.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
The page you are viewing does not exist in the .NET Standard 2.0+ platform documentation. This link will take you to the parent topic of the current section.
.NET Core 3.0+
The page you are viewing does not exist in the .NET Core 3.0+ platform documentation. This link will take you to the parent topic of the current section.

DashboardsModule Members

The module contained in the DevExpress.ExpressApp.Dashboards.v20.1.dll assembly.

Constructors

Name Description
DashboardsModule() Creates an instance of the DashboardsModule class.

Fields

Name Description
DashboardDetailViewName Gets the dashboard Detail View identifier ("DashboardViewer_DetailView", by default).
DashboardViewItemId Gets the dashboard View Item identifier ("DashboardViewer", by default).
DefaultDashboardDataCaption Gets the caption of the IDashboardData object ("Dashboard", by default).
DefaultDashboardDataImageName Gets the IDashboardData object's icon name ("BO_Dashboard", by default).
DefaultDashboardDataProperty
EmptyModules static Represents an empty collection of type ModuleBase. Inherited from ModuleBase.

Properties

Name Description
AdditionalControllerTypes Contains manually specified Controllers to be loaded to the Application Model. Inherited from ModuleBase.
AdditionalExportedTypes Contains manually specified business classes to be loaded to the Application Model. Inherited from ModuleBase.
Application Provides access to an XafApplication object that can be used to manage the current application. Inherited from ModuleBase.
AssemblyName For internal use only. Inherited from ModuleBase.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Container Gets the IContainer that contains the Component. Inherited from Component.
DashboardDataType Specifies the dashboard data type used by the Dashboards Module.
DataProvider static Specifies the data provider used by the Dashboards Module.
Description Specifies a textual description of a module. Inherited from ModuleBase.
DiffsStore For internal use. Inherited from ModuleBase.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
GenerateNavigationItem Specifies whether or not the Reports | Dashboards navigation item is created automatically.
HideDirectDataSourceConnections Specifies if the Data Source Wizard allows setting direct Database connections.
ModelDifferenceResourceName This property is intended for internal use. Inherited from ModuleBase.
ModuleManager Provides access to the ApplicationModulesManager object, which contains information on the modules currenly added to the application. Inherited from ModuleBase.
Name Gets the full name of a module's type. Inherited from ModuleBase.
RequiredModuleTypes Provides access to the collection of modules that are added to the current module via the Module Designer. Inherited from ModuleBase.
ResourcesExportedToModel Provides access to a collection of Resource Localizers used in the current module to extend the Application Model's IModelLocalization node. Inherited from ModuleBase.
Site Gets or sets the ISite of the Component. Inherited from Component.
Version Gets the major, minor, revision, and build numbers of a module's assembly. Inherited from ModuleBase.

Methods

Name Description
ActivateDashboardController(Controller) static Deactivates the specified Controller if the XafApplication.Modules list does not contain DashboardsModule, or the DashboardsModule.DashboardDataType property is not initialized.
AddDashboardData<T>(IObjectSpace, String, String) static Creates a dashboard data object from the specified XML string if there is no dashboard data with the specified title parameter in the database.
AddDashboardDataFromResources<T>(IObjectSpace, String, Assembly, String) static Creates a dashboard data object from the specified XML resource file if there is no dashboard data with the specified title parameter in the database.
AddGeneratorUpdaters(ModelNodesGeneratorUpdaters) Registers the Generator Updater of the Dashboards Module.
AddModelNodeUpdaters(IModelNodeUpdaterRegistrator) Registers node updaters in the application. Inherited from ModuleBase.
AddModelNodeValidators(IModelNodeValidatorRegistrator) This method is intended for internal use. Inherited from ModuleBase.
CreateModule(Type, ModelStoreBase) static Creates an XAF module instance of the specified type. Inherited from ModuleBase.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
CustomizeLogics(CustomLogics) Allows you to override domain logic classes registered for Application Model interfaces. Inherited from ModuleBase.
CustomizeTypesInfo(ITypesInfo) Customizes metadata on business classes specific to the DashboardsModule before loading the metadata to the Application Model's BOModel node.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
ExtendModelInterfaces(ModelInterfaceExtenders) Extends the Application Model with the IModelClassDashboardsVisibility interface.
FindDashboardDataType(XafApplication) static Returns the DashboardsModule.DashboardDataType value of the DashboardsModule instance added to the XafApplication.Modules list.
FindDashboardModule(ModuleList) static Returns the DashboardsModule instance which is added to the XafApplication.Modules list.
GetControllerTypes() Returns a collection of Controllers loaded to the Application Model. Inherited from ModuleBase.
GetExportedTypes() Returns a collection of business classes loaded to the Application Model. Inherited from ModuleBase.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetModuleUpdaters(IObjectSpace, Version) Returns the list of ModuleUpdater updaters that handle database updates for the DashboardsModule module.
GetRealModuleType(Type) static Returns the type of an XAF Module. Inherited from ModuleBase.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetStartupActions() Returns a list of Pop-up Window Show Actions that must be executed before loading the application's main Window. Inherited from ModuleBase.
GetType() Gets the Type of the current instance. Inherited from Object.
GetXafResourceLocalizerTypes() Returns a collection of Resource Localizer types that can be used in an application that uses the current module. Inherited from ModuleBase.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
IsExportedType(Type) Detects whether the specified type is exported to the system class. Inherited from ModuleBase.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Setup(ApplicationModulesManager) Sets up a module after it has been created. Inherited from ModuleBase.
Setup(XafApplication) Sets up the DashboardsModule after it has been added to the XafApplication.Modules collection.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
See Also