com.esri.arcgis.display
Interface IFormattedTextSymbol

All Superinterfaces:

ITextSymbol, Serializable

All Known Implementing Classes:

IFormattedTextSymbolProxy, TextMarkerSymbol, TextSymbol

public interface IFormattedTextSymbol
extends ITextSymbol, Serializable

Provides access to members that control the formatted text symbol.

Description

IFormattedTextSymbol is the interface for creating text symbols that have robust character placement and background display properties.

Remarks

Change the spread of characters in the text string by setting the CharacterSpacing property, which indicates the spacing between each character as a percentage. The default is 0, which indicates the standard character spacing, but values of -200 to 200 are valid. Lines of text can be spaced by setting the Leading property, whose units are Points.

You can change the case of every alphabetic character in the text string by setting the Case property to one of the esriTextCase constants.

You can also create subscript and superscript text by setting the Position property.

Product Availability

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

See Also:

IFormattedTextSymbol, ITextSymbol, ISimpleTextSymbol

Method Summary

ITextBackground	getBackground() The text background object.
int	getCase() The text case.
double	getCharacterSpacing() The character spacing.
double	getCharacterWidth() The character width.
int	getDirection() The text direction.
IFillSymbol	getFillSymbol() The fill symbol.
double	getFlipAngle() The flip angle.
double	getLeading() The character leading.
int	getPosition() The text position.
IColor	getShadowColor() The shadow color.
double	getShadowXOffset() The shadow X offset.
double	getShadowYOffset() The shadow Y offset.
double	getWordSpacing() The word spacing.
boolean	isKerning() Indicates if kerning is on.
boolean	isTypeSetting() Indicates if typesetting is used.
void	setBackgroundByRef(ITextBackground background) The text background object.
void	setCase(int textCase) The text case.
void	setCharacterSpacing(double characterSpacing) The character spacing.
void	setCharacterWidth(double characterWidth) The character width.
void	setDirection(int textDirection) The text direction.
void	setFillSymbolByRef(IFillSymbol fillSymbol) The fill symbol.
void	setFlipAngle(double flipAngle) The flip angle.
void	setKerning(boolean kerning) Indicates if kerning is on.
void	setLeading(double leading) The character leading.
void	setPosition(int textPosition) The text position.
void	setShadowColor(IColor shadowColor) The shadow color.
void	setShadowXOffset(double xOffset) The shadow X offset.
void	setShadowYOffset(double yOffset) The shadow Y offset.
void	setTypeSetting(boolean typeSetting) Indicates if typesetting is used.
void	setWordSpacing(double wordSpacing) The word spacing.

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

getShadowColor

IColor getShadowColor()
                      throws IOException,
                             AutomationException

The shadow color.

Description

ShadowColor is the color of the dropshadow. This can be any of the IColor interfaces.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

setShadowColor

void setShadowColor(IColor shadowColor)
                    throws IOException,
                           AutomationException

The shadow color.

Description

ShadowColor is the color of the dropshadow. This can be any of the IColor interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

