Builder for creating Borders and Zones. More...

Inheritance diagram for NXOpen::Drawings::BordersAndZonesBuilder:

Public Types
enum	FontEnum { FontEnumBlockfont }
	the font More...

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

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

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

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

Public Member Functions
NXOpen::Drawings::BorderAndZoneStyleBuilder *	BorderAndZoneStyle ()
	Returns the border and zone style builder Created in NX10.0.0. More...

double	BottomMargin ()
	Returns the bottom margin More...

double	CenteringMarkExtension ()
	Returns the centering mark extension More...

bool	CreateBorders ()
	Returns the create borders More...

bool	CreateTrimmingMarks ()
	Returns the create trimming marks More...

bool	CreateZoneLabels ()
	Returns the create zone labels More...

bool	CreateZoneMarking ()
	Returns the create zone marking More...

NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType	HorizontalCenteringMark ()
	Returns the horizontal centering mark More...

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

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

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

double	LeftMargin ()
	Returns the left margin More...

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

NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod	Method ()
	Returns the method of creation of zones More...

NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin	Origin ()
	Returns the zone origin type More...

double	RightMargin ()
	Returns the right margin More...

void	SetBottomMargin (double bottomMargin)
	Sets the bottom margin More...

void	SetCenteringMarkExtension (double centeringMarkExtension)
	Sets the centering mark extension More...

void	SetCreateBorders (bool createBorders)
	Sets the create borders More...

void	SetCreateTrimmingMarks (bool createTrimmingMarks)
	Sets the create trimming marks More...

void	SetCreateZoneLabels (bool createZoneLabels)
	Sets the create zone labels More...

void	SetCreateZoneMarking (bool createZoneMarking)
	Sets the create zone marking More...

void	SetHorizontalCenteringMark (NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType horizontalCenteringMark)
	Sets the horizontal centering mark More...

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

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

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

void	SetLeftMargin (double leftMargin)
	Sets the left margin More...

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

void	SetMethod (NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod method)
	Sets the method of creation of zones More...

void	SetOrigin (NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin origin)
	Sets the zone origin type More...

void	SetRightMargin (double rightMargin)
	Sets the right margin More...

void	SetTopMargin (double topMargin)
	Sets the top margin More...

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

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

void	SetVerticalCenteringMark (NXOpen::Drawings::BordersAndZonesBuilder::VerticalCenteringMarkType verticalCenteringMark)
	Sets the vertical centering mark More...

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

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

double	TopMargin ()
	Returns the top margin More...

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

double	TrimmingMarkThickness ()
	Returns the trimming mark thickness More...

NXOpen::Drawings::BordersAndZonesBuilder::VerticalCenteringMarkType	VerticalCenteringMark ()
	Returns the vertical centering mark More...

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

double	Width ()
	Returns the width of the 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

Builder for creating Borders and Zones.

It creates and redefines borders and zones.
To create a new instance of this class, use NXOpen::Drawings::BordersAndZonesCollection::CreateBordersAndZonesBuilder
Default values.

Property

Value

BottomMargin (deprecated)

0 (millimeters part), 0 (inches part)

CenteringMarkExtension (deprecated)

5 (millimeters part), 0.25 (inches part)

CreateBorders (deprecated)

1

CreateTrimmingMarks (deprecated)

1

CreateZoneLabels (deprecated)

1

CreateZoneMarking (deprecated)

1

HorizontalCenteringMark (deprecated)

None

HorizontalSize (deprecated)

50 (millimeters part), 2.5 (inches part)

LabelFont (deprecated)

0

LabelHeight (deprecated)

3.5 (millimeters part), 0.125 (inches part)

LeftMargin (deprecated)

0 (millimeters part), 0 (inches part)

MarkingHeight (deprecated)

10 (millimeters part), 0.375 (inches part)

Method (deprecated)

Standard

Origin (deprecated)

TopLeft

RightMargin (deprecated)

