SheetBordersAndZonesBuilder Class

class NXOpen.Diagramming.SheetBordersAndZonesBuilder

Bases: NXOpen.Builder

The SheetBordersAndZones builder

To create a new instance of this class, use NXOpen.Diagramming.SheetBordersAndZonesCollection.CreateSheetBordersAndZonesBuilder()

New in version NX10.0.0.

Properties

Property	Description
BottomMargin	Returns or sets the value of the margin in bottom border.
CenteringMarkExtension	Returns or sets the length of centering marks extension from inner border
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 used to show the type of centering mark like LeftArrow/RightArrow.
HorizontalSize	Returns or sets the size of horizontal zones.
LabelFont	Returns or sets the font of the label(text).
LabelHeight	Returns or sets the height of the label(text).
LeftMargin	Returns or sets the value of the margin in left border.
MarkingHeight	Returns or sets the height of marking.
Method	Returns or sets the type of methods to create the zones.
Origin	Returns or sets the type of zone origin like TopLeft/BottomRight.
RightMargin	Returns or sets the value of the margin in right border.
SheetBorderSettings	Returns the sheet border settings builder used to get the values related to borders
SheetMarginSettings	Returns the sheet margin settings builder used to get the values related to margins
SheetZoneSettings	Returns the sheet zone settings builder used to get the values related to zones
Tag	Returns the Tag for this object.
TopMargin	Returns or sets the value of the margin in top border.
TrimmingMarkLength	Returns or sets the length of trimming mark.
TrimmingMarkThickness	Returns or sets the width of trimming mark.
VerticalCenteringMark	Returns or sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.
VerticalSize	Returns or sets the size of vertical 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 value of the margin in bottom border.

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

Getter Method

Signature BottomMargin

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature BottomMargin

Parameters:bottomMargin (float) –

New in version NX10.0.0.

License requirements: None.

CenteringMarkExtension

SheetBordersAndZonesBuilder.CenteringMarkExtension

Returns or sets the length of centering marks extension from inner border

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

Getter Method

Signature CenteringMarkExtension

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature 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

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

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

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

Parameters:createZoneMarking (bool) –

New in version NX10.0.0.

License requirements: None.

HorizontalCenteringMark

SheetBordersAndZonesBuilder.HorizontalCenteringMark

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

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

Getter Method

Signature HorizontalCenteringMark

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderHorizontalCenteringMarkType

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature HorizontalCenteringMark

Parameters:horizontalCenteringMarkType (NXOpen.Diagramming.SheetBordersAndZonesBuilderHorizontalCenteringMarkType) –

New in version NX10.0.0.

License requirements: None.

HorizontalSize

SheetBordersAndZonesBuilder.HorizontalSize

Returns or sets the size of horizontal 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

Parameters:horizontalSize (float) –

New in version NX10.0.0.

License requirements: None.

LabelFont

SheetBordersAndZonesBuilder.LabelFont

Returns or sets the font of the label(text).

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

Getter Method

Signature LabelFont

Returns: Return type:int

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature LabelFont

Parameters:labelFont (int) –

New in version NX10.0.0.

License requirements: None.

LabelHeight

SheetBordersAndZonesBuilder.LabelHeight

Returns or sets the height of the label(text).

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

Parameters:labelHeight (float) –

New in version NX10.0.0.

License requirements: None.

LeftMargin

SheetBordersAndZonesBuilder.LeftMargin

Returns or sets the value of the margin in left border.

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

Getter Method

Signature LeftMargin

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature LeftMargin

Parameters:leftMargin (float) –

New in version NX10.0.0.

License requirements: None.

MarkingHeight

SheetBordersAndZonesBuilder.MarkingHeight

Returns or sets the height of marking.

It should be greater than zero.

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

Getter Method

Signature MarkingHeight

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature MarkingHeight

Parameters:markingHeight (float) –

New in version NX10.0.0.

License requirements: None.

Method

SheetBordersAndZonesBuilder.Method

Returns or sets the type of methods to create the zones.

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

Getter Method

Signature Method

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneMethod

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Method

Parameters:method (NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneMethod) –

New in version NX10.0.0.

License requirements: None.

Origin

SheetBordersAndZonesBuilder.Origin

Returns or sets the type of zone origin like TopLeft/BottomRight.

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

Getter Method

Signature Origin

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneOrigin

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature Origin

Parameters:origin (NXOpen.Diagramming.SheetBordersAndZonesBuilderZoneOrigin) –

New in version NX10.0.0.

License requirements: None.

RightMargin

SheetBordersAndZonesBuilder.RightMargin

Returns or sets the value of the margin in right border.

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

Getter Method

Signature RightMargin

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature RightMargin

Parameters:rightMargin (float) –

New in version NX10.0.0.

License requirements: None.

SheetBorderSettings

SheetBordersAndZonesBuilder.SheetBorderSettings

Returns the sheet border settings builder used to get the values related to borders

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

Getter Method

Signature SheetBorderSettings

Returns: Return type:NXOpen.Diagramming.SheetBorderSettingsBuilder

New in version NX11.0.1.

License requirements: None.

SheetMarginSettings

SheetBordersAndZonesBuilder.SheetMarginSettings

Returns the sheet margin settings builder used to get the values related to margins

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

Getter Method

Signature SheetMarginSettings

Returns: Return type:NXOpen.Diagramming.SheetMarginSettingsBuilder

New in version NX11.0.1.

License requirements: None.

SheetZoneSettings

SheetBordersAndZonesBuilder.SheetZoneSettings

Returns the sheet zone settings builder used to get the values related to zones

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

Getter Method

Signature SheetZoneSettings

Returns: Return type:NXOpen.Diagramming.SheetZoneSettingsBuilder

New in version NX11.0.1.

License requirements: None.

TopMargin

SheetBordersAndZonesBuilder.TopMargin

Returns or sets the value of the margin in top border.

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

Getter Method

Signature TopMargin

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature TopMargin

Parameters:topMargin (float) –

New in version NX10.0.0.

License requirements: None.

TrimmingMarkLength

SheetBordersAndZonesBuilder.TrimmingMarkLength

Returns or sets the length of trimming mark.

It should be greater than zero.

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

Getter Method

Signature TrimmingMarkLength

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature TrimmingMarkLength

Parameters:trimmingMarkLength (float) –

New in version NX10.0.0.

License requirements: None.

TrimmingMarkThickness

SheetBordersAndZonesBuilder.TrimmingMarkThickness

Returns or sets the width of trimming mark.

It should be greater than zero.

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

Getter Method

Signature TrimmingMarkThickness

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature TrimmingMarkThickness

Parameters:trimmingMarkThickness (float) –

New in version NX10.0.0.

License requirements: None.

VerticalCenteringMark

SheetBordersAndZonesBuilder.VerticalCenteringMark

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

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

Getter Method

Signature VerticalCenteringMark

Returns: Return type:NXOpen.Diagramming.SheetBordersAndZonesBuilderVerticalCenteringMarkType

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature VerticalCenteringMark

Parameters:verticalCenteringMark (NXOpen.Diagramming.SheetBordersAndZonesBuilderVerticalCenteringMarkType) –

New in version NX10.0.0.

License requirements: None.

VerticalSize

SheetBordersAndZonesBuilder.VerticalSize

Returns or sets the size of vertical 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

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 greater than zero.

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

Getter Method

Signature Width

Returns: Return type:float

New in version NX10.0.0.

License requirements: None.

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

Setter Method

Signature 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.