ImageGroupDocumentData Class

class NXOpen.OpenXml.ImageGroupDocumentData

Bases: NXOpen.OpenXml.DocumentData

Represents the group of images to be exported to the speific Open XML file.

New in version NX11.0.0.

Methods

Method	Description
AddImage	Creates a new NXOpen.OpenXml.ImageDocumentData object.
DeleteAllImages	Deletes all images data
DeleteNthImage	Deletes the nth image data
Dispose	Frees the object from memory.
GetDataType	Gets a specified document data type
GetImagesCount	Gets the number of images
GetNthImage	Gets the nth image data

Method Detail

AddImage

ImageGroupDocumentData.AddImage

Creates a new NXOpen.OpenXml.ImageDocumentData object.

Signature AddImage(fileName, caption)

Parameters:

• fileName (str) – the file name of the image data
• caption (str) – the caption of the image data

Returns:

the image data

Return type:

NXOpen.OpenXml.ImageDocumentData

New in version NX11.0.0.

License requirements: None.

DeleteAllImages

ImageGroupDocumentData.DeleteAllImages

Deletes all images data

Signature DeleteAllImages()

New in version NX11.0.0.

License requirements: None.

DeleteNthImage

ImageGroupDocumentData.DeleteNthImage

Deletes the nth image data

Signature DeleteNthImage(index)

Parameters:index (int) – the index of image

New in version NX11.0.0.

License requirements: None.

Dispose

ImageGroupDocumentData.Dispose

Frees the object from memory.

After this method is called, it is illegal to use the object. In .NET, this method is automatically called when the object is deleted by the garbage collector.

Signature Dispose()

New in version NX11.0.0.

License requirements: None.

GetImagesCount

ImageGroupDocumentData.GetImagesCount

Gets the number of images

Signature GetImagesCount()

Returns:number of images Return type:int

New in version NX11.0.0.

License requirements: None.

GetNthImage

ImageGroupDocumentData.GetNthImage

Gets the nth image data

Signature GetNthImage(index)

Parameters:index (int) – the index of image data Returns:the image data Return type:NXOpen.OpenXml.ImageDocumentData

New in version NX11.0.0.

License requirements: None.