Class ClientPrintJob
Specifies information about the print job to be processed at the client side.
Inheritance
Inherited Members
Namespace:Neodynamic.SDK.Web
Assembly:cs.temp.dll.dll
Syntax
public class ClientPrintJob
Properties
BinaryPrinterCommands
Gets or sets the printer's commands in binary format. Default is null (nothing).
Declaration
public byte[] BinaryPrinterCommands { get; set; }
Property Value
Type | Description |
---|---|
System.Byte[] |
ClientPrinter
Gets or sets the ClientPrinter object. Default is null (nothing).
Declaration
public ClientPrinter ClientPrinter { get; set; }
Property Value
Type | Description |
---|---|
ClientPrinter |
Remarks
The ClientPrinter object refers to the kind of printer that the client machine has attached or can reach.
- Use a DefaultPrinter object for using the default printer installed in the client machine.
- Use a InstalledPrinter object for using a printer installed in the client machine with an associated Windows driver.
- Use a ParallelPortPrinter object for using a printer which is connected through a parallel port in the client machine.
- Use a SerialPortPrinter object for using a printer which is connected through a serial port in the client machine.
- Use a NetworkPrinter object for using a Network IP/Ethernet printer which can be reached from the client machine.
EncodingCodePage
Gets or sets the encoding code page to process the printer's commands. Default is 850 (IBM850/MS-DOS Latin 1).
Declaration
public int EncodingCodePage { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
The encoding code page is needed to convert the specified printer's commands in text plain format to bytes. If you are using the BinaryPrinterCommands property instead of PrinterCommands, then the encoding code page is not taken into account.
FormatHexValues
Gets or sets whether the printer commands have chars expressed in VB or C# hexadecimal notation. Default is false.
Declaration
public bool FormatHexValues { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Remarks
The string set to the PrinterCommands property can contain chars expressed in VB or C# hexadecimal notation. Many printer languages have commands which are represented by non-printable chars and to express these commands in a string could require many concatenations and hence be not so readable. By using hex notation in your preferred language (VB or C#) you can make it simple and elegant. Here is an example: if you need to encode ASCII 27 (escape), then you can represent it as &H27 or 0x27 (VB and C# hex notation respectively).
PrinterCommands
Gets or sets the printer's commands in text plain format. Default is an empty string.
Declaration
public string PrinterCommands { get; set; }
Property Value
Type | Description |
---|---|
System.String |
PrinterCommandsCopies
Gets or sets the num of copies for Printer Commands. Default is 1.
Declaration
public int PrinterCommandsCopies { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Most Printer Command Languages already provide commands for printing copies. Always use that command instead of this property. Refer to the printer command language manual or specification for further details.
PrintFile
Gets or sets the PrintFile object to be printed at the client side. Default is null (nothing).
Declaration
public PrintFile PrintFile { get; set; }
Property Value
Type | Description |
---|---|
PrintFile |
PrintFileGroup
Gets a group of PrintFile objects to be printed at the client side. Default is an empty list.
Declaration
public List<PrintFile> PrintFileGroup { get; }
Property Value
Type | Description |
---|---|
List<PrintFile> |
Methods
GetContent()
Gets a byte array representing this ClientPrintJob object.
Declaration
public byte[] GetContent()
Returns
Type | Description |
---|---|
System.Byte[] | A byte array representing this ClientPrintJob object. |