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

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

Created in NX3.0.0. More...

List of all members.

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

NXOpen::Preferences::SessionDrafting::AnnotationStyleType AnnotationStyle ()
 Returns the annotation style for preview

bool AutomaticCustomSymbolUpdate ()
 Returns the automatic update drafting preferences for custom symbol
Created in NX8.0.1.
bool DynamicAlignment ()
 Returns the dynamic alignment flag.
NXOpen::Preferences::SessionDrafting::EdgeFaceDisplayType ExtractedEdgeFaceDisplay ()
 Returns the extracted edge face display
Created in NX3.0.0.
int ForcedWelcomeMode ()
 Returns the Drafting Welcome mode, for autotests only
Created in NX8.0.0.
NXOpen::Preferences::SessionDrafting::GridObjectType GridObject ()
 Returns the drafting grid object.
bool LoadComponentOnFacetedViewSelection ()
 Returns the load on selection flag
Created in NX3.0.0.
bool LoadComponentOnFacetedViewUpdate ()
 Returns the load on update flag
Created in NX3.0.0.
void SetAnnotationStyle (NXOpen::Preferences::SessionDrafting::AnnotationStyleType rubberbandingDisplay)
 Sets the annotation style for preview

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

Detailed Description

Represents the set of Drafting preferences applicable to entire session
To obtain an instance of this class, refer to 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

Returns the annotation style for preview

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

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



License requirements : None

Returns the dynamic alignment flag.


Created in NX3.0.0.

License requirements : None

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



License requirements : None

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



License requirements : None

Returns the drafting grid object.


Created in NX6.0.2.

License requirements : None

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



License requirements : None

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



License requirements : None

Sets the annotation style for preview

Deprecated:
Deprecated in NX6.0.0.



Created in NX3.0.0.

License requirements : None

Parameters:
rubberbandingDisplayrubberbanding display

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



License requirements : None

Parameters:
automaticUpdateOptionautomaticupdateoption

Sets the dynamic alignment flag.


Created in NX3.0.0.

License requirements : None

Parameters:
dynamicAlignmentdynamic alignment

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



License requirements : None

Parameters:
extractedEdgeFaceDisplayextracted edge face display

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

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

Returns the tag of this object.


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