ViewCreatingEventArgs Class

The base class for event arguments passed to the XafApplication.ListViewCreating, XafApplication.DetailViewCreating, XafApplication.DashboardViewCreating and XafApplication.ViewCreating events.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v21.2.dll

Declaration

C#

public class ViewCreatingEventArgs :
    EventArgs

VB.NET

Public Class ViewCreatingEventArgs
    Inherits EventArgs

Related API Members

ViewCreatingEventArgs is the data class for the following events:

• XafApplication.ViewCreating

Remarks

The ViewCreatingEventArgs class declares properties specific to the events which are designed to create custom Views. These properties are required to create both a DetailView and ListView. The created View must be assigned to the ViewCreatingEventArgs.View property to prevent further creation of a default View.

This class’ descendants are used when creating a particular Detail or List View: DetailViewCreatingEventArgs and ListViewCreatingEventArgs.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ViewCreatingEventArgs class.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-provide-a-specific-view-layout-for-users-of-certain-security-roles-e274/CS/E274.Module/Controllers/CustomizeViewAgainstRoleMainWindowController.cs#L19

//Create corresponding views in the application model first! See the Model.DesignedDiffs.XAFML file for an example.
void Application_ViewCreating(object sender, ViewCreatingEventArgs e) {
    string roleBasedViewId = String.Format("{0}_{1}", e.ViewID, ((ISecurityUserWithRoles)SecuritySystem.CurrentUser).IsUserInRole(AdministratorsViewSuffix) ? AdministratorsViewSuffix : UsersViewSuffix);

VB.NET

XAF_how-to-provide-a-specific-view-layout-for-users-of-certain-security-roles-e274/VB/E274.Module/Controllers/CustomizeViewAgainstRoleMainWindowController.vb#L21

'Create corresponding views in the application model first! See the Model.DesignedDiffs.XAFML file for an example.
Private Sub Application_ViewCreating(ByVal sender As Object, ByVal e As ViewCreatingEventArgs)
    Dim roleBasedViewId As String = String.Format("{0}_{1}", e.ViewID,If(DirectCast(SecuritySystem.CurrentUser, ISecurityUserWithRoles).IsUserInRole(AdministratorsViewSuffix), AdministratorsViewSuffix, UsersViewSuffix))

Inheritance

Object

EventArgs

ViewCreatingEventArgs

DashboardViewCreatingEventArgs

DetailViewCreatingEventArgs

ListViewCreatingEventArgs