Hide Table of Contents
GetUserPreferenceTextFormat Method (IModelDocExtension)

Gets document default user preference values. This method is intended for getting detailing text formats.

.NET Syntax

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


User preference as defined in swUserPreferenceTextFormat_e

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

Return Value

Text format associated with UserPref



This method is equivalent to interactively getting document properties in the SOLIDWORKS product. 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:   GetUserPreferenceTextFormat 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) 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.