Represents a TableBuilder. More...

Inheritance diagram for NXOpen::Diagramming::Tables::TableBuilder:

Public Types
enum	InheritOption { InheritOptionPreferences, InheritOptionCustomerDefaults, InheritOptionSelection }
	Represents the inherit option. More...

Public Types inherited from NXOpen::Diagramming::AnnotationBuilder
enum	TextTypeOption { TextTypeOptionFixed, TextTypeOptionParametric }
	Represents the option NXOpen::Diagramming::AnnotationBuilder::TextType for a NXOpen::Diagramming::AnnotationBuilder . More...

Public Member Functions
NXOpen::Diagramming::RenderingPropertiesBuilder *	BottomBorder ()
	Returns the bottom border rendering properties. More...

NXOpen::Diagramming::Tables::CellSettingsBuilder *	CellSettingsBuilder ()
	Returns the default cell border settings. More...

NXOpen::Diagramming::Tables::ContinuationDataBuilder *	ContinuationDataBuilder ()
	Returns the continuation data. More...

NXOpen::Diagramming::Tables::CellBuilder *	GetCell (int rowIndex, int columnIndex)
	The method to get the cell at the given row and column indexes. More...

NXOpen::Diagramming::Tables::ColumnBuilder *	GetColumn (int columnIndex)
	The method to get the column at the given column index. More...

void	GetFillColor (NXOpen::NXColor *color, double opacity)
	The method to get the fill color. More...

NXOpen::Diagramming::Tables::CellRangeBuilder *	GetHeader (int headerIndex)
	The method to get the header at the given header index. More...

NXOpen::Diagramming::Tables::CellBuilder *	GetHeaderCell (int rowIndex, int columnIndex)
	The method to get the header cell at the given row and column indexes. More...

int	GetNumberOfColumns ()
	Returns the initial number of columns. More...

int	GetNumberOfHeaders ()
	Returns the number of headers. More...

int	GetNumberOfRows ()
	Returns the number of rows. More...

NXOpen::Diagramming::Tables::RowBuilder *	GetRow (int rowIndex)
	The method to get the row at the given row index. More...

void	Inherit (NXOpen::Diagramming::Tables::TableBuilder::InheritOption inheritOption, NXOpen::Diagramming::Annotation *annotation)
	Inherit. More...

double	InitialColumnWidth ()
	Returns the initial width of column. More...

void	InsertColumns (int columnIndex, int numColumns)
	The method to insert the given number of columns after the given column index. More...

void	InsertHeaders (int headerIndex, int numHeaders)
	The method to insert the given number of headers after the given header index. More...

void	InsertRows (int rowIndex, int numRows)
	The method to insert the given number of rows after the given row index. More...

NXOpen::Diagramming::RenderingPropertiesBuilder *	LeftBorder ()
	Returns the left border rendering properties. More...

bool	Locked ()
	Returns the locked flag. More...

void	MergeCells (int topRow, int leftColumn, int bottomRow, int rightColumn)
	The method to merge the cells in the given ranges. More...

void	MergeHeaderCells (int topRow, int leftColumn, int bottomRow, int rightColumn)
	The method to merge the header cells in the given ranges. More...

void	RemoveColumns (int columnIndex, int numColumns)
	The method to remove the given number of columns starting with the given column index. More...

void	RemoveHeaders (int headerIndex, int numHeaders)
	The method to remove the given number of headers starting with the given header index. More...

void	RemoveRows (int rowIndex, int numRows)
	The method to remove the given number of rows starting with the given row index. More...

NXOpen::Diagramming::RenderingPropertiesBuilder *	RightBorder ()
	Returns the right border rendering properties. More...

void	SetFillColor (NXOpen::NXColor *color, double opacity)
	The method to set the fill color. More...

void	SetInitialColumnWidth (double columnWidth)
	Sets the initial width of column. More...

void	SetLocked (bool locked)
	Sets the locked flag. More...

NXOpen::Diagramming::Tables::TableSettingsBuilder *	TableSettingsBuilder ()
	Returns the table settings. More...

NXOpen::Diagramming::RenderingPropertiesBuilder *	TopBorder ()
	Returns the top border rendering properties. More...

void	UnMergeCell (int rowIndex, int columnIndex)
	The method to unmerge the cell at the given row and column indexes. More...

