DataInspectorOptionBuilder.OnGridContentReady(String) Method

A handler for the event that occurs when the widget’s content is ready and each time the content is changed.

Namespace: DevExpress.DashboardAspNetCore

Assembly: DevExpress.Dashboard.v23.2.AspNetCore.dll

NuGet Package: DevExpress.AspNetCore.Dashboard

Declaration

C#

public DataInspectorOptionBuilder OnGridContentReady(
    string onGridContentReady
)

VB.NET

Public Function OnGridContentReady(
    onGridContentReady As String
) As DataInspectorOptionBuilder

Parameters

Name	Type	Description
onGridContentReady	String	A function that is executed when the widget’s content is ready and each time the content is changed.

Returns

Type	Description
DataInspectorOptionBuilder	A reference to this instance after the operation has completed.

Remarks

The Data Inspector uses the DevExtreme DataGrid to display raw or aggregated data.

To customize the Grid widget, enable the Data Inspector (set the AllowInspectAggregatedData(Boolean) / AllowInspectRawData(Boolean) properties to true) and handle the DataGrid’s onContentReady event:

<div style="position: absolute; left: 0; top: 0; right: 0; bottom: 0;">
@(Html.DevExpress().Dashboard("dashboardControl1")
    .Width("100%")
    .Height("100%")
    .UseNeutralFilterMode(true)
    .OnBeforeRender("onBeforeRender")
    .Extensions(x => x.DataInspector(y => y.AllowInspectAggregatedData(true).AllowInspectRawData(true).OnGridContentReady("onGridContentReady")))
)
</div>

Use the event’s component property to obtain the DataGrid instance. The following code snippet shows how to change the DataGrid options (hide the “CategoryName” column):

function onGridContentReady(args) {
    args.component.columnOption("CategoryName", "visible", false);
}