Represents the image to be exported to the speific Open XML file. More...
Public Types | |
| enum | CaptionPosition { CaptionPositionAbove, CaptionPositionBellow } |
| the location of the caption for image data More... | |
 Public Types inherited from NXOpen::OpenXml::DocumentData | |
| enum | Type { TypeBase, TypeText, TypeTable, TypeTableCell, TypeImage, TypeImageGroup, TypeGroup } |
| the document data type More... | |
Public Member Functions | |
| NXString | GetCaption (NXOpen::OpenXml::ImageDocumentData::CaptionPosition *position) |
| Gets the caption of the image data. More... | |
| NXString | GetFileName () |
| Gets the file name of the image data. More... | |
| void | SetCaption (NXOpen::OpenXml::ImageDocumentData::CaptionPosition position, const NXString &caption) |
| Sets the caption of the image data Created in NX11.0.0. More... | |
| void | SetCaption (NXOpen::OpenXml::ImageDocumentData::CaptionPosition position, const char *caption) |
| Sets the caption of the image data Created in NX11.0.0. More... | |
| void | SetFileName (const NXString &fileName) |
| Sets the file name of the image data Created in NX11.0.0. More... | |
| void | SetFileName (const char *fileName) |
| Sets the file name of the image data Created in NX11.0.0. More... | |
| virtual | ~ImageDocumentData () |
| Frees the object from memory. More... | |
| Public Member Functions inherited from NXOpen::OpenXml::DocumentData | |
| NXOpen::OpenXml::DocumentData::Type | GetDataType () |
| Gets a specified document data type. More... | |
| virtual | ~DocumentData () |
| Frees the object from memory. More... | |
| Public Member Functions inherited from NXOpen::TransientObject | |
| void * | GetHandle () |
| Handle of the internal object represented by this object. More... | |
Detailed Description
Represents the image to be exported to the speific Open XML file.
Created in NX11.0.0.
Member Enumeration Documentation
Constructor & Destructor Documentation
|
virtual |
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.
Created in NX11.0.0.
License requirements : None
Member Function Documentation
| NXString NXOpen::OpenXml::ImageDocumentData::GetCaption | ( | NXOpen::OpenXml::ImageDocumentData::CaptionPosition * | position | ) |
Gets the caption of the image data.
- Returns
Created in NX11.0.0.
License requirements : None
- Parameters
-
position position
| NXString NXOpen::OpenXml::ImageDocumentData::GetFileName | ( | ) |
Gets the file name of the image data.
- Returns
Created in NX11.0.0.
License requirements : None
| void NXOpen::OpenXml::ImageDocumentData::SetCaption | ( | NXOpen::OpenXml::ImageDocumentData::CaptionPosition | position, |
| const NXString & | caption | ||
| ) |
Sets the caption of the image data
Created in NX11.0.0.
License requirements : None
- Parameters
-
position position caption caption
| void NXOpen::OpenXml::ImageDocumentData::SetCaption | ( | NXOpen::OpenXml::ImageDocumentData::CaptionPosition | position, |
| const char * | caption | ||
| ) |
Sets the caption of the image data
Created in NX11.0.0.
License requirements : None
- Parameters
-
position position caption caption
| void NXOpen::OpenXml::ImageDocumentData::SetFileName | ( | const NXString & | fileName | ) |
Sets the file name of the image data
Created in NX11.0.0.
License requirements : None
- Parameters
-
fileName filename
| void NXOpen::OpenXml::ImageDocumentData::SetFileName | ( | const char * | fileName | ) |
Sets the file name of the image data
Created in NX11.0.0.
License requirements : None
- Parameters
-
fileName filename
The documentation for this class was generated from the following file:
- OpenXml_ImageDocumentData.hxx