Represents a NXOpen::Drawings::DrawingSheetBuilder
This class was made abstract in NX12 and the creator (JA_DRAWING_SHEET_COLLECTION_drawing_sheet_builder) was deprecated

Created in NX5.0.0. More...

Inheritance diagram for NXOpen::Drawings::DrawingSheetBuilder:

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. More...

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. More...

NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView	BaseordrawingView ()
	Returns the option of base view or drawing view Created in NX7.5.0. More...

NXString	EnglishSheetTemplateLocation ()
	Returns the location of the english drawing sheet template to be added to the part file Created in NX5.0.0. More...

double	Height ()
	Returns the custom or standard height for the drawing sheet Created in NX5.0.0. More...

double	Length ()
	Returns the custom or standard length to be used for the drawing to be created or edited. More...

NXString	MetricSheetTemplateLocation ()
	Returns the location of the metric drawing sheet template to be added to the part file Created in NX5.0.0. More...

NXString	Name ()
	Returns the name of the drawing sheet to be created or edited Created in NX5.0.0. More...

NXString	Number ()
	Returns the number of the drawing sheet to be created or edited Created in NX8.0.0. More...

NXOpen::Drawings::DrawingSheetBuilder::SheetOption	Option ()
	Returns the option to be used to create the drawing sheet Created in NX5.0.0. More...

NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle	ProjectionAngle ()
	Returns the projection_angle option Created in NX5.0.0. More...

NXString	Revision ()
	Returns the revision of the drawing sheet to be created or edited Created in NX8.0.0. More...

double	ScaleDenominator ()
	Returns the denominator of a custom scale Created in NX5.0.0. More...

double	ScaleNumerator ()
	Returns the numerator of a custom scale Created in NX5.0.0. More...

NXString	SecondaryNumber ()
	Returns the secondary number of the drawing sheet to be created or edited Created in NX8.0.0. More...

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. More...

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. More...

void	SetBaseordrawingView (NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView option)
	Sets the option of base view or drawing view Created in NX7.5.0. More...

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. More...

void	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. More...

void	SetHeight (double height)
	Sets the custom or standard height for the drawing sheet Created in NX5.0.0. More...

void	SetLength (double length)
	Sets the custom or standard length to be used for the drawing to be created or edited. More...

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. More...

void	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. More...

void	SetName (const NXString &name)
	Sets the name of the drawing sheet to be created or edited Created in NX5.0.0. More...

void	SetName (const char *name)
	Sets the name of the drawing sheet to be created or edited Created in NX5.0.0. More...

void	SetNumber (const NXString &number)
	Sets the number of the drawing sheet to be created or edited Created in NX8.0.0. More...

void	SetNumber (const char *number)
	Sets the number of the drawing sheet to be created or edited Created in NX8.0.0. More...

void	SetOption (NXOpen::Drawings::DrawingSheetBuilder::SheetOption option)
	Sets the option to be used to create the drawing sheet Created in NX5.0.0. More...

void	SetProjectionAngle (NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle projectionAngle)
	Sets the projection_angle option Created in NX5.0.0. More...

void	SetRevision (const NXString &revision)
	Sets the revision of the drawing sheet to be created or edited Created in NX8.0.0. More...

void	SetRevision (const char *revision)
	Sets the revision of the drawing sheet to be created or edited Created in NX8.0.0. More...

void	SetScaleDenominator (double scaleDenominator)
	Sets the denominator of a custom scale Created in NX5.0.0. More...

void	SetScaleNumerator (double scaleNumerator)
	Sets the numerator of a custom scale Created in NX5.0.0. More...

void	SetSecondaryNumber (const NXString &secondaryNumber)
	Sets the secondary number of the drawing sheet to be created or edited Created in NX8.0.0. More...

void	SetSecondaryNumber (const char *secondaryNumber)
	Sets the secondary number of the drawing sheet to be created or edited Created in NX8.0.0. More...

void	SetStandardEnglishScale (NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale englishScale)
	Sets the standard English drawing scale Created in NX5.0.0. More...

void	SetStandardMetricScale (NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale metricScale)
	Sets the standard Metric drawing scale Created in NX5.0.0. More...

void	SetUnits (NXOpen::Drawings::DrawingSheetBuilder::SheetUnits units)
	Sets the units for the drawing sheet Created in NX5.0.0. More...

NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale	StandardEnglishScale ()
	Returns the standard English drawing scale Created in NX5.0.0. More...

NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale	StandardMetricScale ()
	Returns the standard Metric drawing scale Created in NX5.0.0. More...

NXOpen::Drawings::DrawingSheetBuilder::SheetUnits	Units ()
	Returns the units for the drawing sheet Created in NX5.0.0. More...

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

Represents a NXOpen::Drawings::DrawingSheetBuilder
This class was made abstract in NX12 and the creator (JA_DRAWING_SHEET_COLLECTION_drawing_sheet_builder) was deprecated

Created in NX5.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::DrawingSheetBuilder::SheetBaseordrawingView

the base view or drawing view option

Enumerator
SheetBaseordrawingViewBase	auto start base view
SheetBaseordrawingViewDrawing	auto start drawing view

enum NXOpen::Drawings::DrawingSheetBuilder::SheetMode

the drawing sheet dialog mode

Enumerator
SheetModeCreate	create mode
SheetModeEdit	edit mode

enum NXOpen::Drawings::DrawingSheetBuilder::SheetOption

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

enum NXOpen::Drawings::DrawingSheetBuilder::SheetProjectionAngle

the drawing sheet projection angle

Enumerator
SheetProjectionAngleFirst	first angle projection
SheetProjectionAngleThird	third angle projection

enum NXOpen::Drawings::DrawingSheetBuilder::SheetStandardEnglishScale

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

enum NXOpen::Drawings::DrawingSheetBuilder::SheetStandardMetricScale

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

enum NXOpen::Drawings::DrawingSheetBuilder::SheetUnits

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 NXOpen::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 NXOpen::Drawings::DrawingSheetBuilder::SetAutoStartViewCreation instead.

Created in NX5.0.0.

License requirements : None

Parameters

autoStartBaseView the 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

autoStartViewCreation the 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

option the 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

englishSheetTemplateLocation english 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

englishSheetTemplateLocation english 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

height the 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

length the 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

metricSheetTemplateLocation metric 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

metricSheetTemplateLocation metric 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

name	drawing 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

name	drawing 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

number the 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

number the 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

option the 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

projectionAngle the 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

revision the 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

revision the 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

scaleDenominator the 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

scaleNumerator scale 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

secondaryNumber the 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

secondaryNumber the 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

englishScale the 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

metricScale the 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

units the 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:

Drawings_DrawingSheetBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation