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

Represents a Drawings::DrawingSheetBuilder
创建这个类的新实例, use Drawings::DrawingSheetCollection::DrawingSheetBuilder

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::Drawings::DrawingSheetBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  SheetBaseordrawingView { SheetBaseordrawingViewBase, SheetBaseordrawingViewDrawing }
 基本视图选项More...
 
enum  SheetMode { SheetModeCreate, SheetModeEdit }
 图纸对话框模式More...
 
enum  SheetOption { SheetOptionUseTemplate, SheetOptionStandardSize, SheetOptionCustomSize }
 指定要创建的新图纸的属性的选项.  More...
 
enum  SheetProjectionAngle { SheetProjectionAngleFirst, SheetProjectionAngleThird }
 图纸投影角More...
 
enum  SheetStandardEnglishScale {
  SheetStandardEnglishScaleS81, SheetStandardEnglishScaleS41, SheetStandardEnglishScaleS21, SheetStandardEnglishScaleS11,
  SheetStandardEnglishScaleS12, SheetStandardEnglishScaleS14, SheetStandardEnglishScaleS18, SheetStandardEnglishScaleCustom
}
 标准英制图纸More...
 
enum  SheetStandardMetricScale {
  SheetStandardMetricScaleS501, SheetStandardMetricScaleS201, SheetStandardMetricScaleS101, SheetStandardMetricScaleS51,
  SheetStandardMetricScaleS21, SheetStandardMetricScaleS11, SheetStandardMetricScaleS12, SheetStandardMetricScaleS15,
  SheetStandardMetricScaleS110, SheetStandardMetricScaleS120, SheetStandardMetricScaleS150, SheetStandardMetricScaleS1100,
  SheetStandardMetricScaleCustom
}
 标准公制图纸More...
 
enum  SheetUnits { SheetUnitsMetric, SheetUnitsEnglish }
 图纸单位More...
 

Public Member Functions

bool AutoStartBaseView ()
 返回一个设置,该设置控制在插入一个没有视图的图纸之后,是否自动启动Add Base视图命令 
 
bool AutoStartViewCreation ()
 返回一个设置,该设置控制是否在插入没有视图的图纸后自动启动添加视图创建
 
NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView BaseordrawingView ()
 返回基本视图或图纸视图的选项
Created in NX7.5.0.
 
NXString EnglishSheetTemplateLocation ()
 返回要添加到部件文件的英文图纸模板的位置
Created in NX5.0.0.
 
double Height ()
 返回图纸的自定义高度或标准高度
Created in NX5.0.0.
 
double Length ()
 返回用于创建或编辑图纸的自定义长度或标准长度. 
 
NXString MetricSheetTemplateLocation ()
 返回要添加到部件文件的公制图纸模板的位置
Created in NX5.0.0.
 
NXString Name ()
 返回要创建或编辑的图纸的名称
Created in NX5.0.0.
 
NXString Number ()
 返回要创建或编辑的图纸的数目
Created in NX8.0.0.
 
NXOpen::Drawings::DrawingSheetBuilder::SheetOption Option ()
 返回用于创建图纸的选项
Created in NX5.0.0.
 
NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle ProjectionAngle ()
 返回投影角度选项
Created in NX5.0.0.
 
NXString Revision ()
 返回要创建或编辑的绘图页的修改
Created in NX8.0.0.
 
double ScaleDenominator ()
 返回自定义比例
Created in NX5.0.0.
 
double ScaleNumerator ()
 返回一个自定义比例的分母
Created in NX5.0.0.
 
NXString SecondaryNumber ()
 返回要创建或编辑的图纸页的辅助编号
Created in NX8.0.0.
 
void SetAutoStartBaseView (bool autoStartBaseView)
 设置控件是否在插入没有视图的图纸后自动启动的设置. 
 
void SetAutoStartViewCreation (bool autoStartViewCreation)
 设置控件是否在插入没有视图的图纸后自动启动添加视图创建的设置. 
 
