Hide Table of Contents
GetUserPreferenceToggle Method (IModelDoc2)

Obsolete. Superseded by IModelDocExtension::GetUserPreferenceToggle.

.NET Syntax

Visual Basic (Declaration) 
Function GetUserPreferenceToggle( _
   ByVal UserPreferenceToggle As System.Integer _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDoc2
Dim UserPreferenceToggle As System.Integer
Dim value As System.Boolean
value = instance.GetUserPreferenceToggle(UserPreferenceToggle)
System.bool GetUserPreferenceToggle( 
   System.int UserPreferenceToggle
System.bool GetUserPreferenceToggle( 
&   System.int UserPreferenceToggle


Value as defined in swUserPreferenceToggle_e

Return Value

True if the item specified by UserPreferenceToggle is currently toggled on, false if the item is currently toggled off



This method is equivalent to interactively getting document properties in the SOLIDWORKS product.

The value returned is true if the item is currently turned on, and false if the item is currently turned off. For example:

boolean curState = m_ModelDoc2.GetUserPreferenceToggle( swIgnoreFeatureColors )

See System Options and Document Properties for details.


See Also


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

Subject:   Feedback on Help Topics
Page:   GetUserPreferenceToggle Method (IModelDoc2)
*   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.