com.esri.arcgis.cartoUI
Interface ILegendWizard

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ILegendWizardProxy, LegendWizard

public interface ILegendWizard
extends java.io.Serializable

COM Interface 'ILegendWizard'. Generated 3/19/2015 1:21:02 PM from 'C:\ArcGIS\COM\esriCartoUI.olb'

Description: 'Provides access to members of the legend wizard.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =

Field Summary

static java.lang.String	IID Deprecated. Internal use only
static int	IID0f220a17_fabb_11d3_9fe4_00c04f6bc78e
static int	xxDummy Deprecated. Internal use only

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.

Field Detail

IID0f220a17_fabb_11d3_9fe4_00c04f6bc78e

static final int IID0f220a17_fabb_11d3_9fe4_00c04f6bc78e

See Also:

Constant Field Values

xxDummy

static final int xxDummy

Deprecated. Internal use only

See Also:

Constant Field Values

IID

static final java.lang.String IID

Deprecated. Internal use only

See Also:

Constant Field Values

Method Detail

setPageLayoutByRef

void setPageLayoutByRef(IPageLayout rhs1)
                        throws java.io.IOException,
                               AutomationException

The page layout containing the map frame.

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setInitialLegendFrame

void setInitialLegendFrame(IMapSurroundFrame rhs1)
                           throws java.io.IOException,
                                  AutomationException

The initial legend frame (optional).

Parameters:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getLegendFrame

IMapSurroundFrame getLegendFrame()
                                 throws java.io.IOException,
                                        AutomationException

The legend frame (valid after calling DoModal).

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

doModal

boolean doModal(int parentHWnd)
                throws java.io.IOException,
                       AutomationException

Displays the legend wizard.

Parameters:

parentHWnd - The parentHWnd (A COM typedef) (in)

Returns:

The ok

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.