RadPanelbar.Net2

Summary description for ControlBuilderForm.

Clean up any resources being used.

Required method for Designer support - do not modify the contents of this method with the code editor.

The Windows form that hosts the RadPanelbar editor.

Initializes a new instance of the RadPanelbarEventArgs class.

A RadPanelItem which represents an item in the RadPanelbar control.

Gets the referenced RadPanelItem in the RadPanelbar control when the event is raised.

The referenced item in the RadPanelbar control when the event is raised. Use this property to programmatically access the item referenced in the RadPanelbar when the event is raised.

A navigation control used to create collapsing interfaces.

The RadPanelbar control is used to display a list of items in a Web Forms page.The RadPanelbar control supports the following features: Databinding that allows the control to be populated from various datasources Programmatic access to the RadPanelbar object model which allows dynamic creation and customization of menus. Customizable appearance through built-in or user-defined skins.

Items

The RadPanelbar control is made up of tree of items represented by RadPanelItem objects. Items at the top level (level 0) are called root items. An item that has a parent item is called child item. All root items are stored in the Items collection. Child items are stored in a parent item's Items collection. Each item has a Text, NavigateUrl, and a Value property. The value of the Text property is displayed in the RadPanelbar control, while the Value property is used to store any additional data about the item, such as data passed to the postback event associated with the item. When clicked, an item can navigate to another Web page indicated by the NavigateUrl property.

Gets the component's current version.

Gets or sets a value indicating whether to use the embedded JavaScript files or not.

True if embedded JavaScript files are to be used; otherwise false. The default value is true. Use this property for debugging purposes or to apply any modifications to the JavaScript files.

Defines properties that panel item containers (RadPanelbar, RadPanelItem) should implement

Gets the parent IRadPanelItemContainer.

Gets the collection of child items.

A RadPanelItemCollection that represents the child items. Use this property to retrieve the child items. You can also use it to programmatically add or remove items.

Initializes a new instance of the RadPanelbar class.

Use this constructor to create and initialize a new instance of the RadPanelbar class. The following example demonstrates how to programmatically create a RadPanelbar
control.


            void Page_Load(object sender, EventArgs e)
            {
                RadPanelbar RadPanelbar1 = new RadPanelbar();
                RadPanelbar1.ID = "RadPanelbar1";
                
                RadPanelItem sportItem = new RadPanelItem("Sport", "~/Sport.aspx");
                RadPanelbar1.Items.Add(sportItem);
                
                RadPanelItem newsItem = new RadPanelItem("News");
                RadPanelbar1.Items.Add(newsItem);
             
                PlaceHolder1.Controls.Add(newsItem);
            }


            Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
                Dim RadPanelbar1 As RadPanelbar = New RadPanelbar()
                RadPanelbar1.ID = "RadPanelbar1"
             
                Dim sportItem As RadPanelItem = New RadPanelItem("Sport", "")
                RadPanelbar1.Items.Add(sportItem)
             
                Dim newsItem As RadPanelItem = New RadPanelItem("News")
                RadPanelbar1.Items.Add(newsItem)
             
                PlaceHolder1.Controls.Add(newsItem)
            End Sub

Searches the RadPanelbar control for the first RadPanelItem with a Text property equal to the specified value.

A RadPanelItem whose Text property is equal to the specified value. The method returns the first item matching the search criteria. If no item is matching then null (Nothing in VB.NET) is returned. The value to search for.

Searches the RadPanelbar control for the first RadPanelItem with a Value property equal to the specified value.

A RadPanelItem whose Value property is equal to the specified value. The method returns the first item matching the search criteria. If no item is matching then null (Nothing in VB.NET) is returned. The value to search for.

Searches the RadPanelbar control for the first Item with a NavigateUrl property equal to the specified value.

A RadPanelItem whose NavigateUrl property is equal to the specified value. The method returns the first Item matching the search criteria. If no Item is matching then null (Nothing in VB.NET) is returned. The value to search for.

Gets a linear list of all items in the RadPanelbar control.

An ArrayList containing all items (from all hierarchy levels). Use the GetAllItems method to obtain a linear collection of all items regardless their place in the hierarchy. The following example demonstrates how to disable all items within a RadPanelbar control.


            void Page_Load(object sender, EventArgs e)
            {
                foreach (RadPanelItem item in RadPanelbar1.GetAllItems())
                {
                    item.Enabled = false;
                }
            }


            Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
                For Each childItem As RadPanelItem In RadPanelbar1.GetAllItems
                    childItem.Enabled = False
                Next
            End Sub

Populates the RadPanelbar control from external XML file. Added to support the legacy XML format used in previous versions.

The newly added items will be appended after any existing ones. The name of the XML file.

Populates the RadPanelbar control from external XML file. Added to support the legacy XML format used in previous versions.

The newly added items will be appended after any existing ones. The following example demonstrates how to populate RadPanelbar control from XML file.


            private void Page_Load(object sender, EventArgs e)
            {
                if (!Page.IsPostBack)
                {
                    RadPanelbar1.LoadContentFile("~/Panelbar/Examples/Panelbar.xml");
                }
            }


            Private Sub Page_Load(sender As Object, e As EventArgs) Handles MyBase.Load
                If Not Page.IsPostBack Then
                    RadPanelbar1.LoadContentFile("~/Panelbar/Examples/Panelbar.xml")
                End If
            End Sub

The name of the XML file.

Populates the RadPanelbar control from a XML string. Added to support the legacy XML format used in previous versions.

The newly added items will be appended after any existing ones. String that contain the panelbar definition.

Populates the RadPanelbar control from a XML string. Added to support the legacy XML format used in previous versions.

The newly added items will be appended after any existing ones. String that contain the panelbar definition.

Gets the RadPanelbar control structure as a XML string. Added to support the legacy XML format used in previous versions.

XML string which contains the whole RadPanelbar object along with its child items. The GetXmlString method gets all of the public properties of the RadPanelbar object and enumerates through all of them. If the current property is in the list of excluded properties ( These are properties which are not serialized. For example, Parent is such a property.) the process jumps to the next item. If the current value of the property that is being checked is different from the default value of that property, then this property will be serialized, and the new XML node attribute will be created for that property. After all of the RadPanelbar properties have been serialized, the GetXmlString method serializes all of the child items using the same algorithm

Note: This property is new in the .NET Framework version 2.0. Gets or sets the name of the validation group to which this validation control belongs.

The name of the validation group to which this validation control belongs. The default is an empty string (""), which indicates that this property is not set. This property works only when CausesValidation is set to true.

Gets or sets the URL of the page to post to from the current page when an item from the panel is clicked.

The URL of the Web page to post to from the current page when an item from the panel control is clicked. The default value is an empty string (""), which causes the page to post back to itself.

Specifies the name of the cookie which should be used when PersistStateInCookie is set to true.

If this property is not set the ClientID property will be used as the name of the cookie.

