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

RadOutlookBar

Class

Represents a navigation control that mimics the functionality of the Microsoft Outlook navigation bar. The RadOutlookBar provides a user-friendly interface for managing items in a minimized or expanded state. It allows users to navigate between different views and organize their workflow efficiently by using various items that can be arranged in active areas and minimized areas. The control also supports customization of appearance, including styles and templates for minimized items, and integrates events to handle item selection and state changes like minimizing or restoring the bar. Additionally, it handles dynamic content updates, ensuring that the UI remains responsive as items are added or removed.

Definition

Namespace:Telerik.Windows.Controls

Assembly:Telerik.Windows.Controls.Navigation.dll

Syntax:

[TelerikToolboxCategory("Navigation")]
public class RadOutlookBar : RadTabControl

Inheritance: objectRadTabControlBaseRadTabControlRadOutlookBar

Constructors

RadOutlookBar()

Initializes a new instance of the RadOutlookBar class.

public RadOutlookBar()

Fields

ActiveItemsCountProperty

DependencyProperty

Identifies the ActiveItemsCount dependency property.

public static readonly DependencyProperty ActiveItemsCountProperty

ActiveItemsMaxCountProperty

DependencyProperty

Identifies the ActiveItemsMaxCount dependency property.

public static readonly DependencyProperty ActiveItemsMaxCountProperty

HeaderVisibilityProperty

DependencyProperty

Identifies the HeaderVisibility dependency property.

public static readonly DependencyProperty HeaderVisibilityProperty

HorizontalSplitterStyleProperty

DependencyProperty

Identifies the HorizontalSplitterStyle dependency property.

public static readonly DependencyProperty HorizontalSplitterStyleProperty

IsMinimizableProperty

DependencyProperty

Identifies the IsMinimizable dependency property.

public static readonly DependencyProperty IsMinimizableProperty

IsMinimizedProperty

DependencyProperty

Identifies the IsMinimized dependency property.

public static readonly DependencyProperty IsMinimizedProperty

IsVerticalResizerVisibleProperty

DependencyProperty

Identifies the IsVerticalResizerVisible dependency property.

public static readonly DependencyProperty IsVerticalResizerVisibleProperty

ItemMinimizedTemplateProperty

DependencyProperty

Identifies the ItemMinimizedTemplate dependency property.

public static readonly DependencyProperty ItemMinimizedTemplateProperty

ItemMinimizedTemplateSelectorProperty

DependencyProperty

Identifies the ItemMinimizedTemplateSelector dependency property.

public static readonly DependencyProperty ItemMinimizedTemplateSelectorProperty

MinContentHeightProperty

DependencyProperty

Identifies the MinContentHeight dependency property.

public static readonly DependencyProperty MinContentHeightProperty

MinimizeButtonStyleProperty

DependencyProperty

Identifies the MinimizeButtonStyle dependency property.

public static readonly DependencyProperty MinimizeButtonStyleProperty

MinimizedAreaMinHeightProperty

DependencyProperty

Identifies the MinimizedAreaMinHeight dependency property.

public static readonly DependencyProperty MinimizedAreaMinHeightProperty

MinimizedAreaVisibilityProperty

DependencyProperty

Identifies the MinimizedAreaVisibility dependency property.

public static readonly DependencyProperty MinimizedAreaVisibilityProperty

MinimizedButtonContentProperty

DependencyProperty

Identifies the MinimizedButtonContent dependency property.

public static readonly DependencyProperty MinimizedButtonContentProperty

MinimizedButtonContentTemplateProperty

DependencyProperty

Identifies the MinimizedButtonContentTemplate dependency property.

public static readonly DependencyProperty MinimizedButtonContentTemplateProperty

MinimizedEvent

RoutedEvent

This event gets fired every time a RadOutlookBar IsMinimized property is set to true.

public static readonly RoutedEvent MinimizedEvent

MinimizedWidthProperty

DependencyProperty

Identifies the MinimizedWidth dependency property.

public static readonly DependencyProperty MinimizedWidthProperty

MinimizedWidthThresholdProperty

DependencyProperty

Identifies the MinimizedWidthThreshold dependency property.

public static readonly DependencyProperty MinimizedWidthThresholdProperty

RestoredEvent

RoutedEvent

This event gets fired every time a RadOutlookBar IsMinimized property is set to false.

public static readonly RoutedEvent RestoredEvent

SelectedItemHeaderTemplateProperty

DependencyProperty

