TableBuilder Class

class NXOpen.Diagramming.Tables.TableBuilder

Bases: NXOpen.Diagramming.AnnotationBuilder

Represents a TableBuilder.

To create a new instance of this class, use NXOpen.Diagramming.Tables.TableCollection.CreateTableBuilder()

New in version NX10.0.0.

Properties

Property Description
BottomBorder Returns the bottom border rendering properties.
BoundaryDisplay Returns or sets the visibility of boundary.
BoundaryType Returns or sets the boundary type of the annotation
CellSettingsBuilder Returns the default cell border settings.
ContinuationDataBuilder Returns the continuation data.
FormattedStringBuilder Returns the formatted string of the text.
Height Returns or sets the height.
HeightPolicy Returns or sets the height policy.
InitialColumnWidth Returns or sets the initial width of column.
Internal Returns the flag that indicates if the sheet element is internal.
Label Returns the label of this sheet element.
LabelName Returns or sets the label name of this sheet element.
LeftBorder Returns the left border rendering properties.
Location Returns the location of the sheet element relative to another sheet element.
LocationStyle Returns or sets the location style.
Locked Returns or sets the locked flag.
MirrorX Returns or sets the sheet element to Mirror along the X axis.
MirrorY Returns or sets the sheet element to Mirror along the Y axis.
Owner Returns or sets the owning sheet element.
OwningSheet Returns the owning sheet.
ResizeOption Returns or sets the resize option of the sheet element
RightBorder Returns the right border rendering properties.
Rotation Returns or sets the rotation angle that is counter clockwise and relative to the owner.
SourceElement Returns the source element that records which sheet element it is a copy of.
TableSettingsBuilder Returns the table settings.
Tag Returns the Tag for this object.
Text Returns or sets the text should be used only when textType is Diagramming.
TextStyleBuilder Returns the text style of the annotation.
TextType Returns or sets the text type.
TopBorder Returns the top border rendering properties.
UpToDate Returns the flag that indicates if the sheet element is up to date.
Visible Returns the flag that indicates if the sheet element is visible.
Width Returns or sets the width.
WidthPolicy Returns or sets the width policy.
NXOpen.Diagramming.SheetElementBuilder.X Returns or sets the absolute x coordinate.
NXOpen.Diagramming.SheetElementBuilder.Y Returns or sets the absolute y coordinate.
ZDepth Returns or sets the Z depth.

Methods

Method Description
Commit Commits any edits that have been applied to the builder.
Destroy Deletes the builder, and cleans up any objects created by the builder.
GetAllPorts Gets all ports of this connectable element.
GetAllowedTransformations Get the allowed transformations of the sheet element.
GetCell The method to get the cell at the given row and column indexes.
GetColumn The method to get the column at the given column index.
GetCommittedObjects For builders that create more than one object, this method returns the objects that are created by commit.
GetFillColor The method to get the fill color.
GetHeader The method to get the header at the given header index.
GetHeaderCell The method to get the header cell at the given row and column indexes.
GetMinNodeSize Gets the minimum node size values
GetNumberOfColumns Returns the initial number of columns.
GetNumberOfHeaders Returns the number of headers.
GetNumberOfRows Returns the number of rows.
GetObject Returns the object currently being edited by this builder.
GetPorts Gets ports of this connectable element by the direction.
GetRow The method to get the row at the given row index.
Inherit Inherit.
InsertColumns The method to insert the given number of columns after the given column index.
InsertHeaders The method to insert the given number of headers after the given header index.
InsertRows The method to insert the given number of rows after the given row index.
MergeCells The method to merge the cells in the given ranges.
MergeHeaderCells The method to merge the header cells in the given ranges.
RemoveColumns The method to remove the given number of columns starting with the given column index.
RemoveHeaders The method to remove the given number of headers starting with the given header index.
RemoveRows The method to remove the given number of rows starting with the given row index.
SetFillColor The method to set the fill color.
SetMinNodeSize Sets the minimum node size values
SetOwningSheet Set the owning sheet when the sheet element is created.
ShowResults Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnMergeCell The method to unmerge the cell at the given row and column indexes.
UnMergeHeaderCell The method to unmerge the header cell at the given row and column indexes.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

TableBuilderInheritOption Enumeration Represents the inherit option.

Property Detail

BottomBorder

TableBuilder.BottomBorder

Returns the bottom border rendering properties.

-------------------------------------

Getter Method

