com.esri.arcgis.display
Interface IMask

All Superinterfaces:

Serializable

All Known Implementing Classes:

MultiLayerMarkerSymbol, TextSymbol

public interface IMask
extends Serializable

Provides access to members that control the symbol mask.

Description

IMask can be used to draw a buffer around markers or text. IMultiLayerMarkerSymbols and ITextSymbols both support the use of a mask. Any IFillSymbol object can be used as the MaskSymbol.

Product Availability

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

Method Summary

double	getMaskSize() The mask size.
int	getMaskStyle() The mask style.
IFillSymbol	getMaskSymbol() The mask symbol.
void	setMaskSize(double size) The mask size.
void	setMaskStyle(int style) The mask style.
void	setMaskSymbolByRef(IFillSymbol fillSym) The mask symbol.

Method Detail

getMaskStyle

int getMaskStyle()
                 throws IOException,
                        AutomationException

The mask style.

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

A com.esri.arcgis.display.esriMaskStyle constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskStyle

void setMaskStyle(int style)
                  throws IOException,
                         AutomationException

The mask style.

Description

MaskStyle is the enumeration that defines the shape of the mask. There are two options: esriMSHalo and esriMSNone. esriMSNone is the default MaskStyle.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

style - A com.esri.arcgis.display.esriMaskStyle constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaskSize

double getMaskSize()
                   throws IOException,
                          AutomationException

The mask size.

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:

The size

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskSize

void setMaskSize(double size)
                 throws IOException,
                        AutomationException

The mask size.

Description

MaskSize returns or Sets the Double (ASCII) number for the size of the mask in points (approx. 1/72 inch).

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

size - The size (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getMaskSymbol

IFillSymbol getMaskSymbol()
                          throws IOException,
                                 AutomationException

The mask symbol.

Description

MaskSymbol is the fill symbol used as the mask. Any IFillSymbol 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.IFillSymbol

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setMaskSymbolByRef

void setMaskSymbolByRef(IFillSymbol fillSym)
                        throws IOException,
                               AutomationException

The mask symbol.

Description

MaskSymbol is the fill symbol used as the mask. Any IFillSymbol interface can be used.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:

fillSym - 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.