NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Drawings::DrawingRegionBuilder Class Reference

Represents a Drawing Region Builder
To create a new instance of this class, use Drawings::DrawingRegionCollection::CreateDrawingRegionBuilder
Default values. More...

Inheritance diagram for NXOpen::Drawings::DrawingRegionBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

Public Types

enum  ContentToMove { ContentToMoveAll, ContentToMoveOnlyOverlapping }
 Specifies the region content to move. More...
enum  RegionContinuation {
  RegionContinuationNone, RegionContinuationNewSheet, RegionContinuationNextRegion, RegionContinuationNewSheetRight,
  RegionContinuationNewSheetLeft, RegionContinuationNewSheetUp, RegionContinuationNewSheetDown
}
 Specifies the region continuation type. More...
enum  RegionDraftingObjectType {
  RegionDraftingObjectTypeView, RegionDraftingObjectTypeTable, RegionDraftingObjectTypeAnnotation, RegionDraftingObjectTypeSymbol,
  RegionDraftingObjectTypeBlank, RegionDraftingObjectTypeNone
}
 Specifies the drafting object type. More...
enum  RegionGrowthDirection {
  RegionGrowthDirectionRightfromTopLeft, RegionGrowthDirectionRightfromBottomLeft, RegionGrowthDirectionLeftfromTopRight, RegionGrowthDirectionLeftfromBottomRight,
  RegionGrowthDirectionDownfromTopLeft, RegionGrowthDirectionDownfromTopRight, RegionGrowthDirectionUpfromBottomLeft, RegionGrowthDirectionUpfromBottomRight,
  RegionGrowthDirectionNone
}
 Specifies the region growth direction (this is for Annotations::CustomSymbol and Annotations::Note ) More...
enum  RegionHorizontalGrowthDirection { RegionHorizontalGrowthDirectionLeft, RegionHorizontalGrowthDirectionRight }
 Specifies the region horizontal growth direction. More...
enum  RegionVerticalGrowthDirection { RegionVerticalGrowthDirectionUp, RegionVerticalGrowthDirectionDown }
 Specifies the region vertical growth direction. More...

Public Member Functions

NXOpen::Drawings::DrawingRegionRulesBuilderDrawingRegionRulesBuilder ()
 Returns the DrawingRegionRules builder
Created in NX8.0.0.
double Gap ()
 Returns the gap
Created in NX8.0.0.
NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection GrowthDirection ()
 Returns the growth direction (this is for Annotations::CustomSymbol and Annotations::Note )
Created in NX8.0.0.
NXOpen::ExpressionHeight ()
 Returns the height
Created in NX8.0.0.
NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection HorizontalGrowthDirection ()
 Returns the horizantal growth direction
Created in NX8.0.0.
NXOpen::ExpressionLength ()
 Returns the length
Created in NX8.0.0.
NXOpen::Drawings::DrawingRegionBuilder::ContentToMove MoveContent ()
 Returns the move content
Created in NX8.0.0.
NXString Name ()
 Returns the name
Created in NX8.0.0.
NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType ObjectType ()
 Returns the type
Created in NX8.0.0.
NXOpen::PointOrigin ()
 Returns the origin
Created in NX8.0.0.
int Priority ()
 Returns the priority
Created in NX8.0.0.
void SetGap (double gap)
 Sets the gap
Created in NX8.0.0.
void SetGrowthDirection (NXOpen::Drawings::DrawingRegionBuilder::RegionGrowthDirection growthDirection)
 Sets the growth direction (this is for Annotations::CustomSymbol and Annotations::Note )
Created in NX8.0.0.
void SetHorizontalGrowthDirection (NXOpen::Drawings::DrawingRegionBuilder::RegionHorizontalGrowthDirection horizontalGrowthDirection)
 Sets the horizantal growth direction
Created in NX8.0.0.
void SetMoveContent (NXOpen::Drawings::DrawingRegionBuilder::ContentToMove moveContent)
 Sets the move content
Created in NX8.0.0.
void SetName (const NXString &name)
 Sets the name
Created in NX8.0.0.
void SetNextLinkedRegion (NXOpen::Drawings::DrawingRegion *nextLinkedRegion)
 Set the next linked regions
Created in NX8.0.0.
void SetObjectType (NXOpen::Drawings::DrawingRegionBuilder::RegionDraftingObjectType type)
 Sets the type
Created in NX8.0.0.
void SetOrigin (NXOpen::Point *origin)
 Sets the origin