0 (millimeters part), 0 (inches part)

TopMargin (deprecated)

0 (millimeters part), 0 (inches part)

TrimmingMarkLength (deprecated)

10 (millimeters part), 0.5 (inches part)

TrimmingMarkThickness (deprecated)

5 (millimeters part), 0.25 (inches part)

VerticalCenteringMark (deprecated)

None

VerticalSize (deprecated)

50 (millimeters part), 2.5 (inches part)

Width (deprecated)

10 (millimeters part), 0.375 (inches part)

Created in NX8.0.0.

Member Enumeration Documentation

enum NXOpen::Drawings::BordersAndZonesBuilder::FontEnum

the font

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::FontEnum instead.

Enumerator
FontEnumBlockfont	blockfont

enum NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType

the horizontal centering mark type

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::HorizontalCenteringMarkType instead.

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

enum NXOpen::Drawings::BordersAndZonesBuilder::VerticalCenteringMarkType

the vertical centering mark type

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::VerticalCenteringMarkType instead.

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

enum NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod

the zone method

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::Method instead.

Enumerator
ZoneMethodNone	None.
ZoneMethodStandard	Standard.
ZoneMethodCustom	custom

enum NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin

the zone origin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::ZoneOrigin instead.

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

Member Function Documentation

NXOpen::Drawings::BorderAndZoneStyleBuilder* NXOpen::Drawings::BordersAndZonesBuilder::BorderAndZoneStyle ( )

Returns the border and zone style builder
Created in NX10.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::BottomMargin ( )

Returns the bottom margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::BottomTrimmedMargin instead.

Created in NX8.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::CenteringMarkExtension ( )

Returns the centering mark extension

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksExtension instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Drawings::BordersAndZonesBuilder::CreateBorders ( )

Returns the create borders

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CreateBorders instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Drawings::BordersAndZonesBuilder::CreateTrimmingMarks ( )

Returns the create trimming marks

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CreateTrimmingMarks instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Drawings::BordersAndZonesBuilder::CreateZoneLabels ( )

Returns the create zone labels

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::CreateZoneLabels instead.

Created in NX8.0.0.

License requirements : None

bool NXOpen::Drawings::BordersAndZonesBuilder::CreateZoneMarking ( )

Returns the create zone marking

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::CreateZoneMarkings instead.

Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMark ( )

Returns the horizontal centering mark

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksHorizontal instead.

Created in NX8.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::HorizontalSize ( )

Returns the horizontal size of the zones

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::HorizontalSize instead.

Created in NX8.0.0.

License requirements : None

int NXOpen::Drawings::BordersAndZonesBuilder::LabelFont ( )

Returns the label font

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::LabelFont instead.

Created in NX8.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::LabelHeight ( )

Returns the label height

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::LabelHeight instead.

Created in NX8.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::LeftMargin ( )

Returns the left margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::LeftTrimmedMargin instead.

Created in NX8.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::MarkingHeight ( )

Returns the marking height

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::MarkingHeight instead.

Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod NXOpen::Drawings::BordersAndZonesBuilder::Method ( )

Returns the method of creation of zones

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::Method instead.

Created in NX8.0.0.

License requirements : None

NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin NXOpen::Drawings::BordersAndZonesBuilder::Origin ( )

Returns the zone origin type

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::Origin instead.

Created in NX8.0.0.

License requirements : None

double NXOpen::Drawings::BordersAndZonesBuilder::RightMargin ( )

Returns the right margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::RightTrimmedMargin instead.

Created in NX8.0.0.

License requirements : None

void NXOpen::Drawings::BordersAndZonesBuilder::SetBottomMargin ( double bottomMargin )

Sets the bottom margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::BottomTrimmedMargin instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

bottomMargin bottommargin

void NXOpen::Drawings::BordersAndZonesBuilder::SetCenteringMarkExtension ( double centeringMarkExtension )

