ViewStyleBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ViewStyleBuilder Class

class `NXOpen.Drawings.``ViewStyleBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents the View Style Builder (Drawings.

  ViewStyleBuilder) which manages all the style attributes related * to the view including base view, projected view, drawing view, detail view, broken view, section view etc. * To obtain an instance of this class, we need to follow the steps: create a new view, click the view style * button, edit the view style attributes.

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
ProjectedViewOrientation | Returns the projected view orientation builder
SecondaryComponents | Returns the secondary components style builder of the view style builder which represents the secondary geometry tab on the View Style Dialog
Tag | Returns the Tag for this object.
ViewCommonViewLabel | Returns the view common label builder
ViewProjectedArrowSettings | Returns the projected Arrow Settings builder
ViewProjectedViewSettings | Returns the projected View Settings builder
ViewSectionLineStyleBuilder | Returns the view section line builder
ViewStyleBase | Returns the Base style builder of the view style builder which represents the base tab on the View Style Dialog
ViewStyleDetail | Returns the Detail style builder of the view style builder which represents the detail tab on the View Style Dialog
ViewStyleGeneral | Returns the General style builder of the view style builder which represents the general tab on the View Style Dialog
ViewStyleHiddenLines | Returns the Hidden Lines style builder of the view style builder which represents the hidden lines tab on the View Style Dialog
ViewStyleInheritPmi | Returns the Inherit PMI style builder of the view style builder which represents the inherit PMI tab on the View Style Dialog
ViewStyleOrientation | Returns the Orientation style builder of the view style builder which represents the orientation tab on the View Style Dialog
ViewStylePerspective | Returns the Perspective style builder of the view style builder which represents the perspective tab on the View Style Dialog
ViewStyleProjected | Returns the projected style builder of the view style builder which represents the projected tab on the View Style Dialog
ViewStyleSection | Returns the Section style builder of the view style builder which represents the section tab on the View Style Dialog
ViewStyleSectionConstraints | Returns the Section Constraints style builder of the view style builder which represents the section constraints tab on the View Style Dialog
ViewStyleShading | Returns the Shading style builder of the view style builder which represents the shading tab on the View Style Dialog
ViewStyleShipDraftingViewLinesList | Returns the Ship Drafting View lines builder of the view style builder which represents the ship drafting view lines on the View Style Dialog
ViewStyleSingleLineList | Returns the Ship building lines style builder of the view style builder which represents the ship building lines tab on the View Style Dialog
ViewStyleSmoothEdges | Returns the Smooth Edges style builder of the view style builder which represents the smooth edges tab on the View Style Dialog
ViewStyleThreads | Returns the Threads style builder of the view style builder which represents the threads tab on the View Style Dialog
ViewStyleTraceLines | Returns the Trace lines style builder of the view style builder which represents the trace lines tab on the View Style Dialog
ViewStyleVirtualIntersections | Returns the Virtual intersections style builder of the view style builder which represents the virtual intersections tab on the View Style Dialog
ViewStyleVisibleLines | Returns the Visible lines style builder of the view style builder which represents the visible lines tab on the View Style Dialog

# Methods

Method | Description
--- | ---
FindShipDraftingViewLinesBuilderByName | Gets the `NXOpen.Drawings.ShipDraftingViewLinesBuilder` with the given FeatureName and FeatureSubName
GetAllViewStyleFPCallouts | Retrieves all the Callouts on the Flat Pattern Tab on the View Style Dialog
GetAllViewStyleFPCurves | Retrieves all the Curves on the Flat Pattern Tab on the View Style Dialog
GetViewStyleFPCallout | Retrieves a specified Callout on the Flat Pattern Tab on the View Style Dialog
GetViewStyleFPCalloutConfig | Retrieves the callout configuration on the Flat Pattern Tab on the View Style Dialog
GetViewStyleFPCurve | Retrieves a specified Curve on the Flat Pattern Tab on the View Style Dialog
InheritSettingsFromCustomerDefault | Inherit Settings From Customer Default
InheritSettingsFromPreferences | Inherit Settings From Preference
InheritSettingsFromSelectedObjects | Inherit Settings From Selected Objects
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Property Detail

## ProjectedViewOrientation

`ViewStyleBuilder.``ProjectedViewOrientation`

  Returns the projected view orientation builder

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

  Getter Method

  Signature `ProjectedViewOrientation`

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

  New in version NX9.0.0.

  License requirements: None.

## SecondaryComponents

`ViewStyleBuilder.``SecondaryComponents`

  Returns the secondary components style builder of the view style builder which represents the secondary geometry tab on the View Style Dialog

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

  Getter Method

  Signature `SecondaryComponents`

  Returns: | Returns the Secondary Components sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleSecondaryComponentsBuilder`

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewCommonViewLabel

`ViewStyleBuilder.``ViewCommonViewLabel`

  Returns the view common label builder

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

  Getter Method

  Signature `ViewCommonViewLabel`

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

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewProjectedArrowSettings

`ViewStyleBuilder.``ViewProjectedArrowSettings`

  Returns the projected Arrow Settings builder

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

  Getter Method

  Signature `ViewProjectedArrowSettings`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewProjectedViewSettings

`ViewStyleBuilder.``ViewProjectedViewSettings`

  Returns the projected View Settings builder

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

  Getter Method

  Signature `ViewProjectedViewSettings`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewSectionLineStyleBuilder

`ViewStyleBuilder.``ViewSectionLineStyleBuilder`

  Returns the view section line builder

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

  Getter Method

  Signature `ViewSectionLineStyleBuilder`

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

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleBase

`ViewStyleBuilder.``ViewStyleBase`

  Returns the Base style builder of the view style builder which represents the base tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleBase`

  Returns: | Returns the Base sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleBaseBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleDetail

`ViewStyleBuilder.``ViewStyleDetail`

  Returns the Detail style builder of the view style builder which represents the detail tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleDetail`

  Returns: | Returns the Detail sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleDetailBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleGeneral

`ViewStyleBuilder.``ViewStyleGeneral`

  Returns the General style builder of the view style builder which represents the general tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleGeneral`

  Returns: | Returns the General sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleGeneralBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleHiddenLines

`ViewStyleBuilder.``ViewStyleHiddenLines`

  Returns the Hidden Lines style builder of the view style builder which represents the hidden lines tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleHiddenLines`

  Returns: | Returns the Hidden Lines sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleHiddenLinesBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleInheritPmi

`ViewStyleBuilder.``ViewStyleInheritPmi`

  Returns the Inherit PMI style builder of the view style builder which represents the inherit PMI tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleInheritPmi`

  Returns: | Returns the Inherit Pmi sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleInheritPmiBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleOrientation

`ViewStyleBuilder.``ViewStyleOrientation`

  Returns the Orientation style builder of the view style builder which represents the orientation tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleOrientation`

  Returns: | Returns the Orientation sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleOrientationBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStylePerspective

`ViewStyleBuilder.``ViewStylePerspective`

  Returns the Perspective style builder of the view style builder which represents the perspective tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStylePerspective`

  Returns: | Returns the Perspective sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStylePerspectiveBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleProjected

`ViewStyleBuilder.``ViewStyleProjected`

  Returns the projected style builder of the view style builder which represents the projected tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleProjected`

  Returns: | Returns the Projected sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleProjectedBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleSection

`ViewStyleBuilder.``ViewStyleSection`

  Returns the Section style builder of the view style builder which represents the section tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleSection`

  Returns: | Returns the Section sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleSectionBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleSectionConstraints

`ViewStyleBuilder.``ViewStyleSectionConstraints`

  Returns the Section Constraints style builder of the view style builder which represents the section constraints tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleSectionConstraints`

  Returns: | Returns the Section Constraints sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleSectionConstraintsBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleShading

`ViewStyleBuilder.``ViewStyleShading`

  Returns the Shading style builder of the view style builder which represents the shading tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleShading`

  Returns: | Returns the Shading sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleShadingBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleShipDraftingViewLinesList

`ViewStyleBuilder.``ViewStyleShipDraftingViewLinesList`

  Returns the Ship Drafting View lines builder of the view style builder which represents the ship drafting view lines on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleShipDraftingViewLinesList`

  Returns: | Returns the Ship Drafting View Lines sub-builders on View Style
  Return type: | `NXOpen.Drawings.ShipDraftingViewLinesBuilderList`

  New in version NX10.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## ViewStyleSingleLineList

`ViewStyleBuilder.``ViewStyleSingleLineList`

  Returns the Ship building lines style builder of the view style builder which represents the ship building lines tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleSingleLineList`

  Returns: | Returns the Shipbuilding Lines sub-builders on View Style
  Return type: | `NXOpen.Drawings.ViewStyleShipbuildingLinesBuilderList`

  New in version NX8.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleSmoothEdges

`ViewStyleBuilder.``ViewStyleSmoothEdges`

  Returns the Smooth Edges style builder of the view style builder which represents the smooth edges tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleSmoothEdges`

  Returns: | Returns the Smooth Edges sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleSmoothEdgesBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleThreads

