> GetLeaderAtIndex Method (INote)
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show Table of Contents
GetLeaderAtIndex Method (INote)

Gets information about the specified leader on this note.

.NET Syntax

Visual Basic (Declaration) 
Function GetLeaderAtIndex( _
   ByVal Index As Integer _
) As Object
Visual Basic (Usage) 
Dim instance As INote
Dim Index As Integer
Dim value As Object
 
value = instance.GetLeaderAtIndex(Index)
C# 
object GetLeaderAtIndex( 
   int Index
)
C++/CLI 
Object^ GetLeaderAtIndex( 
&   int Index
) 

Parameters

Index
Index of leader

Return Value

Array of doubles (see Remarks)

Remarks

There can be 0, 1, or 2 lines used with the leader line. In other words, if the note is not attached, then there are 0 lines; otherwise, you can have a straight leaderline (1 line) or a bent leaderline (2 lines). You must infer the number of leader lines based on IsAttached() and HasExtraLeader().

  • IsAttached() == false implies no leaderline and no leaderline points (PointCount=0).

  • HasExtraLeader() == false implies that this is a straight leaderline and 1 line (PointCount=2)

  • HasExtraLeader() == True means that this is a bent leaderline and 2 lines (PointCount=3)

Format of return information is the following array of doubles:

  • return value[0] = x coordinate of first leader point

  • return value[1] = y coordinate of first leader point

  • return value[2] = z coordinate of first leader point

  • return value[3] = x coordinate of second leader point

  • return value[4] = y coordinate of second leader point

  • return value[5] = z coordinate of second leader point

  • return value[6] = x coordinate of third leader point

  • return value[7] = y coordinate of third leader point

  • return value[8] = z coordinate of third leader point

Use INote::GetLeaderCount to see how many leaders there are on the note.

 

See Also



Related SolidWorks Forum Content

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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetLeaderAtIndex Method (INote)
*Comment:  
x

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
x

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

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document 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.