NX Open C++ Reference Guide
|
Represents a Annotations::PartsListBuilder . More...
Public Member Functions | |
bool | AllowManualRows () |
Returns the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list Created in NX9.0.0. | |
bool | AutomaticUpdate () |
Returns 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 Created in NX9.0.0. | |
NXString | CalloutSuffix () |
Returns the callout suffix specifies the suffix to be used for reference symbol text Created in NX9.0.0. | |
NXString | CharToSkip () |
Returns the characters to skip specifies the characters to be skipped for callouts Created in NX9.0.0. | |
bool | CreateNewRowAsLocked () |
Returns the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation Created in NX9.0.0. | |
NXOpen::Annotations::PartsListBuilder::PartsListGrowDirectionOptions | GrowDirectionOptions () |
Returns the grow direction options that specify the direction of growth for the parts list Created in NX9.0.0. | |
NXOpen::NXColor * | HighlightColor () |
Returns the highlight color specifies the color used for the delimiters that highlight manual cell text Created in NX9.0.0. | |
bool | HighlightManualText () |
Returns the highlight manual text specifies whether manual cell text is to be highlighted by delimiters Created in NX9.0.0. | |
int | Increment () |
Returns the increment specifies the value by which consecutive callout values are be incremented Created in NX9.0.0. | |
NXString | InitialCallout () |
Returns the initial callout specifies the text string used to represent the first callout in the parts list Created in NX9.0.0. | |
bool | LockPartsListSetup () |
Returns the Lock Parts List Setup option that determines Is the parts list setup protected/locked Created in NX9.0.0. | |
NXString | MainSymbolCustomText () |
Returns the main symbol custom text specifies the custom text to display in the main callout symbol Created in NX9.0.0. | |
NXOpen::Annotations::PartsListBuilder::PartsListMainSymbolText | MainSymbolText () |
Returns the main symbol text specifies the text to display in the main callout symbol Created in NX9.0.0. | |
NXString | ReferenceSymbolCustomText () |
Returns the reference symbol custom text specifies the custom text to display in the main callout symbol Created in NX9.0.0. | |
NXOpen::Annotations::PartsListBuilder::PartsListReferenceSymbolText | ReferenceSymbolText () |
Returns the reference symbol text specifies the text to display in the reference callout symbol Created in NX9.0.0. | |
void | SetAllowManualRows (bool allowManualRows) |
Sets the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list Created in NX9.0.0. | |
void | SetAutomaticUpdate (bool automaticUpdate) |
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 Created in NX9.0.0. | |
void | SetCalloutSuffix (const NXString &calloutSuffix) |
Sets the callout suffix specifies the suffix to be used for reference symbol text Created in NX9.0.0. | |
void | SetCalloutSuffix (const char *calloutSuffix) |
Sets the callout suffix specifies the suffix to be used for reference symbol text Created in NX9.0.0. | |
void | SetCharToSkip (const NXString &charsToSkip) |
Sets the characters to skip specifies the characters to be skipped for callouts Created in NX9.0.0. | |
void | SetCharToSkip (const char *charsToSkip) |
Sets the characters to skip specifies the characters to be skipped for callouts Created in NX9.0.0. | |
void | SetCreateNewRowAsLocked (bool createNewRowAsLocked) |
Sets the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation Created in NX9.0.0. | |
void | SetGrowDirectionOptions (NXOpen::Annotations::PartsListBuilder::PartsListGrowDirectionOptions growDirectionOptions) |
Sets the grow direction options that specify the direction of growth for the parts list Created in NX9.0.0. | |
void | SetHighlightColor (NXOpen::NXColor *highlightColor) |
Sets the highlight color specifies the color used for the delimiters that highlight manual cell text Created in NX9.0.0. | |
void | SetHighlightManualText (bool highlightManualText) |
Sets the highlight manual text specifies whether manual cell text is to be highlighted by delimiters Created in NX9.0.0. | |
void | SetIncrement (int increment) |
Sets the increment specifies the value by which consecutive callout values are be incremented Created in NX9.0.0. | |
void | SetInitialCallout (const NXString &initialCallout) |
Sets the initial callout specifies the text string used to represent the first callout in the parts list Created in NX9.0.0. | |
void | SetInitialCallout (const char *initialCallout) |
Sets the initial callout specifies the text string used to represent the first callout in the parts list Created in NX9.0.0. | |
void | SetLockPartsListSetup (bool lockPartsListSetup) |
Sets the Lock Parts List Setup option that determines Is the parts list setup protected/locked Created in NX9.0.0. | |
void | SetMainSymbolCustomText (const NXString &mainSymbolCustomText) |
Sets the main symbol custom text specifies the custom text to display in the main callout symbol Created in NX9.0.0. | |
void | SetMainSymbolCustomText (const char *mainSymbolCustomText) |
Sets the main symbol custom text specifies the custom text to display in the main callout symbol Created in NX9.0.0. | |
void | SetMainSymbolText (NXOpen::Annotations::PartsListBuilder::PartsListMainSymbolText mainSymbolText) |
Sets the main symbol text specifies the text to display in the main callout symbol Created in NX9.0.0. | |
void | SetReferenceSymbolCustomText (const NXString &referenceSymbolCustomText) |
Sets the reference symbol custom text specifies the custom text to display in the main callout symbol Created in NX9.0.0. | |
void | SetReferenceSymbolCustomText (const char *referenceSymbolCustomText) |
Sets the reference symbol custom text specifies the custom text to display in the main callout symbol Created in NX9.0.0. | |
void | SetReferenceSymbolText (NXOpen::Annotations::PartsListBuilder::PartsListReferenceSymbolText referenceSymbolText) |
Sets the reference symbol text specifies the text to display in the reference callout symbol Created in NX9.0.0. | |
void | SetShowLockedDeletedRows (NXOpen::Annotations::PartsListBuilder::PartsListShowLockedDeletedRows showLockedDeletedRows) |
Sets the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly Created in NX9.0.0. | |
void | SetShowReferenceCalloutSuffix (bool showReferenceCalloutSuffix) |
Sets the flag indicating whether the reference callout suffix will be displayed. | |
void | SetSortOnUpdate (bool sortOnUpdate) |
Sets the sort on update option that determines whether or not the parts list sorts automatically during update Created in NX9.0.0. | |
void | SetSymbol (NXOpen::Annotations::PartsListBuilder::PartsListSymbolType symbol) |
Sets the symbol type specifies the balloon type used to call out members Created in NX9.0.0. | |
void | SetVerticalGroupAttachment (NXOpen::Annotations::PartsListBuilder::PartsListVerticalGroupLeaderAttachment position) |
Sets the leader attachment to vertical callout groups Created in NX9.0.0. | |
NXOpen::Annotations::PartsListBuilder::PartsListShowLockedDeletedRows | ShowLockedDeletedRows () |
Returns the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly Created in NX9.0.0. | |
bool | ShowReferenceCalloutSuffix () |
Returns the flag indicating whether the reference callout suffix will be displayed. | |
bool | SortOnUpdate () |
Returns the sort on update option that determines whether or not the parts list sorts automatically during update Created in NX9.0.0. | |
NXOpen::Annotations::PartsListBuilder::PartsListSymbolType | Symbol () |
Returns the symbol type specifies the balloon type used to call out members Created in NX9.0.0. | |
virtual bool | Validate () |
Validate whether the inputs to the component are sufficient for commit to be called. | |
NXOpen::Annotations::PartsListBuilder::PartsListVerticalGroupLeaderAttachment | VerticalGroupAttachment () |
Returns the leader attachment to vertical callout groups Created in NX9.0.0. | |
![]() | |
tag_t | GetTag () const |
<b>Deprecated</b>:<br> Use Tag instead. | |
tag_t | Tag () const |
Returns the tag of this object. | |
Represents a Annotations::PartsListBuilder .
This class queries and sets settings specific to parts list when creating or editing parts list settings. <br> This is a sub-builder class and cannot be directly instantiated <br>
Created in NX9.0.0.
Main Symbol Text Types Specifies the text to display in the main callout symbol.
Reference Symbol Text Types Specifies the text to display in the reference callout symbol.
Locked deleted rows options The options specify how to show rows that are locked, but reference components that have been removed from the assembly.
Symbol Types The types specify the balloon type used to call out members.
bool NXOpen::Annotations::PartsListBuilder::AllowManualRows | ( | ) |
Returns the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list
Created in NX9.0.0.
License requirements : None
bool NXOpen::Annotations::PartsListBuilder::AutomaticUpdate | ( | ) |
Returns 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
Created in NX9.0.0.
License requirements : None
NXString NXOpen::Annotations::PartsListBuilder::CalloutSuffix | ( | ) |
Returns the callout suffix specifies the suffix to be used for reference symbol text
Created in NX9.0.0.
License requirements : None
NXString NXOpen::Annotations::PartsListBuilder::CharToSkip | ( | ) |
Returns the characters to skip specifies the characters to be skipped for callouts
Created in NX9.0.0.
License requirements : None
bool NXOpen::Annotations::PartsListBuilder::CreateNewRowAsLocked | ( | ) |
Returns the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation
Created in NX9.0.0.
License requirements : None
NXOpen::Annotations::PartsListBuilder::PartsListGrowDirectionOptions NXOpen::Annotations::PartsListBuilder::GrowDirectionOptions | ( | ) |
Returns the grow direction options that specify the direction of growth for the parts list
Created in NX9.0.0.
License requirements : None
NXOpen::NXColor* NXOpen::Annotations::PartsListBuilder::HighlightColor | ( | ) |
Returns the highlight color specifies the color used for the delimiters that highlight manual cell text
Created in NX9.0.0.
License requirements : None
bool NXOpen::Annotations::PartsListBuilder::HighlightManualText | ( | ) |
Returns the highlight manual text specifies whether manual cell text is to be highlighted by delimiters
Created in NX9.0.0.
License requirements : None
int NXOpen::Annotations::PartsListBuilder::Increment | ( | ) |
Returns the increment specifies the value by which consecutive callout values are be incremented
Created in NX9.0.0.
License requirements : None
NXString NXOpen::Annotations::PartsListBuilder::InitialCallout | ( | ) |
Returns the initial callout specifies the text string used to represent the first callout in the parts list
Created in NX9.0.0.
License requirements : None
bool NXOpen::Annotations::PartsListBuilder::LockPartsListSetup | ( | ) |
Returns the Lock Parts List Setup option that determines Is the parts list setup protected/locked
Created in NX9.0.0.
License requirements : None
NXString NXOpen::Annotations::PartsListBuilder::MainSymbolCustomText | ( | ) |
Returns the main symbol custom text specifies the custom text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
NXOpen::Annotations::PartsListBuilder::PartsListMainSymbolText NXOpen::Annotations::PartsListBuilder::MainSymbolText | ( | ) |
Returns the main symbol text specifies the text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
NXString NXOpen::Annotations::PartsListBuilder::ReferenceSymbolCustomText | ( | ) |
Returns the reference symbol custom text specifies the custom text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
NXOpen::Annotations::PartsListBuilder::PartsListReferenceSymbolText NXOpen::Annotations::PartsListBuilder::ReferenceSymbolText | ( | ) |
Returns the reference symbol text specifies the text to display in the reference callout symbol
Created in NX9.0.0.
License requirements : None
void NXOpen::Annotations::PartsListBuilder::SetAllowManualRows | ( | bool | allowManualRows | ) |
Sets the allow manual rows option that determines whether or not manual rows are allowed to be inserted into a parts list
Created in NX9.0.0.
License requirements : None
allowManualRows | allowmanualrows |
void NXOpen::Annotations::PartsListBuilder::SetAutomaticUpdate | ( | bool | automaticUpdate | ) |
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
Created in NX9.0.0.
License requirements : None
automaticUpdate | automaticupdate |
void NXOpen::Annotations::PartsListBuilder::SetCalloutSuffix | ( | const NXString & | calloutSuffix | ) |
Sets the callout suffix specifies the suffix to be used for reference symbol text
Created in NX9.0.0.
License requirements : None
calloutSuffix | calloutsuffix |
void NXOpen::Annotations::PartsListBuilder::SetCalloutSuffix | ( | const char * | calloutSuffix | ) |
Sets the callout suffix specifies the suffix to be used for reference symbol text
Created in NX9.0.0.
License requirements : None
calloutSuffix | calloutsuffix |
void NXOpen::Annotations::PartsListBuilder::SetCharToSkip | ( | const NXString & | charsToSkip | ) |
Sets the characters to skip specifies the characters to be skipped for callouts
Created in NX9.0.0.
License requirements : None
charsToSkip | charstoskip |
void NXOpen::Annotations::PartsListBuilder::SetCharToSkip | ( | const char * | charsToSkip | ) |
Sets the characters to skip specifies the characters to be skipped for callouts
Created in NX9.0.0.
License requirements : None
charsToSkip | charstoskip |
void NXOpen::Annotations::PartsListBuilder::SetCreateNewRowAsLocked | ( | bool | createNewRowAsLocked | ) |
Sets the create new row as locked option that determines whether new rows in the parts list are locked automatically on creation
Created in NX9.0.0.
License requirements : None
createNewRowAsLocked | createnewrowaslocked |
void NXOpen::Annotations::PartsListBuilder::SetGrowDirectionOptions | ( | NXOpen::Annotations::PartsListBuilder::PartsListGrowDirectionOptions | growDirectionOptions | ) |
Sets the grow direction options that specify the direction of growth for the parts list
Created in NX9.0.0.
License requirements : None
growDirectionOptions | growdirectionoptions |
void NXOpen::Annotations::PartsListBuilder::SetHighlightColor | ( | NXOpen::NXColor * | highlightColor | ) |
Sets the highlight color specifies the color used for the delimiters that highlight manual cell text
Created in NX9.0.0.
License requirements : None
highlightColor | highlightcolor |
void NXOpen::Annotations::PartsListBuilder::SetHighlightManualText | ( | bool | highlightManualText | ) |
Sets the highlight manual text specifies whether manual cell text is to be highlighted by delimiters
Created in NX9.0.0.
License requirements : None
highlightManualText | highlightmanualtext |
void NXOpen::Annotations::PartsListBuilder::SetIncrement | ( | int | increment | ) |
Sets the increment specifies the value by which consecutive callout values are be incremented
Created in NX9.0.0.
License requirements : None
increment | increment |
void NXOpen::Annotations::PartsListBuilder::SetInitialCallout | ( | const NXString & | initialCallout | ) |
Sets the initial callout specifies the text string used to represent the first callout in the parts list
Created in NX9.0.0.
License requirements : None
initialCallout | initialcallout |
void NXOpen::Annotations::PartsListBuilder::SetInitialCallout | ( | const char * | initialCallout | ) |
Sets the initial callout specifies the text string used to represent the first callout in the parts list
Created in NX9.0.0.
License requirements : None
initialCallout | initialcallout |
void NXOpen::Annotations::PartsListBuilder::SetLockPartsListSetup | ( | bool | lockPartsListSetup | ) |
Sets the Lock Parts List Setup option that determines Is the parts list setup protected/locked
Created in NX9.0.0.
License requirements : None
lockPartsListSetup | lockpartslistsetup |
void NXOpen::Annotations::PartsListBuilder::SetMainSymbolCustomText | ( | const NXString & | mainSymbolCustomText | ) |
Sets the main symbol custom text specifies the custom text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
mainSymbolCustomText | mainsymbolcustomtext |
void NXOpen::Annotations::PartsListBuilder::SetMainSymbolCustomText | ( | const char * | mainSymbolCustomText | ) |
Sets the main symbol custom text specifies the custom text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
mainSymbolCustomText | mainsymbolcustomtext |
void NXOpen::Annotations::PartsListBuilder::SetMainSymbolText | ( | NXOpen::Annotations::PartsListBuilder::PartsListMainSymbolText | mainSymbolText | ) |
Sets the main symbol text specifies the text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
mainSymbolText | mainsymboltext |
void NXOpen::Annotations::PartsListBuilder::SetReferenceSymbolCustomText | ( | const NXString & | referenceSymbolCustomText | ) |
Sets the reference symbol custom text specifies the custom text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
referenceSymbolCustomText | referencesymbolcustomtext |
void NXOpen::Annotations::PartsListBuilder::SetReferenceSymbolCustomText | ( | const char * | referenceSymbolCustomText | ) |
Sets the reference symbol custom text specifies the custom text to display in the main callout symbol
Created in NX9.0.0.
License requirements : None
referenceSymbolCustomText | referencesymbolcustomtext |
void NXOpen::Annotations::PartsListBuilder::SetReferenceSymbolText | ( | NXOpen::Annotations::PartsListBuilder::PartsListReferenceSymbolText | referenceSymbolText | ) |
Sets the reference symbol text specifies the text to display in the reference callout symbol
Created in NX9.0.0.
License requirements : None
referenceSymbolText | referencesymboltext |
void NXOpen::Annotations::PartsListBuilder::SetShowLockedDeletedRows | ( | NXOpen::Annotations::PartsListBuilder::PartsListShowLockedDeletedRows | showLockedDeletedRows | ) |
Sets the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly
Created in NX9.0.0.
License requirements : None
showLockedDeletedRows | showlockeddeletedrows |
void NXOpen::Annotations::PartsListBuilder::SetShowReferenceCalloutSuffix | ( | bool | showReferenceCalloutSuffix | ) |
Sets the flag indicating whether the reference callout suffix will be displayed.
A value of true indicates that the suffix will be displayed.
Created in NX9.0.0.
License requirements : None
showReferenceCalloutSuffix | showreferencecalloutsuffix |
void NXOpen::Annotations::PartsListBuilder::SetSortOnUpdate | ( | bool | sortOnUpdate | ) |
Sets the sort on update option that determines whether or not the parts list sorts automatically during update
Created in NX9.0.0.
License requirements : None
sortOnUpdate | sortonupdate |
void NXOpen::Annotations::PartsListBuilder::SetSymbol | ( | NXOpen::Annotations::PartsListBuilder::PartsListSymbolType | symbol | ) |
Sets the symbol type specifies the balloon type used to call out members
Created in NX9.0.0.
License requirements : None
symbol | symbol |
void NXOpen::Annotations::PartsListBuilder::SetVerticalGroupAttachment | ( | NXOpen::Annotations::PartsListBuilder::PartsListVerticalGroupLeaderAttachment | position | ) |
Sets the leader attachment to vertical callout groups
Created in NX9.0.0.
License requirements : drafting ("DRAFTING")
position | position |
NXOpen::Annotations::PartsListBuilder::PartsListShowLockedDeletedRows NXOpen::Annotations::PartsListBuilder::ShowLockedDeletedRows | ( | ) |
Returns the show locked deleted rows option to show rows that are locked, but reference components that have been removed from the assembly
Created in NX9.0.0.
License requirements : None
bool NXOpen::Annotations::PartsListBuilder::ShowReferenceCalloutSuffix | ( | ) |
Returns the flag indicating whether the reference callout suffix will be displayed.
A value of true indicates that the suffix will be displayed.
Created in NX9.0.0.
License requirements : None
bool NXOpen::Annotations::PartsListBuilder::SortOnUpdate | ( | ) |
Returns the sort on update option that determines whether or not the parts list sorts automatically during update
Created in NX9.0.0.
License requirements : None
NXOpen::Annotations::PartsListBuilder::PartsListSymbolType NXOpen::Annotations::PartsListBuilder::Symbol | ( | ) |
Returns the symbol type specifies the balloon type used to call out members
Created in NX9.0.0.
License requirements : None
|
virtual |
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.
Implements NXOpen::GeometricUtilities::IComponentBuilder.
NXOpen::Annotations::PartsListBuilder::PartsListVerticalGroupLeaderAttachment NXOpen::Annotations::PartsListBuilder::VerticalGroupAttachment | ( | ) |
Returns the leader attachment to vertical callout groups
Created in NX9.0.0.
License requirements : None