All docs
V19.2
19.2
19.1
The page you are viewing does not exist in version 19.1. This link will take you to the root page.
18.2
The page you are viewing does not exist in version 18.2. This link will take you to the root page.
18.1
The page you are viewing does not exist in version 18.1. This link will take you to the root page.
17.2
The page you are viewing does not exist in version 17.2. This link will take you to the root page.

DashboardViewer.MaximizeDashboardItemAsync(String) Method

Expands the specified dashboard item to the entire dashboard size in an asynchronous task.

Namespace: DevExpress.DashboardWin

Assembly: DevExpress.Dashboard.v19.2.Win.dll

Declaration

public Task MaximizeDashboardItemAsync(
    string itemName
)
Public Function MaximizeDashboardItemAsync(
    itemName As String
) As Task

Parameters

Name Type Description
itemName String

A String that is the dashboard item component name (the ComponentName property)

Returns

Type Description
Task

The task object that is the asynchronous operation to complete.

Remarks

Use the DashboardViewer.RestoreDashboardItemAsync method to restore the maximized item to its previous size.

Examples

This example demonstrates how to call the asynchronous maximize and restore methods to create a slide show with the dashboard items.

Note

The complete sample project How to Create a Slide Show with Asynchronous Maximize and Restore Methods is available in the DevExpress Examples repository.

using DevExpress.XtraEditors;
using System;
using System.Windows.Forms;

namespace MaximizeSlideShow
{
    public partial class ViewerForm1 : XtraForm {
        bool isSlideShown = false;
        int index = 0;
        Timer slideShowTimer = new Timer() {
            Interval = 5000
        };

        public ViewerForm1() {
            InitializeComponent();
            slideShowTimer.Tick += OnSlideShowTimerTick;
        }

        async void OnSlideShowTimerTick(object sender, EventArgs e) {
            var items = dashboardViewer1.Dashboard.Items;
            int maxIndex = items.Count - 1;

            if(!isSlideShown) {
                slideShowTimer.Stop();
                return;
            }
            await dashboardViewer1.MaximizeDashboardItemAsync(items[index].ComponentName);
            if(index == maxIndex)
                index = 0;
            else
                index++;
        }

        void OnStartClick(object sender, MouseEventArgs e) {
            if(!isSlideShown) {
                isSlideShown = true;
                slideShowTimer.Start();
            }
        }
        async void OnStopClick(object sender, EventArgs e) {
            isSlideShown = false;
            await dashboardViewer1.RestoreDashboardItemAsync();
        }
    }
}
See Also