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

Represents the table to be exported to the speific Open XML file. More...

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

Public Types

enum  CaptionPosition { CaptionPositionAbove, CaptionPositionBellow }
 the location of the caption for table 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

NXOpen::OpenXml::TableCellDataAddCellData (const std::vector< int > &grids)
 Creates a new NXOpen::OpenXml::TableCellData object. More...
 
NXString GetCaption (NXOpen::OpenXml::TableDocumentData::CaptionPosition *position)
 Gets the caption of the table data. More...
 
int GetCellsCount ()
 Gets the number of table cells. More...
 
int GetColumnCount ()
 Gets the column count of table data. More...
 
std::vector< double > GetColumnWidths ()
 Gets the width array of the columns. More...
 
NXOpen::OpenXml::TableCellDataGetNthCell (int index)
 Gets the nth table cell data. More...
 
int GetRowCount ()
 Gets the row count of table data. More...
 
std::vector< double > GetRowHeigths ()
 Gets the height array of the rows. More...
 
void SetCaption (NXOpen::OpenXml::TableDocumentData::CaptionPosition position, const NXString &caption)
 Sets the caption of the table data
Created in NX11.0.0. More...
 
void SetCaption (NXOpen::OpenXml::TableDocumentData::CaptionPosition position, const char *caption)
 Sets the caption of the table data
Created in NX11.0.0. More...
 
void SetColumnWidths (const std::vector< double > &widths)
 Sets the width array of the columns
Created in NX11.0.0. More...
 
void SetRowHeigths (const std::vector< double > &heigths)
 Sets the height array of the rows
Created in NX11.0.0. More...
 
virtual ~TableDocumentData ()
 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 table to be exported to the speific Open XML file.


Created in NX11.0.0.

Member Enumeration Documentation

the location of the caption for table data

Enumerator
CaptionPositionAbove 

the above position

CaptionPositionBellow 

the bellow position

Constructor & Destructor Documentation

virtual NXOpen::OpenXml::TableDocumentData::~TableDocumentData ( )
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::TableCellData* NXOpen::OpenXml::TableDocumentData::AddCellData ( const std::vector< int > &  grids)

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

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

Returns
the table cell data
Created in NX11.0.0.

License requirements : None
Parameters
gridsthe grid IDs to be mergered into the cell data
NXString NXOpen::OpenXml::TableDocumentData::GetCaption ( NXOpen::OpenXml::TableDocumentData::CaptionPosition position)

Gets the caption of the table data.

Returns

Created in NX11.0.0.

License requirements : None
Parameters
positionposition
int NXOpen::OpenXml::TableDocumentData::GetCellsCount ( )

Gets the number of table cells.

Returns
number of table cells
Created in NX11.0.0.

License requirements : None
int NXOpen::OpenXml::TableDocumentData::GetColumnCount ( )

Gets the column count of table data.

Returns

Created in NX11.0.0.

License requirements : None
std::vector<double> NXOpen::OpenXml::TableDocumentData::GetColumnWidths ( )

Gets the width array of the columns.

Returns
the column width array
Created in NX11.0.0.

License requirements : None
NXOpen::OpenXml::TableCellData* NXOpen::OpenXml::TableDocumentData::GetNthCell ( int  index)

Gets the nth table cell data.

Returns
the table cell data
Created in NX11.0.0.

License requirements : None
Parameters
indexthe index of table cell data
int NXOpen::OpenXml::TableDocumentData::GetRowCount ( )

Gets the row count of table data.

Returns

Created in NX11.0.0.

License requirements : None
std::vector<double> NXOpen::OpenXml::TableDocumentData::GetRowHeigths ( )

Gets the height array of the rows.

Returns
the column width array
Created in NX11.0.0.

License requirements : None
void NXOpen::OpenXml::TableDocumentData::SetCaption ( NXOpen::OpenXml::TableDocumentData::CaptionPosition  position,
const NXString caption 
)

Sets the caption of the table data
Created in NX11.0.0.



License requirements : None

Parameters
positionposition
captioncaption
void NXOpen::OpenXml::TableDocumentData::SetCaption ( NXOpen::OpenXml::TableDocumentData::CaptionPosition  position,
const char *  caption 
)

Sets the caption of the table data
Created in NX11.0.0.



License requirements : None

Parameters
positionposition
captioncaption
void NXOpen::OpenXml::TableDocumentData::SetColumnWidths ( const std::vector< double > &  widths)

Sets the width array of the columns
Created in NX11.0.0.



License requirements : None

Parameters
widthsthe column width array
void NXOpen::OpenXml::TableDocumentData::SetRowHeigths ( const std::vector< double > &  heigths)

Sets the height array of the rows
Created in NX11.0.0.



License requirements : None

Parameters
heigthsthe column width array

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