com.esri.arcgis.arcmapui
Interface IDocumentEventsDisp

All Superinterfaces:

java.util.EventListener, java.io.Serializable

All Known Implementing Classes:

IDocumentEventsDispAdapter, IDocumentEventsDispProxy

public interface IDocumentEventsDisp
extends java.util.EventListener, java.io.Serializable

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

Description: 'Provides access to events that occur in ArcMap.' 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	DISPID_1_NAME
static java.lang.String	DISPID_2_NAME
static java.lang.String	DISPID_3_NAME
static java.lang.String	DISPID_4_NAME
static java.lang.String	DISPID_5_NAME
static java.lang.String	DISPID_6_NAME
static java.lang.String	DISPID_7_NAME
static java.lang.String	DISPID_8_NAME
static java.lang.String	IID Deprecated. Internal use only
static int	IID91e55ef5_fbc5_11d1_94a2_080009eebecb
static int	xxDummy Deprecated. Internal use only

Method Summary

boolean	activeViewChanged(IDocumentEventsDispActiveViewChangedEvent theEvent) Fired when the active view has changed.
boolean	beforeCloseDocument(IDocumentEventsDispBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
boolean	closeDocument(IDocumentEventsDispCloseDocumentEvent theEvent) Fired when a document is closed.
boolean	mapsChanged(IDocumentEventsDispMapsChangedEvent theEvent) Fired when a change is made to the map collection.
boolean	newDocument(IDocumentEventsDispNewDocumentEvent theEvent) Fired when a new document is created.
boolean	onContextMenu(IDocumentEventsDispOnContextMenuEvent theEvent) Indicates if a context menu should be displayed at the given xy location.
boolean	openDocument(IDocumentEventsDispOpenDocumentEvent theEvent) Fired when a document is opened.
boolean	vBAReset(IDocumentEventsDispVBAResetEvent theEvent) Fired when VBA is reset.

Field Detail

IID91e55ef5_fbc5_11d1_94a2_080009eebecb

static final int IID91e55ef5_fbc5_11d1_94a2_080009eebecb

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

DISPID_1_NAME

static final java.lang.String DISPID_1_NAME

See Also:

Constant Field Values

DISPID_2_NAME

static final java.lang.String DISPID_2_NAME

See Also:

Constant Field Values

DISPID_3_NAME

static final java.lang.String DISPID_3_NAME

See Also:

Constant Field Values

DISPID_4_NAME

static final java.lang.String DISPID_4_NAME

See Also:

Constant Field Values

DISPID_5_NAME

static final java.lang.String DISPID_5_NAME

See Also:

Constant Field Values

DISPID_6_NAME

static final java.lang.String DISPID_6_NAME

See Also:

Constant Field Values

DISPID_7_NAME

static final java.lang.String DISPID_7_NAME

See Also:

Constant Field Values

DISPID_8_NAME

static final java.lang.String DISPID_8_NAME

See Also:

Constant Field Values

Method Detail

activeViewChanged

boolean activeViewChanged(IDocumentEventsDispActiveViewChangedEvent theEvent)
                          throws java.io.IOException,
                                 AutomationException

Fired when the active view has changed.

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

mapsChanged

boolean mapsChanged(IDocumentEventsDispMapsChangedEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

Fired when a change is made to the map collection.

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

onContextMenu

boolean onContextMenu(IDocumentEventsDispOnContextMenuEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Indicates if a context menu should be displayed at the given xy location. Return true if handled.

Parameters:

theEvent - The event

Returns:

The handled

Throws:

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

AutomationException - If the ArcObject component throws an exception.

newDocument

boolean newDocument(IDocumentEventsDispNewDocumentEvent theEvent)
                    throws java.io.IOException,
                           AutomationException

Fired when a new document is created.

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

openDocument

boolean openDocument(IDocumentEventsDispOpenDocumentEvent theEvent)
                     throws java.io.IOException,
                            AutomationException

Fired when a document is opened.

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

closeDocument

boolean closeDocument(IDocumentEventsDispCloseDocumentEvent theEvent)
                      throws java.io.IOException,
                             AutomationException

Fired when a document is closed.

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

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

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

boolean beforeCloseDocument(IDocumentEventsDispBeforeCloseDocumentEvent theEvent)
                            throws java.io.IOException,
                                   AutomationException

Fired before a document is closed. Return True to abort the close process.

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

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

AutomationException - If the ArcObject component throws an exception.

vBAReset

boolean vBAReset(IDocumentEventsDispVBAResetEvent theEvent)
                 throws java.io.IOException,
                        AutomationException

Fired when VBA is reset.

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

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

AutomationException - If the ArcObject component throws an exception.