Engine Class |
Represents an instance of the application.
Represents an instance of the application.
Inheritance HierarchyNamespace: Dundas.BI
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.4.0.1000)
SyntaxThe Engine type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AppDataPath | Gets the physical path to the application's data folder. |
| ApplicationStorageEngine | Gets the database engine used for application storage. |
| CallerContext | Gets the currently-executing user context. |
| Configuration |
Gets the currently-loaded application configuration.
|
| Culture |
Gets the culture to use for formatting dates, numbers, etc. This will typically
be the culture associated with the in-context Session.
|
 | Current |
Gets the currently running instance of the application engine.
|
| HostIdentifier |
Gets the engine host identifier - a unique name that defines the engine host.
|
| ServerGroupId |
Gets the ID of the server group to which the current server belongs.
|
| ServerName | Gets the name of the server. |
| ServerQualifiedHostIdentifier | Gets the server-qualified engine host identifier. |
| Session |
Gets the Session associated with the currently-executing user context.
|
| State |
Gets the state of the application engine.
|
| TempDataPath | Gets the path where any temporary application data is saved. |
| TimeZone |
Gets the time zone to use for printing dates and times. This will typically
be the time zone associated with the in-context Session.
|
Methods| Name | Description | |
|---|---|---|
 | AddService(Type, ServiceCreatorCallback, Boolean) | Adds the specified service to the service container. (Overrides ServiceContainerAddService(Type, ServiceCreatorCallback, Boolean).) |
| AddService(Type, Object, Boolean) | Adds the specified service to the service container. (Overrides ServiceContainerAddService(Type, Object, Boolean).) |
| GetService(Type) | Gets the requested service. (Overrides ServiceContainerGetService(Type).) |
| GetServiceT |
Gets the service object of the specified type.
|
| GetServiceT(Boolean) |
Gets the service object of the specified type.
|
| RemoveService | Removes the specified service type from the service container. (Overrides ServiceContainerRemoveService(Type, Boolean).) |
| SetupExceptionTException | Populates an exception with additional information. |
| TryGetCurrentEngine |
Attempts to get the current engine instance.
|
| TryGetCurrentSession(Session) |
Gets the session associated with the caller.
|
| TryGetCurrentSession(Session, Boolean) | Gets the session associated with the caller. |
Events| Name | Description | |
|---|---|---|
 | Heartbeat | Occurs when the Engine heartbeat happens - approximately every 60 seconds. |
| Initialized |
Occurs during engine startup after all registered services implementing IRequireInitialization
have been initialized.
|
| Started |
Occurs when the call to StartEngine has completed.
|
| Stopped | Occurs when a call to ShutdownEngine has completed. |
| Stopping | Occurs when the call to ShutdownEngine has started. |
Fields
Extension Methods| Name | Description | |
|---|---|---|
 | Localize(String, Object) | Overloaded.
Gets a localized Web string.
(Defined by IEngineExtensions.) |
| Localize(Type, Object) | Overloaded.
Get a localized web string for particular enumeration value.
(Defined by IEngineExtensions.) |
| LocalizeTEnum(TEnum) | Overloaded.
Get a localized web string for particular enumeration value.
(Defined by IEngineExtensions.) |
See Also