NXOpen::Drawings::SheetBorderSettingsBuilder Class Reference

Represents a NXOpen::Drawings::SheetBorderSettingsBuilder . More...

Inheritance diagram for NXOpen::Drawings::SheetBorderSettingsBuilder:

Public Member Functions
double	ArrowAngle ()
	Returns the arrow angle Created in NX10.0.0. More...
NXOpen::Drawings::ArrowDirectionType	ArrowDirection ()
	Returns the arrow direction Created in NX10.0.0. More...
double	ArrowHeadTail ()
	Returns the arrowhead tail Created in NX10.0.0. More...
double	ArrowLength ()
	Returns the arrow length Created in NX10.0.0. More...
NXOpen::Drawings::ArrowStyleType	ArrowStyle ()
	Returns the arrow style Created in NX10.0.0. More...
double	BorderLineWidth ()
	Returns the border line width Created in NX10.0.0. More...
double	CenteringMarkLength ()
	Returns the centering mark length Created in NX10.0.0. More...
NXOpen::LineColorFontWidthBuilder *	CenteringMarksColorWidth ()
	Returns the centering marks color width Created in NX10.0.0. More...
double	CenteringMarksExtension ()
	Returns the centering marks extension Created in NX10.0.0. More...
NXOpen::Drawings::HorizontalCenteringMarkType	CenteringMarksHorizontal ()
	Returns the centering marks horizontal Created in NX10.0.0. More...
NXOpen::Drawings::VerticalCenteringMarkType	CenteringMarksVertical ()
	Returns the centering marks vertical Created in NX10.0.0. More...
bool	CreateBorders ()
	Returns the create borders Created in NX10.0.0. More...
bool	CreateTrimmingMarks ()
	Returns the create trimming marks Created in NX10.0.0. More...
bool	DisplaySheetSizeInBorder ()
	Returns the display sheet size in border Created in NX10.0.0. More...
double	DistanceFromInnerBorder ()
	Returns the distance from inner border Created in NX10.0.0. More...
NXOpen::LineColorFontWidthBuilder *	InnerLineCFW ()
	Returns the inner border line's color, font and width Created in NX10.0.0. More...
NXOpen::Drawings::Method	Method ()
	Returns the method Created in NX10.0.0. More...
NXOpen::LineColorFontWidthBuilder *	OuterLineCFW ()
	Returns the outer border line's color, font and width Created in NX10.0.0. More...
void	SetArrowAngle (double arrowAngle)
	Sets the arrow angle Created in NX10.0.0. More...
void	SetArrowDirection (NXOpen::Drawings::ArrowDirectionType arrowDirection)
	Sets the arrow direction Created in NX10.0.0. More...
void	SetArrowHeadTail (double arrowHeadTail)
	Sets the arrowhead tail Created in NX10.0.0. More...
void	SetArrowLength (double arrowLength)
	Sets the arrow length Created in NX10.0.0. More...
void	SetArrowStyle (NXOpen::Drawings::ArrowStyleType arrowStyle)
	Sets the arrow style Created in NX10.0.0. More...
void	SetBorderLineWidth (double borderLineWidth)
	Sets the border line width Created in NX10.0.0. More...
void	SetCenteringMarkLength (double centeringMarkLength)
	Sets the centering mark length Created in NX10.0.0. More...
void	SetCenteringMarksExtension (double centeringMarksExtension)
	Sets the centering marks extension Created in NX10.0.0. More...
void	SetCenteringMarksHorizontal (NXOpen::Drawings::HorizontalCenteringMarkType centeringMarksHorizontal)
	Sets the centering marks horizontal Created in NX10.0.0. More...
void	SetCenteringMarksVertical (NXOpen::Drawings::VerticalCenteringMarkType centeringMarksVertical)
	Sets the centering marks vertical Created in NX10.0.0. More...
void	SetCreateBorders (bool createBorders)
	Sets the create borders Created in NX10.0.0. More...
void	SetCreateTrimmingMarks (bool createTrimmingMarks)
	Sets the create trimming marks Created in NX10.0.0. More...
