Hide Table of Contents
SetTextFormat Method (ISketchText)

Sets the text format for this sketch text.

.NET Syntax

Visual Basic (Declaration) 
Function SetTextFormat( _
   ByVal UseDoc As System.Boolean, _
   ByVal TextFormat As System.Object _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As ISketchText
Dim UseDoc As System.Boolean
Dim TextFormat As System.Object
Dim value As System.Boolean
value = instance.SetTextFormat(UseDoc, TextFormat)
System.bool SetTextFormat( 
   System.bool UseDoc,
   System.object TextFormat
System.bool SetTextFormat( 
&   System.bool UseDoc,
&   System.Object^ TextFormat



True to use the default model text format, false to use a local text format


Local text format to use if UseDoc is false

Return Value

True if the text format was successfully set, false if not


To set the text format, you must be editing the sketch. See IModelDoc2::EditSketch or ISketchManager::InsertSketch.

To change the text format of an existing sketch text, get the ITextFormat object using ISketchText::GetTextFormat or ISketchText::IGetTextFormat, next use the various ITextFormat APIs to set the text format properties to what you want the sketch text to look like. Then use this method to change how the sketch text looks. To make the sketch text use the default model text format, use this method with the useDoc argument set to True.

To determine if this sketch text is using the default model text format or not, use ISketchText::GetUseDocTextFormat.


See Also


SOLIDWORKS 2001Plus FCS, Revision Number 10.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:   SetTextFormat Method (ISketchText)
*   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) 2016 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.