DxGridListEditor.GridInstance Property

Provides access to methods of the DxGrid control.

Namespace: DevExpress.ExpressApp.Blazor.Editors

Assembly: DevExpress.ExpressApp.Blazor.v24.1.dll

NuGet Package: DevExpress.ExpressApp.Blazor

Declaration

C#

public IGrid GridInstance { get; }

VB.NET

Public ReadOnly Property GridInstance As IGrid

Property Value

Type	Description
IGrid	An IGrid object.

Remarks

Use the GridInstance property to call methods of the grid control. To change grid properties, use GridModel.

The DxGrid instance becomes available after it is rendered. Always check that GridInstance is not null.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Actions;
using DevExpress.ExpressApp.Blazor.Editors;

namespace MySolution.Blazor.Server.Controllers;

public class TestController : ViewController<ListView> {
    public TestController() {
        SimpleAction simpleAction = new SimpleAction(this, "Test Action", DevExpress.Persistent.Base.PredefinedCategory.Edit);
        simpleAction.Execute += (s, e) => {
            if(View.Editor is DxGridListEditor editor) {
                // Always check that GridInstance is not `null`.
                editor.GridInstance?.CollapseAllGroupRows();
            }
        };
    }
}

The code sample below demonstrates how to access DxGrid API using the GridComponentCaptured event.

C#

using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Blazor.Editors;

namespace MySolution.Blazor.Server.Controllers;

public class TestController : ViewController<ListView> {
    protected override void OnViewControlsCreated() {
        base.OnViewControlsCreated();
        if(View.Editor is DxGridListEditor editor) {
            editor.GridComponentCaptured += (s, e) => {
                e.Grid.CollapseAllGroupRows();
            };
        }
    }
}

Note

Do not cache the grid instance in controller fields because the grid can be disposed of and then rendered again when a user navigates the XAF application. Handle the GridComponentCaptured event every time you access the grid instance.