NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Preferences::SessionAssemblies Class Reference

Represents the set of Assemblies Preferences applicable to entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX3.0.0. More...

Public Types

enum  DragHandlePositionOption { DragHandlePositionOptionCenterOfBoundingBox, DragHandlePositionOptionOriginOfComponent }
 Specify whether drag handle will be positioned at the center of bounding box or origin of component. More...
 
enum  PartNameOption { PartNameOptionFileName, PartNameOptionDescription, PartNameOptionSpecifiedAttributes }
 Describe whether the part name style is file name or description or specified. More...
 
enum  PositioningTaskCollectionOptionForDesignElements { PositioningTaskCollectionOptionForDesignElementsWork, PositioningTaskCollectionOptionForDesignElementsContext }
 Specify whether Design Elements will be added to the Work or Context Collection of a Positioning Task. More...
 

Public Member Functions

bool CheckNewerRevisionsOfTemplatePart ()
 Returns the check for newer revisions of template part option
Created in NX3.0.0. More...
 
bool ComponentMemberSelect ()
 Returns the component member select option
Created in NX3.0.0. More...
 
bool DisplayUpdateReport ()
 Returns the display update report option
Created in NX3.0.0. More...
 
NXOpen::Preferences::SessionAssemblies::DragHandlePositionOption DragHandlePositionPreference ()
 Returns the drag handle position preference
Created in NX10.0.0. More...
 
bool InterpartPositioning ()
 Returns the option to allow interpart geometry selection in the assembly constraints dialog
Created in NX6.0.1. More...
 
NXString PartNameAttribute ()
 Returns the part name attribute
Created in NX3.0.0. More...
 
NXOpen::Preferences::SessionAssemblies::PartNameOption PartNameStyle ()
 Returns the part name style
Created in NX3.0.0. More...
 
NXOpen::Preferences::SessionAssemblies::PositioningTaskCollectionOptionForDesignElements PositioningTaskCollectionForDesignElements ()
 Returns the option to specify where to add Design Elements selected whilst working in the Assembly Constraints Dialog. More...
 
bool PreviewComponentOnAdd ()
 Returns the preview component on add option
More...
 
bool ProductInterfaceEmphasize ()
 Returns the product interface display emphasis setting
More...
 
void SetCheckNewerRevisionsOfTemplatePart (bool checkNewerRevisionsOfTemplatePart)
 Sets the check for newer revisions of template part option
Created in NX3.0.0. More...
 
void SetComponentMemberSelect (bool componentMemberSelect)
 Sets the component member select option
Created in NX3.0.0. More...
 
void SetDisplayUpdateReport (bool displayUpdateReport)
 Sets the display update report option
Created in NX3.0.0. More...
 
void SetDragHandlePositionPreference (NXOpen::Preferences::SessionAssemblies::DragHandlePositionOption dragHandlePosition)
 Sets the drag handle position preference
Created in NX10.0.0. More...
 
void SetInterpartPositioning (bool allowInterpartPositioning)
 Sets the option to allow interpart geometry selection in the assembly constraints dialog
Created in NX6.0.1. More...
 
void SetPartNameAttribute (const NXString &partNameAttribute)
 Sets the part name attribute
Created in NX3.0.0. More...
 
void SetPartNameAttribute (const char *partNameAttribute)
 Sets the part name attribute
Created in NX3.0.0. More...
 
void SetPartNameStyle (NXOpen::Preferences::SessionAssemblies::PartNameOption partNameStyle)
 Sets the part name style
Created in NX3.0.0. More...
 
void SetPositioningTaskCollectionForDesignElements (NXOpen::Preferences::SessionAssemblies::PositioningTaskCollectionOptionForDesignElements collection)
 Sets the option to specify where to add Design Elements selected whilst working in the Assembly Constraints Dialog. More...
 
void SetPreviewComponentOnAdd (bool previewComponentOnAdd)
 Sets the preview component on add option
More...
 
void SetProductInterfaceEmphasize (bool productInterfaceEmphasize)
 Sets the product interface display emphasis setting
More...
 
void SetTolerantPositioning (bool allowTolerantPositioning)
 Sets the option to allow tolerant (imprecise) geometry selection for assembly positioning
Created in NX4.0.0. More...
 
void SetTrueShapeFiltering (bool trueShapeFiltering)
 Sets the true shape filtering option
Created in NX3.0.0. More...
 
