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

Represents the set of Drafting 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  AnnotationStyleType { AnnotationStyleTypeTextboxAndLeaders, AnnotationStyleTypeDetailed }
 Describes the available types for annotation style preference. More...
 
enum  EdgeFaceDisplayType { EdgeFaceDisplayTypeDisplayAndEmphasize, EdgeFaceDisplayTypeCurvesOnly }
 Describes the available edge face display types. More...
 
enum  GridObjectType { GridObjectTypeDrafting, GridObjectTypeSketch, GridObjectTypeSheetzone }
 Describes the available grid objects. More...
 

Public Member Functions

bool AutomaticCustomSymbolUpdate ()
 Returns the automatic update drafting preferences for custom symbol
Created in NX8.0.1. More...
 
bool DynamicAlignment ()
 Returns the dynamic alignment flag. More...
 
NXOpen::Preferences::SessionDrafting::EdgeFaceDisplayType ExtractedEdgeFaceDisplay ()
 Returns the extracted edge face display
Created in NX3.0.0. More...
 
int ForcedWelcomeMode ()
 Returns the Drafting Welcome mode, for autotests only
Created in NX8.0.0. More...
 
NXOpen::Preferences::SessionDrafting::GridObjectType GridObject ()
 Returns the drafting grid object. More...
 
bool LoadComponentOnFacetedViewSelection ()
 Returns the load on selection flag
Created in NX3.0.0. More...
 
bool LoadComponentOnFacetedViewUpdate ()
 Returns the load on update flag
Created in NX3.0.0. More...
 
void SetAutomaticCustomSymbolUpdate (bool automaticUpdateOption)
 Sets the automatic update drafting preferences for custom symbol
Created in NX8.0.1. More...
 
void SetDynamicAlignment (bool dynamicAlignment)
 Sets the dynamic alignment flag. More...
 
void SetExtractedEdgeFaceDisplay (NXOpen::Preferences::SessionDrafting::EdgeFaceDisplayType extractedEdgeFaceDisplay)
 Sets the extracted edge face display
Created in NX3.0.0. More...
 
void SetForcedWelcomeMode (int enterWelcomeMode)
 Sets the Drafting Welcome mode, for autotests only
Created in NX8.0.0. More...
 
void SetGridObject (NXOpen::Preferences::SessionDrafting::GridObjectType drawingGridObject)
 Sets the drafting grid object. More...
 
void SetLoadComponentOnFacetedViewSelection (bool loadComponentOnFacetedViewSelection)
 Sets the load on selection flag
Created in NX3.0.0. More...
 
void SetLoadComponentOnFacetedViewUpdate (bool loadComponentOnFacetedViewUpdate)
 Sets the load on update flag
Created in NX3.0.0. More...
 
void SetSmartlightweightViewsLoadComponentOnDemand (bool loadComponentOnDemand)
 Sets the load on demand flag
Created in NX11.0.0. More...
 
bool SmartlightweightViewsLoadComponentOnDemand ()
 Returns the load on demand flag
Created in NX11.0.0. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents the set of Drafting 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

Describes the available types for annotation style preference.

Enumerator
AnnotationStyleTypeTextboxAndLeaders 

textbox and leaders

AnnotationStyleTypeDetailed 

detailed

Describes the available edge face display types.

Enumerator
EdgeFaceDisplayTypeDisplayAndEmphasize 

display and emphasize

EdgeFaceDisplayTypeCurvesOnly 

curves only

Describes the available grid objects.

Enumerator
GridObjectTypeDrafting 

Drafting Grid.

GridObjectTypeSketch 

Sketch Grid.

GridObjectTypeSheetzone 

Sheet Zone Grid.

Member Function Documentation

bool NXOpen::Preferences::SessionDrafting::AutomaticCustomSymbolUpdate ( )

Returns the automatic update drafting preferences for custom symbol
Created in NX8.0.1.



License requirements : None

