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

Contains methods for adding document data for CAE Report. More...

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

Public Member Functions

NXOpen::OpenXml::ImageGroupDocumentDataAddImageGroup ()
 Creates a new NXOpen::OpenXml::ImageGroupDocumentData object. More...
 
NXOpen::OpenXml::TableDocumentDataAddTable (int columnCount, int rowCount)
 Creates a new NXOpen::OpenXml::TableDocumentData object. More...
 
NXOpen::OpenXml::TextDocumentDataAddText (const NXString &textContent)
 Creates a new NXOpen::OpenXml::TextDocumentData object. More...
 
NXOpen::OpenXml::TextDocumentDataAddText (const char *textContent)
 Creates a new NXOpen::OpenXml::TextDocumentData object. More...
 
void DeleteAllData ()
 Deletes all document data
Created in NX11.0.0. More...
 
void DeleteNthData (int index)
 Deletes the nth document data
Created in NX11.0.0. More...
 
int GetDataCount ()
 Gets the number of data to be exported. More...
 
NXOpen::OpenXml::DocumentDataGetNthData (int index)
 Gets the nth document data object. More...
 
virtual ~DocumentDataGroup ()
 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

Contains methods for adding document data for CAE Report.


Created in NX11.0.0.

Constructor & Destructor Documentation

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

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

Does not to free this object, it will be free while deleting NXOpen::OpenXml::DocumentDataGroup object

Returns
the image group data
Created in NX11.0.0.

License requirements : None
NXOpen::OpenXml::TableDocumentData* NXOpen::OpenXml::DocumentDataGroup::AddTable ( int  columnCount,
int  rowCount 
)

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

Does not to free this object, it will be free while deleting NXOpen::OpenXml::DocumentDataGroup object

Returns
the table data
Created in NX11.0.0.

License requirements : None
Parameters
columnCountthe column size of the table
rowCountthe row size of the table
NXOpen::OpenXml::TextDocumentData* NXOpen::OpenXml::DocumentDataGroup::AddText ( const NXString textContent)

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

Does not to free this object, it will be free while deleting NXOpen::OpenXml::DocumentDataGroup object

Returns
the text data
Created in NX11.0.0.

License requirements : None
Parameters
textContentthe content of the text data
NXOpen::OpenXml::TextDocumentData* NXOpen::OpenXml::DocumentDataGroup::AddText ( const char *  textContent)

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

Does not to free this object, it will be free while deleting NXOpen::OpenXml::DocumentDataGroup object

Returns
the text data
Created in NX11.0.0.

License requirements : None
Parameters
textContentthe content of the text data
void NXOpen::OpenXml::DocumentDataGroup::DeleteAllData ( )

Deletes all document data
Created in NX11.0.0.



License requirements : None

void NXOpen::OpenXml::DocumentDataGroup::DeleteNthData ( int  index)

Deletes the nth document data
Created in NX11.0.0.



License requirements : None

Parameters
indexthe index of data
int NXOpen::OpenXml::DocumentDataGroup::GetDataCount ( )

Gets the number of data to be exported.

Returns
the number of data
Created in NX11.0.0.

License requirements : None
NXOpen::OpenXml::DocumentData* NXOpen::OpenXml::DocumentDataGroup::GetNthData ( int  index)

Gets the nth document data object.

Does not to free this object, it will be free while deleting NXOpen::OpenXml::DocumentDataGroup object

Returns
the data
Created in NX11.0.0.

License requirements : None
Parameters
indexthe index of data

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