DrawingSheetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# DrawingSheetBuilder Class

class `NXOpen.Drawings.``DrawingSheetBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Drawings.DrawingSheetBuilder`

  This class was made abstract in NX12 and the creator (JA_DRAWING_SHEET_COLLECTION_drawing_sheet_builder) was deprecated

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
AutoStartBaseView | Returns or 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.
AutoStartViewCreation | Returns or 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.
BaseordrawingView | Returns or sets the option of base view or drawing view
EnglishSheetTemplateLocation | Returns or sets the location of the english drawing sheet template to be added to the part file
Height | Returns or sets the custom or standard height for the drawing sheet
Length | Returns or sets the custom or standard length to be used for the drawing to be created or edited.
MetricSheetTemplateLocation | Returns or sets the location of the metric drawing sheet template to be added to the part file
Name | Returns or sets the name of the drawing sheet to be created or edited
Number | Returns or sets the number of the drawing sheet to be created or edited
Option | Returns or sets the option to be used to create the drawing sheet
ProjectionAngle | Returns or sets the projection_angle option
Revision | Returns or sets the revision of the drawing sheet to be created or edited
ScaleDenominator | Returns or sets the denominator of a custom scale
ScaleNumerator | Returns or sets the numerator of a custom scale
SecondaryNumber | Returns or sets the secondary number of the drawing sheet to be created or edited
StandardEnglishScale | Returns or sets the standard English drawing scale
StandardMetricScale | Returns or sets the standard Metric drawing scale
Tag | Returns the Tag for this object.
Units | Returns or sets the units for the drawing sheet

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

DrawingSheetBuilderSheetBaseordrawingView Enumeration | the base view or drawing view option
DrawingSheetBuilderSheetMode Enumeration | the drawing sheet dialog mode
DrawingSheetBuilderSheetOption Enumeration | the options for specifying the attributes of the new drawing sheet to be created.
DrawingSheetBuilderSheetProjectionAngle Enumeration | the drawing sheet projection angle
DrawingSheetBuilderSheetStandardEnglishScale Enumeration | the standard English drawing sheet scales
DrawingSheetBuilderSheetStandardMetricScale Enumeration | the standard Metric drawing sheet scales
DrawingSheetBuilderSheetUnits Enumeration | the drawing sheet units

# Property Detail

## AutoStartBaseView

`DrawingSheetBuilder.``AutoStartBaseView`

  Returns or 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.

  `-------------------------------------`

  Getter Method

  Signature `AutoStartBaseView`

  Returns: | the add base view automatic start toggle
  Return type: | bool

  New in version NX5.0.0.

  Deprecated since version NX7.5.0: Use `NXOpen.Drawings.DrawingSheetBuilder.AutoStartViewCreation()` instead.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AutoStartBaseView`

  Parameters: | autoStartBaseView (bool) – the add base view automatic start toggle

  New in version NX5.0.0.

  Deprecated since version NX7.5.0: Use `NXOpen.Drawings.DrawingSheetBuilder.AutoStartViewCreation()` instead.

  License requirements: None.

## AutoStartViewCreation

`DrawingSheetBuilder.``AutoStartViewCreation`

  Returns or 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.

  `-------------------------------------`

  Getter Method

  Signature `AutoStartViewCreation`

  Returns: | the automatically start view creation
  Return type: | bool

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AutoStartViewCreation`

  Parameters: | autoStartViewCreation (bool) – the automatically start view creation

  New in version NX7.5.0.

  License requirements: None.

## BaseordrawingView

`DrawingSheetBuilder.``BaseordrawingView`

  Returns or sets the option of base view or drawing view

  `-------------------------------------`

  Getter Method

  Signature `BaseordrawingView`

  Returns: | the type of view to automatically start creating
  Return type: | `NXOpen.Drawings.DrawingSheetBuilderSheetBaseordrawingView`

  New in version NX7.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BaseordrawingView`

  Parameters: | option (`NXOpen.Drawings.DrawingSheetBuilderSheetBaseordrawingView`) – the type of view to automatically start creating

  New in version NX7.5.0.

  License requirements: drafting (“DRAFTING”)

## EnglishSheetTemplateLocation

`DrawingSheetBuilder.``EnglishSheetTemplateLocation`

  Returns or sets the location of the english drawing sheet template to be added to the part file

  `-------------------------------------`

  Getter Method

  Signature `EnglishSheetTemplateLocation`

  Returns: | the drawing sheet template location
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `EnglishSheetTemplateLocation`

  Parameters: | englishSheetTemplateLocation (str) – english drawing sheet template location

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## Height

`DrawingSheetBuilder.``Height`

  Returns or sets the custom or standard height for the drawing sheet

  `-------------------------------------`

  Getter Method

  Signature `Height`

  Returns: | the custom or standard height for the drawing sheet
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Height`

  Parameters: | height (float) – the custom or standard height for the drawing sheet

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## Length

`DrawingSheetBuilder.``Length`

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

  `-------------------------------------`

  Getter Method

  Signature `Length`

  Returns: | custom or standard length for the drawing sheet
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Length`

  Parameters: | length (float) – the custom or standard length for the drawing sheet

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## MetricSheetTemplateLocation

`DrawingSheetBuilder.``MetricSheetTemplateLocation`

  Returns or sets the location of the metric drawing sheet template to be added to the part file

  `-------------------------------------`

  Getter Method

  Signature `MetricSheetTemplateLocation`

  Returns: | the drawing sheet template location
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `MetricSheetTemplateLocation`

  Parameters: | metricSheetTemplateLocation (str) – metric drawing sheet template location

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## Name

`DrawingSheetBuilder.``Name`

  Returns or sets the name of the drawing sheet to be created or edited

  `-------------------------------------`

  Getter Method

  Signature `Name`

  Returns: | the drawing sheet name
  Return type: | str

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Name`

  Parameters: | name (str) – drawing sheet name

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## Number

`DrawingSheetBuilder.``Number`

  Returns or sets the number of the drawing sheet to be created or edited

  `-------------------------------------`

  Getter Method

  Signature `Number`

  Returns: | the drawing sheet number
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Number`

  Parameters: | number (str) – the drawing sheet number

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## Option

`DrawingSheetBuilder.``Option`

  Returns or sets the option to be used to create the drawing sheet

  `-------------------------------------`

  Getter Method

  Signature `Option`

  Returns: | the option to be used to create the drawing sheet
  Return type: | `NXOpen.Drawings.DrawingSheetBuilderSheetOption`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Option`

  Parameters: | option (`NXOpen.Drawings.DrawingSheetBuilderSheetOption`) – the option to be used to create the drawing sheet

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## ProjectionAngle

`DrawingSheetBuilder.``ProjectionAngle`

  Returns or sets the projection_angle option

  `-------------------------------------`

  Getter Method

  Signature `ProjectionAngle`

  Returns: | the projection_angle option
  Return type: | `NXOpen.Drawings.DrawingSheetBuilderSheetProjectionAngle`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ProjectionAngle`

  Parameters: | projectionAngle (`NXOpen.Drawings.DrawingSheetBuilderSheetProjectionAngle`) – the projection_angle option

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## Revision

`DrawingSheetBuilder.``Revision`

  Returns or sets the revision of the drawing sheet to be created or edited

  `-------------------------------------`

  Getter Method

  Signature `Revision`

  Returns: | the drawing sheet revision
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Revision`

  Parameters: | revision (str) – the drawing sheet revision

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## ScaleDenominator

`DrawingSheetBuilder.``ScaleDenominator`

  Returns or sets the denominator of a custom scale

  `-------------------------------------`

  Getter Method

  Signature `ScaleDenominator`

  Returns: | the denominator of a custom scale
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScaleDenominator`

  Parameters: | scaleDenominator (float) – the denominator of a custom scale

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## ScaleNumerator

`DrawingSheetBuilder.``ScaleNumerator`

  Returns or sets the numerator of a custom scale

  `-------------------------------------`

  Getter Method

  Signature `ScaleNumerator`

  Returns: | the numerator of a custom scale
  Return type: | float

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ScaleNumerator`

  Parameters: | scaleNumerator (float) –

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## SecondaryNumber

`DrawingSheetBuilder.``SecondaryNumber`

  Returns or sets the secondary number of the drawing sheet to be created or edited

  `-------------------------------------`

  Getter Method

  Signature `SecondaryNumber`

  Returns: | the drawing sheet secondary number
  Return type: | str

  New in version NX8.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `SecondaryNumber`

  Parameters: | secondaryNumber (str) – the drawing sheet secondary number

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## StandardEnglishScale

`DrawingSheetBuilder.``StandardEnglishScale`

  Returns or sets the standard English drawing scale

  `-------------------------------------`

  Getter Method

  Signature `StandardEnglishScale`

  Returns: | the standard English drawing scale
  Return type: | `NXOpen.Drawings.DrawingSheetBuilderSheetStandardEnglishScale`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StandardEnglishScale`

  Parameters: | englishScale (`NXOpen.Drawings.DrawingSheetBuilderSheetStandardEnglishScale`) – the standard English drawing scale

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## StandardMetricScale

`DrawingSheetBuilder.``StandardMetricScale`

  Returns or sets the standard Metric drawing scale

  `-------------------------------------`

  Getter Method

  Signature `StandardMetricScale`

  Returns: | the standard Metric drawing scale
  Return type: | `NXOpen.Drawings.DrawingSheetBuilderSheetStandardMetricScale`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `StandardMetricScale`

  Parameters: | metricScale (`NXOpen.Drawings.DrawingSheetBuilderSheetStandardMetricScale`) – the standard Metric drawing scale

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

## Units

`DrawingSheetBuilder.``Units`

  Returns or sets the units for the drawing sheet

  `-------------------------------------`

  Getter Method

  Signature `Units`

  Returns: | the units for the drawing sheet
  Return type: | `NXOpen.Drawings.DrawingSheetBuilderSheetUnits`

  New in version NX5.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Units`

  Parameters: | units (`NXOpen.Drawings.DrawingSheetBuilderSheetUnits`) – the units for the drawing sheet

  New in version NX5.0.0.

  License requirements: drafting (“DRAFTING”)

# Method Detail

## Validate

`DrawingSheetBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.