NX Open C++ Reference Guide
Namespaces | Classes | Enumerations
NXOpen::Diagramming Namespace Reference

Provides classes and interfaces relating to Diagramming. More...

Namespaces

namespace  Tables
 Provides classes and interfaces for Diagramming Tables.
 

Classes

class  Annotation
 Represents the Annotation class. More...
 
class  AnnotationBuilder
 Represents a AnnotationBuilder. More...
 
class  AnnotationCollection
 Represents a collection of Annotation. More...
 
class  BaseObject
 Represents the BaseObject class. More...
 
class  BaseObjectBuilder
 Represents a BaseObjectBuilder. More...
 
class  BaseSubObjectBuilder
 Represents a BaseSubObjectBuilder. More...
 
class  BaseTaggedObjectBuilder
 Represents a BaseTaggedObjectBuilder. More...
 
class  BulkEditBuilder
 Represents a BulkEditBuilder to edit bulk of objects. More...
 
class  CannedAnnotationBuilder
 Represents a CannedAnnotationBuilder. More...
 
class  ConnectableElement
 Represents the ConnectableElement class. More...
 
class  ConnectableElementBuilder
 Represents a ConnectableElementBuilder. More...
 
class  Connection
 Represents the Connection class. More...
 
class  ConnectionBuilder
 Represents a ConnectionBuilder. More...
 
class  ConnectionCollection
 Represents a collection of connection. More...
 
class  ConnectionLocationBuilder
 Represents a ConnectionLocationBuilder. More...
 
class  ConnectionLocationBuilderList
 Represents a list of objects. More...
 
class  DefineTitleBlockBuilder
 Represents a NXOpen::Diagramming::DefineTitleBlockBuilder builder
To create a new instance of this class, use NXOpen::Diagramming::TitleBlockCollection::CreateDefineTitleBlockBuilder

Created in NX11.0.1. More...
 
class  DiagrammingManager
 A manager to deal with all objects. More...
 
class  FormattedStringBuilder
 Represents a FormattedStringBuilder. More...
 
class  Group
 Represents the Group class. More...
 
class  GroupBuilder
 Represents a GroupBuilder. More...
 
class  GroupCollection
 Represents a collection of group. More...
 
class  LeaderLine
 Represents the LeaderLine class. More...
 
class  LeaderLineBuilder
 Represents a LeaderLineBuilder. More...
 
class  LeaderLineBuilderList
 Represents a list of objects. More...
 
class  LeaderLineCollection
 Represents a collection of leader line. More...
 
class  LocationBuilder
 Represents a LocationBuilder. More...
 
class  Node
 Represents the Node class. More...
 
class  NodeBuilder
 Represents a NodeBuilder. More...
 
class  NodeCollection
 Represents a collection of Node. More...
 
class  PopulateTitleBlockBuilder
 Represents a NXOpen::Diagramming::PopulateTitleBlockBuilder builder
To create a new instance of this class, use NXOpen::Diagramming::TitleBlockCollection::CreatePopulateTitleBlockBuilder

Created in NX11.0.1. More...
 
class  Port
 Represents the Port class. More...
 
class  PortBuilder
 Represents a PortBuilder. More...
 
class  PortBuilderList
 Represents a list of objects. More...
 
class  PortCollection
 Represents a collection of Port. More...
 
class  RenderingPropertiesBuilder
 Represents a RenderingPropertiesBuilder. More...
 
class  Shape
 Represents the Shape class. More...
 
class  ShapeBuilder
 Represents a ShapeBuilder. More...
 
class  ShapeCollection
 Represents a collection of Shape. More...
 
class  Sheet
 Represents the Sheet class. More...
 
class  SheetBordersAndZones
 Represents Sheet Borders and Zones
To create or edit an instance of this class, use NXOpen::Diagramming::SheetBordersAndZonesBuilder

Created in NX10.0.0. More...
 
class  SheetBordersAndZonesBuilder
 The SheetBordersAndZones builder
To create a new instance of this class, use NXOpen::Diagramming::SheetBordersAndZonesCollection::CreateSheetBordersAndZonesBuilder

Created in NX10.0.0. More...
 
class  SheetBordersAndZonesCollection
 Represents a collection of NXOpen::Diagramming::SheetBordersAndZones objects
To obtain an instance of this class, refer to NXOpen::Diagramming::DiagrammingManager

Created in NX10.0.0. More...
 
class  SheetBorderSettingsBuilder
 The SheetBorderSettings builder
Created in NX11.0.1. More...
 
class  SheetBuilder
 Represents a SheetBuilder. More...
 
