NXOpen::Annotations::TableColumnBuilder Class Reference

Represents a NXOpen::Annotations::TableColumnBuilder . More...

Inheritance diagram for NXOpen::Annotations::TableColumnBuilder:

Public Types
enum	CategoryType { CategoryTypeGeneral, CategoryTypeCallout, CategoryTypeQuantity }
	The options specify the type of column. More...
enum	ScopeType { ScopeTypeCellsinNewRows, ScopeTypeAllCellsinColumn }
	The options determine whether to apply settings to all cells or only to cells of new rows. More...

Public Member Functions
NXString	AttributeName ()
	Returns the attribute name specifies the attribute name for cells in column. More...
NXOpen::Annotations::TableColumnBuilder::CategoryType	Category ()
	Returns the category specifies the type of column. More...
NXString	DefaultText ()
	Returns the default text specifies the default text set for the column cells. More...
bool	IncludeNestedAssemblies ()
	Returns the include nested assy specified the nested assy setting. More...
bool	KeyField ()
	Returns the key field specifies whether column is key column. More...
bool	ProtectCells ()
	Returns the protect cells specifies whether cells of column are protected. More...
NXOpen::Annotations::TableColumnBuilder::ScopeType	Scope ()
	Returns the scope enum specifies whether settings are to be applied to all cells of column or only cells of new rows in column. More...
NXOpen::SelectDisplayableObject *	SelectParentComponent ()
	Returns the select parent component. More...
void	SetAttributeName (const NXString &attributeName)
	Sets the attribute name specifies the attribute name for cells in column. More...
void	SetAttributeName (const char *attributeName)
	Sets the attribute name specifies the attribute name for cells in column. More...
void	SetCategory (NXOpen::Annotations::TableColumnBuilder::CategoryType category)
	Sets the category specifies the type of column. More...
void	SetDefaultText (const NXString &defaultText)
	Sets the default text specifies the default text set for the column cells. More...
void	SetDefaultText (const char *defaultText)
	Sets the default text specifies the default text set for the column cells. More...
void	SetIncludeNestedAssemblies (bool includeNestedAssemblies)
	Sets the include nested assy specified the nested assy setting. More...
void	SetKeyField (bool keyField)
	Sets the key field specifies whether column is key column. More...
void	SetProtectCells (bool protectCells)
	Sets the protect cells specifies whether cells of column are protected. More...
void	SetScope (NXOpen::Annotations::TableColumnBuilder::ScopeType scope)
	Sets the scope enum specifies whether settings are to be applied to all cells of column or only cells of new rows in column. More...
virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...
Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Annotations::TableColumnBuilder .

This class queries and sets settings specific to parts list column when creating or editing parts list settings.

Created in NX9.0.0.

Member Enumeration Documentation

enum NXOpen::Annotations::TableColumnBuilder::CategoryType

The options specify the type of column.

Enumerator
CategoryTypeGeneral	general
CategoryTypeCallout	callout
CategoryTypeQuantity	quantity

enum NXOpen::Annotations::TableColumnBuilder::ScopeType

The options determine whether to apply settings to all cells or only to cells of new rows.

Enumerator
ScopeTypeCellsinNewRows	cellsin new rows
ScopeTypeAllCellsinColumn	all cellsin column

Member Function Documentation

NXString NXOpen::Annotations::TableColumnBuilder::AttributeName

(

)

Returns the attribute name specifies the attribute name for cells in column.

Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::TableColumnBuilder::CategoryType NXOpen::Annotations::TableColumnBuilder::Category

(

)

Returns the category specifies the type of column.

Created in NX9.0.0.

License requirements : None

NXString NXOpen::Annotations::TableColumnBuilder::DefaultText

(

)

Returns the default text specifies the default text set for the column cells.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::TableColumnBuilder::IncludeNestedAssemblies

(

)

Returns the include nested assy specified the nested assy setting.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::TableColumnBuilder::KeyField

(

)

Returns the key field specifies whether column is key column.

Created in NX9.0.0.

License requirements : None

bool NXOpen::Annotations::TableColumnBuilder::ProtectCells

(

)

Returns the protect cells specifies whether cells of column are protected.

Created in NX9.0.0.

License requirements : None

NXOpen::Annotations::TableColumnBuilder::ScopeType NXOpen::Annotations::TableColumnBuilder::Scope

(

)

Returns the scope enum specifies whether settings are to be applied to all cells of column or only cells of new rows in column.

Created in NX9.0.0.

License requirements : None

NXOpen::SelectDisplayableObject* NXOpen::Annotations::TableColumnBuilder::SelectParentComponent

(

)

Returns the select parent component.

Created in NX9.0.0.

License requirements : None

void NXOpen::Annotations::TableColumnBuilder::SetAttributeName

(

const NXString &

attributeName

)

Sets the attribute name specifies the attribute name for cells in column.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

attributeName

attributename

void NXOpen::Annotations::TableColumnBuilder::SetAttributeName

(

const char *

attributeName

)

Sets the attribute name specifies the attribute name for cells in column.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

attributeName

attributename

void NXOpen::Annotations::TableColumnBuilder::SetCategory

(

NXOpen::Annotations::TableColumnBuilder::CategoryType

category

)

Sets the category specifies the type of column.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

category

category

void NXOpen::Annotations::TableColumnBuilder::SetDefaultText

(

const NXString &

defaultText

)

Sets the default text specifies the default text set for the column cells.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

defaultText

defaulttext

void NXOpen::Annotations::TableColumnBuilder::SetDefaultText

(

const char *

defaultText

)

Sets the default text specifies the default text set for the column cells.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

defaultText

defaulttext

void NXOpen::Annotations::TableColumnBuilder::SetIncludeNestedAssemblies

(

bool

includeNestedAssemblies

)

Sets the include nested assy specified the nested assy setting.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

includeNestedAssemblies

includenestedassemblies

void NXOpen::Annotations::TableColumnBuilder::SetKeyField

(

bool

keyField

)

Sets the key field specifies whether column is key column.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

keyField

keyfield

void NXOpen::Annotations::TableColumnBuilder::SetProtectCells

(

bool

protectCells

)

Sets the protect cells specifies whether cells of column are protected.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

protectCells

protectcells

void NXOpen::Annotations::TableColumnBuilder::SetScope

(

NXOpen::Annotations::TableColumnBuilder::ScopeType

scope

)

Sets the scope enum specifies whether settings are to be applied to all cells of column or only cells of new rows in column.

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters

scope

scope

virtual bool NXOpen::Annotations::TableColumnBuilder::Validate ( )

virtual

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.

Returns

Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

---

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

• Annotations_TableColumnBuilder.hxx