Class ExtensionManagerClass

Namespace
ESRI.ArcGIS.esriSystem
Assembly
ESRI.Server.System.dll
[ClassInterface(ClassInterfaceType.None)]
[Guid("6120BC0A-3D90-4274-97CA-713C41F1FAFF")]
public class ExtensionManagerClass : ExtensionManager, IExtensionManager, IExtensionManagerAdmin, ISupportErrorInfo, IJITExtensionManager
Inheritance
ExtensionManagerClass
Implements
Inherited Members

Constructors

ExtensionManagerClass()

public ExtensionManagerClass()

Explicit Interface Implementations

AddExtension(UID, ref object)

Creates a single extension given the CLSID, then passes initializationData to IExtension::Startup.

virtual void AddExtension(UID ExtensionCLSID, ref object initializationData)

Parameters

ExtensionCLSID UID
initializationData object

Remarks

COM coclasses are identified by a globally unique identifier (GUID). There two formats for the GUID for a coclass: a class ID (CLSID) and a ProgID. The ProgID is a text alias for a CLSID. The UID coclass can be used to represent the GUID of an extension object. You can set the IUID.Value property to either the CLSID or the ProgID.

To find the CLSID and ProgID of an ESRI extension, refer to the following technical document:

ArcObjects Developer Help > Technical Documents > ESRI Extensions: Names and IDs


For your custom extensions, the ProgID is a string composed of the name of your project used to make the extension and the class name of the extension.

Extension[int]

The extension at the specified index.

virtual IExtension Extension[int Index] { get; }

Parameters

Index int

Returns

IExtension

Remarks

This is not the only way to get a reference to an extension; the IApplication interface has FindExtensionByCLSID and FindExtensionByName methods.

ExtensionCLSID[int]

The CLSID of the extension at the specified index.

virtual UID ExtensionCLSID[int Index] { get; }

Parameters

Index int

Returns

UID

ExtensionCount

The number of extensions loaded in the application.

virtual int ExtensionCount { get; }

Returns

int

FindExtension(object)

Finds the extension by CLSID (IUID) or name (String).

virtual IExtension FindExtension(object nameOrID)

Parameters

nameOrID object

Returns

IExtension

Remarks

COM coclasses are identified by a globally unique identifier (GUID). There two formats for the GUID for a coclass: a class ID (CLSID) and a ProgID. The ProgID is a text alias for a CLSID. The UID coclass can be used to represent the GUID of an extension object. You can set the IUID.Value property to either the CLSID or the ProgID.

To find the Name, CLSID, and ProgID of an ESRI extension, refer to the following technical document:

ArcObjects Developer Help > Technical Documents > Names and IDs > Extensions

InsertExtension(UID, IExtension)

Adds an extension to the manager without initialization.

virtual void InsertExtension(UID pExtCLSID, IExtension pExtension)

Parameters

pExtCLSID UID
pExtension IExtension

InterfaceSupportsErrorInfo(ref Guid)

virtual void InterfaceSupportsErrorInfo(ref Guid riid)

Parameters

riid Guid

IsExtensionEnabled(UID)

Indicates whether the extension is currently checked on.

virtual bool IsExtensionEnabled(UID pExtCLSID)

Parameters

pExtCLSID UID

Returns

bool

IsLoaded(UID)

Indicates whether the extension is currently loaded.

virtual bool IsLoaded(UID pID)

Parameters

pID UID

Returns

bool

JITExtensionCLSID[int]

Retrieves the CLSID of the JIT Extension at index.

virtual UID JITExtensionCLSID[int Index] { get; }

Parameters

Index int

Returns

UID

JITExtensionCount

The number of just in time extensions registered with the application.

virtual int JITExtensionCount { get; }

Returns

int

RemoveExtension(IExtension)

Removes a just in time extension from the manager.

virtual void RemoveExtension(IExtension pExtension)

Parameters

pExtension IExtension

ShutdownExtensions()

Shuts down and releases the extensions that are loaded and calls IExtension::Shutdown.

virtual void ShutdownExtensions()

Remarks

There is no way to add extensions to your application using the same method, with which extensions were added to it, after the ShutdownExtensions method has been called in the same application lifetime.

 

Example 1:

Extensions were added with the AddExtension method.

The ShutdownExtensions has been called.

You cannot add extensions using the AddExtension method.

You can add extensions using the StartupExtensions method.

 

Example 2:

Extensions were added with the StartupExtensions method.

The ShutdownExtensions has been called.

You cannot add extensions using the StartupExtensions method.

You can add extensions using the AddExtension method.

 

 

 

StartupExtensions(UID, UID, ref object)

Creates and starts the extensions for the given component category, passing initializationData to each in IExtension::Startup.

virtual void StartupExtensions(UID componentCategory, UID jitCategory, ref object initializationData)

Parameters

componentCategory UID
jitCategory UID
initializationData object

Remarks

It is okay to add extensions to your Application using the AddExtension method after extensions were added with the StartupExtensions method.

You cannot add extensions to your Application using the StartupExtensions method after extensions were added with the AddExtension method. It evokes the "Automation error Catastrophic failure" (-2147418113).

The StartupExtensions method needs to be called before the AddExtensions method or used solely.