com.esri.arcgis.system
Interface IExtensionAccelerators

All Superinterfaces:

Serializable

All Known Implementing Classes:

AnimationExtension, Editor, IExtensionAcceleratorsProxy

public interface IExtensionAccelerators
extends Serializable

Provides access to a method that creates extension accelerators.

Description

IExtensionAccelerators is implemented by extensions to define keyboard accelerators. This interface is not normally called from client code

Remarks

The CreateAccelerators method creates the accelerators for the extension. This method is called when the accelerator table is created during application startup, when a new document is created, or when a document is opened.

When To Use

If you want any of the commands in your extension to have keyboard accelerators associated with them, your extension needs to implement IExtensionAccelerators. In your class module for your extension you would implement both IExtension and IExtensionAccelerators.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

See Also:

IAccelerator, IExtension, IAcceleratorTable

Method Summary

void	createAccelerators() Called to create the keyboard accelerators for this extension.

Method Detail

createAccelerators

void createAccelerators()
                        throws IOException,
                               AutomationException

Called to create the keyboard accelerators for this extension.

Remarks

The CreateAccelerators method creates the accelerators for the extension. This method is called when the accelerator table is created during application startup, when a new document is created, or when a document is opened.

When you use the CreateAccelerators method to assign an accelerator to one of the commands in your extension, you should check to make sure that no other command is currently using the key combination that you want to use.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Supported Platforms

Windows, Solaris, Linux

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

See Also:

IAccelerator, IAcceleratorTable