com.esri.arcgis.cartoUI
Interface IMapGridWizard

All Superinterfaces:
Serializable
All Known Implementing Classes:
MapGridWizard

public interface IMapGridWizard
extends Serializable

Provides access to members of the map grid wizard.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 boolean doModal(int parentHWnd)
          Shows the map grid wizard.
 IElement getGraphicElement()
          The generated graphic element, if any (valid after calling DoModal).
 IMapGrid getMapGrid()
          The specified grid (valid after calling DoModal).
 void setInitialGrid(IMapGrid rhs1)
          The initial map grid (optional).
 void setMapFrameByRef(IMapFrame rhs1)
          The map frame the grid will be added to.
 void setPageLayoutByRef(IPageLayout rhs1)
          The page layout containing the map frame.
 

Method Detail

setMapFrameByRef

void setMapFrameByRef(IMapFrame rhs1)
                      throws IOException,
                             AutomationException
The map frame the grid will be added to.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setPageLayoutByRef

void setPageLayoutByRef(IPageLayout rhs1)
                        throws IOException,
                               AutomationException
The page layout containing the map frame.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

setInitialGrid

void setInitialGrid(IMapGrid rhs1)
                    throws IOException,
                           AutomationException
The initial map grid (optional).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

getMapGrid

IMapGrid getMapGrid()
                    throws IOException,
                           AutomationException
The specified grid (valid after calling DoModal).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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.

getGraphicElement

IElement getGraphicElement()
                           throws IOException,
                                  AutomationException
The generated graphic element, if any (valid after calling DoModal).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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

doModal

boolean doModal(int parentHWnd)
                throws IOException,
                       AutomationException
Shows the map grid wizard.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:
parentHWnd - The parentHWnd (A COM typedef) (in)
Returns:
The ok
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.