TableCellStyleBuilder Class¶
-
class
NXOpen.Annotations.TableCellStyleBuilder¶ Bases:
NXOpen.TaggedObject,NXOpen.GeometricUtilities.IComponentBuilderRepresents a
NXOpen.Annotations.TableCellStyleBuilder.This class queries and sets preferences for table cells.
New in version NX8.0.0.
Properties¶
| Property | Description |
|---|---|
| BorderColor | Returns or sets the border color |
| BorderFont | Returns or sets the border font |
| BorderLocation | Returns or sets the border location |
| BorderWidth | Returns or sets the border width |
| CellFormatType | Returns or sets the cell format |
| DateFormatType | Returns or sets the cell date format. |
| Format | Returns or sets the cell format |
| IncrementIsPercentage | Returns or sets the increment as percent flag |
| IncrementValue | Returns or sets the increment value |
| IsAFormula | Returns or sets the is a formula |
| Precision | Returns or sets the precision |
| Prefix | Returns or sets the prefix |
| ProtectCell | Returns or sets the protect cell |
| SlantAngle | Returns or sets the slant angle in degrees |
| Suffix | Returns or sets the suffix |
| TabDirection | Returns or sets the tab direction |
| Tag | Returns the Tag for this object. |
| TextAlignment | Returns or sets the text alignment |
| TimeFormatType | Returns or sets the cell time format. |
| Url | Returns or sets the url |
| ZeroDisplay | Returns or sets the zero display |
Methods¶
| Method | Description |
|---|---|
| GetFitMethods | Returns the fit methods |
| SetFitMethods | Set fit methods |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
| TableCellStyleBuilderBorderLocationType Enumeration | the valid border location types |
| TableCellStyleBuilderCellFormatTypes Enumeration | the cell format types |
| TableCellStyleBuilderDateFormatTypes Enumeration | the date format types |
| TableCellStyleBuilderFitMethodType Enumeration | the fit method types |
| TableCellStyleBuilderFormatType Enumeration | the valid cell format types |
| TableCellStyleBuilderTabDirectionType Enumeration | the valid tab direction |
| TableCellStyleBuilderTextAlignmentType Enumeration | the valid text alignment types |
| TableCellStyleBuilderTimeFormatTypes Enumeration | the time format types |
| TableCellStyleBuilderZeroDisplayType Enumeration | the valid zero display types |
Property Detail¶
BorderColor¶
-
TableCellStyleBuilder.BorderColor¶ Returns or sets the border color
-------------------------------------Getter Method
Signature
BorderColorReturns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BorderColorParameters: borderColor (int) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
BorderFont¶
-
TableCellStyleBuilder.BorderFont¶ Returns or sets the border font
-------------------------------------Getter Method
Signature
BorderFontReturns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BorderFontParameters: borderFont (int) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
BorderLocation¶
-
TableCellStyleBuilder.BorderLocation¶ Returns or sets the border location
-------------------------------------Getter Method
Signature
BorderLocationReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderBorderLocationTypeNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BorderLocationParameters: borderLocation ( NXOpen.Annotations.TableCellStyleBuilderBorderLocationType) –New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
BorderWidth¶
-
TableCellStyleBuilder.BorderWidth¶ Returns or sets the border width
-------------------------------------Getter Method
Signature
BorderWidthReturns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
BorderWidthParameters: borderWidth (int) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
CellFormatType¶
-
TableCellStyleBuilder.CellFormatType¶ Returns or sets the cell format
-------------------------------------Getter Method
Signature
CellFormatTypeReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderCellFormatTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
CellFormatTypeParameters: format ( NXOpen.Annotations.TableCellStyleBuilderCellFormatTypes) –New in version NX10.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
DateFormatType¶
-
TableCellStyleBuilder.DateFormatType¶ Returns or sets the cell date format.
It is valid to use this when the
NXOpen.Annotations.TableCellStyleBuilder.CellFormatType()is eitherNXOpen.Annotations.TableCellStyleBuilderCellFormatTypes.DateorNXOpen.Annotations.TableCellStyleBuilderCellFormatTypes.DateTime.-------------------------------------Getter Method
Signature
DateFormatTypeReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderDateFormatTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
DateFormatTypeParameters: dateFormat ( NXOpen.Annotations.TableCellStyleBuilderDateFormatTypes) –New in version NX10.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Format¶
-
TableCellStyleBuilder.Format¶ Returns or sets the cell format
-------------------------------------Getter Method
Signature
FormatReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderFormatTypeNew in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.TableCellStyleBuilder.CellFormatType()instead.License requirements: None.
-------------------------------------Setter Method
Signature
FormatParameters: format ( NXOpen.Annotations.TableCellStyleBuilderFormatType) –New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.TableCellStyleBuilder.CellFormatType()instead.License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
IncrementIsPercentage¶
-
TableCellStyleBuilder.IncrementIsPercentage¶ Returns or sets the increment as percent flag
-------------------------------------Getter Method
Signature
IncrementIsPercentageReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IncrementIsPercentageParameters: incrementValue (bool) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
IncrementValue¶
-
TableCellStyleBuilder.IncrementValue¶ Returns or sets the increment value
-------------------------------------Getter Method
Signature
IncrementValueReturns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IncrementValueParameters: incrementValue (float) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
IsAFormula¶
-
TableCellStyleBuilder.IsAFormula¶ Returns or sets the is a formula
-------------------------------------Getter Method
Signature
IsAFormulaReturns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
IsAFormulaParameters: isAFormula (bool) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Precision¶
-
TableCellStyleBuilder.Precision¶ Returns or sets the precision
-------------------------------------Getter Method
Signature
PrecisionReturns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PrecisionParameters: precision (int) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Prefix¶
-
TableCellStyleBuilder.Prefix¶ Returns or sets the prefix
-------------------------------------Getter Method
Signature
PrefixReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
PrefixParameters: prefix (str) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ProtectCell¶
-
TableCellStyleBuilder.ProtectCell¶ Returns or sets the protect cell
-------------------------------------Getter Method
Signature
ProtectCellReturns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ProtectCellParameters: protectCell (bool) – New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
SlantAngle¶
-
TableCellStyleBuilder.SlantAngle¶ Returns or sets the slant angle in degrees
-------------------------------------Getter Method
Signature
SlantAngleReturns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SlantAngleParameters: slantAngle (float) – New in version NX8.5.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Suffix¶
-
TableCellStyleBuilder.Suffix¶ Returns or sets the suffix
-------------------------------------Getter Method
Signature
SuffixReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
SuffixParameters: suffix (str) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
TabDirection¶
-
TableCellStyleBuilder.TabDirection¶ Returns or sets the tab direction
-------------------------------------Getter Method
Signature
TabDirectionReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderTabDirectionTypeNew in version NX9.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TabDirectionParameters: tabDirection ( NXOpen.Annotations.TableCellStyleBuilderTabDirectionType) –New in version NX9.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
TextAlignment¶
-
TableCellStyleBuilder.TextAlignment¶ Returns or sets the text alignment
-------------------------------------Getter Method
Signature
TextAlignmentReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderTextAlignmentTypeNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TextAlignmentParameters: textAlignment ( NXOpen.Annotations.TableCellStyleBuilderTextAlignmentType) –New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
TimeFormatType¶
-
TableCellStyleBuilder.TimeFormatType¶ Returns or sets the cell time format.
It is valid to use this when the
NXOpen.Annotations.TableCellStyleBuilder.CellFormatType`()is eitherNXOpen.Annotations.TableCellStyleBuilderCellFormatTypes.TimeorNXOpen.Annotations.TableCellStyleBuilderCellFormatTypes.DateTime.-------------------------------------Getter Method
Signature
TimeFormatTypeReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderTimeFormatTypesNew in version NX10.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
TimeFormatTypeParameters: timeFormat ( NXOpen.Annotations.TableCellStyleBuilderTimeFormatTypes) –New in version NX10.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Url¶
-
TableCellStyleBuilder.Url¶ Returns or sets the url
-------------------------------------Getter Method
Signature
UrlReturns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
UrlParameters: url (str) – New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
ZeroDisplay¶
-
TableCellStyleBuilder.ZeroDisplay¶ Returns or sets the zero display
-------------------------------------Getter Method
Signature
ZeroDisplayReturns: Return type: NXOpen.Annotations.TableCellStyleBuilderZeroDisplayTypeNew in version NX8.0.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ZeroDisplayParameters: zeroDisplay ( NXOpen.Annotations.TableCellStyleBuilderZeroDisplayType) –New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Method Detail¶
GetFitMethods¶
-
TableCellStyleBuilder.GetFitMethods¶ Returns the fit methods
Signature
GetFitMethods()Returns: Return type: list of NXOpen.Annotations.TableCellStyleBuilderFitMethodTypeNew in version NX8.0.0.
License requirements: None.
SetFitMethods¶
-
TableCellStyleBuilder.SetFitMethods¶ Set fit methods
Signature
SetFitMethods(fitMethods)Parameters: fitMethods (list of NXOpen.Annotations.TableCellStyleBuilderFitMethodType) –New in version NX8.0.0.
License requirements: geometric_tol (“GDT”) OR drafting (“DRAFTING”)
Validate¶
-
TableCellStyleBuilder.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.