Class SfTabItem

Represents a selectable item inside SfTabControl.

Inheritance

System.Object

SfTabItem

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Controls.Navigation

Assembly: Syncfusion.SfTabControl.UWP.dll

Syntax

[ClassReference(IsReviewed = false)]
public class SfTabItem : ContentControl, IDisposable

Remarks

TabItem is a Windows.UI.Xaml.Controls.ContentControl..

Constructors

SfTabItem()

Initializes a new instance of the SfTabItem class.

Declaration

[ClassReference(IsReviewed = false)]
public SfTabItem()

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

Fields

CanCloseProperty

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

Declaration

public static readonly DependencyProperty CanCloseProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

CustomContextMenuItemsProperty

Gets or Sets the ContextMenu

Declaration

[ClassReference(IsReviewed = false)]
public static readonly DependencyProperty CustomContextMenuItemsProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HeaderProperty

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

Declaration

public static readonly DependencyProperty HeaderProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HeaderTemplateProperty

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

Declaration

public static readonly DependencyProperty HeaderTemplateProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

HeaderTemplateSelectorProperty

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

Declaration

public static readonly DependencyProperty HeaderTemplateSelectorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IconPositionProperty

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

Declaration

public static readonly DependencyProperty IconPositionProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IconProperty

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

Declaration

public static readonly DependencyProperty IconProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

IsSelectedProperty

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

Declaration

public static readonly DependencyProperty IsSelectedProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SelectedBackgroundProperty

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

Declaration

public static readonly DependencyProperty SelectedBackgroundProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SelectedForegroundProperty

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

Declaration

[ClassReference(IsReviewed = false)]
public static readonly DependencyProperty SelectedForegroundProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowCloseAllButThisMenuItemProperty

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

Declaration

public static readonly DependencyProperty ShowCloseAllButThisMenuItemProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowCloseAllMenuItemProperty

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

Declaration

public static readonly DependencyProperty ShowCloseAllMenuItemProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowCloseMenuItemProperty

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

Declaration

public static readonly DependencyProperty ShowCloseMenuItemProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ShowPinnableButtonProperty

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

Declaration

public static readonly DependencyProperty ShowPinnableButtonProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

CanClose

Gets or sets a value indicating whether the tab item can be closed or not.

Declaration

public bool CanClose { get; set; }

Property Value

Type
System.Boolean

CustomContextMenuItems

Gets the collection CustomContextMenuItems

Declaration

public ObservableCollection<object> CustomContextMenuItems { get; }

Property Value

Type
System.Collections.ObjectModel.ObservableCollection<System.Object>

Header

Gets or sets the data used as header for SfTabItem.

Declaration

[ClassReference(IsReviewed = false)]
public object Header { get; set; }

Property Value

Type	Description
System.Object	The default is null.

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

HeaderTemplate

Gets or sets the template for the data used as header for SfTabItem.

Declaration

[ClassReference(IsReviewed = false)]
public DataTemplate HeaderTemplate { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.DataTemplate	The default is null.

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

HeaderTemplateSelector

Gets or sets Template Selector for the data used as header for SfTabItem.

Declaration

[ClassReference(IsReviewed = false)]
public DataTemplateSelector HeaderTemplateSelector { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Controls.DataTemplateSelector	The default is null.

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

Icon

Gets or sets the icon in tab item

Declaration

[ClassReference(IsReviewed = false)]
public object Icon { get; set; }

Property Value

Type
System.Object

IconPosition

Gets or sets icon position left or right in tab item

Declaration

[ClassReference(IsReviewed = false)]
public TabIconPosition IconPosition { get; set; }

Property Value

Type
TabIconPosition

IsSelected

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

Declaration

[ClassReference(IsReviewed = false)]
public bool IsSelected { get; set; }

Property Value

Type	Description
System.Boolean	true if this instance is selected; otherwise, false.

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

SelectedBackground

Gets or sets the selected background for SfTabItem.

Declaration

[ClassReference(IsReviewed = false)]
public Brush SelectedBackground { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

SelectedForeground

Gets or sets the selected foreground for SfTabItem.

Declaration

[ClassReference(IsReviewed = false)]
public Brush SelectedForeground { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

See Also

SfTabItem

SfTabControl

Syncfusion.UI.Xaml.Controls

ShowCloseAllButThisMenuItem

Gets or sets a value indicating whether the Close All But this context menu item is showable or not

Declaration

public bool ShowCloseAllButThisMenuItem { get; set; }

Property Value

Type
System.Boolean

ShowCloseAllMenuItem

Gets or sets a value indicating whether the Close All context menu item is showable or not

Declaration

public bool ShowCloseAllMenuItem { get; set; }

Property Value

Type
System.Boolean

ShowCloseMenuItem

Gets or sets a value indicating whether the Close context menu item is showable or not

Declaration

[ClassReference(IsReviewed = false)]
public bool ShowCloseMenuItem { get; set; }

Property Value

Type
System.Boolean

ShowPinnableButton

Gets or sets a value indicating whether the tab item can be pinned or not.

Declaration

public bool ShowPinnableButton { get; set; }

Property Value

Type
System.Boolean

Methods

Dispose()

Disposes the control while unloading.

Declaration

public void Dispose()

Dispose(Boolean)

Disposing unused objects

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing	Argument to dispose the unused object

OnApplyTemplate()

Initializes the SfTabItem control.

Declaration

protected override void OnApplyTemplate()

OnContentChanged(Object, Object)

Defines the Selected content when the content is changed.

Declaration

protected override void OnContentChanged(object oldContent, object newContent)

Parameters

Type	Name	Description
System.Object	oldContent	old content of the tab item
System.Object	newContent	new content of the tab item

OnPointerExited(PointerRoutedEventArgs)

Occurs when the pointer leaves the tab items

Declaration

protected override void OnPointerExited(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	The event arguments

OnPointerMoved(PointerRoutedEventArgs)

Occurs when the pointer is over the tab items

Declaration

protected override void OnPointerMoved(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	The event arguments

OnPointerPressed(PointerRoutedEventArgs)

Invoked when the pointer is pressed

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	The event arguments

OnPointerReleased(PointerRoutedEventArgs)

Invoked when the pointer is released

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e	The event arguments

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)

See Also

SfTabControl

Syncfusion.UI.Xaml.Controls