DashboardViewer.ShowDataInspectorAsync(String) Method

Invokes the Data Inspector dialog for the specified dashboard item asynchronously.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v20.1.Win.dll

NuGet Packages: DevExpress.Win.Dashboard, DevExpress.WindowsDesktop.Win.Dashboard

Declaration

C#

public Task ShowDataInspectorAsync(
    string dashboardItemName
)

VB.NET

Public Function ShowDataInspectorAsync(
    dashboardItemName As String
) As Task

Parameters

Name	Type	Description
dashboardItemName	String	A String object that specifies a component name of the dashboard item for which the Data Inspector displays data.

Returns

Type	Description
Task	The task object that is the asynchronous operation to perform.

Example

This example demonstrates how to call asynchronous methods that retrieves data when the dashboard is loaded.

The Dashboard Viewer loads a dashboard and asynchronously invokes the Data Inspector window.

Note

Example on GitHub: How to Invoke the Data inspector Asynchronously When the Dashboard is Loaded

C#

using System;
using System.Windows.Forms;

namespace DataInspectorOnInitializeExample
{
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
            dashboardViewer1.Initialized += dashboardViewer1_Initialized;
        }
        async void dashboardViewer1_Initialized(object sender, EventArgs e) {
            await dashboardViewer1.ShowDataInspectorAsync("gridDashboardItem1");
        }
    }
}

VB.NET

Imports System
Imports System.Windows.Forms

Namespace DataInspectorOnInitializeExample
    Partial Public Class Form1
        Inherits Form

        Public Sub New()
            InitializeComponent()
            AddHandler dashboardViewer1.Initialized, AddressOf dashboardViewer1_Initialized
        End Sub
        Private Async Sub dashboardViewer1_Initialized(ByVal sender As Object, ByVal e As EventArgs)
            Await dashboardViewer1.ShowDataInspectorAsync("gridDashboardItem1")
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the ShowDataInspectorAsync(String) method.

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#

winforms-dashboard-async-mode-show-data-inspector/CS/Form1.cs#L12

async void dashboardViewer1_Initialized(object sender, EventArgs e) {
    await dashboardViewer1.ShowDataInspectorAsync("gridDashboardItem1");
}

VB.NET

winforms-dashboard-async-mode-show-data-inspector/VB/Form1.vb#L13

Private Async Sub dashboardViewer1_Initialized(ByVal sender As Object, ByVal e As EventArgs)
    Await dashboardViewer1.ShowDataInspectorAsync("gridDashboardItem1")
End Sub

Implements

ShowDataInspectorAsync(String)