com.esri.arcgis.carto
Interface ISymbolBackground

All Superinterfaces:
IBackground, Serializable
All Known Implementing Classes:
SymbolBackground

public interface ISymbolBackground
extends IBackground, Serializable

Provides access to members that control the SymbolBackground object.

Remarks

The ISymbolBackground interfaces is provided to set the symbol used by frame decorations to draw the background of frame elements. See also IFrameDecoration.

ISymbolBackground inherits from IBackground and gives you control over the FillSymbol used to draw the bbackground and the amount of CornerRounding of the background. The default value for CornerRounding is 0 which gives a square background. A value of 100 gives a round background.

Backgrounds, borders and shadows of frame elements are managed in ArcMap on the Frame tab in the Properties of frame elements.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 short getCornerRounding()
          Amount of corner rounding.
 IFillSymbol getFillSymbol()
          Symbol used to draw the background.
 void setCornerRounding(short rounding)
          Amount of corner rounding.
 void setFillSymbol(IFillSymbol symbol)
          Symbol used to draw the background.
 
Methods inherited from interface com.esri.arcgis.carto.IBackground
draw, getGap, getGeometry, getName, queryBounds, setGap, setName
 

Method Detail

getFillSymbol

IFillSymbol getFillSymbol()
                          throws IOException,
                                 AutomationException
Symbol used to draw the background.

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.

setFillSymbol

void setFillSymbol(IFillSymbol symbol)
                   throws IOException,
                          AutomationException
Symbol used to draw the background.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getCornerRounding

short getCornerRounding()
                        throws IOException,
                               AutomationException
Amount of corner rounding. 0 = fully square. 100 = fully round.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setCornerRounding

void setCornerRounding(short rounding)
                       throws IOException,
                              AutomationException
Amount of corner rounding. 0 = fully square. 100 = fully round.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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