NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::Drawings::BordersAndZonesBuilder Class Reference

Builder for creating Borders and Zones. More...

Inheritance diagram for NXOpen::Drawings::BordersAndZonesBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

List of all members.

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

double BottomMargin ()
 Returns the bottom margin
Created in NX8.0.0.
double CenteringMarkExtension ()
 Returns the centering mark extension
Created in NX8.0.0.
bool CreateBorders ()
 Returns the create borders
Created in NX8.0.0.
bool CreateTrimmingMarks ()
 Returns the create trimming marks
Created in NX8.0.0.
bool CreateZoneLabels ()
 Returns the create zone labels
Created in NX8.0.0.
bool CreateZoneMarking ()
 Returns the create zone marking
Created in NX8.0.0.
NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType HorizontalCenteringMark ()
 Returns the horizontal centering mark
Created in NX8.0.0.
double HorizontalSize ()
 Returns the horizontal size of the zones
Created in NX8.0.0.
int LabelFont ()
 Returns the label font
Created in NX8.0.0.
double LabelHeight ()
 Returns the label height
Created in NX8.0.0.
double LeftMargin ()
 Returns the left margin
Created in NX8.0.0.
double MarkingHeight ()
 Returns the marking height
Created in NX8.0.0.
NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod Method ()
 Returns the method of creation of zones
Created in NX8.0.0.
NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin Origin ()
 Returns the zone origin type
Created in NX8.0.0.
double RightMargin ()
 Returns the right margin
Created in NX8.0.0.
void SetBottomMargin (double bottomMargin)
 Sets the bottom margin
Created in NX8.0.0.
void SetCenteringMarkExtension (double centeringMarkExtension)
 Sets the centering mark extension
Created in NX8.0.0.
void SetCreateBorders (bool createBorders)
 Sets the create borders
Created in NX8.0.0.
void SetCreateTrimmingMarks (bool createTrimmingMarks)
 Sets the create trimming marks
Created in NX8.0.0.
void SetCreateZoneLabels (bool createZoneLabels)
 Sets the create zone labels
Created in NX8.0.0.
void SetCreateZoneMarking (bool createZoneMarking)
 Sets the create zone marking
Created in NX8.0.0.
void SetHorizontalCenteringMark (NXOpen::Drawings::BordersAndZonesBuilder::HorizontalCenteringMarkType horizontalCenteringMark)
 Sets the horizontal centering mark
Created in NX8.0.0.
void SetHorizontalSize (double horizontalSize)
 Sets the horizontal size of the zones
Created in NX8.0.0.
void SetLabelFont (int labelFont)
 Sets the label font
Created in NX8.0.0.
void SetLabelHeight (double labelHeight)
 Sets the label height
Created in NX8.0.0.
void SetLeftMargin (double leftMargin)
 Sets the left margin
Created in NX8.0.0.
void SetMarkingHeight (double markingHeight)
 Sets the marking height
Created in NX8.0.0.
void SetMethod (NXOpen::Drawings::BordersAndZonesBuilder::ZoneMethod method)
 Sets the method of creation of zones
Created in NX8.0.0.
void SetOrigin (NXOpen::Drawings::BordersAndZonesBuilder::ZoneOrigin origin)
 Sets the zone origin type
Created in NX8.0.0.
void SetRightMargin (double rightMargin)
 Sets the right margin
Created in NX8.0.0.
void SetTopMargin (double topMargin)
 Sets the top margin
Created in NX8.0.0.
void SetTrimmingMarkLength (double trimmingMarkLength)
 Sets the trimming mark length
Created in NX8.0.0.
void SetTrimmingMarkThickness (double trimmingMarkThickness)
 Sets the trimming mark thickness
Created in NX8.0.0.
void SetVerticalCenteringMark (NXOpen::Drawings::BordersAndZonesBuilder::VerticalCenteringMarkType verticalCenteringMark)
 Sets the vertical centering mark
Created in NX8.0.0.
void SetVerticalSize (double verticalSize)
 Sets the vertical size of the zones
Created in NX8.0.0.
void SetWidth (double width)
 Sets the width of the border
Created in NX8.0.0.
double TopMargin ()
 Returns the top margin
Created in NX8.0.0.
double TrimmingMarkLength ()
 Returns the trimming mark length
Created in NX8.0.0.
double TrimmingMarkThickness ()
 Returns the trimming mark thickness
Created in NX8.0.0.
NXOpen::Drawings::BordersAndZonesBuilder::VerticalCenteringMarkType VerticalCenteringMark ()
 Returns the vertical centering mark
Created in NX8.0.0.
double VerticalSize ()
 Returns the vertical size of the zones
Created in NX8.0.0.
double Width ()
 Returns the width of the border
Created in NX8.0.0.

Detailed Description

Builder for creating Borders and Zones.

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

Property Value

BottomMargin

0 (millimeters part), 0 (inches part)

CenteringMarkExtension

5 (millimeters part), 0.25 (inches part)

CreateBorders

1

CreateTrimmingMarks

1

CreateZoneLabels

1

CreateZoneMarking

1

HorizontalCenteringMark

None

HorizontalSize

50 (millimeters part), 2.5 (inches part)

