com.esri.arcgis.display
Interface ISimpleTextSymbol

All Superinterfaces:

ITextSymbol, Serializable

All Known Implementing Classes:

ISimpleTextSymbolProxy, TextMarkerSymbol, TextSymbol

public interface ISimpleTextSymbol
extends ITextSymbol, Serializable

Provides access to members that control the simple text symbol.

Description

ISimpleTextSymbol is the interface for text symbols that have basic text display capabilties. Use IFormattedTextSymbol to create text symbols with a high degree of display control.

Product Availability

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

See Also:

IFormattedTextSymbol, ITextSymbol, ISimpleTextSymbol

Method Summary

int	getBreakCharacter() Character to be interpreted as text line end.
ITextPath	getTextPath() Path of text baseline.
double	getXOffset() Text offset along X-axis.
double	getYOffset() Text offset along Y-axis.
boolean	isClip() Indicates if the text will be clipped per geometry.
void	setBreakCharacter(int charIndex) Character to be interpreted as text line end.
void	setClip(boolean clip) Indicates if the text will be clipped per geometry.
void	setTextPathByRef(ITextPath textPath) Path of text baseline.
void	setXOffset(double xOffset) Text offset along X-axis.
void	setYOffset(double yOffset) Text offset along Y-axis.

Methods inherited from interface com.esri.arcgis.display.ITextSymbol

getAngle, getColor, getFont, getHorizontalAlignment, getSize, getText, getTextSize, getVerticalAlignment, isRightToLeft, setAngle, setColor, setFont, setHorizontalAlignment, setRightToLeft, setSize, setText, setVerticalAlignment

Method Detail

getBreakCharacter

int getBreakCharacter()
                      throws IOException,
                             AutomationException

Character to be interpreted as text line end.

Description

BreakCharacter is the character code value determining line breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The charIndex

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBreakCharacter

void setBreakCharacter(int charIndex)
                       throws IOException,
                              AutomationException

Character to be interpreted as text line end.

Description

BreakCharacter is the character code value determining line breaks.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

charIndex - The charIndex (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClip

boolean isClip()
               throws IOException,
                      AutomationException

Indicates if the text will be clipped per geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The clip

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClip

void setClip(boolean clip)
             throws IOException,
                    AutomationException

Indicates if the text will be clipped per geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

clip - The clip (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTextPath

ITextPath getTextPath()
                      throws IOException,
                             AutomationException

Path of text baseline.

Description

TextPath sets or returns a TextPath object.

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.ITextPath

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTextPathByRef

void setTextPathByRef(ITextPath textPath)
                      throws IOException,
                             AutomationException

Path of text baseline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

textPath - A reference to a com.esri.arcgis.display.ITextPath (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getXOffset

double getXOffset()
                  throws IOException,
                         AutomationException

Text offset along X-axis.

Description

XOffset sets or returns the horizontal offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The xOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setXOffset

void setXOffset(double xOffset)
                throws IOException,
                       AutomationException

Text offset along X-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

xOffset - The xOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getYOffset

double getYOffset()
                  throws IOException,
                         AutomationException

Text offset along Y-axis.

Description

YOffset sets or returns the vertical offset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The yOffset

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setYOffset

void setYOffset(double yOffset)
                throws IOException,
                       AutomationException

Text offset along Y-axis.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

yOffset - The yOffset (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.