Hide Table of Contents
SetLeader3 Method (IAnnotation)

Sets the leader characteristics for this annotation.

.NET Syntax

Visual Basic (Declaration) 
Function SetLeader3( _
   ByVal LeaderStyle As Integer, _
   ByVal LeaderSide As Integer, _
   ByVal SmartArrowHeadStyle As Boolean, _
   ByVal Perpendicular As Boolean, _
   ByVal AllAround As Boolean, _
   ByVal Dashed As Boolean _
) As Integer
Visual Basic (Usage) 
Dim instance As IAnnotation
Dim LeaderStyle As Integer
Dim LeaderSide As Integer
Dim SmartArrowHeadStyle As Boolean
Dim Perpendicular As Boolean
Dim AllAround As Boolean
Dim Dashed As Boolean
Dim value As Integer
value = instance.SetLeader3(LeaderStyle, LeaderSide, SmartArrowHeadStyle, Perpendicular, AllAround, Dashed)
int SetLeader3( 
   int LeaderStyle,
   int LeaderSide,
   bool SmartArrowHeadStyle,
   bool Perpendicular,
   bool AllAround,
   bool Dashed
int SetLeader3( 
&   int LeaderStyle,
&   int LeaderSide,
&   bool SmartArrowHeadStyle,
&   bool Perpendicular,
&   bool AllAround,
&   bool Dashed


Leader style as defined in swLeaderStyle_e
Leader side as defined in swLeaderSide_e
True to enable smart arrowhead style, false to disable it

True to enable perpendicular bent leader display, false to disable it


True to enable all around symbol display, false to disable it

True to enable dashed line leader display; false to enable solid-line leader

Return Value

Indicates whether the operation was successful (see Remarks)


Not all annotations support all styles of leaders or leader characteristics. Only notes, GTols, surface finish symbols, weld symbols, datum target symbols, and block instances support leaders of any kind.


  • Weld symbol leaders can be hidden, but are always bent; straight leaders (swSTRAIGHT) are not supported.

  • Datum target symbols can have straight or bent leaders, but cannot be hidden (swNO_LEADER is not supported).

  • Only notes support underline leaders (swUNDERLINED).

  • GTols are the only type of annotation that supports perpendicular bent leaders.

  • GTols and weld symbols are the only types of annotations that support all around leader symbols.

  • Datum target symbols are the only type of annotation that supports dashed leaders.

This method sets the characteristics of the annotation, not the individual leaders. You can get or set these characteristics whether or not leaders are displayed.

Use... To...


Determine whether this leader is a dashed line or a solid line.  

Determine whether all around symbol display is enabled or disabled.


Determine whether perpendicular bent leader display is enabled or disabled.


Get the leader attachment side setting.


Get style of leader (hidden, straight, bent, or underline).


Determine whether smart arrowhead style is enabled or disabled.

You can set the leader side, smart arrowhead style, and bent leader values at any time. However, if leader display is disabled, you cannot affect the display of the annotation by setting these values. You can also set the perpendicular bent leader and all around symbol display at any time, but if bent leaders are disabled, you cannot affect the display of the annotation by setting these values.

The return status of this operation can have the following values:

  • 0   Leader characteristics were successfully set

  • -1  Leader characteristics were not set because of an unknown error

  • -2  Leader attachment side setting is invalid

  • -3  Leaders are not supported on this type of annotation

  • -4  Leaders cannot be disabled on this type of annotation

  • -5  Bent leaders cannot be disabled on this type of annotation

  • -6 Underline style leaders are not allowed on this type of annotation

If leader display is enabled, then this method changes the visible model.


See Also


2006 FCS, Revision Number 14

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:   SetLeader3 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.