SheetBordersAndZonesBuilder Class

class NXOpen.Diagramming.SheetBordersAndZonesBuilder

Bases: NXOpen.Builder

Represents Sheet Borders and Zones builder.

It creates and redefines borders and zones. To create a new instance of this class, use NXOpen.Diagramming.SheetBordersAndZonesCollection.CreateSheetBordersAndZonesBuilder()

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)

New in version NX10.0.0.

Properties

Property	Description
BottomMargin	Returns or sets the bottom margin.
CenteringMarkExtension	Returns or sets the centering mark extension.
CreateBorders	Returns or sets the flag that indicates if borders are created.
CreateTrimmingMarks	Returns or sets the flag that indicate if trimming marks are created.
CreateZoneLabels	Returns or sets the flag that indicates if zone labels are created.
CreateZoneMarking	Returns or sets the flag that indicates if zone marking is create.
HorizontalCenteringMark	Returns or sets the horizontal centering mark type.
HorizontalSize	Returns or sets the horizontal size of zones.
LabelFont	Returns or sets the label font.
LabelHeight	Returns or sets the label height.
LeftMargin	Returns or sets the left margin.
MarkingHeight	Returns or sets the marking height.
Method	Returns or sets the zones creation method.
Origin	Returns or sets the zone origin.
RightMargin	Returns or sets the right margin.
Tag	Returns the Tag for this object.
TopMargin	Returns or sets the top margin.
TrimmingMarkLength	Returns or sets the trimming mark length.
TrimmingMarkThickness	Returns or sets the trimming mark thickness.
VerticalCenteringMark	Returns or sets the vertical centering mark type.
VerticalSize	Returns or sets the vertical size of zones.
Width	Returns or sets the width of border.

Methods

Method	Description
Commit	Commits any edits that have been applied to the builder.
Destroy	Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects	For builders that create more than one object, this method returns the objects that are created by commit.
GetObject	Returns the object currently being edited by this builder.
SetOwningSheet	Set the owning sheet when the sheet element is created.
ShowResults	Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate	Validate whether the inputs to the component are sufficient for commit to be called.

Enumerations

SheetBordersAndZonesBuilderArrowDirectionType Enumeration	Represents the arrow direction type
SheetBordersAndZonesBuilderArrowStyleType Enumeration	Represents the arrow style type
SheetBordersAndZonesBuilderHorizontalCenteringMarkType Enumeration	Represents the horizontal centering mark type.
SheetBordersAndZonesBuilderTrimmingMarkStyleType Enumeration	Represents the trimming mark style type
SheetBordersAndZonesBuilderVerticalCenteringMarkType Enumeration	Represents the vertical centering mark type.
SheetBordersAndZonesBuilderZoneMethod Enumeration	Represents the zone method.
SheetBordersAndZonesBuilderZoneOrigin Enumeration	Represents the zone origin.

Property Detail

BottomMargin

SheetBordersAndZonesBuilder.BottomMargin

Returns or sets the bottom margin.

It should be non-negative.

-------------------------------------

Getter Method

Signature BottomMargin()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature BottomMargin(bottomMargin)

Parameters:bottomMargin (float) –

New in version NX10.0.0.

License requirements: None.

CenteringMarkExtension

SheetBordersAndZonesBuilder.CenteringMarkExtension

Returns or sets the centering mark extension.

It should be non-negative.

-------------------------------------

Getter Method

Signature CenteringMarkExtension()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CenteringMarkExtension(centeringMarkExtension)

Parameters:centeringMarkExtension (float) –

New in version NX10.0.0.

License requirements: None.

CreateBorders

SheetBordersAndZonesBuilder.CreateBorders

Returns or sets the flag that indicates if borders are created.

-------------------------------------

Getter Method

Signature CreateBorders()

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateBorders(createBorders)

Parameters:createBorders (bool) –

New in version NX10.0.0.

License requirements: None.

CreateTrimmingMarks

SheetBordersAndZonesBuilder.CreateTrimmingMarks

Returns or sets the flag that indicate if trimming marks are created.

-------------------------------------

Getter Method

Signature CreateTrimmingMarks()

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateTrimmingMarks(createTrimmingMarks)

Parameters:createTrimmingMarks (bool) –

New in version NX10.0.0.

License requirements: None.

CreateZoneLabels

SheetBordersAndZonesBuilder.CreateZoneLabels

Returns or sets the flag that indicates if zone labels are created.

-------------------------------------

Getter Method

Signature CreateZoneLabels()

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateZoneLabels(createZoneLabels)

Parameters:createZoneLabels (bool) –

New in version NX10.0.0.

License requirements: None.

CreateZoneMarking

SheetBordersAndZonesBuilder.CreateZoneMarking

Returns or sets the flag that indicates if zone marking is create.

-------------------------------------

Getter Method

Signature CreateZoneMarking()

Returns: Return type:bool

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature CreateZoneMarking(createZoneMarking)

Parameters:createZoneMarking (bool) –

New in version NX10.0.0.

License requirements: None.

HorizontalCenteringMark

SheetBordersAndZonesBuilder.HorizontalCenteringMark

Returns or sets the horizontal centering mark type.

-------------------------------------

Getter Method

Signature HorizontalCenteringMark()

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderHorizontalCenteringMarkType

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HorizontalCenteringMark(horizontalCenteringMarkType)

