SheetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SheetBuilder Class

class `NXOpen.Diagramming.``SheetBuilder`

  Bases: `NXOpen.Diagramming.BaseObjectBuilder`

  Represents a SheetBuilder.

  To create a new instance of this class, use `NXOpen.Diagramming.SheetCollection.CreateSheetBuilder()`

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
AllowJumpers | Returns or sets the flag if jumpers are allowed to use where connections cross.
Description | Returns or sets the description that will be visible when a template is selected in the Item Rev dialog.
JumperType | Returns or sets the jumper type of the sheet.
Opacity | Returns or sets the opacity of sheet.
PaxFileName | Returns or sets the path name of the PAX file to which the template will be written to.
PresentationName | Returns or sets the presentation name that will be visible in the Presentation column of the Item Rev dialog.
Tag | Returns the Tag for this object.
ToolTip | Returns or sets the tooltip that will be visible when a template is selected in the Item Rev dialog.
Units | Returns or sets the units of the sheet.
UpdatePAXFile | Returns or sets the flag to update pax file or not.

# 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.
GetFeatures | Gets all features.
GetObject | Returns the object currently being edited by this builder.
GetSheetElements | Gets all sheet elements.
GetSize | Gets the height and width of this sheet.
SetSize | Sets the height and width of this sheet.
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

## AllowJumpers

`SheetBuilder.``AllowJumpers`

  Returns or sets the flag if jumpers are allowed to use where connections cross.

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

  Getter Method

  Signature `AllowJumpers`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `AllowJumpers`

  Parameters: | allowJumper (bool) –

  New in version NX10.0.0.

  License requirements: None.

## Description

`SheetBuilder.``Description`

  Returns or sets the description that will be visible when a template is selected in the Item Rev dialog.

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

  Getter Method

  Signature `Description`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `Description`

  Parameters: | description (str) –

  New in version NX11.0.1.

  License requirements: None.

## JumperType

`SheetBuilder.``JumperType`

  Returns or sets the jumper type of the sheet.

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

  Getter Method

  Signature `JumperType`

  Returns: |
  Return type: | `NXOpen.Diagramming.DiagrammingJumpertype`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `JumperType`

  Parameters: | jumperType (`NXOpen.Diagramming.DiagrammingJumpertype`) –

  New in version NX11.0.0.

  License requirements: None.

## Opacity

`SheetBuilder.``Opacity`

  Returns or sets the opacity of sheet.

  0.0 is completely transparent and 1.0 is completely opaque

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

  Getter Method

  Signature `Opacity`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Opacity`

  Parameters: | opacity (float) –

  New in version NX10.0.0.

  License requirements: None.

## PaxFileName

`SheetBuilder.``PaxFileName`

  Returns or sets the path name of the PAX file to which the template will be written to.

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

  Getter Method

  Signature `PaxFileName`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `PaxFileName`

  Parameters: | paxFileName (str) –

  New in version NX11.0.1.

  License requirements: None.

## PresentationName

`SheetBuilder.``PresentationName`

  Returns or sets the presentation name that will be visible in the “Presentation” column of the Item Rev dialog.

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

  Getter Method

  Signature `PresentationName`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `PresentationName`

  Parameters: | presentationName (str) –

  New in version NX11.0.1.

  License requirements: None.

## ToolTip

`SheetBuilder.``ToolTip`

  Returns or sets the tooltip that will be visible when a template is selected in the Item Rev dialog.

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

  Getter Method

  Signature `ToolTip`

  Returns: |
  Return type: | str

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `ToolTip`

  Parameters: | toolTip (str) –

  New in version NX11.0.1.

  License requirements: None.

## Units

`SheetBuilder.``Units`

  Returns or sets the units of the sheet.

  It could be either “meters” or “inches”.

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

  Getter Method

  Signature `Units`

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

  New in version NX10.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Units`

  Parameters: | unit (`NXOpen.Unit`) –

  New in version NX10.0.0.

  License requirements: None.

## UpdatePAXFile

`SheetBuilder.``UpdatePAXFile`

  Returns or sets the flag to update pax file or not.

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

  Getter Method

  Signature `UpdatePAXFile`

  Returns: |
  Return type: | bool

  New in version NX11.0.1.

  License requirements: None.

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

  Setter Method

  Signature `UpdatePAXFile`

  Parameters: | updatePAXFile (bool) –

  New in version NX11.0.1.

  License requirements: None.

# Method Detail

## GetFeatures

`SheetBuilder.``GetFeatures`

  Gets all features.

  Signature `GetFeatures()`

  Returns: |
  Return type: | list of `NXOpen.Diagramming.SheetElement`

  New in version NX10.0.0.

  License requirements: None.

## GetSheetElements

`SheetBuilder.``GetSheetElements`

  Gets all sheet elements.

  Signature `GetSheetElements()`

  Returns: |
  Return type: | list of `NXOpen.Diagramming.SheetElement`

  New in version NX10.0.0.

  License requirements: None.

## GetSize

`SheetBuilder.``GetSize`

  Gets the height and width of this sheet.

  Signature `GetSize()`

  Returns: | a tuple
  Return type: | A tuple consisting of (height, width) height is a float. width is a float.

  New in version NX10.0.0.

  License requirements: None.

## SetSize

`SheetBuilder.``SetSize`

  Sets the height and width of this sheet.

  Signature `SetSize(height, width)`

  Parameters:

  - height (float) –
  - width (float) –

  New in version NX10.0.0.

  License requirements: None.

## Validate

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