IPrintOptions

class IPrintOptions

Bases: ImpactCOMWrapperBase

Description:

Specifies the options required to print a drawing.

Remarks:

When created this class automatically loads default printing options, see printer_name for details.

Wraps a COM object or another wrapper instance. Accepts: - A valid impact_object - An existing impact_com_wrapper_base-derived instance

property colour

Gets Colour.

Description:

Gets and sets the colour output.

Returns:

The value of Colour.

Return type:

colour (ipPrintColour)

property custom_paper_length

Gets custom_paper_length.

Description:

Gets and sets a custom paper length

Remarks:

This property can only be accessed if paper_size is psCustom

Returns:

The value of custom_paper_length.

Return type:

custom_paper_length (int)

property custom_paper_width

Gets custom_paper_width.

Description:

Gets and sets a custom paper width

Remarks:

This property can only be accessed if paper_size is psCustom

Returns:

The value of custom_paper_width.

Return type:

custom_paper_width (int)

property graphic_settings

Gets graphic_settings.

Description:

Gets or sets the 3D Graphic Settings to use when printing

Returns:

The value of graphic_settings.

Return type:

graphic_settings (IMasterSetting)

property ignore_line_weights

Gets ignore_line_weights.

Description:

Gets and sets if line weights are ignored or not.

Returns:

The value of ignore_line_weights.

Return type:

ignore_line_weights (bool)

property increase_line_weights_by

Gets increase_line_weights_by.

Description:

Gets and sets the amount to increase line weights by.

Remarks:

This value must be between 0 and 1000.

Returns:

The value of increase_line_weights_by.

Return type:

increase_line_weights_by (int)

property number_of_copies

Gets number_of_copies.

Description:

Gets and sets number of copies to print.

Returns:

The value of number_of_copies.

Return type:

number_of_copies (int)

property one_to_one_scale

Gets one_to_one_scale.

Description:

Gets and sets if the output is one to one scale.

Returns:

The value of one_to_one_scale.

Return type:

one_to_one_scale (bool)

property orientation

Gets Orientation.

Description:

Gets and sets the print orientation.

Returns:

The value of Orientation.

Return type:

orientation (ipPrintOrientation)

property paper_duplex

Gets paper_duplex.

Description:

Gets and sets the paper duplexing option

Returns:

The value of paper_duplex.

Return type:

paper_duplex (ipPaperDuplex)

property paper_size

Gets paper_size.

Description:

Gets and sets the printer paper size

Remarks:

If paper_size is psCustom then you should also set custom_paper_length and custom_paper_width.

Returns:

The value of paper_size.

Return type:

paper_size (ipPaperSize)

property paper_source

Gets paper_source.

Description:

Gets and sets the printer paper source

Returns:

The value of paper_source.

Return type:

paper_source (ipPaperSource)

property printer_name

Gets printer_name.

Description:

Gets and sets the name of the printer to use.

Remarks:

When the IPrintOptions is created it initialises the properties of this object with the values from the connected users last used printer. When using nServer it loads the default windows printer details. By setting a new printer name the IPrintOptions object interogates the printer and assigns the defaults for the printer to the properties of the object. Setting printer_name will also set Orientation, number_of_copies, paper_size, paper_duplex and paper_source. It is important therefore to always set the printer_name before assigning override values to any of these related properties.

Returns:

The value of printer_name.

Return type:

printer_name (str)

property report_settings

Gets report_settings.

Description:

Gets or sets the Printed Report settings to use when printing

Returns:

The value of report_settings.

Return type:

report_settings (IMasterSetting)

property show_dialog

Gets show_dialog.

Description:

Gets and sets if the print dialog is displayed.

Remarks:

If show_dialog is false output will be to the printer specified in the printer_name property. Setting this property from nServer will result in an error.

Returns:

The value of show_dialog.

Return type:

show_dialog (bool)

property source

Gets Source.

Description:

Gets and sets what should be printed.

Returns:

The value of Source.

Return type:

source (ipPrintSource)

Examples