EditSymbolDisplayBuilder Class¶
-
class
NXOpen.Annotations.EditSymbolDisplayBuilder¶ Bases:
NXOpen.BuilderRepresents a EditSymbolPieces builder
To create a new instance of this class, use
NXOpen.Annotations.CustomSymbolCollection.EditSymbolDisplayBuilder()Default values.
Property Value Font Solid Width Thin New in version NX7.5.0.
Properties¶
| Property | Description |
|---|---|
| Color | Returns or sets the color picker |
| Font | Returns or sets the enum font |
| Style | Returns the style |
| Tag | Returns the Tag for this object. |
| Width | Returns or sets the enum width |
Methods¶
| Method | Description |
|---|---|
| ApplyCfw | Apply color font width |
| ApplyStyle | Apply text preferences |
| 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. |
| SelectComponent | Stores index of the custom symbol component for editing display |
| 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¶
| EditSymbolDisplayBuilderFontTypes Enumeration | The Enum represent font types. |
| EditSymbolDisplayBuilderWidthTypes Enumeration | The Enum represent width types NXOpen.Annotations.EditSymbolDisplayBuilder.Width() and NXOpen.Annotations.EditSymbolDisplayBuilder.Width() will set this width type at builder side and will be used to apply the same on the selected contents after commit |
Property Detail¶
Color¶
-
EditSymbolDisplayBuilder.Color¶ Returns or sets the color picker
-------------------------------------Getter Method
Signature
ColorReturns: Return type: Id New in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
ColorParameters: colorPicker (Id) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Font¶
-
EditSymbolDisplayBuilder.Font¶ Returns or sets the enum font
-------------------------------------Getter Method
Signature
FontReturns: Return type: NXOpen.Annotations.EditSymbolDisplayBuilderFontTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
FontParameters: enumFont ( NXOpen.Annotations.EditSymbolDisplayBuilderFontTypes) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Style¶
-
EditSymbolDisplayBuilder.Style¶ Returns the style
-------------------------------------Getter Method
Signature
StyleReturns: Return type: NXOpen.Annotations.StyleBuilderNew in version NX7.5.0.
License requirements: None.
Width¶
-
EditSymbolDisplayBuilder.Width¶ Returns or sets the enum width
-------------------------------------Getter Method
Signature
WidthReturns: Return type: NXOpen.Annotations.EditSymbolDisplayBuilderWidthTypesNew in version NX7.5.0.
License requirements: None.
-------------------------------------Setter Method
Signature
WidthParameters: enumWidth ( NXOpen.Annotations.EditSymbolDisplayBuilderWidthTypes) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
ApplyCfw¶
-
EditSymbolDisplayBuilder.ApplyCfw¶ Apply color font width
Signature
ApplyCfw()New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
ApplyStyle¶
-
EditSymbolDisplayBuilder.ApplyStyle¶ Apply text preferences
Signature
ApplyStyle()New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
SelectComponent¶
-
EditSymbolDisplayBuilder.SelectComponent¶ Stores index of the custom symbol component for editing display
Signature
SelectComponent(sid)Parameters: sid (str) – sid of selected component New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
EditSymbolDisplayBuilder.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.