com.esri.arcgis.controls
Interface IHookHelper

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

HookHelper, IHookHelperProxy

public interface IHookHelper
extends java.io.Serializable

COM Interface 'IHookHelper'. Generated 3/19/2015 1:21:01 PM from 'C:\ArcGIS\COM\esriControls.olb'

Description: 'Provides access to members needed when developing commands to work with the MapControl, PageLayoutControl, ArcMap, and custom controls and applications.' 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	IID128903ab_6017_47fd_81be_0109f61e9c09
static int	xxDummy Deprecated. Internal use only

Method Summary

IActiveView	getActiveView() Active view of hooked control or application.
IMap	getFocusMap() Focus map of hooked control or application.
java.lang.Object	getHook() Hook object that should be the same as the hook object passed in ICommand::OnCreate.
IOperationStack	getOperationStack() Operation stack of hooked control or application used for undo/redo operations.
IPageLayout	getPageLayout() Page layout of hooked control or application.
void	setHookByRef(java.lang.Object ppHook) Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Field Detail

IID128903ab_6017_47fd_81be_0109f61e9c09

static final int IID128903ab_6017_47fd_81be_0109f61e9c09

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

setHookByRef

void setHookByRef(java.lang.Object ppHook)
                  throws java.io.IOException,
                         AutomationException

Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Parameters:

ppHook - A reference to another Automation Object (IDispatch) (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getHook

java.lang.Object getHook()
                         throws java.io.IOException,
                                AutomationException

Hook object that should be the same as the hook object passed in ICommand::OnCreate.

Returns:

A reference to another Automation Object (IDispatch)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getActiveView

IActiveView getActiveView()
                          throws java.io.IOException,
                                 AutomationException

Active view of hooked control or application.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getPageLayout

IPageLayout getPageLayout()
                          throws java.io.IOException,
                                 AutomationException

Page layout of hooked control or application.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFocusMap

IMap getFocusMap()
                 throws java.io.IOException,
                        AutomationException

Focus map of hooked control or application.

Returns:

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

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getOperationStack

IOperationStack getOperationStack()
                                  throws java.io.IOException,
                                         AutomationException

Operation stack of hooked control or application used for undo/redo operations.

Returns:

A reference to a com.esri.arcgis.systemUI.IOperationStack

Throws:

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

AutomationException - If the ArcObject component throws an exception.