IdSymbolBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# IdSymbolBuilder Class

class `NXOpen.Annotations.``IdSymbolBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Annotations.IdSymbol` builder

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

  Default values.

  Property | Value
  --- | ---
  Size | 0

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ForeshorteningSymbol | Returns the foreshortening symbol builder
Inherit | Returns the inherit The id symbol from which the style properties are inherited
Leader | Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation
LowerText | Returns or sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.
Origin | Returns the origin, where the symbol is going to be displayed
Placement | Returns an annotation placement object
Size | Returns or sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle
Style | Returns the style
SymbolType | Returns or sets the symbol type
Tag | Returns the Tag for this object.
Type | Returns or sets the symbol type
UpperText | Returns or sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

# 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.
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.
SetPreviewObject | Sets the preview object for dialog creation of id symbols
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.

# Enumerations

IdSymbolBuilderSymbolTypes Enumeration | the valid types for an id symbol

# Property Detail

## ForeshorteningSymbol

`IdSymbolBuilder.``ForeshorteningSymbol`

  Returns the foreshortening symbol builder

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

  Getter Method

  Signature `ForeshorteningSymbol`

  Returns: |
  Return type: | `NXOpen.Annotations.ForeshorteningSymbolBuilder`

  New in version NX10.0.0.

  License requirements: None.

## Inherit

`IdSymbolBuilder.``Inherit`

  Returns the inherit The id symbol from which the style properties are inherited

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

  Getter Method

  Signature `Inherit`

  Returns: |
  Return type: | `NXOpen.SelectObject`

  New in version NX5.0.0.

  License requirements: None.

## Leader

`IdSymbolBuilder.``Leader`

  Returns the `NXOpen.Annotations.LeaderBuilder` for the annotation

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

  Getter Method

  Signature `Leader`

  Returns: |
  Return type: | `NXOpen.Annotations.LeaderBuilder`

  New in version NX6.0.0.

  License requirements: None.

## LowerText

`IdSymbolBuilder.``LowerText`

  Returns or sets the lower text The text displayed in the lower portion of the divided symbol In case Quadrant Circle symbol, the lower text is placed in the lower right quadrant just above the horizontal dividing line.

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

  Getter Method

  Signature `LowerText`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LowerText`

  Parameters: | lowerText (str) –

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## Origin

`IdSymbolBuilder.``Origin`

  Returns the origin, where the symbol is going to be displayed

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

  Getter Method

  Signature `Origin`

  Returns: |
  Return type: | `NXOpen.Annotations.OriginBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Placement

`IdSymbolBuilder.``Placement`

  Returns an annotation placement object

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

  Getter Method

  Signature `Placement`

  Returns: |
  Return type: | `NXOpen.Annotations.AnnotationPlacement`

  New in version NX5.0.0.

  Deprecated since version NX6.0.0: This functionality is no longer supported.

  License requirements: None.

## Size

`IdSymbolBuilder.``Size`

  Returns or sets the size The circle symbols are measured by diameter, the rounded box is measured by length, and all other symbols are measured by a circumscribed circle

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

  Getter Method

  Signature `Size`

  Returns: |
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Size`

  Parameters: | size (float) –

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## Style

`IdSymbolBuilder.``Style`

  Returns the style

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

  Getter Method

  Signature `Style`

  Returns: |
  Return type: | `NXOpen.Annotations.StyleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## SymbolType

`IdSymbolBuilder.``SymbolType`

  Returns or sets the symbol type

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

  Getter Method

  Signature `SymbolType`

  Returns: |
  Return type: | `NXOpen.Annotations.IdSymbolBuilderSymbolTypes`

  New in version NX5.0.0.

  Deprecated since version NX6.0.0: Use `NXOpen.Annotations.IdSymbolBuilder.Type()` instead.

  License requirements: None.

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

  Setter Method

  Signature `SymbolType`

  Parameters: | symbolType (`NXOpen.Annotations.IdSymbolBuilderSymbolTypes`) –

  New in version NX5.0.0.

  Deprecated since version NX6.0.0: Use `NXOpen.Annotations.IdSymbolBuilder.Type()` instead.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## Type

`IdSymbolBuilder.``Type`

  Returns or sets the symbol type

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.Annotations.IdSymbolBuilderSymbolTypes`

  New in version NX6.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.Annotations.IdSymbolBuilderSymbolTypes`) –

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

## UpperText

`IdSymbolBuilder.``UpperText`

  Returns or sets the upper text The text displayed in the upper portion of the divided symbol In case Quadrant Circle symbol, the upper text is placed in the upper left quadrant just above the horizontal dividing line.

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

  Getter Method

  Signature `UpperText`

  Returns: |
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UpperText`

  Parameters: | upperText (str) –

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”) OR geometric_tol (“GDT”)

# Method Detail

## SetPreviewObject

`IdSymbolBuilder.``SetPreviewObject`

  Sets the preview object for dialog creation of id symbols

  Signature `SetPreviewObject(symbol)`

  Parameters: | symbol (`NXOpen.Annotations.IdSymbol`) – rubberbanding symbol

  New in version NX5.0.0.

  Deprecated since version NX6.0.0: This functionality is no longer supported.

  License requirements: None.

## Validate

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