ArcGIS Developer Help

TextSymbolClass Class

A symbol that controls how text is displayed.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Description

Use TextSymbol to create text of either IFormattedTextSymbol or ISimpleTextSymbol.

Supported Platforms

Windows, Solaris, Linux

Interfaces

Interfaces	Description
ICharacterOrientation	Provides access to characters orientation.
IClone (esriSystem)	Provides access to members that control cloning of objects.
IDisplayName	Provides access to members that return the display name of an object.
IFormattedTextSymbol	Provides access to members that control the formatted text symbol.
IMapLevel	Provides access to members that control the map level.
IMarginProperties	Provides access to members that control uniform text margin properties.
IMask	Provides access to members that control the symbol mask.
IPersist (esriSystem)
IPersistStream (esriSystem)
IPropertySupport (esriSystem)	Provides access to members that set a default property on an object.
IQueryGeometry	Provides access to members that control geometry query.
ISimpleTextSymbol	Provides access to members that control the simple text symbol.
ISymbol	Provides access to members that control symbols.
ISymbolRotation	Provides access to the symbol rotation properties.
ITextDrawSupport	Provides access to members that control how text strings are drawn.
ITextParserSupport	Provides access to members that control the text parsing support.
IWordBoundaries	Provides access to word boundaries for a text symbol.
IXMLSerialize (esriSystem)	Provides access to members that XML serialize and deserialize an object to/from XML.

Remarks

TextSymbol is the primary object for defining the display properties of a TextElement. Commonly edited properties can be set using ITextSymbol while additional interfaces such as ISimpleTextSymbol and IFormattedTextSymbol provide access to other display properties. Text properties such as highway shields and callouts are implemented as Text Backgrounds and can controlled using IFormattedTextSymbol:Background. The Text property of TextSymbol is only used for low level drawing of text. The text string should be set on the TextElement.

If you are editing Geodatabase Annotation, DO NOT control the display of annotation features by obtaining a reference to the TextSymbol through ITextElement::Symbol and change the properties. This will undermine the storage mechanism that Geodatabase Annotation utilizes for efficient storage. For more information on TextSymbols and Geodatabase Annotation, see the interface ISymbolCollectionElement.