Gets or sets a value indicating whether validation is performed when an item within the RadPanelbar control is selected.

true if validation is performed when an item is selected; otherwise, false. The default value is true. By default, page validation is performed when an item is selected. Page validation determines whether the input controls associated with a validation control on the page all pass the validation rules specified by the validation control. You can specify or determine whether validation is performed on both the client and the server when an item is clicked by using the CausesValidation property. To prevent validation from being performed, set the CausesValidation property to false.

Gets the selected panel item.

Returns the panel item which is currently selected. If no item is selected the SelectedItem property will return null (Nothing in VB.NET).

Gets or sets the template for displaying the items in RadPanelbar.

A ITemplate implemented object that contains the template for displaying panel items. The default value is a null reference (Nothing in Visual Basic), which indicates that this property is not set. The ItemTemplate property sets a template that will be used for all panel items. To specify unique display for individual items use the ItemTemplate property of the RadPanelItem class. The following example demonstrates how to use the ItemTemplate property to add a CheckBox for each item. ASPX: <radP:RadPanelbar runat="server" ID="RadPanelbar1">

<ItemTemplate>
<asp:CheckBox runat="server" ID="CheckBox"></asp:CheckBox>
<asp:Label runat="server" ID="Label1"
Text='<%# DataBinder.Eval(Container, "Text") %>' ></asp:Label>

</ItemTemplate> <Items>
<radP:RadPanelItem Text="News" /> <radP:RadPanelItem Text="Sports" /> <radP:RadPanelItem Text="Games" />
</Items>

</radP:RadPanelbar>

The DataSource object used for data-binding. Can be either IListSource (DataSet, DataTable, DataView) or ICollection / IEnumerable (ArrayList, arrays, etc)

Gets or sets the object from which the data-bound control retrieves its list of data items.

RadPanelbar fully supports binding to IList datasources (DataSet, DataTable) and ICollection / IEnumerable (ArrayList, arrays, etc), so you can easily populate your panelbar instance with only a few lines of code. The built-in data binding supports auto-binding from a a single self-referencing table with ID -> ParentID relation.

Properties and methods related to data binding: DataSource - (mandatory) object. Set to an instance of your datasource. DataMember - (optional) string. If the DataSource is a DataSet and DataMember is set, then RadPanelBar assumes the DataTable with the respective name in the DataSet. Otherwise the first DataTable in the DataSet is used. DataFieldID - (optional) string. The name of the DataColumn holding the ID value; DataFieldParentID - (optional) string. The name of the DataColumn holding the ParentID value; DataTextField (optional) - Gets or sets the field name from a data source to bind to the PanelItem Text property. DataValueField (optional) - Gets or sets the field name from a data source to bind to the PanelItem Value property. DataNavigateUrlField (optional) - Gets or set the field name from a data source to bind to the PanelItem NavigageUrl property. DataBind() - (mandatory) method. Call this method after you've set the aforementioned properties per your scenario.


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();

A data source that provides data for populating the RadPanelbar control.

Gets or sets a value that indicates whether the items are cleared before data binding.

True if items should not be cleared before data binding; otherwise false. The default value is false (child items are cleared). The AppendDataBoundItems property allows you to add items to the RadPanelbar control before data binding occurs. After data binding, the items collection contains both the items from the data source and the previously added items.

Gets the collection of child items in the RadPanelbar control.

A RadPanelItemCollection that represents the children within the RadPanelbar control. The default is empty collection. Use this property to retrieve the child items of the RadPanelbar control. You can also use it to programmatically add or remove items. The following example demonstrates how to programmatically add items.


            void Page_Load(object sender, EventArgs e)
            {
                if (!Page.IsPostBack)
                {
                    RadPanelItem corporateItem = new RadPanelItem("Corporate");
                    RadPanelbar1.Items.Add(corporateItem);
             
                    RadPanelItem newsItem = new RadPanelItem("News");
                    RadPanelbar1.Items.Add(newsItem);
                
                    RadPanelItem aboutUsItem = new RadPanelItem("About us");
                    RadPanelbar1.Items.Add(aboutUsItem);
                }
            }


            Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
                If Not Page.IsPostBack Then
                    Dim corporateItem As RadPanelItem = New RadPanelItem("Corporate")
                    RadPanelbar1.Items.Add(newsItem)
             
                    Dim newsItem As RadPanelItem = New RadPanelItem("News")
                    RadPanelbar1.Items.Add(newsItem)
             
                    Dim aboutUsItem As RadPanelItem = New RadPanelItem("About us")
                    RadPanelbar1.Items.Add(aboutUsItem)
                End If
            End Sub


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
            RadPanelbar1.DataNavigateUrlField = "URL"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
            RadPanelbar1.DataNavigateUrlField = "URL";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();

Gets or sets the field from the data source which is the "child" column in the "parent-child" relationship used to databind the RadPanelbar control.

A string that specifies the field of the data source that will be the "child" column during databinding. The default is empty string RadPanelbar requires both DataFieldID and DataFieldParentID properties to be set in order to be databound recursively.


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
            RadPanelbar1.DataNavigateUrlField = "URL"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
            RadPanelbar1.DataNavigateUrlField = "URL";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();

Gets or sets the field from the data source which is the "parent" column in the "parent-child" relationship used to databind the RadPanelbar control.

A string that specifies the field of the data source that will be the "parent" column during databinding. The default is empty string. RadPanelbar requires both DataFieldID and DataFieldParentID properties to be set in order to be databound recursively.


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
            RadPanelbar1.DataNavigateUrlField = "URL"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
            RadPanelbar1.DataNavigateUrlField = "URL";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();

Gets or sets the formatting string used to control how the item text would look like.

Use the DataTextFormatString property to provide a custom display format for text of the items. The data format string consists of two parts, separated by a colon, in the form { A: Bxx }. For example, the formatting string {0:F2} would format the text as a fixed point number with two decimal places. Note the entire string must be enclosed in braces to indicate that it is a format string and not a literal string. Any text outside the braces is displayed as literal text. The value before the colon (A in the general example) specifies the parameter index in a zero-based list of parameters. A string value representing the format of the Text property.

Gets or sets the field from the data source that provides values for the Text property of the items.

A string that specifies the field from the data source that provides values for the Text property of the items. The default value is empty string.


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
            RadPanelbar1.DataNavigateUrlField = "URL"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
            RadPanelbar1.DataNavigateUrlField = "URL";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
            RadPanelbar1.DataNavigateUrlField = "URL"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
            RadPanelbar1.DataNavigateUrlField = "URL";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();

Gets or sets the field from the data source that provides values for the Value property of the items.

A string that specifies the field from the data source that provides values for the Value property of the items. The default is empty string.

Gets or sets the skin used by RadPanelbar.

A String specifying the skin. The default value is empty string (""). If the value is empty string ("") no skin is used.

Gets the settings for the animation played when an item opens.

