This document is archived and information here might be outdated.  Recommended version.


ICustomOverlayGrid Interface (ArcObjects .NET 10.5 SDK)
ArcObjects Library Reference (Carto)  

ICustomOverlayGrid Interface

Provides access to members that control the custom overlay grid.

Product Availability

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

Members

Description
Read/write property Border The map grid border.
Read/write property DataSource The data source containing the grid cells.
Method Draw Draws the map grid for a map frame to the given display.
Read-only property ExteriorWidth The width (in display units) of the portion of the grid that is outside of the frame.
Method GenerateGraphics Generates graphic elements corresponding to the grid lines and stores them in the specified graphics container.
Read/write property LabelField The name of the field used to label the grid.
Read/write property LabelFormat The label format for map grid labels.
Read/write property LineSymbol The symbol used to draw grid lines - null will draw no lines.
Read/write property Name The name of the map grid.
Method PrepareForOutput Prepares the map grid for output to a device.
Method QueryLabelVisibility Returns the visibility of the labels along all four sides of the map grid.
Method QuerySubTickVisibility Returns the visibility of the subticks along all four sides of the map grid.
Method QueryTickVisibility Returns the visibility of the ticks along all four sides of the map grid.
Method SetDefaults Sets the properties of the map grid to default values.
Method SetLabelVisibility Sets the visibility of the labels along all four sides of the map grid.
Method SetSubTickVisibility Sets the visibility of the subticks along all four sides of the map grid.
Method SetTickVisibility Sets the visibility of the ticks along all four sides of the map grid.
Read/write property SubTickCount The number of subticks to draw between the major ticks.
Read/write property SubTickLength The length of the subticks in points.
Read/write property SubTickLineSymbol The symbol used to draw the subtick lines.
Read/write property TickLength The length of the major ticks in points.
Read/write property TickLineSymbol The line symbol used to draw the major ticks.
Read/write property TickMarkSymbol The symbol used to draw tick marks at the grid interval intersections - null will draw no tick marks.
Read/write property Visible Indicates if the map grid is visible.

Inherited Interfaces

Interfaces Description
IMapGrid Provides access to members that control a map grid.

CoClasses that implement ICustomOverlayGrid

CoClasses and Classes Description
CustomOverlayGrid A custom map 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.

See Also

ICustomOverlayGrid Interface | IMapGrid Interface | IGraticule Interface | IIndexGrid Interface | IMeasuredGrid Interface