NX Open C++ Reference Guide
Public Member Functions | List of all members
NXOpen::Drafting::SettingsManager Class Reference

Represents an object that manages drafting settings. More...

Public Member Functions

NXOpen::Annotations::EditSettingsBuilderCreateAnnotationEditSettingsBuilder (const std::vector< NXOpen::DisplayableObject * > &objects)
 Creates a NXOpen::Annotations::EditSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object. More...
 
NXOpen::Drawings::EditSectionLineSettingsBuilderCreateDrawingEditSectionLineSettingsBuilder (const std::vector< NXOpen::Drawings::SectionLine * > &sectionLines)
 Creates a NXOpen::Drawings::EditSectionLineSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object. More...
 
NXOpen::Drawings::EditViewLabelSettingsBuilderCreateDrawingEditViewLabelSettingsBuilder (const std::vector< NXOpen::DisplayableObject * > &viewLabels)
 Creates a NXOpen::Drawings::EditViewLabelSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object. More...
 
NXOpen::Drawings::EditViewSettingsBuilderCreateDrawingEditViewSettingsBuilder (const std::vector< NXOpen::View * > &views)
 Creates a NXOpen::Drawings::EditViewSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object. More...
 
NXOpen::Layout2d::EditComponentSettingsBuilderCreateLayout2dEditComponentSettingsBuilder (const std::vector< NXOpen::Layout2d::Component * > &components)
 Creates a NXOpen::Layout2d::EditComponentSettingsBuilder This builder is the interface to edit the 2d component settings of layout
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object. More...
 
NXOpen::Drafting::PreferencesBuilderCreatePreferencesBuilder ()
 Creates a NXOpen::Drafting::PreferencesBuilder. More...
 
NXOpen::Annotations::TableEditSettingsBuilderCreateTableEditSettingsBuilder (const std::vector< NXOpen::DisplayableObject * > &objects)
 Creates a NXOpen::Annotations::TableEditSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object. More...
 
void ProcessForMultipleObjectsSettings (const std::vector< NXOpen::Drafting::BaseEditSettingsBuilder * > &editSettingsBuilders)
 Process edit settings builders for multiple objects User must call this API for multiple object settings and pass all edit settings builders for selected objects. More...
 
void ProcessForMutipleObjectsSettings (const std::vector< NXOpen::Drafting::BaseEditSettingsBuilder * > &editSettingsBuilders)
 Process edit settings builders for mutiple objects. More...
 
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents an object that manages drafting settings.


To obtain an instance of this class, refer to NXOpen::Part

Created in NX9.0.0.

Member Function Documentation

NXOpen::Annotations::EditSettingsBuilder* NXOpen::Drafting::SettingsManager::CreateAnnotationEditSettingsBuilder ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Creates a NXOpen::Annotations::EditSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object.

Client must call Drafting::SettingsManager::ProcessForMultipleObjectsSettings after creating all settings builder for selected objects.

Returns
The annotations settings builder
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")
Parameters
objectsthe array of objects for style, NULL not allowed
NXOpen::Drawings::EditSectionLineSettingsBuilder* NXOpen::Drafting::SettingsManager::CreateDrawingEditSectionLineSettingsBuilder ( const std::vector< NXOpen::Drawings::SectionLine * > &  sectionLines)

Creates a NXOpen::Drawings::EditSectionLineSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object.

Client must call Drafting::SettingsManager::ProcessForMultipleObjectsSettings after creating all settings builder for selected objects.

Returns
The section line settings builder
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")
Parameters
sectionLinesThe array of object for section line style, NULL is allowed.
NXOpen::Drawings::EditViewLabelSettingsBuilder* NXOpen::Drafting::SettingsManager::CreateDrawingEditViewLabelSettingsBuilder ( const std::vector< NXOpen::DisplayableObject * > &  viewLabels)

Creates a NXOpen::Drawings::EditViewLabelSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object.

Client must call Drafting::SettingsManager::ProcessForMultipleObjectsSettings after creating all settings builder for selected objects.

Returns
The view label settings builder
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")
Parameters
viewLabelsthe array of view labels to edit, NULL is not allowed.
NXOpen::Drawings::EditViewSettingsBuilder* NXOpen::Drafting::SettingsManager::CreateDrawingEditViewSettingsBuilder ( const std::vector< NXOpen::View * > &  views)

Creates a NXOpen::Drawings::EditViewSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object.

Client must call Drafting::SettingsManager::ProcessForMultipleObjectsSettings after creating all settings builder for selected objects.

Returns
The view settings builder
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")
Parameters
viewsThe array of objects for view style, NULL not allowed.
NXOpen::Layout2d::EditComponentSettingsBuilder* NXOpen::Drafting::SettingsManager::CreateLayout2dEditComponentSettingsBuilder ( const std::vector< NXOpen::Layout2d::Component * > &  components)

Creates a NXOpen::Layout2d::EditComponentSettingsBuilder This builder is the interface to edit the 2d component settings of layout
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object.

Client must call Drafting::SettingsManager::ProcessForMultipleObjectsSettings after creating all settings builder for selected objects.

Returns
The layout2d component settings builder
Created in NX9.0.0.

License requirements : nx_layout ("NX Layout")
Parameters
componentsThe array of components to edit. NULL is not allowed
NXOpen::Drafting::PreferencesBuilder* NXOpen::Drafting::SettingsManager::CreatePreferencesBuilder ( )

Creates a NXOpen::Drafting::PreferencesBuilder.

Returns

Created in NX9.0.0.

License requirements : drafting ("DRAFTING")
NXOpen::Annotations::TableEditSettingsBuilder* NXOpen::Drafting::SettingsManager::CreateTableEditSettingsBuilder ( const std::vector< NXOpen::DisplayableObject * > &  objects)

Creates a NXOpen::Annotations::TableEditSettingsBuilder
For multiple object settings, first create primary settings builder by passing all selected 'n' objects.Then create 'n-1' secondary builders by passing single selected object starting from second selected object.

Client must call Drafting::SettingsManager::ProcessForMultipleObjectsSettings after creating all settings builder for selected objects.

Returns
The table settings builder
Created in NX9.0.0.

License requirements : drafting ("DRAFTING")
Parameters
objectsthe array of objects for style, If NULL, section or cell preferences for all sections or cells will be set.
void NXOpen::Drafting::SettingsManager::ProcessForMultipleObjectsSettings ( const std::vector< NXOpen::Drafting::BaseEditSettingsBuilder * > &  editSettingsBuilders)

Process edit settings builders for multiple objects User must call this API for multiple object settings and pass all edit settings builders for selected objects.


Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters
editSettingsBuilderseditsettingsbuilders
void NXOpen::Drafting::SettingsManager::ProcessForMutipleObjectsSettings ( const std::vector< NXOpen::Drafting::BaseEditSettingsBuilder * > &  editSettingsBuilders)

Process edit settings builders for mutiple objects.


Deprecated:
Deprecated in NX10.0.0. Use Drafting::SettingsManager::ProcessForMultipleObjectsSettings instead.


Created in NX9.0.0.

License requirements : drafting ("DRAFTING")

Parameters
editSettingsBuilderseditsettingsbuilders
tag_t NXOpen::Drafting::SettingsManager::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.