Identifies the SelectedItemHeaderTemplate dependency property.

[Obsolete("This property is obsolete.", false)]
public static readonly DependencyProperty SelectedItemHeaderTemplateProperty

SelectedItemHeaderTemplateSelectorProperty

DependencyProperty

Identifies the SelectedItemHeaderTemplateSelector dependency property.

[Obsolete("This property is obsolete.", false)]
public static readonly DependencyProperty SelectedItemHeaderTemplateSelectorProperty

TitleTemplateProperty

DependencyProperty

Identifies the TitleTemplate dependency property.

public static readonly DependencyProperty TitleTemplateProperty

TitleTemplateSelectorProperty

DependencyProperty

Identifies the TitleTemplateSelector dependency property.

public static readonly DependencyProperty TitleTemplateSelectorProperty

VerticalResizerAlignmentProperty

DependencyProperty

Identifies the VerticalResizerAlignment dependency property.

public static readonly DependencyProperty VerticalResizerAlignmentProperty

VerticalResizerStyleProperty

DependencyProperty

Identifies the VerticalResizerStyle dependency property.

public static readonly DependencyProperty VerticalResizerStyleProperty

Properties

ActiveItemsCount

int

Gets or sets the desired number of items in the ActiveArea of the RadOutlookBar.

public int ActiveItemsCount { get; set; }

ActiveItemsMaxCount

int

Gets or sets the desired number of items in the ActiveArea of the RadOutlookBar.

public int ActiveItemsMaxCount { get; set; }

Remarks:

By default, ActiveItemsMaxCount is Int32.MaxValue which means that RadOutlookBar will put as many items as possible in the ActiveArea depending on available space.

HeaderVisibility

Visibility

Gets or sets the visibility of the title element.

public Visibility HeaderVisibility { get; set; }

HorizontalSplitterStyle

Style

Gets or sets the style for the horizontal splitter.

public Style HorizontalSplitterStyle { get; set; }

IsMinimizable

bool

Gets or sets the IsMinimizable property.

public bool IsMinimizable { get; set; }

IsMinimized

bool

Gets or sets the IsMinimized property.

public bool IsMinimized { get; set; }

IsVerticalResizerVisible

bool

Gets or sets the IsVerticalSplitterVisible property.

public bool IsVerticalResizerVisible { get; set; }

ItemMinimizedTemplate

DataTemplate

Gets or sets the template for the items when they go in the MinimizedArea.

public DataTemplate ItemMinimizedTemplate { get; set; }

ItemMinimizedTemplateSelector

DataTemplateSelector

Gets or sets the template selector that will choose the template for the items when they go in the MinimizedArea.

public DataTemplateSelector ItemMinimizedTemplateSelector { get; set; }

MinContentHeight

double

Gets or sets the minimum height of the content.

public double MinContentHeight { get; set; }

MinimizeButtonStyle

Style

Gets or sets the MinimizeButtonStyle property.

public Style MinimizeButtonStyle { get; set; }

MinimizedAreaMinHeight

double

Gets or sets the minimal height of the MinimizedArea.

public double MinimizedAreaMinHeight { get; set; }

MinimizedAreaVisibility

Visibility

Gets or sets the visibility of the MinimizedArea.

public Visibility MinimizedAreaVisibility { get; set; }

MinimizedButtonContent

object

Gets or sets the MinimizedButtonContent property.

public object MinimizedButtonContent { get; set; }

MinimizedButtonContentTemplate

DataTemplate

Gets or sets the MinimizedButtonContentTemplate property.

public DataTemplate MinimizedButtonContentTemplate { get; set; }

MinimizedWidth

double

Gets or sets the MinimizedWidth property.

public double MinimizedWidth { get; set; }

MinimizedWidthThreshold

double

Gets or sets the MinimizedWidthThreshold property.

public double MinimizedWidthThreshold { get; set; }

this[int]

RadOutlookBarItem

Indexer, gets the RadOutlookBarItem with the given index in the items collection.

public RadOutlookBarItem this[int index] { get; }

Parameters:indexint

The index of the RadOutlookBarItem in the Items collection of RadOutlookBar.

Property Value:

The RadOutlookBarItem with the given index in the Items collection of the RadOutlookBar.

csharp

RadOutlookBar outlookBar = new RadOutlookBar();
outlookBar.ItemsSource = new string[] { "Item Header 1", "Item Header 2", "Item Header 3" };
outlookBar[1].IsSelected = true;

