Hide Table of Contents
IGetLeaderInfo Method (INote)

Gets information describing the layout of the note leader lines.

.NET Syntax

Visual Basic (Declaration) 
Function IGetLeaderInfo( _
   ByRef PointCount As System.Integer _
) As System.Double
Visual Basic (Usage) 
Dim instance As INote
Dim PointCount As System.Integer
Dim value As System.Double
 
value = instance.IGetLeaderInfo(PointCount)
C# 
System.double IGetLeaderInfo( 
   out System.int PointCount
)
C++/CLI 
System.double IGetLeaderInfo( 
&   [Out] System.int PointCount
) 

Parameters

PointCount
Number of points

Return Value

  • in-process, unmanaged C++: Pointer to an array of doubles (see Remarks)
  • VBA, VB.NET, C#, and C++/CLI: Not supported

See In-process Methods for details about this type of method.

Remarks

There can be 0, 1, or 2 lines used with the leader line. If the note is not attached, then there are 0 lines;  otherwise, you 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 a straight leaderline and1 line (PointCount=2)

  • HasExtraLeader() == True implies 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

 

See Also



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:   IGetLeaderInfo Method (INote)
*Comment:  
*   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:




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) 2018 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.