ExportAnalysisController Class
An abstract ViewController descendant that contains the Export Analysis Action.
Namespace: DevExpress.ExpressApp.SystemModule
Assembly: DevExpress.ExpressApp.v24.2.dll
NuGet Package: DevExpress.ExpressApp
#Declaration
public abstract class ExportAnalysisController :
ViewController
#Remarks
The ExportAnalysisController is a Controller activated in Detail Views that contain Property Editors implementing the IExportableAnalysisEditor interface. Currently, only the AnalysisEditorWin and AnalysisEditorWeb Property Editors from the Pivot Chart module implement this interface. As such, the ExportAnalysisController is generally introduced to supply export functionality for the Analysis Detail View, where these Property Editors are used to represent an Analysis object.
The export functionality is presented by the Export Analysis Action.
WinForms
ASP.NET Web Forms
To access the Export Analysis Action, use the ExportAnalysisController.ExportAction property. This Action’s ChoiceActionBase.Items collection is populated based on the IExportableAnalysisEditor.ExportTypes list of the analysis editor to be exported. For details, refer to the ExportAnalysisController.ExportAction property description.
The ExportAnalysisController
allows you to change the Export Analysis Action’s behavior. Use the following events:
- ExportAnalysisController.Exporting
- ExportAnalysisController.Exported
- ExportAnalysisController.CustomExport
The ExportAnalysisController is the base for the platform-specific WinExportAnalysisController and WebExportAnalysisController Controllers. Generally, you do not need to inherit this class, as it will be required to manually implement the functionality which is already implemented in platform-specific descendants. However, you can inherit the WinExportAnalysisController or WebExportAnalysisController classes to add custom functionality. The following protected methods are available, and can be overridden:
Method | When is it called? | Description |
---|---|---|
Create | Invoked when initializing the Export | An abstract method, which is implemented in Win |
Export | Invoked when the Export Action’s Single | Uses the IStream |
**Export Export Export Export Export Export Export Export Export | Invoked when executing the Export method. The appropriate method is invoked, depending on the export type specified. | These methods implement export to the corresponding format using the Dev |
Get | Ivnoked when the Update | Returns the list of supported export types exposed by the current exportable Editor’s IExportable |
Get | Invoked when executing the Export | Returns the Image |
On | Invoked when executing the Export method, before performing export to the required format. | Triggers the Export |
On | Invoked when executing the Export method, after performing export to the required format. | Triggers the Export |
On | Invoked when executing the Export method, before the On | Triggers the Export |
Update | Invoked when:
| Updates the Export Action’s Action |
Update | Invoked when:
| Fills the Export Action’s Items list with items returned by the Get |
Public members are described individually in the documentation.
To determine whether the Controller is active, use the Controller.Active property (see How to: Detect a Lookup List View in Code). If you need to know the reason for its deactivation or activation at runtime, use the DiagnosticInfo Action.
Information on the ExportAnalysisController and its ExportAnalysis Action is available in the Application Model‘s ActionDesign node. To access it, use the Model Editor.