Hide Table of Contents
SetUserPreferenceToggle Method (ISldWorks)

Sets system default user preference values.

.NET Syntax

Visual Basic (Declaration) 
Sub SetUserPreferenceToggle( _
   ByVal UserPreferenceValue As System.Integer, _
   ByVal OnFlag As System.Boolean _
) 
Visual Basic (Usage) 
Dim instance As ISldWorks
Dim UserPreferenceValue As System.Integer
Dim OnFlag As System.Boolean
 
instance.SetUserPreferenceToggle(UserPreferenceValue, OnFlag)
C# 
void SetUserPreferenceToggle( 
   System.int UserPreferenceValue,
   System.bool OnFlag
)
C++/CLI 
void SetUserPreferenceToggle( 
&   System.int UserPreferenceValue,
&   System.bool OnFlag
) 

Parameters

UserPreferenceValue

User preference as defined in swUserPreferenceToggle_e

OnFlag

0 to toggle on UserPreferenceValue, 1 to toggle off

Return Value

True if UserPreferenceValue is set, false if not

Example

Remarks

This method is intended for user preferences that can be toggled.

This method is equivalent to interactively setting system options in the SolidWorks software.

To use this method, choose one of the available items from the swUserPreferenceToggle_e enumerationPass true to turn the item on, and false to turn the item off.

For example, the following command forces the SolidWorks application to use the Search Folders when loading files:

swapp.SetUserPreferenceToggle swUseFolderSearchRules, True

See System Options and Document Properties for details.

 

See Also



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 (ISldWorks)
*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) 2013 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.