Built-in Controllers and Actions in Extra Modules
- 26 minutes to read
The built-in Controllers and their Actions supplied with the eXpressApp Framework‘s extra modules are listed in this topic. Note that you can find more information on a particular Controller or Action in the Model Editor - navigate to the Application Model‘s ActionDesign | Controllers or ActionDesign | Actions node. To determine whether or not an Action is displayed in a particular window, make sure the Action Container that displays the Action is contained in this Template. To determine the Action’s Action Container, use the Application Model’s ActionDesign | ActionToContainerMapping node.
Audit Trail Module
AuditInformationReadonlyViewController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.AuditTrail.v18.2.dll. Actions: none.
Activated for Views that display IBaseAuditDataItemPersistent objects. Makes these Views read-only. Used to prohibit end-users from editing audit information.
AuditInformationListViewRefreshController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.AuditTrail.v18.2.dll. Actions: none.
Activated for nested List Views that display IBaseAuditDataItemPersistent objects. Make new audit entries immediately accessible, after corresponding changes to an object are saved.
AuditTrailListViewController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.AuditTrail.v18.2.dll. Actions: none.
Activated for List Views. Used internally. When a collection with a criterion is loaded, the Controller changes the audit type to ObjectChanged (if the ObjectLoaded type was set previously).
AuditTrailViewController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.AuditTrail.v18.2.dll. Actions: none.
Activated for root Detail Views. Activates the system of auditing changes for the XPO session in which a View is invoked.
Clone Object Module
CloneObjectViewController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.CloneObject.v18.2.dll. Actions: none.
Activated for List and Detail Views. Contains the Clone Action. This Action allows an end-user to clone an object currently selected in a List View or a Detail View’s current object. It invokes a Detail View with a new object. Property values of this object are copied from the object that has been cloned.
See Also: CloneObjectViewController
Conditional Appearance Module
ActionAppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
Activated for List and Detail Views. Collects Actions, mentioned in the current object’s appearance rules, and refreshes their appearance.
AppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
Activated for List and Detail Views. Collects the current appearance rules declared for the business class (see IModelConditionalAppearance and AppearanceAttribute). Exposes the RefreshItemAppearance method used by other module controllers to refresh the appearance.
See Also: AppearanceController
DetailViewItemAppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
Activated for Detail Views. Refreshes the Detail View items’ appearance.
DetailViewLayoutItemAppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
Activated for Detail Views. Refreshes the layout items’ appearance.
ListViewItemAppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
Activated for List Views. Refreshes the current ListEditor appearance, if the editor supports the ISupportAppearanceCustomization interface.
MobileAppearanceController
Platform: Mobile. Assembly: DevExpress.ExpressApp.Mobile.v18.2.dll. Actions: inherited.
Inherited from AppearanceController. Provides client-side scripts that apply appearance rules.
RefreshAppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
Activated for List and Detail Views. Enforces the ISupportRefreshItemsAppearance Controllers (ActionAppearanceController, DetailViewItemAppearanceController and DetailViewLayoutItemAppearanceController) to refresh the appearance when the View.SelectionChanged, View.CurrentObjectChanged, BaseObjectSpace.ObjectChanged and BaseObjectSpace.Committed events occur.
RefreshItemsAppearanceControllerBase<T>
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ConditionalAppearance.v18.2.dll. Actions: none.
The DetailViewItemAppearanceController‘s and DetailViewLayoutItemAppearanceController‘s abstract base class.
Dashboards Module
DashboardNavigationController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Dashboards.v18.2.dll.
Assigns a ViewShortcut to Dashboard Detail View for each navigation item supporting IModelDashboardNavigationItem interface.
HideDetailViewActionsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Dashboards.v18.2.dll.
Activated for the “DashboardViewer_DetailView” Detail View. Deactivates the NewObjectViewController, ModificationsController and DeleteObjectsViewController to prohibit creating, editing and deleting dashboard instances manually.
NewDashboardController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Dashboards.v18.2.dll.
The WinNewDashboardController‘s and WebNewDashboardController‘s base class. Implements the common functionality required to create new Dashboards.
WebDashboardActionsController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Dashboards.Web.v18.2.dll. Actions: ExportDashboardAction, DashboardParametersAction.
Activated for the IDashboardData Detail View with the “DashboardViewer_DetailView” identifier. The ExportDashboardAction Action allows end-users to export the dashboards to various formats. The DashboardParametersAction Action allows end-users to invoke the Dashboard Parameters dialog.
WebDashboardDesignerPopupController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Dashboards.Web.v18.2.dll.
Activated for the “DashboardViewer_DetailView” Detail View. Contains ASP.NET-specific code that performs the ASPxDashboard control setup.
WebDashboardDialogController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Dashboards.Web.v18.2.dll. Actions: Accept.
A DialogController descendant activated for the Dashboard Designer dialog. Introduces custom Accept Action and deactivates the Cancel Action.
WebDashboardWindowController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Dashboards.Web.v18.2.dll.
Registers the client script which performs the client-side dashboard control setup.
WebEditDashboardController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Dashboards.Web.v18.2.dll. Actions: ShowDesignerAction.
Activated in IDashboardData objects’ List and Detail Views. Makes the current View read-only to prohibit creating, editing and deleting dashboard instances manually. The ShowDesignerAction Action allows end-users to modify dashboards in the Dashboard Designer.
WebNewDashboardController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Dashboards.Web.v18.2.dll.
Inherits the NewDashboardController Controller. Contains ASP.NET-specific code, providing end-users with the ability to create new dashboards.
WinEditDashboardController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Dashboards.Win.v18.2.dll. Actions: ShowDesignerAction.
Activated in IDashboardData objects’ List and Detail Views. The ShowDesignerAction Action allows end-users to modify dashboards in the Dashboard Designer. Uses WinShowDashboardDesignerController to show the WinForms Dashboard Designer.
WinExportDashboardController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Dashboards.Win.v18.2.dll. Actions: ExportAction.
Activated for the “DashboardViewer_DetailView” Detail View. The ExportAction Action allows end-users to export the dashboards to various formats.
WinNewDashboardController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Dashboards.Win.v18.2.dll.
Inherits the NewDashboardController. Contains Windows Forms specific code, providing end-users with the ability to create new dashboards. Uses WinShowDashboardDesignerController to show the WinForms Dashboard Designer.
WinPrintDashboardController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Dashboards.Win.v18.2.dll. Actions: PrintAction.
Activated for the “DashboardViewer_DetailView” Detail View. The PrintAction Action allows end-users to print the current dashboard.
WinShowDashboardDesignerController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Dashboards.Win.v18.2.dll.
Contains the DashboardDesignerManager instance. Exposes the ShowDesigner and the GetDashboardData methods the Dashboards Module Controllers use to show the WinForms Dashboard Designer and then get the modified IDashboardData object.
File Attachments Module
FileAttachmentControllerBase
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.FileAttachment.Win.v18.2.dll. Actions: Open, SaveTo.
The base class implementing the FileAttachmentController‘s and FileAttachmentListViewController‘s common functionality.
FileAttachmentController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.FileAttachment.Win.v18.2.dll. Actions: Open, SaveTo.
Activated when the current View’s object type uses the FileAttachment attribute. The Open Action allows end-users to open a file using an associated application. The Save Action allows end-users to save a file to a local disk.
See Also:FileAttachmentController
FileAttachmentController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.FileAttachment.Web.v18.2.dll. Actions: Download.
Activated when the current View’s object type uses the FileAttachment attribute. Contains the Download Action that allows end-users to load a file’s content using a browser.
See Also:FileAttachmentController
FileAttachmentListViewController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.FileAttachment.Win.v18.2.dll. Actions: AddFromFile.
Activated for List Views, whose object type uses the FileAttachment attribute. Contains the AddFromFile Action that allows end-users to add file attachments to List Views using a standard Open File dialog. This Controller also allows adding file attachments to a List View using a drag-and-drop operation.
See Also:FileAttachmentListViewController
HTML Property Editor Module
GridViewDisableHtmlEncodingViewController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.PivotChart.Win.v18.2.dll. Actions: none.
Activated for List Views. If the ASPxGridView control visualizes the current List View, it turns off the HTML encoding, so the HTML markers are stripped out.
KPI Module
AutoRefreshKpiController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: none.
Inherited from the RefreshKpiController. Refreshes the IKpiInstance objects after the Collection Source’s List View collection has been recreated.
DrilldownController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: none.
Activated for nested List Views displaying IKpiInstance objects. The Controller subscribes the ActionBase.Executing event of the ListViewProcessCurrentObjectController.ProcessCurrentObjectAction Action, and displays the drilldown List View when an end-user clicks an IKpiInstance object. If the current List View is a lookup, the Executing event is not handled. The List View with an identifier, specified by the IKpiDefinition.DrillDownListViewId property, is used as drilldown by default. You can handle the Controller’s DrilldownViewInitialized event and specify a custom List View via the handler’s ModelView parameter.
ForceRefreshKpiController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: RefreshKpi.
Inherited from the RefreshKpiController. The RefreshKPI Action allows end-users to refresh displayed IKpiInstance objects manually.
KpiDashboardOrganizationItemController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: none.
Activated for Detail Views displaying KpiDashboardOrganizationItem objects. For internal use.
KpiDefinitionPreviewController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: none.
Activated for Detail Views displaying IKpiDefinition objects. Provides a preview (drilldown) of the current IKpiDefinition object, which is refreshed when the IKpiDefinition.TargetObjectType property is changed. The nested List View with an identifier, specified by the IKpiDefinition.DrillDownListViewId property is used to display a preview.
KpiInstanceDeactivateNewDeleteViewController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: none.
Activated for List and Detail Views displaying IKpiInstance objects. Deactivates the NewObjectViewController and DeleteObjectsViewController Controllers to prohibit creating and deleting KPI instances manually.
RefreshKpiController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: none.
The AutoRefreshKpiController‘s and ForceRefreshKpiController‘s base class. Activated for List and Detail Views displaying IKpiInstance objects. Implements the common functionality required to refresh KPI instances.
ShowKpiAsChartController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Kpi.v18.2.dll. Actions: ShowChart.
Activated for List Views displaying IKpiInstance objects. The ShowChart Action invokes the popup window with a KpiInstance_Chart_DetailView Detail View. This View provides the chart representation of the selected IKpiInstance object.
Maps Module
CustomizeMapPropertyEditorViewController
Platform: Mobile. Assembly: DevExpress.ExpressApp.Maps.Mobile.v18.2.dll. Actions: none.
Provides a client-side script for updating dxMaps.
GetCurrentLocationController
Platform: Mobile. Assembly: DevExpress.ExpressApp.Maps.Mobile.v18.2.dll. Actions: GetCurrentPosition.
Activated for Detail Views displaying the IMapsMarker object. Provides a client-side script for GetCurrentPosition Action which fills the current IMapsMarker object’s Latitude and Longitude properties with the current geolocation.
RefreshMapListViewController
Platform: Mobile. Assembly: DevExpress.ExpressApp.Maps.Mobile.v18.2.dll. Actions: RefreshMap.
Provides a client-side script for the RefreshMap Action which updates dxMaps.
Office Module
MailMergeController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: none.
Activated for Views that display IRichTextMailMergeData objects. Implements the common Mail Merge functionality. Provides the ability to customize Mail Merge settings.
MenuManagerController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: none.
Activated for Views that contain RichTextPropertyEditor. Creates a Menu Manager for the RichTextPropertyEditor, depending on the application settings (see Use Rich Text Documents in Business Objects). Provides the ability to customize ribbon menu and bars.
RichEditActionsController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: OpenAction, SaveAsAction
Activated for Views that contain RichTextPropertyEditor. Customizes print actions for the main menu and application button. The OpenAction allows users to open a document in different formats. The SaveAsAction allows users to save document to the file system in different formats.
RichTextGridController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: none.
Activated for List Views. Prepares the RichEdit control for displaying in a GridView cell. Provides the ability to customize the control.
RichTextServiceController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: none.
Provides the ability to customize the RichEdit control and RichTextRibbonForm.
ShowDocumentInPopupController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: none.
Activated for Views that contain RichTextPropertyEditor. Adds a context menu item. This item opens the content of the current rich text editor in a popup window. Provides the ability to customize RichTextRibbonForm.
ShowInDocumentController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Office.Win.v18.2.dll. Actions: ShowInDocument
Activated for Views. The ShowInDocument Action is activated for Views whose object type is used in Mail Merge Template objects.
Pivot Chart Module
AnalysisColumnChooserController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.PivotChart.Win.v18.2.dll. Actions: none.
Inherited from the System Module‘s ColumnChooserControllerBase Controller. Handles the Field List form.
AnalysisDataBindController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.PivotChart.v18.2.dll. Actions: BindAnalysisData, UnbindAnalysisData.
Inherited from the AnalysisViewControllerBase Controller. The BindAnalysisData Action retrieves objects to be analyzed by the pivot grid. The UnbindAnalysisData clears the pivot grid’s data source. Use these Actions to update the pivot grid’s data source after an Analysis object’s property has been changed (for example, the Criteria or ObjectType property).
AnalysisPrintPreviewController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.PivotChart.Win.v18.2.dll. Actions: PrintChart, PrintPreviewPivotGrid.
Inherits the WinAnalysisViewControllerBase Controller. The Actions of this Controller can be used to print the AnalysisEditorWin Property Editor’s content.
AnalysisReadOnlyController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.PivotChart.v18.2.dll. Actions: none.
Activated for Detail Views whose object type implements the IAnalysisInfo interface. Makes the Analysis Editor’s control read-only, when the current View is read-only.
AnalysisViewControllerBase
Platform: platform-independent. Assembly: DevExpress.ExpressApp.PivotChart.v18.2.dll. Actions: none.
Activated for Detail Views whose object type implements the IAnalysisInfo interface. If there is an Analysis Property Editor in the current Detail View, it updates the Actions state. The AnalysisDataBindController, WinAnalysisViewControllerBase and PrintChartAnalysisController inherits this Controller.
CustomizeNavigationItemsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.PivotChart.v18.2.dll. Actions: none.
Activated in the main Window. Adds the contextual Analysis navigation groups. These groups expose navigation items providing end-users with instant access to Analysis objects related to a certain navigation item when TreeList navigation is enabled.
PivotChartDesignViewController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.PivotChart.Win.v18.2.dll. Actions: ChartWizard.
Inherited from the AnalysisViewControllerBase Controller. Contains the ChartWizard Action, which allows an end-user to run the Chart Designer. This Action is not activated when the current Detail View does not contain an Analysis Property Editor. It is also disabled when the Analysis Property Editor’s chart control is invisible.
PrintChartAnalysisController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.PivotChart.Web.v18.2.dll. Actions: PrintChart.
Inherited from the AnalysisViewControllerBase Controller. Contains the PrintChart Action, which allows end-users to print the chart contained in the current Detail View’s Analysis Property Editor. This Action is enabled when an Analysis Property Editor is contained in the current Detail View.
WinAnalysisViewControllerBase
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.PivotChart.Win.v18.2.dll. Actions: none.
A platform-specific AnalysisViewControllerBase descendant. Updates the Actions state when the chart visibility changes in the AnalysisEditorWin property editor. Inherited by the AnalysisPrintPreviewController and PivotChartDesignViewController.
Pivot Grid Module
ShowChartController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.PivotGrid.Web.v18.2.dll. Actions: none.
Activated in List Views visualized by the ASPxPivotGridListEditor List Editor. The ShowChartAction toggles the visibility of a chart displayed below the pivot.
Reports V2 Module
CopyPredefinedReportsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: CopyPredefinedReport.
Activated in List Views that display IReportDataV2 objects. Provides the CopyPredefinedReport Action used to copy a selected predefined read-only report to an editable report.
CustomizeNavigationItemsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: none.
Activated in the main window. Adds the contextual Reports navigation groups. These groups expose navigation items providing end-users with instant access to reports related to a certain navigation item when TreeList navigation is enabled.
DeleteReportController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: none.
Activated in List Views that display IReportDataV2 objects. Disables the Delete action in the DeleteObjectsViewController when the selected objects contain a predefined report.
MobileCustomizeNavigationItemsController
Platform: Mobile. Assembly: DevExpress.ExpressApp.ReportsV2.Mobile.v18.2.dll. Actions: inherited.
Deactivates the inherited CustomizeNavigationItemsController.
MobileDownloadReportController
Platform: Mobile. Assembly: DevExpress.ExpressApp.ReportsV2.Mobile.v18.2.dll. Actions: DownloadReportAction.
Provides the ability to execute a client-side script when the DownloadReportAction is executed to download a report in the selected format.
MobileNewReportWizardController
Platform: Mobile. Assembly: DevExpress.ExpressApp.ReportsV2.Mobile.v18.2.dll. Actions: inherited.
Inherited from NewReportWizardController. Disables report creation.
MobilePrintSelectionBaseController
Platform: Mobile. Assembly: DevExpress.ExpressApp.ReportsV2.Mobile.v18.2.dll. Actions: inherited.
Deactivates the inherited PrintSelectionBaseController.
NewReportWizardController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: none.
Activated in List Views that display IReportDataV2 objects. Provides end-users with the ability to create new reports using a report wizard.
PreviewReportDialogController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: Accept, Cancel.
A DialogController descendant activated for the report parameters dialog. Introduces custom Accept and Cancel actions.
See Also:PreviewReportDialogController
PrintSelectionBaseController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: ShowInReport.
Activated in all Views. Provides the ShowInReport used to execute In-Place Reports.
See Also:PrintSelectionBaseController | PrintSelectionBaseController.ShowInReportAction
ReportsControllerCore
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: ExecuteReport.
Activated in List Views that display IReportDataV2 objects. Provides the ExecuteReport Action used to execute a selected report.
See Also:ReportServiceController | ReportsControllerCore.ExecuteReportAction
ReportServiceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: none.
Contains the common code used to display the Preview Report window. Exposes the ReportServiceController.ShowPreview method that invokes the Preview Report window.
See Also:ReportServiceController
WebReportsController
Platform: ASP.NET Assembly: DevExpress.ExpressApp.ReportsV2.v18.2.dll. Actions: PrintReportTo_Mht, PrintReportTo_Rtf, PrintReportTo_Pdf, PrintReportTo_Xls, ShowReportInPreviewWindow.
Inherits the ReportsControllerCore Controller. Activated in List Views that display IReportDataV2 objects. Provides the ShowReportInPreviewWindow Action and a set of Actions used to export reports to various formats. Note that these format-specific Actions are inactive unless you set the ReportsAspNetModuleV2.ShowFormatSpecificExportActions property to true.
See Also:WebReportsController
WebReportServiceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ReportsV2.Web.v18.2.dll. Actions: none.
Inherited from the ReportServiceController. Contains a platform specific code to display the Preview Report window in an ASP.NET application.
See Also: WebReportServiceController
WinReportsController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.ReportsV2.Win.v18.2.dll. Actions: none.
Inherits the ReportsControllerCore Controller. Activated in List Views that display IReportDataV2 objects. Initializes the ReportsControllerCore.ExecuteReportAction Action.
See Also: WinReportsController
WinReportServiceController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.ReportsV2.Win.v18.2.dll. Actions: none.
Inherited from the ReportServiceController. Contains the Windows Forms specific code, providing end-users with the ability to create, design and view reports.
See Also: WinReportServiceController
Scheduler Module
SchedulerActionsController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Scheduler.Web.v18.2.dll. Actions: EditSeries, OpenSeries and RestoreOccurrence.
Activated for List Views that display the IRecurrentEvent objects. The EditSeries Action allows end-users to modify the entire series generated from a Recurring Event. Use the Edit Action to modify a particular series instance. The OpenSeries Action allows end-users to view the currently selected Recurring Event as a series. For instance, the resource collection changed in the invoked View is changed for all the Events in the series. The Edit Action executed for the displayed series allows you to edit the entire series. Use the Open Action to view and then edit a particular Event in a series. The RestoreOccurrence Action allows end-users to change a Recurring Event’s pattern if it was changed and no longer satisfies the recurring series’s pattern in which the Event was created.
SchedulerChangedOccurrencesController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Scheduler.v18.2.dll. Actions: none.
Activated for Detail Views that represent IEvent objects.
Designed to create Exceptions from Recurring Events when they are changed.
SchedulerDetailViewActionsController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Scheduler.Web.v18.2.dll. Actions: EditSeriesDetailView.
Activated for Detail Views displaying IRecurrentEvent objects. The EditSeriesDetailView Action allows end-users to modify the currently viewed Recurring Event occurrence’s entire series.
SchedulerModificationsController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Scheduler.Win.v18.2.dll. Actions: none.
Activated for Detail Views representing an IEvent object. For internal use. When a Detail View is invoked from the List View displayed by the SchedulerListEditor, it refreshes the scheduler editor when an object is changed or committed in the Detail View.
SchedulerListViewControllerBase
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Scheduler.v18.2.dll. Actions: none.
Activated for List Views representing IEvent objects. This Controller is a base for the platform-specific SchedulerListViewControllers.
SchedulerListViewController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Scheduler.Win.v18.2.dll. Actions: none.
Inherited from the SchedulerListViewControllerBase Controller. Contains Windows Forms specific code that sets up the Scheduler control to work in an XAF application.
SchedulerListViewController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Scheduler.Web.v18.2.dll. Actions: none.
Inherited from the SchedulerListViewControllerBase Controller. Contains ASP.NET specific code that sets up the ASPxScheduler control to work in an XAF application.
SchedulerRecurrenceInfoControllerBase
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Scheduler.v18.2.dll. Actions: none.
Activated in Detail Views that represent the objects that implement the ISupportRecurrences interface. Represents a base class for Windows Forms and ASP.NET SchedulerRecurrenceInfo Controllers. Manages the Property Editor that represents the Recurrence property.
SchedulerRecurrenceInfoController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Scheduler.Win.v18.2.dll. Actions: none.
Inherited from the SchedulerRecurrenceInfoControllerBase Controller. Contains Windows Forms specific code to manage the Property Editor, representing the Recurrence property.
SchedulerRecurrenceInfoController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.Scheduler.Web.v18.2.dll. Actions: none.
Inherited from the SchedulerRecurrenceInfoControllerBase Controller. Contains ASP.NET specific code to manage the Property Editor, representing the Recurrence property.
SchedulerResourceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Scheduler.v18.2.dll. Actions: none.
Activated in Detail Views that represent the objects that implement the ISupportRecurrences interface.
Make the resources collection read-only when the current Detail View visualizes an occurrence. A resources collection can be edited for the entire series only.
SchedulerResourceDeletingController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Scheduler.Win.v18.2.dll. Actions: none.
Activated for Detail Views displaying IResource objects. Displays the “Please refresh the event detail view to load changes” warning when the current object is deleted. The message is localizable under the Localization | Messages | SchedulerResourceDeletingWarning node.
Script Recorder
ScriptRecorderControllerBase
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ScriptRecorder.v18.2.dll. Actions: PauseRecording, ResumeRecord, SaveScript, ShowScript, SaveScriptForDialogWindow.
The platform-agnostic base class for WinScriptRecorderController and WebScriptRecorderController Controllers.
WebScriptRecorderController
Platform: ASP.NET. Assembly: DevExpress.ExpressApp.ScriptRecorder.Web.v18.2.dll. Actions: inherited.
The ScriptRecorderControllerBase descendant, implementing a platform-specific save functionality. The script to be saved is written to the HTTP output stream when the SaveScript or SaveScriptForDialogWindow Action is executed. The script can be saved using browser capabilities.
WinScriptRecorderController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.ScriptRecorder.Win.v18.2.dll. Actions: inherited.
The ScriptRecorderControllerBase descendant, implementing platform-specific save functionality. When the SaveScript or SaveScriptForDialogWindow Action is executed, the script is saved via the standard Save File dialog.
Security System
ChangePasswordController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: ChangePasswordByUser.
Activated for the My Details Detail View. The ChangePasswordByUser Action allows end-users to change their password. The ChangePasswordController class calls the IAuthenticationStandardUser.SetPassword method to change the password and modify the selected object. The ChangePasswordByUser action is available when a user selects an object that represents the SecuritySystem.CurrentUser entry and its ActionBase.Enabled property is updated dynamically when the selected object is changed.
See Also: Passwords in the Security System | SecurityModule.TryUpdateLogonParameters | PermissionPolicyUser.SetPassword | PermissionPolicyUser.SetPassword
HasRightsToModifyMemberController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: none.
Activated for Detail Views. Makes Property Editors read-only or editable, depending on the current user’s rights to edit the current object. When a Property Editor represents a property of an object set to a reference property, this Controller sets it as read-only or editable, depending on the rights to edit the referenced object.
See Also: HasRightsToModifyMemberController
LastAdminController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: none.
Activated for all Views. Designed for the Simple Security strategy. Throws an exception when the last “Administrator” user is deleted because there must be at least one user with administrative rights.
MyDetailsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: MyDetails.
Activated in the main window. Adds the My Details item to the navigation control. When an end-user clicks this item, a Detail View with the current User’s details is displayed. Additionally, the MyDetails Action is displayed by the “Security” Action Container, which is added to the Default.aspx Template in the ASP.NET application version. This Action shows a Detail View with the current User’s details.
See Also: MyDetailsController
PermissionsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: none.
Activated for Views whose object type implements the IPersistentPermission interface. Manages the creation of new permissions. Replaces the New Action’s predefined types with the found types inherited from the PermissionBase class. The Detail View invoked when using the New Action displays a new PermissionBase object, whose Permission property references the permission selected in the New Action’s Items collection.
RefreshSecurityController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: none.
Activated for root List and Detail Views displaying User objects. Refreshes the permission set when the current user object is changed.
ResetPasswordController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Security.v18.2.dll. Actions: ResetPasswordAction.
Activated for root Views. Designed for a security system that uses the authentication strategy implementing the IAuthenticationStandard interface, and the User type implementing the IAuthenticationStandardUser interface. Contains the ResetPasswordAction Action. This Action allows end-users that possess “Write” access to the User type to set a new password for users. Internally the Action calls the IAuthenticationStandardUser.SetPassword method and modifies the IAuthenticationStandardUser.ChangePasswordOnFirstLogon property. When the selected user object is changed, the ResetPasswordController controller checks that the current user is permitted to modify the StoredPassword and ChangePasswordOnFirstLogon properties of the selected object and updates the ResetPassword action’s ActionBase.Enabled property. The names of these properties are not obtained dynamically. Instead, these strings are specified by the PasswordFieldName and ChangePasswordOnFirstLogonFieldName properties, which are declared as static.
See Also: Passwords in the Security System
State Machine Module
DisableStatePropertyController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.StateMachine.v18.2.dll. Actions: none.
Activated for Detail Views. Prohibits editing of the state property by setting its Property Editor’s AllowEdit property to false.
See Also: PropertyEditor.AllowEdit
StateMachineAppearanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.StateMachine.v18.2.dll. Actions: none.
Activated for List Views and Detail Views. Collects conditional appearance rules declared in state machines associated with currently displayed objects and adds these rules to the list of currently active conditional appearance rules.
See Also: State Machine Module | Conditional Appearance Module Overview
StateMachineController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.StateMachine.v18.2.dll. Actions: ChangeState.
Activated for List Views and Detail Views. Displays the ChangeState Action for objects that have associated state machines. The Action allows end-users to change object states via a UI.
See Also: State Machine Module
StateMachineControllerBase<T>
Platform: platform-independent. Assembly: DevExpress.ExpressApp.StateMachine.v18.2.dll. Actions: none.
A generic abstract base class from which State Machine module Controllers are derived. Contains basic functionality, such as retrieving state machines associated with the object the current View displays.
See Also: View.CurrentObject
TreeList Editors Module
CategoryController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.TreeListEditors.Win.v18.2.dll. Actions: none.
Activated for all Views. Works with business classes that implement the ICategorizedItem interface. This Controller automatically sets a category for newly created objects.
TreeListEditorColumnChooserController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.TreeListEditors.Win.v18.2.dll. Actions: none.
Inherited from the System Module‘s ColumnChooserControllerBase Controller. Sets up the Tree List Editor’s Customization form and supports its functionality. This form can be invoked by selecting a Column Chooser in the grid’s context menu.
TreeListEditorRootValueController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.TreeListEditors.v18.2.dll. Actions: none.
Activated for nested List Views. Allows the Child collection of an ITreeNode object to be displayed via the TreeList control in the object’s Detail View.
TreeNodeController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.TreeListEditors.Win.v18.2.dll. Actions: none.
Activated for root Views. Works with business classes that implement the ITreeNode interface. This Controller links a newly created object to its parent.
Validation Module
ActionValidationController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Extends the Application Model’ IModelAction node with the IModelActionValidationContexts.ValidationContexts property. Subscribes to the Executing event of all Actions available in the current Frame. In the event handler, checks validation rules associated with the context that is set for the Action’s ValidationContexts property. If at least one rule is broken, it cancels the Action’s execution and raises a validation exception.
CheckContextsAvailableController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Activated in all windows. Deactivates the ShowAllContextsController‘s ShowAllContexts Action, if no validation rules are specified for the current View’s object type.
CustomizeErrorMessageColumnController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Validation.Win.v18.2.dll. Actions: none.
This Controller uses the GridListEditor.GridView and XafGridView.ErrorMessages properties to show Error/Warning/Info icon in the Description column of the RuleSetValidationResultItem_ByTarget_ListView list view (see Declare Validation Rules). This Controller is not designed to work with other List Editors. Deactivate it if you need to use another List Editor class to show objects in the ‘RuleSetValidationResultItem_ByTarget_ListView’ list view.
ContextValidationResultController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Validation.Win.v18.2.dll. Actions: none.
Activated for List Views displaying ContextValidationResult objects. Customizes the ListView.Editor settings, so the height of each row is automatically adjusted to display its cells’ contents.
PersistenceValidationController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Subscribes to the BaseObjectSpace.ObjectDeleting and BaseObjectSpace.Committing events. In the event handlers, checks validation rules associated with the DefaultContexts.Save and DefaultContexts.Delete validation contexts. If at least one rule is broken, it cancels execution of the Save/Delete operation and raises a validation exception.
See Also: PersistenceValidationController
PreventValidationDetailsAccessController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Activated for List Views displaying the DisplayableValidationResultItem objects. Prevents invoking the DisplayableValidationResultItem Detail View via the ListViewShowObject Action (see ListViewProcessCurrentObjectController.ProcessCurrentObjectAction) when the ValidationModule.AllowValidationAccess property is set to false.
ResultsHighlightController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Activated for all Views. When validation rules are broken, this controller adds messages to the View.ErrorMessages collection. This results in displaying error images (
) near Property Editors with invalid data.
RuleSetInitializationController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Activated in the main window. Calls the ValidationModule.InitializeRuleSet method to invoke registration of all rules specified by the RuleSet object assigned to the static Validator.RuleSet property (and defined in the Application Model’s Validation | Rules node).
SuppressToolBar
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Validation.Win.v18.2.dll. Actions: none.
Activated for nested List Views of Detail Views displayed when a validation rule is broken, or the ShowAllContexts Action is executed. Hides the List View’s toolbar using the ToolbarVisibilityController‘s methods.
ShowAllContextsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: ShowAllContexts.
Activated for all Views. The ShowAllContexts Action checks all rules that are designed for the current View’s object type. In a List View, the currently selected objects are subject to checking; in a Detail View, the current object is checked. The result of checking the rules is shown in an invoked window, where all checked rules are grouped by context.
ShowRulesController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Validation.v18.2.dll. Actions: none.
Activated in all windows. Represents the DiagnosticInfoProviderBase descendant. Provides the information on rules that are currently available in the Application Model for the DiagnosticInfoController. The DiagnosticInfoController adds the Rules Info Single Choice Action Item DiagnosticInfo Action. When an end-user selects this item, the collected information is shown in an invoked window.
See Also: Determine Why an Action, Controller or Editor is Inactive
ValidationResultsShowingController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Validation.Win.v18.2.dll. Actions: none.
Activated in the main Window. When a validation exception occurs, it shows a special validation error Detail View in the exception error window.
View Variants Module
ChangeVariantController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ViewVariantsModule.v18.2.dll. Actions: ChangeVariant.
Activated for all Views. The ChangeVariant Action allows end-users to switch between predefined View variants of a particular business object type. Its items are specified by the IModelVariants node of the Application Model.
See Also: ChangeVariantController
CustomizeNavigationItemsController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.ViewVariantsModule.v18.2.dll. Actions: none.
Activated in the main Window. Adds the contextual View Variants navigation groups. These groups expose navigation items, providing end-users with instant access to View Variants related to a certain navigation item when TreeList navigation is enabled. Extends the Application Model with the IModelNavigationItemsVariantSettings interface.
Workflow Module
ActivationController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: Activate, Deactivate.
Activated in all Views displaying ISupportIsActive objects. Adds the Activate and Deactivate Actions that set the ISupportIsActive.IsActive property to true and false, respectively.
DebugWorkflowController
Platform: Windows Forms. Assembly: DevExpress.ExpressApp.Workflow.Win.v18.2.dll. Actions: DebugWorkflow, ToggleBreakpoint, StopDebug.
Activated in IWorkflowDefinition Detail Views. Adds workflow debugging Actions into workflow definition Detail Views in Windows Forms applications. These Actions are activated after a workflow’s Activity has been initialized by opening the Designer tab. The Actions can be used to test workflows and diagnose exceptions.
See Also: Workflow Module
DisableRunningWorkflowInstanceInfoCreateByUserController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: none.
Activated in all Windows. Subscribes to the NewObjectViewController‘s NewObjectViewController.CollectCreatableItemTypes and NewObjectViewController.CollectDescendantTypes events. Removes all IRunningWorkflowInstanceInfo objects from the list of creatable types.
RunningInstanceController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: CancelWorkflowInstance, TerminateWorkflowInstance, SuspendWorkflowInstance, ResumeWorkflowInstance.
Activated in List Views and Detail Views displaying IRunningWorkflowInstanceInfo objects. Add Actions that can be used by application administrators to manage running workflow instances.
See Also: Workflow Module
RunningWorkflowInstanceInfoControllerBase<T>
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: none.
An abstract base class containing basic functionality for Controllers that provide information on running workflow instances. Activated in Object Views specified by the generic type parameter, displaying IDCRunningWorkflowInstanceInfo objects. Prohibits end-users from editing objects.
RunningWorkflowInstanceInfoViewer
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: ShowWorkflowInstances.
Activated in List Views and Detail Views. Adds the ShowWorkflowInstances Action displaying all running workflow instances for the current object.
StartWorkflowController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: none.
Activated in the main Window (see Window.IsMain). Tracks creation of Object Spaces by handling the XafApplication.ObjectSpaceCreated event. Creates workflow instance execution request when appropriate.
TrackingVisualizationController
Platform: platform-independent. Assembly: DevExpress.ExpressApp.Workflow.v18.2.dll. Actions: none.
A RunningWorkflowInstanceInfoControllerBase<T> descendant. Activated in running Workflow Instance Info Detail Views. Highlights an Activity selected in the Tracking Records nested List View in the associated WorkflowVisualizationPropertyEditor.