Class RadOutlookBar

RadOutlookBar is a Silverlight control providing the well-known functionality of Microsoft's® Outlook navigation bar.

Inheritance
System.Object
RadTabControlBase
RadTabControl
RadOutlookBar
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

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

Constructors

RadOutlookBar()

Initializes a new instance of the RadOutlookBar class.

Declaration
public RadOutlookBar()

Fields

ActiveItemsCountProperty

Identifies the ActiveItemsCount dependency property.

Declaration
public static readonly DependencyProperty ActiveItemsCountProperty
Field Value
System.Windows.DependencyProperty

ActiveItemsMaxCountProperty

Identifies the ActiveItemsMaxCount dependency property.

Declaration
public static readonly DependencyProperty ActiveItemsMaxCountProperty
Field Value
System.Windows.DependencyProperty

HeaderVisibilityProperty

Identifies the HeaderVisibility dependency property.

Declaration
public static readonly DependencyProperty HeaderVisibilityProperty
Field Value
System.Windows.DependencyProperty

HorizontalSplitterStyleProperty

Identifies the HorizontalSplitterStyle dependency property.

Declaration
public static readonly DependencyProperty HorizontalSplitterStyleProperty
Field Value
System.Windows.DependencyProperty

IsMinimizableProperty

Identifies the IsMinimizable dependency property.

Declaration
public static readonly DependencyProperty IsMinimizableProperty
Field Value
System.Windows.DependencyProperty

IsMinimizedProperty

Identifies the IsMinimized dependency property.

Declaration
public static readonly DependencyProperty IsMinimizedProperty
Field Value
System.Windows.DependencyProperty

IsVerticalResizerVisibleProperty

Identifies the IsVerticalResizerVisible dependency property.

Declaration
public static readonly DependencyProperty IsVerticalResizerVisibleProperty
Field Value
System.Windows.DependencyProperty

ItemMinimizedTemplateProperty

Identifies the ItemMinimizedTemplate dependency property.

Declaration
public static readonly DependencyProperty ItemMinimizedTemplateProperty
Field Value
System.Windows.DependencyProperty

ItemMinimizedTemplateSelectorProperty

Identifies the ItemMinimizedTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty ItemMinimizedTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

MinContentHeightProperty

Identifies the MinContentHeight dependency property.

Declaration
public static readonly DependencyProperty MinContentHeightProperty
Field Value
System.Windows.DependencyProperty

MinimizeButtonStyleProperty

Identifies the MinimizeButtonStyle dependency property.

Declaration
public static readonly DependencyProperty MinimizeButtonStyleProperty
Field Value
System.Windows.DependencyProperty

MinimizedAreaMinHeightProperty

Identifies the MinimizedAreaMinHeight dependency property.

Declaration
public static readonly DependencyProperty MinimizedAreaMinHeightProperty
Field Value
System.Windows.DependencyProperty

MinimizedAreaVisibilityProperty

Identifies the MinimizedAreaVisibility dependency property.

Declaration
public static readonly DependencyProperty MinimizedAreaVisibilityProperty
Field Value
System.Windows.DependencyProperty

MinimizedButtonContentProperty

Identifies the MinimizedButtonContent dependency property.

Declaration
public static readonly DependencyProperty MinimizedButtonContentProperty
Field Value
System.Windows.DependencyProperty

MinimizedButtonContentTemplateProperty

Identifies the MinimizedButtonContentTemplate dependency property.

Declaration
public static readonly DependencyProperty MinimizedButtonContentTemplateProperty
Field Value
System.Windows.DependencyProperty

MinimizedEvent

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

Declaration
public static readonly RoutedEvent MinimizedEvent
Field Value
System.Windows.RoutedEvent

MinimizedWidthProperty

Identifies the MinimizedWidth dependency property.

Declaration
public static readonly DependencyProperty MinimizedWidthProperty
Field Value
System.Windows.DependencyProperty

MinimizedWidthThresholdProperty

Identifies the MinimizedWidthThreshold dependency property.

Declaration
public static readonly DependencyProperty MinimizedWidthThresholdProperty
Field Value
System.Windows.DependencyProperty

RestoredEvent

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

Declaration
public static readonly RoutedEvent RestoredEvent
Field Value
System.Windows.RoutedEvent

SelectedItemHeaderTemplateProperty

Identifies the SelectedItemHeaderTemplate dependency property.

Declaration
[Obsolete("This property is obsolete.", false)]
public static readonly DependencyProperty SelectedItemHeaderTemplateProperty
Field Value
System.Windows.DependencyProperty

SelectedItemHeaderTemplateSelectorProperty

Identifies the SelectedItemHeaderTemplateSelector dependency property.

Declaration
[Obsolete("This property is obsolete.", false)]
public static readonly DependencyProperty SelectedItemHeaderTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

