BordersAndZonesBuilder Class¶
-
class
NXOpen.Drawings.
BordersAndZonesBuilder
¶ Bases:
NXOpen.Builder
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) New in version NX8.0.0.
Properties¶
Property | Description |
---|---|
BorderAndZoneStyle | Returns the border and zone style builder |
BottomMargin | Returns or sets the bottom margin |
CenteringMarkExtension | Returns or sets the centering mark extension |
CreateBorders | Returns or sets the create borders |
CreateTrimmingMarks | Returns or sets the create trimming marks |
CreateZoneLabels | Returns or sets the create zone labels |
CreateZoneMarking | Returns or sets the create zone marking |
HorizontalCenteringMark | Returns or sets the horizontal centering mark |
HorizontalSize | Returns or sets the horizontal size of the 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 method of creation of zones |
Origin | Returns or sets the zone origin type |
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 |
VerticalSize | Returns or sets the vertical size of the zones |
Width | Returns or sets the width of the 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. |
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¶
BordersAndZonesBuilderFontEnum Enumeration | the font |
BordersAndZonesBuilderHorizontalCenteringMarkType Enumeration | the horizontal centering mark type |
BordersAndZonesBuilderVerticalCenteringMarkType Enumeration | the vertical centering mark type |
BordersAndZonesBuilderZoneMethod Enumeration | the zone method |
BordersAndZonesBuilderZoneOrigin Enumeration | the zone origin |
Property Detail¶
BorderAndZoneStyle¶
-
BordersAndZonesBuilder.
BorderAndZoneStyle
¶ Returns the border and zone style builder
-------------------------------------
Getter Method
Signature
BorderAndZoneStyle()
Returns: Return type: NXOpen.Drawings.BorderAndZoneStyleBuilder
New in version NX10.0.0.
License requirements: None.
BottomMargin¶
-
BordersAndZonesBuilder.
BottomMargin
¶ Returns or sets the bottom margin
-------------------------------------
Getter Method
Signature
BottomMargin()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.BottomTrimmedMargin()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
BottomMargin(bottomMargin)
Parameters: bottomMargin (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.BottomTrimmedMargin()
instead.License requirements: drafting (“DRAFTING”)
CenteringMarkExtension¶
-
BordersAndZonesBuilder.
CenteringMarkExtension
¶ Returns or sets the centering mark extension
-------------------------------------
Getter Method
Signature
CenteringMarkExtension()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CenteringMarksExtension()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CenteringMarkExtension(centeringMarkExtension)
Parameters: centeringMarkExtension (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CenteringMarksExtension()
instead.License requirements: drafting (“DRAFTING”)
CreateBorders¶
-
BordersAndZonesBuilder.
CreateBorders
¶ Returns or sets the create borders
-------------------------------------
Getter Method
Signature
CreateBorders()
Returns: Return type: bool New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CreateBorders()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CreateBorders(createBorders)
Parameters: createBorders (bool) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CreateBorders()
instead.License requirements: drafting (“DRAFTING”)
CreateTrimmingMarks¶
-
BordersAndZonesBuilder.
CreateTrimmingMarks
¶ Returns or sets the create trimming marks
-------------------------------------
Getter Method
Signature
CreateTrimmingMarks()
Returns: Return type: bool New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CreateTrimmingMarks()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CreateTrimmingMarks(createTrimmingMarks)
Parameters: createTrimmingMarks (bool) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CreateTrimmingMarks()
instead.License requirements: drafting (“DRAFTING”)
CreateZoneLabels¶
-
BordersAndZonesBuilder.
CreateZoneLabels
¶ Returns or sets the create zone labels
-------------------------------------
Getter Method
Signature
CreateZoneLabels()
Returns: Return type: bool New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.CreateZoneLabels()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CreateZoneLabels(createZoneLabels)
Parameters: createZoneLabels (bool) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.CreateZoneLabels()
instead.License requirements: drafting (“DRAFTING”)
CreateZoneMarking¶
-
BordersAndZonesBuilder.
CreateZoneMarking
¶ Returns or sets the create zone marking
-------------------------------------
Getter Method
Signature
CreateZoneMarking()
Returns: Return type: bool New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.CreateZoneMarkings()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
CreateZoneMarking(createZoneMarking)
Parameters: createZoneMarking (bool) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.CreateZoneMarkings()
instead.License requirements: drafting (“DRAFTING”)
HorizontalCenteringMark¶
-
BordersAndZonesBuilder.
HorizontalCenteringMark
¶ Returns or sets the horizontal centering mark
-------------------------------------
Getter Method
Signature
HorizontalCenteringMark()
Returns: Return type: NXOpen.Drawings.BordersAndZonesBuilderHorizontalCenteringMarkType
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CenteringMarksHorizontal()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalCenteringMark(horizontalCenteringMark)
Parameters: horizontalCenteringMark ( NXOpen.Drawings.BordersAndZonesBuilderHorizontalCenteringMarkType
) –New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CenteringMarksHorizontal()
instead.License requirements: drafting (“DRAFTING”)
HorizontalSize¶
-
BordersAndZonesBuilder.
HorizontalSize
¶ Returns or sets the horizontal size of the zones
-------------------------------------
Getter Method
Signature
HorizontalSize()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.HorizontalSize()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
HorizontalSize(horizontalSize)
Parameters: horizontalSize (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.HorizontalSize()
instead.License requirements: drafting (“DRAFTING”)
LabelFont¶
-
BordersAndZonesBuilder.
LabelFont
¶ Returns or sets the label font
-------------------------------------
Getter Method
Signature
LabelFont()
Returns: Return type: int New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.LabelFont()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
LabelFont(labelFont)
Parameters: labelFont (int) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.LabelFont()
instead.License requirements: drafting (“DRAFTING”)
LabelHeight¶
-
BordersAndZonesBuilder.
LabelHeight
¶ Returns or sets the label height
-------------------------------------
Getter Method
Signature
LabelHeight()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.LabelHeight()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
LabelHeight(labelHeight)
Parameters: labelHeight (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.LabelHeight()
instead.License requirements: drafting (“DRAFTING”)
LeftMargin¶
-
BordersAndZonesBuilder.
LeftMargin
¶ Returns or sets the left margin
-------------------------------------
Getter Method
Signature
LeftMargin()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.LeftTrimmedMargin()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
LeftMargin(leftMargin)
Parameters: leftMargin (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.LeftTrimmedMargin()
instead.License requirements: drafting (“DRAFTING”)
MarkingHeight¶
-
BordersAndZonesBuilder.
MarkingHeight
¶ Returns or sets the marking height
-------------------------------------
Getter Method
Signature
MarkingHeight()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.MarkingHeight()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
MarkingHeight(markingHeight)
Parameters: markingHeight (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.MarkingHeight()
instead.License requirements: drafting (“DRAFTING”)
Method¶
-
BordersAndZonesBuilder.
Method
¶ Returns or sets the method of creation of zones
-------------------------------------
Getter Method
Signature
Method()
Returns: Return type: NXOpen.Drawings.BordersAndZonesBuilderZoneMethod
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.Method()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Method(method)
Parameters: method ( NXOpen.Drawings.BordersAndZonesBuilderZoneMethod
) –New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.Method()
instead.License requirements: drafting (“DRAFTING”)
Origin¶
-
BordersAndZonesBuilder.
Origin
¶ Returns or sets the zone origin type
-------------------------------------
Getter Method
Signature
Origin()
Returns: Return type: NXOpen.Drawings.BordersAndZonesBuilderZoneOrigin
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.Origin()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Origin(origin)
Parameters: origin ( NXOpen.Drawings.BordersAndZonesBuilderZoneOrigin
) –New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.Origin()
instead.License requirements: drafting (“DRAFTING”)
RightMargin¶
-
BordersAndZonesBuilder.
RightMargin
¶ Returns or sets the right margin
-------------------------------------
Getter Method
Signature
RightMargin()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.RightTrimmedMargin()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
RightMargin(rightMargin)
Parameters: rightMargin (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.RightTrimmedMargin()
instead.License requirements: drafting (“DRAFTING”)
TopMargin¶
-
BordersAndZonesBuilder.
TopMargin
¶ Returns or sets the top margin
-------------------------------------
Getter Method
Signature
TopMargin()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.TopTrimmedMargin()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
TopMargin(topMargin)
Parameters: topMargin (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetMarginSettingsBuilder.TopTrimmedMargin()
instead.License requirements: drafting (“DRAFTING”)
TrimmingMarkLength¶
-
BordersAndZonesBuilder.
TrimmingMarkLength
¶ Returns or sets the trimming mark length
-------------------------------------
Getter Method
Signature
TrimmingMarkLength()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.TrimmingMarkLength()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingMarkLength(trimmingMarkLength)
Parameters: trimmingMarkLength (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.TrimmingMarkLength()
instead.License requirements: drafting (“DRAFTING”)
TrimmingMarkThickness¶
-
BordersAndZonesBuilder.
TrimmingMarkThickness
¶ Returns or sets the trimming mark thickness
-------------------------------------
Getter Method
Signature
TrimmingMarkThickness()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.TrimmingMarkWidth()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingMarkThickness(trimmingMarkThickness)
Parameters: trimmingMarkThickness (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.TrimmingMarkWidth()
instead.License requirements: drafting (“DRAFTING”)
VerticalCenteringMark¶
-
BordersAndZonesBuilder.
VerticalCenteringMark
¶ Returns or sets the vertical centering mark
-------------------------------------
Getter Method
Signature
VerticalCenteringMark()
Returns: Return type: NXOpen.Drawings.BordersAndZonesBuilderVerticalCenteringMarkType
New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CenteringMarksVertical()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalCenteringMark(verticalCenteringMark)
Parameters: verticalCenteringMark ( NXOpen.Drawings.BordersAndZonesBuilderVerticalCenteringMarkType
) –New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.CenteringMarksVertical()
instead.License requirements: drafting (“DRAFTING”)
VerticalSize¶
-
BordersAndZonesBuilder.
VerticalSize
¶ Returns or sets the vertical size of the zones
-------------------------------------
Getter Method
Signature
VerticalSize()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.VerticalSize()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
VerticalSize(verticalSize)
Parameters: verticalSize (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetZoneSettingsBuilder.VerticalSize()
instead.License requirements: drafting (“DRAFTING”)
Width¶
-
BordersAndZonesBuilder.
Width
¶ Returns or sets the width of the border
-------------------------------------
Getter Method
Signature
Width()
Returns: Return type: float New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.BorderLineWidth()
instead.License requirements: None.
-------------------------------------
Setter Method
Signature
Width(width)
Parameters: width (float) – New in version NX8.0.0.
Deprecated since version NX10.0.0: Use
NXOpen.Drawings.SheetBorderSettingsBuilder.BorderLineWidth()
instead.License requirements: drafting (“DRAFTING”)
Method Detail¶
Validate¶
-
BordersAndZonesBuilder.
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.