PageBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PageBuilder Class

class `NXOpen.AME.``PageBuilder`

  Bases: `NXOpen.AME.EngineeringObjectBaseBuilder`

  Represents a Page creation class Builder

  To create a new instance of this class, use `NXOpen.AME.AMEManager.CreatePageBuilder()`

  Default values.

  Property | Value
  --- | ---
  PageName | 1
  Type | MultiLineSchematics

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
Aspects | Returns the Page aspect details
Description | Returns or sets the Page description
PageAttributeHolder | Returns the attribute holder
PageName | Returns or sets the Page name
Tag | Returns the Tag for this object.
Type | Returns or sets the Page type

# 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.
GetCommittedAspects | Get the commited Aspect
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetNewObjects | Get the commited Aspect
GetObject | Returns the object currently being edited by this builder.
SetClassificationCode | Set user Classification Code.
SetDefaultClassificationCode | Set default Classification Code.
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

PageBuilderTypes Enumeration | Represents the type of page

# Property Detail

## Aspects

`PageBuilder.``Aspects`

  Returns the Page aspect details

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

  Getter Method

  Signature `Aspects`

  Returns: |
  Return type: | `NXOpen.AME.AspectDetailsBuilder`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Description

`PageBuilder.``Description`

  Returns or sets the Page description

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

  Getter Method

  Signature `Description`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `Description`

  Parameters: | pageDescription (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## PageAttributeHolder

`PageBuilder.``PageAttributeHolder`

  Returns the attribute holder

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

  Getter Method

  Signature `PageAttributeHolder`

  Returns: |
  Return type: | `NXOpen.AME.PageAttributeHolder`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## PageName

`PageBuilder.``PageName`

  Returns or sets the Page name

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

  Getter Method

  Signature `PageName`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `PageName`

  Parameters: | pageName (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Type

`PageBuilder.``Type`

  Returns or sets the Page type

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

  Getter Method

  Signature `Type`

  Returns: |
  Return type: | `NXOpen.AME.PageBuilderTypes`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

  Setter Method

  Signature `Type`

  Parameters: | type (`NXOpen.AME.PageBuilderTypes`) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

# Method Detail

## SetClassificationCode

`PageBuilder.``SetClassificationCode`

  Set user Classification Code.

  Signature `SetClassificationCode(dccString)`

  Parameters: | dccString (str) –

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## SetDefaultClassificationCode

`PageBuilder.``SetDefaultClassificationCode`

  Set default Classification Code.

  Signature `SetDefaultClassificationCode()`

  New in version NX11.0.0.

  License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

## Validate

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