com.esri.arcgis.carto
Interface IFrameDecoration

All Superinterfaces:

Serializable

All Known Implementing Classes:

SymbolBackground, SymbolBorder, SymbolShadow

public interface IFrameDecoration
extends Serializable

Provides access to members that control frame decorations.

Remarks

Frame decorations are used to determine how frame elements are displayed. It is used to alter the background of, add a shadow to, or draw a neatline around any kind of frame element. Use a FrameDecoration on any object supporting IFrameProperties, such as map surround frames or group elements. A FrameDecoration is either a SymbolBackground, SymbolBorder, or SymbolShadow coclass used to draw a frame element.

The CornerRounding property alters the frame from its default rectangle shape to a rounded shape; the maximum value of 100 indicates that along the shorter edge of the frame, the corners will be rounded to the center of the edge.

The Name property corresponds to the name of the style of the border, background, or shadow if it was set from a style file.

VerticalSpacing and HorizontalSpacing refer to the gap, in points, between the frame and its subject, positive values indicating the frame draws outside the subject, and negative values indicating that it draws inside the subject.

The Draw and QueryBounds methods can be used in a similar way to the ISymbol::Draw method.

The GetGeometry method will return you the geometry computed using the frame decoration parameters for the geometry of the frame element you need to pass as input.

The ISymbolBackground, ISymbolBorder, and ISymbolShadow interfaces are provided to set the symbols used by frame decorations.

The IBackground, IBorder, and IShadow interfaces can also be used to set the properties of frame decorations. These properties and methods provided by these interfaces are the same as those described here for frame decorations. The only notable exception is that IBorder and IBackground both provide a Gap property that allows to set at once the VerticalSpacing and HorizontalSpacing properties with the same value.

Finally, the IFrameElement interface allows you to get or set the Background and Border. Or you may access the frame element through the IFrameProperties interface to access the Background, Border, and Shadow.

Product Availability

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

Method Summary

void	draw(IDisplay display, IGeometry geometry) Draws the decoration into the given display object.
IColor	getColor() Color of the frame decoration.
short	getCornerRounding() Amount of corner rounding.
IGeometry	getGeometry(IDisplay display, IGeometry shape) Geometry used to draw the decoration.
double	getHorizontalSpacing() Horizontal offset or gap between the decoration and the subject in points.
String	getName() Name of the frame decoration.
double	getVerticalSpacing() Vertical offset or gap between the decoration and the subject in points.
void	queryBounds(IDisplay display, IGeometry geometry, IEnvelope bounds) Bounding rectangle of the geometry including the area covered by the border.
void	setColor(IColor color) Color of the frame decoration.
void	setCornerRounding(short rounding) Amount of corner rounding.
void	setHorizontalSpacing(double points) Horizontal offset or gap between the decoration and the subject in points.
void	setName(String name) Name of the frame decoration.
void	setVerticalSpacing(double points) Vertical offset or gap between the decoration and the subject in points.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

Name of the frame decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

void setName(String name)
             throws IOException,
                    AutomationException

Name of the frame decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

name - The name (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getColor

IColor getColor()
                throws IOException,
                       AutomationException

Color of the frame decoration.

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.

setColor

void setColor(IColor color)
              throws IOException,
                     AutomationException

Color of the frame decoration.

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.

getHorizontalSpacing

double getHorizontalSpacing()
                            throws IOException,
                                   AutomationException

Horizontal offset or gap between the decoration and the subject in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The points

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHorizontalSpacing

void setHorizontalSpacing(double points)
                          throws IOException,
                                 AutomationException

Horizontal offset or gap between the decoration and the subject in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

points - The points (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getVerticalSpacing

double getVerticalSpacing()
                          throws IOException,
                                 AutomationException

Vertical offset or gap between the decoration and the subject in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The points

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setVerticalSpacing

void setVerticalSpacing(double points)
                        throws IOException,
                               AutomationException

Vertical offset or gap between the decoration and the subject in points.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

points - The points (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.

queryBounds

void queryBounds(IDisplay display,
                 IGeometry geometry,
                 IEnvelope bounds)
                 throws IOException,
                        AutomationException

Bounding rectangle of the geometry including the area covered by the border.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

bounds - A reference to a com.esri.arcgis.geometry.IEnvelope (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

IGeometry getGeometry(IDisplay display,
                      IGeometry shape)
                      throws IOException,
                             AutomationException

Geometry used to draw the decoration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

shape - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

draw

void draw(IDisplay display,
          IGeometry geometry)
          throws IOException,
                 AutomationException

Draws the decoration into the given display object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

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

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.