bool NXOpen::Preferences::SessionDrafting::DynamicAlignment ( )

Returns the dynamic alignment flag.


Created in NX3.0.0.

License requirements : None

NXOpen::Preferences::SessionDrafting::EdgeFaceDisplayType NXOpen::Preferences::SessionDrafting::ExtractedEdgeFaceDisplay ( )

Returns the extracted edge face display
Created in NX3.0.0.



License requirements : None

int NXOpen::Preferences::SessionDrafting::ForcedWelcomeMode ( )

Returns the Drafting Welcome mode, for autotests only
Created in NX8.0.0.



License requirements : None

NXOpen::Preferences::SessionDrafting::GridObjectType NXOpen::Preferences::SessionDrafting::GridObject ( )

Returns the drafting grid object.


Created in NX6.0.2.

License requirements : None

bool NXOpen::Preferences::SessionDrafting::LoadComponentOnFacetedViewSelection ( )

Returns the load on selection flag
Created in NX3.0.0.



License requirements : None

bool NXOpen::Preferences::SessionDrafting::LoadComponentOnFacetedViewUpdate ( )

Returns the load on update flag
Created in NX3.0.0.



License requirements : None

void NXOpen::Preferences::SessionDrafting::SetAutomaticCustomSymbolUpdate ( bool  automaticUpdateOption)

Sets the automatic update drafting preferences for custom symbol
Created in NX8.0.1.



License requirements : None

Parameters
automaticUpdateOptionautomaticupdateoption
void NXOpen::Preferences::SessionDrafting::SetDynamicAlignment ( bool  dynamicAlignment)

Sets the dynamic alignment flag.


Created in NX3.0.0.

License requirements : None

Parameters
dynamicAlignmentdynamic alignment
void NXOpen::Preferences::SessionDrafting::SetExtractedEdgeFaceDisplay ( NXOpen::Preferences::SessionDrafting::EdgeFaceDisplayType  extractedEdgeFaceDisplay)

Sets the extracted edge face display
Created in NX3.0.0.



License requirements : None

Parameters
extractedEdgeFaceDisplayextracted edge face display
void NXOpen::Preferences::SessionDrafting::SetForcedWelcomeMode ( int  enterWelcomeMode)

Sets the Drafting Welcome mode, for autotests only
Created in NX8.0.0.



License requirements : None

Parameters
enterWelcomeMode0: do NOT use welcome, 1: ALWAYS use welcome
void NXOpen::Preferences::SessionDrafting::SetGridObject ( NXOpen::Preferences::SessionDrafting::GridObjectType  drawingGridObject)

Sets the drafting grid object.


Created in NX6.0.2.

License requirements : None

Parameters
drawingGridObjectdrawing grid object
void NXOpen::Preferences::SessionDrafting::SetLoadComponentOnFacetedViewSelection ( bool  loadComponentOnFacetedViewSelection)

Sets the load on selection flag
Created in NX3.0.0.



License requirements : None

Parameters
loadComponentOnFacetedViewSelectionload component on faceted view selection
void NXOpen::Preferences::SessionDrafting::SetLoadComponentOnFacetedViewUpdate ( bool  loadComponentOnFacetedViewUpdate)

Sets the load on update flag
Created in NX3.0.0.



License requirements : None

Parameters
loadComponentOnFacetedViewUpdateload component on faceted view update
void NXOpen::Preferences::SessionDrafting::SetSmartlightweightViewsLoadComponentOnDemand ( bool  loadComponentOnDemand)

Sets the load on demand flag
Created in NX11.0.0.



License requirements : None

Parameters
loadComponentOnDemandload component on demand
bool NXOpen::Preferences::SessionDrafting::SmartlightweightViewsLoadComponentOnDemand ( )

Returns the load on demand flag
Created in NX11.0.0.



License requirements : None

tag_t NXOpen::Preferences::SessionDrafting::Tag ( ) const

Returns the tag of this object.


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