An AnnimationSettings that represents the expand animation. Use the ExpandAnimation property to customize the expand animation of RadPanelbar. You can specify the Type, Duration and the To disable expand animation effects you should set the Type to PanelbarAnimationType.None.
To customize the collapse animation you can use the CollapseAnimation property. The following example demonstrates how to set the ExpandAnimation of RadPanelbar. ASPX: <radP:RadPanelbar ID="RadPanelbar1" runat="server"> <ExpandAnimation Type="OutQuint" Duration="300" /> <Items> <radP:RadPanelItem Text="News" > <Items> <radP:RadPanelItem Text="CNN" NavigateUrl="http://www.cnn.com" /> <radP:RadPanelItem Text="Google News" NavigateUrl="http://news.google.com" /> </Items> </radP:RadPanelItem> <radP:RadPanelItem Text="Sport" > <Items> <radP:RadPanelItem Text="ESPN" NavigateUrl="http://www.espn.com" /> <radP:RadPanelItem Text="Eurosport" NavigateUrl="http://www.eurosport.com" /> </Items> </radP:RadPanelItem> </Items> </radP:RadPanelbar>


            void Page_Load(object sender, EventArgs e)
            {
                RadPanelbar1.ExpandAnimation.Type = PanelbarAnimationType.Linear;
                RadPanelbar1.ExpandAnimation.Duration = 300;
            }


            Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
                RadPanelbar1.ExpandAnimation.Type = PanelbarAnimationType.Linear
                RadPanelbar1.ExpandAnimation.Duration = 300
            End Sub

Gets the settings for the animation played when an item closes.

An AnnimationSettings that represents the collapse animation. Use the CollapseAnimation property to customize the expand animation of RadPanelbar. You can specify the Type, Duration and the items are collapsed.
To disable expand animation effects you should set the Type to PanelbarAnimationType.None. To customize the expand animation you can use the ExpandAnimation property. The following example demonstrates how to set the CollapseAnimation of RadPanelbar. ASPX: <radP:RadPanelbar ID="RadPanelbar1" runat="server"> <CollapseAnimation Type="OutQuint" Duration="300" /> <Items> <radP:RadPanelItem Text="News" > <Items> <radP:RadPanelItem Text="CNN" NavigateUrl="http://www.cnn.com" /> <radP:RadPanelItem Text="Google News" NavigateUrl="http://news.google.com" /> </Items> </radP:RadPanelItem> <radP:RadPanelItem Text="Sport" > <Items> <radP:RadPanelItem Text="ESPN" NavigateUrl="http://www.espn.com" /> <radP:RadPanelItem Text="Eurosport" NavigateUrl="http://www.eurosport.com" /> </Items> </radP:RadPanelItem> </Items> </radP:RadPanelbar>


            void Page_Load(object sender, EventArgs e)
            {
                RadPanelbar1.CollapseAnimation.Type = PanelbarAnimationType.Linear;
                RadPanelbar1.CollapseAnimation.Duration = 300;
            }


            Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
                RadPanelbar1.CollapseAnimation.Type = PanelbarAnimationType.Linear
                RadPanelbar1.CollapseAnimation.Duration = 300
            End Sub

Gets or sets the relative path of the folder containing the skins.

If the skin folder is located in the project root and is named "Skins" the SkinsPath property should be set to: "~/Skins". Then you can create subfolders for individual skins e.g. Skins/Gold, Skins/Default etc. A string specifying the relative path to the folder which contains RadPanelBar skins. The default value is "~/RadControls/Panelbar/Skins". RadPanelBar ships with a set of predefined skins which are ready to use. They are located in RadControls/Panelbar/Skins.


            Dim dbCon As New OleDbConnection("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"))
            dbCon.Open()
             
            Dim adapter As New OleDbDataAdapter("SELECT * FROM Links", dbCon)
            Dim ds As New DataSet()
            adapter.Fill(ds)
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID"
            RadPanelbar1.DataFieldParentID = "ParentID"
            RadPanelbar1.DataNavigateUrlField = "URL"
             
            RadPanelbar1.DataSource = ds
            RadPanelbar1.DataBind()


            OleDbConnection dbCon = new OleDbConnection ("Provider=Microsoft.Jet.OLEDB.4.0;Data Source=" + Server.MapPath("~/Panelbar/Data/data.mdb"));
            dbCon.Open();
             
            OleDbDataAdapter adapter = new OleDbDataAdapter("SELECT * FROM Links", dbCon);
            DataSet ds = new DataSet();
            adapter.Fill(ds);
             
            RadPanelbar1.DataTextField = "TextColumn"
            RadPanelbar1.DataValueField = "ValueColumn"
            RadPanelbar1.DataFieldID = "ID";
            RadPanelbar1.DataFieldParentID = "ParentID";
            RadPanelbar1.DataNavigateUrlField = "URL";
             
            RadPanelbar1.DataSource = ds;            
            RadPanelbar1.DataBind();

Gets or sets the field from the data source that provides values for the NavigateUrl property of the items.

A string that specifies the the field from the data source that provides values for the NavigateUrl property of the items. The default value is empty string.

Occurs on the server when an item in the RadPanelbar control is created.

The ItemCreated event is raised every time a new item is added. The ItemCreated event is not related to data binding and you cannot retrieve the DataItem of the item in the event handler. The ItemCreated event is often useful in scenarios where you want to initialize all items - for example setting the ToolTip of each RadPanelItem to be equal to the Text property. The following example demonstrates how to use the ItemCreated event to set the ToolTip property of each item.


            private void RadPanelbar1_ItemCreated(object sender, Telerik.WebControls.PanelItemEventArgs e)
            {
                e.Item.ToolTip = e.Item.Text;
            }


            Sub RadPanelbar1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.WebControls.PanelItemEventArgs) Handles RadPanelbar1.ItemCreated
                e.Item.ToolTip = e.Item.Text
            End Sub

Occurs on the server when a panel item in the RadPanelbar control is clicked.

The panelbar will also postback if you navigate to a panel item using the [panel item] key and then press [enter] on the panel item that is focused. The instance of the clicked panel item is passed to the ItemClick event handler - you can obtain a reference to it using the eventArgs.RadPanelItem property.

Occurs after a panel item is data bound.

The ItemDataBound event is raised for each panel item upon databinding. You can retrieve the item being bound using the event arguments. The DataItem associated with the item can be retrieved using the DataItem property. The ItemDataBound event is often used in scenarios when you want to perform additional mapping of fields from the DataItem to their respective properties in the RadPanelItem class. The following example demonstrates how to map fields from the data item to item properties using the ItemDataBound event.


            private void RadPanelbar1_ItemDataBound(object sender, Telerik.WebControls.RadPanelbarEventArgs e)
            {
                RadPanelItem item = e.Item;
                DataRowView dataRow = (DataRowView) e.Item.DataItem;
             
                item.ImageUrl = "image" + dataRow["ID"].ToString() + ".gif";
                item.NavigateUrl = dataRow["URL"].ToString();
            }


            Sub RadPanelbar1_ItemDataBound(ByVal sender As Object, ByVal e As RadPanelbarEventArgs) Handles RadPanelbar1.ItemDataBound
                Dim item As RadPanelItem = e.Item
                Dim dataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
             
                item.ImageUrl = "image" + dataRow("ID").ToString() + ".gif"
                item.NavigateUrl = dataRow("URL").ToString()
            End Sub

