ConvertDraftingContentsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# ConvertDraftingContentsBuilder Class

class `NXOpen.Drawings.``ConvertDraftingContentsBuilder`

  Bases: `NXOpen.Builder`

  Represents a `Drawings.ConvertDraftingContentsBuilder`.

  This class queries and sets settings specific to drafting data which will get converted to PMI.

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

  Default values.

  Property | Value
  --- | ---
  SelectionType | Drawing
  UseContextAssembly | 0

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ConfigurationFile | Returns or sets the configuration file
OpenConvertedPmiDestinationPart | Returns or sets the option to open converted pmi destination part
SelectDraftingSheet | Returns the select drafting sheet block.
SelectDraftingView | Returns the select drafting view block
SelectObjectsToConvert | Returns the select objects to convert
SelectionType | Returns or sets the selection type
SettingsBuilder | Returns the settings
Tag | Returns the Tag for this object.
UseContextAssembly | Returns or sets the use context assembly

# 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.
SetContextAssembly | Context assembly part file path
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.

# Enumerations

ConvertDraftingContentsBuilderSelectConversionEntityType Enumeration | enum is used to list out different entity that can be use for conversion

# Property Detail

## ConfigurationFile

`ConvertDraftingContentsBuilder.``ConfigurationFile`

  Returns or sets the configuration file

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

  Getter Method

  Signature `ConfigurationFile`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ConfigurationFile`

  Parameters: | filename (str) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## OpenConvertedPmiDestinationPart

`ConvertDraftingContentsBuilder.``OpenConvertedPmiDestinationPart`

  Returns or sets the option to open converted pmi destination part

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

  Getter Method

  Signature `OpenConvertedPmiDestinationPart`

  Returns: |
  Return type: | bool

  New in version NX12.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OpenConvertedPmiDestinationPart`

  Parameters: | openConvertedPmiDestinationPart (bool) –

  New in version NX12.0.0.

  License requirements: drafting (“DRAFTING”)

## SelectDraftingSheet

`ConvertDraftingContentsBuilder.``SelectDraftingSheet`

  Returns the select drafting sheet block.

  Expect selection object of type DraftingSheet, validation is done at builder level

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

  Getter Method

  Signature `SelectDraftingSheet`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectDraftingView

`ConvertDraftingContentsBuilder.``SelectDraftingView`

  Returns the select drafting view block

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

  Getter Method

  Signature `SelectDraftingView`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectObjectsToConvert

`ConvertDraftingContentsBuilder.``SelectObjectsToConvert`

  Returns the select objects to convert

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

  Getter Method

  Signature `SelectObjectsToConvert`

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

  New in version NX11.0.0.

  License requirements: None.

## SelectionType

`ConvertDraftingContentsBuilder.``SelectionType`

  Returns or sets the selection type

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

  Getter Method

  Signature `SelectionType`

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

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SelectionType`

  Parameters: | selectionType (`NXOpen.Drawings.ConvertDraftingContentsBuilderSelectConversionEntityType`) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## SettingsBuilder

`ConvertDraftingContentsBuilder.``SettingsBuilder`

  Returns the settings

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

  Getter Method

  Signature `SettingsBuilder`

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

  New in version NX11.0.0.

  License requirements: None.

## UseContextAssembly

`ConvertDraftingContentsBuilder.``UseContextAssembly`

  Returns or sets the use context assembly

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

  Getter Method

  Signature `UseContextAssembly`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `UseContextAssembly`

  Parameters: | useContextAssembly (bool) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

# Method Detail

## SetContextAssembly

`ConvertDraftingContentsBuilder.``SetContextAssembly`

  Context assembly part file path

  Signature `SetContextAssembly(contextAssembly)`

  Parameters: | contextAssembly (str) –

  New in version NX11.0.0.

  License requirements: drafting (“DRAFTING”)

## Validate

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