com.esri.arcgis.carto
Interface ICustomOverlayGrid

All Superinterfaces:
IMapGrid, Serializable
All Known Implementing Classes:
CustomOverlayGrid

public interface ICustomOverlayGrid
extends IMapGrid, Serializable

Provides access to members that control the custom overlay grid.

Remarks

A custom overlay grid is a map grid with grid lines read from a feature.
The ICustomOverlayGrid interface gives you access to the feature class that the grid lines are read from through the DataSource property. It also lets you specify which field in this feature class will label the grid using the LabelField property.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
IGraticule, ICustomOverlayGrid, IMeasuredGrid, IIndexGrid, IMapGrid

Method Summary
 IFeatureClass getDataSource()
          The data source containing the grid cells.
 String getLabelField()
          The name of the field used to label the grid.
 void setDataSource(IFeatureClass featureClass)
          The data source containing the grid cells.
 void setLabelField(String fieldName)
          The name of the field used to label the grid.
 
Methods inherited from interface com.esri.arcgis.carto.IMapGrid
draw, generateGraphics, getBorder, getExteriorWidth, getLabelFormat, getLineSymbol, getName, getSubTickCount, getSubTickLength, getSubTickLineSymbol, getTickLength, getTickLineSymbol, getTickMarkSymbol, isVisible, prepareForOutput, queryLabelVisibility, querySubTickVisibility, queryTickVisibility, setBorder, setDefaults, setLabelFormat, setLabelVisibility, setLineSymbol, setName, setSubTickCount, setSubTickLength, setSubTickLineSymbol, setSubTickVisibility, setTickLength, setTickLineSymbol, setTickMarkSymbol, setTickVisibility, setVisible
 

Method Detail

getDataSource

IFeatureClass getDataSource()
                            throws IOException,
                                   AutomationException
The data source containing the grid cells.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Returns:
A reference to a com.esri.arcgis.geodatabase.IFeatureClass
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDataSource

void setDataSource(IFeatureClass featureClass)
                   throws IOException,
                          AutomationException
The data source containing the grid cells.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLabelField

String getLabelField()
                     throws IOException,
                            AutomationException
The name of the field used to label the grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLabelField

void setLabelField(String fieldName)
                   throws IOException,
                          AutomationException
The name of the field used to label the grid.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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