Hide Table of Contents
ISetTextFormat Method (ISketchText)

Sets the text format for this sketch text.

.NET Syntax

Visual Basic (Declaration) 
Function ISetTextFormat( _
   ByVal UseDoc As System.Boolean, _
   ByVal TextFormat As TextFormat _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As ISketchText
Dim UseDoc As System.Boolean
Dim TextFormat As TextFormat
Dim value As System.Boolean
 
value = instance.ISetTextFormat(UseDoc, TextFormat)
C# 
System.bool ISetTextFormat( 
   System.bool UseDoc,
   TextFormat TextFormat
)
C++/CLI 
System.bool ISetTextFormat( 
&   System.bool UseDoc,
&   TextFormat^ TextFormat
) 

Parameters

UseDoc

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

TextFormat

Local text format to use if UseDoc is false

Return Value

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

Remarks

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

Availability

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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   ISetTextFormat Method (ISketchText)
*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) 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.