void	UnMergeHeaderCell (int rowIndex, int columnIndex)
	The method to unmerge the header cell at the given row and column indexes. More...

Public Member Functions inherited from NXOpen::Diagramming::AnnotationBuilder
bool	BoundaryDisplay ()
	Returns the visibility of boundary. More...

NXOpen::Diagramming::DiagrammingAnnotationboundarytype	BoundaryType ()
	Returns the boundary type of the annotation Created in NX10.0.0. More...

NXOpen::Diagramming::FormattedStringBuilder *	FormattedStringBuilder ()
	Returns the formatted string of the text. More...

void	SetBoundaryDisplay (bool boundaryDisplay)
	Sets the visibility of boundary. More...

void	SetBoundaryType (NXOpen::Diagramming::DiagrammingAnnotationboundarytype boundaryType)
	Sets the boundary type of the annotation Created in NX10.0.0. More...

void	SetText (const NXString &strValue)
	Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

void	SetText (const char *strValue)
	Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

void	SetTextType (NXOpen::Diagramming::AnnotationBuilder::TextTypeOption textType)
	Sets the text type. More...

NXString	Text ()
	Returns the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

NXOpen::Diagramming::TextStyleBuilder *	TextStyleBuilder ()
	Returns the text style of the annotation. More...

NXOpen::Diagramming::AnnotationBuilder::TextTypeOption	TextType ()
	Returns the text type. More...

Public Member Functions inherited from NXOpen::Diagramming::ConnectableElementBuilder
std::vector < NXOpen::Diagramming::Port * >	GetAllPorts ()
	Gets all ports of this connectable element. More...

std::vector < NXOpen::Diagramming::Port * >	GetPorts (NXOpen::Diagramming::Direction direction)
	Gets ports of this connectable element by the direction. More...

Public Member Functions inherited from NXOpen::Diagramming::SheetElementBuilder
void	GetAllowedTransformations (bool isAllowedTranslation, bool isAllowedRotation, bool isAllowedScale, bool isAllowedShear)
	Get the allowed transformations of the sheet element. More...

void	GetMinNodeSize (std::vector< double > &sizeValues)
	Gets the minimum node size values Created in NX11.0.0. More...

double	Height ()
	Returns the height. More...

NXOpen::Diagramming::DiagrammingSizingpolicy	HeightPolicy ()
	Returns the height policy. More...

bool	Internal ()
	Returns the flag that indicates if the sheet element is internal. More...

NXOpen::Diagramming::Annotation *	Label ()
	Returns the label of this sheet element. More...

NXString	LabelName ()
	Returns the label name of this sheet element. More...

NXOpen::Diagramming::LocationBuilder *	Location ()
	Returns the location of the sheet element relative to another sheet element. More...

NXOpen::Diagramming::DiagrammingLocationstyle	LocationStyle ()
	Returns the location style. More...

bool	MirrorX ()
	Returns the sheet element to Mirror along the X axis. More...

bool	MirrorY ()
	Returns the sheet element to Mirror along the Y axis. More...

NXOpen::Diagramming::SheetElement *	Owner ()
	Returns the owning sheet element. More...

NXOpen::Diagramming::Sheet *	OwningSheet ()
	Returns the owning sheet. More...

NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType	ResizeOption ()
	Returns the resize option of the sheet element Created in NX11.0.0. More...

double	Rotation ()
	Returns the rotation angle that is counter clockwise and relative to the owner. More...

void	SetHeight (double height)
	Sets the height. More...

void	SetHeightPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy heightPolicy)
	Sets the height policy. More...

void	SetLabelName (const NXString &labelname)
	Sets the label name of this sheet element. More...

void	SetLabelName (const char *labelname)
	Sets the label name of this sheet element. More...

void	SetLocationStyle (NXOpen::Diagramming::DiagrammingLocationstyle locationStyle)
	Sets the location style. More...

void	SetMinNodeSize (const std::vector< double > &sizeValues)
	Sets the minimum node size values Created in NX11.0.0. More...

void	SetMirrorX (bool mirrorX)
	Sets the sheet element to Mirror along the X axis. More...

void	SetMirrorY (bool mirrorY)
	Sets the sheet element to Mirror along the Y axis. More...

void	SetOwner (NXOpen::Diagramming::SheetElement *owner)
	Sets the owning sheet element. More...