void SetBaseordrawingView (NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView option)
 设置基本视图或绘图视图的选项
Created in NX7.5.0.
 
void SetEnglishSheetTemplateLocation (const NXString &englishSheetTemplateLocation)
 设置要添加到部件文件中的英文图纸模板的位置
Created in NX5.0.0.
 
void SetEnglishSheetTemplateLocation (const char *englishSheetTemplateLocation)
 设置要添加到部件文件的英文绘图表模板的位置
Created in NX5.0.0.
 
void SetHeight (double height)
 设置图纸的自定义或标准高度
Created in NX5.0.0.
 
void SetLength (double length)
 设置用于创建或编辑图纸的自定义长度或标准长度. 
 
void SetMetricSheetTemplateLocation (const NXString &metricSheetTemplateLocation)
 设置要添加到部件文件中的公制图纸模板的位置
Created in NX5.0.0.
 
void SetMetricSheetTemplateLocation (const char *metricSheetTemplateLocation)
 设置要添加到部件文件中的公制图纸模板的位置
Created in NX5.0.0.
 
void SetName (const NXString &name)
 设置图纸名称
Created in NX5.0.0.
 
void SetName (const char *name)
 设置图纸名称
Created in NX5.0.0.
 
void SetNumber (const NXString &number)
 设置要创建或编辑的图纸的数目
Created in NX8.0.0.
 
void SetNumber (const char *number)
 设置要创建或编辑的图纸的数目
Created in NX8.0.0.
 
void SetOption (NXOpen::Drawings::DrawingSheetBuilder::SheetOption option)
 设置用于创建图纸的选项
Created in NX5.0.0.
 
void SetProjectionAngle (NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle projectionAngle)
 设置投影角度选项
Created in NX5.0.0.
 
void SetRevision (const NXString &revision)
 设置要创建或编辑的图纸的修改
Created in NX8.0.0.
 
void SetRevision (const char *revision)
 设置要创建或编辑的图纸的修改
Created in NX8.0.0.
 
void SetScaleDenominator (double scaleDenominator)
 设置自定义比例的分母
Created in NX5.0.0.
 
void SetScaleNumerator (double scaleNumerator)
 设置一个自定义比例的分母
Created in NX5.0.0.
 
void SetSecondaryNumber (const NXString &secondaryNumber)
 设置要创建或编辑的图纸的辅助编号
Created in NX8.0.0.
 
void SetSecondaryNumber (const char *secondaryNumber)
 设置要创建或编辑的图纸的辅助编号
Created in NX8.0.0.
 
void SetStandardEnglishScale (NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale englishScale)
 设定标准英制图纸比例
Created in NX5.0.0.
 
void SetStandardMetricScale (NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale metricScale)
 设定标准公制制图比例
Created in NX5.0.0.
 
void SetUnits (NXOpen::Drawings::DrawingSheetBuilder::SheetUnits units)
 Sets the units for the drawing sheet
Created in NX5.0.0.
 
NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale StandardEnglishScale ()
 Returns the standard English drawing scale
Created in NX5.0.0.
 
NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale StandardMetricScale ()
 Returns the standard Metric drawing scale
Created in NX5.0.0.
 
NXOpen::Drawings::DrawingSheetBuilder::SheetUnits Units ()
 Returns the units for the drawing sheet
Created in NX5.0.0.
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder.
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder.
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit.
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder.
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results.
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called.
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t GetTag () const
 
<b>Deprecated</b>:<br>

   Use Tag instead.

 
tag_t Tag () const
 Returns the tag of this object.
 

Detailed Description

Represents a Drawings::DrawingSheetBuilder
To create a new instance of this class, use Drawings::DrawingSheetCollection::DrawingSheetBuilder

Created in NX5.0.0.


Member Enumeration Documentation

the base view or drawing view option

