Class DocumentTabControl

Represents a control that contains multiple items that share the same space for content on the screen.

Inheritance
System.Object
Selector
DocumentTabControl
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.UI.Xaml.Controls.Layout
Assembly: Syncfusion.SfDockingManager.UWP.dll
Syntax
[ClassReference(IsReviewed = false)]
public class DocumentTabControl : Selector, IDisposable
Remarks

TabControl is a Selector which means it can contain a collection of objects of any type (such as string, image, or panel) and it is selectable.

Constructors

DocumentTabControl()

Initializes a new instance of the Syncfusion.UI.Xaml.Controls.Navigation.DocumentTabControl class.

Declaration
[ClassReference(IsReviewed = false)]
public DocumentTabControl()
See Also
Syncfusion.UI.Xaml.Controls.Navigation.DocumentTabControl

Fields

CloseButtonTypeProperty

Represents the CloseButtonTypeProperty

Declaration
public static readonly DependencyProperty CloseButtonTypeProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

SelectedContentProperty

Using a DependencyProperty as the backing store for SelectedContent. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty SelectedContentProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowContextMenuProperty

Using a DependencyProperty as the backing store for MyProperty. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty ShowContextMenuProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

ShowTabstripMenuProperty

Using a DependencyProperty as the backing store for ShowTabStripMenu. This enables animation, styling, binding, etc...

Declaration
public static readonly DependencyProperty ShowTabstripMenuProperty
Field Value
Type
Windows.UI.Xaml.DependencyProperty

Properties

CloseButtonType

Gets or sets a value indicating whether the value of the CloseButtonType dependency property.

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

ShowContextMenu

Gets or sets a value indicating whether the ContextMenu

Declaration
[ClassReference(IsReviewed = false)]
public bool ShowContextMenu { get; set; }
Property Value
Type
System.Boolean

ShowTabstripMenu

Gets or sets a value indicating whether a value to display the TabStripMenu with Tab Item headers for switching tab items on selection.

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

true if this instance is selected; otherwise, false.

Methods

add_DocumentTabClosed(DocumentTabControl.DocumentClosedEventHandler)

Declaration
public void add_DocumentTabClosed(DocumentTabControl.DocumentClosedEventHandler value)
Parameters
Type Name Description
DocumentTabControl.DocumentClosedEventHandler value

Dispose()

Disposes the control while unloading.

Declaration
public void Dispose()

Dispose(Boolean)

Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

GetContainerForItemOverride()

Checks if the item is a Syncfusion.UI.Xaml.Controls.Navigation.DocumentTabItem

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

Dependency Object

IsItemItsOwnContainerOverride(Object)

Checks if the item is a Syncfusion.UI.Xaml.Controls.Navigation.DocumentTabItem

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

true if this instance is selected; otherwise, false

OnApplyTemplate()

Initializes all the child elements of the Syncfusion.UI.Xaml.Controls.Navigation.DocumentTabControl DocumentTabControl control.

Declaration
protected override void OnApplyTemplate()
Overrides

OnItemsChanged(Object)

Called whenever item is added or removed

Declaration
protected override void OnItemsChanged(object e)
Parameters
Type Name Description
System.Object e

OnPointerPressed(PointerRoutedEventArgs)

Invoked when the pointer is pressed on the control

Declaration
protected override void OnPointerPressed(PointerRoutedEventArgs e)
Parameters
Type Name Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs e

OnSelectionChanged(DependencyPropertyChangedEventArgs)

Occurs when the selected Tab item Syncfusion.UI.Xaml.Controls.Navigation.DocumentTabItem is changed.

Declaration
protected override void OnSelectionChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
Windows.UI.Xaml.DependencyPropertyChangedEventArgs args
Overrides

OnTabStripPlacementChanged(DependencyPropertyChangedEventArgs)

Invoked when the TabStripPlacement TabStripPlacement is changed.

Declaration
protected virtual void OnTabStripPlacementChanged(DependencyPropertyChangedEventArgs args)
Parameters
Type Name Description
Windows.UI.Xaml.DependencyPropertyChangedEventArgs args

PrepareContainerForItemOverride(DependencyObject, Object)

Arrange the container for override items

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

remove_DocumentTabClosed(DocumentTabControl.DocumentClosedEventHandler)

Declaration
public void remove_DocumentTabClosed(DocumentTabControl.DocumentClosedEventHandler value)
Parameters
Type Name Description
DocumentTabControl.DocumentClosedEventHandler value

Events

DocumentTabClosed

This event will be raised after the tab item is closed in TabControl.

Declaration
public event DocumentTabControl.DocumentClosedEventHandler DocumentTabClosed
Event Type
Type
DocumentTabControl.DocumentClosedEventHandler

Implements

System.IDisposable

Extension Methods

See Also