TitleBlockCellBuilder Class

class NXOpen.Annotations.TitleBlockCellBuilder

Bases: NXOpen.TaggedObject, NXOpen.GeometricUtilities.IComponentBuilder

Represents a NXOpen.Annotations.TitleBlockCellBuilder

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

New in version NX8.0.0.

Properties

Property Description
Cell Returns the tabular note cell corresponding to this title block cell
EditableText Returns or sets the editable text of the cell
Label Returns or sets the cell label
Lock Returns or sets the lock status
Tag Returns the Tag for this object.
Text Returns the evaluated text of the cell.

Methods

Method Description
EditCell Edits the title block cell attributes such as lock status, content type, value, label etc.
Validate Validate whether the inputs to the component are sufficient for commit to be called.

Property Detail

Cell

TitleBlockCellBuilder.Cell

Returns the tabular note cell corresponding to this title block cell

-------------------------------------

Getter Method

Signature Cell

Returns:The tabular note cell corresponding to this title block cell
Return type:NXOpen.DisplayableObject

New in version NX10.0.2.

License requirements: None.

EditableText

TitleBlockCellBuilder.EditableText

Returns or sets the editable text of the cell

-------------------------------------

Getter Method

Signature EditableText

Returns:
Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature EditableText

Parameters:text (str) –

New in version NX8.0.0.

License requirements: drafting (“DRAFTING”)

Label

TitleBlockCellBuilder.Label

Returns or sets the cell label

-------------------------------------

Getter Method

Signature Label

Returns:
Return type:str

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Label

Parameters:label (str) –

New in version NX8.0.0.

License requirements: drafting (“DRAFTING”)

Lock

TitleBlockCellBuilder.Lock

Returns or sets the lock status

-------------------------------------

Getter Method

Signature Lock

Returns:
Return type:bool

New in version NX8.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Lock

Parameters:lockStatus (bool) –

New in version NX8.0.0.

License requirements: drafting (“DRAFTING”)

Text

TitleBlockCellBuilder.Text

Returns the evaluated text of the cell.

If the cell cannot be evaluated then its raw text is returned.

-------------------------------------

Getter Method

Signature Text

Returns:
Return type:str

New in version NX10.0.2.

License requirements: None.

Method Detail

EditCell

TitleBlockCellBuilder.EditCell

Edits the title block cell attributes such as lock status, content type, value, label etc.

Signature EditCell(lockStatus, contentType, value, label, canChangeLockStatus)

Parameters:
  • lockStatus (bool) – cell lock status
  • contentType (int) – cell content type
  • value (str) – cell value
  • label (str) – cell label
  • canChangeLockStatus (bool) – can change lock status of cell

New in version NX10.0.2.

License requirements: drafting (“DRAFTING”)

Validate

TitleBlockCellBuilder.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.