The SheetBorderSettings builder
Created in NX11.0.1. More...

Inheritance diagram for NXOpen::Diagramming::SheetBorderSettingsBuilder:

Public Member Functions
double	ArrowAngle ()
	Returns the angle of arrow in the borders. More...

NXOpen::Diagramming::ArrowDirectionType	ArrowDirection ()
	Returns the direction of arrow like Into Sheet or Out of Sheet. More...

double	ArrowHeadTail ()
	Returns the length of arrow tail. More...

double	ArrowLength ()
	Returns the length of arrow in the borders. More...

NXOpen::Diagramming::ArrowStyleType	ArrowStyle ()
	Returns the type of arrow style like Open, Closed... More...

double	BorderLineWidth ()
	Returns the width of border. More...

double	CenteringMarkLength ()
	Returns the length of centering mark. More...

NXOpen::LineColorFontWidthBuilder *	CenteringMarksColorWidth ()
	Returns the color and width of centering marks. More...

double	CenteringMarksExtension ()
	Returns the length of centering marks extension from inner border. More...

NXOpen::Diagramming::HorizontalCenteringMarkType	CenteringMarksHorizontal ()
	Returns the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow. More...

NXOpen::Diagramming::VerticalCenteringMarkType	CenteringMarksVertical ()
	Returns the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow. More...

bool	CreateBorders ()
	Returns the flag that indicates if borders are created. More...

bool	CreateTrimmingMarks ()
	Returns the flag indicates to create trimming marks or not. More...

bool	DisplaySheetSizeInBorder ()
	Returns the flag indicates to display sheet size in border or not Created in NX11.0.1. More...

double	DistanceFromInnerBorder ()
	Returns the distance between inner border and arrow head. More...

NXOpen::LineColorFontWidthBuilder *	InnerLineCFW ()
	Returns the color, font and width of inner border line. More...

NXOpen::Diagramming::Method	Method ()
	Returns the type of method to display like Standard/Custom Created in NX11.0.1. More...

NXOpen::LineColorFontWidthBuilder *	OuterLineCFW ()
	Returns the color, font and width of outer border line. More...

void	SetArrowAngle (double arrowAngle)
	Sets the angle of arrow in the borders. More...

void	SetArrowDirection (NXOpen::Diagramming::ArrowDirectionType arrowDirection)
	Sets the direction of arrow like Into Sheet or Out of Sheet. More...

void	SetArrowHeadTail (double arrowHeadTail)
	Sets the length of arrow tail. More...

void	SetArrowLength (double arrowLength)
	Sets the length of arrow in the borders. More...

void	SetArrowStyle (NXOpen::Diagramming::ArrowStyleType arrowStyle)
	Sets the type of arrow style like Open, Closed... More...

void	SetBorderLineWidth (double borderLineWidth)
	Sets the width of border. More...

void	SetCenteringMarkLength (double centeringMarkLength)
	Sets the length of centering mark. More...

void	SetCenteringMarksExtension (double centeringMarksExtension)
	Sets the length of centering marks extension from inner border. More...

void	SetCenteringMarksHorizontal (NXOpen::Diagramming::HorizontalCenteringMarkType centeringMarksHorizontal)
	Sets the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow. More...

void	SetCenteringMarksVertical (NXOpen::Diagramming::VerticalCenteringMarkType centeringMarksVertical)
	Sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow. More...

void	SetCreateBorders (bool createBorders)
	Sets the flag that indicates if borders are created. More...

void	SetCreateTrimmingMarks (bool createTrimmingMarks)
	Sets the flag indicates to create trimming marks or not. More...

void	SetDisplaySheetSizeInBorder (bool displaySheetSizeInBorder)
	Sets the flag indicates to display sheet size in border or not Created in NX11.0.1. More...

void	SetDistanceFromInnerBorder (double distanceInFromInnerBorder)
	Sets the distance between inner border and arrow head. More...

void	SetMethod (NXOpen::Diagramming::Method method)
	Sets the type of method to display like Standard/Custom Created in NX11.0.1. More...

void	SetTrimmingMarkColor (NXOpen::NXColor *trimmingMarkColor)
	Sets the color of trimming mark. More...

void	SetTrimmingMarkLength (double trimmingMarkLength)
	Sets the length of trimming mark. More...