TitleTemplate

DataTemplate

Gets or sets the template for the title.

public DataTemplate TitleTemplate { get; set; }

TitleTemplateSelector

DataTemplateSelector

Gets or sets the template selector for the title template.

public DataTemplateSelector TitleTemplateSelector { get; set; }

VerticalResizerAlignment

ResizerAlignment

Gets or sets the VerticalResizerAlignment property.

public ResizerAlignment VerticalResizerAlignment { get; set; }

VerticalResizerStyle

Style

Gets or sets the style for the vertical resizer.

public Style VerticalResizerStyle { get; set; }

Methods

ArrangeOverride(Size)

Size

When overridden in a derived class, positions child elements and determines a size for a FrameworkElement derived class.

protected override Size ArrangeOverride(Size finalSize)

Parameters:finalSizeSize

The final area within the parent that this element should use to arrange itself and its children.

Returns:

Size

The actual size used.

ChangeVisualState(bool)

Updates the visual states of the control.

protected void ChangeVisualState(bool useTransitions)

Parameters:useTransitionsbool

Identifies whether the transitions should be used.

GetContainerForItemOverride()

DependencyObject

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

protected override DependencyObject GetContainerForItemOverride()

Returns:

DependencyObject

Overrides: RadTabControlBase.GetContainerForItemOverride()

GetContainerForMinimizedItem()

MinimizedOutlookBarItem

This method returns a new instance of MinimizedOutlookBarItem. If overridden, it must return an instance of a class that derives from MinimizedOutlookBarItem.

protected virtual MinimizedOutlookBarItem GetContainerForMinimizedItem()

Returns:

MinimizedOutlookBarItem

IsItemItsOwnContainerOverride(object)

bool

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

protected override bool IsItemItsOwnContainerOverride(object item)

Parameters:itemobject

The item to check.

Returns:

bool

True if the item is (or is eligible to be) its own container; otherwise, false.

Overrides: RadTabControlBase.IsItemItsOwnContainerOverride(object)

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .

public override void OnApplyTemplate()

Overrides: RadTabControl.OnApplyTemplate()

OnCreateAutomationPeer()

AutomationPeer

Creates a peer associated with this object.

protected override AutomationPeer OnCreateAutomationPeer()

Returns:

AutomationPeer

An instance of the .

Overrides: RadTabControl.OnCreateAutomationPeer()

OnInitialized(EventArgs)

Raises the event. This method is invoked whenever is set to true internally.

protected override void OnInitialized(EventArgs e)

Parameters:eEventArgs

The RoutedEventArgs that contains the event data.

Overrides: RadTabControl.OnInitialized(EventArgs)

OnItemsChanged(NotifyCollectionChangedEventArgs)

Raises the event.

protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)

Parameters:eNotifyCollectionChangedEventArgs

The NotifyCollectionChangedEventArgs instance containing the event data.

Overrides: RadTabControl.OnItemsChanged(NotifyCollectionChangedEventArgs)

OnKeyDown(KeyEventArgs)

Called before the event occurs.

protected override void OnKeyDown(KeyEventArgs e)

Parameters:eKeyEventArgs

The data for the event.

OnSelectionChanged(RadSelectionChangedEventArgs)

Raises the SelectionChanged routed event.

protected override void OnSelectionChanged(RadSelectionChangedEventArgs e)

Parameters:eRadSelectionChangedEventArgs

Overrides: RadTabControl.OnSelectionChanged(RadSelectionChangedEventArgs)

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.

Overrides: RadTabControl.PrepareContainerForItemOverride(DependencyObject, object)

Selector_SelectionChanged(object, SelectionChangedEventArgs)

Handles the SelectionChanged event of the Selector control.

protected override void Selector_SelectionChanged(object sender, SelectionChangedEventArgs e)

Parameters:senderobject

The source of the event.

eSelectionChangedEventArgs

The instance containing the event data.

Overrides: RadTabControlBase.Selector_SelectionChanged(object, SelectionChangedEventArgs)

Events

ItemPositionChanged

PositionChangedEventHandler

Occurs when a RadOutlookBarItem changes its position, for example, from ActiveArea to MinimizedArea.

public event PositionChangedEventHandler ItemPositionChanged

Minimized

RoutedEventHandler

Occurs when the IsMinimized property is set to true.

public event RoutedEventHandler Minimized

Restored

RoutedEventHandler

Occurs when the IsMinimized property is set to false.

public event RoutedEventHandler Restored