RadPanelBar for ASP.NET
Table of Contents
The RadPanelBar client object Send comments on this topic.
Telerik RadPanelBar client-side > The RadPanelBar client object

Glossary Item Box

Methods 

Name

Parameters

Return Type

Description

Disable none none Disables all items in the panelbar. Clicking on any item has no effect, child items cannot be expanded.
Enable none none Enables all items in the panelbar.
FindItemByUrl (string URL) RadPanelItem Returns the first RadPanelItem object whose NavigateUrl property is equal to the passed parameter.
Note: The NavigateUrl property is transformed to absolute URL on the client-side, e.g. "default.aspx" is turned into: http://mydomain.com/default.aspx.
SetAttribute (sting attributeName, string value)  none Sets the value of the specified custom attribute.
GetAttribute (sting attributeName)  string Returns the value of the specified custom attribute. If there is no such attribute, null is returned.  
FindItemByValue (string value) RadPanelItem Returns the first RadPanelItem object whose Value property is equal to the passed parameter.
FindItemByText (string text) RadPanelItem Returns the first RadPanelItem object whose Text property is equal to the passed parameter.
FindItemById (string text) RadPanelItem Returns the first RadPanelItem object whose ID property is equal to the passed parameter.
AttachEvent (string eventName, mixed eventHandler) none Attaches an eventHandler to the specified eventName.
For more information, check Client-side API in this help.
DetachEvent (string eventName, mixed eventHandler) Boolean

Detaches an eventHandler from the specified eventName.
Returns "True" if an eventHandler hooked to the specified eventName is found and detached, false otherwise.
For more information, check Client-side API in this help.

EnableEvents none none

Enables the control client-side event emitting. Events are enabled by default.

DisableEvents none none

Disables the control client-side event emitting.

Properties

Name

 Type Description
ID String

Gets the ClientID of the control.

Example

  Copy Code
<script type="text/javascript">
   var panelbar1 = <%=RadPanelBar1.ClientID %>
   function showPanelBar()
   {
       alert(panelbar1.ID);
   }
   showPanelBar();
</script>
DomElement HTML Element Gets the root DOM element of the control.
Items Array

Gets the root level items.

Example

  Copy Code
<script type="text/javascript">
   var panelbar1 = <%=RadPanelBar1.ClientID %>
   function showRootItems()
   {
        for (var i=0; i<panelbar1.Items.length; i++)
       {
           alert(panelbar1.Items[i].Text);
       }
   }
   showRootItems();
</script>
Enabled boolean True if the panelbar is enabled. To enable a panelbar, use the Enable() method.
AllItems Array

Gets a linear collection of all items. This includes all root and child items in the panelbar.

Example

  Copy Code
<script type="text/javascript">
   var panelbar1 = <%=RadPanelBar1.ClientID %>
   function showAllItems()
   {
        for (var i=0; i<panelbar1.AllItems.length; i++)
       {
           alert(panelbar1.AllItems[i].Text);
       }
   }
   showAllItems();
</script>
ExpandedItem RadPanelItem Gets the expanded root level item. If no item is expanded at the root level returns null.
SelectedItem RadPanelItem Gets the currently selected item (global for the entire panelbar). If no item is selected the value is null.
FocusedItem RadPanelItem Gets the focused root level item. Null if no item is selected.

Events

Name Event Handler Parameters Description
OnClientLoad (RadPanelBar sender)

The client-side event handler is called after the panelbar is fully initialized on the client.

For more details, see the OnClientLoad topic.

OnClientMouseOver (RadPanelBar sender, Object eventArgs)

The client-side event handler is called when the mouse moves over a panelbar item. eventArgs exposes one property, Item: the instance of the panelbar item.

For more details, see the OnClientMouseOver topic.

OnClientMouseOut (RadPanelBar sender, Object eventArgs)

The client-side event handler is called when the mouse moves out of a panelbar item. eventArgs exposes one property, Item: the instance of the panelbar item.

For more details, see the OnClientMouseOut topic.

OnClientItemExpand (RadPanelBar sender, Object eventArgs)

The client-side event handler is called when a  group of child items expands. eventArgs exposes one property, Item: the instance of the panelbar item.

For more details, see the OnClientItemExpand topic.

OnClientItemCollapse (RadPanelBar sender, Object eventArgs)

The client-side event handler is called when a  group of child items collapses. eventArgs exposes one property, Item: the instance of the panelbar item.

For more details, see the OnClientItemCollapse topic.

OnClientItemFocus (RadPanelBar sender, Object eventArgs)

If specified, the OnClientItemFocus client-side event handler is called when a panelbar item is selected using either the keyboard (the [TAB] or arrow keys) or mouse click. eventArgs exposes one property, Item: the instance of the panelbar item.

For more details, see the OnClientItemFocus topic.

OnClientItemBlur (RadPanelBar sender, Object eventArgs)

The client-side event handler is called when a panelbar item loses focus as a result of the user pressing a key or mouse click. eventArgs exposes one property, Item: the instance of the panelbar item.

For more details, see the OnClientItemBlur topic.

OnClientItemClicking (RadPanelBar sender, Object eventArgs)

The client-side event handler is called before a panelbar item is clicked upon. eventArgs exposes one property, Item: the instance of the panelbar item. (The event is similar to OnClientItemFocus but fires only on mouse click.)For more details, see the OnClientItemClicking topic.

Can be cancelled: return False from the event handler.
OnClientItemClicked (RadPanelBar sender, Object eventArgs)

The client-side event handler is called after a panelbar item is clicked upon. eventArgs exposes one property, Item: the instance of the panelbar item. (The event is similar to OnClientItemFocus but fires only on mouse click.)

For more details, see the OnClientItemClicked topic.

 

For more details on handling client events, review the client events section.