CellSettingsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CellSettingsBuilder Class

class `NXOpen.Diagramming.Tables.``CellSettingsBuilder`

  Bases: `NXOpen.Diagramming.BaseTaggedObjectBuilder`

  Represents a CellSettingsBuilder.

  This is a sub-builder class and cannot be directly instantiated

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
ContentAlignment | Returns or sets the content alignment of the cell settings.
FillColor | Returns or sets the fill color.
FillOpacity | Returns or sets the fill opacity.
OverflowBehavior | Returns or sets the overflow behavior of the cell settings.
Tag | Returns the Tag for this object.
ZeroDisplay | Returns or sets the zero display of the cell settings.

# Methods

Method | Description
--- | ---
GetContentTextStyle | Gets context text style .
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## ContentAlignment

`CellSettingsBuilder.``ContentAlignment`

  Returns or sets the content alignment of the cell settings.

  `-------------------------------------`

  Getter Method

  Signature `ContentAlignment`

  Returns: |
  Return type: | `NXOpen.Diagramming.Tables.ContentAlignment`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ContentAlignment`

  Parameters: | contentAlignment (`NXOpen.Diagramming.Tables.ContentAlignment`) –

  New in version NX10.0.0.

  License requirements: None.

## FillColor

`CellSettingsBuilder.``FillColor`

  Returns or sets the fill color.

  `-------------------------------------`

  Getter Method

  Signature `FillColor`

  Returns: |
  Return type: | Id

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FillColor`

  Parameters: | colorId (Id) –

  New in version NX10.0.0.

  License requirements: None.

## FillOpacity

`CellSettingsBuilder.``FillOpacity`

  Returns or sets the fill opacity.

  The range of opacity is from 0.0 to 1.0. 0.0 is completely transparent and 1.0 is completely opaque.

  `-------------------------------------`

  Getter Method

  Signature `FillOpacity`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FillOpacity`

  Parameters: | opacity (float) –

  New in version NX10.0.0.

  License requirements: None.

## OverflowBehavior

`CellSettingsBuilder.``OverflowBehavior`

  Returns or sets the overflow behavior of the cell settings.

  `-------------------------------------`

  Getter Method

  Signature `OverflowBehavior`

  Returns: |
  Return type: | `NXOpen.Diagramming.Tables.OverflowBehavior`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `OverflowBehavior`

  Parameters: | overflowBehavior (`NXOpen.Diagramming.Tables.OverflowBehavior`) –

  New in version NX10.0.0.

  License requirements: None.

## ZeroDisplay

`CellSettingsBuilder.``ZeroDisplay`

  Returns or sets the zero display of the cell settings.

  `-------------------------------------`

  Getter Method

  Signature `ZeroDisplay`

  Returns: |
  Return type: | `NXOpen.Diagramming.Tables.ZeroDisplay`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ZeroDisplay`

  Parameters: | zeroDisplay (`NXOpen.Diagramming.Tables.ZeroDisplay`) –

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## GetContentTextStyle

`CellSettingsBuilder.``GetContentTextStyle`

  Gets context text style .

  Signature `GetContentTextStyle()`

  Returns: |
  Return type: | `NXOpen.Diagramming.TextStyleBuilder`

  New in version NX11.0.1.

  License requirements: None.

## Validate

`CellSettingsBuilder.``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.