DXTabControl.GetTabItem(Int32) Method

Returns a tab item by its index.

Namespace: DevExpress.Xpf.Core

Assembly: DevExpress.Xpf.Core.v20.2.dll

NuGet Packages: DevExpress.WindowsDesktop.Wpf.Core, DevExpress.Wpf.Core

Declaration

C#

public DXTabItem GetTabItem(
    int index
)

VB.NET

Public Function GetTabItem(
    index As Integer
) As DXTabItem

Parameters

Name	Type	Description
index	Int32	A zero-based integer value that specifies the tab item’s index.

Returns

Type	Description
DXTabItem	A DXTabItem object, that is a tab item with the specified index; null (Nothing in Visual Basic) if the specified index is out of range.

Remarks

Use the GetTabItem method to obtain a tab item, when tab control’s data items are not the DXTabItem type. This happens when the tab control is bound to a data source, or when its Items collection has been manually filled with arbitrary objects. In this instance, the GetTabItem method returns a DXTabItem object, obtained from a data item with the specified index, using the template specified by the ItemTemplate property.

To obtain a tab item by a data item, use another overload of the GetTabItem method that takes the item parameter.

Example

The following example shows how to allow end-users to only hide selected tab items.In this example, the SelectionChanged event is handled for this purpose. Tab items are obtained using the GetTabItem method.

View Example

MainWindow.xaml

<Window xmlns:controls="clr-namespace:DevExpress.Xpf.Core;assembly=DevExpress.Xpf.Core.v10.1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        x:Class="DXTabControl_AllowHideSelectedItem.MainWindow"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525">
    <Grid x:Name="LayoutRoot" Loaded="LayoutRoot_Loaded">
        <controls:DXTabControl x:Name="tabControl" Height="150" Width="300"
                       SelectionChanged="tabControl_SelectionChanged">
            <controls:DXTabControl.ItemHeaderTemplate>
                <DataTemplate>
                    <TextBlock Text="{Binding Path=ProductName}"/>
                </DataTemplate>
            </controls:DXTabControl.ItemHeaderTemplate>
            <controls:DXTabControl.ItemTemplate>
                <DataTemplate>
                    <StackPanel>
                        <StackPanel Orientation="Horizontal">
                            <TextBlock Text="ID = "/>
                            <TextBlock Text="{Binding Path=ID}" Foreground="Blue"/>
                        </StackPanel>
                        <StackPanel Orientation="Horizontal">
                            <TextBlock Text="Price = "/>
                            <TextBlock Text="{Binding Path=Price}" Foreground="Blue"/>
                        </StackPanel>
                        <StackPanel Orientation="Horizontal">
                            <TextBlock Text="Discount = "/>
                            <TextBlock Text="{Binding Path=Discount}" Foreground="Blue"/>
                        </StackPanel>
                        <StackPanel Orientation="Horizontal">
                            <TextBlock Text="Order Date = "/>
                            <TextBlock Text="{Binding Path=OrderDate}" Foreground="Blue"/>
                        </StackPanel>
                        <StackPanel Orientation="Horizontal">
                            <TextBlock Text="Status = "/>
                            <TextBlock Text="{Binding Path=Status}" Foreground="Blue"/>
                        </StackPanel>
                        <StackPanel Orientation="Horizontal">
                            <TextBlock Text="Urgent = "/>
                            <TextBlock Text="{Binding Path=IsUrgent}" Foreground="Blue"/>
                        </StackPanel>
                    </StackPanel>
                </DataTemplate>
            </controls:DXTabControl.ItemTemplate>
            <controls:DXTabControl.View>
                <controls:TabControlScrollView AllowHideTabItems="False"/>
            </controls:DXTabControl.View>
        </controls:DXTabControl>
    </Grid>
</Window>

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System.Windows
Imports DevExpress.Utils
Imports DevExpress.Xpf.Core
Imports DXExample.DemoData

