FragmentBuilder Class¶
-
class
NXOpen.AME.FragmentBuilder¶ Bases:
NXOpen.BuilderRepresents a Fragment creation class Builder
To create a new instance of this class, use
NXOpen.AME.AMEManager.CreateFragmentBuilder()New in version NX11.0.0.
Properties¶
| Property | Description |
|---|---|
| AspectDetailsBuilder | Returns the fragment aspect details |
| FragmentAttributeHolder | Returns the attribute holder |
| FragmentDescription | Returns or sets the fragment description |
| FragmentName | Returns or sets the fragment name |
| Tag | Returns the Tag for this object. |
| Type | Returns or sets the fragment 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. |
| 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¶
AspectDetailsBuilder¶
-
FragmentBuilder.AspectDetailsBuilder¶ Returns the fragment aspect details
-------------------------------------Getter Method
Signature
AspectDetailsBuilderReturns: Return type: NXOpen.AME.AspectDetailsBuilderNew in version NX11.0.0.
License requirements: None.
FragmentAttributeHolder¶
-
FragmentBuilder.FragmentAttributeHolder¶ Returns the attribute holder
-------------------------------------Getter Method
Signature
FragmentAttributeHolderReturns: Return type: NXOpen.AME.FragmentAttributeHolderNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
FragmentDescription¶
-
FragmentBuilder.FragmentDescription¶ Returns or sets the fragment description
-------------------------------------Getter Method
Signature
FragmentDescriptionReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
FragmentDescriptionParameters: fragmentDescription (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
FragmentName¶
-
FragmentBuilder.FragmentName¶ Returns or sets the fragment name
-------------------------------------Getter Method
Signature
FragmentNameReturns: Return type: str New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
FragmentNameParameters: fragmentName (str) – New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Type¶
-
FragmentBuilder.Type¶ Returns or sets the fragment type
-------------------------------------Getter Method
Signature
TypeReturns: Return type: NXOpen.AME.PageBuilderTypesNew in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
-------------------------------------Setter Method
Signature
TypeParameters: fragmentType ( NXOpen.AME.PageBuilderTypes) –New in version NX11.0.0.
License requirements: ad_automation_design (“FULL AUTOMATION DESIGNER”)
Method Detail¶
Validate¶
-
FragmentBuilder.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.