class  SheetCollection
 Represents a collection of Sheet. More...
 
class  SheetElement
 Represents the SheetElement class. More...
 
class  SheetElementBuilder
 Represents a SheetElementBuilder. More...
 
class  SheetManager
 A manager to deal with all objects. More...
 
class  SheetMarginSettingsBuilder
 The SheetMarginSettings builder
Created in NX11.0.1. More...
 
class  SheetZoneSettingsBuilder
 The SheetZoneSettings builder
Created in NX11.0.1. More...
 
class  TextStyleBuilder
 Represents a TextStyleBuilder. More...
 
class  TitleBlock
 Represents a NXOpen::Diagramming::TitleBlock
To create or edit an instance of this class, use NXOpen::Diagramming::DefineTitleBlockBuilder

Created in NX11.0.1. More...
 
class  TitleBlockCellBuilder
 Represents a builder to edit NXOpen::Diagramming::TitleBlock 's cell
This is a sub-builder class and cannot be directly instantiated

Created in NX11.0.1. More...
 
class  TitleBlockCollection
 Represents a collection of Title Block. More...
 

Enumerations

enum  ArrowDirectionType { ArrowDirectionTypeOutofSheet, ArrowDirectionTypeIntoSheet }
 the arrow direction type More...
 
enum  ArrowStyleType { ArrowStyleTypeFilled, ArrowStyleTypeClosed, ArrowStyleTypeClosedSolid, ArrowStyleTypeOpen }
 the arrow style type More...
 
enum  Axis { AxisX = 1, AxisY }
 Represents the axis type. More...
 
enum  DiagrammingAlignment { DiagrammingAlignmentLeft, DiagrammingAlignmentCenter, DiagrammingAlignmentRight, DiagrammingAlignmentJustify }
 Represents the alignment. More...
 
enum  DiagrammingAnnotationboundarytype {
  DiagrammingAnnotationboundarytypeNone, DiagrammingAnnotationboundarytypeCircle, DiagrammingAnnotationboundarytypeEllipse, DiagrammingAnnotationboundarytypeRectangle,
  DiagrammingAnnotationboundarytypeRoundedRectangle
}
 Represents the boundary type of annotation. More...
 
enum  DiagrammingArrowtype { DiagrammingArrowtypeNone, DiagrammingArrowtypeOpen, DiagrammingArrowtypeFilled, DiagrammingArrowtypeClosedSolid }
 Represents the arrow type. More...
 
enum  DiagrammingConnectionlabelhorizontaloffsetposition { DiagrammingConnectionlabelhorizontaloffsetpositionAbove, DiagrammingConnectionlabelhorizontaloffsetpositionBelow }
 Represents the horizontal connection label offset position. More...
 
enum  DiagrammingConnectionlabelposition { DiagrammingConnectionlabelpositionStart = 1, DiagrammingConnectionlabelpositionEnd, DiagrammingConnectionlabelpositionCenter = 4, DiagrammingConnectionlabelpositionSpaced = 8 }
 Represents the connection label position. More...
 
enum  DiagrammingConnectionlabelverticaloffsetposition { DiagrammingConnectionlabelverticaloffsetpositionLeft, DiagrammingConnectionlabelverticaloffsetpositionRight }
 Represents the vertical connection label offset position. More...
 
enum  DiagrammingFlowdirectionarrowstyle {
  DiagrammingFlowdirectionarrowstyleBottomFilledArrow, DiagrammingFlowdirectionarrowstyleBottomOpenArrow, DiagrammingFlowdirectionarrowstyleClosedArrow, DiagrammingFlowdirectionarrowstyleClosedDoubleArrow,
  DiagrammingFlowdirectionarrowstyleClosedDoubleSolidArrow, DiagrammingFlowdirectionarrowstyleClosedSolidArrow, DiagrammingFlowdirectionarrowstyleFilledArrow, DiagrammingFlowdirectionarrowstyleFilledDoubleArrow,
  DiagrammingFlowdirectionarrowstyleOpenArrow, DiagrammingFlowdirectionarrowstyleOpenDoubleArrow, DiagrammingFlowdirectionarrowstyleTopFilledArrow, DiagrammingFlowdirectionarrowstyleTopOpenArrow
}
 Represents the flow direction arrow style. More...
 
enum  DiagrammingJumperprioritytype { DiagrammingJumperprioritytypeHorizontal, DiagrammingJumperprioritytypeVertical }
 Represents the jumper priority. More...
 
enum  DiagrammingJumpertype { DiagrammingJumpertypeU = 1, DiagrammingJumpertypeBreak }
 Represents the jumper type. More...
 
