Previous IDL Reference Guide: Procedures and Functions Next

DIALOG_PRINTERSETUP

Syntax | Return Value | Arguments | Keywords | Version History | See Also

The DIALOG_PRINTERSETUP function opens a native dialog for setting the applicable properties for a particular printer.

Syntax

Result = DIALOG_PRINTERSETUP( [PrintDestination] [, DIALOG_PARENT=widget_id] [, DISPLAY_NAME=string] [, RESOURCE_NAME=string] [, TITLE=string] )

Return Value

DIALOG_PRINTERSETUP returns a nonzero value if the user pressed the "OK" button in the dialog, or zero otherwise. You can programmatically begin printing based on the value returned by this function.

Arguments

PrintDestination

An instance of the IDLgrPrinter object for which setup properties are to be set. If no PrintDestination is specified, the printer used by the IDL Direct Graphics printer device is modified.

Keywords

DIALOG_PARENT

Set this keyword to the widget ID of a widget to be used as the parent of this dialog.

DISPLAY_NAME

Set this keyword equal to a string indicating the name of the X Windows display on which the dialog is to appear. This keyword is ignored if the DIALOG_PARENT keyword is specified. This keyword is also ignored on Microsoft Windows platforms.

RESOURCE_NAME

Set this keyword equal to a string containing an X Window System resource name to be applied to the dialog.

TITLE

Set this keyword equal to a string to be displayed on the dialog frame. This keyword is ignored on Microsoft Windows platforms.


Note
You can use language catalogs to internationalize this value with strings in particular languages. For more information, see Using Language Catalogs.

Version History

5.0
Introduced

See Also

DIALOG_PRINTJOB, The Printer Device

  IDL Online Help (March 06, 2007)