Sets the centering mark extension

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksExtension instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

centeringMarkExtension centeringmarkextension

void NXOpen::Drawings::BordersAndZonesBuilder::SetCreateBorders ( bool createBorders )

Sets the create borders

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CreateBorders instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

createBorders createborders

void NXOpen::Drawings::BordersAndZonesBuilder::SetCreateTrimmingMarks ( bool createTrimmingMarks )

Sets the create trimming marks

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CreateTrimmingMarks instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

createTrimmingMarks createtrimmingmarks

void NXOpen::Drawings::BordersAndZonesBuilder::SetCreateZoneLabels ( bool createZoneLabels )

Sets the create zone labels

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::CreateZoneLabels instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

createZoneLabels createzonelabels

void NXOpen::Drawings::BordersAndZonesBuilder::SetCreateZoneMarking ( bool createZoneMarking )

Sets the create zone marking

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::CreateZoneMarkings instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

createZoneMarking createzonemarking

void NXOpen::Drawings::BordersAndZonesBuilder::SetHorizontalCenteringMark ( NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType horizontalCenteringMark )

Sets the horizontal centering mark

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::CenteringMarksHorizontal instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

horizontalCenteringMark horizontalcenteringmark

void NXOpen::Drawings::BordersAndZonesBuilder::SetHorizontalSize ( double horizontalSize )

Sets the horizontal size of the zones

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::HorizontalSize instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

horizontalSize horizontalsize

void NXOpen::Drawings::BordersAndZonesBuilder::SetLabelFont ( int labelFont )

Sets the label font

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::LabelFont instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelFont labelfont

void NXOpen::Drawings::BordersAndZonesBuilder::SetLabelHeight ( double labelHeight )

Sets the label height

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::LabelHeight instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

labelHeight labelheight

void NXOpen::Drawings::BordersAndZonesBuilder::SetLeftMargin ( double leftMargin )

Sets the left margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::LeftTrimmedMargin instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

leftMargin leftmargin

void NXOpen::Drawings::BordersAndZonesBuilder::SetMarkingHeight ( double markingHeight )

Sets the marking height

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::MarkingHeight instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

markingHeight markingheight

void NXOpen::Drawings::BordersAndZonesBuilder::SetMethod ( NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod method )

Sets the method of creation of zones

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::Method instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

method method

void NXOpen::Drawings::BordersAndZonesBuilder::SetOrigin ( NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin origin )

Sets the zone origin type

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetZoneSettingsBuilder::Origin instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

origin origin

void NXOpen::Drawings::BordersAndZonesBuilder::SetRightMargin ( double rightMargin )

Sets the right margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::RightTrimmedMargin instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

rightMargin rightmargin

void NXOpen::Drawings::BordersAndZonesBuilder::SetTopMargin ( double topMargin )

Sets the top margin

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetMarginSettingsBuilder::TopTrimmedMargin instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

topMargin topmargin

void NXOpen::Drawings::BordersAndZonesBuilder::SetTrimmingMarkLength ( double trimmingMarkLength )

Sets the trimming mark length

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::TrimmingMarkLength instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

trimmingMarkLength trimmingmarklength

void NXOpen::Drawings::BordersAndZonesBuilder::SetTrimmingMarkThickness ( double trimmingMarkThickness )

Sets the trimming mark thickness

Deprecated:: Deprecated in NX10.0.0.

Use NXOpen::Drawings::SheetBorderSettingsBuilder::TrimmingMarkWidth instead.

Created in NX8.0.0.

License requirements : drafting ("DRAFTING")

Parameters

trimmingMarkThickness trimmingmarkthickness

void NXOpen::Drawings::BordersAndZonesBuilder::SetVerticalCenteringMark ( NXOpen::Drawings::BordersAndZonesBuilder::VerticalCenteringMarkType verticalCenteringMark )

Sets the vertical centering mark