NXOpen .NET Reference Guide  1899
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties
Public Types | Public Member Functions | Properties | List of all members
NXOpen.Drawings.DrawingRegionBuilder Class Reference

Represents a Drawing Region Builder More...

Inheritance diagram for NXOpen.Drawings.DrawingRegionBuilder:
NXOpen.Builder NXOpen.TaggedObject NXOpen.GeometricUtilities.IComponentBuilder NXOpen.Utilities.NXRemotableObject IMessageSink

Public Types

enum  ContentToMove { All, OnlyOverlapping }
 Specifies the region content to move More...
 
enum  RegionContinuation {
  None, NewSheet, NextRegion, NewSheetRight,
  NewSheetLeft, NewSheetUp, NewSheetDown
}
 Specifies the region continuation type More...
 
enum  RegionDraftingObjectType {
  View, Table, Annotation, Symbol,
  Blank, None
}
 Specifies the drafting object type More...
 
enum  RegionGrowthDirection {
  RightfromTopLeft, RightfromBottomLeft, LeftfromTopRight, LeftfromBottomRight,
  DownfromTopLeft, DownfromTopRight, UpfromBottomLeft, UpfromBottomRight,
  None
}
 Specifies the region growth direction (this is for NXOpen.Annotations.CustomSymbol and NXOpen.Annotations.Note ) More...
 
enum  RegionHorizontalGrowthDirection { Left, Right }
 Specifies the region horizontal growth direction More...
 
enum  RegionVerticalGrowthDirection { Up, Down }
 Specifies the region vertical growth direction More...
 

Public Member Functions

unsafe void SetNextLinkedRegion (NXOpen.Drawings.DrawingRegion nextLinkedRegion)
 Set the next linked regions More...
 
- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen.TaggedObject
void PrintTestData (String variableName)
 <exclude> More...
 
void PrintTestData (String variableName, int lineNumber)
 <exclude> More...
 
override string ToString ()
 Returns a String that represents the current Object. More...
 
- Public Member Functions inherited from NXOpen.Utilities.NXRemotableObject
IMessageCtrl AsyncProcessMessage (IMessage msg, IMessageSink replySink)
 Asynchronously processes the given message. More...
 
IMessage SyncProcessMessage (IMessage msg)
 Synchronously processes the given message. More...
 

Properties

unsafe
NXOpen.Drawings.DrawingRegionRulesBuilder 
DrawingRegionRulesBuilder [get]
 Returns the DrawingRegionRules builder More...
 
unsafe double Gap [get, set]
 Returns or sets the gap More...
 
unsafe
NXOpen.Drawings.DrawingRegionBuilder.RegionGrowthDirection 
GrowthDirection [get, set]
 Returns or sets the growth direction (this is for NXOpen.Annotations.CustomSymbol and NXOpen.Annotations.Note ) More...
 
unsafe NXOpen.Expression Height [get]
 Returns the height More...
 
unsafe
NXOpen.Drawings.DrawingRegionBuilder.RegionHorizontalGrowthDirection 
HorizontalGrowthDirection [get, set]
 Returns or sets the horizantal growth direction More...
 
unsafe NXOpen.Expression Length [get]
 Returns the length More...
 
unsafe
NXOpen.Drawings.DrawingRegionBuilder.ContentToMove 
MoveContent [get, set]
 Returns or sets the move content More...
 
unsafe string Name [get, set]
 Returns or sets the name More...
 
unsafe
NXOpen.Drawings.DrawingRegionBuilder.RegionDraftingObjectType 
ObjectType [get, set]
 Returns or sets the type More...
 
unsafe NXOpen.Point Origin [get, set]
 Returns or sets the origin More...
 
unsafe int Priority [get, set]
 Returns or sets the priority More...
 
unsafe
NXOpen.Drawings.DrawingRegionBuilder.RegionContinuation 
SpecifyContinuation [get, set]
 Returns or sets the continuation More...
 
unsafe
NXOpen.Drawings.DrawingRegionBuilder.RegionVerticalGrowthDirection 
VerticalGrowthDirection [get, set]
 Returns or sets the vertical growth direction More...
 