Namespace DXTabControl_AllowHideSelectedItem
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
        End Sub
        Private Sub LayoutRoot_Loaded(ByVal sender As Object, ByVal e As RoutedEventArgs)
            tabControl.ItemsSource = Invoice.GetData()
        End Sub
        Private Sub tabControl_SelectionChanged(ByVal sender As Object, ByVal e As TabControlSelectionChangedEventArgs)
            Dim oldItem As DXTabItem = tabControl.GetTabItem(e.OldSelectedIndex)
            Dim newItem As DXTabItem = tabControl.GetTabItem(tabControl.SelectedIndex)
            If oldItem IsNot Nothing Then
                oldItem.AllowHide = DefaultBoolean.Default
            End If
            If newItem IsNot Nothing Then
                newItem.AllowHide = DefaultBoolean.True
            End If
        End Sub
    End Class
End Namespace

DataSource.cs

using System;
using System.Collections.Generic;

namespace DXExample.DemoData {
    public enum InvoiceStatus { Ordered, Payed, Shipped, Delivered, Invalidated }
    public class Invoice {
        public int ID { get; set; }
        public string ProductName { get; set; }
        public double Price { get; set; }
        public DateTime OrderDate { get; set; }
        public double Discount { get; set; }
        public bool IsUrgent { get; set; }
        public InvoiceStatus Status { get; set; }
        static public List<Invoice> GetData() {
            List<Invoice> data = new List<Invoice>();

            data.Add(new Invoice() { ID = 0, ProductName = "Tofu", IsUrgent = false,
                Price = 235.54, Discount = 9.4, Status = InvoiceStatus.Invalidated,
                OrderDate = new DateTime(2009, 3, 12) });
            data.Add(new Invoice() { ID = 1, ProductName = "Ravioli Angelo", IsUrgent = true,
                Price = 178.45, Discount = 6.1, Status = InvoiceStatus.Delivered,
                OrderDate = new DateTime(2009, 2, 9) });
            data.Add(new Invoice() { ID = 2, ProductName = "Geitost", IsUrgent = false,
                Price = 89.98, Discount = 5.4, Status = InvoiceStatus.Payed,
                OrderDate = new DateTime(2009, 4, 1) });
            data.Add(new Invoice() { ID = 3, ProductName = "Chang", IsUrgent = true,
                Price = 189.33, Discount = 18.2, Status = InvoiceStatus.Shipped,
                OrderDate = new DateTime(2009, 5, 23) });
            data.Add(new Invoice() { ID = 4, ProductName = "Inlagd Sill", IsUrgent = false, 
                Price = 509.10, Discount = 22.2, Status = InvoiceStatus.Ordered,
                OrderDate = new DateTime(2009, 6, 30) });
            data.Add(new Invoice() { ID = 5, ProductName = "Alice Mutton", IsUrgent = true,
                Price = 791.18, Discount = 24.4, Status = InvoiceStatus.Invalidated,
                OrderDate = new DateTime(2009, 5, 7) });

            return data;
        }
    }
}

MainWindow.xaml.cs

using System.Windows;
using DevExpress.Utils;
using DevExpress.Xpf.Core;
using DXExample.DemoData;

namespace DXTabControl_AllowHideSelectedItem {
    public partial class MainWindow : Window {
        public MainWindow() {
            InitializeComponent();
        }
        private void LayoutRoot_Loaded(object sender, RoutedEventArgs e) {
            tabControl.ItemsSource = Invoice.GetData();
        }
        private void tabControl_SelectionChanged(object sender, TabControlSelectionChangedEventArgs e) {
            DXTabItem oldItem = tabControl.GetTabItem(e.OldSelectedIndex);
            DXTabItem newItem = tabControl.GetTabItem(tabControl.SelectedIndex);
            if (oldItem != null)
                oldItem.AllowHide = DefaultBoolean.Default;
            if (newItem != null)
                newItem.AllowHide = DefaultBoolean.True;
        }
    }
}