Gets of sets a value indicating the behavior of RadPanelbar when an item is expanded.

One of the PanelbarExpandMode Enumeration values. The default value is MultipleExpandedItems. Use the ExpandMode property to specify the way RadPanelbar should behave after an item is expanded. The available options are: MultipleExpandedItems (default) - More than one item can be expanded at a time. SingleExpandedItem - Only one item can be expanded at a time. Expanding another item collapses the previously expanded one. FullExpandedItem - Only one item can be expanded at a time. The expanded area occupies the entire height of the RadPanelbar. The Height property should be set in order RadPanelbar to operate correctly in this mode.

Gets or sets a value indicating the client-side event handler that is called before the browser context menu shows (after right-clicking an item).

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. Use the OnClientContextMenu property to specify a JavaScript function that will be executed before the context menu shows after right clicking an item. Two parameters are passed to the handler sender (the client-side RadPanelbar object) eventArgs with two properties

Item - the instance of the selected item
EventObject - the browser DOM event

The following example demonstrates how to use the OnClientContextMenu property. <script language="javascript">
function OnContextMenuHandler(sender, eventArgs)
{
var panelbar = sender;
var item = eventArgs.Item;

alert("You have right-clicked the " + item.Text + " item in the " + panelbar.ID + "panelbar.");
}
</script> <radP:RadPanelbar id="RadPanelbar1" runat="server" OnClientContextMenu="OnContextMenuHandler">
<Items>
<radP:RadPanelItem Text="Personal Details"></radP:RadPanelItem>
<radP:RadPanelItem Text="Education"></radP:RadPanelItem>
<radP:RadPanelItem Text="Computing Skills"></radP:RadPanelItem>
</Items>
</radP:RadPanelbar> This event is similar to OnClientItemFocus but fires only on mouse click. If specified, the OnClientItemClicking client-side event handler is called before a panel item is clicked upon. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). The OnClientItemClicking event can be cancelled. To do so, return False from the event handler.

Gets or sets a value indicating the client-side event handler that is called when a panel item is clicked.

Gets or sets a value indicating the client-side event handler that is called after a panel item is clicked.

This event is similar to OnClientItemFocus but fires only on mouse click. If specified, the OnClientItemClicked client-side event handler is called after a panel item is clicked upon. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled. <script type="text/javascript">
function OnClientItemClickedHandler(sender, eventArgs)
{
alert(eventArgs.Item.Text);
}
</script>
<radP:RadPanelbar ID="RadPanelbar1"
runat="server"
OnClientItemClicked="OnClientItemClickedHandler">
....
</radP:RadPanelbar> A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called when a panel item gets focus.

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. <script type="text/javascript">
function OnClientItemFocusHandler(sender, eventArgs)
{
alert(eventArgs.Item.Text);
}
</script> <radP:RadPanelbar ID="RadPanelbar1"
runat="server"
OnClientItemFocus="OnClientItemFocusHandler">
....
</radP:RadPanelbar> If specified, the OnClientItemFocus client-side event handler is called when a panel item is selected using either the keyboard (the [TAB] or arrow keys) or by clicking it. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled.

Gets or sets a value indicating the client-side event handler that is called after an item loses focus.

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. If specified, the OnClientItemBlur client-side event handler is called when a panel item loses focus as a result of the user pressing a key or clicking elsewhere on the page. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled. <script type="text/javascript">
function OnClientItemBlurHandler(sender, eventArgs)
{
alert(eventArgs.Item.Text);
}
</script> <radP:RadPanelbar ID="RadPanelbar1"
runat="server"
OnClientItemBlur="OnClientItemBlurHandler">
....
</radP:RadPanelbar>

Gets or sets a value indicating the client-side event handler that is called when a group of child items expands.

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. If specified, the OnClientItemOpen client-side event handler is called when a group of child items opens. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled. <script type="text/javascript">
function OnClientItemExpandHandler(sender, eventArgs)
{
alert(eventArgs.Item.Text);
}
</script> <radP:RadPanelbar ID="RadPanelbar1"
runat="server"
OnClientItemExpand="OnClientItemExpandHandler">
....
</radP:RadPanelbar>

Gets or sets a value indicating the client-side event handler that is called when a group of child items collapses.

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. <script type="text/javascript">
function OnClientItemCollapseHandler(sender, eventArgs)
{
alert(eventArgs.Item.Text);
}
</script> <radP:RadPanelbar ID="RadPanelbar1"
runat="server"
OnClientItemCollapse="OnClientItemCollapseHandler">
....
</radP:RadPanelbar> If specified, the OnClientItemClose client-side event handler is called when a group of child items closes. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled. If specified, the OnClienLoad client-side event handler is called after the panelbar is fully initialized on the client. A single parameter - the panelbar client object - is passed to the handler. This event cannot be cancelled. <script type="text/javascript">
function OnClientLoadHandler(sender)
{
alert(sender.ID);
}
</script> <radP:RadPanelbar ID="RadPanelbar1"
runat= "server"
OnClientLoad= "OnClientLoadHandler">
....
</radP:RadPanelbar> A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

Gets or sets a value indicating the client-side event handler that is called after the RadPanelbar client-side object is initialized.

Gets or sets a value indicating the client-side event handler that is called when the mouse moves over a panel item in the RadPanelbar control.

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. If specified, the OnClientMouseOverclient-side event handler is called when the mouse moves over a panel item. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled. The following example demonstrates how to use the OnClientMouseOver property.

<radP:RadPanelbar ID="RadPanelbar1"
runat= "server"
OnClientMouseOver= "OnClientMouseOverHandler">
....
</radP:RadPanelbar>

If specified, the OnClientMouseOut client-side event handler is called when the mouse moves out of a panel item. Two parameters are passed to the handler: sender, the panelbar client object; eventArgs with one property, Item (the instance of the panel item). This event cannot be cancelled.

Gets or sets a value indicating the client-side event handler that is called when the mouse moves out of a panel item in the RadPanelbar control.

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string. <script type="text/javascript">
function OnClientMouseOutHandler(sender, eventArgs)
{
alert(eventArgs.Item.Text);
}
</script> <radP:RadPanelbar ID="RadPanelbar1"
runat= "server"
OnClientMouseOut= "OnClientMouseOutHandler">
....
</radP:RadPanelbar>

Gets or sets a value indicating whether the control would persists its state between pages (expanded and selected items).

