ExportController.ExportActionItemsCreated Event

Occurs after the Export Action’s ChoiceActionBase.Items collection has been populated.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

C#

public event EventHandler<EventArgs> ExportActionItemsCreated

VB.NET

Public Event ExportActionItemsCreated As EventHandler(Of EventArgs)

Event Data

The ExportActionItemsCreated event's data class is EventArgs.

Remarks

By default, the Export Action’s Items collection is populated based on the IExportable.SupportedExportFormats list of the Controller’s ExportController.Exportable editor. To customize the Items collection after it’s been populated, handle the ExportActionItemsCreated event. Note that the exporter used by default can only export data to the formats specified by the ExportTarget enumeration. So, the Action’s Items must be of the ExportTarget type only, if you use the default export.

Note

If the control of the Controller’s ExportController.Exportable Editor doesn’t implement the IPrintable interface or the Exportable Editor is not specified, the Export Action’s Items collection remains empty, the ExportActionItemsCreated event is not raised and the Export Action is not activated.

The following code demonstrates how to place the required item to the first place in the Export Action’s Items collection:

C#

using DevExpress.ExpressApp.SystemModule;
using DevExpress.XtraPrinting;
//...
public partial class MyExportViewController : ViewController {
    public MyExportViewController() {
        InitializeComponent();
        TargetViewType = ViewType.ListView;
    }
    private ExportController exportController;
    protected override void OnActivated() {
        base.OnActivated();
        exportController = Frame.GetController<ExportController>();
        if (exportController != null) {
            exportController.ExportActionItemsCreated += 
                new EventHandler<EventArgs>(exportController_ExportActionItemsCreated);
        }
    }
    void exportController_ExportActionItemsCreated(object sender, EventArgs e) {
        if (((ExportTarget)exportController.ExportAction.Items.FirstActiveItem.Data) != 
        ExportTarget.Xls) {
            ChoiceActionItem item = exportController.ExportAction.Items.Find(ExportTarget.Xls);
            exportController.ExportAction.Items.Remove(item);
            exportController.ExportAction.Items.Insert(0, item);
        }
    }
    protected override void OnDeactivated() {
        base.OnDeactivated();
        if (exportController != null) {
            exportController.ExportActionItemsCreated -= 
               new EventHandler<EventArgs>(exportController_ExportActionItemsCreated); 
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp.SystemModule
Imports DevExpress.XtraPrinting
'...
Partial Public Class MyExportViewController
    Inherits ViewController

    Public Sub New()
        InitializeComponent()
        TargetViewType = ViewType.ListView
    End Sub
    Private exportController As ExportController
    Protected Overrides Sub OnActivated()
        MyBase.OnActivated()
        exportController = Frame.GetController(Of ExportController)()
        If exportController IsNot Nothing Then
            AddHandler exportController.ExportActionItemsCreated, AddressOf exportController_ExportActionItemsCreated
        End If
    End Sub
    Private Sub exportController_ExportActionItemsCreated(ByVal sender As Object, ByVal e As EventArgs)
        If (CType(exportController.ExportAction.Items.FirstActiveItem.Data, ExportTarget)) <> ExportTarget.Xls Then
            Dim item As ChoiceActionItem = exportController.ExportAction.Items.Find(ExportTarget.Xls)
            exportController.ExportAction.Items.Remove(item)
            exportController.ExportAction.Items.Insert(0, item)
        End If
    End Sub
    Protected Overrides Sub OnDeactivated()
        MyBase.OnDeactivated()
        If exportController IsNot Nothing Then
            RemoveHandler exportController.ExportActionItemsCreated, AddressOf exportController_ExportActionItemsCreated
        End If
    End Sub
End Class