TableDocumentData Class

class NXOpen.OpenXml.TableDocumentData

Bases: NXOpen.OpenXml.DocumentData

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

New in version NX11.0.0.

Methods

Method Description
AddCellData Creates a new NXOpen.OpenXml.TableCellData object.
Dispose Frees the object from memory.
GetCaption Gets the caption of the table data
GetCellsCount Gets the number of table cells
GetColumnCount Gets the column count of table data
GetColumnWidths Gets the width array of the columns
GetDataType Gets a specified document data type
GetNthCell Gets the nth table cell data
GetRowCount Gets the row count of table data
GetRowHeigths Gets the height array of the rows
SetCaption Sets the caption of the table data
SetColumnWidths Sets the width array of the columns
SetRowHeigths Sets the height array of the rows

Enumerations

TableDocumentDataCaptionPosition Enumeration the location of the caption for table data

Method Detail

AddCellData

TableDocumentData.AddCellData

Creates a new NXOpen.OpenXml.TableCellData object.

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

Signature AddCellData(grids)

Parameters:grids (list of int) – the grid IDs to be mergered into the cell data
Returns:the table cell data
Return type:NXOpen.OpenXml.TableCellData

New in version NX11.0.0.

License requirements: None.

Dispose

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

TableDocumentData.GetCaption

Gets the caption of the table data

Signature GetCaption()

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

New in version NX11.0.0.

License requirements: None.

GetCellsCount

TableDocumentData.GetCellsCount

Gets the number of table cells

Signature GetCellsCount()

Returns:number of table cells
Return type:int

New in version NX11.0.0.

License requirements: None.

GetColumnCount

TableDocumentData.GetColumnCount

Gets the column count of table data

Signature GetColumnCount()

Returns:
Return type:int

New in version NX11.0.0.

License requirements: None.

GetColumnWidths

TableDocumentData.GetColumnWidths

Gets the width array of the columns

Signature GetColumnWidths()

Returns:the column width array
Return type:list of float

New in version NX11.0.0.

License requirements: None.

GetNthCell

TableDocumentData.GetNthCell

Gets the nth table cell data

Signature GetNthCell(index)

Parameters:index (int) – the index of table cell data
Returns:the table cell data
Return type:NXOpen.OpenXml.TableCellData

New in version NX11.0.0.

License requirements: None.

GetRowCount

TableDocumentData.GetRowCount

Gets the row count of table data

Signature GetRowCount()

Returns:
Return type:int

New in version NX11.0.0.

License requirements: None.

GetRowHeigths

TableDocumentData.GetRowHeigths

Gets the height array of the rows

Signature GetRowHeigths()

Returns:the column width array
Return type:list of float

New in version NX11.0.0.

License requirements: None.

SetCaption

TableDocumentData.SetCaption

Sets the caption of the table data

Signature SetCaption(position, caption)

Parameters:

New in version NX11.0.0.

License requirements: None.

SetColumnWidths

TableDocumentData.SetColumnWidths

Sets the width array of the columns

Signature SetColumnWidths(widths)

Parameters:widths (list of float) – the column width array

New in version NX11.0.0.

License requirements: None.

SetRowHeigths

TableDocumentData.SetRowHeigths

Sets the height array of the rows

Signature SetRowHeigths(heigths)

Parameters:heigths (list of float) – the column width array

New in version NX11.0.0.

License requirements: None.