The SheetBordersAndZones builder
To create a new instance of this class, use NXOpen::Diagramming::SheetBordersAndZonesCollection::CreateSheetBordersAndZonesBuilder

Created in NX10.0.0. More...

Inheritance diagram for NXOpen::Diagramming::SheetBordersAndZonesBuilder:

Public Types
enum	ArrowDirectionType { ArrowDirectionTypeOutofSheet, ArrowDirectionTypeIntoSheet }
	Represents the arrow direction type. More...

enum	ArrowStyleType { ArrowStyleTypeFilled, ArrowStyleTypeClosed, ArrowStyleTypeClosedSolid, ArrowStyleTypeOpen }
	Represents the arrow style type. More...

enum	HorizontalCenteringMarkType { HorizontalCenteringMarkTypeNone, HorizontalCenteringMarkTypeLeftArrow, HorizontalCenteringMarkTypeRightArrow, HorizontalCenteringMarkTypeLeftandRightArrow, HorizontalCenteringMarkTypeLeftandRightLine }
	Represents the horizontal centering mark type. More...

enum	TrimmingMarkStyleType { TrimmingMarkStyleTypeTriangle, TrimmingMarkStyleTypeCorner }
	Represents the trimming mark style type. More...

enum	VerticalCenteringMarkType { VerticalCenteringMarkTypeNone, VerticalCenteringMarkTypeBottomArrow, VerticalCenteringMarkTypeTopArrow, VerticalCenteringMarkTypeBottomandTopArrow, VerticalCenteringMarkTypeBottomandTopLine }
	Represents the vertical centering mark type. More...

enum	ZoneMethod { ZoneMethodNone, ZoneMethodStandard, ZoneMethodCustom }
	Represents the zone method. More...

enum	ZoneOrigin { ZoneOriginBottomRight, ZoneOriginTopLeft, ZoneOriginTopRight, ZoneOriginBottomLeft }
	Represents the zone origin. More...

Public Member Functions
double	BottomMargin ()
	Returns the value of the margin in bottom border. More...

double	CenteringMarkExtension ()
	Returns the length of centering marks extension from inner border Created in NX10.0.0. More...

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

bool	CreateTrimmingMarks ()
	Returns the flag that indicate if trimming marks are created. More...

bool	CreateZoneLabels ()
	Returns the flag that indicates if zone labels are created. More...

bool	CreateZoneMarking ()
	Returns the flag that indicates if zone marking is create. More...

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

double	HorizontalSize ()
	Returns the size of horizontal zones. More...

int	LabelFont ()
	Returns the font of the label(text). More...

double	LabelHeight ()
	Returns the height of the label(text). More...

double	LeftMargin ()
	Returns the value of the margin in left border. More...

double	MarkingHeight ()
	Returns the height of marking. More...

NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneMethod	Method ()
	Returns the type of methods to create the zones. More...

NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneOrigin	Origin ()
	Returns the type of zone origin like TopLeft/BottomRight. More...

double	RightMargin ()
	Returns the value of the margin in right border. More...

void	SetBottomMargin (double bottomMargin)
	Sets the value of the margin in bottom border. More...

void	SetCenteringMarkExtension (double centeringMarkExtension)
	Sets the length of centering marks extension from inner border Created in NX10.0.0. More...

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

void	SetCreateTrimmingMarks (bool createTrimmingMarks)
	Sets the flag that indicate if trimming marks are created. More...

void	SetCreateZoneLabels (bool createZoneLabels)
	Sets the flag that indicates if zone labels are created. More...

void	SetCreateZoneMarking (bool createZoneMarking)
	Sets the flag that indicates if zone marking is create. More...

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

void	SetHorizontalSize (double horizontalSize)
	Sets the size of horizontal zones. More...

void	SetLabelFont (int labelFont)
	Sets the font of the label(text). More...

void	SetLabelHeight (double labelHeight)
	Sets the height of the label(text). More...

void	SetLeftMargin (double leftMargin)
	Sets the value of the margin in left border. More...

void	SetMarkingHeight (double markingHeight)
	Sets the height of marking. More...

void	SetMethod (NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneMethod method)
	Sets the type of methods to create the zones. More...

void	SetOrigin (NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneOrigin origin)
	Sets the type of zone origin like TopLeft/BottomRight. More...

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

void	SetRightMargin (double rightMargin)
	Sets the value of the margin in right border. More...

void	SetTopMargin (double topMargin)
	Sets the value of the margin in top border. More...

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

void	SetTrimmingMarkThickness (double trimmingMarkThickness)
	Sets the width of trimming mark. More...

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

void	SetVerticalSize (double verticalSize)
	Sets the size of vertical zones. More...

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

NXOpen::Diagramming::SheetBorderSettingsBuilder *	SheetBorderSettings ()
	Returns the sheet border settings builder used to get the values related to borders Created in NX11.0.1. More...