Signature BottomBorder

Returns:
Return type:NXOpen.Diagramming.RenderingPropertiesBuilder

New in version NX10.0.0.

License requirements: None.

CellSettingsBuilder

TableBuilder.CellSettingsBuilder

Returns the default cell border settings.

-------------------------------------

Getter Method

Signature CellSettingsBuilder

Returns:
Return type:NXOpen.Diagramming.Tables.CellSettingsBuilder

New in version NX10.0.0.

License requirements: None.

ContinuationDataBuilder

TableBuilder.ContinuationDataBuilder

Returns the continuation data.

-------------------------------------

Getter Method

Signature ContinuationDataBuilder

Returns:
Return type:NXOpen.Diagramming.Tables.ContinuationDataBuilder

New in version NX10.0.0.

License requirements: None.

InitialColumnWidth

TableBuilder.InitialColumnWidth

Returns or sets the initial width of column.

-------------------------------------

Getter Method

Signature InitialColumnWidth

Returns:
Return type:float

New in version NX11.0.1.

License requirements: None.

-------------------------------------

Setter Method

Signature InitialColumnWidth

Parameters:columnWidth (float) –

New in version NX11.0.1.

License requirements: None.

LeftBorder

TableBuilder.LeftBorder

Returns the left border rendering properties.

-------------------------------------

Getter Method

Signature LeftBorder

Returns:
Return type:NXOpen.Diagramming.RenderingPropertiesBuilder

New in version NX10.0.0.

License requirements: None.

Locked

TableBuilder.Locked

Returns or sets the locked flag.

-------------------------------------

Getter Method

Signature Locked

Returns:
Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Locked

Parameters:locked (bool) –

New in version NX10.0.0.

License requirements: None.

RightBorder

TableBuilder.RightBorder

Returns the right border rendering properties.

-------------------------------------

Getter Method

Signature RightBorder

Returns:
Return type:NXOpen.Diagramming.RenderingPropertiesBuilder

New in version NX10.0.0.

License requirements: None.

TableSettingsBuilder

TableBuilder.TableSettingsBuilder

Returns the table settings.

-------------------------------------

Getter Method

Signature TableSettingsBuilder

Returns:
Return type:NXOpen.Diagramming.Tables.TableSettingsBuilder

New in version NX10.0.0.

License requirements: None.

TopBorder

TableBuilder.TopBorder

Returns the top border rendering properties.

-------------------------------------

Getter Method

Signature TopBorder

Returns:
Return type:NXOpen.Diagramming.RenderingPropertiesBuilder

New in version NX10.0.0.

License requirements: None.

Method Detail

GetCell

TableBuilder.GetCell

The method to get the cell at the given row and column indexes.

Signature GetCell(rowIndex, columnIndex)

Parameters:
  • rowIndex (int) –
  • columnIndex (int) –
Returns:
Return type:

NXOpen.Diagramming.Tables.CellBuilder

New in version NX10.0.0.

License requirements: None.

GetColumn

TableBuilder.GetColumn

The method to get the column at the given column index.

Signature GetColumn(columnIndex)

Parameters:columnIndex (int) –
Returns:
Return type:NXOpen.Diagramming.Tables.ColumnBuilder

New in version NX10.0.0.

License requirements: None.

GetFillColor

TableBuilder.GetFillColor

The method to get the fill color.

Signature GetFillColor()

Returns:a tuple
Return type:A tuple consisting of (color, opacity) color is a Id. opacity is a float.

New in version NX10.0.0.

License requirements: None.

GetHeader

TableBuilder.GetHeader

The method to get the header at the given header index.

Signature GetHeader(headerIndex)

Parameters:headerIndex (int) –
Returns:
Return type:NXOpen.Diagramming.Tables.CellRangeBuilder

New in version NX10.0.0.

License requirements: None.

GetHeaderCell

TableBuilder.GetHeaderCell

The method to get the header cell at the given row and column indexes.

Signature GetHeaderCell(rowIndex, columnIndex)

Parameters:
  • rowIndex (int) –
  • columnIndex (int) –
Returns:
Return type:

NXOpen.Diagramming.Tables.CellBuilder

New in version NX10.0.0.

License requirements: None.

GetNumberOfColumns

TableBuilder.GetNumberOfColumns

Returns the initial number of columns.

Signature GetNumberOfColumns()

Returns:
Return type:int

New in version NX10.0.0.

License requirements: None.

