ExportAnalysisController Class
An abstract ViewController descendant that contains the Export Analysis Action.
Namespace: DevExpress.ExpressApp.SystemModule
Assembly: DevExpress.ExpressApp.v24.1.dll
NuGet Package: DevExpress.ExpressApp
Declaration
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 |
|---|---|---|
CreateStreamProvider | Invoked when initializing the ExportAnalysisController Controller. | An abstract method, which is implemented in WinExportController and WebExportController classes. Creates the IStreamProvider object to be used by the Export method. In the WinExportController, the FileStreamProvider is created, which generates the System.IO.FileStream object. In the WebExportController, the MemoryStreamProvider is created, which generates the System.IO.MemoryStream object. |
Export | Invoked when the Export Action’s SingleChoiceAction.Execute event occurs. | Uses the IStreamProvider object, supplied by the CreateStreamProvider method, to create the output stream for export. Invokes the specific ExportTo… method, which writes the export result to this stream. |
**ExportToTxt ExportToRtf ExportToDocx ExportToXls ExportToXlsx ExportToHtml ExportToMht ExportToPdf ExportToImage** | 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 DevExperss.XtraPrinting.ComponentExporter.Export method. |
GetExportTypes | Ivnoked when the UpdateExportAction method is executed. | Returns the list of supported export types exposed by the current exportable Editor’s IExportableAnalysisEditor.ExportTypes property. |
GetImageFormat | Invoked when executing the ExportToImage method. | Returns the ImageFormat object that specifies the target image format, which is ImageFormat.Png (the default setting). This method is overridden in the WinExportControllerMethod and returns the ImageFormat, calculated based on the file extension specified in the Save As dialog. |
OnCustomExport | Invoked when executing the Export method, before performing export to the required format. | Triggers the ExportController.CustomExport event. |
OnExported | Invoked when executing the Export method, after performing export to the required format. | Triggers the ExportController.Exported event. In the WebExportController class, this method is overridden. It writes the export result to the HTTP output stream and adds content type and file name HTTP headers (using the System.Web.HttpResponse). |
OnExporting | Invoked when executing the Export method, before the OnCustomExport method. | Triggers the ExportAnalysisController.Exporting event. |
UpdateActionState | Invoked when:
| Updates the Export Action’s ActionBase.Active BoolList with the “The XtraPrinting Library is available” key/value pair. The value is set to true when the XtraPrinting Library is available. |
UpdateExportAction | Invoked when:
| Fills the Export Action’s Items list with items returned by the GetExportTypes method. |
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.