Back to Devexpress

DashboardControl.GetSelectedTabPageIndex(String) Method

dashboard-devexpress-dot-dashboardwpf-dot-dashboardcontrol-dot-getselectedtabpageindex-x28-system-dot-string-x29.md

latest3.6 KB
Original Source

DashboardControl.GetSelectedTabPageIndex(String) Method

Returns an index of the selected tab page in the specified tab container.

Namespace : DevExpress.DashboardWpf

Assembly : DevExpress.Dashboard.v25.2.Wpf.dll

NuGet Package : DevExpress.Wpf.Dashboard

Declaration

csharp
public int GetSelectedTabPageIndex(
    string tabContainerName
)
vb
Public Function GetSelectedTabPageIndex(
    tabContainerName As String
) As Integer

Parameters

NameTypeDescription
tabContainerNameString

A String that is the TabContainerDashboardItem component name.

|

Returns

TypeDescription
Int32

A String that is the TabContainerDashboardItem component name.

|

Example

The following code selects the last page in a tab container and displays its component name and index in the TabContainerDashboardItem.TabPages collection.

csharp
TabContainerDashboardItem tabContainer = dashboardControl.Dashboard.Items.
    FirstOrDefault(item => item is TabContainerDashboardItem) as TabContainerDashboardItem;
if (tabContainer != null)
    dashboardControl.SetSelectedTabPage(tabContainer.ComponentName, tabContainer.TabPages.Count-1);
string pageComponentName = dashboardControl.GetSelectedTabPage(tabContainer.ComponentName);
int pageIndex = dashboardControl.GetSelectedTabPageIndex(tabContainer.ComponentName);
MessageBox.Show(string.Format("Page {0} with index {1} is selected.", pageComponentName, pageIndex));
vb
Dim tabContainer As TabContainerDashboardItem = TryCast(dashboardControl.Dashboard.Items.FirstOrDefault(Function(item) TypeOf item Is TabContainerDashboardItem), TabContainerDashboardItem)
If tabContainer IsNot Nothing Then
    dashboardControl.SetSelectedTabPage(tabContainer.ComponentName, tabContainer.TabPages.Count-1)
End If
Dim pageComponentName As String = dashboardControl.GetSelectedTabPage(tabContainer.ComponentName)
Dim pageIndex As Integer = dashboardControl.GetSelectedTabPageIndex(tabContainer.ComponentName)
MessageBox.Show(String.Format("Page {0} with index {1} is selected.", pageComponentName, pageIndex))

See Also

Tab Container

SetSelectedTabPage

GetSelectedTabPage(String)

DashboardControl Class

DashboardControl Members

DevExpress.DashboardWpf Namespace