true if the control would persist its state; false otherwise. The default value is false. Use the PersistStateInCookie property to make RadPanelbar persist its state between pages. This feature requires browser cookies to be enabled. Also the ClientID and ID properties of the RadPanelbar control must be the same in all pages accessible via the control (and containing it). Page1.aspx: <radP:RadPanelbar ID="RadPanelbar1" > ... </radP:RadPanelbar> Page2.aspx <radP:RadPanelbar ID="RadPanelbar1" > ... </radP:RadPanelbar>

Gets or sets the data member to bind to a menu item.

When creating a RadPanelItemBinding object, you must specify the criteria for binding. The criteria indicate when a data item should be bound to a menu item. You can specify the Depth property, the DataMember property, or both. When the data source contains multiple elements or tables, use the DataMember property to specify the element or table to bind to a menu item. A data member specifies the type of the data item in the underlying data source, but can represent different information depending on the data source. Each data item in a hierarchical data source exposes a IHierarchyData.Type property, which specifies the type of the data item. For example, the data member for an XML element specifies the name of the element. The following RadPanelItemBinding declaration binds the


            			<Book>

elements of an XmlDataSource control to all the menu items in the menu, regardless of the location in the hierarchy:

            <asp:RadPanelItemBinding DataMember="Book" TextField="Title" ValueField= "ISBN">


            			<Item>

elements that appear at different levels within an XML file. The following RadPanelItemBinding declarations show how to specify menu item bindings that apply to identical data members at different menu depths:


            			<asp:RadPanelItemBinding DataMember="Item" Depth="1" TextField="Title">


            			<asp:RadPanelItemBinding DataMember="Item" Depth="2" TextField="ISBN">

If a menu item binding is defined without a depth or a data member, the menu item binding is applied to all menu items within the menu. This is commonly used when all data items have the same properties and should be displayed identically, regardless of the menu depth. After the binding criteria are established, you can then bind a property of a RadMenuItem object that can be bound to a value. You can bind to a field of a data item or to a static value. When bound to a static value, all RadMenuItem objects to which the RadPanelItemBinding object is applied share the same value. Properties bound to fields contain the values of the field from the data source. If conflicting RadPanelItemBinding objects are defined, the Menu control applies the menu item bindings in the following order of precedence: The RadPanelItemBinding object that defines and matches both a depth and a data member. The RadPanelItemBinding object that defines and matches the data member only. The RadPanelItemBinding object that defines and matches the depth only. The RadPanelItemBinding object that defines neither the depth nor the data member. (This type of menu item binding is applied to all menu items in the menu.) The RadPanelItemBinding object that does not have a match in the data source. In this case, the value returned by the ToString() method of the data item is then bound to the Text and Value properties of the menu items to which the RadPanelItemBinding object is applied.

Gets or sets the text caption for the item.

The text of the item. The default value is empty string. This example demonstrates how to set the text of the item using the Text property. <radM:RadMenu ID="RadMenu1" runat="server">
<Items>
<radM:RadMenuItem Text="News" />
<radM:RadMenuItem Text="News" />
</Items>
</radM:RadMenu> Specifying Text or TextField will override the values populated from the DataTextField property.

Gets or sets the name of the field from the data source to bind to the Text property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the Text of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set. Specifying Text or TextField will override the values populated from the DataTextField property.

Gets or sets the value associated with the item.

The value associated with the item. The default value is empty string. Use the Value property to specify or determine the value associated with the item. Specifying Value or ValueField will override the values populated from the DataValueField property.

Gets or sets the name of the field from the data source to bind to the Value property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the Value of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set. Specifying Value or ValueField will override the values populated from the DataValueField property.

Gets or sets the URL to link to when the item is clicked.

The URL to link to when the item is clicked. The default value is empty string. The following example demonstrates how to use the NavigateUrl property <radM:RadMenu id="RadMenu1" runat="server">
<Items>
<radM:RadMenuItem Text="News" NavigateUrl="~/News.aspx" />
<radM:RadMenuItem Text="External URL" NavigateUrl="http://www.example.com" />
</Items>
</radM:RadMenu> Use the NavigateUrl property to specify the URL to link to when the item is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET application. When specifying external URL do not forget the protocol (e.g. "http://"). Specifying NavigateUrl or NavigateUrlField will override the values populated from the DataNavigateUrlField property.

Gets or sets the name of the field from the data source to bind to the NavigateUrl property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the NavigateUrl of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set. Specifying %NavigateUrl:NavigateUrl% or NavigateUrlField will override the values populated from the DataNavigateUrlField property.

Gets or sets the ToolTip text for a menu item to which the RadPanelItemBinding object is applied.

The ToolTip text for a menu item to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set.

Gets or sets the name of the field from the data source to bind to the ToolTip property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the ToolTip of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set.

Gets or sets the URL to an image that is displayed next to the text of a menu item to which the RadPanelItemBinding object is applied.

The URL to an image that is displayed next to the text of a menu item to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set. This image is shared with all RadMenuItem objects to which the RadPanelItemBinding object is applied. NOTE: You can override the image for an individual menu item by setting its ImageUrl property directly. Instead of using this property to display the same image in each menu item, you can also use the ImageUrlField property to bind the ImageUrl property of a RadMenuItem object to a field of a data source. When rendered, the ImageUrl property of each menu item to which the RadPanelItemBinding object is applied contains the corresponding value from the field. NOTE: If the ImageUrl and ImageUrlField properties are both set, the ImageUrlField property takes precedence. You can override the image for an individual menu item by setting its ImageUrl property directly.

Gets or sets the name of the field from the data source to bind to the ImageUrl property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the ImageUrl of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set. If the data source contains multiple tables or attributes, you must first establish the binding criteria by setting the Depth property, the DataMember property, or both. Instead of using this property to bind the ImageUrl property of a RadMenuItem object to a field, you can also bind it to a static value by setting the RadPanelItemBinding.ImageUrl property. This allows you to display the same image in each menu item to which the RadPanelItemBinding object is applied. NOTE: If the ImageUrl and ImageUrlField properties are both set, the ImageUrlField property takes precedence.

Gets or sets the path to an image to display for the item when the user moves the mouse over the item.

The path to the image to display when the user moves the mouse over the item. The default value is empty string. <radm:RadMenu id="RadMenu1" runat="server">
<Items>
<radm:RadMenuItem ImageUrl="~/Img/inbox.gif" ImageOverUrl="~/Img/inboxOver.gif" Text="Index" />
<radm:RadMenuItem ImageUrl="~/Img/outbox.gif" ImageOverUrl="~/Img/outboxOver.gif" Text="Outbox" />
</Items>
</radm:RadMenu> Use the ImageOverUrl property to specify the image that will be used when the user moves the mouse over the item. If the ImageOverUrl property is set to empty string the image specified by the ImageUrl property will be used. Use "~" (tilde) when referring to images within the current ASP.NET application.

Gets or sets the name of the field from the data source to bind to the ImageOverUrl property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the ImageOverUrl of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set.