shadowColor - A reference to a com.esri.arcgis.display.IColor (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IHsvColor, IHlsColor

getShadowXOffset

double getShadowXOffset()
                        throws IOException,
                               AutomationException

The shadow X offset.

Description

ShadowXOffset is the offset in points (approx. 1/72 inch) in the X or horizontal direction that the dropshadow will be displayed. Positive values offset to the right and negative values offset to the left. The default value is 0 (zero).

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.

setShadowXOffset

void setShadowXOffset(double xOffset)
                      throws IOException,
                             AutomationException

The shadow X offset.

Description

ShadowXOffset is the offset in points (approx. 1/72 inch) in the X or horizontal direction that the dropshadow will be displayed. Positive values offset to the right and negative values offset to the left. The default value is 0 (zero).

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.

getShadowYOffset

double getShadowYOffset()
                        throws IOException,
                               AutomationException

The shadow Y offset.

Description

ShadowYOffset is the offset in points (approx. 1/72 inch) in the Y or vertical direction that the dropshadow will be displayed. Positive values offset upwards and negative values offset downwards. The default value is 0 (zero).

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.

setShadowYOffset

void setShadowYOffset(double yOffset)
                      throws IOException,
                             AutomationException

The shadow Y offset.

Description

ShadowYOffset is the offset in points (approx. 1/72 inch) in the Y or vertical direction that the dropshadow will be displayed. Positive values offset upwards and negative values offset downwards. The default value is 0 (zero).

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.

getPosition

int getPosition()
                throws IOException,
                       AutomationException

The text position.

Description

Position is whether the ITextSymbol will be normal, subscript, or superscript. Use enumerations: esriTPNormal, esriTPSubscript or esriTPSuperscript.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriTextPosition constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextPosition

setPosition

void setPosition(int textPosition)
                 throws IOException,
                        AutomationException

The text position.

Description

Position is whether the IFormattedTextSymbol will be normal, subscript, or superscript.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

textPosition - A com.esri.arcgis.display.esriTextPosition constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextPosition

getCase

int getCase()
            throws IOException,
                   AutomationException

The text case.

Description

Case is whether the letters of an IFormattedTextSymbol are upper, lower, or mixed case. Use enumerations: esriTCNormal, esriTCAllcaps, esriTCsmallcaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriTextCase constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextCase

setCase

void setCase(int textCase)
             throws IOException,
                    AutomationException

The text case.

Description

Case is whether the letters of an IFormattedTextSymbol are upper, lower, or mixed case. Use enumerations: esriTCNormal, esriTCAllcaps, esriTCsmallcaps.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

textCase - A com.esri.arcgis.display.esriTextCase constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

esriTextCase

getCharacterSpacing

double getCharacterSpacing()
                           throws IOException,
                                  AutomationException

The character spacing.

Description

CharacterSpacing is the additional space that is added to each character beyond what is defined by its character box in its font. Character spacing is a percentage of the original character's length.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The characterSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

void setCharacterSpacing(double characterSpacing)
                         throws IOException,
                                AutomationException

The character spacing.

Description

CharacterSpacing is the additional space that is added to each character beyond what is defined by its character box in its font. Character spacing is a percentage of the original character's length.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

characterSpacing - The characterSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

double getCharacterWidth()
                         throws IOException,
                                AutomationException

The character width.

Description

CharacterWidth is the width that is added to each character beyond what is defined by its character box in its font. Character width is a percentage of the original character.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The characterWidth

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

void setCharacterWidth(double characterWidth)
                       throws IOException,
                              AutomationException

The character width.

Description

CharacterWidth is the width that is added to each character beyond what is defined by its character box in its font. Character width is a percentage of the original character.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

characterWidth - The characterWidth (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

double getWordSpacing()
                      throws IOException,
                             AutomationException

The word spacing.

Description

WordSpacing is the additional space that is added between words of the text string. Word spacing is a percentage of the original.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The wordSpacing

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

void setWordSpacing(double wordSpacing)
                    throws IOException,
                           AutomationException

The word spacing.

Description

WordSpacing is the additional space that is added between words of the text string. Word spacing is a percentage of the original.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

wordSpacing - The wordSpacing (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKerning

boolean isKerning()
                  throws IOException,
                         AutomationException

Indicates if kerning is on.

Description

Kerning indicates whether the specific relationship of two adjacent characters within their character cells is examined and adjusted according to the predefined font metrics specific to each typeface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The kerning

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKerning

void setKerning(boolean kerning)
                throws IOException,
                       AutomationException

Indicates if kerning is on.

Description

Kerning indicates whether the specific relationship of two adjacent characters within their character cells is examined and adjusted according to the predefined font metrics specific to each typeface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

kerning - The kerning (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeading

double getLeading()
                  throws IOException,
                         AutomationException

The character leading.

Description

Leading specifies the adjustment to regular spacing between lines. 0 units means no adjustment to regular line spacing. Leading is generally equal to or greater than the text size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The leading

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeading

void setLeading(double leading)
                throws IOException,
                       AutomationException

The character leading.

Description

Leading specifies the adjustment to regular spacing between lines. 0 units means no adjustment to regular line spacing. Leading is generally equal to or greater than the text size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

leading - The leading (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

int getDirection()
                 throws IOException,
                        AutomationException

The text direction.

Description

Direction is the enumeration that defines the flow direction of the text. There are three options: esriTDAngle, esriTDHorizontal, and esriTDVertical. esriTDHorizontal is the default Direction.

Remarks

Direction is not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriTextDirection constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int textDirection)
                  throws IOException,
                         AutomationException

The text direction.

Description

Direction is the enumeration that defines the flow direction of the text. There are three options: esriTDAngle, esriTDHorizontal, and esriTDVertical. esriTDHorizontal is the default Direction.

Remarks

Direction is not yet implemented.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

textDirection - A com.esri.arcgis.display.esriTextDirection constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlipAngle

double getFlipAngle()
                    throws IOException,
                           AutomationException

The flip angle.

Description

Flipangle specifies the angle (in degrees from the vertical) at which point rotated text is flipped (mirrored) in place. The valid range is -360 to 360.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The flipAngle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipAngle

void setFlipAngle(double flipAngle)
                  throws IOException,
                         AutomationException

The flip angle.

Description

Flipangle specifies the angle (in degrees from the vertical) at which point rotated text is flipped (mirrored) in place. The valid range is -360 to 360.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

flipAngle - The flipAngle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

ITextBackground getBackground()
                              throws IOException,
                                     AutomationException

The text background object.

Description

Background is the object displayed behind the text. IBalloonCallout, ILineCallout, ISimpleLineCallout or IMarkerTextBackground can be used as backgrounds for text.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

void setBackgroundByRef(ITextBackground background)
                        throws IOException,
                               AutomationException

The text background object.

Description

Background is the object displayed behind the text. IBalloonCallout, ILineCallout, ISimpleLineCallout or IMarkerTextBackground can be used as backgrounds for text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

background - A reference to a com.esri.arcgis.display.ITextBackground (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTypeSetting

boolean isTypeSetting()
                      throws IOException,
                             AutomationException

Indicates if typesetting is used.

Description

TypeSetting is a Boolean indicator that determines whether text formatting tags will be either executed or displayed as characters within the string. True - formatting tags will be executed. False - formatting tags will be displayed as characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The typeSetting

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeSetting

void setTypeSetting(boolean typeSetting)
                    throws IOException,
                           AutomationException

Indicates if typesetting is used.

Description

TypeSetting is a Boolean indicator that determines whether text formatting tags will be either executed or displayed as characters within the string. True - formatting tags will be executed. False - formatting tags will be displayed as characters.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

typeSetting - The typeSetting (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException

The fill symbol.

Description

FillSymbol is the fill symbol used to render the text. This can be any of the IFillSymbol interfaces.

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFillSymbolByRef

void setFillSymbolByRef(IFillSymbol fillSymbol)
                        throws IOException,
                               AutomationException

The fill symbol.

Description

FillSymbol is the fill symbol used to render the text. This can be any of the IFillSymbol interfaces.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fillSymbol - A reference to a com.esri.arcgis.display.IFillSymbol (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.