ExtendSheetBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ExtendSheetBuilder Class

class `NXOpen.Features.``ExtendSheetBuilder`

  Bases: `NXOpen.Features.FeatureBuilder`

  Represents a `NXOpen.Features.ExtendSheet` builder

  To create a new instance of this class, use `NXOpen.Features.TrimFeatureCollection.CreateExtendSheetBuilder()`

  Default values.

  Property | Value
  --- | ---
  BodyOutputOption | ExtendOriginalSheet
  CopyOriginal | false
  LimitMethod | Offset
  Offset.Value | 5 (millimeters part), 0.2 (inches part)
  SideEdgeShapeOption | Automatic
  SurfaceShapeOption | NaturalCurvature

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
BodyOutputOption | Returns or sets the option to control whether the shape is extended as the original sheet, as a new face, or as a new sheet
CopyOriginal | Returns or sets the copy original option determines if the original body is modified or a copy of the original is made
DistanceTolerance | Returns or sets the distance tolerance
LimitMethod | Returns or sets the option to control limit by distance or until selected objects
LimitTools | Returns the limiting tool face or plane to extend to
Offset | Returns the offset distance to extend
ParentFeatureInternal | Returns or sets whether or not the latest timestamped parent feature of this feature should be made internal
PatchSolutionFlag | Returns or sets the patch solution flag
PatchSurfaceFilename | Returns or sets the patch surface filename
SideEdgeShapeOption | Returns or sets the direction by which the edge is extended
SurfaceShapeOption | Returns or sets the method by which the surface is extended which defines the shape
SurroundingPatchSurfaceFilename | Returns or sets the surrounding patch surface filename
Tag | Returns the Tag for this object.
TargetBoundaryEdges | Returns the input edges to extend

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CommitFeature | Commits the feature parameters and creates the feature
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.
GetFeature | Returns the feature currently being edited by this builder.
GetObject | Returns the object currently being edited by this builder.
HideInternalParentFeatureAfterEdit | Re-suppress an internal parent feature (a slave feature) after it has been edited.
ReverseExtensionSide | Option to reverse the extension side of the edge
SetParentFeatureInternal | Set the parent features which would be internal or slaves to the feature being created or commited
ShowInternalParentFeatureForEdit | Unsuppress an internal parent feature (a slave feature) so it can be edited.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
UnsetParentFeatureInternal | Set the internal parent feature of the feature being edited to external
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

ExtendSheetBuilderBodyOutput Enumeration | Creates extension as an existing or a new entity
ExtendSheetBuilderLimit Enumeration | Determines the Limit type for extension
ExtendSheetBuilderSideEdgeShape Enumeration | Determines the path of the extension
ExtendSheetBuilderSurfaceShape Enumeration | Determines the surface type of the extension

# Property Detail

## BodyOutputOption

`ExtendSheetBuilder.``BodyOutputOption`

  Returns or sets the option to control whether the shape is extended as the original sheet, as a new face, or as a new sheet

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

  Getter Method

  Signature `BodyOutputOption`

  Returns: |
  Return type: | `NXOpen.Features.ExtendSheetBuilderBodyOutput`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `BodyOutputOption`

  Parameters: | bodyOutputOption (`NXOpen.Features.ExtendSheetBuilderBodyOutput`) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## CopyOriginal

`ExtendSheetBuilder.``CopyOriginal`

  Returns or sets the copy original option determines if the original body is modified or a copy of the original is made

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

  Getter Method

  Signature `CopyOriginal`

  Returns: |
  Return type: | bool

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `CopyOriginal`

  Parameters: | copyOriginal (bool) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## DistanceTolerance

`ExtendSheetBuilder.``DistanceTolerance`

  Returns or sets the distance tolerance

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

  Getter Method

  Signature `DistanceTolerance`

  Returns: |
  Return type: | float

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `DistanceTolerance`

  Parameters: | tolerance (float) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## LimitMethod

`ExtendSheetBuilder.``LimitMethod`

  Returns or sets the option to control limit by distance or until selected objects

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

  Getter Method

  Signature `LimitMethod`

  Returns: |
  Return type: | `NXOpen.Features.ExtendSheetBuilderLimit`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LimitMethod`

  Parameters: | limitMethod (`NXOpen.Features.ExtendSheetBuilderLimit`) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## LimitTools

`ExtendSheetBuilder.``LimitTools`

  Returns the limiting tool face or plane to extend to

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

  Getter Method

  Signature `LimitTools`

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

  New in version NX9.0.0.

  License requirements: None.

## Offset

`ExtendSheetBuilder.``Offset`

  Returns the offset distance to extend

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

  Getter Method

  Signature `Offset`

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

  New in version NX9.0.0.

  License requirements: None.

## SideEdgeShapeOption

`ExtendSheetBuilder.``SideEdgeShapeOption`

  Returns or sets the direction by which the edge is extended

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

  Getter Method

  Signature `SideEdgeShapeOption`

  Returns: |
  Return type: | `NXOpen.Features.ExtendSheetBuilderSideEdgeShape`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SideEdgeShapeOption`

  Parameters: | sideEdgeShapeOption (`NXOpen.Features.ExtendSheetBuilderSideEdgeShape`) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## SurfaceShapeOption

`ExtendSheetBuilder.``SurfaceShapeOption`

  Returns or sets the method by which the surface is extended which defines the shape

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

  Getter Method

  Signature `SurfaceShapeOption`

  Returns: |
  Return type: | `NXOpen.Features.ExtendSheetBuilderSurfaceShape`

  New in version NX9.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SurfaceShapeOption`

  Parameters: | surfaceShapeOption (`NXOpen.Features.ExtendSheetBuilderSurfaceShape`) –

  New in version NX9.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## TargetBoundaryEdges

`ExtendSheetBuilder.``TargetBoundaryEdges`

  Returns the input edges to extend

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

  Getter Method

  Signature `TargetBoundaryEdges`

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

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## ReverseExtensionSide

`ExtendSheetBuilder.``ReverseExtensionSide`

  Option to reverse the extension side of the edge

  Signature `ReverseExtensionSide()`

  New in version NX11.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”)

## Validate

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