CellBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# CellBuilder Class

class `NXOpen.Diagramming.Tables.``CellBuilder`

  Bases: `NXOpen.Diagramming.BaseTaggedObjectBuilder`

  Represents a CellBuilder.

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

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
BottomBorder | Returns or sets the bottom border line rendering properties.
FormattedStringBuilder | Returns the formatted string of the text.
LeftBorder | Returns or sets the left border line rendering properties.
Locked | Returns or sets the locked flag.
RightBorder | Returns or sets the right border line rendering properties.
Tag | Returns the Tag for this object.
Text | Returns or sets the text on cell.
TopBorder | Returns or sets the top border line rendering properties.

# Methods

Method | Description
--- | ---
DeleteContent | Delete cell contents.
GetCellSettings | Gets cell settings.
GetContent | Gets cell content.
SetContent | Sets cell content.
SetImageFileLocation | Sets cell image file location.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## BottomBorder

`CellBuilder.``BottomBorder`

  Returns or sets the bottom border line rendering properties.

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

  Getter Method

  Signature `BottomBorder`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BottomBorder`

  Parameters: | properties (`NXOpen.Diagramming.RenderingPropertiesBuilder`) –

  New in version NX10.0.0.

  License requirements: None.

## FormattedStringBuilder

`CellBuilder.``FormattedStringBuilder`

  Returns the formatted string of the text.

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

  Getter Method

  Signature `FormattedStringBuilder`

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

  New in version NX11.0.1.

  License requirements: None.

## LeftBorder

`CellBuilder.``LeftBorder`

  Returns or sets the left border line rendering properties.

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

  Getter Method

  Signature `LeftBorder`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LeftBorder`

  Parameters: | properties (`NXOpen.Diagramming.RenderingPropertiesBuilder`) –

  New in version NX10.0.0.

  License requirements: None.

## Locked

`CellBuilder.``Locked`

  Returns or sets the locked flag.

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

  Getter Method

  Signature `Locked`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Locked`

  Parameters: | locked (bool) –

  New in version NX10.0.0.

  License requirements: None.

## RightBorder

`CellBuilder.``RightBorder`

  Returns or sets the right border line rendering properties.

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

  Getter Method

  Signature `RightBorder`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `RightBorder`

  Parameters: | properties (`NXOpen.Diagramming.RenderingPropertiesBuilder`) –

  New in version NX10.0.0.

  License requirements: None.

## Text

`CellBuilder.``Text`

  Returns or sets the text on cell.

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

  Getter Method

  Signature `Text`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `Text`

  Parameters: | strValue (str) –

  New in version NX10.0.0.

  License requirements: None.

## TopBorder

`CellBuilder.``TopBorder`

  Returns or sets the top border line rendering properties.

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

  Getter Method

  Signature `TopBorder`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `TopBorder`

  Parameters: | properties (`NXOpen.Diagramming.RenderingPropertiesBuilder`) –

  New in version NX10.0.0.

  License requirements: None.

# Method Detail

## DeleteContent

`CellBuilder.``DeleteContent`

  Delete cell contents.

  Signature `DeleteContent()`

  New in version NX10.0.0.

  License requirements: None.

## GetCellSettings

`CellBuilder.``GetCellSettings`

  Gets cell settings.

  Signature `GetCellSettings()`

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

  New in version NX10.0.0.

  License requirements: None.

## GetContent

`CellBuilder.``GetContent`

  Gets cell content.

  Signature `GetContent()`

  Returns: |
  Return type: | list of `NXOpen.Diagramming.Tables.SizedSymbol`

  New in version NX10.0.0.

  License requirements: None.

## SetContent

`CellBuilder.``SetContent`

  Sets cell content.

  Signature `SetContent(symbols)`

  Parameters: | symbols (list of `NXOpen.Diagramming.Tables.SizedSymbol`) –

  New in version NX10.0.0.

  License requirements: None.

## SetImageFileLocation

`CellBuilder.``SetImageFileLocation`

  Sets cell image file location.

  Signature `SetImageFileLocation(fileName)`

  Parameters: | fileName (str) –

  New in version NX10.0.0.

  License requirements: None.

## Validate

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