ImportEplanPageMacroBuilder Class

class NXOpen.AME.ImportEplanPageMacroBuilder

Bases: NXOpen.Builder

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

New in version NX11.0.0.

Properties

Property Description
Description Returns or sets the description
MacroFile Returns or sets the eplan page macro template file
MacroType Returns or sets the macro type
Name Returns or sets the name
SelectedAspectNode Returns the selected engineering object
Tag Returns the Tag for this object.

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.
ImportMacro Imports an eplan page macro
ReadMacroInformation Read device properties
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

Description

ImportEplanPageMacroBuilder.Description

Returns or sets the 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:description (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

MacroFile

ImportEplanPageMacroBuilder.MacroFile

Returns or sets the eplan page macro template file

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

Getter Method

Signature MacroFile

Returns:
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature MacroFile

Parameters:macroFile (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

MacroType

ImportEplanPageMacroBuilder.MacroType

Returns or sets the macro type

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

Getter Method

Signature MacroType

Returns:
Return type:int

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature MacroType

Parameters:macroType (int) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Name

ImportEplanPageMacroBuilder.Name

Returns or sets the name

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

Getter Method

Signature Name

Returns:
Return type:str

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

SelectedAspectNode

ImportEplanPageMacroBuilder.SelectedAspectNode

Returns the selected engineering object

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

Getter Method

Signature SelectedAspectNode

Returns:
Return type:NXOpen.AME.SelectAMEBaseNode

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

ImportMacro

ImportEplanPageMacroBuilder.ImportMacro

Imports an eplan page macro

Signature ImportMacro(segmentsOfResponseMessage)

Parameters:segmentsOfResponseMessage (list of str) –

New in version NX11.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

ReadMacroInformation

ImportEplanPageMacroBuilder.ReadMacroInformation

Read device properties

Signature ReadMacroInformation()

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Validate

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