Class DddServerEnvironmentClass
- Namespace
- ESRI.ArcGIS.Geodatabase
- Assembly
- ESRI.Server.Geodatabase.dll
[Guid("3B6C52A4-7231-4189-B341-C30E7FB58BCF")]
[ClassInterface(ClassInterfaceType.None)]
public class DddServerEnvironmentClass : DddServerEnvironment, IExtension, IExtensionConfig, ISupportErrorInfo
- Inheritance
-
DddServerEnvironmentClass
- Implements
- Inherited Members
Explicit Interface Implementations
Description
Detailed description of the extension.
virtual string Description { get; }
Returns
Remarks
Description is the text that is displayed for this extension in the About this extension box in the Extensions dialog.
InterfaceSupportsErrorInfo(ref Guid)
virtual void InterfaceSupportsErrorInfo(ref Guid riid)
Parameters
riidGuid
Name
The name of the extension.
virtual string Name { get; }
Returns
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.
ProductName
Name of the extension.
virtual string ProductName { get; }
Returns
Remarks
ProductName is the name that is displayed for this extension in the Extensions dialog.
Shutdown()
Shuts down the extension.
virtual 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.
virtual void Startup(ref object initializationData)
Parameters
initializationDataobject
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)
State
The state of the extension.
virtual esriExtensionState State { get; set; }
Returns
Remarks
The esriExtensionState enumeration is used with this property to specify whether the extension is enabled, disabled, or unavailable. When the state is enabled, the extension is checked in the Extensions dialog. The checked state of the extension is saved in the user settings in the registry.
If the extension is terminated prematurely (for example, from interrupting a debugging session) the State will be set to 0.