Parameters:horizontalCenteringMarkType (NXOpen.Diagramming.SheetBordersAndZonesBuilderHorizontalCenteringMarkType) –

New in version NX10.0.0.

License requirements: None.

HorizontalSize

SheetBordersAndZonesBuilder.HorizontalSize

Returns or sets the horizontal size of zones.

It should be greater than zero.

-------------------------------------

Getter Method

Signature HorizontalSize()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature HorizontalSize(horizontalSize)

Parameters:horizontalSize (float) –

New in version NX10.0.0.

License requirements: None.

LabelFont

SheetBordersAndZonesBuilder.LabelFont

Returns or sets the label font.

-------------------------------------

Getter Method

Signature LabelFont()

Returns: Return type:int

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelFont(labelFont)

Parameters:labelFont (int) –

New in version NX10.0.0.

License requirements: None.

LabelHeight

SheetBordersAndZonesBuilder.LabelHeight

Returns or sets the label height.

It should be greater than zero.

-------------------------------------

Getter Method

Signature LabelHeight()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LabelHeight(labelHeight)

Parameters:labelHeight (float) –

New in version NX10.0.0.

License requirements: None.

LeftMargin

SheetBordersAndZonesBuilder.LeftMargin

Returns or sets the left margin.

It should be non-negative.

-------------------------------------

Getter Method

Signature LeftMargin()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature LeftMargin(leftMargin)

Parameters:leftMargin (float) –

New in version NX10.0.0.

License requirements: None.

MarkingHeight

SheetBordersAndZonesBuilder.MarkingHeight

Returns or sets the marking height.

It should be non-negative.

-------------------------------------

Getter Method

Signature MarkingHeight()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature MarkingHeight(markingHeight)

Parameters:markingHeight (float) –

New in version NX10.0.0.

License requirements: None.

Method

SheetBordersAndZonesBuilder.Method

Returns or sets the zones creation method.

-------------------------------------

Getter Method

Signature Method()

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneMethod

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Method(method)

Parameters:method (NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneMethod) –

New in version NX10.0.0.

License requirements: None.

Origin

SheetBordersAndZonesBuilder.Origin

Returns or sets the zone origin.

-------------------------------------

Getter Method

Signature Origin()

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneOrigin

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Origin(origin)

Parameters:origin (NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneOrigin) –

New in version NX10.0.0.

License requirements: None.

RightMargin

SheetBordersAndZonesBuilder.RightMargin

Returns or sets the right margin.

It should be non-negative.

-------------------------------------

Getter Method

Signature RightMargin()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature RightMargin(rightMargin)

Parameters:rightMargin (float) –

New in version NX10.0.0.

License requirements: None.

TopMargin

SheetBordersAndZonesBuilder.TopMargin

Returns or sets the top margin.

It should be non-negative.

-------------------------------------

Getter Method

Signature TopMargin()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TopMargin(topMargin)

Parameters:topMargin (float) –

New in version NX10.0.0.

License requirements: None.

TrimmingMarkLength

SheetBordersAndZonesBuilder.TrimmingMarkLength

Returns or sets the trimming mark length.

It should be non-negative.

-------------------------------------

Getter Method

Signature TrimmingMarkLength()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimmingMarkLength(trimmingMarkLength)

Parameters:trimmingMarkLength (float) –

New in version NX10.0.0.

License requirements: None.

TrimmingMarkThickness

SheetBordersAndZonesBuilder.TrimmingMarkThickness

Returns or sets the trimming mark thickness.

It should be non-negative.

-------------------------------------

Getter Method

Signature TrimmingMarkThickness()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature TrimmingMarkThickness(trimmingMarkThickness)

Parameters:trimmingMarkThickness (float) –

New in version NX10.0.0.

License requirements: None.

VerticalCenteringMark

SheetBordersAndZonesBuilder.VerticalCenteringMark

Returns or sets the vertical centering mark type.

-------------------------------------

Getter Method

Signature VerticalCenteringMark()

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderVerticalCenteringMarkType

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature VerticalCenteringMark(verticalCenteringMark)

Parameters:verticalCenteringMark (NXOpen.Diagramming.SheetBordersAndZonesBuilderVerticalCenteringMarkType) –

New in version NX10.0.0.

License requirements: None.

VerticalSize

SheetBordersAndZonesBuilder.VerticalSize

Returns or sets the vertical size of zones.

It should be greater than zero.

-------------------------------------

Getter Method

Signature VerticalSize()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature VerticalSize(verticalSize)

Parameters:verticalSize (float) –

New in version NX10.0.0.

License requirements: None.

Width

SheetBordersAndZonesBuilder.Width

Returns or sets the width of border.

It should be non-negative.

-------------------------------------

Getter Method

Signature Width()

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

-------------------------------------

Setter Method

Signature Width(width)

Parameters:width (float) –

New in version NX10.0.0.

License requirements: None.

Method Detail

SetOwningSheet

SheetBordersAndZonesBuilder.SetOwningSheet

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.

Signature SetOwningSheet(owningSheet)

Parameters:owningSheet (NXOpen.Diagramming.Sheet) –

New in version NX10.0.0.

License requirements: None.

Validate

SheetBordersAndZonesBuilder.Validate

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.

Signature Validate()

Returns:Was self validation successful Return type:bool

New in version NX3.0.1.

License requirements: None.