PartsListBuilder Class¶
-
class
NXOpen.Annotations.
PartsListBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
Represents a
NXOpen.Annotations.PartsListBuilder
.This class queries and sets settings specific to parts list when creating or editing parts list settings.
This is a sub-builder class and cannot be directly instantiated
New in version NX9.0.0.
Properties¶
Property | Description |
---|---|
AllowManualRows | Returns or sets the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list |
AutomaticUpdate | Returns or sets the automatic update option to determine whether or not the parts list updates automatically whenever a change occurs to a referenced object in the model |
CalloutSuffix | Returns or sets the callout suffix specifies the suffix to be used for reference symbol text |
CharToSkip | Returns or sets the characters to skip specifies the characters to be skipped for callouts |
CreateNewRowAsLocked | Returns or sets the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation |
GrowDirectionOptions | Returns or sets the grow direction options that specify the direction of growth for the parts list |
HighlightColor | Returns or sets the highlight color specifies the color used for the delimiters that highlight manual cell text |
HighlightManualText | Returns or sets the highlight manual text specifies whether manual cell text is to be highlighted by delimiters |
Increment | Returns or sets the increment specifies the value by which consecutive callout values are be incremented |
InitialCallout | Returns or sets the initial callout specifies the text string used to represent the first callout in the parts list |
LockPartsListSetup | Returns or sets the Lock Parts List Setup option that determines Is the parts list setup protected/locked |
MainSymbolCustomText | Returns or sets the main symbol custom text specifies the custom text to display in the main callout symbol |
MainSymbolText | Returns or sets the main symbol text specifies the text to display in the main callout symbol |
ReferenceSymbolCustomText | Returns or sets the reference symbol custom text specifies the custom text to display in the main callout symbol |
ReferenceSymbolText | Returns or sets the reference symbol text specifies the text to display in the reference callout symbol |
ShowLockedDeletedRows | Returns or sets the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly |
ShowReferenceCalloutSuffix | Returns or sets the flag indicating whether the reference callout suffix will be displayed. |
SortOnUpdate | Returns or sets the sort on update option that determines whether or not the parts list sorts automatically during update |
Symbol | Returns or sets the symbol type specifies the balloon type used to call out members |
Tag | Returns the Tag for this object. |
VerticalGroupAttachment | Returns or sets the leader attachment to vertical callout groups |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Enumerations¶
PartsListBuilderPartsListGrowDirectionOptions Enumeration | Grow direction options The options specify the direction of growth for the parts list |
PartsListBuilderPartsListMainSymbolText Enumeration | Main Symbol Text Types Specifies the text to display in the main callout symbol |
PartsListBuilderPartsListReferenceSymbolText Enumeration | Reference Symbol Text Types Specifies the text to display in the reference callout symbol |
PartsListBuilderPartsListShowLockedDeletedRows Enumeration | Locked deleted rows options The options specify how to show rows that are locked, but reference components that have been removed from the assembly |
PartsListBuilderPartsListSymbolType Enumeration | Symbol Types The types specify the balloon type used to call out members |
PartsListBuilderPartsListVerticalGroupLeaderAttachment Enumeration | Represents leader attachment for vertical callout groups. |
Property Detail¶
AllowManualRows¶
-
PartsListBuilder.
AllowManualRows
¶ Returns or sets the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list
-------------------------------------
Getter Method
Signature
AllowManualRows
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AllowManualRows
Parameters: allowManualRows (bool) – New in version NX9.0.0.
License requirements: None.
AutomaticUpdate¶
-
PartsListBuilder.
AutomaticUpdate
¶ Returns or sets the automatic update option to determine whether or not the parts list updates automatically whenever a change occurs to a referenced object in the model
-------------------------------------
Getter Method
Signature
AutomaticUpdate
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
AutomaticUpdate
Parameters: automaticUpdate (bool) – New in version NX9.0.0.
License requirements: None.
CalloutSuffix¶
-
PartsListBuilder.
CalloutSuffix
¶ Returns or sets the callout suffix specifies the suffix to be used for reference symbol text
-------------------------------------
Getter Method
Signature
CalloutSuffix
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CalloutSuffix
Parameters: calloutSuffix (str) – New in version NX9.0.0.
License requirements: None.
CharToSkip¶
-
PartsListBuilder.
CharToSkip
¶ Returns or sets the characters to skip specifies the characters to be skipped for callouts
-------------------------------------
Getter Method
Signature
CharToSkip
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CharToSkip
Parameters: charsToSkip (str) – New in version NX9.0.0.
License requirements: None.
CreateNewRowAsLocked¶
-
PartsListBuilder.
CreateNewRowAsLocked
¶ Returns or sets the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation
-------------------------------------
Getter Method
Signature
CreateNewRowAsLocked
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateNewRowAsLocked
Parameters: createNewRowAsLocked (bool) – New in version NX9.0.0.
License requirements: None.
GrowDirectionOptions¶
-
PartsListBuilder.
GrowDirectionOptions
¶ Returns or sets the grow direction options that specify the direction of growth for the parts list
-------------------------------------
Getter Method
Signature
GrowDirectionOptions
Returns: Return type: NXOpen.Annotations.PartsListBuilderPartsListGrowDirectionOptions
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
GrowDirectionOptions
Parameters: growDirectionOptions ( NXOpen.Annotations.PartsListBuilderPartsListGrowDirectionOptions
) –New in version NX9.0.0.
License requirements: None.
HighlightColor¶
-
PartsListBuilder.
HighlightColor
¶ Returns or sets the highlight color specifies the color used for the delimiters that highlight manual cell text
-------------------------------------
Getter Method
Signature
HighlightColor
Returns: Return type: Id New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HighlightColor
Parameters: highlightColor (Id) – New in version NX9.0.0.
License requirements: None.
HighlightManualText¶
-
PartsListBuilder.
HighlightManualText
¶ Returns or sets the highlight manual text specifies whether manual cell text is to be highlighted by delimiters
-------------------------------------
Getter Method
Signature
HighlightManualText
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
HighlightManualText
Parameters: highlightManualText (bool) – New in version NX9.0.0.
License requirements: None.
Increment¶
-
PartsListBuilder.
Increment
¶ Returns or sets the increment specifies the value by which consecutive callout values are be incremented
-------------------------------------
Getter Method
Signature
Increment
Returns: Return type: int New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Increment
Parameters: increment (int) – New in version NX9.0.0.
License requirements: None.
InitialCallout¶
-
PartsListBuilder.
InitialCallout
¶ Returns or sets the initial callout specifies the text string used to represent the first callout in the parts list
-------------------------------------
Getter Method
Signature
InitialCallout
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
InitialCallout
Parameters: initialCallout (str) – New in version NX9.0.0.
License requirements: None.
LockPartsListSetup¶
-
PartsListBuilder.
LockPartsListSetup
¶ Returns or sets the Lock Parts List Setup option that determines Is the parts list setup protected/locked
-------------------------------------
Getter Method
Signature
LockPartsListSetup
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
LockPartsListSetup
Parameters: lockPartsListSetup (bool) – New in version NX9.0.0.
License requirements: None.
MainSymbolCustomText¶
-
PartsListBuilder.
MainSymbolCustomText
¶ Returns or sets the main symbol custom text specifies the custom text to display in the main callout symbol
-------------------------------------
Getter Method
Signature
MainSymbolCustomText
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MainSymbolCustomText
Parameters: mainSymbolCustomText (str) – New in version NX9.0.0.
License requirements: None.
MainSymbolText¶
-
PartsListBuilder.
MainSymbolText
¶ Returns or sets the main symbol text specifies the text to display in the main callout symbol
-------------------------------------
Getter Method
Signature
MainSymbolText
Returns: Return type: NXOpen.Annotations.PartsListBuilderPartsListMainSymbolText
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
MainSymbolText
Parameters: mainSymbolText ( NXOpen.Annotations.PartsListBuilderPartsListMainSymbolText
) –New in version NX9.0.0.
License requirements: None.
ReferenceSymbolCustomText¶
-
PartsListBuilder.
ReferenceSymbolCustomText
¶ Returns or sets the reference symbol custom text specifies the custom text to display in the main callout symbol
-------------------------------------
Getter Method
Signature
ReferenceSymbolCustomText
Returns: Return type: str New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceSymbolCustomText
Parameters: referenceSymbolCustomText (str) – New in version NX9.0.0.
License requirements: None.
ReferenceSymbolText¶
-
PartsListBuilder.
ReferenceSymbolText
¶ Returns or sets the reference symbol text specifies the text to display in the reference callout symbol
-------------------------------------
Getter Method
Signature
ReferenceSymbolText
Returns: Return type: NXOpen.Annotations.PartsListBuilderPartsListReferenceSymbolText
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ReferenceSymbolText
Parameters: referenceSymbolText ( NXOpen.Annotations.PartsListBuilderPartsListReferenceSymbolText
) –New in version NX9.0.0.
License requirements: None.
ShowLockedDeletedRows¶
-
PartsListBuilder.
ShowLockedDeletedRows
¶ Returns or sets the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly
-------------------------------------
Getter Method
Signature
ShowLockedDeletedRows
Returns: Return type: NXOpen.Annotations.PartsListBuilderPartsListShowLockedDeletedRows
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowLockedDeletedRows
Parameters: showLockedDeletedRows ( NXOpen.Annotations.PartsListBuilderPartsListShowLockedDeletedRows
) –New in version NX9.0.0.
License requirements: None.
ShowReferenceCalloutSuffix¶
-
PartsListBuilder.
ShowReferenceCalloutSuffix
¶ Returns or sets the flag indicating whether the reference callout suffix will be displayed.
A value of true indicates that the suffix will be displayed.
-------------------------------------
Getter Method
Signature
ShowReferenceCalloutSuffix
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
ShowReferenceCalloutSuffix
Parameters: showReferenceCalloutSuffix (bool) – New in version NX9.0.0.
License requirements: None.
SortOnUpdate¶
-
PartsListBuilder.
SortOnUpdate
¶ Returns or sets the sort on update option that determines whether or not the parts list sorts automatically during update
-------------------------------------
Getter Method
Signature
SortOnUpdate
Returns: Return type: bool New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
SortOnUpdate
Parameters: sortOnUpdate (bool) – New in version NX9.0.0.
License requirements: None.
Symbol¶
-
PartsListBuilder.
Symbol
¶ Returns or sets the symbol type specifies the balloon type used to call out members
-------------------------------------
Getter Method
Signature
Symbol
Returns: Return type: NXOpen.Annotations.PartsListBuilderPartsListSymbolType
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
Symbol
Parameters: symbol ( NXOpen.Annotations.PartsListBuilderPartsListSymbolType
) –New in version NX9.0.0.
License requirements: None.
VerticalGroupAttachment¶
-
PartsListBuilder.
VerticalGroupAttachment
¶ Returns or sets the leader attachment to vertical callout groups
-------------------------------------
Getter Method
Signature
VerticalGroupAttachment
Returns: Return type: NXOpen.Annotations.PartsListBuilderPartsListVerticalGroupLeaderAttachment
New in version NX9.0.0.
License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalGroupAttachment
Parameters: position ( NXOpen.Annotations.PartsListBuilderPartsListVerticalGroupLeaderAttachment
) –New in version NX9.0.0.
License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
PartsListBuilder.
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.