Hide Table of Contents
GetTextFormatItems Method (IDisplayDimension)

Gets the format tokens of the specified text portion of a multi-value display dimension.

.NET Syntax

Visual Basic (Declaration) 
Function GetTextFormatItems( _
   ByVal WhichText As System.Integer, _
   ByRef TokensDefinition As System.Object, _
   ByRef TokensEvaluated As System.Object _
) As System.Integer
Visual Basic (Usage) 
Dim instance As IDisplayDimension
Dim WhichText As System.Integer
Dim TokensDefinition As System.Object
Dim TokensEvaluated As System.Object
Dim value As System.Integer
 
value = instance.GetTextFormatItems(WhichText, TokensDefinition, TokensEvaluated)
C# 
System.int GetTextFormatItems( 
   System.int WhichText,
   out System.object TokensDefinition,
   out System.object TokensEvaluated
)
C++/CLI 
System.int GetTextFormatItems( 
&   System.int WhichText,
&   [Out] System.Object^ TokensDefinition,
&   [Out] System.Object^ TokensEvaluated
) 

Parameters

WhichText
Portion of the display dimension text as defined in swDimensionTextParts_e
TokensDefinition
Array of strings containing format symbols for the text portion specified in WhichText
TokensEvaluated
Array of strings containing evaluations of symbols in TokensDefinition

Return Value

Size of returned arrays

Example

Remarks

Each display dimension's PropertyManager page contains a section called Dimension Text that specifies the format of the displayed dimension. The format consists of function symbols or tokens enclosed within angle brackets (e.g., <DIM>), each of which connotes the function or definition of the value symbols that follow it.

This method retrieves all of the symbols, both function and value, for the portion of the display dimension text specified by WhichText. It also retrieves values for any symbols that can be evaluated in TokensDefinition.

NOTE: This method does not support hole callouts.

 

See Also

Availability

SOLIDWORKS 2011 FCS, Revision Number 19.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:   GetTextFormatItems Method (IDisplayDimension)
*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.