Function GetLeaderPointsAtIndex( _
   ByVal Index As System.Integer _
) As System.Object

Dim instance As IAnnotation
Dim Index As System.Integer
Dim value As System.Object
 
value = instance.GetLeaderPointsAtIndex(Index)

System.object GetLeaderPointsAtIndex( 
   System.int Index
)

System.Object^ GetLeaderPointsAtIndex( 
&   System.int Index
) 

Parameters

Index

Index of leader within this annotation (see Remarks)

Return Value

The index value is 0-based. Therefore, a valid index value is >= 0 < number of leaders on this annotation.

Use IAnnotation::GetLeaderCount to find out how many leaders are on this annotation. If the index value is invalid in Visual Basic for Applications (VBA), SOLIDWORKS returns an empty SafeArray or S_false.

You must determine the number of points in the leader to use the data returned by this method. The number of points is a function of the number of segments in the leader. There can be one or two segments in a leader line, depending on whether or not it is a straight, bent, or underlined leader. Use IAnnotation::GetLeaderStyle
to determine the number of points in the leader.

• If IAnnotation::GetLeaderStyle returns swNO_LEADER, then the number of points = 0.
• If IAnnotation::GetLeaderStyle returns swSTRAIGHT and swUNDERLINED then the number
  of points = 2.
• If IAnnotation::GetLeaderStyle returns swBENT, then the number of points = 3.

Additionally, for the COM interface, you must determine the number of points to allocate the appropriate size array for the return value. The number of points must also be passed to the method to help prevent overwrite problems if you have not allocated an array that is the correct size. If the number of points passed does not match what is found, SOLIDWORKS does not return any point information and returns S_false.

The format of the return array is:

retval[0] = X-coordinate of first leader point (at the arrowhead)

retval[1] = Y-coordinate of first leader point

retval[2] = Z-coordinate of first leader point

retval[3] = X-coordinate of second leader point

retval[4] = Y-coordinate of second leader point

retval[5] = Z-coordinate of second leader point

 

retval[6] = X-coordinate of third leader point

retval[7] = Y-coordinate of third leader point

retval[8] = Z-coordinate of third leader point

You cannot directly set the leader coordinate information. The leader coordinates are computed based on the annotations text and attachment points. Use IAnnotation::GetPosition and IAnnotation::SetPosition to get and set the text point.