com.esri.arcgis.arcscene
Interface ISxDocumentEventsDisp

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

ISxDocumentEventsDispAdapter, ISxDocumentEventsDispProxy

public interface ISxDocumentEventsDisp
extends EventListener, Serializable

Provides access to events fired by ArcScene.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Method Summary

boolean	beforeCloseDocument(ISxDocumentEventsDispBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
boolean	closeDocument(ISxDocumentEventsDispCloseDocumentEvent theEvent) Fired when a document is closed.
boolean	newDocument(ISxDocumentEventsDispNewDocumentEvent theEvent) Fired when a new document is created.
boolean	onContextMenu(ISxDocumentEventsDispOnContextMenuEvent theEvent) Fired when a context menu should be displayed at the given xy location.
boolean	openDocument(ISxDocumentEventsDispOpenDocumentEvent theEvent) Fired when a document is opened.
boolean	vBAReset(ISxDocumentEventsDispVBAResetEvent theEvent) Fired when VBA is reset.

Method Detail

onContextMenu

boolean onContextMenu(ISxDocumentEventsDispOnContextMenuEvent theEvent)
                      throws IOException,
                             AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The bHandled

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

boolean newDocument(ISxDocumentEventsDispNewDocumentEvent theEvent)
                    throws IOException,
                           AutomationException

Fired when a new document is created. Return true if handled.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDocument

boolean openDocument(ISxDocumentEventsDispOpenDocumentEvent theEvent)
                     throws IOException,
                            AutomationException

Fired when a document is opened. Return true if handled.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

boolean beforeCloseDocument(ISxDocumentEventsDispBeforeCloseDocumentEvent theEvent)
                            throws IOException,
                                   AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

boolean closeDocument(ISxDocumentEventsDispCloseDocumentEvent theEvent)
                      throws IOException,
                             AutomationException

Fired when a document is closed. Return true if handled.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

vBAReset

boolean vBAReset(ISxDocumentEventsDispVBAResetEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when VBA is reset. Return true if handled.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Supported Platforms

Windows

Parameters:

theEvent - The event

Returns:

The bStop

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.