FormattedStringBuilder Class¶
-
class
NXOpen.Diagramming.FormattedStringBuilder¶ Bases:
NXOpen.Diagramming.BaseSubObjectBuilderRepresents a FormattedStringBuilder.
This is a sub-builder class and cannot be directly instantiated
New in version NX10.0.0.
Properties¶
| Property | Description |
|---|---|
| Format | Returns the format. |
| String | Returns the string. |
| Tag | Returns the Tag for this object. |
Methods¶
| Method | Description |
|---|---|
| AppendFormat | Appends the format and related referenced attributes to this builder. |
| ClearFormat | Clears the format and related referenced attributes of this builder. |
| GetReferencedAttributes | Gets the referenced attributes. |
| SetFormatValue | Sets the format and related referenced attributes to this builder. |
| Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
Method Detail¶
AppendFormat¶
-
FormattedStringBuilder.AppendFormat¶ Appends the format and related referenced attributes to this builder.
Signature
AppendFormat(objTags, attrTitles, appendFormat)Parameters: - objTags (list of
NXOpen.NXObject) – The owners of the referenced attributes - attrTitles (list of str) – The titles of the referenced attributes
- appendFormat (str) –
New in version NX10.0.0.
License requirements: None.
- objTags (list of
ClearFormat¶
-
FormattedStringBuilder.ClearFormat¶ Clears the format and related referenced attributes of this builder.
Signature
ClearFormat()New in version NX10.0.0.
License requirements: None.
GetReferencedAttributes¶
-
FormattedStringBuilder.GetReferencedAttributes¶ Gets the referenced attributes.
Signature
GetReferencedAttributes()Returns: a tuple Return type: A tuple consisting of (attrTitles, objTags). attrTitles is a list of str. The titles of the referenced attributes objTags is a list of NXOpen.NXObject. The owners of the referenced attributesNew in version NX10.0.0.
License requirements: None.
SetFormatValue¶
-
FormattedStringBuilder.SetFormatValue¶ Overloaded method SetFormatValue
SetFormatValue(objTags, attrTitles, format)SetFormatValue(objTags, parentTags, attrTitles, format)
-------------------------------------Sets the format and related referenced attributes to this builder.
Signature
SetFormatValue(objTags, attrTitles, format)Parameters: - objTags (list of
NXOpen.NXObject) – The owners of the referenced attributes - attrTitles (list of str) – The titles of the referenced attributes
- format (str) –
New in version NX10.0.0.
License requirements: None.
-------------------------------------Sets the format and related referenced attributes to this builder in managed mode.
Signature
SetFormatValue(objTags, parentTags, attrTitles, format)Parameters: - objTags (list of
NXOpen.NXObject) – The owners of the referenced attributes - parentTags (list of
NXOpen.NXObject) – The owner parents of the referenced attributes - attrTitles (list of str) – The titles of the referenced attributes
- format (str) –
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Validate¶
-
FormattedStringBuilder.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.