Class RadPanelBar
A navigation control used for building collapsible side-menu systems and Outlook-type panels.
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll
Syntax
[TelerikToolboxCategory("Navigation")]
public class RadPanelBar : RadTreeView, IScrollingServiceCore, IScrollingInfo
Remarks
The RadPanelBar control is used for displaying a list of items in an application and is often used for building collapsible side-menu interfaces. The RadPanelBar control has the following features:
Items
The RadPanelBar control is made up of a tree-like structure of items represented by RadPanelBarItem objects. Items at the first level (level 0) are called root items. An item that has a parent item is called a child item. All root items are stored in the System.Windows.Controls.ItemsControl.Items collection. Child items are stored in a parent item's System.Windows.Controls.ItemsControl.Items collection.
Each item has a Header and an Item property. The value of the Header property is always visible in the RadPanelBar control whenever a RadPanelBarItem is collapsed or expanded, while the Item property is used to store the actual content of the RadPanelBarItem i.e. what is visible when the RadPanelBarItem is expanded.
Constructors
RadPanelBar()
Initializes a new instance of the RadPanelBar class.
Declaration
public RadPanelBar()
Remarks
Use this constructor to create and initialize a new instance of the RadPanelBar control.
Examples
The following example demonstrates how to programmatically create a RadPanelBar control.
void Page_Load(object sender, EventArgs e)
{
RadPanelBar myPanelBar = new RadPanelBar();
}
Fields
ExpandModeProperty
Identifies the ExpandMode dependency property.
Declaration
public static readonly DependencyProperty ExpandModeProperty
Field Value
System.Windows.DependencyProperty
|
OrientationChangedEvent
Occurs when orientation changes.
Declaration
public static readonly RoutedEvent OrientationChangedEvent
Field Value
RoutedEvent
|
OrientationProperty
Identifies the Orientation dependency property.
Declaration
public static readonly DependencyProperty OrientationProperty
Field Value
System.Windows.DependencyProperty
|
Properties
BringIntoViewMode
This property does not apply to RadPanelBar.
Declaration
public BringIntoViewMode BringIntoViewMode { get; set; }
Property Value
BringIntoViewMode
|
CheckedItems
This property does not apply to RadPanelBar.
Declaration
public ICollection<object> CheckedItems { get; }
Property Value
System.Collections.Generic.ICollection<System.Object>
|
ExpanderStyle
This property does not apply to RadPanelBar.
Declaration
public Style ExpanderStyle { get; set; }
Property Value
System.Windows.Style
|
ExpandMode
Gets or sets the expand mode.
Declaration
[SRDescription("PanelBarExpandModePropertyDescription")]
public ExpandMode ExpandMode { get; set; }
Property Value
ExpandMode
One of the ExpandMode values. The default value is Single. |
Remarks
Use the ExpandMode property to specify the way RadPanelBar should behave after an item is expanded. The available options are:
ImagesBaseDir
This property does not apply to RadPanelBar.
Declaration
public string ImagesBaseDir { get; set; }
Property Value
System.String
|
IsDragDropEnabled
Gets or sets a value indicating whether drag and drop is enabled. This property is obsolete and will have not effect when set in future release.
Declaration
public bool IsDragDropEnabled { get; set; }
Property Value
System.Boolean
|
IsDropPreviewLineEnabled
This property does not apply to RadPanelBar.
Declaration
public bool IsDropPreviewLineEnabled { get; set; }
Property Value
System.Boolean
|
IsEditable
This property does not apply to RadPanelBar.
Declaration
public bool IsEditable { get; set; }
Property Value
System.Boolean
|
IsEditing
This property does not apply to RadPanelBar.
Declaration
public override bool IsEditing { get; }
Property Value
System.Boolean
|
Overrides
IsLineEnabled
This property does not apply to RadPanelBar.
Declaration
public bool IsLineEnabled { get; set; }
Property Value
System.Boolean
|
IsLoadOnDemandEnabled
This property does not apply to RadPanelBar.
Declaration
public bool IsLoadOnDemandEnabled { get; set; }
Property Value
System.Boolean
|
IsOptionElementsEnabled
This property does not apply to RadPanelBar.
Declaration
public bool IsOptionElementsEnabled { get; set; }
Property Value
System.Boolean
|
IsRootLinesEnabled
This property does not apply to RadPanelBar.
Declaration
public bool IsRootLinesEnabled { get; set; }
Property Value
System.Boolean
|
IsTriStateMode
This property does not apply to RadPanelBar.
Declaration
public bool IsTriStateMode { get; set; }
Property Value
System.Boolean
|
IsVirtualizing
This property does not apply to RadPanelBar.
Declaration
public bool IsVirtualizing { get; set; }
Property Value
System.Boolean
|
ItemEditTemplate
This property does not apply to RadPanelBar.
Declaration
public DataTemplate ItemEditTemplate { get; set; }
Property Value
System.Windows.DataTemplate
|
ItemEditTemplateSelector
This property does not apply to RadPanelBar.
Declaration
public DataTemplateSelector ItemEditTemplateSelector { get; set; }
Property Value
DataTemplateSelector
|
ItemsIndent
This property does not apply to RadPanelBar.
Declaration
public int ItemsIndent { get; set; }
Property Value
System.Int32
|
ItemsOptionListType
This property does not apply to RadPanelBar.
Declaration
public OptionListType ItemsOptionListType { get; set; }
Property Value
OptionListType
|
Orientation
Gets or sets the orientation.
Declaration
public Orientation Orientation { get; set; }
Property Value
System.Windows.Controls.Orientation
The orientation. |
PathSeparator
This property does not apply to RadPanelBar.
Declaration
public string PathSeparator { get; set; }
Property Value
System.String
|
TextDropRoot
This property does not apply to RadPanelBar.
Declaration
public string TextDropRoot { get; set; }
Property Value
System.String
|
Methods
add_EditCanceled(RadTreeViewItemEditedEventHandler)
Declaration
public void add_EditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
add_Edited(RadTreeViewItemEditedEventHandler)
Declaration
public void add_Edited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
add_EditStarted(RadTreeViewItemEditedEventHandler)
Declaration
public void add_EditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
add_PreviewEditCanceled(RadTreeViewItemEditedEventHandler)
Declaration
public void add_PreviewEditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
add_PreviewEdited(RadTreeViewItemEditedEventHandler)
Declaration
public void add_PreviewEdited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
add_PreviewEditStarted(RadTreeViewItemEditedEventHandler)
Declaration
public void add_PreviewEditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
AddItemByPath(String)
This method does not apply to RadPanelBar.
Declaration
public RadTreeViewItem AddItemByPath(string path)
Parameters
System.String
path
|
Returns
RadTreeViewItem
|
AddItemsByPath(String, String)
This method does not apply to RadPanelBar.
Declaration
public RadTreeViewItem AddItemsByPath(string path, string separator)
Parameters
System.String
path
|
System.String
separator
|
Returns
RadTreeViewItem
|
BringIndexIntoView(Int32)
This method does not apply to RadPanelBar.
Declaration
public void BringIndexIntoView(int index)
Parameters
System.Int32
index
|
BringItemIntoView(Object)
This method does not apply to RadPanelBar.
Declaration
public void BringItemIntoView(object item)
Parameters
System.Object
item
|
BringPathIntoView(String)
This method does not apply to RadPanelBar.
Declaration
public void BringPathIntoView(string path)
Parameters
System.String
path
|
ClearContainerForItemOverride(DependencyObject, Object)
When overridden in a derived class, undoes the effects of the System.Windows.Controls.ItemsControl.PrepareContainerForItemOverride(System.Windows.DependencyObject,System.Object) method.
Declaration
protected override void ClearContainerForItemOverride(DependencyObject element, object item)
Parameters
System.Windows.DependencyObject
element
The container element. |
System.Object
item
The Item. |
Overrides
ExpandItemByPath(String)
This method does not apply to RadPanelBar.
Declaration
public void ExpandItemByPath(string path)
Parameters
System.String
path
|
GetContainerForItemOverride()
Creates or identifies the element that is used to display the given item.
Declaration
protected override DependencyObject GetContainerForItemOverride()
Returns
System.Windows.DependencyObject
|
Overrides
GetItemByPath(String)
This method does not apply to RadPanelBar.
Declaration
public RadTreeViewItem GetItemByPath(string path)
Parameters
System.String
path
|
Returns
RadTreeViewItem
|
HasSelectedItem()
Determines whether a RadPanelBar has a selected item.
Declaration
public bool HasSelectedItem()
Returns
System.Boolean
|
HideBetweenItemsDragCue()
This method does not apply to RadPanelBar.
Declaration
public void HideBetweenItemsDragCue()
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()
Returns class-specific System.Windows.Automation.Peers.AutomationPeer.
Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer
The type-specific System.Windows.Automation.Peers.AutomationPeer implementation. |
Overrides
OnExpandModeChanged(ExpandMode, ExpandMode)
Declaration
protected virtual void OnExpandModeChanged(ExpandMode oldValue, ExpandMode newValue)
Parameters
ExpandMode
oldValue
|
ExpandMode
newValue
|
OnOrientationChanged(OrientationChangedEventArgs)
Raises the OrientationChanged event.
Declaration
protected virtual void OnOrientationChanged(OrientationChangedEventArgs e)
Parameters
OrientationChangedEventArgs
e
The OrientationChangedEventArgs instance containing the event data. |
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
remove_EditCanceled(RadTreeViewItemEditedEventHandler)
Declaration
public void remove_EditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
remove_Edited(RadTreeViewItemEditedEventHandler)
Declaration
public void remove_Edited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
remove_EditStarted(RadTreeViewItemEditedEventHandler)
Declaration
public void remove_EditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
remove_PreviewEditCanceled(RadTreeViewItemEditedEventHandler)
Declaration
public void remove_PreviewEditCanceled(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
remove_PreviewEdited(RadTreeViewItemEditedEventHandler)
Declaration
public void remove_PreviewEdited(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler)
Declaration
public void remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler
value
|
SelectItemByPath(String)
This method does not apply to RadPanelBar.
Declaration
public void SelectItemByPath(string path)
Parameters
System.String
path
|
ShowBetweenItemsDragCue(RadTreeViewItem)
This method does not apply to RadPanelBar.
Declaration
public void ShowBetweenItemsDragCue(RadTreeViewItem dropDestination)
Parameters
RadTreeViewItem
dropDestination
|
Events
Checked
This event does not apply to RadPanelBar.
Declaration
public event EventHandler<RadRoutedEventArgs> Checked
Event Type
System.EventHandler<RadRoutedEventArgs>
|
EditCanceled
This event does not apply to RadPanelBar.
Declaration
public event RadTreeViewItemEditedEventHandler EditCanceled
Event Type
RadTreeViewItemEditedEventHandler
|
Edited
This event does not apply to RadPanelBar.
Declaration
public event RadTreeViewItemEditedEventHandler Edited
Event Type
RadTreeViewItemEditedEventHandler
|
EditStarted
This event does not apply to RadPanelBar.
Declaration
public event RadTreeViewItemEditedEventHandler EditStarted
Event Type
RadTreeViewItemEditedEventHandler
|
LoadOnDemand
This event does not apply to RadPanelBar.
Declaration
public event EventHandler<RadRoutedEventArgs> LoadOnDemand
Event Type
System.EventHandler<RadRoutedEventArgs>
|
OrientationChanged
Occurs when orientation changes.
Declaration
public event EventHandler<OrientationChangedEventArgs> OrientationChanged
Event Type
System.EventHandler<OrientationChangedEventArgs>
|
PreviewChecked
This event does not apply to RadPanelBar.
Declaration
public event EventHandler<RadRoutedEventArgs> PreviewChecked
Event Type
System.EventHandler<RadRoutedEventArgs>
|
PreviewEditCanceled
This event does not apply to RadPanelBar.
Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditCanceled
Event Type
RadTreeViewItemEditedEventHandler
|
PreviewEdited
This event does not apply to RadPanelBar.
Declaration
public event RadTreeViewItemEditedEventHandler PreviewEdited
Event Type
RadTreeViewItemEditedEventHandler
|
PreviewEditStarted
This event does not apply to RadPanelBar.
Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditStarted
Event Type
RadTreeViewItemEditedEventHandler
|
PreviewUnchecked
This event does not apply to RadPanelBar.
Declaration
public event EventHandler<RadRoutedEventArgs> PreviewUnchecked
Event Type
System.EventHandler<RadRoutedEventArgs>
|
Unchecked
This event does not apply to RadPanelBar.
Declaration
public event EventHandler<RadRoutedEventArgs> Unchecked
Event Type
System.EventHandler<RadRoutedEventArgs>
|