void	SetOwningSheet (NXOpen::Diagramming::Sheet *owningSheet)
	Set the owning sheet when the sheet element is created. More...

void	SetResizeOption (NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType resizeOption)
	Sets the resize option of the sheet element Created in NX11.0.0. More...

void	SetRotation (double angle)
	Sets the rotation angle that is counter clockwise and relative to the owner. More...

void	SetWidth (double width)
	Sets the width. More...

void	SetWidthPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy widthPolicy)
	Sets the width policy. More...

void	SetX (double x)
	Sets the absolute x coordinate. More...

void	SetY (double y)
	Sets the absolute y coordinate. More...

void	SetZDepth (int zDepth)
	Sets the Z depth. More...

NXOpen::Diagramming::SheetElement *	SourceElement ()
	Returns the source element that records which sheet element it is a copy of. More...

bool	UpToDate ()
	Returns the flag that indicates if the sheet element is up to date. More...

bool	Visible ()
	Returns the flag that indicates if the sheet element is visible. More...

double	Width ()
	Returns the width. More...

NXOpen::Diagramming::DiagrammingSizingpolicy	WidthPolicy ()
	Returns the width policy. More...

double	X ()
	Returns the absolute x coordinate. More...

double	Y ()
	Returns the absolute y coordinate. More...

int	ZDepth ()
	Returns the Z depth. 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

enum NXOpen::Diagramming::Tables::TableBuilder::InheritOption

Represents the inherit option.

Created in NX11.0.0.

Enumerator
InheritOptionPreferences	Setting the inherit from preferences option.
InheritOptionCustomerDefaults	Setting the inherit from customer defaults option.
InheritOptionSelection	Setting the inherit from selection option.

Member Function Documentation

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::TableBuilder::BottomBorder ( )

Returns the bottom border rendering properties.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Tables::CellSettingsBuilder* NXOpen::Diagramming::Tables::TableBuilder::CellSettingsBuilder ( )

Returns the default cell border settings.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Tables::ContinuationDataBuilder* NXOpen::Diagramming::Tables::TableBuilder::ContinuationDataBuilder ( )

Returns the continuation data.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Tables::CellBuilder* NXOpen::Diagramming::Tables::TableBuilder::GetCell	(	int	rowIndex,
		int	columnIndex
	)

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

Returns: Created in NX10.0.0.

License requirements : None

Parameters

rowIndex	rowindex
columnIndex	columnindex

NXOpen::Diagramming::Tables::ColumnBuilder* NXOpen::Diagramming::Tables::TableBuilder::GetColumn ( int columnIndex )

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

Returns: Created in NX10.0.0.

License requirements : None

Parameters

columnIndex columnindex

void NXOpen::Diagramming::Tables::TableBuilder::GetFillColor	(	NXOpen::NXColor **	color,
		double *	opacity
	)

The method to get the fill color.

Created in NX10.0.0.

License requirements : None

Parameters

color	color
opacity	opacity

NXOpen::Diagramming::Tables::CellRangeBuilder* NXOpen::Diagramming::Tables::TableBuilder::GetHeader ( int headerIndex )

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

Returns: Created in NX10.0.0.

License requirements : None

Parameters

headerIndex headerindex

NXOpen::Diagramming::Tables::CellBuilder* NXOpen::Diagramming::Tables::TableBuilder::GetHeaderCell	(	int	rowIndex,
		int	columnIndex
	)

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

Returns: Created in NX10.0.0.

License requirements : None

Parameters

rowIndex	rowindex
columnIndex	columnindex

int NXOpen::Diagramming::Tables::TableBuilder::GetNumberOfColumns ( )

Returns the initial number of columns.

Returns: Created in NX10.0.0.

License requirements : None

int NXOpen::Diagramming::Tables::TableBuilder::GetNumberOfHeaders ( )

Returns the number of headers.

Returns: Created in NX10.0.0.

License requirements : None

int NXOpen::Diagramming::Tables::TableBuilder::GetNumberOfRows ( )

Returns the number of rows.

Returns: Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::Tables::RowBuilder* NXOpen::Diagramming::Tables::TableBuilder::GetRow ( int rowIndex )

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

Returns: Created in NX10.0.0.

License requirements : None

Parameters

rowIndex rowindex

