PrinterID Properties

Property Description
ConfigPrefix

Command used to place the printer into the proper mode prepare the printer for the GetConfiguration command to be able to retrieve the status.

This property is only needed if if there is a command that must prepare the printer before obtaining the configuration string. There is a delay of ConfigCommandDelay milliseconds after the command is sent. After the delay, the read buffer is cleared without being saved in case there was a response to the command.

See ConfigInit for additional details about how these config commands interact.

ConfigCommand

Command used to prompt the printer to send its configuration string to the mobile device.

This command is sent to the printer to retrieve a configuration string that is returned to the application. After the command is sent there is a delay of ConfigCommandDelay milliseconds, after which the read buffer is read and converted to a string to be returned.

See ConfigInit for additional details about how these config commands interact.

ConfigInit

Command used to place the printer into command mode to obtain the configuration.

The four commands that are sent in association with a GetConfiguration call are sent in the following order, if they are defined:

  1. ConfigInit: Delay ConfigInitDelay milliseconds. Discard anything returned by printer.
  2. ConfigPrefix: Delay ConfigCommand milliseconds. Discard anything returned by printer.
  3. ConfigCommand (Must be defined, or no commands sent): Delay ConfigCommand milliseconds. Save and return reply from printer.
  4. ConfigPostfix: Delay ConfigCommand milliseconds. Discard anything returned by printer.
ConfigInitDelay

Delay in milliseconds performed after the ConfigInit command is sent and before the ConfigPrefix command is sent.

Delay is not performed if ConfigInit is an empty string or not specified.

ConfigPostfix

Command used to return the printer to its printing mode after a configuration string is retrieved.

This property is only needed if you must switch the printer back to printing mode before after obtaining the configuration string. There is a delay of ConfigCommandDelay milliseconds after the command is sent. After the delay, the read buffer is cleared without being saved in case there was a response to the command.

See ConfigInit for additional details about how these config commands interact.

ConfigCommandDelay

Delay in milliseconds to be done after each of the configuration retrieval commands with the exception of ConfigInit.

This delay is performed after the ConfigPrefix command if defined, after the ConfigCommand command is sent, and after the ConfigPostfix command is sent if defined. The delay is performed before the read buffer is read or cleared.

BoldOnSeq Command needed to turn on bold print.
BoldOffSeq Command needed to turn off bold print.
CompressFontSeq

Command needed to turn on compressed print.

For printers without a compress font command, you may use a command to switch to a smaller font.

CrLfSeq

Command needed to perform a carriage return and line feed for the printer.

If this value is not specified, defaults to "0x0D,0x0A".

DoubleWideFontSeq Command needed to turn on double wide printing. For printers without a double wide font command, you may use a command to switch to a larger font.
DisplayName

Display name that is returned along with the PrinterId name in a call to EnumeratePrinters().

This string should be unique to the entire set of display name properties in the <Printers> section. It is returned by the EnumeratePrinters() function generally to be used as a readable name for a printer setup.

EntryName

Reference to a sub element of the PrinterPorts element.

This is the link between the commands for this printer and the PrinterPorts element that describes the communications with the printer.

FileName

Specifies the name of a file to which printer output is sent instead of to the device referenced in EntryName.

If there is a FileName property specified, all output is sent to this file and not to any other device specified by the EntryName property.

FormFeedSeq

Command needed to perform a form feed.

If not specified, defaults to "12,13,10".

GraphCompressedLinePrefix Command used to start a line of compressed graphics.
GraphNoncompressedLinePrefix Command used to start a line of non-compressed graphics.
GraphEmptyLinesPrefix Command used to specify number of blank graphics lines to print.
GraphCharHeight Count of pixels high of normal character. Used to convert character lines to pixel height.
GraphCharWidth Count of pixels wide of normal character. Used to convert character widths to pixel width.
GraphModeExitSeq Command used to exit graphics mode.
GraphModeInitSeq Command used to enter graphics mode.
GraphNumPins

Number of pins high of the print head.

For dot matrix printers this is usually a number from 7 to 24. For thermal printers this is usually 1.

GraphPostfixSeq Command to send after completing graphics mode.
GraphPrefixSeq Command to send before starting graphics mode.
GraphXDots Width in pixels of a full line of print.
InitSeq

Characters to send to printer after opening a channel to the printer.

These are the commands sent to the printer after calling Open.

ItalicOffSeq Command used to turn italic print off.
ItalicOnSeq Command used to turn italic print on.
NormalFontSeq Command used to return printing to normal font.
Notification

Reference to a sub element of the Notifications element.

This is the link between the commands for this printer and the Notifications element that describes the warning and error strings that the printer might return while printing.

StatusSettings

Reference to a sub element of the GetStatusSettings element.

This is the link between the commands for this printer and the GetStatusSettings element that describes printer commands and the warning and error strings that the printer might return in response to a GetStatus method call.

PrintableLines

Length of page (not counting headers and footers).  0 for continuous.

Determines how many lines of text will print before the page break logic is executed.

ShutdownChars

Specifies a character to send multiple times before closing communications with the printer.

Defaults to 0x00 if not specified.

ShutdownCharsRepeat

Specifies the number of time the character specified by ShutdownChars should be sent before closing communications with the printer.

Defaults to 0 for disk file, COMx:, IRDA, NPCP, and Wi-Fi.

Defaults to 1000 for WPPORT.

ShutdownDelay

Specifies a delay in milliseconds between a call to Close and actually closing the communication channel with the printer.

Defaults to 0 for file, IRDA, NPCP and Wi-Fi.

Defaults to 1000 for COMx: and WPPORT.

StartupChars

Specifies a character to send multiple times before starting to print.

Defaults to 0x00 if not specified.

StartupCharsRepeat

Specifies the number of time the character specified by StartupChars should be sent before starting to print.

Defaults to 0 for disk file, COMx:, IRDA, NPCP, and Wi-Fi.

Defaults to 500 for WPPORT.

StartupDelay

Specifies a delay in milliseconds between opening the communication with the printer and actually starting to send to the printer.

Defaults to 0 if not specified.

StrikeOutOffSeq Command used to turn off strikeout printing.
StrikeOutOnSeq Command used to turn on strikeout printing.
UnderlineOnSeq Command used to turn underline on.
UnderlineOffSeq Command used to turn underline off.
Unicode Specifies if using a Unicode printer.