void	SetDisplaySheetSizeInBorder (bool displaySheetSizeInBorder)
	Sets the display sheet size in border Created in NX10.0.0. More...
void	SetDistanceFromInnerBorder (double distanceInFromInnerBorder)
	Sets the distance from inner border Created in NX10.0.0. More...
void	SetMethod (NXOpen::Drawings::Method method)
	Sets the method Created in NX10.0.0. More...
void	SetTrimmingMarkColor (NXOpen::NXColor *trimmingMarkColor)
	Sets the trimming mark color Created in NX10.0.0. More...
void	SetTrimmingMarkLength (double trimmingMarkLength)
	Sets the trimming mark length Created in NX10.0.0. More...
void	SetTrimmingMarkStyle (NXOpen::Drawings::TrimmingMarkStyleType trimmingMarkStyle)
	Sets the trimming mark style Created in NX10.0.0. More...
void	SetTrimmingMarkWidth (double trimmingMarkWidth)
	Sets the trimming mark width Created in NX10.0.0. More...
NXOpen::NXColor *	TrimmingMarkColor ()
	Returns the trimming mark color Created in NX10.0.0. More...
double	TrimmingMarkLength ()
	Returns the trimming mark length Created in NX10.0.0. More...
NXOpen::Drawings::TrimmingMarkStyleType	TrimmingMarkStyle ()
	Returns the trimming mark style Created in NX10.0.0. More...
double	TrimmingMarkWidth ()
	Returns the trimming mark width Created in NX10.0.0. 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

Represents a NXOpen::Drawings::SheetBorderSettingsBuilder .

This class queries and sets sheet border settings preferences when creating a sheet border.

Created in NX10.0.0.

Member Function Documentation

double NXOpen::Drawings::SheetBorderSettingsBuilder::ArrowAngle

(

)

Returns the arrow angle
Created in NX10.0.0.

License requirements : None

NXOpen::Drawings::ArrowDirectionType NXOpen::Drawings::SheetBorderSettingsBuilder::ArrowDirection

(

)

Returns the arrow direction
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::ArrowHeadTail

(

)

Returns the arrowhead tail
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::ArrowLength

(

)

Returns the arrow length
Created in NX10.0.0.

License requirements : None

NXOpen::Drawings::ArrowStyleType NXOpen::Drawings::SheetBorderSettingsBuilder::ArrowStyle

(

)

Returns the arrow style
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::BorderLineWidth

(

)

Returns the border line width
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarkLength

(

)

Returns the centering mark length
Created in NX10.0.0.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksColorWidth

(

)

Returns the centering marks color width
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksExtension

(

)

Returns the centering marks extension
Created in NX10.0.0.

License requirements : None

NXOpen::Drawings::HorizontalCenteringMarkType NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksHorizontal

(

)

Returns the centering marks horizontal
Created in NX10.0.0.

License requirements : None

NXOpen::Drawings::VerticalCenteringMarkType NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksVertical

(

)

Returns the centering marks vertical
Created in NX10.0.0.

License requirements : None

bool NXOpen::Drawings::SheetBorderSettingsBuilder::CreateBorders

(

)

Returns the create borders
Created in NX10.0.0.

License requirements : None

bool NXOpen::Drawings::SheetBorderSettingsBuilder::CreateTrimmingMarks

(

)

Returns the create trimming marks
Created in NX10.0.0.

License requirements : None

bool NXOpen::Drawings::SheetBorderSettingsBuilder::DisplaySheetSizeInBorder

(

)

Returns the display sheet size in border
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::DistanceFromInnerBorder

(

)

Returns the distance from inner border
Created in NX10.0.0.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Drawings::SheetBorderSettingsBuilder::InnerLineCFW

(

)

Returns the inner border line's color, font and width
Created in NX10.0.0.

License requirements : None

NXOpen::Drawings::Method NXOpen::Drawings::SheetBorderSettingsBuilder::Method

(

)

Returns the method
Created in NX10.0.0.

License requirements : None

NXOpen::LineColorFontWidthBuilder* NXOpen::Drawings::SheetBorderSettingsBuilder::OuterLineCFW