Enumerator:
SheetBaseordrawingViewBase 

auto start base view

SheetBaseordrawingViewDrawing 

auto start drawing view

the drawing sheet dialog mode

Enumerator:
SheetModeCreate 

create mode

SheetModeEdit 

edit mode

the options for specifying the attributes of the new drawing sheet to be created.

Enumerator:
SheetOptionUseTemplate 

a drawing sheet template

SheetOptionStandardSize 

a standard size drawing sheet

SheetOptionCustomSize 

a custom size drawing sheet

the drawing sheet projection angle

Enumerator:
SheetProjectionAngleFirst 

first angle projection

SheetProjectionAngleThird 

third angle projection

the standard English drawing sheet scales

Enumerator:
SheetStandardEnglishScaleS81 

a scale of 8:1

SheetStandardEnglishScaleS41 

a scale of 4:1

SheetStandardEnglishScaleS21 

a scale of 2:1

SheetStandardEnglishScaleS11 

a scale of 1:1

SheetStandardEnglishScaleS12 

a scale of 1:2

SheetStandardEnglishScaleS14 

a scale of 1:4

SheetStandardEnglishScaleS18 

a scale of 1:8

SheetStandardEnglishScaleCustom 

a custom scale

the standard Metric drawing sheet scales

Enumerator:
SheetStandardMetricScaleS501 

a scale of 50:1

SheetStandardMetricScaleS201 

a scale of 20:1

SheetStandardMetricScaleS101 

a scale of 10:1

SheetStandardMetricScaleS51 

a scale of 5:1

SheetStandardMetricScaleS21 

a scale of 2:1

SheetStandardMetricScaleS11 

a scale of 1:1

SheetStandardMetricScaleS12 

a scale of 1:2

SheetStandardMetricScaleS15 

a scale of 1:5

SheetStandardMetricScaleS110 

a scale of 1:10

SheetStandardMetricScaleS120 

a scale of 1:20

SheetStandardMetricScaleS150 

a scale of 1:50

SheetStandardMetricScaleS1100 

a scale of 1:100

SheetStandardMetricScaleCustom 

a custom scale

the drawing sheet units

Enumerator:
SheetUnitsMetric 

a Metric units drawing sheet

SheetUnitsEnglish 

an English units drawing sheet

Member Function Documentation

bool NXOpen::Drawings::DrawingSheetBuilder::AutoStartBaseView ( )

Returns the setting that controls whether or not the Add Base View command is automatically started after inserting a sheet that has no views on it.

       This option does not appear for Edit Sheet. 
       the toggle is changed to be auto start view creation in Nx7.0, obsolete.


Deprecated:
Deprecated in NX7.5.0. Use Drawings::DrawingSheetBuilder::AutoStartViewCreation instead.


Created in NX5.0.0.

License requirements : None

bool NXOpen::Drawings::DrawingSheetBuilder::AutoStartViewCreation ( )

Returns the setting that controls whether or not the Add View creation is automatically started after inserting a sheet that has no views on it.

       This option does not appear for Edit Sheet.             


Created in NX7.5.0.

License requirements : None

NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView NXOpen::Drawings::DrawingSheetBuilder::BaseordrawingView ( )

Returns the option of base view or drawing view
Created in NX7.5.0.



License requirements : None

NXString NXOpen::Drawings::DrawingSheetBuilder::EnglishSheetTemplateLocation ( )

Returns the location of the english drawing sheet template to be added to the part file
Created in NX5.0.0.



License requirements : None

double NXOpen::Drawings::DrawingSheetBuilder::Height ( )

Returns the custom or standard height for the drawing sheet
Created in NX5.0.0.



License requirements : None

double NXOpen::Drawings::DrawingSheetBuilder::Length ( )

Returns the custom or standard length to be used for the drawing to be created or edited.


Created in NX5.0.0.

License requirements : None

