> SetUserPreferenceTextFormat Method (IModelDocExtension)
Welcome
Getting Started
SolidWorks API Help
FeatureWorks API Help
SolidWorks Document Manager API Help
eDrawings API Help
SolidWorks Routing API Help
SolidWorks Simulation API Help
SolidWorks Utilities API Help
SolidWorks Workgroup PDM API Help
Hide Table of Contents Show 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 Integer, _
   ByVal UserPrefOption As Integer, _
   ByVal Value As TextFormat _
) As Boolean
Visual Basic (Usage) 
Dim instance As IModelDocExtension
Dim UserPref As Integer
Dim UserPrefOption As Integer
Dim Value As TextFormat
Dim value As Boolean
 
value = instance.SetUserPreferenceTextFormat(UserPref, UserPrefOption, Value)
C# 
bool SetUserPreferenceTextFormat( 
   int UserPref,
   int UserPrefOption,
   TextFormat Value
)
C++/CLI 
bool SetUserPreferenceTextFormat( 
&   int UserPref,
&   int UserPrefOption,
&   TextFormat^ Value
)

Parameters

UserPref
User preference as defined by swUserPreferenceTextFormat_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
Text format to which to assign the user preference specified in UserPref

Return Value

True if the user preference is set, false if not

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


Related SolidWorks Forum Content

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:   SetUserPreferenceTextFormat Method (IModelDocExtension)
*Comment:  
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) 2012 SP05

The search functionality within the web help is in a beta test phase and you may experience periodic delays or interruptions in its performance. These are the normal and ordinary features of a beta test and shall not under any circumstances give rise to any liability on the part of DS SolidWorks or its licensors. The topics within the Web-based help are not beta topics; they document API Help (English only) 2012 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.