IFrameDecoration Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Help for .NET developers > ArcObjects namespaces > Carto > ESRI.ArcGIS.Carto > Interfaces > IF > IFrameDecoration Interface (ArcObjects .NET 10.6 SDK)
ArcObjects Library Reference (Carto)  

IFrameDecoration Interface

Provides access to members that control frame decorations.

Product Availability

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

Members

Name Description
Read/write property Color Color of the frame decoration.
Read/write property CornerRounding Amount of corner rounding. 0=fully square. 100=fully round.
Method Draw Draws the decoration into the given display object.
Method GetGeometry Geometry used to draw the decoration.
Read/write property HorizontalSpacing Horizontal offset or gap between the decoration and the subject in points.
Read/write property Name Name of the frame decoration.
Method QueryBounds Bounding rectangle of the geometry including the area covered by the border.
Read/write property VerticalSpacing Vertical offset or gap between the decoration and the subject in points.

CoClasses that implement IFrameDecoration

CoClasses and Classes Description
SymbolBackground Background drawn using a symbol.
SymbolBorder Border drawn using a symbol.
SymbolShadow Shadow drawn using a symbol.

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.