Back to all docs
API Reference / Telerik.Windows.Controls / RadRibbonTab

Class
RadRibbonTab

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:
cs-api-definition
[TelerikToolboxCategory("Navigation")]
[Themable]
public class RadRibbonTab : HeaderedItemsControl, IRadTabItem

Inheritance: objectRadRibbonTab

Implements: IRadTabItem

Constructors

RadRibbonTab()

Initializes a new instance of the RadRibbonTab class.

Declaration

cs-api-definition
public RadRibbonTab()

Fields

ContextualGroupNameProperty

Identifies the ContextualGroupName property.

Declaration

cs-api-definition
public static readonly DependencyProperty ContextualGroupNameProperty

Field Value

DependencyProperty

HeaderVisibilityProperty

Identifies the HeaderVisibility property.

Declaration

cs-api-definition
public static readonly DependencyProperty HeaderVisibilityProperty

Field Value

DependencyProperty

IsContextualTabVisibleProperty

Identifies the IsContextualTabVisible property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsContextualTabVisibleProperty

Field Value

DependencyProperty

IsSelectedProperty

Identifies the property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsSelectedProperty

Field Value

DependencyProperty

MinimizedBackgroundProperty

Identifies the MinimizedBackground property.

Declaration

cs-api-definition
public static readonly DependencyProperty MinimizedBackgroundProperty

Field Value

DependencyProperty

Properties

ContextualGroupName

Gets or sets the associated Contextual Groups.

Declaration

cs-api-definition
public string ContextualGroupName { get; set; }

Property Value

string

HeaderVisibility

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

Declaration

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

Property Value

Visibility

IsContextualTabVisible

Gets value indicating whether the ContextualTab is visible or not.

Declaration

cs-api-definition
public bool? IsContextualTabVisible { get; }

Property Value

bool?

IsSelected

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

Declaration

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

Property Value

bool

True if this instance is selected; otherwise, false.

Implements IRadTabItem.IsSelected

MinimizedBackground

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

Declaration

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

Property Value

Brush

SimplifiedItems

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

Declaration

cs-api-definition
public ObservableCollection<RadRibbonGroup> SimplifiedItems { get; }

Property Value

ObservableCollection<RadRibbonGroup>

SimplifiedResources

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

Declaration

cs-api-definition
public ResourceDictionary SimplifiedResources { get; }

Property Value

ResourceDictionary

TabStripPlacement

Gets the tab strip placement.

Declaration

cs-api-definition
public Dock TabStripPlacement { get; }

Property Value

Dock

Implements IRadTabItem.TabStripPlacement

Methods

ArrangeOverride(Size)

Called when the control is arranged.

Declaration

cs-api-definition
protected override Size ArrangeOverride(Size finalSize)

Parameters

finalSize

Size

Returns

Size

ChangeVisualState(bool)

Updates the visual state of the control.

Declaration

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

Parameters

useTransitions

bool

Indicates whether transitions should be used.

GetContainerForItemOverride()

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

Declaration

cs-api-definition
protected override sealed DependencyObject GetContainerForItemOverride()

Returns

DependencyObject

The element that is used to display the given item.

IsItemItsOwnContainerOverride(object)

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

Declaration

cs-api-definition
protected override sealed bool IsItemItsOwnContainerOverride(object item)

Parameters

item

object

Returns

bool

OnApplyTemplate()

Called when the control template is applied.

Declaration

cs-api-definition
public override void OnApplyTemplate()

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.

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.

PrepareContainerForItemOverride(DependencyObject, object)

Prepares the specified element to display the specified item.

Declaration

cs-api-definition
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)

Parameters

element

DependencyObject

Element used to display the specified item.

item

object

Specified item.

ResetTheme()

Resets the theme.

Declaration

cs-api-definition
public void ResetTheme()

SetTabOrientation(Orientation)

Sets the tab orientation.

Declaration

cs-api-definition
public void SetTabOrientation(Orientation orientation)

Parameters

orientation

Orientation

The orientation.

Implements IRadTabItem.SetTabOrientation(Orientation)

UpdateHeaderPresenterContent()

Updates the content of the header presenter.

Declaration

cs-api-definition
public void UpdateHeaderPresenterContent()

Implements IRadTabItem.UpdateHeaderPresenterContent()

UpdateTabStripPlacement(Dock)

Updates the tab strip placement.

Declaration

cs-api-definition
public void UpdateTabStripPlacement(Dock placement)

Parameters

placement

Dock

The placement.

Implements IRadTabItem.UpdateTabStripPlacement(Dock)

In this article
DefinitionConstructorsRadRibbonTab()FieldsContextualGroupNamePropertyHeaderVisibilityPropertyIsContextualTabVisiblePropertyIsSelectedPropertyMinimizedBackgroundPropertyPropertiesContextualGroupNameHeaderVisibilityIsContextualTabVisibleIsSelectedMinimizedBackgroundSimplifiedItemsSimplifiedResourcesTabStripPlacementMethodsArrangeOverride(Size)ChangeVisualState(bool)GetContainerForItemOverride()IsItemItsOwnContainerOverride(object)OnApplyTemplate()OnInitialized(EventArgs)OnIsSelectedChanged(bool, bool)OnMouseEnter(MouseEventArgs)OnMouseLeave(MouseEventArgs)PrepareContainerForItemOverride(DependencyObject, object)ResetTheme()SetTabOrientation(Orientation)UpdateHeaderPresenterContent()UpdateTabStripPlacement(Dock)
Not finding the help you need?
Contact Support