LabelFont

0

LabelHeight

3.5 (millimeters part), 0.125 (inches part)

LeftMargin

0 (millimeters part), 0 (inches part)

MarkingHeight

10 (millimeters part), 0.375 (inches part)

Method

Standard

Origin

TopLeft

RightMargin

0 (millimeters part), 0 (inches part)

TopMargin

0 (millimeters part), 0 (inches part)

TrimmingMarkLength

10 (millimeters part), 0.5 (inches part)

TrimmingMarkThickness

5 (millimeters part), 0.25 (inches part)

VerticalCenteringMark

None

VerticalSize

50 (millimeters part), 2.5 (inches part)

Width

10 (millimeters part), 0.375 (inches part)


Created in NX8.0.0.


Member Enumeration Documentation

the font

Enumerator:
FontEnumBlockfont 

blockfont

the horizontal centering mark type

Enumerator:
HorizontalCenteringMarkTypeNone 

None.

HorizontalCenteringMarkTypeLeftArrow 

Left Arrow.

HorizontalCenteringMarkTypeRightArrow 

Right Arrow.

HorizontalCenteringMarkTypeLeftandRightArrow 

Left and Right Arrow.

HorizontalCenteringMarkTypeLeftandRightLine 

leftand right line

the vertical centering mark type

Enumerator:
VerticalCenteringMarkTypeNone 

None.

VerticalCenteringMarkTypeBottomArrow 

Bottom Arrow.

VerticalCenteringMarkTypeTopArrow 

Top Arrow.

VerticalCenteringMarkTypeBottomandTopArrow 

Bottom and Top Arrow.

VerticalCenteringMarkTypeBottomandTopLine 

bottomand top line

the zone method

Enumerator:
ZoneMethodNone 

None.

ZoneMethodStandard 

Standard.

ZoneMethodCustom 

custom

the zone origin

Enumerator:
ZoneOriginBottomRight 

Bottom Right.

ZoneOriginTopLeft 

Top Left.

ZoneOriginTopRight 

Top Right.

ZoneOriginBottomLeft 

bottom left


Member Function Documentation

Returns the bottom margin
Created in NX8.0.0.



License requirements : None

Returns the centering mark extension
Created in NX8.0.0.



License requirements : None

Returns the create borders
Created in NX8.0.0.



License requirements : None

Returns the create trimming marks
Created in NX8.0.0.



License requirements : None

Returns the create zone labels
Created in NX8.0.0.



License requirements : None

Returns the create zone marking
Created in NX8.0.0.



License requirements : None

Returns the horizontal centering mark
Created in NX8.0.0.



License requirements : None

Returns the horizontal size of the zones
Created in NX8.0.0.



License requirements : None

Returns the label font
Created in NX8.0.0.



License requirements : None

Returns the label height
Created in NX8.0.0.



License requirements : None

Returns the left margin
Created in NX8.0.0.



License requirements : None

Returns the marking height
Created in NX8.0.0.



License requirements : None

Returns the method of creation of zones
Created in NX8.0.0.



License requirements : None

Returns the zone origin type
Created in NX8.0.0.



License requirements : None

Returns the right margin
Created in NX8.0.0.



License requirements : None

Sets the bottom margin
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
bottomMarginbottommargin

Sets the centering mark extension
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
centeringMarkExtensioncenteringmarkextension

Sets the create borders
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
createBorderscreateborders

Sets the create trimming marks
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
createTrimmingMarkscreatetrimmingmarks

Sets the create zone labels
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
createZoneLabelscreatezonelabels

Sets the create zone marking
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
createZoneMarkingcreatezonemarking

Sets the horizontal centering mark
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
horizontalCenteringMarkhorizontalcenteringmark

Sets the horizontal size of the zones
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
horizontalSizehorizontalsize

Sets the label font
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
labelFontlabelfont

Sets the label height
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
labelHeightlabelheight

Sets the left margin
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
leftMarginleftmargin

Sets the marking height
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
markingHeightmarkingheight

Sets the method of creation of zones
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
methodmethod

Sets the zone origin type
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
originorigin

Sets the right margin
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
rightMarginrightmargin

Sets the top margin
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
topMargintopmargin

Sets the trimming mark length
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
trimmingMarkLengthtrimmingmarklength

Sets the trimming mark thickness
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
trimmingMarkThicknesstrimmingmarkthickness

Sets the vertical centering mark
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
verticalCenteringMarkverticalcenteringmark

Sets the vertical size of the zones
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
verticalSizeverticalsize

Sets the width of the border
Created in NX8.0.0.



License requirements : drafting ("DRAFTING")

Parameters:
widthwidth

Returns the top margin
Created in NX8.0.0.



License requirements : None

Returns the trimming mark length
Created in NX8.0.0.



License requirements : None

Returns the trimming mark thickness
Created in NX8.0.0.



License requirements : None

Returns the vertical centering mark
Created in NX8.0.0.



License requirements : None

Returns the vertical size of the zones
Created in NX8.0.0.



License requirements : None

Returns the width of the border
Created in NX8.0.0.



License requirements : None


The documentation for this class was generated from the following file:
Copyright 2011 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.