ConvertSheetToLayoutBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ConvertSheetToLayoutBuilder Class

class `NXOpen.Layout2d.``ConvertSheetToLayoutBuilder`

  Bases: `NXOpen.Layout2d.LayoutDrawingSheetBuilder`

  Represents a Builder for converting a drawing sheet to Layout

  To create a new instance of this class, use `NXOpen.Layout2d.LayoutDrawingSheetCollection.CreateConvertSheetToLayoutBuilder()`

  New in version NX12.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
SelectSheetView | Returns the select drawing sheet to convert
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.

# Property Detail

## SelectSheetView

`ConvertSheetToLayoutBuilder.``SelectSheetView`

  Returns the select drawing sheet to convert

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

  Getter Method

  Signature `SelectSheetView`

  Returns: |
  Return type: | `NXOpen.SelectView`

  New in version NX12.0.0.

  License requirements: None.

# Method Detail

## Validate

`ConvertSheetToLayoutBuilder.``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.