com.esri.arcgis.display
Interface IDotDensityMasking

All Superinterfaces:
Serializable
All Known Implementing Classes:
DotDensityFillSymbol

public interface IDotDensityMasking
extends Serializable

Provides access to the masking properties of a dot density fill symbol.

Description

Use this interface to access the masking properties of a DotDensityRenderer. To access a renderer's masking layer, use IDotDensityRenderer.ControlLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IDotDensityFillSymbol, IDotDensityFillSymbol2

Method Summary
 IGeometry getMaskGeometry()
          The geometry used for masking (can be a geometry collection).
 boolean isExcludeMask()
          Indicates if the dots are to be excluded from the mask area.
 boolean isUseMasking()
          Indicates if masking is used.
 void setExcludeMask(boolean excludeMask)
          Indicates if the dots are to be excluded from the mask area.
 void setMaskGeometryByRef(IGeometry geometry)
          The geometry used for masking (can be a geometry collection).
 void setUseMasking(boolean useMasking)
          Indicates if masking is used.
 

Method Detail

setMaskGeometryByRef

void setMaskGeometryByRef(IGeometry geometry)
                          throws IOException,
                                 AutomationException
The geometry used for masking (can be a geometry collection).

Description

The geometry used for masking. This usually comes from IDotDensityRenderer.ControlLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Parameters:
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.

getMaskGeometry

IGeometry getMaskGeometry()
                          throws IOException,
                                 AutomationException
The geometry used for masking (can be a geometry collection).

Description

The geometry used for masking. This usually comes from IDotDensityRenderer.ControlLayer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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.

isUseMasking

boolean isUseMasking()
                     throws IOException,
                            AutomationException
Indicates if masking is used.

Description

Specifies whether or not dot density masking is used. If True , then the MaskGeometry is used to control the placement of dots within polygon features of the rendered layer.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setUseMasking

void setUseMasking(boolean useMasking)
                   throws IOException,
                          AutomationException
Indicates if masking is used.

Description

P>Controls whether masking is used. If True, then the MaskGeometry is used to control the placement of dots.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isExcludeMask

boolean isExcludeMask()
                      throws IOException,
                             AutomationException
Indicates if the dots are to be excluded from the mask area.

Description

Specifies whether or not dots are only to be placed outside the polygons of the layer specified in IDotDensityRenderer::ControlLayer, or whether or not they are only to be placed inside these polygons.

Remarks

To turn dot density masking on or off set UseMasking.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setExcludeMask

void setExcludeMask(boolean excludeMask)
                    throws IOException,
                           AutomationException
Indicates if the dots are to be excluded from the mask area.

Description

If UseMasking is True, then this property controls whether dots are placed either inside or outside the features in the masking layer. If True, then dots are only placed outside the masked area.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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