ClassRadOutlookBar
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 : RadTabControlInheritance: objectRadTabControlBaseRadTabControlRadOutlookBar
Inherited Members
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 ActiveItemsCountPropertyField Value
DependencyProperty
ActiveItemsMaxCountProperty
Identifies the ActiveItemsMaxCount dependency property.
Declaration
public static readonly DependencyProperty ActiveItemsMaxCountPropertyField Value
DependencyProperty
HeaderVisibilityProperty
Identifies the HeaderVisibility dependency property.
Declaration
public static readonly DependencyProperty HeaderVisibilityPropertyField Value
DependencyProperty
HorizontalSplitterStyleProperty
Identifies the HorizontalSplitterStyle dependency property.
Declaration
public static readonly DependencyProperty HorizontalSplitterStylePropertyField Value
DependencyProperty
IsMinimizableProperty
Identifies the IsMinimizable dependency property.
Declaration
public static readonly DependencyProperty IsMinimizablePropertyField Value
DependencyProperty
IsMinimizedProperty
Identifies the IsMinimized dependency property.
Declaration
public static readonly DependencyProperty IsMinimizedPropertyField Value
DependencyProperty
IsVerticalResizerVisibleProperty
Identifies the IsVerticalResizerVisible dependency property.
Declaration
public static readonly DependencyProperty IsVerticalResizerVisiblePropertyField Value
DependencyProperty
ItemMinimizedTemplateProperty
Identifies the ItemMinimizedTemplate dependency property.
Declaration
public static readonly DependencyProperty ItemMinimizedTemplatePropertyField Value
DependencyProperty
ItemMinimizedTemplateSelectorProperty
Identifies the ItemMinimizedTemplateSelector dependency property.
Declaration
public static readonly DependencyProperty ItemMinimizedTemplateSelectorPropertyField Value
DependencyProperty
MinContentHeightProperty
Identifies the MinContentHeight dependency property.
Declaration
public static readonly DependencyProperty MinContentHeightPropertyField Value
DependencyProperty
MinimizeButtonStyleProperty
Identifies the MinimizeButtonStyle dependency property.
Declaration
public static readonly DependencyProperty MinimizeButtonStylePropertyField Value
DependencyProperty
MinimizedAreaMinHeightProperty
Identifies the MinimizedAreaMinHeight dependency property.
Declaration
public static readonly DependencyProperty MinimizedAreaMinHeightPropertyField Value
DependencyProperty
MinimizedAreaVisibilityProperty
Identifies the MinimizedAreaVisibility dependency property.
Declaration
public static readonly DependencyProperty MinimizedAreaVisibilityPropertyField Value
DependencyProperty
MinimizedButtonContentProperty
Identifies the MinimizedButtonContent dependency property.
Declaration
public static readonly DependencyProperty MinimizedButtonContentPropertyField Value
DependencyProperty
MinimizedButtonContentTemplateProperty
Identifies the MinimizedButtonContentTemplate dependency property.
Declaration
public static readonly DependencyProperty MinimizedButtonContentTemplatePropertyField Value
DependencyProperty
MinimizedEvent
This event gets fired every time a RadOutlookBar IsMinimized property is set to true.
Declaration
public static readonly RoutedEvent MinimizedEventField Value
RoutedEvent
MinimizedWidthProperty
Identifies the MinimizedWidth dependency property.
Declaration
public static readonly DependencyProperty MinimizedWidthPropertyField Value
DependencyProperty
MinimizedWidthThresholdProperty
Identifies the MinimizedWidthThreshold dependency property.
Declaration
public static readonly DependencyProperty MinimizedWidthThresholdPropertyField Value
DependencyProperty
RestoredEvent
This event gets fired every time a RadOutlookBar IsMinimized property is set to false.
Declaration
public static readonly RoutedEvent RestoredEventField Value
RoutedEvent
SelectedItemHeaderTemplateProperty
Identifies the SelectedItemHeaderTemplate dependency property.
Declaration
[Obsolete("This property is obsolete.", false)]
public static readonly DependencyProperty SelectedItemHeaderTemplatePropertyField Value
DependencyProperty
SelectedItemHeaderTemplateSelectorProperty
Identifies the SelectedItemHeaderTemplateSelector dependency property.
Declaration
[Obsolete("This property is obsolete.", false)]
public static readonly DependencyProperty SelectedItemHeaderTemplateSelectorPropertyField Value
DependencyProperty
TitleTemplateProperty
Identifies the TitleTemplate dependency property.
Declaration
public static readonly DependencyProperty TitleTemplatePropertyField Value
DependencyProperty
TitleTemplateSelectorProperty
Identifies the TitleTemplateSelector dependency property.
Declaration
public static readonly DependencyProperty TitleTemplateSelectorPropertyField Value
DependencyProperty
VerticalResizerAlignmentProperty
Identifies the VerticalResizerAlignment dependency property.
Declaration
public static readonly DependencyProperty VerticalResizerAlignmentPropertyField Value
DependencyProperty
VerticalResizerStyleProperty
Identifies the VerticalResizerStyle dependency property.
Declaration
public static readonly DependencyProperty VerticalResizerStylePropertyField Value
DependencyProperty
Properties
ActiveItemsCount
Gets or sets the desired number of items in the ActiveArea of the RadOutlookBar.
ActiveItemsMaxCount
Gets or sets the desired number of items in the ActiveArea of the RadOutlookBar.
Declaration
public int ActiveItemsMaxCount { get; set; }Property Value
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
Gets or sets the visibility of the title element.
Declaration
public Visibility HeaderVisibility { get; set; }Property Value
Visibility
HorizontalSplitterStyle
Gets or sets the style for the horizontal splitter.
Declaration
public Style HorizontalSplitterStyle { get; set; }Property Value
Style
IsMinimizable
Gets or sets the IsMinimizable property.
IsMinimized
Gets or sets the IsMinimized property.
IsVerticalResizerVisible
Gets or sets the IsVerticalSplitterVisible property.
Declaration
public bool IsVerticalResizerVisible { get; set; }Property Value
ItemMinimizedTemplate
Gets or sets the template for the items when they go in the MinimizedArea.
Declaration
public DataTemplate ItemMinimizedTemplate { get; set; }Property Value
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
DataTemplateSelector
MinContentHeight
Gets or sets the minimum height of the content.
MinimizeButtonStyle
Gets or sets the MinimizeButtonStyle property.
Declaration
public Style MinimizeButtonStyle { get; set; }Property Value
Style
MinimizedAreaMinHeight
Gets or sets the minimal height of the MinimizedArea.
Declaration
public double MinimizedAreaMinHeight { get; set; }Property Value
MinimizedAreaVisibility
Gets or sets the visibility of the MinimizedArea.
Declaration
public Visibility MinimizedAreaVisibility { get; set; }Property Value
Visibility
MinimizedButtonContent
Gets or sets the MinimizedButtonContent property.
Declaration
public object MinimizedButtonContent { get; set; }Property Value
MinimizedButtonContentTemplate
Gets or sets the MinimizedButtonContentTemplate property.
Declaration
public DataTemplate MinimizedButtonContentTemplate { get; set; }Property Value
DataTemplate
MinimizedWidth
Gets or sets the MinimizedWidth property.
MinimizedWidthThreshold
Gets or sets the MinimizedWidthThreshold property.
Declaration
public double MinimizedWidthThreshold { get; set; }Property Value
TitleTemplate
Gets or sets the template for the title.
Declaration
public DataTemplate TitleTemplate { get; set; }Property Value
DataTemplate
TitleTemplateSelector
Gets or sets the template selector for the title template.
Declaration
public DataTemplateSelector TitleTemplateSelector { get; set; }Property Value
DataTemplateSelector
VerticalResizerAlignment
Gets or sets the VerticalResizerAlignment property.
Declaration
public ResizerAlignment VerticalResizerAlignment { get; set; }Property Value
VerticalResizerStyle
Gets or sets the style for the vertical resizer.
Declaration
public Style VerticalResizerStyle { get; set; }Property Value
Style
this[int]
Indexer, gets the RadOutlookBarItem with the given index in the items collection.
Declaration
public RadOutlookBarItem this[int index] { get; }Parameters
index
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.
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 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.
<pre><code class="lang-csharp">RadOutlookBar outlookBar = new RadOutlookBar();
outlookBar.ItemsSource = new string[] { "Item Header 1", "Item Header 2", "Item Header 3" };
outlookBar[1].IsSelected = true;</code></pre>
Methods
ArrangeOverride(Size)
When overridden in a derived class, positions child elements and determines a size for a FrameworkElement derived class.
Declaration
protected override Size ArrangeOverride(Size finalSize)Parameters
finalSize
Size
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.
Declaration
protected void ChangeVisualState(bool useTransitions)Parameters
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
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
[SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")]
protected virtual MinimizedOutlookBarItem GetContainerForMinimizedItem()Returns
IsItemItsOwnContainerOverride(object)
Determines if the specified item is (or is eligible to be) its own container.
OnApplyTemplate()
When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call .
Declaration
public override void OnApplyTemplate()Overrides
OnCreateAutomationPeer()
Creates a peer associated with this object.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()Returns
AutomationPeer
An instance of the .
Overrides
OnInitialized(EventArgs)
Raises the event. This method is invoked whenever is set to true internally.
Declaration
protected override void OnInitialized(EventArgs e)Parameters
e
The RoutedEventArgs that contains the event data.
Overrides
OnItemsChanged(NotifyCollectionChangedEventArgs)
Raises the event.
Declaration
protected override void OnItemsChanged(NotifyCollectionChangedEventArgs e)Parameters
e
NotifyCollectionChangedEventArgs
The NotifyCollectionChangedEventArgs instance containing the event data.
Overrides
OnKeyDown(KeyEventArgs)
Called before the event occurs.
Declaration
protected override void OnKeyDown(KeyEventArgs e)Parameters
e
KeyEventArgs
The data for the event.
OnSelectionChanged(RadSelectionChangedEventArgs)
Raises the SelectionChanged routed event.
Declaration
protected override void OnSelectionChanged(RadSelectionChangedEventArgs e)Parameters
e
Overrides
PrepareContainerForItemOverride(DependencyObject, object)
Prepares the specified element to display the specified item.
Declaration
protected override void PrepareContainerForItemOverride(DependencyObject element, object item)Parameters
element
DependencyObject
Element used to display the specified item.
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
sender
The source of the event.
e
SelectionChangedEventArgs
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 ItemPositionChangedEvent Value
Minimized
Occurs when the IsMinimized property is set to true.
Declaration
public event RoutedEventHandler MinimizedEvent Value
RoutedEventHandler
Restored
Occurs when the IsMinimized property is set to false.
Declaration
public event RoutedEventHandler RestoredEvent Value
RoutedEventHandler