void NXOpen::Diagramming::Tables::TableBuilder::Inherit	(	NXOpen::Diagramming::Tables::TableBuilder::InheritOption	inheritOption,
		NXOpen::Diagramming::Annotation *	annotation
	)

Inherit.

Created in NX11.0.0.

License requirements : None

Parameters

inheritOption	inheritoption
annotation	annotation

double NXOpen::Diagramming::Tables::TableBuilder::InitialColumnWidth ( )

Returns the initial width of column.

Created in NX11.0.1.

License requirements : None

void NXOpen::Diagramming::Tables::TableBuilder::InsertColumns	(	int	columnIndex,
		int	numColumns
	)

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

Created in NX10.0.0.

License requirements : None

Parameters

columnIndex	columnindex
numColumns	numcolumns

void NXOpen::Diagramming::Tables::TableBuilder::InsertHeaders	(	int	headerIndex,
		int	numHeaders
	)

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

Created in NX10.0.0.

License requirements : None

Parameters

headerIndex	headerindex
numHeaders	numheaders

void NXOpen::Diagramming::Tables::TableBuilder::InsertRows	(	int	rowIndex,
		int	numRows
	)

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

Created in NX10.0.0.

License requirements : None

Parameters

rowIndex	rowindex
numRows	numrows

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::TableBuilder::LeftBorder ( )

Returns the left border rendering properties.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::Tables::TableBuilder::Locked ( )

Returns the locked flag.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::Tables::TableBuilder::MergeCells	(	int	topRow,
		int	leftColumn,
		int	bottomRow,
		int	rightColumn
	)

The method to merge the cells in the given ranges.

Created in NX10.0.0.

License requirements : None

Parameters

topRow	toprow
leftColumn	leftcolumn
bottomRow	bottomrow
rightColumn	rightcolumn

void NXOpen::Diagramming::Tables::TableBuilder::MergeHeaderCells	(	int	topRow,
		int	leftColumn,
		int	bottomRow,
		int	rightColumn
	)

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

Created in NX10.0.0.

License requirements : None

Parameters

topRow	toprow
leftColumn	leftcolumn
bottomRow	bottomrow
rightColumn	rightcolumn

void NXOpen::Diagramming::Tables::TableBuilder::RemoveColumns	(	int	columnIndex,
		int	numColumns
	)

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	columnindex
numColumns	numcolumns

void NXOpen::Diagramming::Tables::TableBuilder::RemoveHeaders	(	int	headerIndex,
		int	numHeaders
	)

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	headerindex
numHeaders	numheaders

void NXOpen::Diagramming::Tables::TableBuilder::RemoveRows	(	int	rowIndex,
		int	numRows
	)

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	rowindex
numRows	numrows

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::TableBuilder::RightBorder ( )

Returns the right border rendering properties.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::Tables::TableBuilder::SetFillColor	(	NXOpen::NXColor *	color,
		double	opacity
	)

The method to set the fill color.

Created in NX10.0.0.

License requirements : None

Parameters

color	color
opacity	opacity

void NXOpen::Diagramming::Tables::TableBuilder::SetInitialColumnWidth ( double columnWidth )

Sets the initial width of column.

Created in NX11.0.1.

License requirements : None

Parameters

columnWidth columnwidth

void NXOpen::Diagramming::Tables::TableBuilder::SetLocked ( bool locked )

Sets the locked flag.

Created in NX10.0.0.

License requirements : None

Parameters

locked locked

NXOpen::Diagramming::Tables::TableSettingsBuilder* NXOpen::Diagramming::Tables::TableBuilder::TableSettingsBuilder ( )

Returns the table settings.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::RenderingPropertiesBuilder* NXOpen::Diagramming::Tables::TableBuilder::TopBorder ( )

Returns the top border rendering properties.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::Tables::TableBuilder::UnMergeCell	(	int	rowIndex,
		int	columnIndex
	)

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

Created in NX10.0.0.

License requirements : None

Parameters

rowIndex	rowindex
columnIndex	columnindex

void NXOpen::Diagramming::Tables::TableBuilder::UnMergeHeaderCell	(	int	rowIndex,
		int	columnIndex
	)

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

Created in NX10.0.0.

License requirements : None

Parameters

rowIndex	rowindex
columnIndex	columnindex

The documentation for this class was generated from the following file:

Diagramming_Tables_TableBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation