PreferencesBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PreferencesBuilder Class

class `NXOpen.Drafting.``PreferencesBuilder`

  Bases: `NXOpen.Builder`

  Represents a `NXOpen.Drafting.PreferencesBuilder` builder

  To create a new instance of this class, use `NXOpen.Drafting.SettingsManager.CreatePreferencesBuilder()`

  Default values.

  Property | Value
  --- | ---
  ViewStyle.ViewStyleGeneral.AngleSetting.Angle.Value | 0
  ViewStyle.ViewStyleGeneral.AngleSetting.Associative | 0
  ViewStyle.ViewStyleGeneral.AngleSetting.EvaluationPlane | DrawingSheet
  ViewStyle.ViewStyleGeneral.Scale.Denominator | 1.0
  ViewStyle.ViewStyleGeneral.Scale.Numerator | 1.0
  ViewStyle.ViewStyleGeneral.Scale.ScaleType | Ratio
  ViewStyle.ViewStyleOrientation.HingeLine.ReverseDirection | false
  ViewStyle.ViewStyleOrientation.HingeLine.VectorOption | Inferred
  ViewStyle.ViewStyleOrientation.Ovt.AssociativeOrientation | 0

  New in version NX9.0.0.

# Properties

Property | Description
--- | ---
AnnotationStyle | Returns the annotation style builder
AssemblyCreationSettingsBuilder | Returns the assembly creation from 2d component builder
AutomationBooklet | Returns the AutomationBookletBuilder builder
AutomationRule | Returns the drafting automation rule builder
AutomationTemplateRegion | Returns the AutomationTemplateRegion builder
BendTable | Returns the Bend table settings builder
BorderAndZoneStyle | Returns the border and zone style builder
CommonWorkflow | Returns the common workflow builder
Component2dSettings | Returns the 2d component settings block builder, this builder stores the settings of the 2d component
CreateComponentFrom3DSettingsBuilder | Returns the create component from 3d builder
DimensionWorkflow | Returns the Dimension Workflow builder
DrawingFormatTitle | Returns the drawing format title block builder
DrawingFormatsheet | Returns the drawing format sheet builder
FramebarGeneral | Returns the framebar general builder
GeneralLayoutPreferencesBuilder | Returns the general layout preferences builder
HoleTableContent | Returns the Hole table settings content builder
HoleTableFormat | Returns the Hole table settings format builder
HoleTableHoleFilters | Returns the Hole table settings hole filters builder
HoleTableLabel | Returns the Hole table settings label builder
HoleTableWorkflow | Returns the Hole table settings workflow builder
PartsList | Returns the parts list style builder
RetainedAnnotations | Returns the General Retained Annotations builder
SymbolWorkflow | Returns the SymbolWorkflow builder
TableCellStyle | Returns the table cell style builder
TableSection | Returns the table section style builder
TabularNoteStyle | Returns the tabular note style builder
Tag | Returns the Tag for this object.
TrackDrawingChangesGeneral | Returns the track drawing changes general settings builder
TrackDrawingChangesReportFilter | Returns the track drawing changes report filter builder
ViewBreak | Returns the view break builder
ViewCommonViewLabel | Returns the view Common View label builder
ViewDetailLabel | Returns the view detail label builder
ViewLabel | Returns the view label builder
ViewProjectedLabel | Returns the view projected label builder
ViewSectionLabel | Returns the view section label builder
ViewSectionLine | Returns the Section Line builder
ViewStyle | Returns the view style builder
ViewWorkflow | Returns the view workflow builder
VisualDrawingCompare | Returns the visual drawing compare settings builder
Workflow | Returns the general workflow builder

# 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.
InheritSettingsFromCustomerDefault | Inherit Settings From Customer Default
InheritSettingsFromPreferences | Inherit Settings From Preference
InheritSettingsFromSelectedObjects | Inherit Settings From Selected Objects
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

## AnnotationStyle

`PreferencesBuilder.``AnnotationStyle`

  Returns the annotation style builder

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

  Getter Method

  Signature `AnnotationStyle`

  Returns: |
  Return type: | `NXOpen.Annotations.StyleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## AssemblyCreationSettingsBuilder

`PreferencesBuilder.``AssemblyCreationSettingsBuilder`

  Returns the assembly creation from 2d component builder

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

  Getter Method

  Signature `AssemblyCreationSettingsBuilder`

  Returns: |
  Return type: | `NXOpen.Layout2d.AssemblyCreationSettingsBuilder`

  New in version NX11.0.1.

  License requirements: None.

## AutomationBooklet

`PreferencesBuilder.``AutomationBooklet`

  Returns the AutomationBookletBuilder builder

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

  Getter Method

  Signature `AutomationBooklet`

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

  New in version NX9.0.0.

  License requirements: None.

## AutomationRule

`PreferencesBuilder.``AutomationRule`

  Returns the drafting automation rule builder

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

  Getter Method

  Signature `AutomationRule`

  Returns: |
  Return type: | `NXOpen.Drafting.AutomationRuleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## AutomationTemplateRegion

`PreferencesBuilder.``AutomationTemplateRegion`

  Returns the AutomationTemplateRegion builder

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

  Getter Method

  Signature `AutomationTemplateRegion`

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

  New in version NX9.0.0.

  License requirements: None.

## BendTable

`PreferencesBuilder.``BendTable`

  Returns the Bend table settings builder

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

  Getter Method

  Signature `BendTable`

  Returns: |
  Return type: | `NXOpen.Annotations.BendTableSettingsBuilder`

  New in version NX9.0.0.

  License requirements: None.

## BorderAndZoneStyle

`PreferencesBuilder.``BorderAndZoneStyle`

  Returns the border and zone style builder

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

  Getter Method

  Signature `BorderAndZoneStyle`

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

  New in version NX10.0.0.

  License requirements: None.

## CommonWorkflow

`PreferencesBuilder.``CommonWorkflow`

  Returns the common workflow builder

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

  Getter Method

  Signature `CommonWorkflow`

  Returns: |
  Return type: | `NXOpen.Annotations.CommonWorkflowBuilder`

  New in version NX9.0.0.

  License requirements: None.

## Component2dSettings

`PreferencesBuilder.``Component2dSettings`

  Returns the 2d component settings block builder, this builder stores the settings of the 2d component

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

  Getter Method

  Signature `Component2dSettings`

  Returns: |
  Return type: | `NXOpen.Layout2d.ComponentSettingsBlockBuilder`

  New in version NX9.0.0.

  License requirements: None.

## CreateComponentFrom3DSettingsBuilder

`PreferencesBuilder.``CreateComponentFrom3DSettingsBuilder`

  Returns the create component from 3d builder

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

  Getter Method

  Signature `CreateComponentFrom3DSettingsBuilder`

  Returns: |
  Return type: | `NXOpen.Layout2d.CreateComponentFrom3DSettingsBuilder`

  New in version NX11.0.1.

  License requirements: None.

## DimensionWorkflow

`PreferencesBuilder.``DimensionWorkflow`

  Returns the Dimension Workflow builder

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

  Getter Method

  Signature `DimensionWorkflow`

  Returns: |
  Return type: | `NXOpen.Annotations.DimensionWorkflowBuilder`

  New in version NX10.0.0.

  License requirements: None.

## DrawingFormatTitle

`PreferencesBuilder.``DrawingFormatTitle`

  Returns the drawing format title block builder

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

  Getter Method

  Signature `DrawingFormatTitle`

  Returns: |
  Return type: | `NXOpen.Annotations.DrawingFormatTitleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## DrawingFormatsheet

`PreferencesBuilder.``DrawingFormatsheet`

  Returns the drawing format sheet builder

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

  Getter Method

  Signature `DrawingFormatsheet`

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

  New in version NX9.0.0.

  License requirements: None.

## FramebarGeneral

`PreferencesBuilder.``FramebarGeneral`

  Returns the framebar general builder

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

  Getter Method

  Signature `FramebarGeneral`

  Returns: |
  Return type: | `NXOpen.Annotations.ShipDraftingFramebarGeneralBuilder`

  New in version NX9.0.0.

  License requirements: None.

## GeneralLayoutPreferencesBuilder

`PreferencesBuilder.``GeneralLayoutPreferencesBuilder`

  Returns the general layout preferences builder

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

  Getter Method

  Signature `GeneralLayoutPreferencesBuilder`

  Returns: |
  Return type: | `NXOpen.Layout2d.GeneralPreferencesBuilder`

  New in version NX12.0.0.

  License requirements: None.

## HoleTableContent

`PreferencesBuilder.``HoleTableContent`

  Returns the Hole table settings content builder

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

  Getter Method

  Signature `HoleTableContent`

  Returns: |
  Return type: | `NXOpen.Annotations.HoleTableSettingsContentBuilder`

  New in version NX9.0.0.

  License requirements: None.

## HoleTableFormat

`PreferencesBuilder.``HoleTableFormat`

  Returns the Hole table settings format builder

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

  Getter Method

  Signature `HoleTableFormat`

  Returns: |
  Return type: | `NXOpen.Annotations.HoleTableSettingsFormatBuilder`

  New in version NX9.0.0.

  License requirements: None.

## HoleTableHoleFilters

`PreferencesBuilder.``HoleTableHoleFilters`

  Returns the Hole table settings hole filters builder

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

  Getter Method

  Signature `HoleTableHoleFilters`

  Returns: |
  Return type: | `NXOpen.Annotations.HoleTableSettingsHoleFiltersBuilder`

  New in version NX9.0.0.

  License requirements: None.

## HoleTableLabel

`PreferencesBuilder.``HoleTableLabel`

  Returns the Hole table settings label builder

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

  Getter Method

  Signature `HoleTableLabel`

  Returns: |
  Return type: | `NXOpen.Annotations.HoleTableSettingsLabelBuilder`

  New in version NX9.0.0.

  License requirements: None.

## HoleTableWorkflow

`PreferencesBuilder.``HoleTableWorkflow`

  Returns the Hole table settings workflow builder

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

  Getter Method

  Signature `HoleTableWorkflow`

  Returns: |
  Return type: | `NXOpen.Annotations.HoleTableSettingsWorkflowBuilder`

  New in version NX9.0.0.

  License requirements: None.

## PartsList

`PreferencesBuilder.``PartsList`

  Returns the parts list style builder

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

  Getter Method

  Signature `PartsList`

  Returns: |
  Return type: | `NXOpen.Annotations.PartsListBuilder`

  New in version NX9.0.0.

  License requirements: None.

## RetainedAnnotations

`PreferencesBuilder.``RetainedAnnotations`

  Returns the General Retained Annotations builder

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

  Getter Method

  Signature `RetainedAnnotations`

  Returns: |
  Return type: | `NXOpen.Annotations.RetainedAnnotationsBuilder`

  New in version NX9.0.0.

  License requirements: None.

## SymbolWorkflow

`PreferencesBuilder.``SymbolWorkflow`

  Returns the SymbolWorkflow builder

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

  Getter Method

  Signature `SymbolWorkflow`

  Returns: |
  Return type: | `NXOpen.Annotations.SymbolWorkflowBuilder`

  New in version NX9.0.0.

  License requirements: None.

## TableCellStyle

`PreferencesBuilder.``TableCellStyle`

  Returns the table cell style builder

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

  Getter Method

  Signature `TableCellStyle`

  Returns: |
  Return type: | `NXOpen.Annotations.TableCellStyleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## TableSection

