ReplaceSymbolBuilder Class¶
-
class
NXOpen.Annotations.ReplaceSymbolBuilder¶ Bases:
NXOpen.BuilderRepresents a Builder for Replace Custom Symbol functionality
To create a new instance of this class, use
NXOpen.Annotations.CustomSymbolCollection.CreateReplaceSymbolBuilder()Default values.
Property Value ReplaceAll 0 New in version NX8.0.1.
Properties¶
| Property | Description |
|---|---|
| IsPartSymbol | Returns or sets the flag indicating whether the selected symbol is part symbol |
| ReplaceAll | Returns or sets the flag indicating whether to replace all instances of selected symbols |
| Symbol | Returns the symbol |
| SymbolName | Returns or sets the symbol name |
| SymbolPath | Returns or sets the symbol path |
| 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. |
| 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. |
| 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. |
Property Detail¶
IsPartSymbol¶
-
ReplaceSymbolBuilder.IsPartSymbol¶ Returns or sets the flag indicating whether the selected symbol is part symbol
-------------------------------------Getter Method
Signature
IsPartSymbolReturns: Return type: bool New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
IsPartSymbolParameters: isPartSymbol (bool) – New in version NX8.0.1.
License requirements: drafting (“DRAFTING”)
ReplaceAll¶
-
ReplaceSymbolBuilder.ReplaceAll¶ Returns or sets the flag indicating whether to replace all instances of selected symbols
-------------------------------------Getter Method
Signature
ReplaceAllReturns: Return type: bool New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
ReplaceAllParameters: replaceAll (bool) – New in version NX8.0.1.
License requirements: drafting (“DRAFTING”)
Symbol¶
-
ReplaceSymbolBuilder.Symbol¶ Returns the symbol
-------------------------------------Getter Method
Signature
SymbolReturns: Return type: NXOpen.Annotations.SelectBaseCustomSymbolListNew in version NX8.0.1.
License requirements: None.
SymbolName¶
-
ReplaceSymbolBuilder.SymbolName¶ Returns or sets the symbol name
-------------------------------------Getter Method
Signature
SymbolNameReturns: Return type: str New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
SymbolNameParameters: symbolName (str) – New in version NX8.0.1.
License requirements: drafting (“DRAFTING”)
SymbolPath¶
-
ReplaceSymbolBuilder.SymbolPath¶ Returns or sets the symbol path
-------------------------------------Getter Method
Signature
SymbolPathReturns: Return type: str New in version NX8.0.1.
License requirements: None.
-------------------------------------Setter Method
Signature
SymbolPathParameters: symbolPath (str) – New in version NX8.0.1.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
ReplaceSymbolBuilder.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.