`ViewStyleBuilder.``ViewStyleThreads`

  Returns the Threads style builder of the view style builder which represents the threads tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleThreads`

  Returns: | Returns the Threads sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleThreadsBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleTraceLines

`ViewStyleBuilder.``ViewStyleTraceLines`

  Returns the Trace lines style builder of the view style builder which represents the trace lines tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleTraceLines`

  Returns: | Returns the Trace Lines sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleTraceLinesBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleVirtualIntersections

`ViewStyleBuilder.``ViewStyleVirtualIntersections`

  Returns the Virtual intersections style builder of the view style builder which represents the virtual intersections tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleVirtualIntersections`

  Returns: | Returns the Intersections sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleVirtualIntersectionsBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## ViewStyleVisibleLines

`ViewStyleBuilder.``ViewStyleVisibleLines`

  Returns the Visible lines style builder of the view style builder which represents the visible lines tab on the View Style Dialog

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

  Getter Method

  Signature `ViewStyleVisibleLines`

  Returns: | Returns the Visible Lines sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleVisibleLinesBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

# Method Detail

## FindShipDraftingViewLinesBuilderByName

`ViewStyleBuilder.``FindShipDraftingViewLinesBuilderByName`

  Gets the `NXOpen.Drawings.ShipDraftingViewLinesBuilder` with the given FeatureName and FeatureSubName

  Signature `FindShipDraftingViewLinesBuilderByName(featureName, featureSubName)`

  Parameters:

  - featureName (str) –
  - featureSubName (str) –

  Returns: | Returns the Ship Drafting View Lines sub-builders with the given FeatureName and FeatureSubName
  Return type: | `NXOpen.Drawings.ShipDraftingViewLinesBuilder`

  New in version NX11.0.0.

  License requirements: nx_ship_drafting (“Ship Drafting”)

## GetAllViewStyleFPCallouts

`ViewStyleBuilder.``GetAllViewStyleFPCallouts`

  Retrieves all the Callouts on the Flat Pattern Tab on the View Style Dialog

  Signature `GetAllViewStyleFPCallouts()`

  Returns: | Returns all the Flat Pattern Callout sub-builders on View Style
  Return type: | list of `NXOpen.Drawings.ViewStyleFPCalloutsBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## GetAllViewStyleFPCurves

`ViewStyleBuilder.``GetAllViewStyleFPCurves`

  Retrieves all the Curves on the Flat Pattern Tab on the View Style Dialog

  Signature `GetAllViewStyleFPCurves()`

  Returns: | Returns all the Flat Pattern Curve sub-builders on View Style
  Return type: | list of `NXOpen.Drawings.ViewStyleFPCurvesBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## GetViewStyleFPCallout

`ViewStyleBuilder.``GetViewStyleFPCallout`

  Retrieves a specified Callout on the Flat Pattern Tab on the View Style Dialog

  Signature `GetViewStyleFPCallout(type)`

  Parameters: | type (str) – Indicates which flat pattern callout
  Returns: | Returns the particular Flat Pattern Callout sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleFPCalloutsBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## GetViewStyleFPCalloutConfig

`ViewStyleBuilder.``GetViewStyleFPCalloutConfig`

  Retrieves the callout configuration on the Flat Pattern Tab on the View Style Dialog

  Signature `GetViewStyleFPCalloutConfig()`

  Returns: | Returns the Flat Pattern Callout Config sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleFPCalloutConfigBuilder`

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## GetViewStyleFPCurve

`ViewStyleBuilder.``GetViewStyleFPCurve`

  Retrieves a specified Curve on the Flat Pattern Tab on the View Style Dialog

  Signature `GetViewStyleFPCurve(type)`

  Parameters: | type (`NXOpen.SheetMetal.FlatPatternSettingsFlatPatternObjectType`) – Indicates which flat pattern curve
  Returns: | Returns the particular Flat Pattern Curve sub-builder on View Style
  Return type: | `NXOpen.Drawings.ViewStyleFPCurvesBuilder`

  New in version NX6.0.0.

  License requirements: drafting (“DRAFTING”)

## InheritSettingsFromCustomerDefault

`ViewStyleBuilder.``InheritSettingsFromCustomerDefault`

  Inherit Settings From Customer Default

  Signature `InheritSettingsFromCustomerDefault()`

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## InheritSettingsFromPreferences

`ViewStyleBuilder.``InheritSettingsFromPreferences`

  Inherit Settings From Preference

  Signature `InheritSettingsFromPreferences()`

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## InheritSettingsFromSelectedObjects

`ViewStyleBuilder.``InheritSettingsFromSelectedObjects`

  Inherit Settings From Selected Objects

  Signature `InheritSettingsFromSelectedObjects(selectedObject)`

  Parameters: | selectedObject (`NXOpen.NXObject`) – The selected annotation or table or view instance object. None is not allowed.

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## Validate

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