Gets or sets the target window or frame to display the Web page content linked to when the menu item is clicked.

The target window or frame to load the Web page linked to when the Item is selected. Values must begin with a letter in the range of a through z (case insensitive), except for the following special values, which begin with an underscore: _blank Renders the content in a new window without frames. _parent Renders the content in the immediate frameset parent. _self Renders the content in the frame with focus. _top Renders the content in the full window without frames. The default value is empty string. Use the Target property to specify the frame or window that displays the Web page linked to when the menu item is clicked. The Web page is specified by setting the NavigateUrl property. If this property is not set, the Web page specified by the NavigateUrl property is loaded in the current window. The following example demonstrates how to use the Target property ASPX: <radM:RadMenu runat="server" ID="RadMenu1"> <Items> <radM:RadMenuItem Target="_blank" NavigateUrl="http://www.google.com" /> </Items> </radM:RadMenu>

Gets or sets the name of the field from the data source to bind to the Target property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the Target of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set.

Gets or sets a value indicating whether the menu item is enabled.

Use the Enabled property to specify or determine whether a menu item is functional. When set to false, the item appears dimmed.

Gets or sets the name of the field from the data source to bind to the Enabled property of a RadMenuItem object to which the RadPanelItemBinding object is applied.

The name of the field from the data source to bind to the Enabled of a RadMenuItem to which the RadPanelItemBinding is applied. The default is an empty string (""), which indicates that this property is not set.

Gets or sets the menu depth to which the RadPanelItemBinding object is applied.

When creating a RadPanelItemBinding object, you must specify the criteria for binding. The criteria indicate when a data item should be bound to a menu item. You can specify the Depth property, the DataMember property, or both. Use the Depth property to specify the menu depth at which to apply the RadPanelItemBinding object. For example, the following RadPanelItemBinding declaration binds the Name and ID fields of the data source to the Text and Value properties, respectively, of all menu items with a depth of 0:

            <asp:RadPanelItemBinding Depth="0" TextField="Name" ValueField="ID">

Sometimes you might need to create a menu item binding that specifies both a depth and a data member. This is often used when the data source contains items at different levels that have the same data member value. For example, you can have
<Item> elements that appear at different levels within an XML file. The following RadPanelItemBinding declarations show how to specify menu item bindings that apply to identical data members at different menu depths:

            		
            			<asp:RadPanelItemBinding DataMember="Item" Depth="1" TextField="Title">

            		
            			<asp:RadPanelItemBinding DataMember="Item" Depth="2" TextField="ISBN">

If a menu item binding is defined without a depth and a data member, the menu item binding is applied to all menu items within the menu. This is commonly used when all data items have the same properties and should be displayed identically, regardless of the menu depth. After the binding criteria are established, you can then bind a property of a RadMenuItem object that can be bound to a value. You can bind to a field of a data item or to a static value. When bound to a static value, all RadMenuItem objects to which the RadPanelItemBinding object is applied share the same value. Properties bound to fields contain the values of the field from the data source. If conflicting RadPanelItemBinding objects are defined, the Menu control applies the menu item bindings in the following order of precedence: The RadPanelItemBinding object that defines and matches both a depth and a data member. The RadPanelItemBinding object that defines and matches the data member only. The RadPanelItemBinding object that defines and matches the depth only. The RadPanelItemBinding object that defines neither the depth nor the data member. (This type of menu item binding is applied to all menu items in the menu.) The RadPanelItemBinding object that does not have a match in the data source. In this case, the value returned by the ToString() method of the data item is then bound to the Text and Value properties of the menu items to which the RadPanelItemBinding object is applied.

Gets or sets the string that specifies the display format for the text of a menu item to which the RadPanelItemBinding object is applied.

Utility class for Design - Time VisualStudio.NET project management.

Defines the common property categories' names

Represents the different ways RadPanelbar behaves when an item is expanded.

More than one item can be expanded at a time.

Only one item can be expanded at a time. Expanding another item collapses the previously expanded one.

Only one item can be expanded at a time. The expanded area occupies the entire height of the RadPanelbar.

Represents the animation settings used for expand or collapse effects.

RadPanelbar supports a wide variety of animation effects which are represented by the PanelbarAnimationSettings class. To customize the animation played when items are opened use the ExpandAnimation property. To customize the animation played when items are closed use the CollapseAnimation property.

Gets or sets the effect that will be used for the animation.

On of the PanelbarAnimationType values. The default value is None. Use the Type property of the PanelbarAnimationSettings class to customize the effect used for the animation. To turn off animation effects set this property to None.

Gets or sets the duration in milliseconds of the animation.

An integer representing the duration in milliseconds of the animation.

Represents the effects that can be used in an animation.

Represents a single item in the RadPanelbar control.

The RadPanelbar control is made up of a hierarchy of panel items represented by RadPanelItem objects. Panel items at the top level (level 0) are called root panel items. A panel item that has a parent panel item is called subpanel item. All root panel items are stored in the Items collection of the panel. Subpanel items are stored in a parent panel item's Items collection. You can access a panel item's parent panel item by using the Owner property. To create the panel items for a RadPanelbar control, use one of the following methods: Use declarative syntax to create static panel items. Use a constructor to dynamically create new instances of the RadPanelItem class. These RadPanelItem objects can then be added to the Items collection of their owner. Bind the RadPanelbar control to a data source. When the user clicks a panel item, the panel control can either navigate to a linked Web page or simply post back to the server. If the NavigateUrl property of a panel item is set, the RadPanelbar control navigates to the linked page. By default, a linked page is displayed in the same window or frame as the RadPanelbar control. To display the linked content in a different window or frame, use the Target property. Each panel item has a Text and a Value property. The value of the Text property is displayed in the RadPanelbar control, while the Value property is used to store any additional data about the panel item.

Initializes a new instance of the RadPanelItem class.

Use this constructor to create and initialize a new instance of the RadPanelItem class using default values. The following example demonstrates how to add items to RadPanelbar controls.


            RadPanelItem item = new RadPanelItem();
            item.Text = "News";
            item.NavigateUrl = "~/News.aspx";
             
            RadPanelbar1.Items.Add(item);


            Dim item As New RadPanelItem()
            item.Text = "News"
            item.NavigateUrl = "~/News.aspx"
             
            RadPanelbar1.Items.Add(item)

Initializes a new instance of the RadPanelItem class with the specified text data.

Use this constructor to create and initialize a new instance of the RadPanelItem class using the specified text. The following example demonstrates how to add items to RadPanelbar controls.


            RadPanelItem item = new RadPanelItem("News");
             
            RadPanelbar1.Items.Add(item);


            Dim item As New RadPanelItem("News")
             
            RadPanelbar1.Items.Add(item)

The text of the item. The Text property is set to the value of this parameter.

Expands all parent items so the item is visible.

Initializes a new instance of the RadPanelItem class with the specified text and URL to navigate to.

