Skip to main content
All docs
V25.1
  • DashboardViewer.MaximizeDashboardItemAsync(String) Method

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

    Namespace: DevExpress.DashboardWin

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

    NuGet Package: DevExpress.Win.Dashboard

    Declaration

    public Task MaximizeDashboardItemAsync(
        string itemName
    )

    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.

    Example

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

    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