BaseCustomSymbolBuilder Class¶
-
class
NXOpen.Annotations.
BaseCustomSymbolBuilder
¶ Bases:
NXOpen.Builder
Represents a base Builder for Drafting and PMI Custom Symbol
This is an abstract class, and cannot be instantiated.
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
Angle | Returns the angle |
AnnotationPreference | Returns or sets the enum annot pref. |
ControlledNoteTitle | Returns or sets the controlled note title |
GeometryPreference | Returns or sets the enum geom pref. |
HorizontalFlip | Returns or sets the horizontal flip |
Integer | Returns or sets the integer value of selected text |
IsPartSymbol | Returns or sets the is part symbol. |
Leader | Returns the NXOpen.Annotations.LeaderBuilder for the annotation |
LockStatus | Returns or sets the get symbol lock property |
MasterSymbolName | Returns or sets the master symbol Name. |
MasterSymbolPath | Returns or sets the master symbol path. |
Origin | Returns the origin |
PartiallyControlledNoteTitle | Returns or sets the partially controlled note title |
Real | Returns or sets the real value of selected text |
Scale | Returns the scale |
SmashSymbol | Returns or sets the smash symbol |
Style | Returns the style builder |
Tag | Returns the Tag for this object. |
Texts | Returns the texts |
VerticalFlip | Returns or sets the vertical flip |
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. |
GetArbitraryNoteTitle | Returns the arbitrary note value in an array. |
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. |
GetSymbol | Returns the custom symbol @return The custom symbol |
SelectPartSymbol | Selects part custom symbol |
SelectSymbol | Selects custom symbol |
SelectText | Selects the node index of custom symbol text |
SetArbitraryNoteTitle | Sets the arbitrary note value. |
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¶
BaseCustomSymbolBuilderAnnotationPreferences Enumeration | Enum for Annotation Preferences This is used by NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference() and NXOpen.Annotations.BaseCustomSymbolBuilder.AnnotationPreference() to set the annotation preferences for a symbol |
BaseCustomSymbolBuilderGeometryPreferences Enumeration | Enum for Geometric Preferences This is used by NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference() and NXOpen.Annotations.BaseCustomSymbolBuilder.GeometryPreference() to set the geometric preferences for a symbol |
Property Detail¶
Angle¶
-
BaseCustomSymbolBuilder.
Angle
¶ Returns the angle
-------------------------------------
Getter Method
Signature
Angle()
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
AnnotationPreference¶
-
BaseCustomSymbolBuilder.
AnnotationPreference
¶ Returns or sets the enum annot pref.
This is used while creating the object and it is non-editable property
-------------------------------------
Getter Method
Signature
AnnotationPreference()
Returns: Return type: NXOpen.Annotations.BaseCustomSymbolBuilderAnnotationPreferences
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AnnotationPreference(enumAnnotPref)
Parameters: enumAnnotPref ( NXOpen.Annotations.BaseCustomSymbolBuilderAnnotationPreferences
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
ControlledNoteTitle¶
-
BaseCustomSymbolBuilder.
ControlledNoteTitle
¶ Returns or sets the controlled note title
-------------------------------------
Getter Method
Signature
ControlledNoteTitle()
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ControlledNoteTitle(controlledNoteTitle)
Parameters: controlledNoteTitle (int) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
GeometryPreference¶
-
BaseCustomSymbolBuilder.
GeometryPreference
¶ Returns or sets the enum geom pref.
This is used while creating the object and it is non-editable property
-------------------------------------
Getter Method
Signature
GeometryPreference()
Returns: Return type: NXOpen.Annotations.BaseCustomSymbolBuilderGeometryPreferences
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GeometryPreference(enumGeomPref)
Parameters: enumGeomPref ( NXOpen.Annotations.BaseCustomSymbolBuilderGeometryPreferences
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
HorizontalFlip¶
-
BaseCustomSymbolBuilder.
HorizontalFlip
¶ Returns or sets the horizontal flip
-------------------------------------
Getter Method
Signature
HorizontalFlip()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalFlip(horizontalFlip)
Parameters: horizontalFlip (bool) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Integer¶
-
BaseCustomSymbolBuilder.
Integer
¶ Returns or sets the integer value of selected text
-------------------------------------
Getter Method
Signature
Integer()
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Integer(integer)
Parameters: integer (int) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
IsPartSymbol¶
-
BaseCustomSymbolBuilder.
IsPartSymbol
¶ Returns or sets the is part symbol.
This is used while creating the object and it is non-editable property
-------------------------------------
Getter Method
Signature
IsPartSymbol()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IsPartSymbol(isPartSymbol)
Parameters: isPartSymbol (bool) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Leader¶
-
BaseCustomSymbolBuilder.
Leader
¶ Returns the
NXOpen.Annotations.LeaderBuilder
for the annotation-------------------------------------
Getter Method
Signature
Leader()
Returns: Return type: NXOpen.Annotations.LeaderBuilder
New in version NX7.5.0.
License requirements: None.
LockStatus¶
-
BaseCustomSymbolBuilder.
LockStatus
¶ Returns or sets the get symbol lock property
-------------------------------------
Getter Method
Signature
LockStatus()
Returns: Return type: bool New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LockStatus(lockUpdate)
Parameters: lockUpdate (bool) – New in version NX8.0.0.
License requirements: drafting (“DRAFTING”)
MasterSymbolName¶
-
BaseCustomSymbolBuilder.
MasterSymbolName
¶ Returns or sets the master symbol Name.
This is used while creating the object and it is non-editable property
-------------------------------------
Getter Method
Signature
MasterSymbolName()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MasterSymbolName(masterSymbolName)
Parameters: masterSymbolName (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
MasterSymbolPath¶
-
BaseCustomSymbolBuilder.
MasterSymbolPath
¶ Returns or sets the master symbol path.
This is used while creating the object and it is non-editable property
-------------------------------------
Getter Method
Signature
MasterSymbolPath()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MasterSymbolPath(masterSymbolPath)
Parameters: masterSymbolPath (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Origin¶
-
BaseCustomSymbolBuilder.
Origin
¶ Returns the origin
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Annotations.OriginBuilder
New in version NX7.5.0.
License requirements: None.
PartiallyControlledNoteTitle¶
-
BaseCustomSymbolBuilder.
PartiallyControlledNoteTitle
¶ Returns or sets the partially controlled note title
-------------------------------------
Getter Method
Signature
PartiallyControlledNoteTitle()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
PartiallyControlledNoteTitle(partiallyControlledNoteTitle)
Parameters: partiallyControlledNoteTitle (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Real¶
-
BaseCustomSymbolBuilder.
Real
¶ Returns or sets the real value of selected text
-------------------------------------
Getter Method
Signature
Real()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Real(real)
Parameters: real (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Scale¶
-
BaseCustomSymbolBuilder.
Scale
¶ Returns the scale
-------------------------------------
Getter Method
Signature
Scale()
Returns: Return type: NXOpen.Expression
New in version NX7.5.0.
License requirements: None.
SmashSymbol¶
-
BaseCustomSymbolBuilder.
SmashSymbol
¶ Returns or sets the smash symbol
-------------------------------------
Getter Method
Signature
SmashSymbol()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SmashSymbol(smashSymbol)
Parameters: smashSymbol (bool) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Style¶
-
BaseCustomSymbolBuilder.
Style
¶ Returns the style builder
-------------------------------------
Getter Method
Signature
Style()
Returns: Return type: NXOpen.Annotations.StyleBuilder
New in version NX7.5.0.
License requirements: None.
Texts¶
-
BaseCustomSymbolBuilder.
Texts
¶ Returns the texts
-------------------------------------
Getter Method
Signature
Texts()
Returns: Return type: NXOpen.Annotations.MasterSymbolListItemBuilderList
New in version NX7.5.0.
License requirements: None.
VerticalFlip¶
-
BaseCustomSymbolBuilder.
VerticalFlip
¶ Returns or sets the vertical flip
-------------------------------------
Getter Method
Signature
VerticalFlip()
Returns: Return type: bool New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalFlip(verticalFlip)
Parameters: verticalFlip (bool) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
GetArbitraryNoteTitle¶
-
BaseCustomSymbolBuilder.
GetArbitraryNoteTitle
¶ Returns the arbitrary note value in an array.
This should be used only after
Annotations.BaseCustomSymbolBuilder.SelectText()
is usedSignature
GetArbitraryNoteTitle()
Returns: Return type: list of str New in version NX7.5.0.
License requirements: None.
GetSymbol¶
-
BaseCustomSymbolBuilder.
GetSymbol
¶ Returns the custom symbol
Signature
GetSymbol()
Returns: The custom symbol Return type: NXOpen.Annotations.BaseCustomSymbol
New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
SelectPartSymbol¶
-
BaseCustomSymbolBuilder.
SelectPartSymbol
¶ Selects part custom symbol
Signature
SelectPartSymbol(name, path)
Parameters: - name (str) – Name of symbol
- path (str) – PartSymbol full Path
New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
SelectSymbol¶
-
BaseCustomSymbolBuilder.
SelectSymbol
¶ Selects custom symbol
Signature
SelectSymbol(name)
Parameters: name (str) – Name of symbol New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
SelectText¶
-
BaseCustomSymbolBuilder.
SelectText
¶ Selects the node index of custom symbol text
Signature
SelectText(index)
Parameters: index (int) – index of selected text New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
SetArbitraryNoteTitle¶
-
BaseCustomSymbolBuilder.
SetArbitraryNoteTitle
¶ Sets the arbitrary note value.
This should be used only after
Annotations.BaseCustomSymbolBuilder.SelectText()
is usedSignature
SetArbitraryNoteTitle(arbitraryNoteTitle)
Parameters: arbitraryNoteTitle (list of str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
BaseCustomSymbolBuilder.
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.