PrinterEntity GitHub

๐Ÿ“Š Overview: 5 Functions 5 Getters

Extends: Entity

๐Ÿ• Last updated: 2026-01-13T16:04:12.691Z


๐Ÿ“‘ Table of Contents


Functions

Regular Functions

getLabelPaperOptions

Function getLabelPaperOptions -> Collection

Returns a collection of label paper options with 709x291 dimensions from printer options

Returns: Collection


updateOptions

[๐Ÿ–ฅ๏ธ local]

Function updateOptions

Reads printer paper and source options from system and updates the printerโ€™s configuration


printJobs

[๐Ÿ–ฅ๏ธ local]

Function printJobs

Prints all pending print jobs for this printer, grouped by paper type


setCurrent

[๐Ÿ–ฅ๏ธ local]

Function setCurrent -> $Success : Boolean

Sets this printer as the current printer for printing operations

Returns: Boolean


setDefault

[๐Ÿ–ฅ๏ธ local]

Function setDefault

Sets this printer as the default printer (currently incomplete)


Computed Attributes (Getters/Setters/Query/OrderBy)

isDocumentPrinter

[๐Ÿ” get only, ๐Ÿ–ฅ๏ธ local]

Function get isDocumentPrinter -> Boolean

Returns true if printer type is set to Document

Returns: Boolean


isLabelPrinter

[๐Ÿ” get only, ๐Ÿ–ฅ๏ธ local]

Function get isLabelPrinter -> Boolean

Returns true if printer type is set to Label

Returns: Boolean


LabelPaperName

[๐Ÿ” get only]

Function get LabelPaperName -> Text

Returns the name of the first available label paper option, or empty string if none

Returns: Text


LabelPrinter

[๐Ÿ” get only]

Function get LabelPrinter -> Boolean

Returns true if this printer has label paper options configured

Returns: Boolean


TypeDisplay

[๐Ÿ” get only, ๐Ÿ–ฅ๏ธ local]

Function get TypeDisplay -> Text

Returns a human-readable display string for the printer type

Returns: Text


๐Ÿ—‚๏ธ Tables

  • Printer - ORDA Entity class for Printer table

๏ฟฝ Forms


Generated from PrinterEntity.4dm


This site uses Just the Docs, a documentation theme for Jekyll.