Options
All
  • Public
  • Public/Protected
  • All
Menu

Class InstalledPrinter

It represents a printer installed in the client machine with an associated OS printer driver.

Hierarchy

  • InstalledPrinter

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new InstalledPrinter(printerName: string, printToDefaultIfNotFound?: boolean, trayName?: string, paperName?: string, duplex?: DuplexMode, autoDetectRawModeDataType?: boolean, driverModel?: number): InstalledPrinter

  • Creates an instance of the InstalledPrinter class with the specified printer name.

    Parameters

    • printerName: string

      The name of the printer installed in the client machine.

    • printToDefaultIfNotFound: boolean = false

      Whether to use Default printer if the specified one is not found or missing.

    • trayName: string = ''

      The name of the tray to print

    • paperName: string = ''

      The name of the paper

    • duplex: DuplexMode = DuplexMode.Default

      The duplex option

    • autoDetectRawModeDataType: boolean = false

      Whether to automatically detect Raw Mode Data Type based on the Windows printer driver model.

    • driverModel: number = 0

    Returns InstalledPrinter

Properties

Id

Id: number = 1

The Client Printer ID

Accessors

autoDetectRawModeDataType

  • get autoDetectRawModeDataType(): boolean
  • set autoDetectRawModeDataType(value: boolean): void

  • Gets or sets whether to automatically detect Raw Mode Data Type based on the Windows printer driver model. Default is false.

    Returns boolean

  • Gets or sets whether to automatically detect Raw Mode Data Type based on the Windows printer driver model. Default is false.

    Parameters

    • value: boolean

    Returns void

driverModel

  • get driverModel(): number
  • set driverModel(value: number): void

  • Gets or sets the Windows driver model to use; set to 3 for driver model V3 or set to 4 for driver model V4. Default value is zero.

    Returns number

  • Gets or sets the Windows driver model to use; set to 3 for driver model V3 or set to 4 for driver model V4. Default value is zero.

    Parameters

    • value: number

    Returns void

duplex

  • Gets or sets the printer's double-sided (duplex) printing capability. Default is the current printer's driver setting.

    Returns DuplexMode

  • Gets or sets the printer's double-sided (duplex) printing capability. Default is the current printer's driver setting.

    Parameters

    Returns void

paperName

  • get paperName(): string
  • set paperName(value: string): void

  • Gets or sets the name of the Paper supported by the client printer. Default value is an empty string.

    Returns string

  • Gets or sets the name of the Paper supported by the client printer. Default value is an empty string.

    Parameters

    • value: string

    Returns void

printToDefaultIfNotFound

  • get printToDefaultIfNotFound(): boolean
  • set printToDefaultIfNotFound(value: boolean): void

  • Gets or sets whether to print to Default printer in case of the specified printer name is not found or missing. Default is false.

    Returns boolean

  • Gets or sets whether to print to Default printer in case of the specified printer name is not found or missing. Default is false.

    Parameters

    • value: boolean

    Returns void

printerName

  • get printerName(): string
  • set printerName(value: string): void

  • Gets or sets the name of the printer installed in the client machine. Default value is an empty string.

    Returns string

  • Gets or sets the name of the printer installed in the client machine. Default value is an empty string.

    Parameters

    • value: string

    Returns void

trayName

  • get trayName(): string
  • set trayName(value: string): void

  • Gets or sets the name of the tray supported by the client printer. Default value is an empty string.

    Returns string

  • Gets or sets the name of the tray supported by the client printer. Default value is an empty string.

    Parameters

    • value: string

    Returns void

Methods

serialize

  • serialize(): string

  • The Client Printer serialization.

    Returns string