`PreferencesBuilder.``TableSection`

  Returns the table section style builder

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

  Getter Method

  Signature `TableSection`

  Returns: |
  Return type: | `NXOpen.Annotations.TableSectionStyleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## TabularNoteStyle

`PreferencesBuilder.``TabularNoteStyle`

  Returns the tabular note style builder

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

  Getter Method

  Signature `TabularNoteStyle`

  Returns: |
  Return type: | `NXOpen.Annotations.TabularNoteStyleBuilder`

  New in version NX9.0.0.

  License requirements: None.

## TrackDrawingChangesGeneral

`PreferencesBuilder.``TrackDrawingChangesGeneral`

  Returns the track drawing changes general settings builder

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

  Getter Method

  Signature `TrackDrawingChangesGeneral`

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

  New in version NX11.0.0.

  License requirements: None.

## TrackDrawingChangesReportFilter

`PreferencesBuilder.``TrackDrawingChangesReportFilter`

  Returns the track drawing changes report filter builder

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

  Getter Method

  Signature `TrackDrawingChangesReportFilter`

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

  New in version NX11.0.0.

  License requirements: None.

## ViewBreak

`PreferencesBuilder.``ViewBreak`

  Returns the view break builder

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

  Getter Method

  Signature `ViewBreak`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewCommonViewLabel

`PreferencesBuilder.``ViewCommonViewLabel`

  Returns the view Common View label builder

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

  Getter Method

  Signature `ViewCommonViewLabel`

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

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Use `NXOpen.Drawings.ViewStyleBuilder.ViewCommonViewLabel()` instead.

  License requirements: None.

## ViewDetailLabel

`PreferencesBuilder.``ViewDetailLabel`

  Returns the view detail label builder

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

  Getter Method

  Signature `ViewDetailLabel`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewLabel

`PreferencesBuilder.``ViewLabel`

  Returns the view label builder

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

  Getter Method

  Signature `ViewLabel`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewProjectedLabel

`PreferencesBuilder.``ViewProjectedLabel`

  Returns the view projected label builder

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

  Getter Method

  Signature `ViewProjectedLabel`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewSectionLabel

`PreferencesBuilder.``ViewSectionLabel`

  Returns the view section label builder

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

  Getter Method

  Signature `ViewSectionLabel`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewSectionLine

`PreferencesBuilder.``ViewSectionLine`

  Returns the Section Line builder

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

  Getter Method

  Signature `ViewSectionLine`

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

  New in version NX9.0.0.

  Deprecated since version NX10.0.0: Use `NXOpen.Drawings.ViewStyleBuilder.ViewSectionLineStyleBuilder()` instead.

  License requirements: None.

## ViewStyle

`PreferencesBuilder.``ViewStyle`

  Returns the view style builder

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

  Getter Method

  Signature `ViewStyle`

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

  New in version NX9.0.0.

  License requirements: None.

## ViewWorkflow

`PreferencesBuilder.``ViewWorkflow`

  Returns the view workflow builder

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

  Getter Method

  Signature `ViewWorkflow`

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

  New in version NX9.0.0.

  License requirements: None.

## VisualDrawingCompare

`PreferencesBuilder.``VisualDrawingCompare`

  Returns the visual drawing compare settings builder

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

  Getter Method

  Signature `VisualDrawingCompare`

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

  New in version NX11.0.0.

  License requirements: None.

## Workflow

`PreferencesBuilder.``Workflow`

  Returns the general workflow builder

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

  Getter Method

  Signature `Workflow`

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

  New in version NX9.0.0.

  License requirements: None.

# Method Detail

## InheritSettingsFromCustomerDefault

`PreferencesBuilder.``InheritSettingsFromCustomerDefault`

  Inherit Settings From Customer Default

  Signature `InheritSettingsFromCustomerDefault()`

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## InheritSettingsFromPreferences

`PreferencesBuilder.``InheritSettingsFromPreferences`

  Inherit Settings From Preference

  Signature `InheritSettingsFromPreferences()`

  New in version NX9.0.0.

  License requirements: drafting (“DRAFTING”)

## InheritSettingsFromSelectedObjects

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

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