New to Telerik UI for WPFStart a free 30-day trial

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

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

C#
[TelerikToolboxCategory("Navigation")]
public class RadTabItem : HeaderedContentControl, IRadTabItem

Inheritance: objectRadTabItem

Derived Classes: RadOutlookBarItemRadPaneRadRibbonBackstageItem

Implements: IRadTabItem

Constructors

Initializes a new instance of the RadTabItem class.

C#
public RadTabItem()
Remarks:

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

Fields

BottomTemplateProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty BottomTemplateProperty

Identifies the dependency property.

C#
public static readonly DependencyProperty CloseButtonVisibilityProperty

DropDownContentProperty

DependencyProperty

Identifies the DropDownContent property.

C#
public static readonly DependencyProperty DropDownContentProperty

Identifies the DropDownContentTemplate property.

C#
public static readonly DependencyProperty DropDownContentTemplateProperty

Identifies the DropDownTemplateSelector property.

C#
public static readonly DependencyProperty DropDownContentTemplateSelectorProperty

HeaderForegroundProperty

DependencyProperty

Identifies the HeaderForeground property.

C#
public static readonly DependencyProperty HeaderForegroundProperty

IsBreakProperty

DependencyProperty

Identifies the dependency property.

C#
public static readonly DependencyProperty IsBreakProperty

IsDragDisabledProperty

DependencyProperty

Identifies the IsDragDisabled property.

C#
public static readonly DependencyProperty IsDragDisabledProperty

IsPinnedProperty

DependencyProperty

Identifies the dependency property.

C#
public static readonly DependencyProperty IsPinnedProperty

IsSelectedProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty IsSelectedProperty

LeftTemplateProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty LeftTemplateProperty

PinButtonVisibilityProperty

DependencyProperty

Identifies the dependency property.

C#
public static readonly DependencyProperty PinButtonVisibilityProperty

RightTemplateProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty RightTemplateProperty

TabOrientationProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty TabOrientationProperty

TabStripPlacementProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty TabStripPlacementProperty

TopTemplateProperty

DependencyProperty

Identifies the property.

C#
public static readonly DependencyProperty TopTemplateProperty

Properties

BottomTemplate

ControlTemplate

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

C#
public virtual ControlTemplate BottomTemplate { get; set; }

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

C#
public Visibility CloseButtonVisibility { get; set; }

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

C#
public object DropDownContent { get; set; }

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

C#
public DataTemplate DropDownContentTemplate { get; set; }

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

C#
public DataTemplateSelector DropDownContentTemplateSelector { get; set; }

Gets or sets the item header foreground.

C#
public Brush HeaderForeground { get; set; }

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

C#
public virtual bool IsBreak { get; set; }
Property Value:

true if this instance is break; otherwise, false.

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

C#
public bool IsDragDisabled { get; set; }
Property Value:

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

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

C#
public bool IsPinned { get; set; }

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

C#
public bool IsSelected { get; set; }

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

ControlTemplate

Gets or sets the left template.

C#
public virtual ControlTemplate LeftTemplate { get; set; }
Property Value:

The left template.

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

C#
public Visibility PinButtonVisibility { get; set; }

RightTemplate

ControlTemplate

Gets or sets the right template.

C#
public virtual ControlTemplate RightTemplate { get; set; }
Property Value:

The right template.

TabOrientation

Orientation

Gets the tab orientation.

C#
[Browsable(false)]
public virtual Orientation TabOrientation { get; }

Gets the tab strip placement.

C#
[Browsable(false)]
public virtual Dock TabStripPlacement { get; }

Implements: IRadTabItem.TabStripPlacement

TopTemplate

ControlTemplate

Gets or sets the top template.

C#
public virtual ControlTemplate TopTemplate { get; set; }
Property Value:

The top template.

Methods

Updates the visual state of the control.

C#
protected virtual void ChangeVisualState(bool useTransitions)
Parameters:useTransitionsbool

Indicates whether transitions should be used.

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

C#
protected virtual ControlTemplate FindTemplateFromPosition(Dock position)
Parameters:positionDock

The position for which to return a template.

Returns:

ControlTemplate

A control template to use.

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

C#
protected override Size MeasureOverride(Size availableSize)
Parameters:availableSizeSize

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.

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

C#
public override void OnApplyTemplate()

Called when the property changes.

C#
protected override void OnContentChanged(object oldContent, object newContent)
Parameters:oldContentobject

The old value of the property.

newContentobject

The new value of the property.

Creates a RadTabItemAutomationPeer.

C#
protected override AutomationPeer OnCreateAutomationPeer()
Returns:

AutomationPeer

A new instance of the RadTabItemAutomationPeer.

Called before the event occurs.

C#
protected override void OnGotFocus(RoutedEventArgs e)
Parameters:eRoutedEventArgs

The data for the event.

Called when the property of a changes.

C#
protected override void OnHeaderChanged(object oldHeader, object newHeader)
Parameters:oldHeaderobject

Old value of the property.

newHeaderobject

New value of the property.

C#
protected virtual void OnHeaderMouseEnter(object sender, MouseEventArgs e)
Parameters:senderobjecteMouseEventArgs
C#
protected virtual void OnHeaderMouseLeave(object sender, MouseEventArgs e)
Parameters:senderobjecteMouseEventArgs

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

C#
protected virtual void OnHeaderMouseLeftButtonDown(object sender, MouseButtonEventArgs e)
Parameters:senderobject

The header element sender.

eMouseButtonEventArgs

The MouseEventArgs for the event.

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

C#
protected virtual void OnHeaderMouseLeftButtonUp(object sender, MouseButtonEventArgs e)
Parameters:senderobject

The header element sender.

eMouseButtonEventArgs

The MouseEventArgs for the event.

Called when the control has been initialized.

C#
protected override void OnInitialized(EventArgs e)
Parameters:eEventArgs

Called when the IsSelected property has changed.

C#
protected virtual void OnIsSelectedChanged(bool oldValue, bool newValue)
Parameters:oldValuebool

The old value of the IsSelected property.

newValuebool

The new value of the IsSelected property.

Called before the event occurs.

C#
protected override void OnKeyDown(KeyEventArgs e)
Parameters:eKeyEventArgs

The data for the event.

Called when the RadTabItem is loaded.

C#
protected virtual void OnLoaded(object sender, RoutedEventArgs e)
Parameters:senderobject

The tab item that has loaded.

eRoutedEventArgs

The event arguments.

Called before the event occurs.

C#
protected override void OnLostFocus(RoutedEventArgs e)
Parameters:eRoutedEventArgs

The data for the event.

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

C#
protected override void OnMouseEnter(MouseEventArgs e)
Parameters:eMouseEventArgs

The data for the event.

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

C#
protected override void OnMouseLeave(MouseEventArgs e)
Parameters:eMouseEventArgs

The data for the event.

Called when the item is selected.

C#
public virtual void OnSelected(RadRoutedEventArgs e)
Parameters:eRadRoutedEventArgs

Called when the item is unselected.

C#
public virtual void OnUnselected(RadRoutedEventArgs e)
Parameters:eRadRoutedEventArgs

Sets the navigation mode for RadTabItem.

C#
protected void SetNavigationMode(KeyboardNavigationMode mode)
Parameters:modeKeyboardNavigationMode

The mode.

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

C#
protected void UpdateTemplate()