Class RadPanelBarItem

Represents an item in the RadPanelBar control.

Inheritance
System.Object
EditableHeaderedItemsControl
RadTreeViewItem
RadPanelBarItem
Inherited Members
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.Navigation.dll

Syntax

[TelerikToolboxCategory("Navigation")]
public class RadPanelBarItem : RadTreeViewItem, TreeViewPanel.IProvideStackingSize, TreeViewPanel.ICachable, ICommandSource
Remarks

The RadPanelBar control is made up of items. Items which are immediate children of the PanelBar are root items. Items which are children of root items are child items.

An item usually stores data in two properties, the Header property and the Item property. The value of the Header property is always displayed in the RadPanelBar control, and the Item property property is used to store the actual content of the RadPanelBarItem and is visible only when the RadPanelBarItem is expanded.

To create panel items, use one of the following methods:

Constructors

RadPanelBarItem()

Initializes a new instance of the RadPanelBarItem class.

Declaration
public RadPanelBarItem()

Fields

ChildItemsTemplateProperty

Identifies the ChildItemsTemplate dependency property.

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

ExpandedLengthProperty

Identifies the ExpandedLength dependency property.

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

ExpandedMaxLengthProperty

Identifies the ExpandedMaxLength dependency property.

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

ExpandedMinLengthProperty

Identifies the ExpandedMinLength dependency property.

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

LevelProperty

Identifies the Level dependency property.

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

Remarks

This property specifies the depth of nesting of the current instance within the parent RadPanelBar.

Properties

CheckState

This property does not apply to RadPanelBarItem.

Declaration
public ToggleState CheckState { get; set; }
Property Value
System.Windows.Automation.ToggleState

ChildItemsTemplate

Gets or sets the template of the child elements.

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

DefaultImageSrc

This property does not apply to RadPanelBarItem.

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

ExpandedImageSrc

This property does not apply to RadPanelBarItem.

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

ExpandedLength

Gets or sets the ExpandedLength property. This property is used only when either of the IsResizingEnabled or IsScrollViewerInsideItemsEnabled properties are true.

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

ExpandedMaxLength

Gets or sets the ExpandedMaxLength property. This property is used only when the IsResizingEnabled property is true.

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

ExpandedMinLength

Gets or sets the ExpandedMinLength property. This property is used only when the IsResizingEnabled property is true.

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

HeaderEditTemplate

This property does not apply to RadPanelBarItem.

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

HeaderEditTemplateSelector

This property does not apply to RadPanelBarItem.

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

IsCheckBoxEnabled

This property does not apply to RadPanelBarItem.

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

IsChecked

This property does not apply to RadPanelBarItem.

Declaration
public Nullable<bool> IsChecked { get; set; }
Property Value
System.Nullable<System.Boolean>

IsEditable

This property does not apply to RadPanelBarItem.

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

IsInEditMode

This property does not apply to RadPanelBarItem.

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

IsInSelectedPath

This property does not apply to RadPanelBarItem.

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

IsInViewport

This property does not apply to RadPanelBarItem.

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

IsLoadingOnDemand

This property does not apply to RadPanelBarItem.

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

IsLoadOnDemandEnabled

This property does not apply to RadPanelBarItem.

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

IsRadioButtonEnabled

This property does not apply to RadPanelBarItem.

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

IsRootItem

This property does not apply to RadPanelBarItem.

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

IsScrollViewerEnabled

Gets the IsScrollViewerEnabled property. This property controls whether the ScrollBarVisibility of the ScrollViewer inside the ControlTemplate of the RadPanelBarItem.

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

IsSelectionActive

This property does not apply to RadPanelBarItem.

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

ItemsOptionListType

This property does not apply to RadPanelBarItem.

Declaration
public OptionListType ItemsOptionListType { get; set; }
Property Value
OptionListType

Level

Gets or sets the Level property.

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

The level.

OptionType

This property does not apply to RadPanelBarItem.

Declaration
public OptionListType OptionType { get; set; }
Property Value
OptionListType

ParentItem

Gets the parent PanelBarItem of the current item.

Declaration
public RadPanelBarItem ParentItem { get; }
Property Value
RadPanelBarItem

SelectedImageSrc

This property does not apply to RadPanelBarItem.

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

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_EditorPrepare(EditorPrepareEventHandler)

Declaration
public void add_EditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler 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_PreviewEditorPrepare(EditorPrepareEventHandler)

Declaration
public void add_PreviewEditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler value

add_PreviewEditStarted(RadTreeViewItemEditedEventHandler)

Declaration
public void add_PreviewEditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

BeginEdit()

This method does not apply to RadPanelBarItem.

Declaration
public override bool BeginEdit()
Returns
System.Boolean

Overrides

BringIndexIntoView(Int32)

This method does not apply to RadPanelBarItem.

