How to: Access the Grid Component in a List View

• Jul 19, 2024
• 3 minutes to read

This article explains how to access properties of a grid component displayed in a List View.

You can use this technique with any List Editor control in ASP.NET Core Blazor, Windows Forms, or ASP.NET Web Forms applications.

Step-by-Step Instructions

1. In Solution Explorer, navigate to:
   • A platform-specific project in a .NET ASP.NET Core Blazor or Windows Forms application.
   • A platform-specific module project in a .NET Framework ASP.NET Web Forms or Windows Forms application.
2. Add a View Controller to the Controllers folder.

3. Inherit the controller from the ObjectViewController<ViewType, ObjectType> class and override the OnViewControlsCreated method as demonstrated in the following code example:

   ASP.NET Core Blazor

    using DevExpress.Blazor;
    using DevExpress.ExpressApp;
    using DevExpress.ExpressApp.Blazor.Editors;
    using MainDemo.Module.BusinessObjects;
    using YourApplicationName.Module.BusinessObjects;
   
    namespace YourApplicationName.Blazor.Server.Controllers;
   
    public class EmployeeListViewController : ObjectViewController<ListView, Employee> {
        protected override void OnViewControlsCreated() {
            base.OnViewControlsCreated();
            if(View.Editor is DxGridListEditor editor) {
                editor.GridModel.ColumnResizeMode = GridColumnResizeMode.ColumnsContainer;
   
                foreach(var columnModel in editor.GridDataColumnModels) {
                    if(columnModel.FieldName == "Department.Title") {
                        columnModel.FilterMenuButtonDisplayMode = GridFilterMenuButtonDisplayMode.Never;
                    }
                    columnModel.MinWidth = 50;
                }
            }
        }
    }
   

   Windows Forms

   using DevExpress.ExpressApp;
   using DevExpress.ExpressApp.Win.Editors;
   using DevExpress.XtraGrid.Columns;
   using DevExpress.XtraGrid.Views.Grid;
   using YourApplicationName.Module.BusinessObjects;
   
   namespace YourApplicationName.Win.Controllers;
   
   public class GridViewController : ObjectViewController<ListView, TargetClassName> {
       protected override void OnViewControlsCreated() {
           base.OnViewControlsCreated();
           // Obtain the List Editor: XAF's abstraction over the UI control.
           if (View.Editor is GridListEditor gridListEditor && gridListEditor.GridView != null) {
               // Access the GridView object (part of the DevExpress WinForms Grid Control architecture). 
               GridView gridView = gridListEditor.GridView;
               // Specify the behavior of the grid's columns.
               // Access grid columns.
               // Use column settings to disable the sorting and grouping functionality. 
               foreach (GridColumn columnModel in gridView.Columns) {
                   columnModel.OptionsColumn.AllowSort = DevExpress.Utils.DefaultBoolean.False;
                   columnModel.OptionsColumn.AllowGroup = DevExpress.Utils.DefaultBoolean.False;
               }
           }
       }
   }
   

   ASP.NET Web Forms

   using DevExpress.ExpressApp;
   using DevExpress.ExpressApp.Web.Editors.ASPx;
   using YourApplicationName.Module.BusinessObjects;
   
   namespace YourApplicationName.Module.Web.Controllers {
       public partial class GridViewController : ObjectViewController<ListView, TargetClassName> {
           protected override void OnViewControlsCreated() {
               base.OnViewControlsCreated();
               // Obtain the List Editor: XAF's abstraction over the UI control.
               ASPxGridListEditor listEditor = ((ListView)View).Editor as ASPxGridListEditor;
               if (listEditor != null) {
                   // Use the grid control's behavior settings to disable the sort and group functionality.
                   listEditor.Grid.SettingsBehavior.AllowSort = false;
                   listEditor.Grid.SettingsBehavior.AllowGroup = false;
   
               }
           }
       }
   }
   

Platform-Specific Events for Control Customization

In Windows Forms or ASP.NET Web Forms applications, a View Item control or a List Editor control may not be ready for customization immediately after creation. If the technique described in this topic does not have the desired effect, handle platform-specific events listed below.

Windows Forms:

The Control object’s HandleCreated, VisibleChanged, or ParentChanged event.

You can also handle Load or any similar event if the current control type exposes it.

ASP.NET Web Forms:

The Control object’s Load or Init server-side event.

Alternatively, you may need to handle the WebWindow.PagePreRender event. Use the CurrentRequestWindow static property to get the current WebWindow object.

If your application also requires customization on the client side, refer to the following topic for additional information: Client-Side Functionality.

ASP.NET Core Blazor

XAF ASP.NET Core Blazor apps do no need specialized events to customize their underlying controls. However, you must use an EventCallback-based approach instead of handling regular C# events for underlying Blazor UI controls. For more information, refer to the Handle Component Events section.

Contact our Support Center if you need help.