Hide Table of Contents
GetLeaderPointsAtIndex Method (IAnnotation)

Gets coordinate information about a specified leader on this annotation.

.NET Syntax

Visual Basic (Declaration) 
Function GetLeaderPointsAtIndex( _
   ByVal Index As Integer _
) As Object
Visual Basic (Usage) 
Dim instance As IAnnotation
Dim Index As Integer
Dim value As Object
value = instance.GetLeaderPointsAtIndex(Index)
object GetLeaderPointsAtIndex( 
   int Index
Object^ GetLeaderPointsAtIndex( 
&   int Index


Index of leader within this annotation (see Remarks)

Return Value

Array of objects (see Remarks)



The index value is 0-based. Therefore, a valid index value is greater than or equal to 0, but less than the 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.


See Also


SolidWorks 99, datecode 1999207

Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   GetLeaderPointsAtIndex Method (IAnnotation)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2012 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.