Class
RadTabItem

Represents a tab item, the default item of the RadTabControl.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

cs-api-definition
[TelerikToolboxCategory("Navigation")]
public class RadTabItem : HeaderedContentControl, IRadTabItem

Inheritance: objectRadTabItem

Derived Classes: RadOutlookBarItemRadPaneRadRibbonBackstageItem

Implements: IRadTabItem

Constructors

RadTabItem()

Initializes a new instance of the RadTabItem class.

Declaration

cs-api-definition
public RadTabItem()

Remarks

The RadTabItem is a . Please see RadTabItem for more information.

Fields

BottomTemplateProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty BottomTemplateProperty

Field Value

DependencyProperty

CloseButtonVisibilityProperty

Identifies the dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CloseButtonVisibilityProperty

Field Value

DependencyProperty

DropDownContentProperty

Identifies the DropDownContent property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownContentProperty

Field Value

DependencyProperty

DropDownContentTemplateProperty

Identifies the DropDownContentTemplate property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownContentTemplateProperty

Field Value

DependencyProperty

DropDownContentTemplateSelectorProperty

Identifies the DropDownTemplateSelector property.

Declaration

cs-api-definition
public static readonly DependencyProperty DropDownContentTemplateSelectorProperty

Field Value

DependencyProperty

HeaderForegroundProperty

Identifies the HeaderForeground property.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderForegroundProperty

Field Value

DependencyProperty

IsBreakProperty

Identifies the dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsBreakProperty

Field Value

DependencyProperty

IsDragDisabledProperty

Identifies the IsDragDisabled property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsDragDisabledProperty

Field Value

DependencyProperty

IsPinnedProperty

Identifies the dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsPinnedProperty

Field Value

DependencyProperty

IsSelectedProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsSelectedProperty

Field Value

DependencyProperty

LeftTemplateProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty LeftTemplateProperty

Field Value

DependencyProperty

PinButtonVisibilityProperty

Identifies the dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty PinButtonVisibilityProperty

Field Value

DependencyProperty

RightTemplateProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty RightTemplateProperty

Field Value

DependencyProperty

TabOrientationProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty TabOrientationProperty

Field Value

DependencyProperty

TabStripPlacementProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty TabStripPlacementProperty

Field Value

DependencyProperty

TopTemplateProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty TopTemplateProperty

Field Value

DependencyProperty

Properties

BottomTemplate

Gets or sets the template of the TabItem when the TabStripPlacement is set to Bottom. This is a dependency property.

Declaration

cs-api-definition
public virtual ControlTemplate BottomTemplate { get; set; }

Property Value

ControlTemplate

CloseButtonVisibility

Gets or sets a value indicating the visibility of the close button.

Declaration

cs-api-definition
public Visibility CloseButtonVisibility { get; set; }

Property Value

Visibility

DropDownContent

Gets or sets the content that will appear in the DropDown menu when it is shown. This is a dependency property.

Declaration

cs-api-definition
public object DropDownContent { get; set; }

Property Value

object

DropDownContentTemplate

Gets or sets the template for the MenuItem that will present this item in the DropDown menu. This is a dependency property.

Declaration

cs-api-definition
public DataTemplate DropDownContentTemplate { get; set; }

Property Value

DataTemplate

DropDownContentTemplateSelector

Gets or sets the template selector for the MenuItem that will present this item in the DropDown menu. This is a dependency property.

Declaration

cs-api-definition
public DataTemplateSelector DropDownContentTemplateSelector { get; set; }

Property Value

DataTemplateSelector

HeaderForeground

Gets or sets the item header foreground.

Declaration

cs-api-definition
public Brush HeaderForeground { get; set; }

Property Value

Brush

IsBreak

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

Declaration

cs-api-definition
public virtual bool IsBreak { get; set; }

Property Value

bool

true if this instance is break; otherwise, false.

IsDragDisabled

Gets or sets a value indicating whether this instance can be dragged.

Declaration

cs-api-definition
public bool IsDragDisabled { get; set; }

Property Value

bool

true if this instance can be dragged; otherwise, false.

IsPinned

Gets or sets a value indicating whether this tab item instance is pinned.

Declaration

cs-api-definition
public bool IsPinned { get; set; }

Property Value

bool

IsSelected

Gets or sets whether the TabItem is selected. This is a dependency property.

Declaration

cs-api-definition
public bool IsSelected { get; set; }

Property Value

bool

Implements IRadTabItem.IsSelected

Remarks

When another item is selected, IsSelected will change to false.

Multiple TabItems with their property set to true can be added to the TabControl, only the last one to be added will be selected.

LeftTemplate

Gets or sets the left template.

Declaration

cs-api-definition
public virtual ControlTemplate LeftTemplate { get; set; }

Property Value

ControlTemplate

The left template.

PinButtonVisibility

Gets or sets a value indicating the visibility of the pin button.

Declaration

cs-api-definition
public Visibility PinButtonVisibility { get; set; }

Property Value

Visibility

RightTemplate

Gets or sets the right template.

Declaration

cs-api-definition
public virtual ControlTemplate RightTemplate { get; set; }

Property Value

ControlTemplate

The right template.

TabOrientation

Gets the tab orientation.

Declaration

cs-api-definition
[Browsable(false)]
public virtual Orientation TabOrientation { get; }

Property Value

Orientation

TabStripPlacement

Gets the tab strip placement.

Declaration

cs-api-definition
[Browsable(false)]
public virtual Dock TabStripPlacement { get; }

Property Value

Dock

Implements IRadTabItem.TabStripPlacement

