XafApplication.ListViewCreating Event

Occurs when creating a List View.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<ListViewCreatingEventArgs> ListViewCreating

VB.NET

Public Event ListViewCreating As EventHandler(Of ListViewCreatingEventArgs)

Event Data

The ListViewCreating event's data class is ListViewCreatingEventArgs. The following properties provide information specific to this event:

Property	Description
CollectionSource	Returns the collection source to be used when creating a new List View.
IsRoot	Indicates whether a root View must be created. Inherited from ViewCreatingEventArgs.
ObjectSpace	Returns the Object Space to be used when creating a new View. Inherited from ViewCreatingEventArgs.
View	Specifies a custom List View created in a XafApplication.ListViewCreating event.
ViewID	Returns the ID of the created View. Inherited from ViewCreatingEventArgs.

Remarks

Handle this event to provide a custom List View instead of a default one. Use the handler’s ListViewCreatingEventArgs.View parameter to get information on the created List View. To do this, use the application’s XafApplication.FindModelView method passing the View ID as a parameter. To create a List View, use the collection source passed as the handler’s ListViewCreatingEventArgs.CollectionSource parameter. To specify whether the List View is root, use the handler’s ViewCreatingEventArgs.IsRoot parameter.

The following example demonstrates how to handle the ListViewCreating event:

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Model;

namespace MySolution.Module {
    public sealed partial class MySolutionModule : ModuleBase {
        public override void Setup(XafApplication application) {
            base.Setup(application);
            application.ListViewCreating += application_ListViewCreating;
        }
        void application_ListViewCreating(object sender, ListViewCreatingEventArgs e) {
            IModelListView modeListView = ((XafApplication)sender).FindModelView(e.ViewID) as IModelListView;
            if (modeListView != null) {
                modeListView.MasterDetailMode = MasterDetailMode.ListViewAndDetailView;
            }
        }
    }
}

VB.NET

Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Model

Public NotInheritable Class MySolutionModule
    Inherits ModuleBase
    Public Overrides Sub Setup(application As XafApplication)
        MyBase.Setup(application)
        AddHandler application.ListViewCreating, AddressOf Application_ListViewCreating
    End Sub
    Private Sub Application_ListViewCreating(sender As Object, e As ListViewCreatingEventArgs)
        Dim modeListView As IModelListView = TryCast(CType(sender, XafApplication).FindModelView(e.ViewID), IModelListView)
        If modeListView IsNot Nothing Then
            modeListView.MasterDetailMode = MasterDetailMode.ListViewAndDetailView
        End If
    End Sub
End Class