Interface nsIPrinterListType

Hierarchy

Properties

fallbackPaperList printers systemDefaultPrinterName

Methods

AddRef QueryInterface Release getNamedOrDefaultPrinter getPrinterByName getPrinterBySystemName initPrintSettingsFromPrinter

Properties

Readonly fallbackPaperList

fallbackPaperList: any

Returns a Promise that resolves to an array of nsIPaper instances for common paper sizes suitable to be supported for Save to PDF.

Readonly printers

printers: any

Returns a promise that resolves to an array of printers.

Readonly systemDefaultPrinterName

systemDefaultPrinterName: string

The system default printer name. This is not necessarily gecko's default printer; see nsIPrintSettingsService.lastUsedPrinterName for that.

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getNamedOrDefaultPrinter

  • Returns a promise that resolves to the printer of the given name, or the default system printer, or is rejected if there are no printers available.

    Parameters

    • aPrinterName: string

    Returns any

getPrinterByName

  • Returns a promise that resolves to the printer of a given name, or is rejected if there is no such printer.

    Parameters

    • aPrinterName: string

    Returns any

getPrinterBySystemName

  • Returns a promise that resolves to the printer of a given system name, or is rejected if there is no such printer. This may be more efficient than using getNamedPrinter, but requires the caller to know the system name of the printer they want to find.

    Parameters

    • aPrinterName: string

    Returns any

initPrintSettingsFromPrinter

  • Initializes certain settings from the native printer into the PrintSettings These settings include, but are not limited to: Page Orientation Page Size Number of Copies

    Parameters

    • aPrinterName: string
    • aPrintSettings: nsIPrintSettings

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc