ssCore.Printer.getProperties

Return a collection of printer property settings: font name, font size, paper orientation, number of copies to print, margin settings and the selected printer.


Availability:

First available in version 3.0 build 2039.


Input Parameters:

None.


Output Parameters:

fontName - Name of the font that will be used to render text on the selected printer (for Printer.printText).

fontSize - Size of the font that will be used to render text on the selected printer (for Printer.printText).

paperOrientation - Current paper orientation for the selected printer.

copies - Number of copies of the text that will be printed using Printer.printText.

topMargin - Top margin setting (in inches) of the selected printer.

leftMargin - Left margin setting (in inches) of the selected printer.

bottomMargin - Bottom margin setting (in inches) of the selected printer.

rightMargin - Right margin setting (in inches) of the selected printer.

selectedPrinter - Name of the selected printer.


Asynchronous Mode:

When this method is called asynchronously, a return object containing the output parameters is passed to the specified callback function.

ssCore.Printer.getProperties( paramsObject [, callbackParamsObject] [, errorParamsObject] );


Synchronous Mode:

When this method is called synchronously, a return object containing the output parameters is returned to the caller immediately.

var returnObject = ssCore.Printer.getProperties( paramsObject );


Notes:

None.


Examples:

var return_obj = ssCore.Printer.getProperties();

ssDebug.trace(return_obj.fontName);
ssDebug.trace(return_obj.fontSize);
ssDebug.trace(return_obj.paperOrientation);
ssDebug.trace(return_obj.copies);
ssDebug.trace(return_obj.topMargin);
ssDebug.trace(return_obj.leftMargin);
ssDebug.trace(return_obj.bottomMargin);
ssDebug.trace(return_obj.rightMargin);
ssDebug.trace(return_obj.selectedPrinter);