com.esri.arcgis.display
Interface IFormattedTextSymbol

All Superinterfaces:

ITextSymbol, java.io.Serializable

All Known Implementing Classes:

IFormattedTextSymbolProxy, TextMarkerSymbol, TextSymbol

public interface IFormattedTextSymbol
extends ITextSymbol, java.io.Serializable

COM Interface 'IFormattedTextSymbol'. Generated 3/19/2015 1:20:55 PM from 'C:\ArcGIS\COM\esriDisplay.olb'

Description: 'Provides access to members that control the formatted text symbol.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IIDb65a3e72_2993_11d1_9a43_0080c7ec5c96
static int	xxDummy Deprecated. Internal use only

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

IIDa80b5e91_7f9c_11d0_9410_080009eebecb

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

Field Detail

IIDb65a3e72_2993_11d1_9a43_0080c7ec5c96

static final int IIDb65a3e72_2993_11d1_9a43_0080c7ec5c96

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

getShadowColor

IColor getShadowColor()
                      throws java.io.IOException,
                             AutomationException

The shadow color.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadowColor

void setShadowColor(IColor shadowColor)
                    throws java.io.IOException,
                           AutomationException

The shadow color.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShadowXOffset

double getShadowXOffset()
                        throws java.io.IOException,
                               AutomationException

The shadow X offset.

Returns:

The xOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadowXOffset

void setShadowXOffset(double xOffset)
                      throws java.io.IOException,
                             AutomationException

The shadow X offset.

Parameters:

xOffset - The xOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getShadowYOffset

double getShadowYOffset()
                        throws java.io.IOException,
                               AutomationException

The shadow Y offset.

Returns:

The yOffset

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setShadowYOffset

void setShadowYOffset(double yOffset)
                      throws java.io.IOException,
                             AutomationException

The shadow Y offset.

Parameters:

yOffset - The yOffset (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPosition

int getPosition()
                throws java.io.IOException,
                       AutomationException

The text position.

Returns:

A com.esri.arcgis.display.esriTextPosition constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPosition

void setPosition(int textPosition)
                 throws java.io.IOException,
                        AutomationException

The text position.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCase

int getCase()
            throws java.io.IOException,
                   AutomationException

The text case.

Returns:

A com.esri.arcgis.display.esriTextCase constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCase

void setCase(int textCase)
             throws java.io.IOException,
                    AutomationException

The text case.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterSpacing

double getCharacterSpacing()
                           throws java.io.IOException,
                                  AutomationException

The character spacing.

Returns:

The characterSpacing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterSpacing

void setCharacterSpacing(double characterSpacing)
                         throws java.io.IOException,
                                AutomationException

The character spacing.

Parameters:

characterSpacing - The characterSpacing (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCharacterWidth

double getCharacterWidth()
                         throws java.io.IOException,
                                AutomationException

The character width.

Returns:

The characterWidth

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setCharacterWidth

void setCharacterWidth(double characterWidth)
                       throws java.io.IOException,
                              AutomationException

The character width.

Parameters:

characterWidth - The characterWidth (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWordSpacing

double getWordSpacing()
                      throws java.io.IOException,
                             AutomationException

The word spacing.

Returns:

The wordSpacing

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWordSpacing

void setWordSpacing(double wordSpacing)
                    throws java.io.IOException,
                           AutomationException

The word spacing.

Parameters:

wordSpacing - The wordSpacing (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isKerning

boolean isKerning()
                  throws java.io.IOException,
                         AutomationException

Indicates if kerning is on.

Returns:

The kerning

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setKerning

void setKerning(boolean kerning)
                throws java.io.IOException,
                       AutomationException

Indicates if kerning is on.

Parameters:

kerning - The kerning (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLeading

double getLeading()
                  throws java.io.IOException,
                         AutomationException

The character leading.

Returns:

The leading

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLeading

void setLeading(double leading)
                throws java.io.IOException,
                       AutomationException

The character leading.

Parameters:

leading - The leading (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDirection

int getDirection()
                 throws java.io.IOException,
                        AutomationException

The text direction.

Returns:

A com.esri.arcgis.display.esriTextDirection constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDirection

void setDirection(int textDirection)
                  throws java.io.IOException,
                         AutomationException

The text direction.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFlipAngle

double getFlipAngle()
                    throws java.io.IOException,
                           AutomationException

The flip angle.

Returns:

The flipAngle

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFlipAngle

void setFlipAngle(double flipAngle)
                  throws java.io.IOException,
                         AutomationException

The flip angle.

Parameters:

flipAngle - The flipAngle (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getBackground

ITextBackground getBackground()
                              throws java.io.IOException,
                                     AutomationException

The text background object.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setBackgroundByRef

void setBackgroundByRef(ITextBackground background)
                        throws java.io.IOException,
                               AutomationException

The text background object.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isTypeSetting

boolean isTypeSetting()
                      throws java.io.IOException,
                             AutomationException

Indicates if typesetting is used.

Returns:

The typeSetting

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTypeSetting

void setTypeSetting(boolean typeSetting)
                    throws java.io.IOException,
                           AutomationException

Indicates if typesetting is used.

Parameters:

typeSetting - The typeSetting (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFillSymbol

IFillSymbol getFillSymbol()
                          throws java.io.IOException,
                                 AutomationException

The fill symbol.

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFillSymbolByRef

void setFillSymbolByRef(IFillSymbol fillSymbol)
                        throws java.io.IOException,
                               AutomationException

The fill symbol.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.