NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::OpenXml::ImageGroupDocumentData Class Reference

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

Inheritance diagram for NXOpen::OpenXml::ImageGroupDocumentData:
NXOpen::OpenXml::DocumentData NXOpen::TransientObject

Public Member Functions

NXOpen::OpenXml::ImageDocumentDataAddImage (const NXString &fileName, const NXString &caption)
 Creates a new NXOpen::OpenXml::ImageDocumentData object. More...
 
NXOpen::OpenXml::ImageDocumentDataAddImage (const char *fileName, const char *caption)
 Creates a new NXOpen::OpenXml::ImageDocumentData object. More...
 
void DeleteAllImages ()
 Deletes all images data
Created in NX11.0.0. More...
 
void DeleteNthImage (int index)
 Deletes the nth image data
Created in NX11.0.0. More...
 
int GetImagesCount ()
 Gets the number of images. More...
 
NXOpen::OpenXml::ImageDocumentDataGetNthImage (int index)
 Gets the nth image data. More...
 
virtual ~ImageGroupDocumentData ()
 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...
 

Additional Inherited Members

- Public Types inherited from NXOpen::OpenXml::DocumentData
enum  Type {
  TypeBase, TypeText, TypeTable, TypeTableCell,
  TypeImage, TypeImageGroup, TypeGroup
}
 the document data type More...
 

Detailed Description

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


Created in NX11.0.0.

Constructor & Destructor Documentation

virtual NXOpen::OpenXml::ImageGroupDocumentData::~ImageGroupDocumentData ( )
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

NXOpen::OpenXml::ImageDocumentData* NXOpen::OpenXml::ImageGroupDocumentData::AddImage ( const NXString fileName,
const NXString caption 
)

Creates a new NXOpen::OpenXml::ImageDocumentData object.

Returns
the image data
Created in NX11.0.0.

License requirements : None
Parameters
fileNamethe file name of the image data
captionthe caption of the image data
NXOpen::OpenXml::ImageDocumentData* NXOpen::OpenXml::ImageGroupDocumentData::AddImage ( const char *  fileName,
const char *  caption 
)

Creates a new NXOpen::OpenXml::ImageDocumentData object.

Returns
the image data
Created in NX11.0.0.

License requirements : None
Parameters
fileNamethe file name of the image data
captionthe caption of the image data
void NXOpen::OpenXml::ImageGroupDocumentData::DeleteAllImages ( )

Deletes all images data
Created in NX11.0.0.



License requirements : None

void NXOpen::OpenXml::ImageGroupDocumentData::DeleteNthImage ( int  index)

Deletes the nth image data
Created in NX11.0.0.



License requirements : None

Parameters
indexthe index of image
int NXOpen::OpenXml::ImageGroupDocumentData::GetImagesCount ( )

Gets the number of images.

Returns
number of images
Created in NX11.0.0.

License requirements : None
NXOpen::OpenXml::ImageDocumentData* NXOpen::OpenXml::ImageGroupDocumentData::GetNthImage ( int  index)

Gets the nth image data.

Returns
the image data
Created in NX11.0.0.

License requirements : None
Parameters
indexthe index of image data

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.