NXOpen::Diagramming::SheetMarginSettingsBuilder *	SheetMarginSettings ()
	Returns the sheet margin settings builder used to get the values related to margins Created in NX11.0.1. More...

NXOpen::Diagramming::SheetZoneSettingsBuilder *	SheetZoneSettings ()
	Returns the sheet zone settings builder used to get the values related to zones Created in NX11.0.1. More...

double	TopMargin ()
	Returns the value of the margin in top border. More...

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

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

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

double	VerticalSize ()
	Returns the size of vertical zones. More...

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

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder. More...

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder. More...

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit. More...

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder. More...

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results. 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 SheetBordersAndZones builder
To create a new instance of this class, use NXOpen::Diagramming::SheetBordersAndZonesCollection::CreateSheetBordersAndZonesBuilder

Created in NX10.0.0.

Member Enumeration Documentation

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::ArrowDirectionType

Represents the arrow direction type.

Enumerator
ArrowDirectionTypeOutofSheet	Out of Sheet.
ArrowDirectionTypeIntoSheet	into sheet

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::ArrowStyleType

Represents the arrow style type.

Enumerator
ArrowStyleTypeFilled	Filled.
ArrowStyleTypeClosed	Closed.
ArrowStyleTypeClosedSolid	Close Solid.
ArrowStyleTypeOpen	open

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::HorizontalCenteringMarkType

Represents the horizontal centering mark type.

Enumerator
HorizontalCenteringMarkTypeNone	None.
HorizontalCenteringMarkTypeLeftArrow	Left Arrow.
HorizontalCenteringMarkTypeRightArrow	Right Arrow.
HorizontalCenteringMarkTypeLeftandRightArrow	Left and Right Arrow.
HorizontalCenteringMarkTypeLeftandRightLine	leftand right line

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::TrimmingMarkStyleType

Represents the trimming mark style type.

Enumerator
TrimmingMarkStyleTypeTriangle	Triangle.
TrimmingMarkStyleTypeCorner	corner

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::VerticalCenteringMarkType

Represents the vertical centering mark type.

Enumerator
VerticalCenteringMarkTypeNone	None.
VerticalCenteringMarkTypeBottomArrow	Bottom Arrow.
VerticalCenteringMarkTypeTopArrow	Top Arrow.
VerticalCenteringMarkTypeBottomandTopArrow	Bottom and Top Arrow.
VerticalCenteringMarkTypeBottomandTopLine	bottomand top line

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneMethod

Represents the zone method.

Enumerator
ZoneMethodNone	None.
ZoneMethodStandard	Standard.
ZoneMethodCustom	custom

enum NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneOrigin

Represents the zone origin.

Enumerator
ZoneOriginBottomRight	Bottom Right.
ZoneOriginTopLeft	Top Left.
ZoneOriginTopRight	Top Right.
ZoneOriginBottomLeft	bottom left

Member Function Documentation

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::BottomMargin ( )

Returns the value of the margin in bottom border.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::CenteringMarkExtension ( )

Returns the length of centering marks extension from inner border
Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetBordersAndZonesBuilder::CreateBorders ( )

Returns the flag that indicates if borders are created.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetBordersAndZonesBuilder::CreateTrimmingMarks ( )

Returns the flag that indicate if trimming marks are created.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetBordersAndZonesBuilder::CreateZoneLabels ( )

Returns the flag that indicates if zone labels are created.

Created in NX10.0.0.

License requirements : None

bool NXOpen::Diagramming::SheetBordersAndZonesBuilder::CreateZoneMarking ( )

Returns the flag that indicates if zone marking is create.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetBordersAndZonesBuilder::HorizontalCenteringMarkType NXOpen::Diagramming::SheetBordersAndZonesBuilder::HorizontalCenteringMark ( )

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

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::HorizontalSize ( )

Returns the size of horizontal zones.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

int NXOpen::Diagramming::SheetBordersAndZonesBuilder::LabelFont ( )

Returns the font of the label(text).

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::LabelHeight ( )

Returns the height of the label(text).

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::LeftMargin ( )

Returns the value of the margin in left border.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::MarkingHeight ( )

Returns the height of marking.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneMethod NXOpen::Diagramming::SheetBordersAndZonesBuilder::Method ( )

Returns the type of methods to create the zones.

Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneOrigin NXOpen::Diagramming::SheetBordersAndZonesBuilder::Origin ( )

Returns the type of zone origin like TopLeft/BottomRight.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::RightMargin ( )

Returns the value of the margin in right border.

Created in NX10.0.0.

License requirements : None

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetBottomMargin ( double bottomMargin )

Sets the value of the margin in bottom border.

Created in NX10.0.0.

License requirements : None

Parameters

bottomMargin bottommargin

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetCenteringMarkExtension ( double centeringMarkExtension )

Sets the length of centering marks extension from inner border
Created in NX10.0.0.

License requirements : None

Parameters

centeringMarkExtension centeringmarkextension

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

