DashboardViewer.SetSelectedTabPage(String, Int32) Method

Selects the tab page specified by its index in the specified tab container.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public void SetSelectedTabPage(
    string tabContainerName,
    int index
)

VB.NET

Public Sub SetSelectedTabPage(
    tabContainerName As String,
    index As Integer
)

Parameters

Name	Type	Description
tabContainerName	String	A String that is the TabContainerDashboardItem.ComponentName property value and identifies the tab container.
index	Int32	An integer that is the index in the TabContainerDashboardItem.TabPages collection.

Example

The following code implements tab navigation in the TabContainerDashboardItem control.

View Example: How to navigate tabs using custom tab header buttons or set up a slide show

C#

using DevExpress.DashboardCommon;
using System.Linq;
// ...

enum NextPrevValue {
    Next,
    Prev
}

void ShowNextPrevTab(NextPrevValue value) {
    Dashboard dashboard = dashboardViewer.Dashboard;
    TabContainerDashboardItem tabContainer = dashboard.Items.SingleOrDefault(i => i is TabContainerDashboardItem) as TabContainerDashboardItem;
        if(tabContainer != null) {
            int increment = value == NextPrevValue.Next ? 1 : -1;
            string tabContainerName = tabContainer.ComponentName;
            int selectedIndex = dashboardViewer.GetSelectedTabPageIndex(tabContainerName);
            int pageCount = tabContainer.TabPages.Count;
            dashboardViewer.SetSelectedTabPage(tabContainerName, (selectedIndex + pageCount + increment) % pageCount);
        }
} 

VB.NET

Imports DevExpress.DashboardCommon
Imports System.Linq
' ...

Friend Enum NextPrevValue
    [Next]
    Prev
End Enum

Private Sub ShowNextPrevTab(ByVal value As NextPrevValue)
    Dim tabContainer As TabContainerDashboardItem = TryCast(dashboard.Items.SingleOrDefault(Function(i) TypeOf i Is TabContainerDashboardItem), TabContainerDashboardItem)
    If tabContainer IsNot Nothing Then
        Dim increment As Integer = If(value = NextPrevValue.Next, 1, -1)
        Dim tabContainerName As String = tabContainer.ComponentName
        Dim selectedIndex As Integer = dashboardViewer.GetSelectedTabPageIndex(tabContainerName)
        Dim pageCount As Integer = tabContainer.TabPages.Count
        dashboardViewer.SetSelectedTabPage(tabContainerName, (selectedIndex + pageCount + increment) Mod pageCount)
    End If
End Sub 

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetSelectedTabPage(String, Int32) 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-viewer-tab-navigation-buttons-tab-animation/CS/DashboardNextPrevTab/ViewerForm.cs#L65

    int pageCount = tabContainer.TabPages.Count;
    dashboardViewer.SetSelectedTabPage(tabContainerName, (selectedIndex + pageCount + increment) % pageCount);
}

winforms-dashboard-window-calculation-example/CS/WindowCalculationExample/Form1.cs#L96

    int pageCount = ((TabContainerDashboardItem)dashboardViewer1.Dashboard.Items[timedTabContainerName]).TabPages.Count;
    dashboardViewer1.SetSelectedTabPage(timedTabContainerName, ++selectedIndex % pageCount);
}

VB.NET

winforms-dashboard-viewer-tab-navigation-buttons-tab-animation/VB/DashboardNextPrevTab/ViewerForm.vb#L69

    Dim pageCount As Integer = tabContainer.TabPages.Count
    dashboardViewer.SetSelectedTabPage(tabContainerName, (selectedIndex + pageCount + increment) Mod pageCount)
End If

winforms-dashboard-window-calculation-example/VB/WindowCalculationExample/Form1.vb#L76

    Dim pageCount As Integer = CType(dashboardViewer1.Dashboard.Items(timedTabContainerName), TabContainerDashboardItem).TabPages.Count
    dashboardViewer1.SetSelectedTabPage(timedTabContainerName, Threading.Interlocked.Increment(selectedIndex) Mod pageCount)
End If

Implements

SetSelectedTabPage(String, Int32)