TopTemplate

Gets or sets the top template.

Declaration

cs-api-definition
public virtual ControlTemplate TopTemplate { get; set; }

Property Value

ControlTemplate

The top template.

Methods

ChangeVisualState(bool)

Updates the visual state of the control.

Declaration

cs-api-definition
protected virtual void ChangeVisualState(bool useTransitions)

Parameters

useTransitions

bool

Indicates whether transitions should be used.

FindTemplateFromPosition(Dock)

Returns the template that will be used, based on the position of the TabStrip.

Declaration

cs-api-definition
protected virtual ControlTemplate FindTemplateFromPosition(Dock position)

Parameters

position

Dock

The position for which to return a template.

Returns

ControlTemplate

A control template to use.

MeasureOverride(Size)

When implemented in a derived class, provides the behavior for the "Measure" layout pass.

Declaration

cs-api-definition
protected override Size MeasureOverride(Size availableSize)

Parameters

availableSize

Size

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

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 (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate().

Declaration

cs-api-definition
public override void OnApplyTemplate()

OnContentChanged(object, object)

Called when the property changes.

Declaration

cs-api-definition
protected override void OnContentChanged(object oldContent, object newContent)

Parameters

oldContent

object

The old value of the property.

newContent

object

The new value of the property.

OnCreateAutomationPeer()

Creates a RadTabItemAutomationPeer.

Declaration

cs-api-definition
protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer

A new instance of the RadTabItemAutomationPeer.

OnGotFocus(RoutedEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnGotFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

The data for the event.

OnHeaderChanged(object, object)

Called when the property of a changes.

Declaration

cs-api-definition
protected override void OnHeaderChanged(object oldHeader, object newHeader)

Parameters

oldHeader

object

Old value of the property.

newHeader

object

New value of the property.

OnHeaderMouseEnter(object, MouseEventArgs)

Declaration

cs-api-definition
protected virtual void OnHeaderMouseEnter(object sender, MouseEventArgs e)

Parameters

sender

object

e

MouseEventArgs

OnHeaderMouseLeave(object, MouseEventArgs)

Declaration

cs-api-definition
protected virtual void OnHeaderMouseLeave(object sender, MouseEventArgs e)

Parameters

sender

object

e

MouseEventArgs

OnHeaderMouseLeftButtonDown(object, MouseButtonEventArgs)

Called when the mouse is pressed over the header of the TabItem.

Declaration

cs-api-definition
protected virtual void OnHeaderMouseLeftButtonDown(object sender, MouseButtonEventArgs e)

Parameters

sender

object

The header element sender.

e

MouseButtonEventArgs

The MouseEventArgs for the event.

OnHeaderMouseLeftButtonUp(object, MouseButtonEventArgs)

Called when the left mouse button is release over the header of the TabItem.

Declaration

cs-api-definition
protected virtual void OnHeaderMouseLeftButtonUp(object sender, MouseButtonEventArgs e)

Parameters

sender

object

The header element sender.

e

MouseButtonEventArgs

The MouseEventArgs for the event.

OnInitialized(EventArgs)

Called when the control has been initialized.

Declaration

cs-api-definition
protected override void OnInitialized(EventArgs e)

Parameters

e

EventArgs

OnIsSelectedChanged(bool, bool)

Called when the IsSelected property has changed.

Declaration

cs-api-definition
protected virtual void OnIsSelectedChanged(bool oldValue, bool newValue)

Parameters

oldValue

bool

The old value of the IsSelected property.

newValue

bool

The new value of the IsSelected property.

OnKeyDown(KeyEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnKeyDown(KeyEventArgs e)

Parameters

e

KeyEventArgs

The data for the event.

OnLoaded(object, RoutedEventArgs)

Called when the RadTabItem is loaded.

Declaration

cs-api-definition
protected virtual void OnLoaded(object sender, RoutedEventArgs e)

Parameters

sender

object

The tab item that has loaded.

e

RoutedEventArgs

The event arguments.

OnLostFocus(RoutedEventArgs)

Called before the event occurs.

Declaration

cs-api-definition
protected override void OnLostFocus(RoutedEventArgs e)

Parameters

e

RoutedEventArgs

The data for the event.

OnMouseEnter(MouseEventArgs)

Called before the System.Windows.UIElement.MouseEnter event occurs.

Declaration

cs-api-definition
protected override void OnMouseEnter(MouseEventArgs e)

Parameters

e

MouseEventArgs

The data for the event.

OnMouseLeave(MouseEventArgs)

Called before the System.Windows.UIElement.MouseLeave event occurs.

Declaration

cs-api-definition
protected override void OnMouseLeave(MouseEventArgs e)

Parameters

e

MouseEventArgs

The data for the event.

OnSelected(RadRoutedEventArgs)

Called when the item is selected.

Declaration

cs-api-definition
public virtual void OnSelected(RadRoutedEventArgs e)

Parameters

e

RadRoutedEventArgs

OnUnselected(RadRoutedEventArgs)

Called when the item is unselected.

Declaration

cs-api-definition
public virtual void OnUnselected(RadRoutedEventArgs e)

Parameters

e

RadRoutedEventArgs

SetNavigationMode(KeyboardNavigationMode)

Sets the navigation mode for RadTabItem.

Declaration

cs-api-definition
protected void SetNavigationMode(KeyboardNavigationMode mode)

Parameters

mode

KeyboardNavigationMode

The mode.

UpdateTemplate()

Updates the template of the RadTabItem based on the current TabStripPlacement.

Declaration

cs-api-definition
protected void UpdateTemplate()