- Properties inherited from NXOpen.Builder
unsafe NXOpen.PreviewBuilder PreviewBuilder [get]
 Returns the preview builder subobject. More...
 
- Properties inherited from NXOpen.TaggedObject
Tag Tag [get]
 Returns the tag of this object. More...
 
- Properties inherited from NXOpen.Utilities.NXRemotableObject
IMessageSink NextSink [get]
 Gets the next message sink in the sink chain. More...
 

Additional Inherited Members

- Protected Member Functions inherited from NXOpen.TaggedObject
new void initialize ()
 <exclude> More...
 

Detailed Description

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

Created in NX8.0.0

Member Enumeration Documentation

Specifies the region content to move

Enumerator
All 
OnlyOverlapping 

Specifies the region continuation type

Enumerator
None 
NewSheet 
NextRegion 
NewSheetRight 
NewSheetLeft 
NewSheetUp 
NewSheetDown 

Specifies the drafting object type

Enumerator
View 
Table 
Annotation 
Symbol 
Blank 
None 

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

Enumerator
RightfromTopLeft 
RightfromBottomLeft 
LeftfromTopRight 
LeftfromBottomRight 
DownfromTopLeft 
DownfromTopRight 
UpfromBottomLeft 
UpfromBottomRight 
None 

Specifies the region horizontal growth direction

Enumerator
Left 
Right 

Specifies the region vertical growth direction

Enumerator
Up 
Down 

Member Function Documentation

unsafe void NXOpen.Drawings.DrawingRegionBuilder.SetNextLinkedRegion ( NXOpen.Drawings.DrawingRegion  nextLinkedRegion)
inline

Set the next linked regions

Created in NX8.0.0

License requirements: nx_drawing_auto ("NX Drawing Automation")

Parameters
nextLinkedRegion

Property Documentation

unsafe NXOpen.Drawings.DrawingRegionRulesBuilder NXOpen.Drawings.DrawingRegionBuilder.DrawingRegionRulesBuilder
get

Returns the DrawingRegionRules builder

Created in NX8.0.0

License requirements: nx_drawing_auto ("NX Drawing Automation")

unsafe double NXOpen.Drawings.DrawingRegionBuilder.Gap
getset

Returns or sets the gap

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Drawings.DrawingRegionBuilder.RegionGrowthDirection NXOpen.Drawings.DrawingRegionBuilder.GrowthDirection
getset

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

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Expression NXOpen.Drawings.DrawingRegionBuilder.Height
get

Returns the height

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Drawings.DrawingRegionBuilder.RegionHorizontalGrowthDirection NXOpen.Drawings.DrawingRegionBuilder.HorizontalGrowthDirection
getset

Returns or sets the horizantal growth direction

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Expression NXOpen.Drawings.DrawingRegionBuilder.Length
get

Returns the length

Created in NX8.0.0

License requirements: None.

unsafe NXOpen.Drawings.DrawingRegionBuilder.ContentToMove NXOpen.Drawings.DrawingRegionBuilder.MoveContent
getset

Returns or sets the move content

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe string NXOpen.Drawings.DrawingRegionBuilder.Name
getset

Returns or sets the name

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Drawings.DrawingRegionBuilder.RegionDraftingObjectType NXOpen.Drawings.DrawingRegionBuilder.ObjectType
getset

Returns or sets the type

Created in NX8.0.0

License requirements to get this property: nx_drawing_auto ("NX Drawing Automation")

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Point NXOpen.Drawings.DrawingRegionBuilder.Origin
getset

Returns or sets the origin

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe int NXOpen.Drawings.DrawingRegionBuilder.Priority
getset

Returns or sets the priority

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Drawings.DrawingRegionBuilder.RegionContinuation NXOpen.Drawings.DrawingRegionBuilder.SpecifyContinuation
getset

Returns or sets the continuation

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")

unsafe NXOpen.Drawings.DrawingRegionBuilder.RegionVerticalGrowthDirection NXOpen.Drawings.DrawingRegionBuilder.VerticalGrowthDirection
getset

Returns or sets the vertical growth direction

Created in NX8.0.0

License requirements to get this property: None.

License requirements to set this property: nx_drawing_auto ("NX Drawing Automation")


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