com.esri.arcgis.carto
Interface IACRasterShieldSymbol

All Superinterfaces:
Serializable
All Known Implementing Classes:
ACRasterShieldSymbol

public interface IACRasterShieldSymbol
extends Serializable

Provides access to members that control ArcIMS raster shield symbol.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 String getFont()
          The font name.
 IColor getFontColor()
          The font color.
 int getFontSize()
          The font size.
 int getFontStyle()
          The font style.
 String getImage()
          The path to the image.
 int getLabelMode()
          The label mode.
 int getPrintMode()
          The print mode.
 IColor getShadowColor()
          The shadow color.
 IPoint getTextPosition()
          The text position on the bitmap.
 String getURL()
          The url to access the image.
 boolean isBoundary()
          Indicates if a boundary is drawn.
 boolean isShadow()
          Indicates if the shadow is used.
 void setBoundary(boolean flag)
          Indicates if a boundary is drawn.
 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 setImage(String path)
          The path to the image.
 void setLabelMode(int labelMode)
          The label mode.
 void setPrintMode(int printMode)
          The print mode.
 void setShadow(boolean flag)
          Indicates if the shadow is used.
 void setShadowColor(IColor color)
          The shadow color.
 void setTextPosition(IPoint point)
          The text position on the bitmap.
 void setURL(String uRL)
          The url to access the image.
 

Method Detail

getURL

String getURL()
              throws IOException,
                     AutomationException
The url to access the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setURL

void setURL(String uRL)
            throws IOException,
                   AutomationException
The url to access the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getImage

String getImage()
                throws IOException,
                       AutomationException
The path to the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setImage

void setImage(String path)
              throws IOException,
                     AutomationException
The path to the image.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

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.

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.

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.

getTextPosition

IPoint getTextPosition()
                       throws IOException,
                              AutomationException
The text position on the bitmap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geometry.IPoint
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setTextPosition

void setTextPosition(IPoint point)
                     throws IOException,
                            AutomationException
The text position on the bitmap.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
point - A reference to a com.esri.arcgis.geometry.IPoint (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getLabelMode

int getLabelMode()
                 throws IOException,
                        AutomationException
The label mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLabelMode

void setLabelMode(int labelMode)
                  throws IOException,
                         AutomationException
The label mode.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isBoundary

boolean isBoundary()
                   throws IOException,
                          AutomationException
Indicates if a boundary is drawn.

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.

setBoundary

void setBoundary(boolean flag)
                 throws IOException,
                        AutomationException
Indicates if a boundary is drawn.

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.