enum  DiagrammingLocationstyle { DiagrammingLocationstyleAbsolute, DiagrammingLocationstyleRelative }
 Represents the location style. More...
 
enum  DiagrammingRepeatstartposition { DiagrammingRepeatstartpositionCenter, DiagrammingRepeatstartpositionStart, DiagrammingRepeatstartpositionEnd }
 Represents the repeat start position. More...
 
enum  DiagrammingSizingpolicy { DiagrammingSizingpolicyLength, DiagrammingSizingpolicyAuto, DiagrammingSizingpolicyPercent, DiagrammingSizingpolicyInherit = 4 }
 Represents the sizing policy type. More...
 
enum  DiagrammingStubsides { DiagrammingStubsidesAuto, DiagrammingStubsidesLeft, DiagrammingStubsidesRight }
 Represents the stub side type. More...
 
enum  Direction { DirectionIn = 1, DirectionOut, DirectionBoth }
 Represents the direction type. More...
 
enum  FontEnum { FontEnumBlockfont }
 the font More...
 
enum  HorizontalCenteringMarkType {
  HorizontalCenteringMarkTypeNone, HorizontalCenteringMarkTypeLeftArrow, HorizontalCenteringMarkTypeRightArrow, HorizontalCenteringMarkTypeLeftandRightArrow,
  HorizontalCenteringMarkTypeLeftandRightLine
}
 the horizontal centering mark type More...
 
enum  Method { MethodNone, MethodStandard, MethodCustom }
 the zone method More...
 
enum  TrimmingMarkStyleType { TrimmingMarkStyleTypeTriangle, TrimmingMarkStyleTypeCorner }
 the trimming mark style type More...
 
enum  VerticalCenteringMarkType {
  VerticalCenteringMarkTypeNone, VerticalCenteringMarkTypeBottomArrow, VerticalCenteringMarkTypeTopArrow, VerticalCenteringMarkTypeBottomandTopArrow,
  VerticalCenteringMarkTypeBottomandTopLine
}
 the vertical centering mark type More...
 
enum  ZoneOrigin { ZoneOriginBottomRight, ZoneOriginTopLeft, ZoneOriginTopRight, ZoneOriginBottomLeft }
 the zone origin More...
 

Detailed Description

Provides classes and interfaces relating to Diagramming.

Enumeration Type Documentation

the arrow direction type

Enumerator
ArrowDirectionTypeOutofSheet 

Out of Sheet.

ArrowDirectionTypeIntoSheet 

into sheet

the arrow style type

Enumerator
ArrowStyleTypeFilled 

Filled.

ArrowStyleTypeClosed 

Closed.

ArrowStyleTypeClosedSolid 

Close Solid.

ArrowStyleTypeOpen 

open

Represents the axis type.


Created in NX10.0.0.

Enumerator
AxisX 

X axis.

AxisY 

Y axis.

Represents the alignment.


Created in NX10.0.0.

Enumerator
DiagrammingAlignmentLeft 

Setting the left alignment.

DiagrammingAlignmentCenter 

Setting the center alignment.

DiagrammingAlignmentRight 

Setting the right alignment.

DiagrammingAlignmentJustify 

Setting the justify alignment.

Represents the boundary type of annotation.


Created in NX10.0.0.

Enumerator
DiagrammingAnnotationboundarytypeNone 

No Boundary Type.

DiagrammingAnnotationboundarytypeCircle 

Circle Type.

DiagrammingAnnotationboundarytypeEllipse 

Ellipse Type.

DiagrammingAnnotationboundarytypeRectangle 

Rectangle Type.

DiagrammingAnnotationboundarytypeRoundedRectangle 

Rounded Rectangle Type.

Represents the arrow type.


Created in NX10.0.0.

Enumerator
DiagrammingArrowtypeNone 

Setting the arrow type none arrow.

DiagrammingArrowtypeOpen 

Setting the arrow type open arrow.

DiagrammingArrowtypeFilled 

Setting the arrow type filled arrow.

DiagrammingArrowtypeClosedSolid 

Setting the arrow type closed solid arrow.

Represents the horizontal connection label offset position.


Created in NX11.0.0.

Enumerator
DiagrammingConnectionlabelhorizontaloffsetpositionAbove 

Above.

DiagrammingConnectionlabelhorizontaloffsetpositionBelow 

Below.

Represents the connection label position.


Created in NX11.0.0.

Enumerator
DiagrammingConnectionlabelpositionStart 

Start.

DiagrammingConnectionlabelpositionEnd 