NXString NXOpen::Drawings::DrawingSheetBuilder::MetricSheetTemplateLocation ( )

Returns the location of the metric drawing sheet template to be added to the part file
Created in NX5.0.0.



License requirements : None

NXString NXOpen::Drawings::DrawingSheetBuilder::Name ( )

Returns the name of the drawing sheet to be created or edited
Created in NX5.0.0.



License requirements : None

NXString NXOpen::Drawings::DrawingSheetBuilder::Number ( )

Returns the number of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : None

NXOpen::Drawings::DrawingSheetBuilder::SheetOption NXOpen::Drawings::DrawingSheetBuilder::Option ( )

Returns the option to be used to create the drawing sheet
Created in NX5.0.0.



License requirements : None

NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle NXOpen::Drawings::DrawingSheetBuilder::ProjectionAngle ( )

Returns the projection_angle option
Created in NX5.0.0.



License requirements : None

NXString NXOpen::Drawings::DrawingSheetBuilder::Revision ( )

Returns the revision of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : None

double NXOpen::Drawings::DrawingSheetBuilder::ScaleDenominator ( )

Returns the denominator of a custom scale
Created in NX5.0.0.



License requirements : None

double NXOpen::Drawings::DrawingSheetBuilder::ScaleNumerator ( )

Returns the numerator of a custom scale
Created in NX5.0.0.



License requirements : None

NXString NXOpen::Drawings::DrawingSheetBuilder::SecondaryNumber ( )

Returns the secondary number of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : None

void NXOpen::Drawings::DrawingSheetBuilder::SetAutoStartBaseView ( bool  autoStartBaseView)

Sets the setting that controls whether or not the Add Base View command is automatically started after inserting a sheet that has no views on it.

       This option does not appear for Edit Sheet. 
       the toggle is changed to be auto start view creation in Nx7.0, obsolete.


Deprecated:
Deprecated in NX7.5.0. Use Drawings::DrawingSheetBuilder::SetAutoStartViewCreation instead.


Created in NX5.0.0.

License requirements : None

Parameters
autoStartBaseViewthe add base view automatic start toggle
void NXOpen::Drawings::DrawingSheetBuilder::SetAutoStartViewCreation ( bool  autoStartViewCreation)

Sets the setting that controls whether or not the Add View creation is automatically started after inserting a sheet that has no views on it.

       This option does not appear for Edit Sheet.             


Created in NX7.5.0.

License requirements : None

Parameters
autoStartViewCreationthe automatically start view creation
void NXOpen::Drawings::DrawingSheetBuilder::SetBaseordrawingView ( NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView  option)

Sets the option of base view or drawing view
Created in NX7.5.0.



License requirements : drafting ("DRAFTING")

Parameters
optionthe type of view to automatically start creating
void NXOpen::Drawings::DrawingSheetBuilder::SetEnglishSheetTemplateLocation ( const NXString englishSheetTemplateLocation)

Sets the location of the english drawing sheet template to be added to the part file
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
englishSheetTemplateLocationenglish drawing sheet template location
void NXOpen::Drawings::DrawingSheetBuilder::SetEnglishSheetTemplateLocation ( const char *  englishSheetTemplateLocation)

Sets the location of the english drawing sheet template to be added to the part file
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
englishSheetTemplateLocationenglish drawing sheet template location
void NXOpen::Drawings::DrawingSheetBuilder::SetHeight ( double  height)

Sets the custom or standard height for the drawing sheet
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
heightthe custom or standard height for the drawing sheet
void NXOpen::Drawings::DrawingSheetBuilder::SetLength ( double  length)

Sets the custom or standard length to be used for the drawing to be created or edited.


Created in NX5.0.0.

License requirements : drafting ("DRAFTING")

Parameters
lengththe custom or standard length for the drawing sheet
void NXOpen::Drawings::DrawingSheetBuilder::SetMetricSheetTemplateLocation ( const NXString metricSheetTemplateLocation)

