NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Diagramming.Tables.TableBuilder Class Reference

Represents a TableBuilder. More...

Inheritance diagram for NXOpen.Diagramming.Tables.TableBuilder:
NXOpen.Diagramming.AnnotationBuilder NXOpen.Diagramming.ConnectableElementBuilder NXOpen.Diagramming.SheetElementBuilder NXOpen.Diagramming.BaseObjectBuilder NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  InheritOption { Preferences, CustomerDefaults, Selection }
 Represents the inherit option. More...
 
- Public Types inherited from NXOpen.Diagramming.AnnotationBuilder
enum  TextTypeOption { Fixed, Parametric }
 Represents the option NXOpen.Diagramming.AnnotationBuilder.TextType for a NXOpen.Diagramming.AnnotationBuilder . More...
 

Public Member Functions

unsafe
NXOpen.Diagramming.Tables.CellBuilder 
GetCell (int rowIndex, int columnIndex)
 The method to get the cell at the given row and column indexes. More...
 
unsafe
NXOpen.Diagramming.Tables.ColumnBuilder 
GetColumn (int columnIndex)
 The method to get the column at the given column index. More...
 
unsafe void GetFillColor (out NXOpen.NXColor color, out double opacity)
 The method to get the fill color. More...
 
unsafe
NXOpen.Diagramming.Tables.CellRangeBuilder 
GetHeader (int headerIndex)
 The method to get the header at the given header index. More...
 
unsafe
NXOpen.Diagramming.Tables.CellBuilder 
GetHeaderCell (int rowIndex, int columnIndex)
 The method to get the header cell at the given row and column indexes. More...
 
unsafe int GetNumberOfColumns ()
 Returns the initial number of columns. More...
 
unsafe int GetNumberOfHeaders ()
 Returns the number of headers. More...
 
unsafe int GetNumberOfRows ()
 Returns the number of rows. More...
 
unsafe
NXOpen.Diagramming.Tables.RowBuilder 
GetRow (int rowIndex)
 The method to get the row at the given row index. More...
 
unsafe void Inherit (NXOpen.Diagramming.Tables.TableBuilder.InheritOption inheritOption, NXOpen.Diagramming.Annotation annotation)
 Inherit. More...
 
unsafe void InsertColumns (int columnIndex, int numColumns)
 The method to insert the given number of columns after the given column index. More...
 
unsafe void InsertHeaders (int headerIndex, int numHeaders)
 The method to insert the given number of headers after the given header index. More...
 
unsafe void InsertRows (int rowIndex, int numRows)
 The method to insert the given number of rows after the given row index. More...
 
unsafe void MergeCells (int topRow, int leftColumn, int bottomRow, int rightColumn)
 The method to merge the cells in the given ranges. More...
 
unsafe void MergeHeaderCells (int topRow, int leftColumn, int bottomRow, int rightColumn)
 The method to merge the header cells in the given ranges. More...
 
unsafe void RemoveColumns (int columnIndex, int numColumns)
 The method to remove the given number of columns starting with the given column index. More...
 
unsafe void RemoveHeaders (int headerIndex, int numHeaders)
 The method to remove the given number of headers starting with the given header index. More...
 
unsafe void RemoveRows (int rowIndex, int numRows)
 The method to remove the given number of rows starting with the given row index. More...
 
unsafe void SetFillColor (NXOpen.NXColor color, double opacity)
 The method to set the fill color. More...
 
unsafe void UnMergeCell (int rowIndex, int columnIndex)
 The method to unmerge the cell at the given row and column indexes. More...
 
unsafe void UnMergeHeaderCell (int rowIndex, int columnIndex)
 The method to unmerge the header cell at the given row and column indexes. More...
 

Properties

unsafe
NXOpen.Diagramming.RenderingPropertiesBuilder 
BottomBorder [get]
 Returns the bottom border rendering properties. More...
 
unsafe
NXOpen.Diagramming.Tables.CellSettingsBuilder 
CellSettingsBuilder [get]
 Returns the default cell border settings. More...
 
unsafe
NXOpen.Diagramming.Tables.ContinuationDataBuilder 
ContinuationDataBuilder [get]
 Returns the continuation data. More...
 
unsafe
NXOpen.Diagramming.RenderingPropertiesBuilder 
DefaultBottomBorder [get]
 Returns the default bottom border rendering properties. More...
 