Use this constructor to create and initialize a new instance of the RadPanelItem class using the specified text and URL. This example demonstrates how to add items to RadPanelbar controls.


            RadPanelItem item = new RadPanelItem("News", "~/News.aspx");
             
            RadPanelbar1.Items.Add(item);


            Dim item As New RadPanelItem("News", "~/News.aspx")
             
            RadPanelbar1.Items.Add(item)

The text of the item. The Text property is set to the value of this parameter. The url which the item will navigate to. The NavigateUrl property is set to the value of this parameter.

Creates a copy of the current RadPanelItem object.

A RadPanelItem which is a copy of the current one. Use the Clone method to create a copy of the current item. All properties of the clone are set to the same values as the current ones. Child items are not cloned.

Gets or sets a value indicating whether the item is selected.

true if the item is selected; otherwise, false. The default is false. true if the item is selected; otherwise false. The default value is false. Use the Selected property to determine whether the item is currently selected.

Gets or sets a value indicating whether the panel item is expanded.

true if the panel item is expanded; otherwise, false. The default is false.

This property is being used internally by the RadPanelbar control. Setting it may lead to unpredictable results.

The ID property is used internally. Use the Value property to store any item related data.

Gets the IRadPanelItemContainer which contains the item.

The object which contains the item. It might be an instance of the RadPanelbar class or the RadPanelItem class depending on the hierarchy level. The value is of the IRadPanelItemContainer type which is implemented by the RadPanelbar class and the RadPanelItem class. Use the Owner property when recursively traversing RadPanelbar.

Gets the collection of child items.

A RadPanelItemCollection that represents the child items. Use this property to retrieve the child items. You can also use it to programmatically add or remove items.

Gets the zero based index of the item in the Items collection of its parent.

An integer specifying the zero based index of the item considering the RadPanelItemCollection that contains it.

Gets or sets the text caption for the panel item.

The text of the item. The default value is empty string. This example demonstrates how to set the text of the item using the Text property. <radP:RadPanelbar ID="RadPanelbar1" runat="server">
<Items>
<radP:RadPanelItem Text="News" />
<radP:RadPanelItem Text="News" />
</Items>
</radP:RadPanelbar> Use the Text property to specify the text to display for the item.

Gets or sets the value associated with the panel item.

The value associated with the item. The default value is empty string. Use the Value property to specify or determine the value associated with the item.

Gets or sets the target window or frame to display the Web page content linked to when the panel item is clicked.

The target window or frame to load the Web page linked to when the Item is selected. Values must begin with a letter in the range of a through z (case insensitive), except for the following special values, which begin with an underscore: _blank Renders the content in a new window without frames. _parent Renders the content in the immediate frameset parent. _self Renders the content in the frame with focus. _top Renders the content in the full window without frames. The default value is empty string. Use the Target property to specify the frame or window that displays the Web page linked to when the panel item is clicked. The Web page is specified by setting the NavigateUrl property. If this property is not set, the Web page specified by the NavigateUrl property is loaded in the current window.

Gets or sets the URL to link to when the item is clicked.

The URL to link to when the item is clicked. The default value is empty string. The following example demonstrates how to use the NavigateUrl property <radP:RadPanelbar id="RadPanelbar1" runat="server">
<Items>
<radP:RadPanelItem Text="News" NavigateUrl="~/News.aspx" />
<radP:RadPanelItem Text="External URL" NavigateUrl="http://www.example.com" />
</Items>
</radP:RadPanelbar> Use the NavigateUrl property to specify the URL to link to when the item is clicked. Use "~" (tilde) in front of an URL within the same ASP.NET application. When specifying external URL do not forget the protocol (e.g. "http://").

Gets or sets the data item represented by the item.

An object representing the data item to which the Item is bound to. The DataItem property will always return null when accessed outside of ItemDataBound event handler. This property is applicable only during data binding. Use it along with the ItemDataBound event to perform additional mapping of fields from the data item to RadPanelItem properties. The following example demonstrates how to map fields from the data item to %RadPanelItem properties. It assumes the user has subscribed to the ItemDataBound:RadPanelbar.ItemDataBound event.:RadPanelItem%


            private void RadPanelbar1_PanelItemDataBound(object sender, Telerik.WebControls.RadPanelbarEventArgs e)
            {
                RadPanelItem item = e.Item;
                DataRowView dataRow = (DataRowView) e.Item.DataItem;
             
                item.ImageUrl = "image" + dataRow["ID"].ToString() + ".gif";
                item.NavigateUrl = dataRow["URL"].ToString();
            }


            Sub RadPanel1_PanelItemDataBound(ByVal sender As Object, ByVal e As RadPanelbarEventArgs) Handles RadPanelbar1.ItemDataBound
                Dim item As RadPanelItem = e.Item
                Dim dataRow As DataRowView = CType(e.Item.DataItem, DataRowView)
             
                item.ImageUrl = "image" + dataRow("ID").ToString() + ".gif"
                item.NavigateUrl = dataRow("URL").ToString()
            End Sub

Gets or sets the template for displaying the item.

A ITemplate implemented object that contains the template for displaying the item. The default value is a null reference (Nothing in Visual Basic), which indicates that this property is not set. To specify common display for all panel items use the ItemTemplate property of the RadPanelbar class. The following template demonstrates how to add a Calendar control in certain panel item. ASPX: <radP:RadPanelbar runat="server" ID="RadPanelbar1">

<Items>
<radP:RadPanelItem Text="Date">
<Items>
<radP:RadPanelItem Text="SelectDate">
<ItemTemplate>
<asp:Calendar runat="server" ID="Calendar1" />
</ItemTemplate>
</radP:RadPanelItem>
</Items>
</radP:RadPanelItem>
</Items>

</radP:RadPanelbar>

Manages the item level of a particular Item instance. This property allows easy implementation/separation of the panel items in levels.

Gets or sets a value indicating the position of the image within the item.

One of the RadPanelItemImagePosition Enumeration values. The default value is Left.

Gets or sets the path to an image to display for the item.

The path to the image to display for the item. The default value is empty string. Use the ImageUrl property to specify the image for the item. If the ImageUrl property is set to empty string no image will be rendered. Use "~" (tilde) when referring to images within the current ASP.NET application.

Gets or sets the path to an image to display for the item when the user moves the mouse over the item.

The path to the image to display when the user moves the mouse over the item. The default value is empty string. Use the ImageOverUrl property to specify the image that will be used when the user moves the mouse over the item. If the ImageOverUrl property is set to empty string the image specified by the ImageUrl property will be used. Use "~" (tilde) when referring to images within the current ASP.NET application.

Gets or sets the path to an image to display for the item when it is disabled.

The path to the image to display for the item. The default value is empty string. Use the DisabledImageUrl property to specify the image for the item when it is disabled. If the DisabledImageUrl property is set to empty string no image will be rendered. Use "~" (tilde) when referring to images within the current ASP.NET application.

