New to Telerik UI for WPF? Start a free 30-day trial

RadRibbonTab

Class

Represents a tab within a RadRibbonView, providing a container for ribbon groups and functionalities related to tab management. The RadRibbonTab control supports visual states for contextual and non-contextual tabs, as well as selection states. It allows for customization of the header visibility, background appearance when minimized, and association with contextual groups. This class also implements theming capabilities and provides hooks for event handling when the tab is selected or unselected. Additionally, it provides a way to manage visibility and layout of contained elements based on the ribbon's state.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.RibbonView.dll

Syntax:

[TelerikToolboxCategory("Navigation")]
[Themable]
public class RadRibbonTab : HeaderedItemsControl, IRadTabItem

Inheritance: objectRadRibbonTab

Implements: IRadTabItem

Constructors

RadRibbonTab()

Initializes a new instance of the RadRibbonTab class.

public RadRibbonTab()

Fields

ContextualGroupNameProperty

DependencyProperty

Identifies the ContextualGroupName property.

public static readonly DependencyProperty ContextualGroupNameProperty

HeaderVisibilityProperty

DependencyProperty

Identifies the HeaderVisibility property.

public static readonly DependencyProperty HeaderVisibilityProperty

IsContextualTabVisibleProperty

DependencyProperty

Identifies the IsContextualTabVisible property.

public static readonly DependencyProperty IsContextualTabVisibleProperty

IsSelectedProperty

DependencyProperty

Identifies the property.

public static readonly DependencyProperty IsSelectedProperty

MinimizedBackgroundProperty

DependencyProperty

Identifies the MinimizedBackground property.

public static readonly DependencyProperty MinimizedBackgroundProperty

Properties

ContextualGroupName

string

Gets or sets the associated Contextual Groups.

public string ContextualGroupName { get; set; }

HeaderVisibility

Visibility

Gets or sets a value indicating whether the header of the tab will be visible.

public Visibility HeaderVisibility { get; set; }

IsContextualTabVisible

bool?

Gets value indicating whether the ContextualTab is visible or not.

public bool? IsContextualTabVisible { get; }

IsSelected

bool

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

public bool IsSelected { get; set; }

Property Value:

True if this instance is selected; otherwise, false.

Implements: IRadTabItem.IsSelected

MinimizedBackground

Brush

Gets or sets a brushed used for the Background of RibbonTab when the Ribbon is minimized.

public Brush MinimizedBackground { get; set; }

SimplifiedItems

ObservableCollection<RadRibbonGroup>

Gets or sets the collection used to display items in RibbonView's Simplified state.

public ObservableCollection<RadRibbonGroup> SimplifiedItems { get; }

SimplifiedResources

ResourceDictionary

Gets or sets the resource dictionary used in RibbonView's Simplified state.

public ResourceDictionary SimplifiedResources { get; }

TabStripPlacement

Dock

Gets the tab strip placement.

public Dock TabStripPlacement { get; }

Implements: IRadTabItem.TabStripPlacement

Methods

ArrangeOverride(Size)

Size

Called when the control is arranged.

protected override Size ArrangeOverride(Size finalSize)

Parameters:finalSizeSizeReturns:

Size

ChangeVisualState(bool)

Updates the visual state of the control.

protected void ChangeVisualState(bool useTransitions)

Parameters:useTransitionsbool

Indicates whether transitions should be used.

GetContainerForItemOverride()

DependencyObject

Creates or identifies the element that is used to display the given item.

protected override sealed DependencyObject GetContainerForItemOverride()

Returns:

DependencyObject

The element that is used to display the given item.

IsItemItsOwnContainerOverride(object)

bool

Determines if the specified item is (or is eligible to be) its own container.

protected override sealed bool IsItemItsOwnContainerOverride(object item)

Parameters:itemobjectReturns:

bool

OnApplyTemplate()

Called when the control template is applied.

public override void OnApplyTemplate()

OnInitialized(EventArgs)

Called when the control has been initialized.

protected override void OnInitialized(EventArgs e)

Parameters:eEventArgs

OnIsSelectedChanged(bool, bool)

Called when the IsSelected property has changed.

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.

OnMouseEnter(MouseEventArgs)

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

protected override void OnMouseEnter(MouseEventArgs e)

Parameters:eMouseEventArgs

The data for the event.

OnMouseLeave(MouseEventArgs)

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

protected override void OnMouseLeave(MouseEventArgs e)

Parameters:eMouseEventArgs

The data for the event.

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters:elementDependencyObject

Element used to display the specified item.

itemobject

Specified item.

ResetTheme()

Resets the theme.

public void ResetTheme()

SetTabOrientation(Orientation)

Sets the tab orientation.

public void SetTabOrientation(Orientation orientation)

Parameters:orientationOrientation

The orientation.

Implements: IRadTabItem.SetTabOrientation(Orientation)

UpdateHeaderPresenterContent()

Updates the content of the header presenter.

public void UpdateHeaderPresenterContent()

Implements: IRadTabItem.UpdateHeaderPresenterContent()

UpdateTabStripPlacement(Dock)

Updates the tab strip placement.

public void UpdateTabStripPlacement(Dock placement)

Parameters:placementDock

The placement.

Implements: IRadTabItem.UpdateTabStripPlacement(Dock)