Represents a AnnotationBuilder. More...

Inheritance diagram for NXOpen::Diagramming::AnnotationBuilder:

Public Types
enum	TextTypeOption { TextTypeOptionFixed, TextTypeOptionParametric }
	Represents the option NXOpen::Diagramming::AnnotationBuilder::TextType for a NXOpen::Diagramming::AnnotationBuilder . More...

Public Member Functions
bool	BoundaryDisplay ()
	Returns the visibility of boundary. More...

NXOpen::Diagramming::DiagrammingAnnotationboundarytype	BoundaryType ()
	Returns the boundary type of the annotation Created in NX10.0.0. More...

NXOpen::Diagramming::FormattedStringBuilder *	FormattedStringBuilder ()
	Returns the formatted string of the text. More...

void	SetBoundaryDisplay (bool boundaryDisplay)
	Sets the visibility of boundary. More...

void	SetBoundaryType (NXOpen::Diagramming::DiagrammingAnnotationboundarytype boundaryType)
	Sets the boundary type of the annotation Created in NX10.0.0. More...

void	SetText (const NXString &strValue)
	Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

void	SetText (const char *strValue)
	Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

void	SetTextType (NXOpen::Diagramming::AnnotationBuilder::TextTypeOption textType)
	Sets the text type. More...

NXString	Text ()
	Returns the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed Created in NX10.0.0. More...

NXOpen::Diagramming::TextStyleBuilder *	TextStyleBuilder ()
	Returns the text style of the annotation. More...

NXOpen::Diagramming::AnnotationBuilder::TextTypeOption	TextType ()
	Returns the text type. More...

Public Member Functions inherited from NXOpen::Diagramming::ConnectableElementBuilder
std::vector < NXOpen::Diagramming::Port * >	GetAllPorts ()
	Gets all ports of this connectable element. More...

std::vector < NXOpen::Diagramming::Port * >	GetPorts (NXOpen::Diagramming::Direction direction)
	Gets ports of this connectable element by the direction. More...

Public Member Functions inherited from NXOpen::Diagramming::SheetElementBuilder
void	GetAllowedTransformations (bool isAllowedTranslation, bool isAllowedRotation, bool isAllowedScale, bool isAllowedShear)
	Get the allowed transformations of the sheet element. More...

void	GetMinNodeSize (std::vector< double > &sizeValues)
	Gets the minimum node size values Created in NX11.0.0. More...

double	Height ()
	Returns the height. More...

NXOpen::Diagramming::DiagrammingSizingpolicy	HeightPolicy ()
	Returns the height policy. More...

bool	Internal ()
	Returns the flag that indicates if the sheet element is internal. More...

NXOpen::Diagramming::Annotation *	Label ()
	Returns the label of this sheet element. More...

NXString	LabelName ()
	Returns the label name of this sheet element. More...

NXOpen::Diagramming::LocationBuilder *	Location ()
	Returns the location of the sheet element relative to another sheet element. More...

NXOpen::Diagramming::DiagrammingLocationstyle	LocationStyle ()
	Returns the location style. More...

bool	MirrorX ()
	Returns the sheet element to Mirror along the X axis. More...

bool	MirrorY ()
	Returns the sheet element to Mirror along the Y axis. More...

NXOpen::Diagramming::SheetElement *	Owner ()
	Returns the owning sheet element. More...

NXOpen::Diagramming::Sheet *	OwningSheet ()
	Returns the owning sheet. More...

NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType	ResizeOption ()
	Returns the resize option of the sheet element Created in NX11.0.0. More...

double	Rotation ()
	Returns the rotation angle that is counter clockwise and relative to the owner. More...

void	SetHeight (double height)
	Sets the height. More...

void	SetHeightPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy heightPolicy)
	Sets the height policy. More...

void	SetLabelName (const NXString &labelname)
	Sets the label name of this sheet element. More...

void	SetLabelName (const char *labelname)
	Sets the label name of this sheet element. More...

void	SetLocationStyle (NXOpen::Diagramming::DiagrammingLocationstyle locationStyle)
	Sets the location style. More...

void	SetMinNodeSize (const std::vector< double > &sizeValues)
	Sets the minimum node size values Created in NX11.0.0. More...

void	SetMirrorX (bool mirrorX)
	Sets the sheet element to Mirror along the X axis. More...

void	SetMirrorY (bool mirrorY)
	Sets the sheet element to Mirror along the Y axis. More...

void	SetOwner (NXOpen::Diagramming::SheetElement *owner)
	Sets the owning sheet element. More...

void	SetOwningSheet (NXOpen::Diagramming::Sheet *owningSheet)
	Set the owning sheet when the sheet element is created. More...

void	SetResizeOption (NXOpen::Diagramming::SheetElementBuilder::ResizeOptionType resizeOption)
	Sets the resize option of the sheet element Created in NX11.0.0. More...

