Hide Table of Contents
SetUserPreferenceTextFormat Method (IModelDocExtension)

Sets document default user preference values. This method is intended for setting detailing text formats.

.NET Syntax

Visual Basic (Declaration) 
Function SetUserPreferenceTextFormat( _
   ByVal UserPref As System.Integer, _
   ByVal UserPrefOption As System.Integer, _
   ByVal Value As TextFormat _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDocExtension
Dim UserPref As System.Integer
Dim UserPrefOption As System.Integer
Dim Value As TextFormat
Dim value As System.Boolean
value = instance.SetUserPreferenceTextFormat(UserPref, UserPrefOption, Value)
System.bool SetUserPreferenceTextFormat( 
   System.int UserPref,
   System.int UserPrefOption,
   TextFormat Value
System.bool SetUserPreferenceTextFormat( 
&   System.int UserPref,
&   System.int UserPrefOption,
&   TextFormat^ Value


User preference as defined by swUserPreferenceTextFormat_e

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

Text format to which to assign the user preference specified in UserPref

Return Value

True if the user preference is set, false if not



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


See Also


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

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