Declaration
public void BringIndexIntoView(int index)
Parameters
System.Int32 index

BringItemIntoView(Object)

This method does not apply to RadPanelBarItem.

Declaration
public void BringItemIntoView(object item)
Parameters
System.Object item

CancelEdit()

This method does not apply to RadPanelBarItem.

Declaration
public override bool CancelEdit()
Returns
System.Boolean

Overrides

ChangeVisualState(Boolean)

Updates the visual state of the control.

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

Indicates whether transitions should be used.
Overrides

CommitEdit()

This method does not apply to RadPanelBarItem.

Declaration
public override bool CommitEdit()
Returns
System.Boolean

Overrides

EndEdit(Boolean)

This method does not apply to RadPanelBarItem.

Declaration
public bool EndEdit(bool cancelEdit)
Parameters
System.Boolean cancelEdit

Returns
System.Boolean

GetContainerForItemOverride()

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

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

Overrides

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

MeasureOverride(Size)

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
System.Windows.Size availableSize

Returns
System.Windows.Size

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

OnChildItemsTemplateChanged(RadPanelBarItem)

Clears the template property.

Declaration
protected virtual void OnChildItemsTemplateChanged(RadPanelBarItem item)
Parameters
RadPanelBarItem item

The item.

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

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

OnIsExpandedChanged(Boolean, Boolean)

Called when IsExpanded changes.

Declaration
protected override void OnIsExpandedChanged(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

If set to true [old value].
System.Boolean newValue

If set to true [new value].
Overrides

OnItemsChanged(NotifyCollectionChangedEventArgs)

Invoked when the System.Windows.Controls.ItemsControl.Items property changes.

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

Information about the change.
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

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_EditorPrepare(EditorPrepareEventHandler)

Declaration
public void remove_EditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler 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_PreviewEditorPrepare(EditorPrepareEventHandler)

Declaration
public void remove_PreviewEditorPrepare(EditorPrepareEventHandler value)
Parameters
EditorPrepareEventHandler value

remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler)

Declaration
public void remove_PreviewEditStarted(RadTreeViewItemEditedEventHandler value)
Parameters
RadTreeViewItemEditedEventHandler value

StopEdit(Boolean)

This method does not apply to RadPanelBarItem.

Declaration
public void StopEdit(bool cancelEdit)
Parameters
System.Boolean cancelEdit

Events

Checked

This event does not apply to RadPanelBarItem.

Declaration
public event EventHandler<RadRoutedEventArgs> Checked
Event Type
System.EventHandler<RadRoutedEventArgs>

EditCanceled

This event does not apply to RadPanelBarItem.

Declaration
public event RadTreeViewItemEditedEventHandler EditCanceled
Event Type
RadTreeViewItemEditedEventHandler

Edited

This event does not apply to RadPanelBarItem.

Declaration
public event RadTreeViewItemEditedEventHandler Edited
Event Type
RadTreeViewItemEditedEventHandler

EditorPrepare

This event does not apply to RadPanelBarItem.

Declaration
public event EditorPrepareEventHandler EditorPrepare
Event Type
EditorPrepareEventHandler

EditStarted

This event does not apply to RadPanelBarItem.

Declaration
public event RadTreeViewItemEditedEventHandler EditStarted
Event Type
RadTreeViewItemEditedEventHandler

LoadOnDemand

This event does not apply to RadPanelBarItem.

Declaration
public event EventHandler<RadRoutedEventArgs> LoadOnDemand
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewChecked

This event does not apply to RadPanelBarItem.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewChecked
Event Type
System.EventHandler<RadRoutedEventArgs>

PreviewEditCanceled

This event does not apply to RadPanelBarItem.

Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditCanceled
Event Type
RadTreeViewItemEditedEventHandler

PreviewEdited

This event does not apply to RadPanelBarItem.

Declaration
public event RadTreeViewItemEditedEventHandler PreviewEdited
Event Type
RadTreeViewItemEditedEventHandler

PreviewEditorPrepare

This event does not apply to RadPanelBarItem.

Declaration
public event EditorPrepareEventHandler PreviewEditorPrepare
Event Type
EditorPrepareEventHandler

PreviewEditStarted

This event does not apply to RadPanelBarItem.

Declaration
public event RadTreeViewItemEditedEventHandler PreviewEditStarted
Event Type
RadTreeViewItemEditedEventHandler

PreviewUnchecked

This event does not apply to RadPanelBarItem.

Declaration
public event EventHandler<RadRoutedEventArgs> PreviewUnchecked
Event Type
System.EventHandler<RadRoutedEventArgs>

Unchecked

This event does not apply to RadPanelBarItem.

Declaration
public event EventHandler<RadRoutedEventArgs> Unchecked
Event Type
System.EventHandler<RadRoutedEventArgs>

Extension Methods