Created in NX8.0.0.
void SetPriority (int priority)
 Sets the priority
Created in NX8.0.0.
void SetSpecifyContinuation (NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation specifyContinuation)
 Sets the continuation
Created in NX8.0.0.
void SetVerticalGrowthDirection (NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection verticalGrowthDirection)
 Sets the vertical growth direction
Created in NX8.0.0.
NXOpen::Drawings::DrawingRegionBuilder::RegionContinuation SpecifyContinuation ()
 Returns the continuation
Created in NX8.0.0.
NXOpen::Drawings::DrawingRegionBuilder::RegionVerticalGrowthDirection VerticalGrowthDirection ()
 Returns the vertical growth direction
Created in NX8.0.0.

Detailed Description

Represents a Drawing Region Builder
To create a new instance of this class, use 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


Created in NX8.0.0.


Member Enumeration Documentation

Specifies the region content to move.

Enumerator:
ContentToMoveAll 

all

ContentToMoveOnlyOverlapping 

only overlapping

Specifies the region continuation type.

Enumerator:
RegionContinuationNone 

none

RegionContinuationNewSheet 

new sheet

RegionContinuationNextRegion 

next region

RegionContinuationNewSheetRight 

new sheet right

RegionContinuationNewSheetLeft 

new sheet left

RegionContinuationNewSheetUp 

new sheet up

RegionContinuationNewSheetDown 

new sheet down

Specifies the drafting object type.

Enumerator:
RegionDraftingObjectTypeView 

view

RegionDraftingObjectTypeTable 

table

RegionDraftingObjectTypeAnnotation 

annotation

RegionDraftingObjectTypeSymbol 

symbol

RegionDraftingObjectTypeBlank 

blank

RegionDraftingObjectTypeNone 

none

Specifies the region growth direction (this is for Annotations::CustomSymbol and Annotations::Note )

Enumerator:
RegionGrowthDirectionRightfromTopLeft 

rightfrom top left

RegionGrowthDirectionRightfromBottomLeft 

rightfrom bottom left

RegionGrowthDirectionLeftfromTopRight 

leftfrom top right

RegionGrowthDirectionLeftfromBottomRight 

leftfrom bottom right

RegionGrowthDirectionDownfromTopLeft 

downfrom top left

RegionGrowthDirectionDownfromTopRight 

downfrom top right

RegionGrowthDirectionUpfromBottomLeft 

upfrom bottom left

RegionGrowthDirectionUpfromBottomRight 

upfrom bottom right

RegionGrowthDirectionNone 

none

Specifies the region horizontal growth direction.

Enumerator:
RegionHorizontalGrowthDirectionLeft 

left

RegionHorizontalGrowthDirectionRight 

right

Specifies the region vertical growth direction.

Enumerator:
RegionVerticalGrowthDirectionUp 

up

RegionVerticalGrowthDirectionDown 

down


Member Function Documentation

Returns the DrawingRegionRules builder
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Returns the gap
Created in NX8.0.0.



License requirements : None

Returns the growth direction (this is for Annotations::CustomSymbol and Annotations::Note )
Created in NX8.0.0.



License requirements : None

Returns the height
Created in NX8.0.0.



License requirements : None

Returns the horizantal growth direction
Created in NX8.0.0.



License requirements : None

Returns the length
Created in NX8.0.0.



License requirements : None

Returns the move content
Created in NX8.0.0.



License requirements : None

Returns the name
Created in NX8.0.0.



License requirements : None

Returns the type
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Returns the origin
Created in NX8.0.0.



License requirements : None

Returns the priority
Created in NX8.0.0.



License requirements : None

Sets the gap
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
gapgap

Sets the growth direction (this is for Annotations::CustomSymbol and Annotations::Note )
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
growthDirectiongrowthdirection

Sets the horizantal growth direction
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
horizontalGrowthDirectionhorizontalgrowthdirection

Sets the move content
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
moveContentmovecontent

Sets the name
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
namename

Set the next linked regions
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
nextLinkedRegionnextlinkedregion

Sets the type
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
typetype

Sets the origin
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
originorigin

Sets the priority
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
prioritypriority

Sets the continuation
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
specifyContinuationspecifycontinuation

Sets the vertical growth direction
Created in NX8.0.0.



License requirements : nx_drafting_plus ("Drafting Plus")

Parameters:
verticalGrowthDirectionverticalgrowthdirection

Returns the continuation
Created in NX8.0.0.



License requirements : None

Returns the vertical growth direction
Created in NX8.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.