Hide Table of Contents
GetUseDocTextFormat Method (IAnnotation)

Gets whether SolidWorks is currently using the document default text format setting for this annotation.

.NET Syntax

Visual Basic (Declaration) 
Function GetUseDocTextFormat( _
   ByVal Index As Integer _
) As Boolean
Visual Basic (Usage) 
Dim instance As IAnnotation
Dim Index As Integer
Dim value As Boolean
value = instance.GetUseDocTextFormat(Index)
bool GetUseDocTextFormat( 
   int Index
bool GetUseDocTextFormat( 
&   int Index


Number indicating which text within this annotation to check (see Remarks)

Return Value

True if the setting is a document default setting, false if not


The behavior of this method differs slightly depending on the type of annotation.

  • Weld, Datum Target, Datum Feature, and Surface Finish Symbols

    These symbols always use the document default setting for dimension text format of the text objects within the symbol. Therefore, this method always returns True for these annotation types. The index argument is not used and should be set to 0.
  • Geometric Tolerance Symbols, Display Dimensions, and Simple Notes

    These symbols can use the document default setting to display all of the text objects within the symbol (dimension text setting for the geometric tolerance symbols and display dimensions, or note text setting for notes), in which case this method returns True. They can also use a local format, in which case this method returns false. The index argument is not used and should be set to 0.
  • Blocks and Compound Notes

    These symbols can contain several different pieces of text, each individually using the document default setting for notes or a local format. The index argument identifies the text. The index value is 0-based. If the index value is invalid, this method returns True. To get the number of text or text format objects, use IAnnotation::GetTextFormatCount.

To get the text format object for this annotation, use IAnnotation::GetTextFormat, IAnnotation::IGetTextFormat, IAnnotation::SetTextFormat, or IAnnotation::ISetTextFormat.


See Also


SolidWorks 2000 FCS, Revision Number 8.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:   GetUseDocTextFormat Method (IAnnotation)
*   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) 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.