Sets the location of the metric drawing sheet template to be added to the part file
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
metricSheetTemplateLocationmetric drawing sheet template location
void NXOpen::Drawings::DrawingSheetBuilder::SetMetricSheetTemplateLocation ( const char *  metricSheetTemplateLocation)

Sets the location of the metric drawing sheet template to be added to the part file
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
metricSheetTemplateLocationmetric drawing sheet template location
void NXOpen::Drawings::DrawingSheetBuilder::SetName ( const NXString name)

Sets the name of the drawing sheet to be created or edited
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
namedrawing sheet name
void NXOpen::Drawings::DrawingSheetBuilder::SetName ( const char *  name)

Sets the name of the drawing sheet to be created or edited
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
namedrawing sheet name
void NXOpen::Drawings::DrawingSheetBuilder::SetNumber ( const NXString number)

Sets the number of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
numberthe drawing sheet number
void NXOpen::Drawings::DrawingSheetBuilder::SetNumber ( const char *  number)

Sets the number of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
numberthe drawing sheet number
void NXOpen::Drawings::DrawingSheetBuilder::SetOption ( NXOpen::Drawings::DrawingSheetBuilder::SheetOption  option)

Sets the option to be used to create the drawing sheet
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
optionthe option to be used to create the drawing sheet
void NXOpen::Drawings::DrawingSheetBuilder::SetProjectionAngle ( NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle  projectionAngle)

Sets the projection_angle option
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
projectionAnglethe projection_angle option
void NXOpen::Drawings::DrawingSheetBuilder::SetRevision ( const NXString revision)

Sets the revision of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
revisionthe drawing sheet revision
void NXOpen::Drawings::DrawingSheetBuilder::SetRevision ( const char *  revision)

Sets the revision of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
revisionthe drawing sheet revision
void NXOpen::Drawings::DrawingSheetBuilder::SetScaleDenominator ( double  scaleDenominator)

Sets the denominator of a custom scale
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
scaleDenominatorthe denominator of a custom scale
void NXOpen::Drawings::DrawingSheetBuilder::SetScaleNumerator ( double  scaleNumerator)

Sets the numerator of a custom scale
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
scaleNumeratorscale numerator
void NXOpen::Drawings::DrawingSheetBuilder::SetSecondaryNumber ( const NXString secondaryNumber)

Sets the secondary number of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
secondaryNumberthe drawing sheet secondary number
void NXOpen::Drawings::DrawingSheetBuilder::SetSecondaryNumber ( const char *  secondaryNumber)

Sets the secondary number of the drawing sheet to be created or edited
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters
secondaryNumberthe drawing sheet secondary number
void NXOpen::Drawings::DrawingSheetBuilder::SetStandardEnglishScale ( NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale  englishScale)

Sets the standard English drawing scale
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
englishScalethe standard English drawing scale
void NXOpen::Drawings::DrawingSheetBuilder::SetStandardMetricScale ( NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale  metricScale)

Sets the standard Metric drawing scale
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
metricScalethe standard Metric drawing scale
void NXOpen::Drawings::DrawingSheetBuilder::SetUnits ( NXOpen::Drawings::DrawingSheetBuilder::SheetUnits  units)

Sets the units for the drawing sheet
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters
unitsthe units for the drawing sheet
NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale NXOpen::Drawings::DrawingSheetBuilder::StandardEnglishScale ( )

Returns the standard English drawing scale
Created in NX5.0.0.



License requirements : None

NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale NXOpen::Drawings::DrawingSheetBuilder::StandardMetricScale ( )

Returns the standard Metric drawing scale
Created in NX5.0.0.



License requirements : None

NXOpen::Drawings::DrawingSheetBuilder::SheetUnits NXOpen::Drawings::DrawingSheetBuilder::Units ( )

Returns the units for the drawing sheet
Created in NX5.0.0.



License requirements : None


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