This document is archived and information here might be outdated.  Recommended version.


IMultiPartTextElement Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

IMultiPartTextElement Interface

Provides access to methods and properties for maintaining multipart elements.

Product Availability

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

Description

IMultipartTextElement provides access to the methods to maintain and create TextElements that are multipart.  A TextElement is multipart when IMultiPartTextElement::IsMultipart returns True.

A multipart text element features an individual location for each word in the TextElement's text string. This is achieved by storing the individual geometry for each element in order in a GeometryBag, which is geometry for the TextElement.  The GeometryBag may contain the typical TextElement geometries of Point and Polyline as well as a Multipoint.  A multipart TextElement is draw by the TextSymbol with the WordTextPath.  When a specific word needs to be drawn via the OverposterTextPath, a multipoint will be stored for that word in the GeometryBag so it can be identified by the WordTextPath.


To convert an existing TextElement to multipart, simply call the ConvertToMultiPart method.  Likewise, to convert a multipart element back to a single part element, call ConvertToSinglePart.

When the text string for a multipart TextElement is updated, the number of geometries in the GeometryBag and the word count are kept in sync automatically.  Adding an extra word will simply add an extra geometry, where removing a word will remove a geometry.  Replacing a word will cause the new word to draw on the same geometry.

Members

Description
Method ConvertToMultiPart Converts the current element into a multipart element.
Method ConvertToSinglePart Converts the current element into a single part element.
Method DeletePart Delete a part in the multipart element at the specified index.
Method InsertPart Insert a part in the multipart element at the specified index.
Read-only property IsMultipart Indicates if the element is multi part.
Read-only property PartCount The number of parts in the multipart element.
Method QueryPart Returns the part in the multipart element at the specified index.
Method ReplacePart Replace a part in the multipart element at the specified index.
Method SynchronizeParts Synchronize the geometry with the text of the element.

CoClasses that implement IMultiPartTextElement

CoClasses and Classes Description
PMFTitleTextElement The Graphic Element to display dynamic PMF titles.
TextElement The Graphic Element to display text.