void	SetTrimmingMarkStyle (NXOpen::Diagramming::TrimmingMarkStyleType trimmingMarkStyle)
	Sets the type of trimming mark style like Corner or Triangle. More...

void	SetTrimmingMarkWidth (double trimmingMarkWidth)
	Sets the width of trimming mark. More...

NXOpen::NXColor *	TrimmingMarkColor ()
	Returns the color of trimming mark. More...

double	TrimmingMarkLength ()
	Returns the length of trimming mark. More...

NXOpen::Diagramming::TrimmingMarkStyleType	TrimmingMarkStyle ()
	Returns the type of trimming mark style like Corner or Triangle. More...

double	TrimmingMarkWidth ()
	Returns the width of trimming mark. More...

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called. More...

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	Tag () const
	Returns the tag of this object. More...

Detailed Description

The SheetBorderSettings builder
Created in NX11.0.1.

Member Function Documentation

double NXOpen::Diagramming::SheetBorderSettingsBuilder::ArrowAngle ( )

Returns the angle of arrow in the borders.

Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::ArrowDirectionType NXOpen::Diagramming::SheetBorderSettingsBuilder::ArrowDirection ( )

Returns the direction of arrow like Into Sheet or Out of Sheet.

Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::ArrowHeadTail ( )

Returns the length of arrow tail.

Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::ArrowLength ( )

Returns the length of arrow in the borders.

Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::ArrowStyleType NXOpen::Diagramming::SheetBorderSettingsBuilder::ArrowStyle ( )

Returns the type of arrow style like Open, Closed...

Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::BorderLineWidth ( )

Returns the width of border.

It should be greater than zero.
Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::CenteringMarkLength ( )

Returns the length of centering mark.

Created in NX11.0.1.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Diagramming::SheetBorderSettingsBuilder::CenteringMarksColorWidth ( )

Returns the color and width of centering marks.

Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::CenteringMarksExtension ( )

Returns the length of centering marks extension from inner border.

Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::HorizontalCenteringMarkType NXOpen::Diagramming::SheetBorderSettingsBuilder::CenteringMarksHorizontal ( )

Returns the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow.

Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::VerticalCenteringMarkType NXOpen::Diagramming::SheetBorderSettingsBuilder::CenteringMarksVertical ( )

Returns the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.

Created in NX11.0.1.

License requirements : None

bool NXOpen::Diagramming::SheetBorderSettingsBuilder::CreateBorders ( )

Returns the flag that indicates if borders are created.

Created in NX11.0.1.

License requirements : None

bool NXOpen::Diagramming::SheetBorderSettingsBuilder::CreateTrimmingMarks ( )

Returns the flag indicates to create trimming marks or not.

Created in NX11.0.1.

License requirements : None

bool NXOpen::Diagramming::SheetBorderSettingsBuilder::DisplaySheetSizeInBorder ( )

Returns the flag indicates to display sheet size in border or not
Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::DistanceFromInnerBorder ( )

Returns the distance between inner border and arrow head.

Created in NX11.0.1.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Diagramming::SheetBorderSettingsBuilder::InnerLineCFW ( )

Returns the color, font and width of inner border line.

Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::Method NXOpen::Diagramming::SheetBorderSettingsBuilder::Method ( )

Returns the type of method to display like Standard/Custom
Created in NX11.0.1.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Diagramming::SheetBorderSettingsBuilder::OuterLineCFW ( )

Returns the color, font and width of outer border line.

Created in NX11.0.1.

License requirements : None

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetArrowAngle ( double arrowAngle )

Sets the angle of arrow in the borders.

Created in NX11.0.1.

License requirements : None

Parameters

arrowAngle arrowangle

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetArrowDirection ( NXOpen::Diagramming::ArrowDirectionType arrowDirection )

Sets the direction of arrow like Into Sheet or Out of Sheet.

Created in NX11.0.1.

License requirements : None

Parameters

arrowDirection arrowdirection

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetArrowHeadTail ( double arrowHeadTail )

Sets the length of arrow tail.

Created in NX11.0.1.

License requirements : None

Parameters

arrowHeadTail arrowheadtail

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetArrowLength ( double arrowLength )

Sets the length of arrow in the borders.

Created in NX11.0.1.

License requirements : None

Parameters

arrowLength arrowlength

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetArrowStyle ( NXOpen::Diagramming::ArrowStyleType arrowStyle )

Sets the type of arrow style like Open, Closed...

Created in NX11.0.1.

