Hide Table of Contents
SetUserPreferenceToggle Method (IModelDocExtension)

Sets document default user preference values. This method is intended for user preferences that can be toggled.

.NET Syntax

Visual Basic (Declaration) 
Function SetUserPreferenceToggle( _
   ByVal UserPref As System.Integer, _
   ByVal UserPrefOption As System.Integer, _
   ByVal Value As System.Boolean _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDocExtension
Dim UserPref As System.Integer
Dim UserPrefOption As System.Integer
Dim Value As System.Boolean
Dim value As System.Boolean
 
value = instance.SetUserPreferenceToggle(UserPref, UserPrefOption, Value)
C# 
System.bool SetUserPreferenceToggle( 
   System.int UserPref,
   System.int UserPrefOption,
   System.bool Value
)
C++/CLI 
System.bool SetUserPreferenceToggle( 
&   System.int UserPref,
&   System.int UserPrefOption,
&   System.bool Value
)

Parameters

UserPref

User preference as defined in swUserPreferenceToggle_e

UserPrefOption

User-preference option for customizing annotation and dimension drafting standards and as defined in swUserPreferenceOption_e; if not needed, then specify swDetailingNoOptionSpecified

Value

True to toggle UserPref on, false to toggle UserPref off

Return Value

True if UserPref is toggled on, false if UserPref is toggled off

Example

Remarks

This method is equivalent to interactively setting document properties in the SOLIDWORKS software. See System Options and Document Properties for details.

 

See Also

Availability

SOLIDWORKS 2009 FCS, Revision Number 17.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:   SetUserPreferenceToggle Method (IModelDocExtension)
*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) 2019 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.

0.20.62