DetailViewBuilder Class

class NXOpen.Drawings.DetailViewBuilder

Bases: NXOpen.Builder

Represents a NXOpen.Drawings.DetailView.

This class is used to create and edit Detail Views

To create a new instance of this class, use NXOpen.Drawings.DraftingViewCollection.CreateDetailViewBuilder()

Default values.

Property	Value
Origin.AlignmentMethod	Infer
Origin.AlignmentOption	ToView
Scale.Denominator	1.0
Scale.Numerator	1.0
Scale.ScaleType	Ratio
SecondaryComponents.ObjectType	PrimaryGeometry
Style.ViewStyleGeneral.AngleSetting.Angle.Value	0
Style.ViewStyleGeneral.AngleSetting.Associative	0
Style.ViewStyleGeneral.AngleSetting.EvaluationPlane	DrawingSheet
Style.ViewStyleOrientation.HingeLine.ReverseDirection	false
Style.ViewStyleOrientation.HingeLine.VectorOption	Inferred
Style.ViewStyleOrientation.Ovt.AssociativeOrientation	0

New in version NX6.0.0.

Properties

Property	Description
Associative	Returns or sets the associative toggle If view is associative and set associative to false, the view will be converted to independent detail view.
BoundaryPoint1	Returns or sets the first boundary point.
BoundaryPoint2	Returns or sets the second boundary point.
HiddenObjects	Returns the list of objects to not show in the view
LabelOnParent	Returns or sets the label on parent
NonSectionedObjects	Returns the list of objects to not section in the view
Origin	Returns the origin
Parent	Returns the parent view
Scale	Returns the scale
SecondaryComponents	Returns the list of secondary components in the view
Style	Returns the style
Tag	Returns the Tag for this object.
Type	Returns or sets the 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.

Enumerations

DetailViewBuilderLabelOnParentType Enumeration	the display type for the label on parent
DetailViewBuilderTypes Enumeration	the type of boundary

Property Detail

Associative

DetailViewBuilder.Associative

Returns or sets the associative toggle If view is associative and set associative to false, the view will be converted to independent detail view.

Otherwise, this setting will have no effect

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

Getter Method

Signature Associative

Returns: Return type:bool

New in version NX7.5.0.

License requirements: None.

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

Setter Method

Signature Associative

Parameters:associative (bool) –

New in version NX7.5.0.

License requirements: None.

BoundaryPoint1

DetailViewBuilder.BoundaryPoint1

Returns or sets the first boundary point.

This is the center of the boundary for these types: NXOpen.Drawings.DetailViewBuilderTypes.Circular and NXOpen.Drawings.DetailViewBuilderTypes.RectangleByCenterAndCorner. This boundary point will be None for the type: NXOpen.Drawings.DetailViewBuilderTypes.Custom

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

Getter Method

Signature BoundaryPoint1

Returns: Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature BoundaryPoint1

Parameters:boundaryPoint1 (NXOpen.Point) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

BoundaryPoint2

DetailViewBuilder.BoundaryPoint2

Returns or sets the second boundary point.

This is the point on the circle for the NXOpen.Drawings.DetailViewBuilderTypes.Circular and the corner point for the NXOpen.Drawings.DetailViewBuilderTypes.RectangleByCenterAndCorner. This boundary point will be None for the type: NXOpen.Drawings.DetailViewBuilderTypes.Custom

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

Getter Method

Signature BoundaryPoint2

Returns: Return type:NXOpen.Point

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature BoundaryPoint2

Parameters:boundaryPoint2 (NXOpen.Point) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

HiddenObjects

DetailViewBuilder.HiddenObjects

Returns the list of objects to not show in the view

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

Getter Method

Signature HiddenObjects

Returns: Return type:NXOpen.Drawings.HiddenObjectsBuilder

New in version NX6.0.0.

License requirements: None.

LabelOnParent

DetailViewBuilder.LabelOnParent

Returns or sets the label on parent

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

Getter Method

Signature LabelOnParent

Returns: Return type:NXOpen.Drawings.DetailViewBuilderLabelOnParentType

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature LabelOnParent

Parameters:labelOnParent (NXOpen.Drawings.DetailViewBuilderLabelOnParentType) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

NonSectionedObjects

DetailViewBuilder.NonSectionedObjects

Returns the list of objects to not section in the view

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

Getter Method

Signature NonSectionedObjects

Returns: Return type:NXOpen.Drawings.HiddenObjectsBuilder

New in version NX6.0.0.

License requirements: None.

Origin

DetailViewBuilder.Origin

Returns the origin

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

Getter Method

Signature Origin

Returns: Return type:NXOpen.Drawings.ViewPlacementBuilder

New in version NX6.0.0.

License requirements: None.

Parent

DetailViewBuilder.Parent

Returns the parent view

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

Getter Method

Signature Parent

Returns: Return type:NXOpen.Drawings.ParentViewBuilder

New in version NX6.0.0.

License requirements: None.

Scale

DetailViewBuilder.Scale

Returns the scale

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

Getter Method

Signature Scale

Returns: Return type:NXOpen.Drawings.ViewScaleBuilder

New in version NX6.0.0.

License requirements: None.

SecondaryComponents

DetailViewBuilder.SecondaryComponents

Returns the list of secondary components in the view

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

Getter Method

Signature SecondaryComponents

Returns: Return type:NXOpen.Drawings.DraftingComponentSelectionBuilder

New in version NX11.0.0.

License requirements: None.

Style

DetailViewBuilder.Style

Returns the style

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

Getter Method

Signature Style

Returns: Return type:NXOpen.Drawings.ViewStyleBuilder

New in version NX6.0.0.

License requirements: None.

Type

DetailViewBuilder.Type

Returns or sets the type

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

Getter Method

Signature Type

Returns: Return type:NXOpen.Drawings.DetailViewBuilderTypes

New in version NX6.0.0.

License requirements: None.

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

Setter Method

Signature Type

Parameters:type (NXOpen.Drawings.DetailViewBuilderTypes) –

New in version NX6.0.0.

License requirements: drafting (“DRAFTING”)

Method Detail

Validate

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