Class DocumentTabControl

Represents class for document tab control

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

Constructors

DocumentTabControl()

Initializes a new instance of the DocumentTabControl class.

Declaration
public DocumentTabControl()

DocumentTabControl(DocumentContainer)

Initializes a new instance of the DocumentTabControl class.

Declaration
public DocumentTabControl(DocumentContainer container)
Parameters
Type Name Description
DocumentContainer container

The container.

Fields

LastItemClosedEvent

Occurs when [last item closed].

Declaration
public static readonly RoutedEvent LastItemClosedEvent
Field Value
Type Description
System.Windows.RoutedEvent

m_Flag

represent the flag flag

Declaration
public bool m_Flag
Field Value
Type Description
System.Boolean

MoveToNextTabGroupCommand

Represents move to next tab group command.

Declaration
public static readonly RoutedCommand MoveToNextTabGroupCommand
Field Value
Type Description
System.Windows.Input.RoutedCommand

MoveToPreviousTabGroupCommand

Represents move to previous tab group command.

Declaration
public static readonly RoutedCommand MoveToPreviousTabGroupCommand
Field Value
Type Description
System.Windows.Input.RoutedCommand

NewHorizontalTabGroupCommand

Command for new horizontal tab group.

Declaration
public static readonly RoutedCommand NewHorizontalTabGroupCommand
Field Value
Type Description
System.Windows.Input.RoutedCommand

NewVerticalTabGroupCommand

Command for new Vertical tab.

Declaration
public static readonly RoutedCommand NewVerticalTabGroupCommand
Field Value
Type Description
System.Windows.Input.RoutedCommand

Properties

Container

Gets or sets the container.

Declaration
public DocumentContainer Container { get; set; }
Property Value
Type Description
DocumentContainer

The container.

Methods

CanCloseTabItem(TabItemExt)

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

Declaration
protected override 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.
Overrides

CanProcessCloseCurrentTabItemCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected override 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.
Overrides

CanProcessCloseTabItemCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected override 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.
Overrides

CanProcessCloseTabsCommand(Object, CanExecuteRoutedEventArgs)

Represents the method that will handle the CanExecute event.

Declaration
protected override 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.
Overrides

Dispose()

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

Declaration
public void Dispose()

FireOnCloseAllTabs(CloseTabEventArgs)

Calls when all TabItems close

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

Event arguments
Overrides

FireOnCloseButtonClick(CloseTabEventArgs)

Calls when TabItem closes

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

Event arguments
Overrides

FireOnCloseOtherTabs(CloseTabEventArgs)

Calls when other TabItems close

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

Event arguments
Overrides

GetContent(ContentControl)

Gets the content.

Declaration
public static UIElement GetContent(ContentControl item)
Parameters
Type Name Description
System.Windows.Controls.ContentControl item

The item ContentControl.
Returns
Type Description
System.Windows.UIElement

UIElement element

GetContentBool(ContentControl, FrameworkElement)

Compares item content with element

Declaration
public static bool GetContentBool(ContentControl item, FrameworkElement element)
Parameters
Type Name Description
System.Windows.Controls.ContentControl item

tabitem
System.Windows.FrameworkElement element

uielement
Returns
Type Description
System.Boolean

GetOrderedItems()

Gets the ordered items.

Declaration
public IList<Control> GetOrderedItems()
Returns
Type Description
System.Collections.Generic.IList<System.Windows.Controls.Control>

IList Control

GetTabItem(UIElement)

Gets the tab item.

Declaration
public TabItemExt GetTabItem(UIElement element)
Parameters
Type Name Description
System.Windows.UIElement element

The element.
Returns
Type Description
TabItemExt

TabItemExt item

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

OnCreateAutomationPeer()

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

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoke on Items Collection Change

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

NotifyCollectionChangedEventArgs
Overrides

OnKeyDown(KeyEventArgs)

Invoked when a KeyDown attached routed event occurs.

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

Event data

OnMouseDown(MouseButtonEventArgs)

Declaration
protected override void OnMouseDown(MouseButtonEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseButtonEventArgs e

OnMouseLeave(MouseEventArgs)

Invoked when an unhandled MouseLeave attached event is raised on this element.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Input.MouseEventArgs e

The MouseEventArgs that contains the event data.

OnPropertyChanged(DependencyPropertyChangedEventArgs)

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

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.
Overrides

SetActiveItem(FrameworkElement)

Sets the active item.

Declaration
public bool SetActiveItem(FrameworkElement activeItem)
Parameters
Type Name Description
System.Windows.FrameworkElement activeItem

The active item.
Returns
Type Description
System.Boolean

bool item Focus

StateChangeHandler(Object, RoutedEventArgs)

States the change handler.

Declaration
protected void StateChangeHandler(object sender, RoutedEventArgs e)
Parameters
Type Name Description
System.Object sender

The sender.
System.Windows.RoutedEventArgs e

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

SwitchImmediate(Int32)

Switches the immediate.

Declaration
public void SwitchImmediate(int step)
Parameters
Type Name Description
System.Int32 step

The direction.

UpdateAfterPersistLoad(UIElement)

Updates the after persist load.

Declaration
public void UpdateAfterPersistLoad(UIElement activeDocument)
Parameters
Type Name Description
System.Windows.UIElement activeDocument

The active document.

Events

LastItemClosed

Occurs when [last item closed].

Declaration
public event RoutedEventHandler LastItemClosed
Event Type
Type Description
System.Windows.RoutedEventHandler

Implements

System.IDisposable