DrawingRegionBuilder Class

class NXOpen.Drawings.DrawingRegionBuilder

Bases: NXOpen.Builder

Represents a Drawing Region Builder

To create a new instance of this class, use NXOpen.Drawings.DrawingRegionCollection.CreateDrawingRegionBuilder()

Default values.

Property	Value
Gap	0
GrowthDirection	RightfromTopLeft
Height.Value	0 (millimeters part), 0 (inches part)
HorizontalGrowthDirection	Left
Length.Value	0 (millimeters part), 0 (inches part)
MoveContent	All
ObjectType	View
Priority	0
SpecifyContinuation	None
VerticalGrowthDirection	Up

New in version NX8.0.0.

Properties

Property	Description
DrawingRegionRulesBuilder	Returns the DrawingRegionRules builder
Gap	Returns or sets the gap
GrowthDirection	Returns or sets the growth direction (this is for NXOpen.Annotations.CustomSymbol and NXOpen.Annotations.Note)
Height	Returns the height
HorizontalGrowthDirection	Returns or sets the horizantal growth direction
Length	Returns the length
MoveContent	Returns or sets the move content
Name	Returns or sets the name
ObjectType	Returns or sets the type
Origin	Returns or sets the origin
Priority	Returns or sets the priority
SpecifyContinuation	Returns or sets the continuation
Tag	Returns the Tag for this object.
VerticalGrowthDirection	Returns or sets the vertical growth direction

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.
SetNextLinkedRegion	Set the next linked regions
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

DrawingRegionBuilderContentToMove Enumeration	Specifies the region content to move
DrawingRegionBuilderRegionContinuation Enumeration	Specifies the region continuation type
DrawingRegionBuilderRegionDraftingObjectType Enumeration	Specifies the drafting object type
DrawingRegionBuilderRegionGrowthDirection Enumeration	Specifies the region growth direction (this is for NXOpen.Annotations.CustomSymbol and NXOpen.Annotations.Note)
DrawingRegionBuilderRegionHorizontalGrowthDirection Enumeration	Specifies the region horizontal growth direction
DrawingRegionBuilderRegionVerticalGrowthDirection Enumeration	Specifies the region vertical growth direction

Property Detail

DrawingRegionRulesBuilder

DrawingRegionBuilder.DrawingRegionRulesBuilder

Returns the DrawingRegionRules builder

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

Getter Method

Signature DrawingRegionRulesBuilder

Returns: Return type:NXOpen.Drawings.DrawingRegionRulesBuilder

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Gap

DrawingRegionBuilder.Gap

Returns or sets the gap

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

Getter Method

Signature Gap

Returns: Return type:float

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Gap

Parameters:gap (float) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

GrowthDirection

DrawingRegionBuilder.GrowthDirection

Returns or sets the growth direction (this is for NXOpen.Annotations.CustomSymbol and NXOpen.Annotations.Note)

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

Getter Method

Signature GrowthDirection

Returns: Return type:NXOpen.Drawings.DrawingRegionBuilderRegionGrowthDirection

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature GrowthDirection

Parameters:growthDirection (NXOpen.Drawings.DrawingRegionBuilderRegionGrowthDirection) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Height

DrawingRegionBuilder.Height

Returns the height

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

Getter Method

Signature Height

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

HorizontalGrowthDirection

DrawingRegionBuilder.HorizontalGrowthDirection

Returns or sets the horizantal growth direction

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

Getter Method

Signature HorizontalGrowthDirection

Returns: Return type:NXOpen.Drawings.DrawingRegionBuilderRegionHorizontalGrowthDirection

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature HorizontalGrowthDirection

Parameters:horizontalGrowthDirection (NXOpen.Drawings.DrawingRegionBuilderRegionHorizontalGrowthDirection) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Length

DrawingRegionBuilder.Length

Returns the length

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

Getter Method

Signature Length

Returns: Return type:NXOpen.Expression

New in version NX8.0.0.

License requirements: None.

MoveContent

DrawingRegionBuilder.MoveContent

Returns or sets the move content

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

Getter Method

Signature MoveContent

Returns: Return type:NXOpen.Drawings.DrawingRegionBuilderContentToMove

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature MoveContent

Parameters:moveContent (NXOpen.Drawings.DrawingRegionBuilderContentToMove) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Name

DrawingRegionBuilder.Name

Returns or sets the name

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

Getter Method

Signature Name

Returns: Return type:str

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Name

Parameters:name (str) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

ObjectType

DrawingRegionBuilder.ObjectType

Returns or sets the type

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

Getter Method

Signature ObjectType

Returns: Return type:NXOpen.Drawings.DrawingRegionBuilderRegionDraftingObjectType

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

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

Setter Method

Signature ObjectType

Parameters:type (NXOpen.Drawings.DrawingRegionBuilderRegionDraftingObjectType) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Origin

DrawingRegionBuilder.Origin

Returns or sets the origin

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

Getter Method

Signature Origin

Returns: Return type:NXOpen.Point

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Origin

Parameters:origin (NXOpen.Point) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Priority

DrawingRegionBuilder.Priority

Returns or sets the priority

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

Getter Method

Signature Priority

Returns: Return type:int

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature Priority

Parameters:priority (int) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

SpecifyContinuation

DrawingRegionBuilder.SpecifyContinuation

Returns or sets the continuation

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

Getter Method

Signature SpecifyContinuation

Returns: Return type:NXOpen.Drawings.DrawingRegionBuilderRegionContinuation

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature SpecifyContinuation

Parameters:specifyContinuation (NXOpen.Drawings.DrawingRegionBuilderRegionContinuation) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

VerticalGrowthDirection

DrawingRegionBuilder.VerticalGrowthDirection

Returns or sets the vertical growth direction

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

Getter Method

Signature VerticalGrowthDirection

Returns: Return type:NXOpen.Drawings.DrawingRegionBuilderRegionVerticalGrowthDirection

New in version NX8.0.0.

License requirements: None.

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

Setter Method

Signature VerticalGrowthDirection

Parameters:verticalGrowthDirection (NXOpen.Drawings.DrawingRegionBuilderRegionVerticalGrowthDirection) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Method Detail

SetNextLinkedRegion

DrawingRegionBuilder.SetNextLinkedRegion

Set the next linked regions

Signature SetNextLinkedRegion(nextLinkedRegion)

Parameters:nextLinkedRegion (NXOpen.Drawings.DrawingRegion) –

New in version NX8.0.0.

License requirements: nx_drawing_auto (“NX Drawing Automation”)

Validate

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