TableColumnBuilder Class¶
-
class
NXOpen.Annotations.TableColumnBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.Annotations.TableColumnBuilder.This class queries and sets settings specific to parts list column when creating or editing parts list settings.
New in version NX9.0.0.
Properties¶
| Property | Description |
|---|---|
| AttributeName | Returns or sets the attribute name specifies the attribute name for cells in column. |
| Category | Returns or sets the category specifies the type of column. |
| DefaultText | Returns or sets the default text specifies the default text set for the column cells. |
| IncludeNestedAssemblies | Returns or sets the include nested assy specified the nested assy setting. |
| KeyField | Returns or sets the key field specifies whether column is key column. |
| ProtectCells | Returns or sets the protect cells specifies whether cells of column are protected. |
| Scope | Returns or sets the scope enum specifies whether settings are to be applied to all cells of column or only cells of new rows in column. |
| SelectParentComponent | Returns the select parent component. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| TableColumnBuilderCategoryType Enumeration | The options specify the type of column. |
| TableColumnBuilderScopeType Enumeration | The options determine whether to apply settings to all cells or only to cells of new rows. |
Property Detail¶
AttributeName¶
-
TableColumnBuilder.AttributeName¶ Returns or sets the attribute name specifies the attribute name for cells in column.
-------------------------------------Getter Method
Signature
AttributeNameReturns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
AttributeNameParameters: attributeName (str) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Category¶
-
TableColumnBuilder.Category¶ Returns or sets the category specifies the type of column.
-------------------------------------Getter Method
Signature
CategoryReturns: Return type: NXOpen.Annotations.TableColumnBuilderCategoryTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CategoryParameters: category ( NXOpen.Annotations.TableColumnBuilderCategoryType) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
DefaultText¶
-
TableColumnBuilder.DefaultText¶ Returns or sets the default text specifies the default text set for the column cells.
-------------------------------------Getter Method
Signature
DefaultTextReturns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DefaultTextParameters: defaultText (str) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
IncludeNestedAssemblies¶
-
TableColumnBuilder.IncludeNestedAssemblies¶ Returns or sets the include nested assy specified the nested assy setting.
-------------------------------------Getter Method
Signature
IncludeNestedAssembliesReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IncludeNestedAssembliesParameters: includeNestedAssemblies (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
KeyField¶
-
TableColumnBuilder.KeyField¶ Returns or sets the key field specifies whether column is key column.
-------------------------------------Getter Method
Signature
KeyFieldReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
KeyFieldParameters: keyField (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
ProtectCells¶
-
TableColumnBuilder.ProtectCells¶ Returns or sets the protect cells specifies whether cells of column are protected.
-------------------------------------Getter Method
Signature
ProtectCellsReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProtectCellsParameters: protectCells (bool) – New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Scope¶
-
TableColumnBuilder.Scope¶ Returns or sets the scope enum specifies whether settings are to be applied to all cells of column or only cells of new rows in column.
-------------------------------------Getter Method
Signature
ScopeReturns: Return type: NXOpen.Annotations.TableColumnBuilderScopeTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ScopeParameters: scope ( NXOpen.Annotations.TableColumnBuilderScopeType) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
SelectParentComponent¶
-
TableColumnBuilder.SelectParentComponent¶ Returns the select parent component.
-------------------------------------Getter Method
Signature
SelectParentComponentReturns: Return type: NXOpen.SelectDisplayableObjectNew in version NX9.0.0.
License requirements: None.
Method Detail¶
Validate¶
-
TableColumnBuilder.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.