menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TabSplitter - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TabSplitter

    Represents the TabSplitter class

    Inheritance
    System.Object
    TabSplitter
    Implements
    System.IDisposable
    Namespace: Syncfusion.Windows.Tools.Controls
    Assembly: Syncfusion.Tools.Wpf.dll
    Syntax
    [SkinType(SkinVisualStyle = Skin.Default, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF;component/Controls/TabSplitter/Themes/Generic.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2007Blue, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/Office2007BlueStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2007Silver, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/Office2007SilverStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Default, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF;component/Controls/TabSplitter/Themes/Generic.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2007Black, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/Office2007BlackStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Blend, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/BlendStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.VS2010, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/VS2010Style.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2010Blue, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/Office2010BlueStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2010Black, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/Office2010BlackStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Office2010Silver, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/Office2010SilverStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Metro, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/MetroStyle.xaml")]
    [SkinType(SkinVisualStyle = Skin.Transparent, Type = typeof(TabSplitter), XamlResource = "/Syncfusion.Tools.WPF.Classic;component/Controls/TabSplitter/Themes/TransparentStyle.xaml")]
    public class TabSplitter : Selector, IDisposable

    Constructors

    TabSplitter()

    Initializes a new instance of the TabSplitter class.

    Declaration
    public TabSplitter()

    Fields

    BottomPanelHeightProperty

    Represents BottomPanelHeight dependency property.

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

    BottomSelectedContentProperty

    Represents bottom selected content property.

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

    BottomSelectedContentPropertyKey

    Represents bottom selected content property key.

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

    HideHeaderOnSingleChildProperty

    Represents the HideHeaderOnSingleChild Dependency Property

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

    ImageProperty

    Represents the Image Dependency property

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

    MouseOverBackgroundProperty

    MouseOverBackground DependencyProperty

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

    MouseOverForegroundProperty

    MouseOverForeground DependencyProperty

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

    SelectedBackgroundProperty

    SelectedBackground DependencyProperty

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

    SelectedForegroundProperty

    SelectedForeground DependencyProperty

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

    SplitterDistanceFromTopProperty

    Represents the SplitterDistance from Top

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

    TabSplitterListContextMenuItemTemplateProperty

    Represents the TabSplitter List context menu item template property

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

    TopSelectedContentProperty

    Represents top selected content property.

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

    TopSelectedContentPropertyKey

    Represents top selected content property key.

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

    Properties

    BorderContentPanel

    Gets the tab layout panel.

    Declaration
    protected Border BorderContentPanel { get; }
    Property Value
    Type Description
    System.Windows.Controls.Border

    The tab layout panel.

    BottomPanelHeight

    Gets or sets BottomPanelHeight property. Is used to regulate height of the bottom panel (in the 2 row of the resized grid when resize direction = rows).

    Declaration
    public double BottomPanelHeight { get; set; }
    Property Value
    Type
    System.Double

    BottomSelectedContent

    Gets the value of the BottomSelectedContent dependency property.

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

    HideHeaderOnSingleChild

    Hides the Header On Single Child

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

    MouseOverBackground

    Gets or sets the value of the MouseOverBackground dependency property.

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

    MouseOverForeground

    Gets or sets the mouse over foreground.

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

    The mouse over foreground.

    SelectedBackground

    Gets or sets the selected background.

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

    The selected background.

    SelectedForeground

    Gets or sets the selected foreground.

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

    The selected foreground.

    SplitterDistanceFromTop

    Sets the Splitter distance from Top

    Declaration
    public double SplitterDistanceFromTop { get; set; }
    Property Value
    Type
    System.Double

    TabLayoutPanel

    Gets the tab layout panel.

    Declaration
    protected TabSplitterItemPanel TabLayoutPanel { get; }
    Property Value
    Type Description
    TabSplitterItemPanel

    The tab layout panel.

    TabPanel

    Gets the tab panel.

    Declaration
    protected TabPanelAdv TabPanel { get; }
    Property Value
    Type Description
    TabPanelAdv

    The tab panel.

    TabSplitterListContextMenuItemTemplate

    Gets or sets the tab splitter list context menu item template.

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

    The tab splitter list context menu item template.

    TopSelectedContent

    Gets the value of the TopSelectedContent dependency property.

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

    Methods

    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

    Dispose()

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

    Declaration
    public void Dispose()

    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()

    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.

    GetImage(DependencyObject)

    Gets the image.

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

    The obj DependencyObject.

    Returns
    Type Description
    System.Windows.Media.ImageSource

    Image Source

    IsItemItsOwnContainerOverride(Object)

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

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

    The item to check.

    Returns
    Type Description
    System.Boolean

    true if the item is (or is eligible to be) its own container; otherwise, false.

    MeasureOverride(Size)

    Measures child elements accordingly constraint size.

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

    The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.

    Returns
    Type Description
    System.Windows.Size

    The size that this element determines it needs during layout, based on its calculations of child element sizes.

    OnApplyTemplate()

    When overridden in a derived class, is invoked whenever application code or internal processes call System.Windows.FrameworkElement.ApplyTemplate.

    Declaration
    public override void OnApplyTemplate()

    OnBottomPanelHeightChanged(DependencyPropertyChangedEventArgs)

    Raises BottomPanelHeightChanged event.

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

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

    OnBottomSelectedContentChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises BottomSelectedContentChanged event.

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

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

    OnInitialized(EventArgs)

    Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

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

    The System.Windows.RoutedEventArgs that contains the event data.

    OnItemsChanged(NotifyCollectionChangedEventArgs)

    Updates the current selection when an item in the System.Windows.Controls.Primitives.Selector has changed

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

    The event data.

    OnKeyDown(KeyEventArgs)

    Invoked when the System.Windows.UIElement.KeyDown event is received.

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

    Information about the event.

    OnLeftPanelWidthChanged(DependencyPropertyChangedEventArgs)

    Raises LeftPanelWidthChanged event.

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

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

    OnMouseOverBackgroundChanged(DependencyPropertyChangedEventArgs)

    Raises MouseOverBackgroundChanged event.

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

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

    OnMouseOverForegroundChanged(DependencyPropertyChangedEventArgs)

    Raises the MouseOverForegroundChanged event.

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

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

    OnPropertyChanged(DependencyPropertyChangedEventArgs)

    Invoked whenever the effective value of any dependency property on this System.Windows.FrameworkElement has been updated. The specific dependency property that changed is reported in the arguments parameter. Overrides System.Windows.DependencyObject.OnPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs).

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

    The event data that describes the property that changed, as well as old and new values.

    OnRightPanelWidthChanged(DependencyPropertyChangedEventArgs)

    Raises RightPanelWidthChanged event.

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

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

    OnSelectedBackgroundChanged(DependencyPropertyChangedEventArgs)

    Raises the SelectedBackgroundChanged event.

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

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

    OnSelectedForegroundChanged(DependencyPropertyChangedEventArgs)

    Raises the SelectedForegroundChanged event.

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

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

    OnSelectionChanged(SelectionChangedEventArgs)

    Called when the selection changes.

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

    The event data.

    OnTabSplitterListContextMenuItemTemplateChanged(DependencyPropertyChangedEventArgs)

    Raises the TabSplitterListContextMenuItemTemplateChanged event.

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

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

    OnTopPanelHeightChanged(DependencyPropertyChangedEventArgs)

    Raises TopPanelHeightChanged event.

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

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

    OnTopSelectedContentChanged(DependencyPropertyChangedEventArgs)

    Updates property value cache and raises TopSelectedContentChanged event.

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

    Property change details, such as old value and new 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

    The obj DependencyObject.

    System.Windows.Media.ImageSource value

    The value.

    VerifyZIndex()

    Verifies the index of the Z.

    Declaration
    protected void VerifyZIndex()

    Events

    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

    BottomSelectedContentChanged

    Event that is raised when BottomSelectedContent property is changed.

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

    MouseOverBackgroundChanged

    Event that is raised when MouseOverBackground property is changed.

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

    MouseOverForegroundChanged

    Event that is raised when MouseOverBackground property is changed.

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

    SelectedBackgroundChanged

    Occurs when [selected background changed].

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

    SelectedForegroundChanged

    Occurs when [selected foreground changed].

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

    TabSplitterListContextMenuItemTemplateChanged

    Event that is raised when TabListContextMenuItemTemplate property is changed.

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

    TopSelectedContentChanged

    Event that is raised when TopSelectedContent property is changed.

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

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved