FormSheetBuilder Class

class NXOpen.AME.FormSheetBuilder

Bases: NXOpen.Builder

JA class for the Form Sheet dialog

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

Default values.

Property Value
FormSheetSizeOption Standard
FormSheetStandardMetricSize A3landscape
Height 297
Length 420

New in version NX12.0.0.

Properties

Property Description
BasicProperties Returns the name and description
FormSheetSizeOption Returns or sets the size option type of type NXOpen.AME.FormSheetBuilderSizeOption
FormSheetStandardMetricSize Returns or sets the standard metric size of type NXOpen.AME.FormSheetBuilderStandardMetricSize
Height Returns or sets the height
Length Returns or sets the length
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.
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

FormSheetBuilderSizeOption Enumeration Represents form sheet size option
FormSheetBuilderStandardMetricSize Enumeration Represents standard metric sizes for form sheet

Property Detail

BasicProperties

FormSheetBuilder.BasicProperties

Returns the name and description

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

Getter Method

Signature BasicProperties

Returns:
Return type:NXOpen.AME.BasicPropertiesBuilder

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

FormSheetSizeOption

FormSheetBuilder.FormSheetSizeOption

Returns or sets the size option type of type NXOpen.AME.FormSheetBuilderSizeOption

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

Getter Method

Signature FormSheetSizeOption

Returns:
Return type:NXOpen.AME.FormSheetBuilderSizeOption

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature FormSheetSizeOption

Parameters:sizeOption (NXOpen.AME.FormSheetBuilderSizeOption) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

FormSheetStandardMetricSize

FormSheetBuilder.FormSheetStandardMetricSize

Returns or sets the standard metric size of type NXOpen.AME.FormSheetBuilderStandardMetricSize

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

Getter Method

Signature FormSheetStandardMetricSize

Returns:
Return type:NXOpen.AME.FormSheetBuilderStandardMetricSize

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature FormSheetStandardMetricSize

Parameters:standardMetricSize (NXOpen.AME.FormSheetBuilderStandardMetricSize) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Height

FormSheetBuilder.Height

Returns or sets the height

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

Getter Method

Signature Height

Returns:
Return type:float

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Height

Parameters:height (float) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Length

FormSheetBuilder.Length

Returns or sets the length

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

Getter Method

Signature Length

Returns:
Return type:float

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

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

Setter Method

Signature Length

Parameters:length (float) –

New in version NX12.0.0.

License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)

Method Detail

Validate

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