Hide Table of Contents
SetBrokenLeader2 Method (IDisplayDimension)

Sets the broken leader display characteristic of this display dimension.

.NET Syntax

Visual Basic (Declaration) 
Function SetBrokenLeader2( _
   ByVal UseDoc As System.Boolean, _
   ByVal Broken As System.Integer _
) As System.Integer
Visual Basic (Usage) 
Dim instance As IDisplayDimension
Dim UseDoc As System.Boolean
Dim Broken As System.Integer
Dim value As System.Integer
value = instance.SetBrokenLeader2(UseDoc, Broken)
System.int SetBrokenLeader2( 
   System.bool UseDoc,
   System.int Broken
System.int SetBrokenLeader2( 
&   System.bool UseDoc,
&   System.int Broken



True uses the document default setting, false uses the setting specified in the Broken argument


Broken leader value as defined in swDisplayDimensionLeaderText_e if UseDoc is false

Return Value

Return status:


Command failed, no broken leader values were set


Command was successful, all precision values were set


Specified broken value is invalid, the display dimension was set to use the document default


Dimension text can be displayed above a solid, unbroken leader line, or broken with the text displayed horizontally or aligned with the leader line. This method allows you to determine if this IDisplayDimension uses the default document setting for this value or if the user has applied a specific setting.

If UseDoc is True, then SOLIDWORKS ignores the broken value.

The return value indicates the success or failure of this method. In general, a value less than 0 indicates that the command failed, and no broken leader values were set. A value of 0 indicates success.

Use IDisplayDimension::GetUseDocBrokenLeader and IDisplayDimension::GetBrokenLeader2 to get these values.

After using this method, use IModelDoc2::GraphicsRedraw2 to redraw the graphics window to see your changes.


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:   SetBrokenLeader2 Method (IDisplayDimension)
*   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) 2016 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.