Class ClientPrintJob

Specifies information about the print job to be processed at the client side.

Hierarchy

ClientJob
- ClientPrintJob

Index

Constructors

constructor

Properties

_type

Accessors

Methods

Constructors

constructor

new ClientPrintJob(): ClientPrintJob

Inherited from ClientJob.constructor
Returns ClientPrintJob

Properties

_type

_type: string = ''

Accessors

binaryPrinterCommands

get binaryPrinterCommands(): Uint8Array
set binaryPrinterCommands(value: Uint8Array): void

- Defined in ClientPrintJob.ts:79
Gets or sets the printer's commands in binary format. Default is null (nothing).

Returns Uint8Array
- Defined in ClientPrintJob.ts:82
Gets or sets the printer's commands in binary format. Default is null (nothing).

Parameters
- value: Uint8Array
Returns void

clientPrinter

get clientPrinter(): IClientPrinter
set clientPrinter(value: IClientPrinter): void

- Defined in ClientPrintJob.ts:27
Gets or sets the ClientPrinter object. Default is null (nothing).

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 OS printer 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.

Returns IClientPrinter
- Defined in ClientPrintJob.ts:30
Gets or sets the ClientPrinter object. Default is null (nothing).

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 OS printer 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.

Parameters
- value: IClientPrinter
Returns void

files

get files(): PrintFile[]

- Defined in ClientPrintJob.ts:92
Gets an array of PrintFile objects to be printed at the client side. Default is an empty list.

Returns PrintFile[]

printerCommands

get printerCommands(): string
set printerCommands(value: string): void

- Defined in ClientPrintJob.ts:56
Gets or sets the printer's commands in text plain format. Default is an empty string.

Returns string
- Defined in ClientPrintJob.ts:60
Gets or sets the printer's commands in text plain format. Default is an empty string.

Parameters
- value: string
Returns void

printerCommandsCodePage

get printerCommandsCodePage(): Encoding
set printerCommandsCodePage(value: Encoding): void

- Defined in ClientPrintJob.ts:67
Gets or sets the Encoding or CodePage to apply on the printerCommands property. It requires SheetJS (https://github.com/SheetJS/js-codepage). Refer to JSPM.Encoding enum.

Returns Encoding
- Defined in ClientPrintJob.ts:70
Gets or sets the Encoding or CodePage to apply on the printerCommands property. It requires SheetJS (https://github.com/SheetJS/js-codepage). Refer to JSPM.Encoding enum.

Parameters
- value: Encoding
Returns void

printerCommandsCopies

get printerCommandsCopies(): number
set printerCommandsCopies(value: number): void

- Defined in ClientPrintJob.ts:39
Gets or sets the number of copies for Printer Commands. Default is 1.

Returns number
- Defined in ClientPrintJob.ts:42
Gets or sets the number of copies for Printer Commands. Default is 1.

Parameters
- value: number
Returns void

Methods

_cmd2bin

_cmd2bin(): void

- Defined in ClientPrintJob.ts:177
Returns void

_genPCArrayAsync

_genPCArrayAsync(binPrinterCommands: Uint8Array, printerCopies: number): Promise<Blob>

- Defined in ClientPrintJob.ts:142
Parameters
- binPrinterCommands: Uint8Array
- printerCopies: number
Returns Promise<Blob>

_genPFGArrayAsync

_genPFGArrayAsync(printFileGroup: PrintFile[]): Promise<Blob>

- Defined in ClientPrintJob.ts:122
Parameters
- printFileGroup: PrintFile[]
Returns Promise<Blob>

_genPrinterArrayAsync

_genPrinterArrayAsync(clientPrinter: IClientPrinter): Promise<Uint8Array>

- Defined in ClientPrintJob.ts:163
Parameters
- clientPrinter: IClientPrinter
Returns Promise<Uint8Array>

_generateDataAsync

_generateDataAsync(): Promise<Blob>

Overrides ClientJob._generateDataAsync
- Defined in ClientPrintJob.ts:212
Returns Promise<Blob>

onError

onError(data: any, is_critical: any): void

Overrides ClientJob.onError
- Defined in ClientPrintJob.ts:111
Occurs when an error is thrown for the current print job.

Parameters
- data: any
  
  The data object related to this event.
- is_critical: any
  
  Whether the error is critial or not.
Returns void

onFinished

onFinished(data: any): void

- Defined in ClientPrintJob.ts:105
Occurs when the current print job has finished.

Parameters
- data: any
  
  The data object related to this event.
Returns void

onUpdate

onUpdate(data: any, last: any): void

Overrides ClientJob.onUpdate
- Defined in ClientPrintJob.ts:113
Parameters
- data: any
- last: any
Returns void

onUpdated

onUpdated(data: any): void

- Defined in ClientPrintJob.ts:100
Occurs when the current print job is updated.

Parameters
- data: any
  
  The data object related to this event.
Returns void

sendToClient

sendToClient(): Promise<unknown>

Inherited from ClientJob.sendToClient
- Defined in ClientJob.ts:18
Returns Promise<unknown>