MasterSymbolListItemBuilder Class¶
-
class
NXOpen.Annotations.
MasterSymbolListItemBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Annotations.MasterSymbolListItemBuilder
To create a new instance of this class, use
NXOpen.Annotations.CustomSymbolCollection.CreateMasterSymbolListItemBuilder()
New in version NX7.5.0.
Properties¶
Property | Description |
---|---|
DoubleDefault | Returns or sets the double default, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Real < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>` |
DoubleMax | Returns or sets the double max, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Real < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>` |
DoubleMin | Returns or sets the double min, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Real < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>` |
IntegerDefault | Returns or sets the integer default, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Integer < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>` |
IntegerMax | Returns or sets the integer max ,this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Integer < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>` |
IntegerMin | Returns or sets the integer min , this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Integer < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>` |
NoteText | Returns or sets the first line of note text |
NoteTitle | Returns or sets the note title |
Rule | Returns or sets the note rule |
Tag | Returns the Tag for this object. |
TextType | Returns or sets the text type |
Methods¶
Method | Description |
---|---|
GetMultilineString | Returns the multiple notes for a given Text Type. |
SetMultilineString | Sets the multiple notes for the given Text Type |
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
MasterSymbolListItemBuilderTextTypes Enumeration | The Enum for Text Types |
Property Detail¶
DoubleDefault¶
-
MasterSymbolListItemBuilder.
DoubleDefault
¶ Returns or sets the double default, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Real < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
-------------------------------------
Getter Method
Signature
DoubleDefault()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoubleDefault(doubleDefault)
Parameters: doubleDefault (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
DoubleMax¶
-
MasterSymbolListItemBuilder.
DoubleMax
¶ Returns or sets the double max, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Real < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
-------------------------------------
Getter Method
Signature
DoubleMax()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoubleMax(doubleMax)
Parameters: doubleMax (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
DoubleMin¶
-
MasterSymbolListItemBuilder.
DoubleMin
¶ Returns or sets the double min, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Real < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
-------------------------------------
Getter Method
Signature
DoubleMin()
Returns: Return type: float New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
DoubleMin(doubleMin)
Parameters: doubleMin (float) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
IntegerDefault¶
-
MasterSymbolListItemBuilder.
IntegerDefault
¶ Returns or sets the integer default, this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Integer < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
-------------------------------------
Getter Method
Signature
IntegerDefault()
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IntegerDefault(integerDefault)
Parameters: integerDefault (int) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
IntegerMax¶
-
MasterSymbolListItemBuilder.
IntegerMax
¶ Returns or sets the integer max ,this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Integer < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
-------------------------------------
Getter Method
Signature
IntegerMax()
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IntegerMax(integerMax)
Parameters: integerMax (int) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
IntegerMin¶
-
MasterSymbolListItemBuilder.
IntegerMin
¶ Returns or sets the integer min , this property is valid if text type is :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Integer < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
-------------------------------------
Getter Method
Signature
IntegerMin()
Returns: Return type: int New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
IntegerMin(integerMin)
Parameters: integerMin (int) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
NoteText¶
-
MasterSymbolListItemBuilder.
NoteText
¶ Returns or sets the first line of note text
-------------------------------------
Getter Method
Signature
NoteText()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NoteText(noteText)
Parameters: noteText (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
NoteTitle¶
-
MasterSymbolListItemBuilder.
NoteTitle
¶ Returns or sets the note title
-------------------------------------
Getter Method
Signature
NoteTitle()
Returns: Return type: str New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
NoteTitle(noteTitle)
Parameters: noteTitle (str) – New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Rule¶
-
MasterSymbolListItemBuilder.
Rule
¶ Returns or sets the note rule
-------------------------------------
Getter Method
Signature
Rule()
Returns: Return type: str New in version NX8.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Rule(rule)
Parameters: rule (str) – New in version NX8.0.0.
License requirements: nx_layout (“NX Layout”)
TextType¶
-
MasterSymbolListItemBuilder.
TextType
¶ Returns or sets the text type
-------------------------------------
Getter Method
Signature
TextType()
Returns: Return type: NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes
New in version NX7.5.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
TextType(textType)
Parameters: textType ( NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes
) –New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
GetMultilineString¶
-
MasterSymbolListItemBuilder.
GetMultilineString
¶ Returns the multiple notes for a given Text Type.
this property is valid for :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Arbitrary < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`, :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.Controlled < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`, :py:class:` NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes.PartiallyControlled < NXOpen.Annotations.MasterSymbolListItemBuilderTextTypes>`
Signature
GetMultilineString()
Returns: Return type: list of str New in version NX7.5.0.
License requirements: None.
SetMultilineString¶
-
MasterSymbolListItemBuilder.
SetMultilineString
¶ Sets the multiple notes for the given Text Type
Signature
SetMultilineString(multilineString)
Parameters: multilineString (list of str) – array of notes New in version NX7.5.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
MasterSymbolListItemBuilder.
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.