SheetBorderSettingsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# SheetBorderSettingsBuilder Class

class `NXOpen.Drawings.``SheetBorderSettingsBuilder`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.Drawings.SheetBorderSettingsBuilder`.

  This class queries and sets sheet border settings preferences when creating a sheet border.

  New in version NX10.0.0.

# Properties

Property | Description
--- | ---
ArrowAngle | Returns or sets the arrow angle
ArrowDirection | Returns or sets the arrow direction
ArrowHeadTail | Returns or sets the arrowhead tail
ArrowLength | Returns or sets the arrow length
ArrowStyle | Returns or sets the arrow style
BorderLineWidth | Returns or sets the border line width
CenteringMarkLength | Returns or sets the centering mark length
CenteringMarksColorWidth | Returns the centering marks color width
CenteringMarksExtension | Returns or sets the centering marks extension
CenteringMarksHorizontal | Returns or sets the centering marks horizontal
CenteringMarksVertical | Returns or sets the centering marks vertical
CreateBorders | Returns or sets the create borders
CreateTrimmingMarks | Returns or sets the create trimming marks
DisplaySheetSizeInBorder | Returns or sets the display sheet size in border
DistanceFromInnerBorder | Returns or sets the distance from inner border
InnerLineCFW | Returns the inner border line’s color, font and width
Method | Returns or sets the method
OuterLineCFW | Returns the outer border line’s color, font and width
Tag | Returns the Tag for this object.
TrimmingMarkColor | Returns or sets the trimming mark color
TrimmingMarkLength | Returns or sets the trimming mark length
TrimmingMarkStyle | Returns or sets the trimming mark style
TrimmingMarkWidth | Returns or sets the trimming mark width

# 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 arrow angle

  `-------------------------------------`

  Getter Method

  Signature `ArrowAngle`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ArrowAngle`

  Parameters: | arrowAngle (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## ArrowDirection

`SheetBorderSettingsBuilder.``ArrowDirection`

  Returns or sets the arrow direction

  `-------------------------------------`

  Getter Method

  Signature `ArrowDirection`

  Returns: |
  Return type: | `NXOpen.Drawings.ArrowDirectionType`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ArrowDirection`

  Parameters: | arrowDirection (`NXOpen.Drawings.ArrowDirectionType`) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## ArrowHeadTail

`SheetBorderSettingsBuilder.``ArrowHeadTail`

  Returns or sets the arrowhead tail

  `-------------------------------------`

  Getter Method

  Signature `ArrowHeadTail`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ArrowHeadTail`

  Parameters: | arrowHeadTail (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## ArrowLength

`SheetBorderSettingsBuilder.``ArrowLength`

  Returns or sets the arrow length

  `-------------------------------------`

  Getter Method

  Signature `ArrowLength`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ArrowLength`

  Parameters: | arrowLength (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## ArrowStyle

`SheetBorderSettingsBuilder.``ArrowStyle`

  Returns or sets the arrow style

  `-------------------------------------`

  Getter Method

  Signature `ArrowStyle`

  Returns: |
  Return type: | `NXOpen.Drawings.ArrowStyleType`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ArrowStyle`

  Parameters: | arrowStyle (`NXOpen.Drawings.ArrowStyleType`) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## BorderLineWidth

`SheetBorderSettingsBuilder.``BorderLineWidth`

  Returns or sets the border line width

  `-------------------------------------`

  Getter Method

  Signature `BorderLineWidth`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BorderLineWidth`

  Parameters: | borderLineWidth (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## CenteringMarkLength

`SheetBorderSettingsBuilder.``CenteringMarkLength`

  Returns or sets the centering mark length

  `-------------------------------------`

  Getter Method

  Signature `CenteringMarkLength`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenteringMarkLength`

  Parameters: | centeringMarkLength (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## CenteringMarksColorWidth

`SheetBorderSettingsBuilder.``CenteringMarksColorWidth`

  Returns the centering marks color width

  `-------------------------------------`

  Getter Method

  Signature `CenteringMarksColorWidth`

  Returns: |
  Return type: | `NXOpen.LineColorFontWidthBuilder`

  New in version NX10.0.0.

  License requirements: None.

## CenteringMarksExtension

`SheetBorderSettingsBuilder.``CenteringMarksExtension`

  Returns or sets the centering marks extension

  `-------------------------------------`

  Getter Method

  Signature `CenteringMarksExtension`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenteringMarksExtension`

  Parameters: | centeringMarksExtension (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## CenteringMarksHorizontal

`SheetBorderSettingsBuilder.``CenteringMarksHorizontal`

  Returns or sets the centering marks horizontal

  `-------------------------------------`

  Getter Method

  Signature `CenteringMarksHorizontal`

  Returns: |
  Return type: | `NXOpen.Drawings.HorizontalCenteringMarkType`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenteringMarksHorizontal`

  Parameters: | centeringMarksHorizontal (`NXOpen.Drawings.HorizontalCenteringMarkType`) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## CenteringMarksVertical

`SheetBorderSettingsBuilder.``CenteringMarksVertical`

  Returns or sets the centering marks vertical

  `-------------------------------------`

  Getter Method

  Signature `CenteringMarksVertical`

  Returns: |
  Return type: | `NXOpen.Drawings.VerticalCenteringMarkType`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CenteringMarksVertical`

  Parameters: | centeringMarksVertical (`NXOpen.Drawings.VerticalCenteringMarkType`) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## CreateBorders

`SheetBorderSettingsBuilder.``CreateBorders`

  Returns or sets the create borders

  `-------------------------------------`

  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: drafting (“DRAFTING”)

## CreateTrimmingMarks

`SheetBorderSettingsBuilder.``CreateTrimmingMarks`

  Returns or sets the create trimming marks

  `-------------------------------------`

  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: drafting (“DRAFTING”)

## DisplaySheetSizeInBorder

`SheetBorderSettingsBuilder.``DisplaySheetSizeInBorder`

  Returns or sets the display sheet size in border

  `-------------------------------------`

  Getter Method

  Signature `DisplaySheetSizeInBorder`

  Returns: |
  Return type: | bool

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DisplaySheetSizeInBorder`

  Parameters: | displaySheetSizeInBorder (bool) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## DistanceFromInnerBorder

`SheetBorderSettingsBuilder.``DistanceFromInnerBorder`

  Returns or sets the distance from inner border

  `-------------------------------------`

  Getter Method

  Signature `DistanceFromInnerBorder`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `DistanceFromInnerBorder`

  Parameters: | distanceInFromInnerBorder (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## InnerLineCFW

`SheetBorderSettingsBuilder.``InnerLineCFW`

  Returns the inner border line’s color, font and width

  `-------------------------------------`

  Getter Method

  Signature `InnerLineCFW`

  Returns: |
  Return type: | `NXOpen.LineColorFontWidthBuilder`

  New in version NX10.0.0.

  License requirements: None.

## Method

`SheetBorderSettingsBuilder.``Method`

  Returns or sets the method

  `-------------------------------------`

  Getter Method

  Signature `Method`

  Returns: |
  Return type: | `NXOpen.Drawings.Method`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Method`

  Parameters: | method (`NXOpen.Drawings.Method`) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## OuterLineCFW

`SheetBorderSettingsBuilder.``OuterLineCFW`

  Returns the outer border line’s color, font and width

  `-------------------------------------`

  Getter Method

  Signature `OuterLineCFW`

  Returns: |
  Return type: | `NXOpen.LineColorFontWidthBuilder`

  New in version NX10.0.0.

  License requirements: None.

## TrimmingMarkColor

`SheetBorderSettingsBuilder.``TrimmingMarkColor`

  Returns or sets the trimming mark color

  `-------------------------------------`

  Getter Method

  Signature `TrimmingMarkColor`

  Returns: |
  Return type: | Id

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrimmingMarkColor`

  Parameters: | trimmingMarkColor (Id) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## TrimmingMarkLength

`SheetBorderSettingsBuilder.``TrimmingMarkLength`

  Returns or sets the trimming mark length

  `-------------------------------------`

  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: drafting (“DRAFTING”)

## TrimmingMarkStyle

`SheetBorderSettingsBuilder.``TrimmingMarkStyle`

  Returns or sets the trimming mark style

  `-------------------------------------`

  Getter Method

  Signature `TrimmingMarkStyle`

  Returns: |
  Return type: | `NXOpen.Drawings.TrimmingMarkStyleType`

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrimmingMarkStyle`

  Parameters: | trimmingMarkStyle (`NXOpen.Drawings.TrimmingMarkStyleType`) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

## TrimmingMarkWidth

`SheetBorderSettingsBuilder.``TrimmingMarkWidth`

  Returns or sets the trimming mark width

  `-------------------------------------`

  Getter Method

  Signature `TrimmingMarkWidth`

  Returns: |
  Return type: | float

  New in version NX10.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `TrimmingMarkWidth`

  Parameters: | trimmingMarkWidth (float) –

  New in version NX10.0.0.

  License requirements: drafting (“DRAFTING”)

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