TitleTemplateProperty

Identifies the TitleTemplate dependency property.

Declaration
public static readonly DependencyProperty TitleTemplateProperty
Field Value
System.Windows.DependencyProperty

TitleTemplateSelectorProperty

Identifies the TitleTemplateSelector dependency property.

Declaration
public static readonly DependencyProperty TitleTemplateSelectorProperty
Field Value
System.Windows.DependencyProperty

VerticalResizerAlignmentProperty

Identifies the VerticalResizerAlignment dependency property.

Declaration
public static readonly DependencyProperty VerticalResizerAlignmentProperty
Field Value
System.Windows.DependencyProperty

VerticalResizerStyleProperty

Identifies the VerticalResizerStyle dependency property.

Declaration
public static readonly DependencyProperty VerticalResizerStyleProperty
Field Value
System.Windows.DependencyProperty

Properties

ActiveItemsCount

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

Declaration
public int ActiveItemsCount { get; set; }
Property Value
System.Int32

ActiveItemsMaxCount

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

Declaration
public int ActiveItemsMaxCount { get; set; }
Property Value
System.Int32

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.

Align

This property does not apply to OutlookBar.

Declaration
public TabStripAlign Align { get; set; }
Property Value
TabStripAlign

AllTabsEqualHeight

This property does not apply to OutlookBar.

Declaration
public bool AllTabsEqualHeight { get; set; }
Property Value
System.Boolean

BackgroundVisibility

This property does not apply to OutlookBar.

Declaration
public override Visibility BackgroundVisibility { get; set; }
Property Value
System.Windows.Visibility

Overrides

BottomTemplate

This property does not apply to OutlookBar.

Declaration
public ControlTemplate BottomTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate

HeaderVisibility

Gets or sets the visibility of the title element.

Declaration
public Visibility HeaderVisibility { get; set; }
Property Value
System.Windows.Visibility

HorizontalSplitterStyle

Gets or sets the style for the horizontal splitter.

Declaration
public Style HorizontalSplitterStyle { get; set; }
Property Value
System.Windows.Style

IsMinimizable

Gets or sets the IsMinimizable property.

Declaration
public bool IsMinimizable { get; set; }
Property Value
System.Boolean

IsMinimized

Gets or sets the IsMinimized property.

Declaration
public bool IsMinimized { get; set; }
Property Value
System.Boolean

IsVerticalResizerVisible

Gets or sets the IsVerticalSplitterVisible property.

Declaration
public bool IsVerticalResizerVisible { get; set; }
Property Value
System.Boolean

Item[Int32]

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

Declaration
public RadOutlookBarItem this[int index] { get; }
Parameters
System.Int32 index

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

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

You can use the indexer to quickly get the RadOutlookBarItem with the given index. The indexer is a shortcut for the ContainerFromIndex method.

Note that you cannot use the indexer to change (replace) an item if you would like to do this use the System.Windows.Controls.ItemsControl.Items property. If an invalid index is passed null is returned.

The following example demonstrates how you can use the indexer to quickly access a given item. 

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

ItemMinimizedTemplate

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

Declaration
public DataTemplate ItemMinimizedTemplate { get; set; }
Property Value
System.Windows.DataTemplate

ItemMinimizedTemplateSelector

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

Declaration
public DataTemplateSelector ItemMinimizedTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

LeftTemplate

This property does not apply to OutlookBar.

Declaration
public ControlTemplate LeftTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate

MinContentHeight

Gets or sets the minimum height of the content.

Declaration
public double MinContentHeight { get; set; }
Property Value
System.Double

MinimizeButtonStyle

Gets or sets the MinimizeButtonStyle property.

Declaration
public Style MinimizeButtonStyle { get; set; }
Property Value
System.Windows.Style

MinimizedAreaMinHeight

Gets or sets the minimal height of the MinimizedArea.

Declaration
public double MinimizedAreaMinHeight { get; set; }
Property Value
System.Double

MinimizedAreaVisibility

Gets or sets the visibility of the MinimizedArea.

Declaration
public Visibility MinimizedAreaVisibility { get; set; }
Property Value
System.Windows.Visibility

MinimizedButtonContent

Gets or sets the MinimizedButtonContent property.

Declaration
public object MinimizedButtonContent { get; set; }
Property Value
System.Object

MinimizedButtonContentTemplate

Gets or sets the MinimizedButtonContentTemplate property.

Declaration
public DataTemplate MinimizedButtonContentTemplate { get; set; }
Property Value
System.Windows.DataTemplate

MinimizedWidth

Gets or sets the MinimizedWidth property.

Declaration
public double MinimizedWidth { get; set; }
Property Value
System.Double

MinimizedWidthThreshold

Gets or sets the MinimizedWidthThreshold property.

