ViewAlignmentBuilder Class¶
-
class
NXOpen.Drawings.ViewAlignmentBuilder¶ Bases:
NXOpen.BuilderRepresents a
NXOpen.Drawings.ViewAlignmentBuilder.This class is used to construct the view alignment Builder To create a new instance of this class, use
NXOpen.Drawings.ViewAlignmentCollection.CreateViewAlignmentBuilder()Default values.
Property Value Placement.AlignmentMethod Infer Placement.AlignmentOption ToView New in version NX8.5.0.
Properties¶
| Property | Description |
|---|---|
| CandidateView | Returns or sets the candidate view in builder |
| InEditMode | Returns or sets the builder edit mode flag. |
| Placement | Returns the view placement component |
| SelectedAlignment | Returns or sets the selected alignment in builder. |
| Tag | Returns the Tag for this object. |
| View | Returns the select drafting view component |
Methods¶
| Method | Description |
|---|---|
| Commit | Commits any edits that have been applied to the builder. |
| DeleteCurrentAlignment | Deletes a view alignment that is stored as the current alignment in 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¶
CandidateView¶
-
ViewAlignmentBuilder.CandidateView¶ Returns or sets the candidate view in builder
-------------------------------------Getter Method
Signature
CandidateViewReturns: Return type: NXOpen.Drawings.DraftingViewNew in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
-------------------------------------Setter Method
Signature
CandidateViewParameters: candidateView ( NXOpen.Drawings.DraftingView) –New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
InEditMode¶
-
ViewAlignmentBuilder.InEditMode¶ Returns or sets the builder edit mode flag.
There are two modes in the view alignment dialog, Create and Edit modes, and the flag determines the current mode. View alignment can be created in Create mode, and edited or deleted in Edit mode.
-------------------------------------Getter Method
Signature
InEditModeReturns: Return type: bool New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
-------------------------------------Setter Method
Signature
InEditModeParameters: inEditMode (bool) – New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
Placement¶
-
ViewAlignmentBuilder.Placement¶ Returns the view placement component
-------------------------------------Getter Method
Signature
PlacementReturns: Return type: NXOpen.Drawings.ViewPlacementBuilderNew in version NX8.5.0.
License requirements: None.
SelectedAlignment¶
-
ViewAlignmentBuilder.SelectedAlignment¶ Returns or sets the selected alignment in builder.
It needs to be set in edit mode as it specifies which alignment in the list needs to be edited or deleted
-------------------------------------Getter Method
Signature
SelectedAlignmentReturns: Return type: NXOpen.Drawings.ViewAlignmentNew in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
-------------------------------------Setter Method
Signature
SelectedAlignmentParameters: alignment ( NXOpen.Drawings.ViewAlignment) –New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
View¶
-
ViewAlignmentBuilder.View¶ Returns the select drafting view component
-------------------------------------Getter Method
Signature
ViewReturns: Return type: NXOpen.Drawings.SelectDraftingViewNew in version NX8.5.0.
License requirements: None.
Method Detail¶
DeleteCurrentAlignment¶
-
ViewAlignmentBuilder.DeleteCurrentAlignment¶ Deletes a view alignment that is stored as the current alignment in the builder
Signature
DeleteCurrentAlignment()New in version NX8.5.0.
License requirements: drafting (“DRAFTING”)
Validate¶
-
ViewAlignmentBuilder.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.