BaseViewBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# BaseViewBuilder Class

class `NXOpen.Drawings.``BaseViewBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Drawings.BaseView` builder

  To create a new instance of this class, use `NXOpen.Drawings.DraftingViewCollection.CreateBaseViewBuilder()`

  Default values.

  Property | Value
  --- | ---
  Placement.AlignmentMethod | Infer
  Placement.AlignmentOption | ToView
  Scale.Denominator | 1.0
  Scale.Numerator | 1.0
  Scale.ScaleType | Ratio
  SecondaryComponents.ObjectType | PrimaryGeometry
  Style.ViewStyleGeneral.AngleSetting.Angle.Value | 0
  Style.ViewStyleGeneral.AngleSetting.Associative | 0
  Style.ViewStyleGeneral.AngleSetting.EvaluationPlane | DrawingSheet
  Style.ViewStyleOrientation.HingeLine.ReverseDirection | false
  Style.ViewStyleOrientation.HingeLine.VectorOption | Inferred
  Style.ViewStyleOrientation.Ovt.AssociativeOrientation | 0

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
HiddenObjects | Returns the list of objects to not show in the view
NonSectionedObjects | Returns the list of objects to not section in the view
Placement | Returns the view placement
Scale | Returns the view scale
SecondaryComponents | Returns the list of secondary objects in the view
SelectModelView | Returns the model view
Style | Returns the view style
Tag | Returns the Tag for this object.

# 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

## HiddenObjects

`BaseViewBuilder.``HiddenObjects`

  Returns the list of objects to not show in the view

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

  Getter Method

  Signature `HiddenObjects`

  Returns: |
  Return type: | `NXOpen.Drawings.HiddenObjectsBuilder`

  New in version NX6.0.0.

  License requirements: None.

## NonSectionedObjects

`BaseViewBuilder.``NonSectionedObjects`

  Returns the list of objects to not section in the view

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

  Getter Method

  Signature `NonSectionedObjects`

  Returns: |
  Return type: | `NXOpen.Drawings.HiddenObjectsBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Placement

`BaseViewBuilder.``Placement`

  Returns the view placement

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

  Getter Method

  Signature `Placement`

  Returns: |
  Return type: | `NXOpen.Drawings.ViewPlacementBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Scale

`BaseViewBuilder.``Scale`

  Returns the view scale

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

  Getter Method

  Signature `Scale`

  Returns: |
  Return type: | `NXOpen.Drawings.ViewScaleBuilder`

  New in version NX6.0.0.

  License requirements: None.

## SecondaryComponents

`BaseViewBuilder.``SecondaryComponents`

  Returns the list of secondary objects in the view

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

  Getter Method

  Signature `SecondaryComponents`

  Returns: |
  Return type: | `NXOpen.Drawings.DraftingComponentSelectionBuilder`

  New in version NX11.0.0.

  License requirements: None.

## SelectModelView

`BaseViewBuilder.``SelectModelView`

  Returns the model view

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

  Getter Method

  Signature `SelectModelView`

  Returns: |
  Return type: | `NXOpen.Drawings.SelectModelViewBuilder`

  New in version NX6.0.0.

  License requirements: None.

## Style

`BaseViewBuilder.``Style`

  Returns the view style

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

  Getter Method

  Signature `Style`

  Returns: |
  Return type: | `NXOpen.Drawings.ViewStyleBuilder`

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

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