Hide Table of Contents
SetConsiderLeadersAsLines Method (IModelDoc2)

Sets a flag on the document that indicates whether the display data of a leader should be included as lines when the lines are retrieved from a view or annotation in this document.

.NET Syntax

Visual Basic (Declaration) 
Function SetConsiderLeadersAsLines( _
   ByVal LeadersAsLines As System.Boolean _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim LeadersAsLines As System.Boolean
Dim value As System.Boolean
 
value = instance.SetConsiderLeadersAsLines(LeadersAsLines)
C# 
System.bool SetConsiderLeadersAsLines( 
   System.bool LeadersAsLines
)
C++/CLI 
System.bool SetConsiderLeadersAsLines( 
&   System.bool LeadersAsLines
) 

Parameters

LeadersAsLines

True to return leaders as line data, false to not

Return Value

Original value of the flag before calling this method

Remarks

The various GetLeaderCount and GetLeaderAtIndex methods that are found on several different annotations return the information about where the vertices of the leader are located. GetLineCount and GetLinesAtIndex also return the leader information as part of its line information. Depending on what your program is trying to accomplish and which methods it is using, this duplication of information may not be desirable. This method controls this behavior by setting a flag on the document that indicates whether or not the leader information is returned as part of the line information or not.

Initially, when a document is opened, the flag is set to True, so that existing applications work as they have always worked. If you do not want to get back leader information as part of the line information, call this method and set the value to false. The flag is not saved with the document, so you must specifically set it to false whenever you do not want leaders as part of the line information.

The various GetArrowHeadCount and GetArrowHeadAtIndex methods are also affected. When this flag has been set to false so that leaders are not considered as lines, the arrowhead information for the arrowheads on those leaders is not returned. However, GetArrowHeadInfo still returns valid information.

Use IModelDoc2::GetConsiderLeadersAsLines to determine the current behavior.

 

See Also

Availability

SOLIDWORKS 2001Plus FCS, Revision Number 10.0


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:   SetConsiderLeadersAsLines Method (IModelDoc2)
*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) 2017 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.