com.esri.arcgis.carto
Interface IMapClipOptions

All Superinterfaces:

Serializable

All Known Implementing Classes:

Map

public interface IMapClipOptions
extends Serializable

Provides access to the Map's clipping options.

Product Availability

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

Method Summary

IBorder	getClipBorder() An optional border drawn around ClipGeometry.
Object	getClipData() Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.
ISet	getClipFilter() Sets or returns the set of layers that will be excluded from clipping.
IGeometry	getClipGeometry() A shape that layers in the map are clipped to.
int	getClipType() Method used to clip layers in map.
boolean	isClipGridAndGraticules() Clip grids and grticules to data extent
void	setClipBorder(IBorder border) An optional border drawn around ClipGeometry.
void	setClipData(Object data) Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.
void	setClipFilter(ISet layers) Sets or returns the set of layers that will be excluded from clipping.
void	setClipGeometry(IGeometry clipGeometry) A shape that layers in the map are clipped to.
void	setClipGridAndGraticules(boolean pClipGridAndGraticules) Clip grids and grticules to data extent
void	setClipType(int type) Method used to clip layers in map.

Method Detail

getClipType

int getClipType()
                throws IOException,
                       AutomationException

Method used to clip layers in map.

Product Availability

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

Returns:

A com.esri.arcgis.carto.esriMapClipType constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipType

void setClipType(int type)
                 throws IOException,
                        AutomationException

Method used to clip layers in map.

Product Availability

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

Parameters:

type - A com.esri.arcgis.carto.esriMapClipType constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipData

Object getClipData()
                   throws IOException,
                          AutomationException

Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.

Product Availability

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

Returns:

A reference to another Object (IUnknown)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipData

void setClipData(Object data)
                 throws IOException,
                        AutomationException

Sets or returns extended clip type data, i.e., other Map when type is esriMapClipMapExtent.

Product Availability

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

Parameters:

data - A reference to another Object (IUnknown) (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipGeometry

IGeometry getClipGeometry()
                          throws IOException,
                                 AutomationException

A shape that layers in the map are clipped to.

Product Availability

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

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.

setClipGeometry

void setClipGeometry(IGeometry clipGeometry)
                     throws IOException,
                            AutomationException

A shape that layers in the map are clipped to.

Product Availability

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

Parameters:

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

getClipBorder

IBorder getClipBorder()
                      throws IOException,
                             AutomationException

An optional border drawn around ClipGeometry.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.carto.IBorder

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipBorder

void setClipBorder(IBorder border)
                   throws IOException,
                          AutomationException

An optional border drawn around ClipGeometry.

Product Availability

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

Parameters:

border - A reference to a com.esri.arcgis.carto.IBorder (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClipFilter

ISet getClipFilter()
                   throws IOException,
                          AutomationException

Sets or returns the set of layers that will be excluded from clipping.

Product Availability

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

Returns:

A reference to a com.esri.arcgis.system.ISet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipFilter

void setClipFilter(ISet layers)
                   throws IOException,
                          AutomationException

Sets or returns the set of layers that will be excluded from clipping.

Product Availability

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

Parameters:

layers - A reference to a com.esri.arcgis.system.ISet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setClipGridAndGraticules

void setClipGridAndGraticules(boolean pClipGridAndGraticules)
                              throws IOException,
                                     AutomationException

Clip grids and grticules to data extent

Product Availability

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

Parameters:

pClipGridAndGraticules - The pClipGridAndGraticules (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isClipGridAndGraticules

boolean isClipGridAndGraticules()
                                throws IOException,
                                       AutomationException

Clip grids and grticules to data extent

Product Availability

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

Returns:

The pClipGridAndGraticules

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.