void	SetRotation (double angle)
	Sets the rotation angle that is counter clockwise and relative to the owner. More...

void	SetWidth (double width)
	Sets the width. More...

void	SetWidthPolicy (NXOpen::Diagramming::DiagrammingSizingpolicy widthPolicy)
	Sets the width policy. More...

void	SetX (double x)
	Sets the absolute x coordinate. More...

void	SetY (double y)
	Sets the absolute y coordinate. More...

void	SetZDepth (int zDepth)
	Sets the Z depth. More...

NXOpen::Diagramming::SheetElement *	SourceElement ()
	Returns the source element that records which sheet element it is a copy of. More...

bool	UpToDate ()
	Returns the flag that indicates if the sheet element is up to date. More...

bool	Visible ()
	Returns the flag that indicates if the sheet element is visible. More...

double	Width ()
	Returns the width. More...

NXOpen::Diagramming::DiagrammingSizingpolicy	WidthPolicy ()
	Returns the width policy. More...

double	X ()
	Returns the absolute x coordinate. More...

double	Y ()
	Returns the absolute y coordinate. More...

int	ZDepth ()
	Returns the Z depth. More...

Detailed Description

Represents a AnnotationBuilder.

To create a new instance of this class, use NXOpen::Diagramming::AnnotationCollection::CreateAnnotationBuilder

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::Diagramming::AnnotationBuilder::TextTypeOption

Represents the option NXOpen::Diagramming::AnnotationBuilder::TextType for a NXOpen::Diagramming::AnnotationBuilder .

Created in NX10.0.0.

Enumerator
TextTypeOptionFixed	Setting the text type fixed.
TextTypeOptionParametric	Setting the text type parametric.

Member Function Documentation

bool NXOpen::Diagramming::AnnotationBuilder::BoundaryDisplay ( )

Returns the visibility of boundary.

If return true, the annotation will show its boundary if it has one.
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::DiagrammingAnnotationboundarytype NXOpen::Diagramming::AnnotationBuilder::BoundaryType ( )

Returns the boundary type of the annotation
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::FormattedStringBuilder* NXOpen::Diagramming::AnnotationBuilder::FormattedStringBuilder ( )

Returns the formatted string of the text.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::AnnotationBuilder::SetBoundaryDisplay ( bool boundaryDisplay )

Sets the visibility of boundary.

If return true, the annotation will show its boundary if it has one.
Created in NX10.0.0.

License requirements : None

Parameters

boundaryDisplay boundarydisplay

void NXOpen::Diagramming::AnnotationBuilder::SetBoundaryType ( NXOpen::Diagramming::DiagrammingAnnotationboundarytype boundaryType )

Sets the boundary type of the annotation
Created in NX10.0.0.

License requirements : None

Parameters

boundaryType boundarytype

void NXOpen::Diagramming::AnnotationBuilder::SetText ( const NXString & strValue )

Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed
Created in NX10.0.0.

License requirements : None

Parameters

strValue strvalue

void NXOpen::Diagramming::AnnotationBuilder::SetText ( const char * strValue )

Sets the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed
Created in NX10.0.0.

License requirements : None

Parameters

strValue strvalue

void NXOpen::Diagramming::AnnotationBuilder::SetTextType ( NXOpen::Diagramming::AnnotationBuilder::TextTypeOption textType )

Sets the text type.

If NXOpen::Diagramming::AnnotationBuilder::TextTypeOptionFixed , the text of annotation is stored in NXOpen::Diagramming::AnnotationBuilder . If NXOpen::Diagramming::AnnotationBuilder::TextTypeOptionParametric , the text of annotation is stored in NXOpen::Diagramming::AnnotationBuilder::FormattedStringBuilder .
Created in NX10.0.0.

License requirements : None

Parameters

textType texttype

NXString NXOpen::Diagramming::AnnotationBuilder::Text ( )

Returns the text should be used only when textType is Diagramming.AnnotationBuilder.TextTypeOption.Fixed
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::TextStyleBuilder* NXOpen::Diagramming::AnnotationBuilder::TextStyleBuilder ( )

Returns the text style of the annotation.

Created in NX11.0.0.

License requirements : None

NXOpen::Diagramming::AnnotationBuilder::TextTypeOption NXOpen::Diagramming::AnnotationBuilder::TextType ( )

Returns the text type.

If NXOpen::Diagramming::AnnotationBuilder::TextTypeOptionFixed , the text of annotation is stored in NXOpen::Diagramming::AnnotationBuilder . If NXOpen::Diagramming::AnnotationBuilder::TextTypeOptionParametric , the text of annotation is stored in NXOpen::Diagramming::AnnotationBuilder::FormattedStringBuilder .
Created in NX10.0.0.

License requirements : None

The documentation for this class was generated from the following file:

Diagramming_AnnotationBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation