SheetBorderSettingsBuilder Class¶
-
class
NXOpen.Diagramming.
SheetBorderSettingsBuilder
¶ Bases:
NXOpen.TaggedObject
,NXOpen.GeometricUtilities.IComponentBuilder
The SheetBorderSettings builder
New in version NX11.0.1.
Properties¶
Property | Description |
---|---|
ArrowAngle | Returns or sets the angle of arrow in the borders. |
ArrowDirection | Returns or sets the direction of arrow like Into Sheet or Out of Sheet. |
ArrowHeadTail | Returns or sets the length of arrow tail. |
ArrowLength | Returns or sets the length of arrow in the borders. |
ArrowStyle | Returns or sets the type of arrow style like Open, Closed. |
BorderLineWidth | Returns or sets the width of border. |
CenteringMarkLength | Returns or sets the length of centering mark. |
CenteringMarksColorWidth | Returns the color and width of centering marks. |
CenteringMarksExtension | Returns or sets the length of centering marks extension from inner border. |
CenteringMarksHorizontal | Returns or sets the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow. |
CenteringMarksVertical | Returns or sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow. |
CreateBorders | Returns or sets the flag that indicates if borders are created. |
CreateTrimmingMarks | Returns or sets the flag indicates to create trimming marks or not. |
DisplaySheetSizeInBorder | Returns or sets the flag indicates to display sheet size in border or not |
DistanceFromInnerBorder | Returns or sets the distance between inner border and arrow head. |
InnerLineCFW | Returns the color, font and width of inner border line. |
Method | Returns or sets the type of method to display like Standard/Custom |
OuterLineCFW | Returns the color, font and width of outer border line. |
Tag | Returns the Tag for this object. |
TrimmingMarkColor | Returns or sets the color of trimming mark. |
TrimmingMarkLength | Returns or sets the length of trimming mark. |
TrimmingMarkStyle | Returns or sets the type of trimming mark style like Corner or Triangle. |
TrimmingMarkWidth | Returns or sets the width of trimming mark. |
Methods¶
Method | Description |
---|---|
Validate | Validate whether the inputs to the component are sufficient for commit to be called. |
Property Detail¶
ArrowAngle¶
-
SheetBorderSettingsBuilder.
ArrowAngle
¶ Returns or sets the angle of arrow in the borders.
-------------------------------------
Getter Method
Signature
ArrowAngle
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ArrowAngle
Parameters: arrowAngle (float) – New in version NX11.0.1.
License requirements: None.
ArrowDirection¶
-
SheetBorderSettingsBuilder.
ArrowDirection
¶ Returns or sets the direction of arrow like Into Sheet or Out of Sheet.
-------------------------------------
Getter Method
Signature
ArrowDirection
Returns: Return type: NXOpen.Diagramming.ArrowDirectionType
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ArrowDirection
Parameters: arrowDirection ( NXOpen.Diagramming.ArrowDirectionType
) –New in version NX11.0.1.
License requirements: None.
ArrowHeadTail¶
-
SheetBorderSettingsBuilder.
ArrowHeadTail
¶ Returns or sets the length of arrow tail.
-------------------------------------
Getter Method
Signature
ArrowHeadTail
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ArrowHeadTail
Parameters: arrowHeadTail (float) – New in version NX11.0.1.
License requirements: None.
ArrowLength¶
-
SheetBorderSettingsBuilder.
ArrowLength
¶ Returns or sets the length of arrow in the borders.
-------------------------------------
Getter Method
Signature
ArrowLength
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ArrowLength
Parameters: arrowLength (float) – New in version NX11.0.1.
License requirements: None.
ArrowStyle¶
-
SheetBorderSettingsBuilder.
ArrowStyle
¶ Returns or sets the type of arrow style like Open, Closed.
-------------------------------------
Getter Method
Signature
ArrowStyle
Returns: Return type: NXOpen.Diagramming.ArrowStyleType
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
ArrowStyle
Parameters: arrowStyle ( NXOpen.Diagramming.ArrowStyleType
) –New in version NX11.0.1.
License requirements: None.
BorderLineWidth¶
-
SheetBorderSettingsBuilder.
BorderLineWidth
¶ Returns or sets the width of border.
It should be greater than zero.
-------------------------------------
Getter Method
Signature
BorderLineWidth
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
BorderLineWidth
Parameters: borderLineWidth (float) – New in version NX11.0.1.
License requirements: None.
CenteringMarkLength¶
-
SheetBorderSettingsBuilder.
CenteringMarkLength
¶ Returns or sets the length of centering mark.
-------------------------------------
Getter Method
Signature
CenteringMarkLength
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CenteringMarkLength
Parameters: centeringMarkLength (float) – New in version NX11.0.1.
License requirements: None.
CenteringMarksColorWidth¶
-
SheetBorderSettingsBuilder.
CenteringMarksColorWidth
¶ Returns the color and width of centering marks.
-------------------------------------
Getter Method
Signature
CenteringMarksColorWidth
Returns: Return type: NXOpen.LineColorFontWidthBuilder
New in version NX11.0.1.
License requirements: None.
CenteringMarksExtension¶
-
SheetBorderSettingsBuilder.
CenteringMarksExtension
¶ Returns or sets the length of centering marks extension from inner border.
-------------------------------------
Getter Method
Signature
CenteringMarksExtension
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CenteringMarksExtension
Parameters: centeringMarksExtension (float) – New in version NX11.0.1.
License requirements: None.
CenteringMarksHorizontal¶
-
SheetBorderSettingsBuilder.
CenteringMarksHorizontal
¶ Returns or sets the horizontal centering mark used to show the type of centering mark like LeftArrow/RightArrow.
-------------------------------------
Getter Method
Signature
CenteringMarksHorizontal
Returns: Return type: NXOpen.Diagramming.HorizontalCenteringMarkType
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CenteringMarksHorizontal
Parameters: centeringMarksHorizontal ( NXOpen.Diagramming.HorizontalCenteringMarkType
) –New in version NX11.0.1.
License requirements: None.
CenteringMarksVertical¶
-
SheetBorderSettingsBuilder.
CenteringMarksVertical
¶ Returns or sets the vertical centering mark used to show the type of centering mark like TopArrow/BottomArrow.
-------------------------------------
Getter Method
Signature
CenteringMarksVertical
Returns: Return type: NXOpen.Diagramming.VerticalCenteringMarkType
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CenteringMarksVertical
Parameters: centeringMarksVertical ( NXOpen.Diagramming.VerticalCenteringMarkType
) –New in version NX11.0.1.
License requirements: None.
CreateBorders¶
-
SheetBorderSettingsBuilder.
CreateBorders
¶ Returns or sets the flag that indicates if borders are created.
-------------------------------------
Getter Method
Signature
CreateBorders
Returns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateBorders
Parameters: createBorders (bool) – New in version NX11.0.1.
License requirements: None.
CreateTrimmingMarks¶
-
SheetBorderSettingsBuilder.
CreateTrimmingMarks
¶ Returns or sets the flag indicates to create trimming marks or not.
-------------------------------------
Getter Method
Signature
CreateTrimmingMarks
Returns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
CreateTrimmingMarks
Parameters: createTrimmingMarks (bool) – New in version NX11.0.1.
License requirements: None.
DisplaySheetSizeInBorder¶
-
SheetBorderSettingsBuilder.
DisplaySheetSizeInBorder
¶ Returns or sets the flag indicates to display sheet size in border or not
-------------------------------------
Getter Method
Signature
DisplaySheetSizeInBorder
Returns: Return type: bool New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
DisplaySheetSizeInBorder
Parameters: displaySheetSizeInBorder (bool) – New in version NX11.0.1.
License requirements: None.
DistanceFromInnerBorder¶
-
SheetBorderSettingsBuilder.
DistanceFromInnerBorder
¶ Returns or sets the distance between inner border and arrow head.
-------------------------------------
Getter Method
Signature
DistanceFromInnerBorder
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
DistanceFromInnerBorder
Parameters: distanceInFromInnerBorder (float) – New in version NX11.0.1.
License requirements: None.
InnerLineCFW¶
-
SheetBorderSettingsBuilder.
InnerLineCFW
¶ Returns the color, font and width of inner border line.
-------------------------------------
Getter Method
Signature
InnerLineCFW
Returns: Return type: NXOpen.LineColorFontWidthBuilder
New in version NX11.0.1.
License requirements: None.
Method¶
-
SheetBorderSettingsBuilder.
Method
¶ Returns or sets the type of method to display like Standard/Custom
-------------------------------------
Getter Method
Signature
Method
Returns: Return type: NXOpen.Diagramming.Method
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
Method
Parameters: method ( NXOpen.Diagramming.Method
) –New in version NX11.0.1.
License requirements: None.
OuterLineCFW¶
-
SheetBorderSettingsBuilder.
OuterLineCFW
¶ Returns the color, font and width of outer border line.
-------------------------------------
Getter Method
Signature
OuterLineCFW
Returns: Return type: NXOpen.LineColorFontWidthBuilder
New in version NX11.0.1.
License requirements: None.
TrimmingMarkColor¶
-
SheetBorderSettingsBuilder.
TrimmingMarkColor
¶ Returns or sets the color of trimming mark.
-------------------------------------
Getter Method
Signature
TrimmingMarkColor
Returns: Return type: Id New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingMarkColor
Parameters: trimmingMarkColor (Id) – New in version NX11.0.1.
License requirements: None.
TrimmingMarkLength¶
-
SheetBorderSettingsBuilder.
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 NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingMarkLength
Parameters: trimmingMarkLength (float) – New in version NX11.0.1.
License requirements: None.
TrimmingMarkStyle¶
-
SheetBorderSettingsBuilder.
TrimmingMarkStyle
¶ Returns or sets the type of trimming mark style like Corner or Triangle.
-------------------------------------
Getter Method
Signature
TrimmingMarkStyle
Returns: Return type: NXOpen.Diagramming.TrimmingMarkStyleType
New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingMarkStyle
Parameters: trimmingMarkStyle ( NXOpen.Diagramming.TrimmingMarkStyleType
) –New in version NX11.0.1.
License requirements: None.
TrimmingMarkWidth¶
-
SheetBorderSettingsBuilder.
TrimmingMarkWidth
¶ Returns or sets the width of trimming mark.
It should be greater than zero.
-------------------------------------
Getter Method
Signature
TrimmingMarkWidth
Returns: Return type: float New in version NX11.0.1.
License requirements: None.
-------------------------------------
Setter Method
Signature
TrimmingMarkWidth
Parameters: trimmingMarkWidth (float) – New in version NX11.0.1.
License requirements: None.
Method Detail¶
Validate¶
-
SheetBorderSettingsBuilder.
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.