End.

DiagrammingConnectionlabelpositionCenter 

Centered.

DiagrammingConnectionlabelpositionSpaced 

Spaced.

Represents the vertical connection label offset position.


Created in NX11.0.0.

Enumerator
DiagrammingConnectionlabelverticaloffsetpositionLeft 

Left.

DiagrammingConnectionlabelverticaloffsetpositionRight 

Right.

Represents the flow direction arrow style.


Created in NX11.0.1.

Enumerator
DiagrammingFlowdirectionarrowstyleBottomFilledArrow 

bottom filled arrow

DiagrammingFlowdirectionarrowstyleBottomOpenArrow 

bottom open arrow

DiagrammingFlowdirectionarrowstyleClosedArrow 

closed arrow

DiagrammingFlowdirectionarrowstyleClosedDoubleArrow 

closed double arrow

DiagrammingFlowdirectionarrowstyleClosedDoubleSolidArrow 

closed double solid arrow

DiagrammingFlowdirectionarrowstyleClosedSolidArrow 

closed solid arrow

DiagrammingFlowdirectionarrowstyleFilledArrow 

filled arrow

DiagrammingFlowdirectionarrowstyleFilledDoubleArrow 

filled double arrow

DiagrammingFlowdirectionarrowstyleOpenArrow 

open arrow

DiagrammingFlowdirectionarrowstyleOpenDoubleArrow 

open double arrow

DiagrammingFlowdirectionarrowstyleTopFilledArrow 

top filled arrow

DiagrammingFlowdirectionarrowstyleTopOpenArrow 

top open arrow

Represents the jumper priority.


Created in NX11.0.0.

Enumerator
DiagrammingJumperprioritytypeHorizontal 

Horizontal.

DiagrammingJumperprioritytypeVertical 

Vertical.

Represents the jumper type.


Created in NX11.0.0.

Enumerator
DiagrammingJumpertypeU 

U shape.

DiagrammingJumpertypeBreak 

Break.

Represents the location style.


Created in NX10.0.0.

Enumerator
DiagrammingLocationstyleAbsolute 

Absolute.

DiagrammingLocationstyleRelative 

Relative.

Represents the repeat start position.


Created in NX11.0.0.

Enumerator
DiagrammingRepeatstartpositionCenter 

Center.

DiagrammingRepeatstartpositionStart 

Start.

DiagrammingRepeatstartpositionEnd 

End.

Represents the sizing policy type.


Created in NX10.0.0.

Enumerator
DiagrammingSizingpolicyLength 

Length policy.

DiagrammingSizingpolicyAuto 

Auto policy.

DiagrammingSizingpolicyPercent 

Percent policy.

DiagrammingSizingpolicyInherit 

Inherit policy.

Represents the stub side type.


Created in NX10.0.0.

Enumerator
DiagrammingStubsidesAuto 

Auto side.

DiagrammingStubsidesLeft 

Left side.

DiagrammingStubsidesRight 

Right side.

Represents the direction type.


Created in NX10.0.0.

Enumerator
DirectionIn 

In direction.

DirectionOut 

Out direction.

DirectionBoth 

Both direction.

the font

Enumerator
FontEnumBlockfont 

blockfont

the horizontal centering mark type

Enumerator
HorizontalCenteringMarkTypeNone 

None.

HorizontalCenteringMarkTypeLeftArrow 

Left Arrow.

HorizontalCenteringMarkTypeRightArrow 

Right Arrow.

HorizontalCenteringMarkTypeLeftandRightArrow 

Left and Right Arrow.

HorizontalCenteringMarkTypeLeftandRightLine 

leftand right line

the zone method

Enumerator
MethodNone 

To support legacy parts.

MethodStandard 

Standard.

MethodCustom 

custom

the trimming mark style type

Enumerator
TrimmingMarkStyleTypeTriangle 

Triangle.

TrimmingMarkStyleTypeCorner 

corner

the vertical centering mark type

Enumerator
VerticalCenteringMarkTypeNone 

None.

VerticalCenteringMarkTypeBottomArrow 

Bottom Arrow.

VerticalCenteringMarkTypeTopArrow 

Top Arrow.

VerticalCenteringMarkTypeBottomandTopArrow 

Bottom and Top Arrow.

VerticalCenteringMarkTypeBottomandTopLine 

bottomand top line

the zone origin

Enumerator
ZoneOriginBottomRight 

Bottom Right.

ZoneOriginTopLeft 

Top Left.

ZoneOriginTopRight 

Top Right.

ZoneOriginBottomLeft 

bottom left

Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.