unsafe
NXOpen.Diagramming.RenderingPropertiesBuilder 
DefaultRightBorder [get]
 Returns the default right border rendering properties. More...
 
unsafe double InitialColumnWidth [get, set]
 Returns or sets the initial width of column. More...
 
unsafe
NXOpen.Diagramming.RenderingPropertiesBuilder 
LeftBorder [get]
 Returns the left border rendering properties. More...
 
unsafe bool Locked [get, set]
 Returns or sets the locked flag. More...
 
unsafe
NXOpen.Diagramming.RenderingPropertiesBuilder 
RightBorder [get]
 Returns the right border rendering properties. More...
 
unsafe
NXOpen.Diagramming.Tables.TableSettingsBuilder 
TableSettingsBuilder [get]
 Returns the table settings. More...
 
unsafe
NXOpen.Diagramming.RenderingPropertiesBuilder 
TopBorder [get]
 Returns the top border rendering properties. More...
 
- Properties inherited from NXOpen.Diagramming.AnnotationBuilder
unsafe bool BoundaryDisplay [get, set]
 Returns or sets the visibility of boundary. More...
 
unsafe
NXOpen.Diagramming.DiagrammingAnnotationboundarytype 
BoundaryType [get, set]
 Returns or sets the boundary type of the annotation More...
 
unsafe
NXOpen.Diagramming.FormattedStringBuilder 
FormattedStringBuilder [get]
 Returns the formatted string of the text. More...
 
unsafe string Text [get, set]
 Returns or sets the text should be used only when textType is Diagramming. More...
 
unsafe
NXOpen.Diagramming.TextStyleBuilder 
TextStyleBuilder [get]
 Returns the text style of the annotation. More...
 
unsafe
NXOpen.Diagramming.AnnotationBuilder.TextTypeOption 
TextType [get, set]
 Returns or sets the text type. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

Represents a TableBuilder.

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

Created in NX10.0.0

Member Enumeration Documentation

Represents the inherit option.

Enumerator
Preferences 

Setting the inherit from preferences option

CustomerDefaults 

Setting the inherit from customer defaults option

Selection 

Setting the inherit from selection option

Member Function Documentation