void SetUpdateDesignElementPositionOnLoad (bool updateDesignElementPositionOnLoad)
 Sets the option that enables automatic local positioning update of design elements
Created in NX10.0.0. More...
 
void SetUpdateStructureOnExpand (bool updateStructure)
 Sets the update structure on assembly tree expand option
Created in NX4.0.0. More...
 
void SetWarnOnDelete (bool workOnDelete)
 Sets the warn on delete option
Created in NX9.0.0. More...
 
void SetWarnOnDragDrop (bool warnOnDragDrop)
 Sets the warn on drag and drop
Created in NX3.0.0. More...
 
void SetWorkPartDisplayAsEntirePart (bool workPartDisplayAsEntirePart)
 Sets the work part display as entire part option
Created in NX3.0.0. More...
 
void SetWorkPartEmphasize (bool workPartEmphasize)
 Sets the emphasize for work part
More...
 
void SetWorkPartMaintain (bool workPartMaintain)
 Sets the work part maintain option
More...
 
void SetWorkPartWarnOnAutomaticChange (bool workPartWarnOnAutomaticChange)
 Sets the warn on automatic change for work part option
Created in NX3.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 
bool TolerantPositioning ()
 Returns the option to allow tolerant (imprecise) geometry selection for assembly positioning
Created in NX4.0.0. More...
 
bool TrueShapeFiltering ()
 Returns the true shape filtering option
Created in NX3.0.0. More...
 
bool UpdateDesignElementPositionOnLoad ()
 Returns the option that enables automatic local positioning update of design elements
Created in NX10.0.0. More...
 
bool UpdateStructureOnExpand ()
 Returns the update structure on assembly tree expand option
Created in NX4.0.0. More...
 
bool WarnOnDelete ()
 Returns the warn on delete option
Created in NX9.0.0. More...
 
bool WarnOnDragDrop ()
 Returns the warn on drag and drop
Created in NX3.0.0. More...
 
bool WorkPartDisplayAsEntirePart ()
 Returns the work part display as entire part option
Created in NX3.0.0. More...
 
bool WorkPartEmphasize ()
 Returns the emphasize for work part
More...
 
bool WorkPartMaintain ()
 Returns the work part maintain option
More...
 
bool WorkPartWarnOnAutomaticChange ()
 Returns the warn on automatic change for work part option
Created in NX3.0.0. More...
 

Detailed Description

Represents the set of Assemblies Preferences applicable to entire session
To obtain an instance of this class, refer to NXOpen::Preferences::SessionPreferences

Created in NX3.0.0.


Member Enumeration Documentation

Specify whether drag handle will be positioned at the center of bounding box or origin of component.

Enumerator
DragHandlePositionOptionCenterOfBoundingBox 

center of bounding box

DragHandlePositionOptionOriginOfComponent 

origin of component

Describe whether the part name style is file name or description or specified.

Enumerator
PartNameOptionFileName 

file name

PartNameOptionDescription 

description

PartNameOptionSpecifiedAttributes 

specified attributes

Specify whether Design Elements will be added to the Work or Context Collection of a Positioning Task.

Enumerator
PositioningTaskCollectionOptionForDesignElementsWork 

work

PositioningTaskCollectionOptionForDesignElementsContext 

context

Member Function Documentation

bool NXOpen::Preferences::SessionAssemblies::CheckNewerRevisionsOfTemplatePart ( )

Returns the check for newer revisions of template part option
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::ComponentMemberSelect ( )

Returns the component member select option
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::DisplayUpdateReport ( )

Returns the display update report option
Created in NX3.0.0.



License requirements : None

NXOpen::Preferences::SessionAssemblies::DragHandlePositionOption NXOpen::Preferences::SessionAssemblies::DragHandlePositionPreference ( )

Returns the drag handle position preference
Created in NX10.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::InterpartPositioning ( )

Returns the option to allow interpart geometry selection in the assembly constraints dialog
Created in NX6.0.1.



License requirements : None

NXString NXOpen::Preferences::SessionAssemblies::PartNameAttribute ( )

Returns the part name attribute
Created in NX3.0.0.



License requirements : None

NXOpen::Preferences::SessionAssemblies::PartNameOption NXOpen::Preferences::SessionAssemblies::PartNameStyle ( )

Returns the part name style
Created in NX3.0.0.



License requirements : None

NXOpen::Preferences::SessionAssemblies::PositioningTaskCollectionOptionForDesignElements NXOpen::Preferences::SessionAssemblies::PositioningTaskCollectionForDesignElements ( )

