Interface IExtension

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll

Provides access to members that define an extension.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("7F657EC9-DBF1-11D2-9F2F-00C04F6BC69E")]
public interface IExtension

Remarks

If you want your extension to be exposed in the Extensions dialog, you would also implement the IExtensionConfig interface. The class module for your extension would implement both IExtension and IExtensionConfig.

Properties

Name

The name of the extension.

string Name { get; }

Property Value

string

Remarks

When implementing IExtension to create a custom extension, use the Name property to set the name of this extension.

If you implement persistence (e.g. IPersistVariant) for the extension, the length of the Name property cannot exceed 31 characters.


Methods

Shutdown()

Shuts down the extension.

void Shutdown()

Remarks

When implementing IExtension to create a custom extension, use the Shutdown method to perform some action when the extension gets unloaded.

Startup(ref object)

Starts up the extension with the given initialization data.

void Startup(ref object initializationData)

Parameters

initializationData object

Remarks

When implementing IExtension to create a custom extension, use the Startup method to perform some action when the extension gets loaded.

The following list is an example of some of the common object types for the initializationData parameter.

Extension Category          initializationData object type
ESRI Mx Application            Application (IMxApplication)
ESRI Gx Applcation             Application (IGxApplication)
ESRI Editor Extensions        Editor (IEditor)