(

)

Returns the outer border line's color, font and width
Created in NX10.0.0.

License requirements : None

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetArrowAngle

(

double

arrowAngle

)

Sets the arrow angle
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

arrowAngle

arrowangle

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetArrowDirection

(

NXOpen::Drawings::ArrowDirectionType

arrowDirection

)

Sets the arrow direction
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

arrowDirection

arrowdirection

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetArrowHeadTail

(

double

arrowHeadTail

)

Sets the arrowhead tail
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

arrowHeadTail

arrowheadtail

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetArrowLength

(

double

arrowLength

)

Sets the arrow length
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

arrowLength

arrowlength

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetArrowStyle

(

NXOpen::Drawings::ArrowStyleType

arrowStyle

)

Sets the arrow style
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

arrowStyle

arrowstyle

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetBorderLineWidth

(

double

borderLineWidth

)

Sets the border line width
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

borderLineWidth

borderlinewidth

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetCenteringMarkLength

(

double

centeringMarkLength

)

Sets the centering mark length
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

centeringMarkLength

centeringmarklength

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetCenteringMarksExtension

(

double

centeringMarksExtension

)

Sets the centering marks extension
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

centeringMarksExtension

centeringmarksextension

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetCenteringMarksHorizontal

(

NXOpen::Drawings::HorizontalCenteringMarkType

centeringMarksHorizontal

)

Sets the centering marks horizontal
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

centeringMarksHorizontal

centeringmarkshorizontal

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetCenteringMarksVertical

(

NXOpen::Drawings::VerticalCenteringMarkType

centeringMarksVertical

)

Sets the centering marks vertical
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

centeringMarksVertical

centeringmarksvertical

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetCreateBorders

(

bool

createBorders

)

Sets the create borders
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

createBorders

createborders

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetCreateTrimmingMarks

(

bool

createTrimmingMarks

)

Sets the create trimming marks
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

createTrimmingMarks

createtrimmingmarks

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetDisplaySheetSizeInBorder

(

bool

displaySheetSizeInBorder

)

Sets the display sheet size in border
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

displaySheetSizeInBorder

displaysheetsizeinborder

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetDistanceFromInnerBorder

(

double

distanceInFromInnerBorder

)

Sets the distance from inner border
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

distanceInFromInnerBorder

distanceinfrominnerborder

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetMethod

(

NXOpen::Drawings::Method

method

)

Sets the method
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

method

method

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetTrimmingMarkColor

(

NXOpen::NXColor *

trimmingMarkColor

)

Sets the trimming mark color
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

trimmingMarkColor

trimmingmarkcolor

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetTrimmingMarkLength

(

double

trimmingMarkLength

)

Sets the trimming mark length
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

trimmingMarkLength

trimmingmarklength

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetTrimmingMarkStyle

(

NXOpen::Drawings::TrimmingMarkStyleType

trimmingMarkStyle

)

Sets the trimming mark style
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

trimmingMarkStyle

trimmingmarkstyle

void NXOpen::Drawings::SheetBorderSettingsBuilder::SetTrimmingMarkWidth

(

double

trimmingMarkWidth

)

Sets the trimming mark width
Created in NX10.0.0.

License requirements : drafting ("DRAFTING")

Parameters

trimmingMarkWidth

trimmingmarkwidth

NXOpen::NXColor* NXOpen::Drawings::SheetBorderSettingsBuilder::TrimmingMarkColor

(

)

Returns the trimming mark color
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::TrimmingMarkLength

(

)

Returns the trimming mark length
Created in NX10.0.0.

License requirements : None

NXOpen::Drawings::TrimmingMarkStyleType NXOpen::Drawings::SheetBorderSettingsBuilder::TrimmingMarkStyle

(

)

Returns the trimming mark style
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::SheetBorderSettingsBuilder::TrimmingMarkWidth

(

)

Returns the trimming mark width
Created in NX10.0.0.

License requirements : None

virtual bool NXOpen::Drawings::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:

• Drawings_SheetBorderSettingsBuilder.hxx