Returns the option to specify where to add Design Elements selected whilst working in the Assembly Constraints Dialog.

The Design Elements will either be added to the Work or the Context collection of the Positioning Task.
Created in NX10.0.0.

License requirements : None

bool NXOpen::Preferences::SessionAssemblies::PreviewComponentOnAdd ( )

Returns the preview component on add option

Deprecated:
Deprecated in NX12.0.0.

No replacement.


Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::SessionAssemblies::ProductInterfaceEmphasize ( )

Returns the product interface display emphasis setting

Deprecated:
Deprecated in NX8.5.0.

Use Preferences::SessionVisualizationEmphasis::ProductInterfaceEmphasis instead.


Created in NX5.0.0.

License requirements : None

void NXOpen::Preferences::SessionAssemblies::SetCheckNewerRevisionsOfTemplatePart ( bool  checkNewerRevisionsOfTemplatePart)

Sets the check for newer revisions of template part option
Created in NX3.0.0.



License requirements : None

Parameters
checkNewerRevisionsOfTemplatePartcheck newer revisions of template part
void NXOpen::Preferences::SessionAssemblies::SetComponentMemberSelect ( bool  componentMemberSelect)

Sets the component member select option
Created in NX3.0.0.



License requirements : None

Parameters
componentMemberSelectcomponent member select
void NXOpen::Preferences::SessionAssemblies::SetDisplayUpdateReport ( bool  displayUpdateReport)

Sets the display update report option
Created in NX3.0.0.



License requirements : None

Parameters
displayUpdateReportdisplay update report
void NXOpen::Preferences::SessionAssemblies::SetDragHandlePositionPreference ( NXOpen::Preferences::SessionAssemblies::DragHandlePositionOption  dragHandlePosition)

Sets the drag handle position preference
Created in NX10.0.0.



License requirements : None

Parameters
dragHandlePositiondraghandleposition
void NXOpen::Preferences::SessionAssemblies::SetInterpartPositioning ( bool  allowInterpartPositioning)

Sets the option to allow interpart geometry selection in the assembly constraints dialog
Created in NX6.0.1.



License requirements : None

Parameters
allowInterpartPositioningallow interpart positioning
void NXOpen::Preferences::SessionAssemblies::SetPartNameAttribute ( const NXString partNameAttribute)

Sets the part name attribute
Created in NX3.0.0.



License requirements : None

Parameters
partNameAttributepart name attribute
void NXOpen::Preferences::SessionAssemblies::SetPartNameAttribute ( const char *  partNameAttribute)

Sets the part name attribute
Created in NX3.0.0.



License requirements : None

Parameters
partNameAttributepart name attribute
void NXOpen::Preferences::SessionAssemblies::SetPartNameStyle ( NXOpen::Preferences::SessionAssemblies::PartNameOption  partNameStyle)

Sets the part name style
Created in NX3.0.0.



License requirements : None

Parameters
partNameStylepart name style
void NXOpen::Preferences::SessionAssemblies::SetPositioningTaskCollectionForDesignElements ( NXOpen::Preferences::SessionAssemblies::PositioningTaskCollectionOptionForDesignElements  collection)

Sets the option to specify where to add Design Elements selected whilst working in the Assembly Constraints Dialog.

The Design Elements will either be added to the Work or the Context collection of the Positioning Task.
Created in NX10.0.0.

License requirements : None

Parameters
collectioncollection
void NXOpen::Preferences::SessionAssemblies::SetPreviewComponentOnAdd ( bool  previewComponentOnAdd)

Sets the preview component on add option

Deprecated:
Deprecated in NX12.0.0.

No replacement.


Created in NX3.0.0.

License requirements : None

Parameters
previewComponentOnAddpreview component on add
void NXOpen::Preferences::SessionAssemblies::SetProductInterfaceEmphasize ( bool  productInterfaceEmphasize)

Sets the product interface display emphasis setting

Deprecated:
Deprecated in NX8.5.0.

Use Preferences::SessionVisualizationEmphasis::SetProductInterfaceEmphasis instead.


Created in NX5.0.0.

License requirements : None

Parameters
productInterfaceEmphasizeproduct interface emphasize
void NXOpen::Preferences::SessionAssemblies::SetTolerantPositioning ( bool  allowTolerantPositioning)

Sets the option to allow tolerant (imprecise) geometry selection for assembly positioning
Created in NX4.0.0.



License requirements : None

Parameters
allowTolerantPositioningallow tolerant positioning
void NXOpen::Preferences::SessionAssemblies::SetTrueShapeFiltering ( bool  trueShapeFiltering)

Sets the true shape filtering option
Created in NX3.0.0.



License requirements : None

Parameters
trueShapeFilteringtrue shape filtering
void NXOpen::Preferences::SessionAssemblies::SetUpdateDesignElementPositionOnLoad ( bool  updateDesignElementPositionOnLoad)

Sets the option that enables automatic local positioning update of design elements
Created in NX10.0.0.



License requirements : nx_4gd_integration ("4th Generation Design")

Parameters
updateDesignElementPositionOnLoadupdate design element position on load
void NXOpen::Preferences::SessionAssemblies::SetUpdateStructureOnExpand ( bool  updateStructure)

Sets the update structure on assembly tree expand option
Created in NX4.0.0.



License requirements : None

Parameters
updateStructureupdate structure
void NXOpen::Preferences::SessionAssemblies::SetWarnOnDelete ( bool  workOnDelete)

Sets the warn on delete option
Created in NX9.0.0.



License requirements : None

Parameters
workOnDeletework on delete
void NXOpen::Preferences::SessionAssemblies::SetWarnOnDragDrop ( bool  warnOnDragDrop)

Sets the warn on drag and drop
Created in NX3.0.0.



License requirements : None

Parameters
warnOnDragDropwarn on drag drop
void NXOpen::Preferences::SessionAssemblies::SetWorkPartDisplayAsEntirePart ( bool  workPartDisplayAsEntirePart)

Sets the work part display as entire part option
Created in NX3.0.0.



License requirements : None

Parameters
workPartDisplayAsEntirePartwork part display as entire part
void NXOpen::Preferences::SessionAssemblies::SetWorkPartEmphasize ( bool  workPartEmphasize)

Sets the emphasize for work part

Deprecated:
Deprecated in NX8.5.0.

Use Preferences::SessionVisualizationEmphasis::SetWorkPartEmphasis instead.


Created in NX3.0.0.

License requirements : None

Parameters
workPartEmphasizework part emphasize
void NXOpen::Preferences::SessionAssemblies::SetWorkPartMaintain ( bool  workPartMaintain)

Sets the work part maintain option

Deprecated:
Deprecated in NX12.0.0.

No replacement.


Created in NX3.0.0.

License requirements : None

Parameters
workPartMaintainwork part maintain
void NXOpen::Preferences::SessionAssemblies::SetWorkPartWarnOnAutomaticChange ( bool  workPartWarnOnAutomaticChange)

Sets the warn on automatic change for work part option
Created in NX3.0.0.



License requirements : None

Parameters
workPartWarnOnAutomaticChangework part warn on automatic change
tag_t NXOpen::Preferences::SessionAssemblies::Tag ( ) const

Returns the tag of this object.

bool NXOpen::Preferences::SessionAssemblies::TolerantPositioning ( )

Returns the option to allow tolerant (imprecise) geometry selection for assembly positioning
Created in NX4.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::TrueShapeFiltering ( )

Returns the true shape filtering option
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::UpdateDesignElementPositionOnLoad ( )

Returns the option that enables automatic local positioning update of design elements
Created in NX10.0.0.



License requirements : nx_4gd_integration ("4th Generation Design")

bool NXOpen::Preferences::SessionAssemblies::UpdateStructureOnExpand ( )

Returns the update structure on assembly tree expand option
Created in NX4.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::WarnOnDelete ( )

Returns the warn on delete option
Created in NX9.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::WarnOnDragDrop ( )

Returns the warn on drag and drop
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::WorkPartDisplayAsEntirePart ( )

Returns the work part display as entire part option
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::SessionAssemblies::WorkPartEmphasize ( )

Returns the emphasize for work part

Deprecated:
Deprecated in NX8.5.0.

Use Preferences::SessionVisualizationEmphasis::WorkPartEmphasis instead.


Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::SessionAssemblies::WorkPartMaintain ( )

Returns the work part maintain option

Deprecated:
Deprecated in NX12.0.0.

No replacement.


Created in NX3.0.0.

License requirements : None

bool NXOpen::Preferences::SessionAssemblies::WorkPartWarnOnAutomaticChange ( )

Returns the warn on automatic change for work part option
Created in NX3.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.