TableCellStyleBuilder Class¶
-
class
NXOpen.Annotations.
TableCellStyleBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents 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 @return |
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
BorderColor()
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BorderColor(borderColor)
Parameters: 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
BorderFont()
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BorderFont(borderFont)
Parameters: 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
BorderLocation()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderBorderLocationType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BorderLocation(borderLocation)
Parameters: 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
BorderWidth()
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
BorderWidth(borderWidth)
Parameters: 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
CellFormatType()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderCellFormatTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CellFormatType(format)
Parameters: 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.Date
orNXOpen.Annotations.TableCellStyleBuilderCellFormatTypes.DateTime
.-------------------------------------
Getter Method
Signature
DateFormatType()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderDateFormatTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DateFormatType(dateFormat)
Parameters: 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
Format()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderFormatType
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Annotations.TableCellStyleBuilder.CellFormatType
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Format(format)
Parameters: 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
IncrementIsPercentage()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IncrementIsPercentage(incrementValue)
Parameters: 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
IncrementValue()
Returns: Return type: float New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IncrementValue(incrementValue)
Parameters: 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
IsAFormula()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsAFormula(isAFormula)
Parameters: 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
Precision()
Returns: Return type: int New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Precision(precision)
Parameters: 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
Prefix()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Prefix(prefix)
Parameters: 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
ProtectCell()
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ProtectCell(protectCell)
Parameters: 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
SlantAngle()
Returns: Return type: float New in version NX8.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SlantAngle(slantAngle)
Parameters: 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
Suffix()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Suffix(suffix)
Parameters: 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
TabDirection()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderTabDirectionType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TabDirection(tabDirection)
Parameters: 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
TextAlignment()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderTextAlignmentType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TextAlignment(textAlignment)
Parameters: 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.Time
orNXOpen.Annotations.TableCellStyleBuilderCellFormatTypes.DateTime
.-------------------------------------
Getter Method
Signature
TimeFormatType()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderTimeFormatTypes
New in version NX10.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TimeFormatType(timeFormat)
Parameters: 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
Url()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Url(url)
Parameters: 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
ZeroDisplay()
Returns: Return type: NXOpen.Annotations.TableCellStyleBuilderZeroDisplayType
New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ZeroDisplay(zeroDisplay)
Parameters: 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.TableCellStyleBuilderFitMethodType
New 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.