com.esri.arcgis.display
Interface ITextParser

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimpleTextParser

public interface ITextParser
extends Serializable

Provides access to members that parse text strings.

Remarks

To learn more about the text formatting tags supported by ArcMap, read the help for SimpleTextParser.

Product Availability

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

Method Summary

String	getText() Text to parse.
ITextSymbol	getTextSymbol() The text symbol.
void	hasTags(boolean[] hasTags) Returns true if the text contains tags and false if it does not.
void	next() Parses the next tag and string and sets the TextSymbol accordingly.
void	reset() Resets the text string tag sequence to the beginning.
void	setText(String text) Text to parse.
void	setTextSymbolByRef(ITextSymbol textSym) The text symbol.

Method Detail

getTextSymbol

ITextSymbol getTextSymbol()
                          throws IOException,
                                 AutomationException

The text symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A reference to a com.esri.arcgis.display.ITextSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextSymbolByRef

void setTextSymbolByRef(ITextSymbol textSym)
                        throws IOException,
                               AutomationException

The text symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

textSym - A reference to a com.esri.arcgis.display.ITextSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getText

String getText()
               throws IOException,
                      AutomationException

Text to parse.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The text

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setText

void setText(String text)
             throws IOException,
                    AutomationException

Text to parse.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

text - The text (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

hasTags

void hasTags(boolean[] hasTags)
             throws IOException,
                    AutomationException

Returns true if the text contains tags and false if it does not.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

hasTags - The hasTags (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

next

void next()
          throws IOException,
                 AutomationException

Parses the next tag and string and sets the TextSymbol accordingly.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

reset

void reset()
           throws IOException,
                  AutomationException

Resets the text string tag sequence to the beginning.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.