BreakDistance Property

Description

Sets and returns the break distance for the referenced Dimension object.

Property type

Read-write property

Syntax

Visual Basic
Public Property BreakDistance As Double

Remarks

The break distance defines where the text is positioned. If the BreakPosition property is igDimBreakPositonCenter, the break distance is a ratio of dimension value to distance required. For example, a ratio of 0.5 places the text at the center point between the Origin and Measure terminators. In all other cases, this distance is the absolute distance from the respective terminator ends.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeFrameWork.Application
    Dim objDoc As SolidEdgeDraft.DraftDocument
    Dim objSheet As SolidEdgeDraft.Sheet
    Dim objline As SolidEdgeFrameworkSupport.Line2d
    Dim objDimension As SolidEdgeFrameworkSupport.Dimension
    Dim dblBrkDistance As Double
    ' Report errors
    Const PI = 3.14159265358979
    ' Create/get the application with specific settings
    On Error Resume Next
    Set objApp = GetObject(, "SolidEdge.Application")
    If Err Then
        Err.Clear
        Set objApp = CreateObject("SolidEdge.Application")
        Set objDoc = objApp.Documents.Add("SolidEdge.DraftDocument")
        objApp.Visible = True
    Else
        Set objDoc = objApp.ActiveDocument
    End If
    'getting the Active Sheet object
    Set objSheet = objDoc.ActiveSheet
    'create a line2d
    Set objline = objSheet.Lines2d.AddBy2Points(0.1, 0.1, 0.3, 0.3)
    'create a dimension object
    Set objDimension = objSheet.Dimensions.AddLength(Object:=objline)
    'get break distance
    dblBrkDistance = objDimension.BreakDistance
    'set break distance
    objDimension.BreakDistance = 0.9
    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objSheet = Nothing
    Set objDimension = Nothing
    Set objline = Nothing
End Sub