com.esri.arcgis.carto
Interface IACTextSymbol

All Superinterfaces:
Serializable
All Known Implementing Classes:
ACTextMarkerSymbol, ACTextSymbol

public interface IACTextSymbol
extends Serializable

Provides access to members that control ArcIMS text symbol.

Product Availability

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


Method Summary
 IColor getBlockoutColor()
          The background color.
 String getFont()
          The font name.
 IColor getFontColor()
          The font color.
 int getFontSize()
          The font size.
 int getFontStyle()
          The font style.
 IColor getGlowingColor()
          The glowing color.
 int getInterval()
          The interval.
 IColor getOutlineColor()
          The outline color.
 int getPrintMode()
          The print mode.
 IColor getShadowColor()
          The shadow color.
 boolean isBlockout()
          Indicates if the background is used.
 boolean isGlowing()
          Indicates if the glow is used.
 boolean isOutline()
          Indicates if the outline is used.
 boolean isShadow()
          Indicates if the shadow is used.
 void setBlockout(boolean flag)
          Indicates if the background is used.
 void setBlockoutColor(IColor color)
          The background color.
 void setFont(String font)
          The font name.
 void setFontColor(IColor color)
          The font color.
 void setFontSize(int fontSize)
          The font size.
 void setFontStyle(int fontStyle)
          The font style.
 void setGlowing(boolean flag)
          Indicates if the glow is used.
 void setGlowingColor(IColor color)
          The glowing color.
 void setInterval(int interval)
          The interval.
 void setOutline(boolean flag)
          Indicates if the outline is used.
 void setOutlineColor(IColor color)
          The outline color.
 void setPrintMode(int printMode)
          The print mode.
 void setShadow(boolean flag)
          Indicates if the shadow is used.
 void setShadowColor(IColor color)
          The shadow color.
 

Method Detail

getFont

String getFont()
               throws IOException,
                      AutomationException
The font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The font
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFont

void setFont(String font)
             throws IOException,
                    AutomationException
The font name.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
font - The font (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontStyle

int getFontStyle()
                 throws IOException,
                        AutomationException
The font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.acFontStyle constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontStyle

void setFontStyle(int fontStyle)
                  throws IOException,
                         AutomationException
The font style.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fontStyle - A com.esri.arcgis.carto.acFontStyle constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontSize

int getFontSize()
                throws IOException,
                       AutomationException
The font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The fontSize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setFontSize

void setFontSize(int fontSize)
                 throws IOException,
                        AutomationException
The font size.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
fontSize - The fontSize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFontColor

IColor getFontColor()
                    throws IOException,
                           AutomationException
The font color.

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.

setFontColor

void setFontColor(IColor color)
                  throws IOException,
                         AutomationException
The font color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
color - 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.

isOutline

boolean isOutline()
                  throws IOException,
                         AutomationException
Indicates if the outline is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setOutline

void setOutline(boolean flag)
                throws IOException,
                       AutomationException
Indicates if the outline is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOutlineColor

IColor getOutlineColor()
                       throws IOException,
                              AutomationException
The outline color.

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.

setOutlineColor

void setOutlineColor(IColor color)
                     throws IOException,
                            AutomationException
The outline color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
color - 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.

isGlowing

boolean isGlowing()
                  throws IOException,
                         AutomationException
Indicates if the glow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGlowing

void setGlowing(boolean flag)
                throws IOException,
                       AutomationException
Indicates if the glow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getGlowingColor

IColor getGlowingColor()
                       throws IOException,
                              AutomationException
The glowing color.

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.

setGlowingColor

void setGlowingColor(IColor color)
                     throws IOException,
                            AutomationException
The glowing color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
color - 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.

isShadow

boolean isShadow()
                 throws IOException,
                        AutomationException
Indicates if the shadow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setShadow

void setShadow(boolean flag)
               throws IOException,
                      AutomationException
Indicates if the shadow is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getShadowColor

IColor getShadowColor()
                      throws IOException,
                             AutomationException
The shadow color.

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.

setShadowColor

void setShadowColor(IColor color)
                    throws IOException,
                           AutomationException
The shadow color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
color - 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.

isBlockout

boolean isBlockout()
                   throws IOException,
                          AutomationException
Indicates if the background is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The flag
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setBlockout

void setBlockout(boolean flag)
                 throws IOException,
                        AutomationException
Indicates if the background is used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
flag - The flag (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getBlockoutColor

IColor getBlockoutColor()
                        throws IOException,
                               AutomationException
The background color.

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.

setBlockoutColor

void setBlockoutColor(IColor color)
                      throws IOException,
                             AutomationException
The background color.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
color - 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.

getInterval

int getInterval()
                throws IOException,
                       AutomationException
The interval.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
The interval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setInterval

void setInterval(int interval)
                 throws IOException,
                        AutomationException
The interval.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
interval - The interval (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getPrintMode

int getPrintMode()
                 throws IOException,
                        AutomationException
The print mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A com.esri.arcgis.carto.acPrintMode constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setPrintMode

void setPrintMode(int printMode)
                  throws IOException,
                         AutomationException
The print mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
printMode - A com.esri.arcgis.carto.acPrintMode constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.