com.esri.arcgis.display
Interface IMarkerTextBackground

All Superinterfaces:
ITextBackground, Serializable
All Known Implementing Classes:
MarkerTextBackground

public interface IMarkerTextBackground
extends ITextBackground, Serializable

Provides access to members that control the marker text background.

Description

IMarkerTextBackground can be used to display a marker symbol in conjunction with text. Any marker supported by the IMarkerSymbol interface can be used as the background. These include: ICharacterMarkerSymbol, ISimpleMarkerSymbol, IArrowMarkerSymbol, and IPictureMarkerSymbol. Use the ITextBackground interface to set additional properties for IMarkerTextBackground.

Remarks

Set the MarkerSymbol you wish to use as a background using the Symbol property. The ScaleToFit property defaults to False--set this property to True if you want the Symbol to draw large enough to fit the entire text string. The Symbol object's Size property does not actually change, only its appearance when drawn.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux


Method Summary
 IMarkerSymbol getSymbol()
          The marker symbol.
 boolean isScaleToFit()
          Indicates if the marker symbol is scaled to fill the text box.
 void setScaleToFit(boolean scale)
          Indicates if the marker symbol is scaled to fill the text box.
 void setSymbolByRef(IMarkerSymbol markerSymbol)
          The marker symbol.
 
Methods inherited from interface com.esri.arcgis.display.ITextBackground
draw, getTextSymbol, queryBoundary, setTextBoxByRef, setTextSymbolByRef
 

Method Detail

getSymbol

IMarkerSymbol getSymbol()
                        throws IOException,
                               AutomationException
The marker symbol.

Description

Symbol is the marker used as the background to the text. Any IMarkerSymbol interface can be used.

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

setSymbolByRef

void setSymbolByRef(IMarkerSymbol markerSymbol)
                    throws IOException,
                           AutomationException
The marker symbol.

Description

Symbol is the marker used as the background to the text. Any IMarkerSymbol interface can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isScaleToFit

boolean isScaleToFit()
                     throws IOException,
                            AutomationException
Indicates if the marker symbol is scaled to fill the text box.

Description

ScaleToFit is a Boolean indicator used to scale the marker to fit around the associated text. ScaleToFit it set to False by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setScaleToFit

void setScaleToFit(boolean scale)
                   throws IOException,
                          AutomationException
Indicates if the marker symbol is scaled to fill the text box.

Description

ScaleToFit is a Boolean indicator used to scale the marker to fit around the associated text. ScaleToFit it set to False by default.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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