DashboardViewer.GetSelectedTabPage(String) Method

Gets the selected page in the specified tab container.

Namespace: DevExpress.DashboardWin

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public string GetSelectedTabPage(
    string tabContainerName
)

VB.NET

Public Function GetSelectedTabPage(
    tabContainerName As String
) As String

Parameters

Name	Type	Description
tabContainerName	String	A String that is the TabContainerDashboardItem.ComponentName property value and identifies the tab container.

Returns

Type	Description
String	A String that is the DashboardTabPage.ComponentName property value and identifies the tab page.

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 

Implements

GetSelectedTabPage(String)