Class PrintMgr

constructor

• new PrintMgr(options: Options): PrintMgr

  Create a PrintMgr instance. Instead of creating an instance in new mode, use create to create an instance.

  Parameters

  • options: Options

    Create a PrintMgr instance with the specified options.

  Returns PrintMgr

  Example

  const printMgr = await PrintMgr.create();
  Copy

options

destroy

• destroy(): Promise<void>

  Destroy the current object.

  Returns Promise<void>

  A promise that resolves when the object is destroyed.

doModal

• doModal(): Promise<void>

  do modal

  Returns Promise<void>

  A promise that resolves when the modal operation is completed.

enumPrinterName

• enumPrinterName(): Promise<string[]>

  enum printer name

  Returns Promise<string[]>

  A promise that resolves to the array of printer names.

getDefaultPrint

• getDefaultPrint(): Promise<string>

  get default print printer name

  Returns Promise<string>

  A promise that resolves to the default print printer name.

getPrintAutoCenter

• getPrintAutoCenter(): Promise<boolean>

  Get the print auto center.

  Returns Promise<boolean>

  A promise that resolves to whether to auto center.

getPrintCopies

• getPrintCopies(): Promise<number>

  Get the print copies.

  Returns Promise<number>

  A promise that resolves to the number of copies.

getPrintPageArray

• getPrintPageArray(): Promise<number[]>

  get print page array

  Returns Promise<number[]>

  A promise that resolves to the print page array.

getPrintReverse

• getPrintReverse(): Promise<boolean>

  get print reverse

  Returns Promise<boolean>

  A promise that resolves to whether the print reverse is set.

getPrintSubset

• getPrintSubset(): Promise<number>

  Get the print subset.

  Returns Promise<number>

  A promise that resolves to the print subset mode. the valid values are: DefineConst.FR_PRINT_SUBSET_ALL, DefineConst.FR_PRINT_SUBSET_OLD, DefineConst.FR_PRINT_SUBSET_EVEN

getRangeMode

• getRangeMode(): Promise<number>

  get print range mode

  Returns Promise<number>

  A promise that resolves to the print range mode.

setDefaultPrint

• setDefaultPrint(printerName: string): Promise<void>

  set default print printer by name

  Parameters

  • printerName: string

    printer name

  Returns Promise<void>

  A promise that resolves when the default print printer is set.

setPrintAsImage

• setPrintAsImage(printAsImage?: boolean): Promise<void>

  set print as image

  Parameters

  • printAsImage: boolean = false

    whether to set print as image, default is false

  Returns Promise<void>

  A promise that resolves when the print as image is set.

setPrintAutoCenter

• setPrintAutoCenter(autoCenter: boolean): Promise<void>

  Set the print auto center.

  Parameters

  • autoCenter: boolean

    Whether to auto center.

  Returns Promise<void>

  A promise that resolves when the print auto center is set.

setPrintAutoRotate

• setPrintAutoRotate(autoRotate: boolean): Promise<void>

  Set the print auto rotate.

  Parameters

  • autoRotate: boolean

    Whether to auto rotate.

  Returns Promise<void>

  A promise that resolves when the print auto rotate is set.

setPrintCopies

• setPrintCopies(copies: number): Promise<void>

  Set the print copies. Displayed as the number of print copies in the UI.

  Parameters

  • copies: number

    The number of copies, must be greater than 0 and less than or equal to 10000.

  Returns Promise<void>

  A promise that resolves when the print copies is set.

setPrintPageArray

• setPrintPageArray(pageArray: number[]): Promise<void>

  set print page array

  Parameters

  • pageArray: number[]

    page array

  Returns Promise<void>

  A promise that resolves when the print page array is set.

setPrintPaperSizeByPage

• setPrintPaperSizeByPage(paperSizeByPage?: boolean): Promise<void>

  set print paper size by page

  Parameters

  • paperSizeByPage: boolean = false

    whether to set paper size by page, default is false

  Returns Promise<void>

  A promise that resolves when the print paper size by page is set.

setPrintPreview

• setPrintPreview(preview?: boolean): Promise<void>

  set print preview

  Parameters

  • preview: boolean = false

    whether to set print preview, default is false

  Returns Promise<void>

  A promise that resolves when the print preview is set.

setPrintPrintWhat

• setPrintPrintWhat(printWhatMode: number): Promise<void>

  Set the print what mode.

  Parameters

  • printWhatMode: number

    The print what mode. The valid values are: DefineConst.FR_PRINT_WHAT_DOCUMENT, DefineConst.FR_PRINT_WHAT_DOCUMENT_MAKEUPS, DefineConst.FR_PRINT_WHAT_DOCUMENT_STAMPS, DefineConst.FR_PRINT_WHAT_FORM_FIELDS_ONLY

  Returns Promise<void>

  A promise that resolves when the print what mode is set.

setPrintRange

• setPrintRange(rangeMode: number, from?: number, to?: number): Promise<void>

  Set the print range.

  Parameters

  • rangeMode: number

    The range mode. The valid values are: DefineConst.FR_PRINT_RANGE_ALL, DefineConst.FR_PRINT_RANGE_CURRENT_VIEW, DefineConst.FR_PRINT_RANGE_CURRENT_PAGE, DefineConst.FR_PRINT_RANGE_PAGES
  • Optionalfrom: number

    The starting page number. if rangeMode is not DefineConst.FR_PRINT_RANGE_PAGES, this parameter will be ignored.
  • Optionalto: number

    The ending page number. if rangeMode is not DefineConst.FR_PRINT_RANGE_PAGES, this parameter will be ignored.

  Returns Promise<void>

  A promise that resolves when the print range is set.

setPrintReverse

• setPrintReverse(reverse?: boolean): Promise<void>

  set print reverse

  Parameters

  • reverse: boolean = false

    whether to set reverse, default is false

  Returns Promise<void>

  A promise that resolves when the print reverse is set.

setPrintSubset

• setPrintSubset(subsetMode: number): Promise<void>

  Set the print subset.

  Parameters

  • subsetMode: number

    The print subset mode. The valid values are: DefineConst.FR_PRINT_SUBSET_ALL, DefineConst.FR_PRINT_SUBSET_OLD, DefineConst.FR_PRINT_SUBSET_EVEN

  Returns Promise<void>

  A promise that resolves when the print subset is set.

setProgressDisplay

• setProgressDisplay(show?: boolean): Promise<void>

  set progress display

  Parameters

  • show: boolean = true

    whether to set progress display, default is true

  Returns Promise<void>

  A promise that resolves when the progress display is set.

setSimulateOverprinting

• setSimulateOverprinting(simulateOverPrinting?: boolean): Promise<void>

  set simulate overprinting

  Parameters

  • simulateOverPrinting: boolean = false

    whether to set simulate overprinting, default is false

  Returns Promise<void>

  A promise that resolves when the simulate overprinting is set.

Staticcreate

• create(options: Options): Promise<PrintMgrType>

  Create a PrintMgr instance.

  Parameters

  • options: Options

    Create a PrintMgr instance with the specified options.

  Returns Promise<PrintMgrType>

  A promise that resolves to the created PrintMgr instance.

  Example

  const printMgr = await PrintMgr.create();
  Copy