com.esri.arcgis.carto
Interface ISymbolBorder

All Superinterfaces:
IBorder, Serializable
All Known Implementing Classes:
SymbolBorder

public interface ISymbolBorder
extends IBorder, Serializable

Provides access to members that control the SymbolBorder object.

Remarks

The ISymbolBorder interfaces is provided to set the symbol used by frame decorations to draw the borders around frame elements. See also IFrameDecoration.

ISymbolBorder inherits from IBorder and gives you control over the LineSymbol used to draw the border and the amount of CornerRounding of the border. The default value for CornerRounding is 0 which gives a square border. A value of 100 gives a round border.

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.
 ILineSymbol getLineSymbol()
          Symbol used to draw the border.
 void setCornerRounding(short rounding)
          Amount of corner rounding.
 void setLineSymbol(ILineSymbol symbol)
          Symbol used to draw the border.
 
Methods inherited from interface com.esri.arcgis.carto.IBorder
draw, getGap, getGeometry, getName, queryBounds, setGap, setName
 

Method Detail

getLineSymbol

ILineSymbol getLineSymbol()
                          throws IOException,
                                 AutomationException
Symbol used to draw the border.

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.ILineSymbol
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setLineSymbol

void setLineSymbol(ILineSymbol symbol)
                   throws IOException,
                          AutomationException
Symbol used to draw the border.

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.ILineSymbol (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.