Sets the flag that indicates if borders are created.

Created in NX10.0.0.

License requirements : None

Parameters

createBorders createborders

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

Sets the flag that indicate if trimming marks are created.

Created in NX10.0.0.

License requirements : None

Parameters

createTrimmingMarks createtrimmingmarks

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetCreateZoneLabels ( bool createZoneLabels )

Sets the flag that indicates if zone labels are created.

Created in NX10.0.0.

License requirements : None

Parameters

createZoneLabels createzonelabels

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetCreateZoneMarking ( bool createZoneMarking )

Sets the flag that indicates if zone marking is create.

Created in NX10.0.0.

License requirements : None

Parameters

createZoneMarking createzonemarking

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetHorizontalCenteringMark ( NXOpen::Diagramming::SheetBordersAndZonesBuilder::HorizontalCenteringMarkType horizontalCenteringMarkType )

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

Created in NX10.0.0.

License requirements : None

Parameters

horizontalCenteringMarkType horizontalcenteringmarktype

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetHorizontalSize ( double horizontalSize )

Sets the size of horizontal zones.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

horizontalSize horizontalsize

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetLabelFont ( int labelFont )

Sets the font of the label(text).

Created in NX10.0.0.

License requirements : None

Parameters

labelFont labelfont

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetLabelHeight ( double labelHeight )

Sets the height of the label(text).

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

labelHeight labelheight

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetLeftMargin ( double leftMargin )

Sets the value of the margin in left border.

Created in NX10.0.0.

License requirements : None

Parameters

leftMargin leftmargin

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetMarkingHeight ( double markingHeight )

Sets the height of marking.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

markingHeight markingheight

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetMethod ( NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneMethod method )

Sets the type of methods to create the zones.

Created in NX10.0.0.

License requirements : None

Parameters

method method

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetOrigin ( NXOpen::Diagramming::SheetBordersAndZonesBuilder::ZoneOrigin origin )

Sets the type of zone origin like TopLeft/BottomRight.

Created in NX10.0.0.

License requirements : None

Parameters

origin origin

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetOwningSheet ( NXOpen::Diagramming::Sheet * owningSheet )

Set the owning sheet when the sheet element is created.

It is not allowed to change the owning sheet when editing the borders and zones.
Created in NX10.0.0.

License requirements : None

Parameters

owningSheet owningsheet

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetRightMargin ( double rightMargin )

Sets the value of the margin in right border.

Created in NX10.0.0.

License requirements : None

Parameters

rightMargin rightmargin

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetTopMargin ( double topMargin )

Sets the value of the margin in top border.

Created in NX10.0.0.

License requirements : None

Parameters

topMargin topmargin

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

Sets the length of trimming mark.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

trimmingMarkLength trimmingmarklength

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetTrimmingMarkThickness ( double trimmingMarkThickness )

Sets the width of trimming mark.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

trimmingMarkThickness trimmingmarkthickness

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetVerticalCenteringMark ( NXOpen::Diagramming::SheetBordersAndZonesBuilder::VerticalCenteringMarkType verticalCenteringMark )

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

Created in NX10.0.0.

License requirements : None

Parameters

verticalCenteringMark verticalcenteringmark

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetVerticalSize ( double verticalSize )

Sets the size of vertical zones.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

verticalSize verticalsize

void NXOpen::Diagramming::SheetBordersAndZonesBuilder::SetWidth ( double width )

Sets the width of border.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

Parameters

width width

NXOpen::Diagramming::SheetBorderSettingsBuilder* NXOpen::Diagramming::SheetBordersAndZonesBuilder::SheetBorderSettings ( )

Returns the sheet border settings builder used to get the values related to borders
Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::SheetMarginSettingsBuilder* NXOpen::Diagramming::SheetBordersAndZonesBuilder::SheetMarginSettings ( )

Returns the sheet margin settings builder used to get the values related to margins
Created in NX11.0.1.

License requirements : None

NXOpen::Diagramming::SheetZoneSettingsBuilder* NXOpen::Diagramming::SheetBordersAndZonesBuilder::SheetZoneSettings ( )

Returns the sheet zone settings builder used to get the values related to zones
Created in NX11.0.1.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::TopMargin ( )

Returns the value of the margin in top border.

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::TrimmingMarkLength ( )

Returns the length of trimming mark.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::TrimmingMarkThickness ( )

Returns the width of trimming mark.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

NXOpen::Diagramming::SheetBordersAndZonesBuilder::VerticalCenteringMarkType NXOpen::Diagramming::SheetBordersAndZonesBuilder::VerticalCenteringMark ( )

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

Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::VerticalSize ( )

Returns the size of vertical zones.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

double NXOpen::Diagramming::SheetBordersAndZonesBuilder::Width ( )

Returns the width of border.

It should be greater than zero.
Created in NX10.0.0.

License requirements : None

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

Diagramming_SheetBordersAndZonesBuilder.hxx

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation