com.esri.arcgis.cartoUI
Interface IMapGridFactory

All Superinterfaces:

Serializable

All Known Implementing Classes:

CustomOverlayGridFactory, GraticuleFactory, IndexGridFactory, MeasuredGridFactory, MgrsGridFactory

public interface IMapGridFactory
extends Serializable

Provides access to members of the map grid factory.

Description

You can use the MapGridFactory coclass to quickly create map grids. The map grids created will have default properties applied. Use one of the inheriting coclasses—GraticuleFactory, IndexGridFactory, MeasuredGridFactory, or CustomOverlayGridFactory—to create the respective map grid.

The way to manage the map grids created by the MapGridFactory is detailed in the Carto Library Overview

The Create method takes a map frame as its argument and returns an IMapGrid interface to a newly created map grid. The map grid has default properties. This is similar to creating a map grid and using IMapGrid::SetDefault to assign properties to it. Name returns the name of the map grid class to which the map grid factory object belongs. An example is provided in the CartoUI Library Overview

Product Availability

Available with ArcGIS Desktop.

Method Summary

IMapGrid	create(IMapFrame mapFrame) Creates a map grid.
String	getName() The name of the map grid class.

Method Detail

getName

String getName()
               throws IOException,
                      AutomationException

The name of the map grid class.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

The name

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

create

IMapGrid create(IMapFrame mapFrame)
                throws IOException,
                       AutomationException

Creates a map grid.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

mapFrame - A reference to a com.esri.arcgis.carto.IMapFrame (in)

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.