Gets or sets the path to an image to display for the item when it is selected.

The path to the image to display for the item. The default value is empty string. Use the SelectedImageUrl property to specify the image for the item when it is disabled. If the SelectedImageUrl property is set to empty string no image will be rendered. Use "~" (tilde) when referring to images within the current ASP.NET application.

Gets or sets the path to an image to display for the item when it is expanded.

The path to the image to display for the item. The default value is empty string. Use the ExpandedImageUrl property to specify the image for the item when it is expanded. If the ExpandedImageUrl property is set to empty string no image will be rendered. Use "~" (tilde) when referring to images within the current ASP.NET application.

Sets or gets whether the item is separator. It also represents a logical state of the item. Might be used in some applications for keyboard navigation to omit processing items that are marked as separators.

Gets the RadPanelbar instance which contains the item.

Use this property to obtain an instance to the RadPanelbar object containing the item.

Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is clicked.

The CSS class applied when the panel item is clicked. The default value is "clicked". By default the visual appearance of clicked panel items is defined in the skin CSS file. You can use the ClickedCssClass property to specify unique appearance for the panel item when it is clicked.

Gets or sets the Cascading Style Sheet (CSS) class applied to the element enclosing the child items.

The default value is empry string.

Gets or sets the height of the child item group.

A Unit that represents the height of the child item group. The default value is Empty. If the total child group height exceeds the value specified with the ChildGroupHeight property scrolling will be applied.

Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is disabled.

The CSS class applied when the panel item is disabled. The default value is "disabled". By default the visual appearance of disabled panel items is defined in the skin CSS file. You can use the DisabledCssClass property to specify unique appearance for the panel item when it is disabled.

Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is selected.

The CSS class applied when the panel item is selected. The default value is "selected". By default the visual appearance of selected panel items is defined in the skin CSS file. You can use the SelectedCssClass property to specify unique appearance for the panel item when it is selected.

Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is opened (its child items are visible).

The CSS class applied when the panel item is opened. The default value is "expanded". By default the visual appearance of opened panel items is defined in the skin CSS file. You can use the ExpandedCssClass property to specify unique appearance for the panel item when it is opened.

Gets or sets the Cascading Style Sheet (CSS) class applied when the panel item is focused.

The CSS class applied when the panel item is focused. The default value is "focused". By default the visual appearance of focused panel items is defined in the skin CSS file. You can use the FocusedCssClass property to specify unique appearance for the panel item when it is focused.

Gets or sets a value indicating whether clicking on the item will postback.

True if the panel item should postback; otherwise false. By default all the items will postback provided the user has subscribed to the ItemClick event. If you subscribe to the ItemClick all panel items will postback. To turn off that behavior you should set the PostBack property to false. This property cannot be set in design time.

A collection of RadPanelItem objects in a RadPanelbar control.

The RadPanelItemCollection class represents a collection of RadPanelItem objects. The RadPanelItem objects in turn represent panel items within a RadPanelbar control. Use the indexer to programmatically retrieve a single RadPanelItem from the collection, using array notation. Use the Count property to determine the total number of panel items in the collection. Use the Add method to add panel items in the collection. Use the Remove method to remove panel items from the collection.

Initializes a new instance of the RadPanelItemCollection class.

Use the constructor to create a new RadPanelItemCollection class. The owner of the collection.

Appends a RadPanelItem to the end of the collection.

The following example demonstrates how to programmatically add items in a RadPanelbar control.


            RadPanelItem newsItem = new RadPanelItem("News");
             
            RadPanelbar1.Items.Add(newsItem);


            Dim newsItem As RadPanelItem = New RadPanelItem("News")
             
            RadPanelbar1.Items.Add(newsItem)

Adds the items in an array of RadPanelItem objects to the collection.

Use the AddRange method to add the items in the array of RadPanelItem objects specified by the items parameter. This allows you to add multiple RadPanelItem objects to the collection in a single step. The following example demonstrates how to use the AddRange method to add multiple items in a single step.


            void Page_Load(object sender, EventArgs e)
            {
                if (!Page.IsPostBack)
                {
                    RadPanelItem[] items = new RadPanelItem[] { new RadPanelItem("First"), new RadPanelItem("Second"), new RadPanelItem("Third") };
                    RadPanelbar1.Items.AddRange(items);
                }
            }


            Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
                If Not Page.IsPostBack Then
                    Dim items() As RadPanelItem = {New RadPanelItem("First"), New RadPanelItem("Second"), New RadPanelItem("Third")}
                    RadPanelbar1.Items.AddRange(items)
                End If
            End Sub

Inserts the specified RadPanelItem in the collection at the specified index location.

Use the Insert method to add a RadPanelItem to the collection at the index specified by the index parameter. The location in the collection to insert the RadPanelItem. The RadPanelItem to add to the collection.

Determines the index value that represents the position of the specified RadPanelItem in the collection.

The zero-based index position of the specified RadPanelItem in the collection. Use the IndexOf method to determine the index value of the RadPanelItem specified by the item parameter in the collection. If an item with this criteria is not found in the collection, -1 is returned. A RadPanelItem to search for in the collection.

Determines whether the collection contains the specified RadPanelItem.

true if the collection contains the specified item; otherwise, false. Use the Contains method to determine whether the RadPanelItem specified by the item parameter is in the collection. A RadPanelItem to search for in the collection.

Removes the specified RadPanelItem from the collection.

Use the Remove method to remove a RadPanelItem from the collection. The following example demonstrates how to programmatically remove a RadPanelItem from a RadPanelbar control.


            RadPanelItem newsItem = RadPanelbar1.FindItemByText("News");
            if (newsItem != null)
            {
                RadPanelbar1.Items.Remove(newsItem);
            }


            Dim newsItem As RadPanelItem = RadPanelbar1.FindItemByText("News")
            If Not newsItem Is Nothing Then
                RadPanelbar1.Items.Remove(newsItem)
            End If

Removes the RadPanelItem at the specified index from the collection.

Use the RemoveAt method to remove the RadPanelItem at the specified index from the collection. The index of the RadPanelItem to remove.

Removes all items from the collection.

Use the Clear method to remove all items from the collection. The Count property is set to 0.

Searches the RadPanelItemCollection for the first RadPanelItem with a Text property equal to the specified value.

Searches the RadPanelItemCollection for the first RadPanelItem with a Value property equal to the specified value.

Searches the RadPanelItemCollection for the first Item with a NavigateUrl property equal to the specified value.

A Item whose NavigateUrl property is equal to the specified value. The method returns the first Item matching the search criteria. If no Item is matching then null (Nothing in VB.NET) is returned. The value to search for.

Gets a RadPanelItem at the specified index in the collection.

Use this indexer to get a RadPanelItem from the collection at the specified index, using array notation. The zero-based index of the RadPanelItem to retrieve from the collection.

The position of the image within a panel item.

The image is rendered leftmost.

The image is rendered rightmost.