com.esri.arcgis.cartoUI
Interface ILegendWizard

All Superinterfaces:

Serializable

All Known Implementing Classes:

LegendWizard

public interface ILegendWizard
extends Serializable

Provides access to members of the legend wizard.

Remarks

Before calling the DoModal method on the LegendWizard, you must first do appropriate setup of a Legend object. This includes creating a Legend object, adding it as a MapSurround to the FocusMap, and assigning a valid Envelope to the Legend's element geometry.

Product Availability

Available with ArcGIS Desktop.

Method Summary

boolean	doModal(int parentHWnd) Displays the legend wizard.
IMapSurroundFrame	getLegendFrame() The legend frame (valid after calling DoModal).
void	setInitialLegendFrame(IMapSurroundFrame rhs1) The initial legend frame (optional).
void	setPageLayoutByRef(IPageLayout rhs1) The page layout containing the map frame.

Method Detail

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.

setInitialLegendFrame

void setInitialLegendFrame(IMapSurroundFrame rhs1)
                           throws IOException,
                                  AutomationException

The initial legend frame (optional).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Parameters:

rhs1 - A reference to a com.esri.arcgis.carto.IMapSurroundFrame (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendFrame

IMapSurroundFrame getLegendFrame()
                                 throws IOException,
                                        AutomationException

The legend frame (valid after calling DoModal).

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Returns:

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

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

boolean doModal(int parentHWnd)
                throws IOException,
                       AutomationException

Displays the legend wizard.

Remarks

Before calling the DoModal method on the LegendWizard, you must first do appropriate setup of a Legend object. This includes creating a Legend object, adding it as a MapSurround to the FocusMap, and assigning a valid Envelope to the Legend's element geometry.

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.