ImageDocumentData Class

class NXOpen.OpenXml.ImageDocumentData

Bases: NXOpen.OpenXml.DocumentData

Represents the image to be exported to the speific Open XML file.

New in version NX11.0.0.

Methods

Method Description
Dispose Frees the object from memory.
GetCaption Gets the caption of the image data
GetDataType Gets a specified document data type
GetFileName Gets the file name of the image data
SetCaption Sets the caption of the image data
SetFileName Sets the file name of the image data

Enumerations

ImageDocumentDataCaptionPosition Enumeration the location of the caption for image data

Method Detail

Dispose

ImageDocumentData.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.

GetCaption

ImageDocumentData.GetCaption

Gets the caption of the image data

Signature GetCaption()

Returns:a tuple
Return type:A tuple consisting of (caption, position). caption is a str. position is a NXOpen.OpenXml.ImageDocumentDataCaptionPosition.

New in version NX11.0.0.

License requirements: None.

GetFileName

ImageDocumentData.GetFileName

Gets the file name of the image data

Signature GetFileName()

Returns:
Return type:str

New in version NX11.0.0.

License requirements: None.

SetCaption

ImageDocumentData.SetCaption

Sets the caption of the image data

Signature SetCaption(position, caption)

Parameters:

New in version NX11.0.0.

License requirements: None.

SetFileName

ImageDocumentData.SetFileName

Sets the file name of the image data

Signature SetFileName(fileName)

Parameters:fileName (str) –

New in version NX11.0.0.

License requirements: None.