PageNamingBuilder Class

class NXOpen.AME.PageNamingBuilder

Bases: NXOpen.Builder

Class to define Page naming schema

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

Default values.

Property Value
DisplayDigits 1
Increment 1
Start 1

New in version NX11.0.0.

Properties

Property Description
DisplayDigits Returns or sets the Display Digits
Increment Returns or sets the increment
Start Returns or sets the start name
Tag Returns the Tag for this object.
TargetSelection Returns the Target node selection

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

DisplayDigits

PageNamingBuilder.DisplayDigits

Returns or sets the Display Digits

-------------------------------------

Getter Method

Signature DisplayDigits

Returns:
Return type:int

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature DisplayDigits

Parameters:displayDigits (int) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Increment

PageNamingBuilder.Increment

Returns or sets the increment

-------------------------------------

Getter Method

Signature Increment

Returns:
Return type:int

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature Increment

Parameters:increment (int) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Start

PageNamingBuilder.Start

Returns or sets the start name

-------------------------------------

Getter Method

Signature Start

Returns:
Return type:int

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

-------------------------------------

Setter Method

Signature Start

Parameters:start (int) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

TargetSelection

PageNamingBuilder.TargetSelection

Returns the Target node selection

-------------------------------------

Getter Method

Signature TargetSelection

Returns:
Return type:NXOpen.AME.SelectAMEBaseNode

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

Validate

PageNamingBuilder.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.