Class TabControlExt

TabControlExt, an application can define multiple pages for the same area of a window. TabControlExt contains the TabItemExt which is used to define Tab Items for the TabControlExt. Clicking on a Tab Item Header, will display the data corresponding to that particular Tab Item.

Inheritance
System.Object
TabControlExt
DocumentTabControl
Implements
System.IDisposable
Namespace: Syncfusion.Windows.Tools.Controls
Assembly: Syncfusion.Tools.Wpf.dll
Syntax
[SkinType(SkinVisualStyle = Skin.Office2007Blue, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2007BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Black, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2007BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2007Silver, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2007SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2010BlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2010BlackStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2010SilverStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2003, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2003Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Blend, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/BlendStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.SyncOrange, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/SyncOrangeStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyRed, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/ShinyRedStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.ShinyBlue, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/ShinyBlueStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Default, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF;component/Controls/TabControlExt/Themes/aero.normalcolor.xaml")]
[SkinType(SkinVisualStyle = Skin.VS2010, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/VS2010Style.xaml")]
[SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/MetroStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/TransparentStyle.xaml")]
[SkinType(SkinVisualStyle = Skin.Office2013, Type = typeof(TabControlExt), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabControlExt/Themes/Office2013Style.xaml")]
public class TabControlExt : TabControl, IDisposable
Examples






using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Data;
using System.Windows.Documents;
using System.Windows.Input;
using System.Windows.Media;
using System.Windows.Media.Imaging;
using System.Windows.Navigation;
using System.Windows.Shapes;
using Syncfusion.Windows.Tools.Controls;
namespace TabControlExt
{
/// 
/// Interaction logic for Window1.xaml
/// 
public partial class Window1 : Window
{
public Window1()
{
InitializeComponent();
TabControlExt tabControlExt = new TabControlExt();
StackPanel stackPanel = new StackPanel();
stackPanel.Children.Add(tabControlExt);
}
}
}

Constructors

TabControlExt()

Initializes a new instance of the TabControlExt class.

Declaration
public TabControlExt()

Fields

AllowDragDropProperty

Represents the AllowDragDropProperty Dependency property

Declaration
public static readonly DependencyProperty AllowDragDropProperty
Field Value
Type
System.Windows.DependencyProperty

CloseButtonTypeProperty

Represents the CloseButtonTypeProperty

Declaration
public static readonly DependencyProperty CloseButtonTypeProperty
Field Value
Type
System.Windows.DependencyProperty

CloseModeProperty

Declaration
public static readonly DependencyProperty CloseModeProperty
Field Value
Type
System.Windows.DependencyProperty

CloseTabOnMiddleClickProperty

Declaration
public static readonly DependencyProperty CloseTabOnMiddleClickProperty
Field Value
Type
System.Windows.DependencyProperty

CollapseDefaultTabListContextMenuItemsProperty

Represents the CollapseDefaultTabListContextMenuItemsProperty

Declaration
public static readonly DependencyProperty CollapseDefaultTabListContextMenuItemsProperty
Field Value
Type
System.Windows.DependencyProperty

ContextMenuItemsProperty

ContextMenuItems Dependency property key.

Declaration
protected static readonly DependencyProperty ContextMenuItemsProperty
Field Value
Type
System.Windows.DependencyProperty

CustomEditableTemplateProperty

Represents the IsAllTabsClosedProperty Dependency property

Declaration
public static readonly DependencyProperty CustomEditableTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

DefaultContextMenuItemVisibilityProperty

Represents the DefaultContextMenuItemVisiblity Dependency Property

Declaration
public static readonly DependencyProperty DefaultContextMenuItemVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

DisableResizeOnSelectionProperty

Represents the DisableResizeOnSelectionProperty

Declaration
public static readonly DependencyProperty DisableResizeOnSelectionProperty
Field Value
Type
System.Windows.DependencyProperty

DragEndEvent

Event represents the DragEndEvent

Declaration
public static readonly RoutedEvent DragEndEvent
Field Value
Type
System.Windows.RoutedEvent

DraggedItem

Represents the Dragged Item object

Declaration
public static FrameworkElement DraggedItem
Field Value
Type
System.Windows.FrameworkElement

DragMarkerColorProperty

Represents the DragMarkerColorProperty Dependency property

Declaration
public static readonly DependencyProperty DragMarkerColorProperty
Field Value
Type
System.Windows.DependencyProperty

DragMarkerStyleProperty

Represents the DragMarkerStyleProperty Dependency property

Declaration
public static readonly DependencyProperty DragMarkerStyleProperty
Field Value
Type
System.Windows.DependencyProperty

DragSourceObject

Represents the DragSource object

Declaration
public static FrameworkElement DragSourceObject
Field Value
Type
System.Windows.FrameworkElement

DragStartEvent

Event represents the DragStartEvent

Declaration
public static readonly RoutedEvent DragStartEvent
Field Value
Type
System.Windows.RoutedEvent

EditHeaderItemStyleProperty

Represents the EditHeaderItemStyle Dependency property

Declaration
public static readonly DependencyProperty EditHeaderItemStyleProperty
Field Value
Type
System.Windows.DependencyProperty

EditHeaderTemplateProperty

Declaration
public static readonly DependencyProperty EditHeaderTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

EnableAutoScrollProperty

Represents the EnableAutoScrollProperty

Declaration
public static readonly DependencyProperty EnableAutoScrollProperty
Field Value
Type
System.Windows.DependencyProperty

EnableLabelEditProperty

Represents the EnableLabelEditProperty Dependency property

Declaration
public static readonly DependencyProperty EnableLabelEditProperty
Field Value
Type
System.Windows.DependencyProperty

FullScreenModeProperty

Represents the FullScreenMode Dependency property

Declaration
public static readonly DependencyProperty FullScreenModeProperty
Field Value
Type
System.Windows.DependencyProperty

HideHeaderOnSingleChildProperty

Represents the HideHeaderOnSingleChild Dependency Property

Declaration
public static readonly DependencyProperty HideHeaderOnSingleChildProperty
Field Value
Type
System.Windows.DependencyProperty

HotTrackingEnabledProperty

Represents the HotTrackingEnabledProperty

Declaration
public static readonly DependencyProperty HotTrackingEnabledProperty
Field Value
Type
System.Windows.DependencyProperty

HoverBackgroundProperty

Represents the HoverBackgroundProperty

Declaration
public static readonly DependencyProperty HoverBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

ImageAlignmentProperty

Represents the ImageAlignmentProperty

Declaration
public static readonly DependencyProperty ImageAlignmentProperty
Field Value
Type
System.Windows.DependencyProperty

ImageHeightProperty

Represents the ImageHeightProperty

Declaration
public static readonly DependencyProperty ImageHeightProperty
Field Value
Type
System.Windows.DependencyProperty

ImageProperty

Represents the ImageProperty

Declaration
public static readonly DependencyProperty ImageProperty
Field Value
Type
System.Windows.DependencyProperty

ImageWidthProperty

Represents the ImageWidthProperty

Declaration
public static readonly DependencyProperty ImageWidthProperty
Field Value
Type
System.Windows.DependencyProperty

IsAllTabsClosedProperty

Represents the IsAllTabsClosedProperty Dependency property

Declaration
public static readonly DependencyProperty IsAllTabsClosedProperty
Field Value
Type
System.Windows.DependencyProperty

IsAllTabsClosedPropertyKey

Represents the IsAllTabsClosedPropertyKey Dependency property

Declaration
protected static readonly DependencyPropertyKey IsAllTabsClosedPropertyKey
Field Value
Type
System.Windows.DependencyPropertyKey

IsCustomTabItemContextMenuEnabledProperty

Represents the IsCustomTabItemContextMenuEnabledProperty

Declaration
public static readonly DependencyProperty IsCustomTabItemContextMenuEnabledProperty
Field Value
Type
System.Windows.DependencyProperty

IsDisableUnloadTabItemExtContentProperty

Represents the IsDisableUnLoadTabItemExtContent dependency property

Declaration
public static readonly DependencyProperty IsDisableUnloadTabItemExtContentProperty
Field Value
Type
System.Windows.DependencyProperty

IsEditingProperty

Represents the IsEditingProperty Dependency property

Declaration
protected static readonly DependencyProperty IsEditingProperty
Field Value
Type
System.Windows.DependencyProperty

IsLazyLoadedProperty

Declaration
public static readonly DependencyProperty IsLazyLoadedProperty
Field Value
Type
System.Windows.DependencyProperty

IsNewButtonClosedonNoChildProperty

Declaration
public static readonly DependencyProperty IsNewButtonClosedonNoChildProperty
Field Value
Type
System.Windows.DependencyProperty

IsNewButtonEnabledProperty

Represents the IsNewButtonEnabledProperty

Declaration
public static readonly DependencyProperty IsNewButtonEnabledProperty
Field Value
Type
System.Windows.DependencyProperty

KeepTabInFrontProperty

Represents the KeepTabInFrontProperty

Declaration
public static readonly DependencyProperty KeepTabInFrontProperty
Field Value
Type
System.Windows.DependencyProperty

m_Flag

internal variable which has flag

Declaration
public bool m_Flag
Field Value
Type
System.Boolean

MenuIconProperty

Represents the MenuIconProperty

Declaration
public static readonly DependencyProperty MenuIconProperty
Field Value
Type
System.Windows.DependencyProperty

MenuItemCloseAllTabsNameProperty

Represents the MenuItemCloseAllTabsNameProperty

Declaration
public static readonly DependencyProperty MenuItemCloseAllTabsNameProperty
Field Value
Type
System.Windows.DependencyProperty

MenuItemCloseOtherTabsNameProperty

Represents the MenuItemCloseOtherTabsNameProperty

Declaration
public static readonly DependencyProperty MenuItemCloseOtherTabsNameProperty
Field Value
Type
System.Windows.DependencyProperty

MenuItemCloseTabsNameProperty

Represents the MenuItemCloseTabsNameProperty

Declaration
public static readonly DependencyProperty MenuItemCloseTabsNameProperty
Field Value
Type
System.Windows.DependencyProperty

NewButtonAlignmentProperty

Represents the NewButtonStyle Dependency property

Declaration
public static readonly DependencyProperty NewButtonAlignmentProperty
Field Value
Type
System.Windows.DependencyProperty

NewButtonBackgroundProperty

Represents the NewButtonBackground Property

Declaration
public static readonly DependencyProperty NewButtonBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

NewButtonBorderThicknessProperty

Represents the NewButtonBorderThickness Dependency property

Declaration
public static readonly DependencyProperty NewButtonBorderThicknessProperty
Field Value
Type
System.Windows.DependencyProperty

NewButtonStyleProperty

Represents the NewButtonAlignment

Declaration
public static readonly DependencyProperty NewButtonStyleProperty
Field Value
Type
System.Windows.DependencyProperty

NewButtonTemplateProperty

Represents the NewButtonTemplateProperty Dependency property

Declaration
public static readonly DependencyProperty NewButtonTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

NewTabButtonTemplateProperty

Represents the NewButtonTemplateProperty Dependency property

Declaration
public static readonly DependencyProperty NewTabButtonTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

RotateTextWhenVerticalProperty

Represents the RotateTextWhenVerticalProperty

Declaration
public static readonly DependencyProperty RotateTextWhenVerticalProperty
Field Value
Type
System.Windows.DependencyProperty

ScrollingButtonStyleProperty

Represents the ScrollingButtonStyleProperty

Declaration
public static readonly DependencyProperty ScrollingButtonStyleProperty
Field Value
Type
System.Windows.DependencyProperty

ScrollingTimeProperty

Represents the ScrollingTimeProperty Dependency property

Declaration
public static readonly DependencyProperty ScrollingTimeProperty
Field Value
Type
System.Windows.DependencyProperty

SelectedItemFontWeightProperty

Represents the SelectedItemFontWeightProperty

Declaration
public static readonly DependencyProperty SelectedItemFontWeightProperty
Field Value
Type
System.Windows.DependencyProperty

SelectOnCreatingNewItemProperty

Represents the IsDisableUnLoadTabItemExtContent dependency property

Declaration
public static readonly DependencyProperty SelectOnCreatingNewItemProperty
Field Value
Type
System.Windows.DependencyProperty

ShowTabItemContextMenuProperty

Represents the ShowTabItemContextMenuProperty

Declaration
public static readonly DependencyProperty ShowTabItemContextMenuProperty
Field Value
Type
System.Windows.DependencyProperty

ShowTabListContextMenuProperty

Represents the ShowTabListContextMenuProperty Dependency property

Declaration
public static readonly DependencyProperty ShowTabListContextMenuProperty
Field Value
Type
System.Windows.DependencyProperty

TabClosingEvent

Routed event that is raised when the tab is about to close. User can cancel the closure by setting Cancel to true.

Declaration
public static readonly RoutedEvent TabClosingEvent
Field Value
Type
System.Windows.RoutedEvent

TabItemHeaderStyleProperty

Declaration
public static readonly DependencyProperty TabItemHeaderStyleProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemHoverBackgroundProperty

Represents the TabItemHoverBackground Property

Declaration
public static readonly DependencyProperty TabItemHoverBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemHoverBorderBrushProperty

Represents the TabItemHoverBorderBrush Property

Declaration
public static readonly DependencyProperty TabItemHoverBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemHoverForegroundProperty

Represents the TabItemSelectedForeground Property

Declaration
public static readonly DependencyProperty TabItemHoverForegroundProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemLayoutProperty

Represents the TabItemLayoutProperty

Declaration
public static readonly DependencyProperty TabItemLayoutProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemSelectedBackgroundProperty

Represents the TabItemSelectedBackground Property

Declaration
public static readonly DependencyProperty TabItemSelectedBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemSelectedBorderBrushProperty

Represents the TabItemSelectedBorderBrush Property

Declaration
public static readonly DependencyProperty TabItemSelectedBorderBrushProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemSelectedForegroundProperty

Represents the TabItemSelectedForeground Property

Declaration
public static readonly DependencyProperty TabItemSelectedForegroundProperty
Field Value
Type
System.Windows.DependencyProperty

TabItemSizeProperty

Represents the TabItemSizeProperty

Declaration
public static readonly DependencyProperty TabItemSizeProperty
Field Value
Type
System.Windows.DependencyProperty

TabListContextMenuItemsProperty

Represents the TabListContextMenuProperty

Declaration
public static readonly DependencyProperty TabListContextMenuItemsProperty
Field Value
Type
System.Windows.DependencyProperty

TabListContextMenuItemStyleProperty

Represents the TabListContextMenuItemStyle Dependency property

Declaration
public static readonly DependencyProperty TabListContextMenuItemStyleProperty
Field Value
Type
System.Windows.DependencyProperty

TabListContextMenuItemTemplateProperty

Represents the TabListContextMenuItemTemplateProperty Dependency property

Declaration
public static readonly DependencyProperty TabListContextMenuItemTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

TabListContextMenuOptionsProperty

Represents the TabListContextMenuOptionsProperty

Declaration
public static readonly DependencyProperty TabListContextMenuOptionsProperty
Field Value
Type
System.Windows.DependencyProperty

TabListContextMenuStyleProperty

Represents the TabListContextMenuStyle Dependency property

Declaration
public static readonly DependencyProperty TabListContextMenuStyleProperty
Field Value
Type
System.Windows.DependencyProperty

TabListContextMenuTemplateProperty

Represents the TabListContextMenuTemplate Dependency property

Declaration
public static readonly DependencyProperty TabListContextMenuTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

TabPanelBackgroundProperty

Represents the HoverBackgroundProperty

Declaration
public static readonly DependencyProperty TabPanelBackgroundProperty
Field Value
Type
System.Windows.DependencyProperty

TabPanelItemProperty

Represents the TabPanelItemProperty Dependency property

Declaration
public static readonly DependencyProperty TabPanelItemProperty
Field Value
Type
System.Windows.DependencyProperty

TabPanelStyleProperty

Represents the TabPanelStyleProperty

Declaration
public static readonly DependencyProperty TabPanelStyleProperty
Field Value
Type
System.Windows.DependencyProperty

TabPanelTemplateProperty

Represents the TabPanelTemplateProperty

Declaration
public static readonly DependencyProperty TabPanelTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

TabScrollButtonVisibilityProperty

Represents the TabScrollButtonVisibilityProperty

Declaration
public static readonly DependencyProperty TabScrollButtonVisibilityProperty
Field Value
Type
System.Windows.DependencyProperty

TabScrollStyleProperty

Represents the TabScrollStyleProperty

Declaration
public static readonly DependencyProperty TabScrollStyleProperty
Field Value
Type
System.Windows.DependencyProperty

TabVisualStyleProperty

Declaration
public static readonly DependencyProperty TabVisualStyleProperty
Field Value
Type
System.Windows.DependencyProperty

ToolBarTrayProperty

Represents the ToolBarTray Dependency property

Declaration
public static readonly DependencyProperty ToolBarTrayProperty
Field Value
Type
System.Windows.DependencyProperty

UseCustomEditableTemplateProperty

Represents the UseCustomEditableTemplateProperty Dependency property

Declaration
public static readonly DependencyProperty UseCustomEditableTemplateProperty
Field Value
Type
System.Windows.DependencyProperty

Properties

ActivatedItem

Gets or sets activated tab item.

Declaration
public TabItemExt ActivatedItem { get; set; }
Property Value
Type
TabItemExt

AllowDragDrop

Gets or sets a value indicating whether AllowDragDrop is true.

Declaration
public bool AllowDragDrop { get; set; }
Property Value
Type
System.Boolean

CloseButtonType

Gets or sets the value of the CloseButtonType dependency property.

Declaration
public CloseButtonType CloseButtonType { get; set; }
Property Value
Type
CloseButtonType

CloseMode

Declaration
public CloseMode CloseMode { get; set; }
Property Value
Type
CloseMode

CloseTabOnMiddleClick

Gets or set a value that indicate whether the tab can be closed on mouse middle button click.

Declaration
public bool CloseTabOnMiddleClick { get; set; }
Property Value
Type
System.Boolean

CollapseDefaultTabListContextMenuItems

Gets or sets a value indicating whether [collapse default tab list context menu items].

Declaration
public bool CollapseDefaultTabListContextMenuItems { get; set; }
Property Value
Type Description
System.Boolean

true if [collapse default tab list context menu items]; otherwise, false.

DefaultContextMenuItemVisibility

Gets or sets the default context menu item visibility.

Declaration
public Visibility DefaultContextMenuItemVisibility { get; set; }
Property Value
Type Description
System.Windows.Visibility

The default context menu item visibility.

DefaultDragMarkerStyle

Gets default style of the DragMarker.

Declaration
public Style DefaultDragMarkerStyle { get; }
Property Value
Type
System.Windows.Style

DisableResizeOnSelection

Gets or sets a value indicating whether [disable resize on selection].

Declaration
public bool DisableResizeOnSelection { get; set; }
Property Value
Type Description
System.Boolean

true if [disable resize on selection]; otherwise, false.

DragMarkerColor

Gets or sets the value of the DragMarkerColor dependency property.

Declaration
public Brush DragMarkerColor { get; set; }
Property Value
Type
System.Windows.Media.Brush

DragMarkerStyle

Gets or sets the value of the DragMarkerStyle dependency property.

Declaration
public Style DragMarkerStyle { get; set; }
Property Value
Type
System.Windows.Style

EditHeaderItemStyle

Gets or sets the edit header item style.

Declaration
public Style EditHeaderItemStyle { get; set; }
Property Value
Type Description
System.Windows.Style

The edit header item style.

EditHeaderTemplate

Declaration
public DataTemplate EditHeaderTemplate { get; set; }
Property Value
Type
System.Windows.DataTemplate

EnableAutoScroll

Gets or sets a value indicating whether auto scrolling is enabled when rearranging the tab items.

Declaration
public bool EnableAutoScroll { get; set; }
Property Value
Type Description
System.Boolean

By default auto scrolling is disabled.
Remarks

Tab reordering can be enabled by setting AllowDragDrop to true.

EnableLabelEdit

Gets or sets a value indicating whether the EnableLabelEdit is true.

Declaration
public bool EnableLabelEdit { get; set; }
Property Value
Type
System.Boolean

FullScreenMode

Gets or sets the value of the FullScreenMode dependency property.

Declaration
public FullScreenMode FullScreenMode { get; set; }
Property Value
Type
FullScreenMode

HideHeaderOnSingleChild

Hides the Header On Single Child

Declaration
public bool HideHeaderOnSingleChild { get; set; }
Property Value
Type
System.Boolean

HotTrackingEnabled

Gets or sets a value indicating whether the HotTrackingEnabled is true.

Declaration
public bool HotTrackingEnabled { get; set; }
Property Value
Type
System.Boolean

IsAllTabsClosed

Gets or sets a value indicating whether the DragMarkerStyle is true.

Declaration
public bool IsAllTabsClosed { get; protected set; }
Property Value
Type
System.Boolean

IsCustomTabItemContextMenuEnabled

Gets or sets a value indicating whether the IsCustomTabItemContextMenuEnabled is true.

Declaration
public bool IsCustomTabItemContextMenuEnabled { get; set; }
Property Value
Type
System.Boolean

IsDisableUnloadTabItemExtContent

Gets or sets a value indicating whether this instance is disable unload tab item ext content.

Declaration
public bool IsDisableUnloadTabItemExtContent { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is disable unload tab item ext content; otherwise, false.

IsDragging

Gets or sets a value indicating whether this instance is dragging.

Declaration
protected bool IsDragging { get; set; }
Property Value
Type Description
System.Boolean

true if this instance is dragging; otherwise, false.

IsLazyLoaded

Declaration
public bool IsLazyLoaded { get; set; }
Property Value
Type
System.Boolean

IsNewButtonClosedonNoChild

Gets or Sets IsNewButtonClosedonNoChild which indicates whether to close new tab or not when no child in Tabcontrol

Declaration
public bool IsNewButtonClosedonNoChild { get; set; }
Property Value
Type
System.Boolean

IsNewButtonEnabled

Gets or Sets IsNewTabEnabled which indicates whether to create new tab is displayed or not

Declaration
public bool IsNewButtonEnabled { get; set; }
Property Value
Type
System.Boolean

KeepTabInFront

Gets or sets a value indicating whether the KeepTabInFront is true.

Declaration
public bool KeepTabInFront { get; set; }
Property Value
Type
System.Boolean

MenuItemCloseAllTabsName

Gets or sets the name of the menu item close all tabs.

Declaration
[Obsolete("This property is deprecated,since we have localization support for menu item.")]
public string MenuItemCloseAllTabsName { get; set; }
Property Value
Type Description
System.String

The name of the menu item close all tabs.

MenuItemCloseOtherTabsName

Gets or sets the name of the menu item close other tabs.

Declaration
[Obsolete("This property is deprecated,since we have localization support for menu item.")]
public string MenuItemCloseOtherTabsName { get; set; }
Property Value
Type Description
System.String

The name of the menu item close other tabs.

MenuItemCloseTabsName

Gets or sets the name of the menu item close tabs.

Declaration
[Obsolete("This property is deprecated,since we have localization support for menu item.")]
public string MenuItemCloseTabsName { get; set; }
Property Value
Type Description
System.String

The name of the menu item close tabs.

NewButtonAlignment

Gets or Sets the Value of NewButtonAlignment Dependency Property

Declaration
public NewButtonAlignment NewButtonAlignment { get; set; }
Property Value
Type
NewButtonAlignment

NewButtonBackground

Gets or sets the value of NewButtonBackground Dependency Property.

Declaration
public Brush NewButtonBackground { get; set; }
Property Value
Type
System.Windows.Media.Brush

NewButtonBorderThickness

Gets or Sets the value of NewButtonBorderThickness Dependency Property.

Declaration
public Thickness NewButtonBorderThickness { get; set; }
Property Value
Type
System.Windows.Thickness

NewButtonStyle

Gets or Sets the value of NewButtonStyle Dependency property

Declaration
[Obsolete("This property is obsolete, please use NewButtonDataTemplate to modify appearance of new tab button.")]
public Style NewButtonStyle { get; set; }
Property Value
Type
System.Windows.Style

NewButtonTemplate

Gets or Sets the value of NewButtonTemplate Dependency property

Declaration
[Obsolete("This property is obsolete, please use NewButtonDataTemplate to modify appearance of new tab button.")]
public ControlTemplate NewButtonTemplate { get; set; }
Property Value
Type
System.Windows.Controls.ControlTemplate

NewTabButtonTemplate

Gets or sets the DataTemplate that defines the visual representation of the new tab button. The object that defines visual representation of the new tab button. A DataTemplate representing plus(+) symbol is the default value. By enabling IsNewButtonEnabled you can add new tab, by handling NewButtonClick event. This event will be triggered when new tab button is clicked.The DataContext of the NewTabButtonTemplate is inherited from TabControlExt

Declaration
public DataTemplate NewTabButtonTemplate { get; set; }
Property Value
Type
System.Windows.DataTemplate

RotateTextWhenVertical

Gets or sets a value indicating whether the RotateTextWhenVertical is true.

Declaration
public bool RotateTextWhenVertical { get; set; }
Property Value
Type
System.Boolean

ScrollingButtonStyle

Gets or sets the value of the ScrollingButtonStyle dependency property.

Declaration
public Style ScrollingButtonStyle { get; set; }
Property Value
Type
System.Windows.Style

ScrollingTime

Gets or sets tabs scrolling time in milliseconds.

Declaration
public int ScrollingTime { get; set; }
Property Value
Type
System.Int32

SelectedItemFontWeight

Gets or sets the value of the SelectedItemFontWeight dependency property.

Declaration
public FontWeight SelectedItemFontWeight { get; set; }
Property Value
Type
System.Windows.FontWeight

SelectOnCreatingNewItem

Declaration
public bool SelectOnCreatingNewItem { get; set; }
Property Value
Type
System.Boolean

ShowTabItemContextMenu

Gets or sets a value indicating whether the ShowTabItemContextMenu is true.

Declaration
public bool ShowTabItemContextMenu { get; set; }
Property Value
Type
System.Boolean

ShowTabListContextMenu

Gets or sets a value indicating whether the ShowTabListContextMenu is true.

Declaration
[Obsolete("This property is deprecated, please set TabListContextMenuOptions to TabListContextMenuOptions.Default")]
public bool ShowTabListContextMenu { get; set; }
Property Value
Type
System.Boolean

TabItemHeaderStyle

Gets or sets the style for the headers of tabs within the TabControlExt.

Declaration
public TabItemHeaderStyle TabItemHeaderStyle { get; set; }
Property Value
Type Description
TabItemHeaderStyle

The TabHeaderStyle property allows customization of visual styles for tab headers.
Remarks

This property is effective exclusively with theme-studio themes only and does not apply to classic themes and the default UI.

TabItemHoverBackground

Declaration
public Brush TabItemHoverBackground { get; set; }
Property Value
Type
System.Windows.Media.Brush

TabItemHoverBorderBrush

Declaration
public Brush TabItemHoverBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

TabItemHoverForeground

Declaration
public Brush TabItemHoverForeground { get; set; }
Property Value
Type
System.Windows.Media.Brush

TabItemLayout

Gets or sets the value of the TabItemLayout dependency property.

Declaration
public TabItemLayoutType TabItemLayout { get; set; }
Property Value
Type
TabItemLayoutType

TabItemSelectedBackground

Declaration
public Brush TabItemSelectedBackground { get; set; }
Property Value
Type
System.Windows.Media.Brush

TabItemSelectedBorderBrush

Declaration
public Brush TabItemSelectedBorderBrush { get; set; }
Property Value
Type
System.Windows.Media.Brush

TabItemSelectedForeground

Declaration
public Brush TabItemSelectedForeground { get; set; }
Property Value
Type
System.Windows.Media.Brush

TabItemSize

Gets or sets the value of the TabItemSize dependency property.

Declaration
public TabItemSizeMode TabItemSize { get; set; }
Property Value
Type
TabItemSizeMode

TabListContextMenuItems

Declaration
public DocumentTabItemMenuItemCollection TabListContextMenuItems { get; set; }
Property Value
Type
DocumentTabItemMenuItemCollection

TabListContextMenuItemStyle

Gets or sets the tab list context menu item style.

Declaration
public Style TabListContextMenuItemStyle { get; set; }
Property Value
Type Description
System.Windows.Style

The tab list context menu item style.

TabListContextMenuItemTemplate

Gets or sets the value of the TabListContextMenuItemTemplate dependency property.

Declaration
public DataTemplate TabListContextMenuItemTemplate { get; set; }
Property Value
Type
System.Windows.DataTemplate

TabListContextMenuOptions

Get or sets a value that indicates which type of items should be visible in TabListContextMenu

Declaration
public TabListContextMenuOptions TabListContextMenuOptions { get; set; }
Property Value
Type
TabListContextMenuOptions
Examples
//To show visile, disable and custom tab items.
tabControl.TabListContextMenuOptions = TabListContextMenuOptions.Default;
//To disable <b>TabListContextMenu</b>
tabControl.TabListContextMenuOptions = TabListContextMenuOptions.None;
// To show only enabled and hidden items
tabControl.TabListContextMenuOptions = TabListContextMenuOptions.ShowEnabledItems | ShowHiddenItems;

TabListContextMenuStyle

Gets or sets the tab list context menu style.

Declaration
public Style TabListContextMenuStyle { get; set; }
Property Value
Type Description
System.Windows.Style

The tab list context menu style.

TabListContextMenuTemplate

Gets or sets the tab list context menu template.

Declaration
public ControlTemplate TabListContextMenuTemplate { get; set; }
Property Value
Type Description
System.Windows.Controls.ControlTemplate

The tab list context menu template.

TabPanelBackground

Gets or sets the tab panel background.

Declaration
public Brush TabPanelBackground { get; set; }
Property Value
Type Description
System.Windows.Media.Brush

The tab panel background.

TabPanelItem

Gets or sets the value of the TabPanelItem dependency property.

Declaration
public object TabPanelItem { get; set; }
Property Value
Type
System.Object

TabPanelStyle

Gets or sets the value of the TabPanelStyle dependency property.

Declaration
public Style TabPanelStyle { get; set; }
Property Value
Type
System.Windows.Style

TabPanelTemplate

Gets or sets the value of the TabPanelTemplate dependency property.

Declaration
public ControlTemplate TabPanelTemplate { get; set; }
Property Value
Type
System.Windows.Controls.ControlTemplate

TabScrollButtonVisibility

Gets or sets the value of the TabScrollButtonVisibility dependency property.

Declaration
public TabScrollButtonVisibility TabScrollButtonVisibility { get; set; }
Property Value
Type
TabScrollButtonVisibility

TabScrollStyle

Gets or sets the value of the TabScrollStyle dependency property.

Declaration
public TabScrollStyle TabScrollStyle { get; set; }
Property Value
Type
TabScrollStyle

TabVisualStyle

Declaration
public TabVisualStyle TabVisualStyle { get; set; }
Property Value
Type
TabVisualStyle

ToolBarTray

Gets or sets the value of the ToolBarTray dependency property.

Declaration
public ToolBarTray ToolBarTray { get; set; }
Property Value
Type
System.Windows.Controls.ToolBarTray

Methods

CanCloseTabItem(TabItemExt)

Determines whether this instance [can close tab item] the specified item.

Declaration
protected virtual bool CanCloseTabItem(TabItemExt item)
Parameters
Type Name Description
TabItemExt item

The tab item
Returns
Type Description
System.Boolean

true if this instance [can close tab item] the specified item; otherwise, false.

CanProcessCloseCurrentTabItemCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected virtual void CanProcessCloseCurrentTabItemCommand(object sender, CanExecuteRoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.CanExecuteRoutedEventArgs e

The event data.

CanProcessCloseTabItemCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected virtual void CanProcessCloseTabItemCommand(object sender, CanExecuteRoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.CanExecuteRoutedEventArgs e

The event data.

CanProcessCloseTabsCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected virtual void CanProcessCloseTabsCommand(object sender, CanExecuteRoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.CanExecuteRoutedEventArgs e

The event data.

CanProcessPinTabsCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected virtual void CanProcessPinTabsCommand(object sender, CanExecuteRoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The source of the event.
System.Windows.Input.CanExecuteRoutedEventArgs e

The event data.

ClearContainerForItemOverride(DependencyObject, Object)

Invoked when cleaer the item from container

Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
Type Name Description
System.Windows.DependencyObject element

Container generated item
System.Object item

container item

CompleteHeaderEdit(TabItemExt, Boolean)

Complete editing process on the specifies TabItemExt.

Declaration
public void CompleteHeaderEdit(TabItemExt editableItem, bool applyChanges)
Parameters
Type Name Description
TabItemExt editableItem

TabItemExt which is editing in the current moment.
System.Boolean applyChanges

Specifies whether editing changes should be applied or no.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()

FireAfterLabelEdit(TabItemExt)

Fires the after label edit.

Declaration
protected virtual void FireAfterLabelEdit(TabItemExt tabitem)
Parameters
Type Name Description
TabItemExt tabitem

FireBeforeDropDownContextMenuClose()

Fires the before drop down context menu close.

Declaration
protected virtual void FireBeforeDropDownContextMenuClose()

FireBeforeDropDownContextMenuOpen()

Fires the before drop down context menu open.

Declaration
protected virtual void FireBeforeDropDownContextMenuOpen()

FireBeforeLabelEdit(TabItemExt)

Fires the before label edit.

Declaration
protected virtual bool FireBeforeLabelEdit(TabItemExt tabitem)
Parameters
Type Name Description
TabItemExt tabitem
Returns
Type
System.Boolean

FireDragEnd(TabItemExt)

Fires the drag end.

Declaration
protected virtual TabControlExtDragEventArgs FireDragEnd(TabItemExt item)
Parameters
Type Name Description
TabItemExt item

Value of the item.
Returns
Type Description
TabControlExtDragEventArgs

returns TabControlExtDragEventArgs

FireDragStart(TabItemExt)

Fires the drag start.

Declaration
protected virtual TabControlExtDragEventArgs FireDragStart(TabItemExt item)
Parameters
Type Name Description
TabItemExt item

Value of the item.
Returns
Type Description
TabControlExtDragEventArgs

returns TabControlExtDragEventArgs

FireOnCloseAllTabs(CloseTabEventArgs)

Raises OnCloseAllTabs event.

Declaration
protected virtual void FireOnCloseAllTabs(CloseTabEventArgs e)
Parameters
Type Name Description
CloseTabEventArgs e

Property change details, such as old value and new value.

FireOnCloseButtonClick(CloseTabEventArgs)

Raises OnCloseButtonClick event.

Declaration
protected virtual void FireOnCloseButtonClick(CloseTabEventArgs e)
Parameters
Type Name Description
CloseTabEventArgs e

Property change details, such as old value and new value.

FireOnClosedTab(CloseTabEventArgs)

Raises after a Tab is Closed.

Declaration
protected virtual void FireOnClosedTab(CloseTabEventArgs e)
Parameters
Type Name Description
CloseTabEventArgs e

Property Changed Details such as TargetItem

FireOnCloseOtherTabs(CloseTabEventArgs)

Raises OnCloseOtherTabs event.

Declaration
protected virtual void FireOnCloseOtherTabs(CloseTabEventArgs e)
Parameters
Type Name Description
CloseTabEventArgs e

Property change details, such as old value and new value.

FireSelectedItemChangedEvent(SelectedItemChangedEventArgs)

Raises SelectedItemChanged event.

Declaration
protected virtual void FireSelectedItemChangedEvent(SelectedItemChangedEventArgs e)
Parameters
Type Name Description
SelectedItemChangedEventArgs e

The SelectedItemChangedEventArgs instance containing the event data.

GetContainerForItemOverride()

Creates or identifies the element that is used to display the given item.

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
Type Description
System.Windows.DependencyObject

The element that is used to display the given item.

GetContextMenuItems(DependencyObject)

Gets the value of the ContextMenuItems dependency property.

Declaration
public static ObservableCollection<object> GetContextMenuItems(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Collections.ObjectModel.ObservableCollection<System.Object>

returns an ObservableCollection

GetCustomEditableTemplate(DependencyObject)

Gets the value of the CustomEditableTemplate dependency property.

Declaration
public static DataTemplate GetCustomEditableTemplate(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Windows.DataTemplate

returns a DataTemplate

GetHoverBackground(DependencyObject)

Gets the value of the HoverBackground dependency property.

Declaration
public static Brush GetHoverBackground(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Windows.Media.Brush

returns a Brush

GetImage(DependencyObject)

Gets the value of the Image dependency property.

Declaration
public static ImageSource GetImage(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Windows.Media.ImageSource

returns an ImageSource

GetImageAlignment(DependencyObject)

Gets the value of the ImageAlignment dependency property.

Declaration
public static ImageAlignment GetImageAlignment(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
ImageAlignment

returns a ImageAlignment

GetImageHeight(DependencyObject)

Gets the value of the ImageHeight dependency property.

Declaration
public static double GetImageHeight(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Double

returns a double value

GetImageWidth(DependencyObject)

Gets the value of the ImageWidth dependency property.

Declaration
public static double GetImageWidth(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Double

returns a double value

GetIsEditing(DependencyObject)

Gets the value of the IsEditing dependency property.

Declaration
public static bool GetIsEditing(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Boolean

returns bool value

GetMenuIcon(DependencyObject)

Gets the menu icon.

Declaration
public static ImageSource GetMenuIcon(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj.
Returns
Type
System.Windows.Media.ImageSource

GetUseCustomEditableTemplate(DependencyObject)

Gets the value of the UseCustomEditableTemplate dependency property.

Declaration
public static bool GetUseCustomEditableTemplate(DependencyObject obj)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
Returns
Type Description
System.Boolean

returns bool value

InvokeNewTabItem(Object, EventArgs)

Invokes the new tab item.

Declaration
public object InvokeNewTabItem(object sender, EventArgs args)
Parameters
Type Name Description
System.Object sender

The sender.
System.EventArgs args

The System.EventArgs instance containing the event data.
Returns
Type
System.Object

IsItemItsOwnContainerOverride(Object)

Determines if the specified item is (or is eligible to be) its own ItemContainer.

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
Type Name Description
System.Object item

Specified item.
Returns
Type Description
System.Boolean

Returns true if the item is its own ItemContainer; otherwise, false.

LabelEditStart(TabItemExt)

Launch LabelEdit operation on the specified item.

Declaration
public void LabelEditStart(TabItemExt item)
Parameters
Type Name Description
TabItemExt item

Item which header will be editing.

LoadTabState(SaveMode)

Loads the state persisted.

Declaration
public void LoadTabState(SaveMode mode)
Parameters
Type Name Description
SaveMode mode

Value of the mode.

MeasureOverride(Size)

Preforms Measure process

Declaration
protected override Size MeasureOverride(Size constraint)
Parameters
Type Name Description
System.Windows.Size constraint
Returns
Type
System.Windows.Size

OnAllowDragDropChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises AllowDragDropChanged event.

Declaration
protected virtual void OnAllowDragDropChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnApplyTemplate()

Called when an internal process or application calls ApplyTemplate, which is used to build the current template's visual tree.

Declaration
public override void OnApplyTemplate()

OnCloseButtonTypeChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises CloseButtonTypeChanged event.

Declaration
protected virtual void OnCloseButtonTypeChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnCreateAutomationPeer()

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
Type
System.Windows.Automation.Peers.AutomationPeer

OnDragMarkerColorChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises DragMarkerColorChanged event.

Declaration
protected virtual void OnDragMarkerColorChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnDragMarkerStyleChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises DragMarkerStyleChanged event.

Declaration
protected virtual void OnDragMarkerStyleChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnEnableLabelEditChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises EnableLabelEditChanged event.

Declaration
protected virtual void OnEnableLabelEditChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnFlowDirectionChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises FlowDirectionChanged event.

Declaration
protected virtual void OnFlowDirectionChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnHotTrackingEnabledChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises HotTrackingEnabledChanged event.

Declaration
protected virtual void OnHotTrackingEnabledChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnInitialized(EventArgs)

Called when System.Windows.FrameworkElement.IsInitialized is set to true.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

Provides data for the System.Windows.FrameworkElement.Initialized event.

OnIsCloseTabProcessEnabledChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises IsCloseTabProcessEnabledChanged event.

Declaration
protected virtual void OnIsCloseTabProcessEnabledChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnItemsChanged(NotifyCollectionChangedEventArgs)

Called to update the current selection when items change.

Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
Type Name Description
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The event data for the System.Windows.Controls.ItemContainerGenerator.ItemsChanged event.

OnItemsSourceChanged(IEnumerable, IEnumerable)

Called when the source of an item in a selector changes.

Declaration
protected override void OnItemsSourceChanged(IEnumerable oldValue, IEnumerable newValue)
Parameters
Type Name Description
System.Collections.IEnumerable oldValue

Old value of the source.
System.Collections.IEnumerable newValue

New value of the source.

OnKeepTabInFrontChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises KeepTabInFrontChanged event.

Declaration
protected virtual void OnKeepTabInFrontChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnPreviewKeyDown(KeyEventArgs)

Invoked when an unhandled System.Windows.Input.Keyboard.PreviewKeyDownattached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnPreviewKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Input.KeyEventArgs e

The System.Windows.Input.KeyEventArgs that contains the event data.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

Called when some dependencyProperty is changed.

Declaration
protected override void OnPropertyChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Provides data for various property changed events. Typically these events report effective value changes in the value of a read-only dependency property.

OnRotateTextWhenVerticalChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises RotateTextWhenVerticalChanged event.

Declaration
protected virtual void OnRotateTextWhenVerticalChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnScrollingTimeChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ScrollingTimeChanged event.

Declaration
protected virtual void OnScrollingTimeChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnSelectedIndexChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises SelectedIndexChanged event.

Declaration
protected virtual void OnSelectedIndexChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnSelectedItemFontWeightChanged(DependencyPropertyChangedEventArgs)

Raises SelectedItemFontWeightChanged event.

Declaration
protected virtual void OnSelectedItemFontWeightChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnSelectionChanged(SelectionChangedEventArgs)

Raises the System.Windows.Controls.Primitives.Selector.SelectionChanged routed event.

Declaration
protected override void OnSelectionChanged(SelectionChangedEventArgs e)
Parameters
Type Name Description
System.Windows.Controls.SelectionChangedEventArgs e

Provides data for System.Windows.Controls.SelectionChangedEventArgs.

OnShowTabItemContextMenuChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ShowTabItemContextMenuChanged event.

Declaration
protected virtual void OnShowTabItemContextMenuChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnShowTabListContextMenuChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises ShowTabListContextMenuChanged event.

Declaration
protected virtual void OnShowTabListContextMenuChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnStylusSystemGesture(StylusSystemGestureEventArgs)

Declaration
protected override void OnStylusSystemGesture(StylusSystemGestureEventArgs e)
Parameters
Type Name Description
System.Windows.Input.StylusSystemGestureEventArgs e

OnTabItemLayoutChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabItemLayoutChanged event.

Declaration
protected virtual void OnTabItemLayoutChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabItemSizeChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabItemSizeChanged event.

Declaration
protected virtual void OnTabItemSizeChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabListContextMenuItemTemplateChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabListContextMenuItemTemplateChanged event.

Declaration
protected virtual void OnTabListContextMenuItemTemplateChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabPanelBackgroundChanged(DependencyPropertyChangedEventArgs)

Raises the TabPanelBackgroundChanged event.

Declaration
protected virtual void OnTabPanelBackgroundChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnTabPanelItemChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabPanelItemChanged event.

Declaration
protected virtual void OnTabPanelItemChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabPanelStyleChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabPanelStyleChanged event.

Declaration
protected virtual void OnTabPanelStyleChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabPanelTemplateChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabPanelTemplateChanged event.

Declaration
protected virtual void OnTabPanelTemplateChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabScrollButtonVisibilityChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabScrollButtonVisibilityChanged event.

Declaration
protected virtual void OnTabScrollButtonVisibilityChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabScrollStyleChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabScrollStyleChanged event.

Declaration
protected virtual void OnTabScrollStyleChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTabStripPlacementChanged(DependencyPropertyChangedEventArgs)

Updates property value cache and raises TabStripPlacementChanged event.

Declaration
protected virtual void OnTabStripPlacementChanged(DependencyPropertyChangedEventArgs e)
Parameters
Type Name Description
System.Windows.DependencyPropertyChangedEventArgs e

Property change details, such as old value and new value.

OnTakeDragItemEvent(TabItemExt)

Called when [take drag item event].

Declaration
protected virtual void OnTakeDragItemEvent(TabItemExt item)
Parameters
Type Name Description
TabItemExt item

Value of the item.

PrepareContainerForItemOverride(DependencyObject, Object)

Prepare Container for the particular item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
Type Name Description
System.Windows.DependencyObject element

The container element used to display the given item.
System.Object item

The item for which the container has to be prepared.

SaveTabState(SaveMode)

Saves the state persisted for the current TabControlExt location.

Declaration
public void SaveTabState(SaveMode mode)
Parameters
Type Name Description
SaveMode mode

Value of the mode.

SetContextMenuItems(DependencyObject, ObservableCollection<Object>)

Sets the value of the ContextMenuItems dependency property.

Declaration
protected static void SetContextMenuItems(DependencyObject obj, ObservableCollection<object> value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Collections.ObjectModel.ObservableCollection<System.Object> value

The value.

SetCustomEditableTemplate(DependencyObject, DataTemplate)

Sets the value of the CustomEditableTemplate dependency property.

Declaration
public static void SetCustomEditableTemplate(DependencyObject obj, DataTemplate value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Windows.DataTemplate value

The value.

SetHoverBackground(DependencyObject, Brush)

Sets the value of the HoverBackground dependency property.

Declaration
public static void SetHoverBackground(DependencyObject obj, Brush value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Windows.Media.Brush value

The value.

SetImage(DependencyObject, ImageSource)

Sets the value of the Image dependency property.

Declaration
public static void SetImage(DependencyObject obj, ImageSource value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Windows.Media.ImageSource value

The value.

SetImageAlignment(DependencyObject, ImageAlignment)

Sets the value of the ImageAlignment dependency property.

Declaration
public static void SetImageAlignment(DependencyObject obj, ImageAlignment value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
ImageAlignment value

The value.

SetImageHeight(DependencyObject, Double)

Sets the value of the ImageHeight dependency property.

Declaration
public static void SetImageHeight(DependencyObject obj, double value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Double value

The value.

SetImageWidth(DependencyObject, Double)

Sets the value of the ImageWidth dependency property.

Declaration
public static void SetImageWidth(DependencyObject obj, double value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Double value

The value.

SetIsEditing(DependencyObject, Boolean)

Sets the value of the IsEditing dependency property.

Declaration
protected static void SetIsEditing(DependencyObject obj, bool value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Boolean value

if set to true [value].

SetMenuIcon(DependencyObject, ImageSource)

Sets the menu icon.

Declaration
public static void SetMenuIcon(DependencyObject obj, ImageSource value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

The obj.
System.Windows.Media.ImageSource value

The value.

SetUseCustomEditableTemplate(DependencyObject, Boolean)

Sets the value of the UseCustomEditableTemplate dependency property.

Declaration
public static void SetUseCustomEditableTemplate(DependencyObject obj, bool value)
Parameters
Type Name Description
System.Windows.DependencyObject obj

Sender Object.
System.Boolean value

if set to true [value].

VerifyZIndex()

Verifies the index of the Z.

Declaration
protected void VerifyZIndex()

Events

AfterLabelEdit

Occurs when [after label edit].

Declaration
public event AfterLabelEditHandler AfterLabelEdit
Event Type
Type
AfterLabelEditHandler

AllowDragDropChanged

Event that is raised when AllowDragDrop property is changed.

Declaration
public event PropertyChangedCallback AllowDragDropChanged
Event Type
Type
System.Windows.PropertyChangedCallback

BeforeDropDownContextMenuClose

Occurs when [before drop down context menu close].

Declaration
public event EventHandler BeforeDropDownContextMenuClose
Event Type
Type
System.EventHandler

BeforeDropDownContextMenuOpen

Occurs when [before drop down context menu open].

Declaration
public event EventHandler BeforeDropDownContextMenuOpen
Event Type
Type
System.EventHandler

BeforeLabelEdit

Occurs when [before label edit].

Declaration
public event BeforeLabelEditHandler BeforeLabelEdit
Event Type
Type
BeforeLabelEditHandler

CloseButtonTypeChanged

Event that is raised when CloseButtonType property is changed.

Declaration
public event PropertyChangedCallback CloseButtonTypeChanged
Event Type
Type
System.Windows.PropertyChangedCallback

DragEnd

Occurs when [drag end].

Declaration
public event TabControlExt.TabControlExtDragHandler DragEnd
Event Type
Type
TabControlExt.TabControlExtDragHandler

DragMarkerColorChanged

Event that is raised when DragMarkerColor property is changed.

Declaration
public event PropertyChangedCallback DragMarkerColorChanged
Event Type
Type
System.Windows.PropertyChangedCallback

DragMarkerStyleChanged

Event that is raised when DragMarkerStyle property is changed.

Declaration
public event PropertyChangedCallback DragMarkerStyleChanged
Event Type
Type
System.Windows.PropertyChangedCallback

DragStart

Occurs when [drag start].

Declaration
public event TabControlExt.TabControlExtDragHandler DragStart
Event Type
Type
TabControlExt.TabControlExtDragHandler

EnableLabelEditChanged

Event that is raised when EnableLabelEdit property is changed.

Declaration
public event PropertyChangedCallback EnableLabelEditChanged
Event Type
Type
System.Windows.PropertyChangedCallback

FlowDirectionChanged

Event that is raised when FlowDirection property is changed.

Declaration
public event PropertyChangedCallback FlowDirectionChanged
Event Type
Type
System.Windows.PropertyChangedCallback

HotTrackingEnabledChanged

Event that is raised when HotTrackingEnabled property is changed.

Declaration
public event PropertyChangedCallback HotTrackingEnabledChanged
Event Type
Type
System.Windows.PropertyChangedCallback

KeepTabInFrontChanged

Event that is raised when KeepTabInFront property is changed.

Declaration
public event PropertyChangedCallback KeepTabInFrontChanged
Event Type
Type
System.Windows.PropertyChangedCallback

NewButtonClick

Occurs when [new button click].

Declaration
public event EventHandler NewButtonClick
Event Type
Type
System.EventHandler

OnCloseAllTabs

Occurs when [on close all tabs].

Declaration
public event OnCloseTabsEventHandler OnCloseAllTabs
Event Type
Type
OnCloseTabsEventHandler

OnCloseButtonClick

Occurs when [on close button click].

Declaration
public event OnCloseTabsEventHandler OnCloseButtonClick
Event Type
Type
OnCloseTabsEventHandler

OnCloseOtherTabs

Event that is raised when IsCloseTabProcessEnabled property is changed.

Declaration
public event OnCloseTabsEventHandler OnCloseOtherTabs
Event Type
Type
OnCloseTabsEventHandler

PreviewSelectedItemChangedEvent

Declaration
public event PreviewSelectedItemChangedEventHandler PreviewSelectedItemChangedEvent
Event Type
Type
PreviewSelectedItemChangedEventHandler

RotateTextWhenVerticalChanged

Event that is raised when RotateTextWhenVertical property is changed.

Declaration
public event PropertyChangedCallback RotateTextWhenVerticalChanged
Event Type
Type
System.Windows.PropertyChangedCallback

ScrollingTimeChanged

Event that is raised when ScrollingTime property is changed.

Declaration
public event PropertyChangedCallback ScrollingTimeChanged
Event Type
Type
System.Windows.PropertyChangedCallback

SelectedIndexChanged

Event that is raised when SelectedIndex property is changed.

Declaration
public event PropertyChangedCallback SelectedIndexChanged
Event Type
Type
System.Windows.PropertyChangedCallback

SelectedItemChangedEvent

Occurs when [selected item changed event].

Declaration
public event SelectedItemChangedEventHandler SelectedItemChangedEvent
Event Type
Type
SelectedItemChangedEventHandler

SelectedItemFontWeightChanged

Event that is raised when SelectedItemFontWeight property is changed.

Declaration
public event PropertyChangedCallback SelectedItemFontWeightChanged
Event Type
Type
System.Windows.PropertyChangedCallback

ShowTabItemContextMenuChanged

Event that is raised when ShowTabItemContextMenu property is changed.

Declaration
[Obsolete("This event is deprecated")]
public event PropertyChangedCallback ShowTabItemContextMenuChanged
Event Type
Type
System.Windows.PropertyChangedCallback

ShowTabListContextMenuChanged

Event that is raised when ShowTabListContextMenu property is changed.

Declaration
[Obsolete("This event is deprecated")]
public event PropertyChangedCallback ShowTabListContextMenuChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabClosed

Declaration
public event TabClosedEventHandler TabClosed
Event Type
Type
TabClosedEventHandler

TabClosing

Occurs when [document closing].

Declaration
public event CancelingRoutedEventHandler TabClosing
Event Type
Type
CancelingRoutedEventHandler

TabItemLayoutChanged

Event that is raised when TabItemLayout property is changed.

Declaration
public event PropertyChangedCallback TabItemLayoutChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabItemSizeChanged

Event that is raised when TabItemSize property is changed.

Declaration
public event PropertyChangedCallback TabItemSizeChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabListContextMenuItemTemplateChanged

Event that is raised when TabListContextMenuItemTemplate property is changed.

Declaration
[Obsolete("This event is deprecated")]
public event PropertyChangedCallback TabListContextMenuItemTemplateChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabOrderChanged

Occurs when rearranging item within a TabControlExt.

Declaration
public event EventHandler<TabOrderChangedEventArgs> TabOrderChanged
Event Type
Type
System.EventHandler<TabOrderChangedEventArgs>

TabOrderChanging

Occurs when rearranging item within a TabControlExt.

Declaration
public event EventHandler<TabOrderChangingEventArgs> TabOrderChanging
Event Type
Type
System.EventHandler<TabOrderChangingEventArgs>
Remarks

This event can be canceled.

TabPanelBackgroundChanged

Event that is raised when TabPanelBackground proeprty is changed.

Declaration
public event PropertyChangedCallback TabPanelBackgroundChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabPanelItemChanged

Event that is raised when TabPanelItem property is changed.

Declaration
public event PropertyChangedCallback TabPanelItemChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabPanelStyleChanged

Event that is raised when TabPanelStyle property is changed.

Declaration
public event PropertyChangedCallback TabPanelStyleChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabPanelTemplateChanged

Event that is raised when TabPanelTemplate property is changed.

Declaration
public event PropertyChangedCallback TabPanelTemplateChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabScrollButtonVisibilityChanged

Event that is raised when TabScrollButtonVisibility property is changed.

Declaration
public event PropertyChangedCallback TabScrollButtonVisibilityChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabScrollStyleChanged

Event that is raised when TabScrollStyle property is changed.

Declaration
public event PropertyChangedCallback TabScrollStyleChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TabStripPlacementChanged

Event that is raised when TabStripPlacement property is changed.

Declaration
public event PropertyChangedCallback TabStripPlacementChanged
Event Type
Type
System.Windows.PropertyChangedCallback

TakeDragItemEvent

Occurs when [take drag item event].

Declaration
public event TakeDragItemHandler TakeDragItemEvent
Event Type
Type
TakeDragItemHandler

Explicit Interface Implementations

IDisposable.Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
void IDisposable.Dispose()

Implements

System.IDisposable