IGraphicImages

class IGraphicImages

Bases: ImpactCOMWrapperBase, Iterable

Description:

A collection of IGraphicImage objects.

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

property count

Gets Count.

Description:

Gets the number of items in the collection.

Returns:

The value of Count.

Return type:

count (int)

embed_all()
Description:

Embeds all images in this collection in the relevant drawing.

item(index)
Description:

Gets an IGraphicImage from the collection with the specified index.

Parameters:

index (any) – Specifes the index of the IGraphicImage to get.

load_from_document(document, embedded, post_script_options)
Description:

Loads an image from and IDocument.

Parameters:

  • document (IDocument) – Specifies the IDocument to load from.

  • embedded (bool) – Specifies if the image should be embedded in the drawing or not.

  • post_script_options (IPostScriptImageOptions) – Specifies the postscript options to use. If this is null then defaults are used.

load_from_file(file_name, embedded, post_script_options)
Description:

Loads an image from file.

Remarks:

If the image cannot be loaded null is returned.

Parameters:

  • file_name (str) – Specifies the file to load.

  • embedded (bool) – Specifies if the image should be embedded in the drawing or not.

  • post_script_options (IPostScriptImageOptions) – Specifies the postscript options to use. If this is null then defaults are used.

load_from_stream(stream, file_name, chunk_size, embedded, post_script_options)
Description:

Loads an image from a stream.

Parameters:

  • stream (win32com.client.Dispatch) – Specifies the stream to load the image from. The IUnknown interface passed here must support the IStream interface.

  • file_name (str) – Specifies the file name to use for the drawing when it is reconstructed on the server side.

  • chunk_size (int) – Specifies the number of bytes to read for each sequential access to the specified stream. This value must be between 1K (1024 bytes) and 1MB (1048576 bytes), if a value is specified outside this range then the actual value used will be modified to fit into the range.

  • embedded (bool) – Specifies if the image should be embedded in the drawing or not.

  • post_script_options (IPostScriptImageOptions) – Specifies the postscript options to use. If this is null then defaults are used.

remove(graphic_image)
Description:

Removes an IGraphicImage object from this collection.

Parameters:

graphic_image (IGraphicImage) – Specifies the IGraphicImage object to remove.

Examples