IDialogPictureOptions

class IDialogPictureOptions

Bases: ImpactCOMWrapperBase

Description:

Options for displaying a picture on a dialog

Remarks:

Use IGUI.create_dialog_picture_options to create the object. Introduced in Impact 11.0.0.11.

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

property auto_resize

Gets auto_resize.

Description:

Specifies whether images assigned to the control are automatically resized.

Returns:

The value of auto_resize.

Return type:

auto_resize (ipDialogPictureAutoResize)

property command_panel_always_visible

Gets command_panel_always_visible.

Description:

Determines if the command panel is always visible or only visible when hovering over the picture control.

Returns:

The value of command_panel_always_visible.

Return type:

command_panel_always_visible (bool)

property command_panel_position

Gets command_panel_position.

Description:

Specifies the command panel position. Use dpcpNone to hide all commands.

Returns:

The value of command_panel_position.

Return type:

command_panel_position (ipDialogPictureCommandsPosition)

property height

Gets Height.

Description:

The height of the image within the control

Returns:

The value of Height.

Return type:

height (int)

property resize_height

Gets resize_height.

Description:

The height to resize to.

Returns:

The value of resize_height.

Return type:

resize_height (int)

property resize_width

Gets resize_width.

Description:

The width to resize to.

Returns:

The value of resize_width.

Return type:

resize_width (int)

property storage_compression_factor

Gets storage_compression_factor.

Description:

The compression factor to use when storing the image.

Remarks:

Must be a value between 0 and 100. The higher the value the more compression and the smaller the image file. Specify zero to use the default compression factor (currently 25).

Returns:

The value of storage_compression_factor.

Return type:

storage_compression_factor (int)

property storage_format

Gets storage_format.

Description:

The file format to use to store the assigned image. Can only be ffBitmap, ffJPG or ffPNG.

Returns:

The value of storage_format.

Return type:

storage_format (ipFileFormat)

property width

Gets Width.

Description:

The width of the image within the control

Returns:

The value of Width.

Return type:

width (int)

allow_file_format(format)
Description:

Add a specific file format that is allowed to be loaded in the picture control.

Remarks:

If no file formats are specified then all raster file formats are allowed.

Parameters:

format (ipFileFormat) – The format to be allowed.

hide_command(command)
Description:

Hides a specific command button on the control.

Remarks:

See also command_panel_position.

Parameters:

command (ipDialogPictureCommand) – The command to be hidden.