Class PrintMgr

constructor

• new PrintMgr(options: Options): PrintMgr

  创建一个 PrintMgr 实例。 请使用 create 来创建实例，而不是通过 new 模式创建实例。

  Parameters

  • options: Options

    使用指定的选项创建一个 PrintMgr 实例。

  Returns PrintMgr

  Example

  const printMgr = await PrintMgr.create();
  Copy

options

destroy

• destroy(): Promise<void>

  销毁当前对象。

  Returns Promise<void>

  当对象被销毁时解决的 Promise。

doModal

• doModal(): Promise<void>

  执行模态操作

  Returns Promise<void>

  当模态操作完成时会被 resolve 的 Promise。

enumPrinterName

• enumPrinterName(): Promise<string[]>

  枚举打印机名称

  Returns Promise<string[]>

  一个解析为打印机名称数组的 Promise。

getDefaultPrint

• getDefaultPrint(): Promise<string>

  获取默认打印机名称

  Returns Promise<string>

  一个解析为默认打印机名称的 Promise。

getPrintAutoCenter

• getPrintAutoCenter(): Promise<boolean>

  获取打印自动居中设置。

  Returns Promise<boolean>

  一个 Promise，解析为是否自动居中。

getPrintCopies

• getPrintCopies(): Promise<number>

  获取打印份数。

  Returns Promise<number>

  返回一个 Promise，其解析值为份数。

getPrintPageArray

• getPrintPageArray(): Promise<number[]>

  获取打印页面数组

  Returns Promise<number[]>

  一个解析为打印页面数组的 Promise。

getPrintReverse

• getPrintReverse(): Promise<boolean>

  获取是否反向打印

  Returns Promise<boolean>

  一个 Promise，会解析为是否已设置反向打印。

getPrintSubset

• getPrintSubset(): Promise<number>

  获取打印子集。

  Returns Promise<number>

  一个 Promise，会解析为打印子集模式。有效值为：DefineConst.FR_PRINT_SUBSET_ALL、DefineConst.FR_PRINT_SUBSET_OLD、DefineConst.FR_PRINT_SUBSET_EVEN

getRangeMode

• getRangeMode(): Promise<number>

  获取打印范围模式

  Returns Promise<number>

  一个解析为打印范围模式的 Promise。

setDefaultPrint

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

  通过名称设置默认打印机

  Parameters

  • printerName: string

    打印机名称

  Returns Promise<void>

  当默认打印机设置完成时被解析的 Promise。

setPrintAsImage

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

  设置以图像方式打印

  Parameters

  • printAsImage: boolean = false

    是否设置为以图像方式打印，默认为 false

  Returns Promise<void>

  当以图像方式打印设置完成时 resolve 的 Promise。

setPrintAutoCenter

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

  设置打印自动居中。

  Parameters

  • autoCenter: boolean

    是否自动居中。

  Returns Promise<void>

  一个在打印自动居中设置完成时被解析的 Promise。

setPrintAutoRotate

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

  设置打印自动旋转。

  Parameters

  • autoRotate: boolean

    是否自动旋转。

  Returns Promise<void>

  当打印自动旋转设置完成时 resolve 的 Promise。

setPrintCopies

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

  设置打印份数。在界面中显示为打印份数。

  Parameters

  • copies: number

    份数，必须大于 0 且小于等于 10000。

  Returns Promise<void>

  当打印份数设置完成时被解析的 Promise。

setPrintPageArray

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

  设置打印页数组

  Parameters

  • pageArray: number[]

    页数组

  Returns Promise<void>

  当打印页数组设置完成时 resolve 的 Promise。

setPrintPaperSizeByPage

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

  按页面设置打印纸张大小

  Parameters

  • paperSizeByPage: boolean = false

    是否按页面设置纸张大小，默认为 false

  Returns Promise<void>

  当按页面设置打印纸张大小完成时解析的 Promise。

setPrintPreview

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

  设置打印预览

  Parameters

  • preview: boolean = false

    是否设置打印预览，默认为 false

  Returns Promise<void>

  当打印预览设置完成时解析的 Promise。

setPrintPrintWhat

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

  设置“打印内容”模式。

  Parameters

  • printWhatMode: number

    “打印内容”模式。有效值为：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>

  当“打印内容”模式设置完成时兑现的 Promise。

setPrintRange

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

  设置打印范围。

  Parameters

  • rangeMode: number

    范围模式。有效值为：DefineConst.FR_PRINT_RANGE_ALL、DefineConst.FR_PRINT_RANGE_CURRENT_VIEW、DefineConst.FR_PRINT_RANGE_CURRENT_PAGE、DefineConst.FR_PRINT_RANGE_PAGES
  • Optionalfrom: number

    起始页码。如果 rangeMode 不是 DefineConst.FR_PRINT_RANGE_PAGES，该参数将被忽略。
  • Optionalto: number

    结束页码。如果 rangeMode 不是 DefineConst.FR_PRINT_RANGE_PAGES，该参数将被忽略。

  Returns Promise<void>

  当打印范围设置完成时被解析的 Promise。

setPrintReverse

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

  设置倒序打印

  Parameters

  • reverse: boolean = false

    是否设置倒序打印，默认为 false

  Returns Promise<void>

  当倒序打印设置完成时解析的 Promise。

setPrintSubset

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

  设置打印子集。

  Parameters

  • subsetMode: number

    打印子集模式。有效值为：DefineConst.FR_PRINT_SUBSET_ALL, DefineConst.FR_PRINT_SUBSET_OLD, DefineConst.FR_PRINT_SUBSET_EVEN

  Returns Promise<void>

  当打印子集设置完成时会被 resolve 的 Promise。

setProgressDisplay

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

  设置进度显示

  Parameters

  • show: boolean = true

    是否设置进度显示，默认为 true

  Returns Promise<void>

  当进度显示设置完成时 resolve 的 Promise。

setSimulateOverprinting

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

  设置模拟叠印

  Parameters

  • simulateOverPrinting: boolean = false

    是否设置模拟叠印，默认值为 false

  Returns Promise<void>

  当模拟叠印设置完成时会被 resolve 的 Promise。

Staticcreate

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

  创建一个 PrintMgr 实例。

  Parameters

  • options: Options

    使用指定的选项创建一个 PrintMgr 实例。

  Returns Promise<PrintMgrType>

  一个 Promise，解析为创建的 PrintMgr 实例。

  Example

  const printMgr = await PrintMgr.create();
  Copy