EditTitleBlockBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# EditTitleBlockBuilder Class

class `NXOpen.Annotations.``EditTitleBlockBuilder`

  Bases: `NXOpen.Annotations.BaseTitleBlockBuilder`

  Represents a `NXOpen.Annotations.EditTitleBlockBuilder` builder

  To create a new instance of this class, use `NXOpen.Annotations.TitleBlockCollection.CreateEditTitleBlockBuilder()`

  New in version NX8.0.0.

# Properties

Property | Description
--- | ---
Cells | Returns the cells
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCellValueForLabel | Return the value of the cell for given label.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
SetCellValueForLabel | Sets the value of the cell for given label.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Method Detail

## GetCellValueForLabel

`EditTitleBlockBuilder.``GetCellValueForLabel`

  Return the value of the cell for given label.

  If multiple title blocks are selected, then value of the cell from the first title block, which has the cell with given label, is returned.

  Signature `GetCellValueForLabel(label)`

  Parameters: | label (str) – Label whose value is queried
  Returns: | Value of the label
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

## SetCellValueForLabel

`EditTitleBlockBuilder.``SetCellValueForLabel`

  Sets the value of the cell for given label.

  If multiple title blocks are selected, then values of cells with the given label in all the title blocks are set.

  Signature `SetCellValueForLabel(label, value)`

  Parameters:

  - label (str) – Label whose value is to be set
  - value (str) – Value of the label

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## Validate

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