unsafe NXOpen.Diagramming.Tables.CellBuilder NXOpen.Diagramming.Tables.TableBuilder.GetCell ( int  rowIndex,
int  columnIndex 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
columnIndex
Returns
unsafe NXOpen.Diagramming.Tables.ColumnBuilder NXOpen.Diagramming.Tables.TableBuilder.GetColumn ( int  columnIndex)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
columnIndex
Returns
unsafe void NXOpen.Diagramming.Tables.TableBuilder.GetFillColor ( out NXOpen.NXColor  color,
out double  opacity 
)
inline

The method to get the fill color.

Created in NX10.0.0

License requirements: None.

Parameters
color
opacity
unsafe NXOpen.Diagramming.Tables.CellRangeBuilder NXOpen.Diagramming.Tables.TableBuilder.GetHeader ( int  headerIndex)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
headerIndex
Returns
unsafe NXOpen.Diagramming.Tables.CellBuilder NXOpen.Diagramming.Tables.TableBuilder.GetHeaderCell ( int  rowIndex,
int  columnIndex 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
columnIndex
Returns
unsafe int NXOpen.Diagramming.Tables.TableBuilder.GetNumberOfColumns ( )
inline

Returns the initial number of columns.

Created in NX10.0.0

License requirements: None.

Returns
unsafe int NXOpen.Diagramming.Tables.TableBuilder.GetNumberOfHeaders ( )
inline

Returns the number of headers.

Created in NX10.0.0

License requirements: None.

Returns
unsafe int NXOpen.Diagramming.Tables.TableBuilder.GetNumberOfRows ( )
inline

Returns the number of rows.

Created in NX10.0.0

License requirements: None.

Returns
unsafe NXOpen.Diagramming.Tables.RowBuilder NXOpen.Diagramming.Tables.TableBuilder.GetRow ( int  rowIndex)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
Returns
unsafe void NXOpen.Diagramming.Tables.TableBuilder.Inherit ( NXOpen.Diagramming.Tables.TableBuilder.InheritOption  inheritOption,
NXOpen.Diagramming.Annotation  annotation 
)
inline

Inherit.

Created in NX11.0.0

License requirements: None.

Parameters
inheritOption
annotation
unsafe void NXOpen.Diagramming.Tables.TableBuilder.InsertColumns ( int  columnIndex,
int  numColumns 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
columnIndex
numColumns
unsafe void NXOpen.Diagramming.Tables.TableBuilder.InsertHeaders ( int  headerIndex,
int  numHeaders 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
headerIndex
numHeaders
unsafe void NXOpen.Diagramming.Tables.TableBuilder.InsertRows ( int  rowIndex,
int  numRows 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
numRows
unsafe void NXOpen.Diagramming.Tables.TableBuilder.MergeCells ( int  topRow,
int  leftColumn,
int  bottomRow,
int  rightColumn 
)
inline

The method to merge the cells in the given ranges.

Created in NX10.0.0

License requirements: None.

Parameters
topRow
leftColumn
bottomRow
rightColumn
unsafe void NXOpen.Diagramming.Tables.TableBuilder.MergeHeaderCells ( int  topRow,
int  leftColumn,
int  bottomRow,
int  rightColumn 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
topRow
leftColumn
bottomRow
rightColumn
unsafe void NXOpen.Diagramming.Tables.TableBuilder.RemoveColumns ( int  columnIndex,
int  numColumns 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
columnIndex
numColumns
unsafe void NXOpen.Diagramming.Tables.TableBuilder.RemoveHeaders ( int  headerIndex,
int  numHeaders 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
headerIndex
numHeaders
unsafe void NXOpen.Diagramming.Tables.TableBuilder.RemoveRows ( int  rowIndex,
int  numRows 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
numRows
unsafe void NXOpen.Diagramming.Tables.TableBuilder.SetFillColor ( NXOpen.NXColor  color,
double  opacity 
)
inline

The method to set the fill color.

Created in NX10.0.0

License requirements: None.

Parameters
color
opacity
unsafe void NXOpen.Diagramming.Tables.TableBuilder.UnMergeCell ( int  rowIndex,
int  columnIndex 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
columnIndex
unsafe void NXOpen.Diagramming.Tables.TableBuilder.UnMergeHeaderCell ( int  rowIndex,
int  columnIndex 
)
inline

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

Created in NX10.0.0

License requirements: None.

Parameters
rowIndex
columnIndex

Property Documentation

unsafe NXOpen.Diagramming.RenderingPropertiesBuilder NXOpen.Diagramming.Tables.TableBuilder.BottomBorder
get

Returns the bottom border rendering properties.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.Tables.CellSettingsBuilder NXOpen.Diagramming.Tables.TableBuilder.CellSettingsBuilder
get

Returns the default cell border settings.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.Tables.ContinuationDataBuilder NXOpen.Diagramming.Tables.TableBuilder.ContinuationDataBuilder
get

Returns the continuation data.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.RenderingPropertiesBuilder NXOpen.Diagramming.Tables.TableBuilder.DefaultBottomBorder
get

Returns the default bottom border rendering properties.

Created in NX1872.0.0

License requirements: None.

unsafe NXOpen.Diagramming.RenderingPropertiesBuilder NXOpen.Diagramming.Tables.TableBuilder.DefaultRightBorder
get

Returns the default right border rendering properties.

Created in NX1872.0.0

License requirements: None.

unsafe double NXOpen.Diagramming.Tables.TableBuilder.InitialColumnWidth
getset

Returns or sets the initial width of column.

Created in NX11.0.1

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.RenderingPropertiesBuilder NXOpen.Diagramming.Tables.TableBuilder.LeftBorder
get

Returns the left border rendering properties.

Created in NX10.0.0

License requirements: None.

unsafe bool NXOpen.Diagramming.Tables.TableBuilder.Locked
getset

Returns or sets the locked flag.

Created in NX10.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.Diagramming.RenderingPropertiesBuilder NXOpen.Diagramming.Tables.TableBuilder.RightBorder
get

Returns the right border rendering properties.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.Tables.TableSettingsBuilder NXOpen.Diagramming.Tables.TableBuilder.TableSettingsBuilder
get

Returns the table settings.

Created in NX10.0.0

License requirements: None.

unsafe NXOpen.Diagramming.RenderingPropertiesBuilder NXOpen.Diagramming.Tables.TableBuilder.TopBorder
get

Returns the top border rendering properties.

Created in NX10.0.0

License requirements: None.


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