com.esri.arcgis.arcscene
Interface ISxDocumentEvents

All Superinterfaces:

EventListener, Serializable

All Known Implementing Classes:

ISxDocumentEventsAdapter, ISxDocumentEventsProxy

public interface ISxDocumentEvents
extends EventListener, Serializable

Provides access to the events fired by ArcScene.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Method Summary

boolean	beforeCloseDocument(ISxDocumentEventsBeforeCloseDocumentEvent theEvent) Fired before a document is closed.
void	closeDocument(ISxDocumentEventsCloseDocumentEvent theEvent) Fired when a document is closed.
void	newDocument(ISxDocumentEventsNewDocumentEvent theEvent) Fired when a new document is created.
void	onContextMenu(ISxDocumentEventsOnContextMenuEvent theEvent) Fired when a context menu should be displayed at the given xy location.
void	openDocument(ISxDocumentEventsOpenDocumentEvent theEvent) Fired when a document is opened.

Method Detail

onContextMenu

void onContextMenu(ISxDocumentEventsOnContextMenuEvent theEvent)
                   throws IOException,
                          AutomationException

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

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

newDocument

void newDocument(ISxDocumentEventsNewDocumentEvent theEvent)
                 throws IOException,
                        AutomationException

Fired when a new document is created.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

openDocument

void openDocument(ISxDocumentEventsOpenDocumentEvent theEvent)
                  throws IOException,
                         AutomationException

Fired when a document is opened.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

beforeCloseDocument

boolean beforeCloseDocument(ISxDocumentEventsBeforeCloseDocumentEvent 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.

Parameters:

theEvent - The event

Returns:

The abortClose

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

closeDocument

void closeDocument(ISxDocumentEventsCloseDocumentEvent theEvent)
                   throws IOException,
                          AutomationException

Fired when a document is closed.

Product Availability

Available with ArcGIS Desktop. Requires 3D Analyst Extension.

Parameters:

theEvent - The event

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.