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

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

Created in NX5.0.0. More...

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

List of all members.

Public Types

enum  SheetBaseordrawingView { SheetBaseordrawingViewBase, SheetBaseordrawingViewDrawing }
 the base view or drawing view option More...
enum  SheetMode { SheetModeCreate, SheetModeEdit }
 the drawing sheet dialog mode More...
enum  SheetOption { SheetOptionUseTemplate, SheetOptionStandardSize, SheetOptionCustomSize }
 the options for specifying the attributes of the new drawing sheet to be created. More...
enum  SheetProjectionAngle { SheetProjectionAngleFirst, SheetProjectionAngleThird }
 the drawing sheet projection angle More...
enum  SheetStandardEnglishScale {
  SheetStandardEnglishScaleS81, SheetStandardEnglishScaleS41, SheetStandardEnglishScaleS21, SheetStandardEnglishScaleS11,
  SheetStandardEnglishScaleS12, SheetStandardEnglishScaleS14, SheetStandardEnglishScaleS18, SheetStandardEnglishScaleCustom
}
 the standard English drawing sheet scales More...
enum  SheetStandardMetricScale {
  SheetStandardMetricScaleS501, SheetStandardMetricScaleS201, SheetStandardMetricScaleS101, SheetStandardMetricScaleS51,
  SheetStandardMetricScaleS21, SheetStandardMetricScaleS11, SheetStandardMetricScaleS12, SheetStandardMetricScaleS15,
  SheetStandardMetricScaleS110, SheetStandardMetricScaleS120, SheetStandardMetricScaleS150, SheetStandardMetricScaleS1100,
  SheetStandardMetricScaleCustom
}
 the standard Metric drawing sheet scales More...
enum  SheetUnits { SheetUnitsMetric, SheetUnitsEnglish }
 the drawing sheet units More...

Public Member Functions

bool 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.
bool 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.
NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView BaseordrawingView ()
 Returns the option of base view or drawing view
Created in NX7.5.0.
NXString EnglishSheetTemplateLocation ()
 Returns the location of the english drawing sheet template to be added to the part file
Created in NX5.0.0.
double Height ()
 Returns the custom or standard height for the drawing sheet
Created in NX5.0.0.
double Length ()
 Returns the custom or standard length to be used for the drawing to be created or edited.
NXString MetricSheetTemplateLocation ()
 Returns the location of the metric drawing sheet template to be added to the part file
Created in NX5.0.0.
NXString Name ()
 Returns the name of the drawing sheet to be created or edited
Created in NX5.0.0.
NXString Number ()
 Returns the number of the drawing sheet to be created or edited
Created in NX8.0.0.
NXOpen::Drawings::DrawingSheetBuilder::SheetOption Option ()
 Returns the option to be used to create the drawing sheet
Created in NX5.0.0.
NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle ProjectionAngle ()
 Returns the projection_angle option
Created in NX5.0.0.
NXString Revision ()
 Returns the revision of the drawing sheet to be created or edited
Created in NX8.0.0.
double ScaleDenominator ()
 Returns the denominator of a custom scale
Created in NX5.0.0.
double ScaleNumerator ()
 Returns the numerator of a custom scale
Created in NX5.0.0.
NXString SecondaryNumber ()
 Returns the secondary number of the drawing sheet to be created or edited
Created in NX8.0.0.
void 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.
void 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.
void SetBaseordrawingView (NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView option)
 Sets the option of base view or drawing view
Created in NX7.5.0.
void 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.
void SetHeight (double height)
 Sets the custom or standard height for the drawing sheet
Created in NX5.0.0.
void SetLength (double length)
 Sets the custom or standard length to be used for the drawing to be created or edited.
void 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.
void SetName (const NXString &name)
 Sets the name of the drawing sheet to be created or edited
Created in NX5.0.0.
void SetNumber (const NXString &number)
 Sets the number of the drawing sheet to be created or edited
Created in NX8.0.0.
void SetOption (NXOpen::Drawings::DrawingSheetBuilder::SheetOption option)
 Sets the option to be used to create the drawing sheet
Created in NX5.0.0.
void SetProjectionAngle (NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle projectionAngle)
 Sets the projection_angle option
Created in NX5.0.0.
void SetRevision (const NXString &revision)
 Sets the revision of the drawing sheet to be created or edited
Created in NX8.0.0.
void SetScaleDenominator (double scaleDenominator)
 Sets the denominator of a custom scale
Created in NX5.0.0.
void SetScaleNumerator (double scaleNumerator)
 Sets the numerator of a custom scale
Created in NX5.0.0.
void SetSecondaryNumber (const NXString &secondaryNumber)
 Sets the secondary number of the drawing sheet to be created or edited
Created in NX8.0.0.
void SetStandardEnglishScale (NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale englishScale)
 Sets the standard English drawing scale
Created in NX5.0.0.
void SetStandardMetricScale (NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale metricScale)
 Sets the standard Metric drawing scale
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.

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

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.


Created in NX5.0.0.

License requirements : None

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

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

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

Returns the projection_angle option
Created in NX5.0.0.



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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



License requirements : None

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.


Created in NX5.0.0.

License requirements : None

Parameters:
autoStartBaseViewthe add base view automatic start toggle

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

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

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

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

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

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

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

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

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

Sets the projection_angle option
Created in NX5.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
projectionAnglethe projection_angle option

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

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



License requirements : drafting ("DRAFTING")

Parameters:
scaleDenominatorthe denominator of a custom scale

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



License requirements : drafting ("DRAFTING")

Parameters:
scaleNumeratorscale numerator

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

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



License requirements : drafting ("DRAFTING")

Parameters:
englishScalethe standard English drawing scale

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



License requirements : drafting ("DRAFTING")

Parameters:
metricScalethe standard Metric drawing scale

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



License requirements : drafting ("DRAFTING")

Parameters:
unitsthe units for the drawing sheet

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



License requirements : None

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



License requirements : None

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 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.