Declaration
public double MinimizedWidthThreshold { get; set; }
Property Value
System.Double

ReorderTabRows

This property does not apply to OutlookBar.

Declaration
public override bool ReorderTabRows { get; set; }
Property Value
System.Boolean

Overrides

RightTemplate

This property does not apply to OutlookBar.

Declaration
public ControlTemplate RightTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate

ScrollMode

This property does not apply to OutlookBar.

Declaration
public TabControlScrollMode ScrollMode { get; set; }
Property Value
TabControlScrollMode

TabOrientation

This property does not apply to OutlookBar.

Declaration
public Orientation TabOrientation { get; set; }
Property Value
System.Windows.Controls.Orientation

TabStripPlacement

This property does not apply to OutlookBar.

Declaration
public Dock TabStripPlacement { get; set; }
Property Value
System.Windows.Controls.Dock

TitleTemplate

Gets or sets the template for the title.

Declaration
public DataTemplate TitleTemplate { get; set; }
Property Value
System.Windows.DataTemplate

TitleTemplateSelector

Gets or sets the template selector for the title template.

Declaration
public DataTemplateSelector TitleTemplateSelector { get; set; }
Property Value
System.Windows.Controls.DataTemplateSelector

TopTemplate

This property does not apply to OutlookBar.

Declaration
public ControlTemplate TopTemplate { get; set; }
Property Value
System.Windows.Controls.ControlTemplate

VerticalResizerAlignment

Gets or sets the VerticalResizerAlignment property.

Declaration
public ResizerAlignment VerticalResizerAlignment { get; set; }
Property Value
ResizerAlignment

VerticalResizerStyle

Gets or sets the style for the vertical resizer.

Declaration
public Style VerticalResizerStyle { get; set; }
Property Value
System.Windows.Style

Methods

ArrangeOverride(Size)

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

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
System.Windows.Size finalSize

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

The actual size used.

ChangeVisualState(Boolean)

Updates the visual states of the control.

Declaration
protected void ChangeVisualState(bool useTransitions)
Parameters
System.Boolean useTransitions

Identifies whether the transitions should be used.

GetContainerForItemOverride()

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

Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject

Overrides

GetContainerForMinimizedItem()

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

Declaration
protected virtual MinimizedOutlookBarItem GetContainerForMinimizedItem()
Returns
MinimizedOutlookBarItem

IsItemItsOwnContainerOverride(Object)

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

Declaration
protected override bool IsItemItsOwnContainerOverride(object item)
Parameters
System.Object item

The item to check.
Returns
System.Boolean

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

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
public override void OnApplyTemplate()
Overrides

OnCreateAutomationPeer()

Creates a Telerik.Windows.Controls.RadOutlookBarAutomationPeer peer associated with this object.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

An instance of the Telerik.Windows.Controls.RadOutlookBarAutomationPeer.
Overrides

OnInitialized(EventArgs)

Raises the System.Windows.FrameworkElement.Initialized event. This method is invoked whenever System.Windows.FrameworkElement.IsInitialized is set to true internally.

Declaration
protected override void OnInitialized(EventArgs e)
Parameters
System.EventArgs e

The System.Windows.RoutedEventArgs that contains the event data.
Overrides

OnItemsChanged(NotifyCollectionChangedEventArgs)

Raises the ItemsChanged event.

Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)
Parameters
System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data.
Overrides

OnKeyDown(KeyEventArgs)

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

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

The data for the event.

OnSelectionChanged(RadSelectionChangedEventArgs)

Raises the SelectionChanged routed event.

Declaration
protected override void OnSelectionChanged(RadSelectionChangedEventArgs e)
Parameters
RadSelectionChangedEventArgs e

Overrides

PrepareContainerForItemOverride(DependencyObject, Object)

Prepares the specified element to display the specified item.

Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject element

Element used to display the specified item.
System.Object item

Specified item.
Overrides

Selector_SelectionChanged(Object, SelectionChangedEventArgs)

Handles the SelectionChanged event of the Selector control.

Declaration
protected override void Selector_SelectionChanged(object sender, SelectionChangedEventArgs e)
Parameters
System.Object sender

The source of the event.
System.Windows.Controls.SelectionChangedEventArgs e

The instance containing the event data.
Overrides

Events

ItemPositionChanged

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

Declaration
public event PositionChangedEventHandler ItemPositionChanged
Event Type
PositionChangedEventHandler

Minimized

Occurs when the IsMinimized property is set to true.

Declaration
public event RoutedEventHandler Minimized
Event Type
System.Windows.RoutedEventHandler

Restored

Occurs when the IsMinimized property is set to false.

Declaration
public event RoutedEventHandler Restored
Event Type
System.Windows.RoutedEventHandler

Extension Methods