License requirements : None

Parameters

arrowStyle arrowstyle

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetBorderLineWidth ( double borderLineWidth )

Sets the width of border.

It should be greater than zero.
Created in NX11.0.1.

License requirements : None

Parameters

borderLineWidth borderlinewidth

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetCenteringMarkLength ( double centeringMarkLength )

Sets the length of centering mark.

Created in NX11.0.1.

License requirements : None

Parameters

centeringMarkLength centeringmarklength

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetCenteringMarksExtension ( double centeringMarksExtension )

Sets the length of centering marks extension from inner border.

Created in NX11.0.1.

License requirements : None

Parameters

centeringMarksExtension centeringmarksextension

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetCenteringMarksHorizontal ( NXOpen::Diagramming::HorizontalCenteringMarkType centeringMarksHorizontal )

Sets the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow.

Created in NX11.0.1.

License requirements : None

Parameters

centeringMarksHorizontal centeringmarkshorizontal

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetCenteringMarksVertical ( NXOpen::Diagramming::VerticalCenteringMarkType centeringMarksVertical )

Sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.

Created in NX11.0.1.

License requirements : None

Parameters

centeringMarksVertical centeringmarksvertical

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetCreateBorders ( bool createBorders )

Sets the flag that indicates if borders are created.

Created in NX11.0.1.

License requirements : None

Parameters

createBorders createborders

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetCreateTrimmingMarks ( bool createTrimmingMarks )

Sets the flag indicates to create trimming marks or not.

Created in NX11.0.1.

License requirements : None

Parameters

createTrimmingMarks createtrimmingmarks

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetDisplaySheetSizeInBorder ( bool displaySheetSizeInBorder )

Sets the flag indicates to display sheet size in border or not
Created in NX11.0.1.

License requirements : None

Parameters

displaySheetSizeInBorder displaysheetsizeinborder

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetDistanceFromInnerBorder ( double distanceInFromInnerBorder )

Sets the distance between inner border and arrow head.

Created in NX11.0.1.

License requirements : None

Parameters

distanceInFromInnerBorder distanceinfrominnerborder

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetMethod ( NXOpen::Diagramming::Method method )

Sets the type of method to display like Standard/Custom
Created in NX11.0.1.

License requirements : None

Parameters

method method

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetTrimmingMarkColor ( NXOpen::NXColor * trimmingMarkColor )

Sets the color of trimming mark.

Created in NX11.0.1.

License requirements : None

Parameters

trimmingMarkColor trimmingmarkcolor

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetTrimmingMarkLength ( double trimmingMarkLength )

Sets the length of trimming mark.

It should be greater than zero.
Created in NX11.0.1.

License requirements : None

Parameters

trimmingMarkLength trimmingmarklength

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetTrimmingMarkStyle ( NXOpen::Diagramming::TrimmingMarkStyleType trimmingMarkStyle )

Sets the type of trimming mark style like Corner or Triangle.

Created in NX11.0.1.

License requirements : None

Parameters

trimmingMarkStyle trimmingmarkstyle

void NXOpen::Diagramming::SheetBorderSettingsBuilder::SetTrimmingMarkWidth ( double trimmingMarkWidth )

Sets the width of trimming mark.

It should be greater than zero.
Created in NX11.0.1.

License requirements : None

Parameters

trimmingMarkWidth trimmingmarkwidth

NXOpen::NXColor* NXOpen::Diagramming::SheetBorderSettingsBuilder::TrimmingMarkColor ( )

Returns the color of trimming mark.

Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::TrimmingMarkLength ( )

Returns the length of trimming mark.

It should be greater than zero.
Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::TrimmingMarkStyleType NXOpen::Diagramming::SheetBorderSettingsBuilder::TrimmingMarkStyle ( )

Returns the type of trimming mark style like Corner or Triangle.

Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBorderSettingsBuilder::TrimmingMarkWidth ( )

Returns the width of trimming mark.

It should be greater than zero.
Created in NX11.0.1.

License requirements : None

virtual bool NXOpen::Diagramming::SheetBorderSettingsBuilder::Validate ( )

virtual

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.

Returns: Was self validation successful
Created in NX3.0.1.

License requirements : None

Implements NXOpen::GeometricUtilities::IComponentBuilder.

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

Diagramming_SheetBorderSettingsBuilder.hxx

Public Member Functions

Detailed Description

Member Function Documentation