AddByConnect Method

Description

Creates a Leader object for a specified dimensioning object.

Syntax

Visual Basic
Public Function AddByConnect( _ ByVal ConnectObject As Object, _ ByVal x1 As Double, _ ByVal y1 As Double, _ ByVal z1 As Double, _ ByVal keyPoint As Boolean, _ ByVal x2 As Double, _ ByVal y2 As Double, _ ByVal z2 As Double _ ) As Leader

Visual Basic

Public Function AddByConnect( _
   ByVal ConnectObject As Object, _
   ByVal x1 As Double, _
   ByVal y1 As Double, _
   ByVal z1 As Double, _
   ByVal keyPoint As Boolean, _
   ByVal x2 As Double, _
   ByVal y2 As Double, _
   ByVal z2 As Double _
) As Leader

Parameters

ConnectObject: Specifies the dimensioning object to which the leader is to connect.
x1: Specifies the coordinates of the connect object's locate point. This point is used as a proximity point when calculating the key point.
y1: Specifies the coordinates of the connect object's locate point. This point is used as a proximity point when calculating the key point.
z1: Specifies the coordinates of the connect object's locate point. This point is used as a proximity point when calculating the key point.
keyPoint: Specifies whether the object or a key point of the object is to be used for measuring. If True, the nearest projected point on the element is selected for the leader's terminal point; if False, the nearest key point is selected.
x2: Specifies the coordinates of the annotation end of the leader.
y2: Specifies the coordinates of the annotation end of the leader.
z2: Specifies the coordinates of the annotation end of the leader.

Remarks

By default, the annotation connect point of the leader is at the midpoint of the left or right side (depending on which is closer to the terminal connect point) of the dimensioning object. If the Leader object is placed with respect to a key point, the point of reference is the key point.

Example

Example (Visual Basic)

Private Sub Form_Load()
    Dim objApp As SolidEdgeFramework.Application
    Dim objDoc As SolidEdgeDraft.DraftDocument
    Dim objSheet As SolidEdgeDraft.Sheet
    Dim objTextBox As SolidEdgeFrameworkSupport.TextBox
    Dim objLeaders As SolidEdgeFrameworkSupport.Leaders
    ' 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 text Box in the active sheet.
    Set objTextBox = objSheet.TextBoxes.AddByHtWdAng(x1:=0.1, y1:=0.1, z1:=0, ht:=0.1, wd:=0.15, ang:=0)
    'Add some text to the Text
    objTextBox.Text = "THIS IS FOR TESTING ONLY"
    'Create Leaders collection object
    Set objLeaders = objSheet.Leaders
    'Create a leader attatched to text box
    Call objLeaders.AddByConnect(ConnectObject:=objTextBox, x1:=0.11, _
                                 y1:=0.2, z1:=0, Keypoint:=True, _
                                 x2:=0.2, y2:=0.4, z2:=0)
    ' USER DISPLAY
    ' Release objects
    Set objApp = Nothing
    Set objDoc = Nothing
    Set objSheet = Nothing
    Set objTextBox = Nothing
    Set objLeaders = Nothing
End Sub