GetNumberOfHeaders

TableBuilder.GetNumberOfHeaders

Returns the number of headers.

Signature GetNumberOfHeaders()

Returns:
Return type:int

New in version NX10.0.0.

License requirements: None.

GetNumberOfRows

TableBuilder.GetNumberOfRows

Returns the number of rows.

Signature GetNumberOfRows()

Returns:
Return type:int

New in version NX10.0.0.

License requirements: None.

GetRow

TableBuilder.GetRow

The method to get the row at the given row index.

Signature GetRow(rowIndex)

Parameters:rowIndex (int) –
Returns:
Return type:NXOpen.Diagramming.Tables.RowBuilder

New in version NX10.0.0.

License requirements: None.

Inherit

TableBuilder.Inherit

Inherit.

Signature Inherit(inheritOption, annotation)

Parameters:

New in version NX11.0.0.

License requirements: None.

InsertColumns

TableBuilder.InsertColumns

The method to insert the given number of columns after the given column index.

Signature InsertColumns(columnIndex, numColumns)

Parameters:
  • columnIndex (int) –
  • numColumns (int) –

New in version NX10.0.0.

License requirements: None.

InsertHeaders

TableBuilder.InsertHeaders

The method to insert the given number of headers after the given header index.

Signature InsertHeaders(headerIndex, numHeaders)

Parameters:
  • headerIndex (int) –
  • numHeaders (int) –

New in version NX10.0.0.

License requirements: None.

InsertRows

TableBuilder.InsertRows

The method to insert the given number of rows after the given row index.

Signature InsertRows(rowIndex, numRows)

Parameters:
  • rowIndex (int) –
  • numRows (int) –

New in version NX10.0.0.

License requirements: None.

MergeCells

TableBuilder.MergeCells

The method to merge the cells in the given ranges.

Signature MergeCells(topRow, leftColumn, bottomRow, rightColumn)

Parameters:
  • topRow (int) –
  • leftColumn (int) –
  • bottomRow (int) –
  • rightColumn (int) –

New in version NX10.0.0.

License requirements: None.

MergeHeaderCells

TableBuilder.MergeHeaderCells

The method to merge the header cells in the given ranges.

Signature MergeHeaderCells(topRow, leftColumn, bottomRow, rightColumn)

Parameters:
  • topRow (int) –
  • leftColumn (int) –
  • bottomRow (int) –
  • rightColumn (int) –

New in version NX10.0.0.

License requirements: None.

RemoveColumns

TableBuilder.RemoveColumns

The method to remove the given number of columns starting with the given column index.

Signature RemoveColumns(columnIndex, numColumns)

Parameters:
  • columnIndex (int) –
  • numColumns (int) –

New in version NX10.0.0.

License requirements: None.

RemoveHeaders

TableBuilder.RemoveHeaders

The method to remove the given number of headers starting with the given header index.

Signature RemoveHeaders(headerIndex, numHeaders)

Parameters:
  • headerIndex (int) –
  • numHeaders (int) –

New in version NX10.0.0.

License requirements: None.

RemoveRows

TableBuilder.RemoveRows

The method to remove the given number of rows starting with the given row index.

Signature RemoveRows(rowIndex, numRows)

Parameters:
  • rowIndex (int) –
  • numRows (int) –

New in version NX10.0.0.

License requirements: None.

SetFillColor

TableBuilder.SetFillColor

The method to set the fill color.

Signature SetFillColor(color, opacity)

Parameters:
  • color (Id) –
  • opacity (float) –

New in version NX10.0.0.

License requirements: None.

UnMergeCell

TableBuilder.UnMergeCell

The method to unmerge the cell at the given row and column indexes.

Signature UnMergeCell(rowIndex, columnIndex)

Parameters:
  • rowIndex (int) –
  • columnIndex (int) –

New in version NX10.0.0.

License requirements: None.

UnMergeHeaderCell

TableBuilder.UnMergeHeaderCell

The method to unmerge the header cell at the given row and column indexes.

Signature UnMergeHeaderCell(rowIndex, columnIndex)

Parameters:
  • rowIndex (int) –
  • columnIndex (int) –

New in version NX10.0.0.

License requirements: None.

Validate

TableBuilder.Validate

Validate whether the inputs to the component are sufficient for commit to be called.

If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

Signature Validate()

Returns:Was self validation successful
Return type:bool

New in version NX3.0.1.

License requirements: None.