RadListBox

Gets or sets a value indicating whether to update the underlying datasource after postback caused by reorder, delete or transfer.

public bool AllowAutomaticUpdates { get; set; }

Property Value:

true if the datasource should be update; otherwise, false. The default value is false.

Automatic updates require postback so the AutoPostBackOnDelete, AutoPostBackOnReorder or AutoPostBackOnTransfer should be set to true depending on the requirements.

AllowDelete

Gets or sets a value indicating whether RadListBox displays the delte button.

[ClientControlProperty]
public bool AllowDelete { get; set; }

Property Value:

true if delete button is displayed; otherwise, false. The default value is false.

AllowReorder

Gets or sets a value indicating whether RadListBox displays the reordering buttons.

[ClientControlProperty]
public bool AllowReorder { get; set; }

Property Value:

true if reordering UI is displayed; otherwise, false. The default value is false.

AllowTransfer

Gets or sets a value indicating whether RadListBox displays the transfer buttons.

[ClientControlProperty]
public bool AllowTransfer { get; set; }

Property Value:

true if transfer UI is displayed; otherwise, false. The default value is false.

AllowTransferDuplicates

Gets or sets a value indicating whether the user can transfer the same item more than once.

[ClientControlProperty]
public bool AllowTransferDuplicates { get; set; }

Property Value:

true if the user should be able to transfer the same item more than once; otherwise, false. The default value is false.

The property should only be used together with SelectionType="Copy"

AllowTransferOnDoubleClick

Gets or sets a value indicating whether the double click on a item causes transfer

[ClientControlProperty]
[ClientPropertyName("_allowTransferOnDblClick")]
public bool AllowTransferOnDoubleClick { get; set; }

Property Value:

true if the user should be able to transfer items with double click; otherwise, false. The default value is false.

AriaLabel

Gets or sets the value of the aria-label attribute rendered on the RadListBox root element when EnableAriaSupport is true.

public string AriaLabel { get; set; }

AutoPostBack

Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the RadListBox selection.

[Bindable(false)]
[ClientControlProperty]
public bool AutoPostBack { get; set; }

Set this property to true if the server needs to capture the selection as soon as it is made. For example, other controls on the Web page can be automatically filled depending on the user's selection from a list control.

This property can be used to allow automatic population of other controls on the Web page based on a user's selection from a list.

The value of this property is stored in view state.

The server-side event that is fired is SelectedIndexChanged.

AutoPostBackOnDelete

Gets or sets a value indicating whether RadListBox should post back after delete.

[ClientControlProperty]
public bool AutoPostBackOnDelete { get; set; }

Property Value:

true if RadListBox should postback after delete; otherwise, false. The default value is false.

AutoPostBackOnReorder

Gets or sets a value indicating whether RadListBox should post back after reorder.

[ClientControlProperty]
public bool AutoPostBackOnReorder { get; set; }

Property Value:

true if RadListBox should postback after reorder; otherwise, false. The default value is false.

AutoPostBackOnTransfer

Gets or sets a value indicating whether RadListBox should post back after transfer.

[ClientControlProperty]
public bool AutoPostBackOnTransfer { get; set; }

Property Value:

true if RadListBox should postback after transfer; otherwise, false. The default value is false.

ButtonSettings

ListBoxButtonSettings

Used to customize the appearance and position of the buttons displayed by RadListBox.

[PersistenceMode(PersistenceMode.InnerProperty)]
public ListBoxButtonSettings ButtonSettings { get; }

CheckBoxes

When set to true displays a checkbox next to each item.

[ClientControlProperty]
[ClientPropertyName("_checkBoxes")]
public bool CheckBoxes { get; set; }

CheckedItems

IList<RadListBoxItem>

Gets the currently checked items in the ListBox.

[Browsable(false)]
public virtual IList<RadListBoxItem> CheckedItems { get; }

ClientChanges

IList<ClientOperation<RadListBoxItem>>

Gets a list of all client-side changes (adding an Item, removing an Item, changing an Item's property) which have occurred.

[Browsable(false)]
public IList<ClientOperation<RadListBoxItem>> ClientChanges { get; }

ClientItemTemplate

Gets or sets the HTML template of a RadListBoxItem when added on the client.

[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual string ClientItemTemplate { get; set; }

Controls

ControlCollection

Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.

public override ControlCollection Controls { get; }

Property Value:

The collection of child controls for the specified server control.

Overrides: Control.Controls

CssClassFormatString

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

protected override string CssClassFormatString { get; }

Overrides: RadDataBoundControl.CssClassFormatString

Example:

protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

Culture

CultureInfo

Gets or sets the selected culture. Localization strings will be loaded based on this value.

public CultureInfo Culture { get; set; }

Property Value:

The culture.

DataKeyField

Gets or sets the key field in the data source. Usually this is the database column which denotes the primary key.

public string DataKeyField { get; set; }

Property Value:

The name of the key field in the data source specified.

DataKeyField is required for automatic data source updates during transfer, reorder and delete.

DataKeys

DataKeyCollection

Gets a DataKeyCollection object that stores the key values of each record.

[Browsable(false)]
public virtual DataKeyCollection DataKeys { get; }

Property Value:

The data keys.

The DataKeys property is populated after databinding if the DataKeyField property is set.

DataSortField

Gets or sets the sort field in the data source. The sort field must be of numeric type.

public string DataSortField { get; set; }

Property Value:

The name of the sort field in the data source specified.

DataSortField is required for automatic data source updates during reorder.

EmptyMessage

Gets or sets the empty message.

public string EmptyMessage { get; set; }

Property Value:

The empty message.

EmptyMessageTemplate

Gets or sets the ITemplate that defines the RadListBox empty message template.

[TemplateContainer(typeof(RadListBox))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate EmptyMessageTemplate { get; set; }

Property Value:

The item template.

EnableAriaSupport

When set to true enables support for WAI-ARIA.

[ClientControlProperty]
[ClientPropertyName("enableAriaSupport")]
public bool EnableAriaSupport { get; set; }

EnableDragAndDrop

When set to true enables Drag-and-drop functionality

[ClientControlProperty]
public bool EnableDragAndDrop { get; set; }

EnableImageLazyLoading

Gets or sets a value indicating whether images in list items should be lazy loaded when they become visible in the viewport.

public bool EnableImageLazyLoading { get; set; }

EnableLoadOnDemand

Gets or sets the EnableLoadOnDemand property.

public bool EnableLoadOnDemand { get; set; }

Property Value:

The EnableLoadOnDemand property.

EnableMarkMatches

Gets or sets the enable mark matches.

public bool EnableMarkMatches { get; set; }

Property Value:

The enable mark matches.

Footer

WebControl

Get a footer of RadListBox.

[Browsable(false)]
public WebControl Footer { get; }

FooterTemplate

Gets or sets the ITemplate that defines the RadListBox footer template.

[TemplateContainer(typeof(RadListBox))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate FooterTemplate { get; set; }

Property Value:

The footer template.

Header

WebControl

Get a header of RadListBox.

[Browsable(false)]
public WebControl Header { get; }

HeaderTemplate

Gets or sets the ITemplate that defines the RadListBox header template.

[TemplateContainer(typeof(RadListBox))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate HeaderTemplate { get; set; }

Property Value:

The header template.

Items

RadListBoxItemCollection

Gets the items of the RadListBox control.

[PersistenceMode(PersistenceMode.InnerProperty)]
public RadListBoxItemCollection Items { get; }

Property Value:

The RadListBoxItemCollection object which represents the items.

You can use the Items property to add and remove items in the RadListBox control.

ItemTemplate

Gets or sets the ITemplate that defines how items in the RadListBox control are displayed.

[TemplateContainer(typeof(RadListBoxItem))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate ItemTemplate { get; set; }

Property Value:

The item template.

LoadingPanelID

The ID of the RadAjaxLoadingPanel to be displayed during LOD

[PersistenceMode(PersistenceMode.Attribute)]
[TypeConverter("Telerik.Web.Design.AjaxLoadingPanelIDConverter, Telerik.Web.Design, Version=2026.3.812.462, Culture=neutral, PublicKeyToken=121fae78165ba3d4")]
[ClientPropertyName("_loadingPanelID")]
[ClientControlProperty]
public string LoadingPanelID { get; set; }

Localization

ListBoxButtons

Gets the localization.

[PersistenceMode(PersistenceMode.InnerProperty)]
[TypeConverter(typeof(ExpandableObjectConverter))]
public ListBoxButtons Localization { get; }

Property Value:

The localization.

LocalizationPath

Gets or sets a value indicating where RadListBox will look for its .resx localization files.

public string LocalizationPath { get; set; }

Property Value:

The localization path.

OnClientCheckAllChecked

Gets or sets the name of the JavaScript function which handles the checkAllItemChecked client-side event.

[ClientControlEvent]
[ClientPropertyName("checkAllChecked")]
public string OnClientCheckAllChecked { get; set; }

The JavaScript function executed when CheckAll checkbox is checked.

OnClientCheckAllChecking

Gets or sets the name of the JavaScript function which handles the checkAllItemChecked client-side event.

[ClientControlEvent]
[ClientPropertyName("checkAllChecking")]
public string OnClientCheckAllChecking { get; set; }

The JavaScript function executed before CheckAll checkbox is checked.

OnClientContextMenu

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

[ClientControlEvent]
[ClientPropertyName("contextMenu")]
public string OnClientContextMenu { get; set; }

Use theOnClientContextMenu property to specify a JavaScript function that will be executed before the context menu shows after right clicking an item.

Example:

function onContextMenu(sender, args)
{
var item = args.get_item();
}

OnClientDeleted

Gets or sets the name of the JavaScript function which handles the deleted client-side event.

[ClientControlEvent]
[ClientPropertyName("deleted")]
public string OnClientDeleted { get; set; }

The deleted event occurs when an itema are deleted (during transfer or delete for example).

OnClientDeleting

Gets or sets the name of the JavaScript function which handles the deleting client-side event.

[ClientControlEvent]
[ClientPropertyName("deleting")]
public string OnClientDeleting { get; set; }

The deleting event occurs when an items are deleted (during transfer or delete for example).

Example:

function onDeleting(sender, args)
{
args.set_cancel(true);
}

OnClientDragging

Gets or sets the name of the JavaScript function which handles the itemDragging client-side event.

[ClientControlEvent]
[ClientPropertyName("dragging")]
public string OnClientDragging { get; set; }

The itemDragging event occurs when user moves the mouse while dragging an item.

OnClientDragStart

Gets or sets the name of the JavaScript function which handles the itemDragStart client-side event.

[ClientControlEvent]
[ClientPropertyName("dragStart")]
public string OnClientDragStart { get; set; }

The itemDragStart event occurs when user starts to drag an item.

Example:

function onItemDragStart(sender, args)
{
args.set_cancel(true);
}

OnClientDropped

Gets or sets the name of the JavaScript function which handles the itemDropped client-side event.

[ClientControlEvent]
[ClientPropertyName("dropped")]
public string OnClientDropped { get; set; }

The itemDropped event occurs after the user drops an item onto another item.

OnClientDropping

Gets or sets the name of the JavaScript function which handles the itemDropping client-side event.

[ClientControlEvent]
[ClientPropertyName("dropping")]
public string OnClientDropping { get; set; }

The itemDropping event occurs when the user drops an item onto another item.

OnClientItemChecked

Gets or sets the name of the JavaScript function which handles the itemChecked client-side event.

[ClientControlEvent]
[ClientPropertyName("itemChecked")]
public string OnClientItemChecked { get; set; }

The itemChecked event occurs when the item is checked.

OnClientItemChecking

Gets or sets the name of the JavaScript function which handles the itemChecking client-side event.

[ClientControlEvent]
[ClientPropertyName("itemChecking")]
public string OnClientItemChecking { get; set; }

The itemChecking event occurs when the item is checked.

Example:

function onItemChecking(sender, args)
{
args.set_cancel(true);
}

OnClientItemDataBound

Gets or sets the name of the JavaScript function called when an Item is created during Web Service Load on Demand.

[ClientControlEvent]
[ClientPropertyName("itemDataBound")]
public string OnClientItemDataBound { get; set; }

OnClientItemDoubleClicked

[ClientControlEvent]
[ClientPropertyName("itemDoubleClicked")]
public string OnClientItemDoubleClicked { get; set; }

OnClientItemDoubleClicking

[ClientControlEvent]
[ClientPropertyName("itemDoubleClicking")]
public string OnClientItemDoubleClicking { get; set; }

OnClientItemsRequested

Gets or sets a value indicating the client-side event handler that is called when the RadListBox items were just populated (for example from web service).

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemsRequested")]
public string OnClientItemsRequested { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientItemsRequested client-side event handler is called when the RadListBox items were just populated. Two parameters are passed to the handler:

sender, the menu client object;
eventArgs, null for this event.

This event cannot be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onItemsRequested(sender, eventArgs)<br />
{<br />
       alert("Loading finished");<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadListBox ID="RadListBox1"<br />
runat="server"<br />
    <strong>OnClientItemsRequested="onItemsRequested"</strong>&gt;<br />
....<br />
&lt;/telerik:RadListBox&gt;</p>

OnClientItemsRequestFailed

Gets or sets a value indicating the client-side event handler that is called when the operation for populating the RadListBox has failed.

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemsRequestFailed")]
public string OnClientItemsRequestFailed { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientItemsRequestFailed client-side event handler is called when the operation for populating the RadListBox has failed. Two parameters are passed to the handler:

sender, the menu client object;
eventArgs with one property:
set_cancel(), set to true to suppress the default action (alert message).

This event can be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onItemsRequestFailed(sender, eventArgs)<br />
{<br />
       alert("Error: " + errorMessage);<br />
       eventArgs.set_cancel(true);<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadListBox ID="RadListBox1"<br />
runat="server"<br />
    <strong>OnClientItemsRequestFailed="onItemsRequestFailed"</strong>&gt;<br />
....<br />
&lt;/telerik:RadListBox&gt;</p>

OnClientItemsRequesting

Gets or sets a value indicating the client-side event handler that is called when the RadListBOx is about to be populated (for example from web service).

[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemsRequesting")]
public string OnClientItemsRequesting { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientItemsRequesting client-side event handler is called when the RadListBox is about to be populated. Two parameters are passed to the handler:

sender, the listBox client object;
eventArgs with three properties:
get_context(), an user object that will be passed to the web service.
set_cancel(), used to cancel the event.

This event can be cancelled.

Example:

<p>&lt;script type="text/javascript"&gt;<br />
function onItemRequestingHandler(sender, eventArgs)<br />
{<br />
       var context = eventArgs.get_context();<br />
       context["Parameter1"] = "Value";<br />
}<br />
&lt;/script&gt;</p>
<p>&lt;telerik:RadListBox ID="RadListBox1"<br />
runat="server"<br />
    <strong>OnClientItemPopulating="onClientItemPopulatingHandler"</strong>&gt;<br />
....<br />
&lt;/telerik:RadListBox&gt;</p>

OnClientLoad

Gets or sets the name of the JavaScript function which handles the load client-side event.

[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }

The load event occurs when RadListBox is initialized.

OnClientMouseOut

Gets or sets the name of the JavaScript function which handles the mouseOut client-side event.

[ClientControlEvent]
[ClientPropertyName("mouseOut")]
public string OnClientMouseOut { get; set; }

The mouseOut event occurs when the user moves away the mouse from a listbox item.

OnClientMouseOver

Gets or sets the name of the JavaScript function which handles the mouseOver client-side event.

[ClientControlEvent]
[ClientPropertyName("mouseOver")]
public string OnClientMouseOver { get; set; }

The mouseOver event occurs when the user hovers a listbox item with the mouse.

OnClientReordered

Gets or sets the name of the JavaScript function which handles the reordered client-side event.

[ClientControlEvent]
[ClientPropertyName("reordered")]
public string OnClientReordered { get; set; }

The reordered event occurs when an item is reordered.

OnClientReordering

Gets or sets the name of the JavaScript function which handles the reordering client-side event.

[ClientControlEvent]
[ClientPropertyName("reordering")]
public string OnClientReordering { get; set; }

The reordering event occurs when an item is reordered.

Example:

function onReordering(sender, args)
{
args.set_cancel(true);
}

OnClientSelectedIndexChanged

Gets or sets the name of the JavaScript function which handles the selectedIndexChanged client-side event.

[ClientControlEvent]
[ClientPropertyName("selectedIndexChanged")]
public string OnClientSelectedIndexChanged { get; set; }

The selectedIndexChanged client-side event occurs when the selection changes.

OnClientSelectedIndexChanging

Gets or sets the name of the JavaScript function which handles the selectedIndexChanging client-side event.

[ClientControlEvent]
[ClientPropertyName("selectedIndexChanging")]
public string OnClientSelectedIndexChanging { get; set; }

The selectedIndexChanging client-side event occurs when the selection changes.

Example:

function onSelectedIndexChanging(sender, args)
{
args.set_cancel(true);
}

OnClientTemplateDataBound

Gets or sets the name of the JavaScript function called when the client template for an item is evaluated

[ClientControlEvent]
[ClientPropertyName("templateDataBound")]
public string OnClientTemplateDataBound { get; set; }

OnClientTransferred

Gets or sets the name of the JavaScript function which handles the transferred client-side event.

[ClientControlEvent]
[ClientPropertyName("transferred")]
public string OnClientTransferred { get; set; }

The transferred event occurs when an item is transferred.

OnClientTransferring

Gets or sets the name of the JavaScript function which handles the transferring client-side event.

[ClientControlEvent]
[ClientPropertyName("transferring")]
public string OnClientTransferring { get; set; }

The transferring event occurs when an item is transferred.

Example:

function onTransferring(sender, args)
{
args.set_cancel(true);
}

PersistClientChanges

Gets or sets a value indicating whether RadListBox should persist the changes that occurred client-side (reorder, transfer, delete) after postback.

[ClientControlProperty]
[ClientPropertyName("_persistChanges")]
public bool PersistClientChanges { get; set; }

Property Value:

true if client-side changes should be persisted after postback; otherwise, false. The default value is true.

SelectedIndex

int

Gets or sets the selected index of the RadListBox control.

[Bindable(true)]
[Browsable(false)]
public virtual int SelectedIndex { get; set; }

Property Value:

The index that should be selected.

Set the selected index to -1 to clear the selection.

SelectedItem

Gets the currently selected Item in the ListBox.

[Bindable(false)]
[Browsable(false)]
public virtual RadListBoxItem SelectedItem { get; }

Property Value:

A RadListBoxItem which is currently selected. Null (Nothing) if there is no selected item (SelectedIndex is -1).

SelectedItems

IList<RadListBoxItem>

Gets the currently selected items in the ListBox.

[Browsable(false)]
public virtual IList<RadListBoxItem> SelectedItems { get; }

SelectedValue

Gets the Value of the selected item. When set selects the item with matching Value property.

[Browsable(false)]
[Bindable(true, BindingDirection.TwoWay)]
[Themeable(false)]
[ClientControlProperty]
[ClientPropertyName("_selectedValue")]
public virtual string SelectedValue { get; set; }

SelectionMode

ListBoxSelectionMode

Gets or sets the Selection Mode of the RadListBox.

[ClientControlProperty]
[ClientPropertyName("selectionMode")]
[ClientPersistedProperty]
public ListBoxSelectionMode SelectionMode { get; set; }

ShowCheckAll

Gets or sets a value that indicates whether the CheckAll checkbox is shown in ListBox.

[ClientControlProperty]
[ClientPropertyName("_showCheckAll")]
public bool ShowCheckAll { get; set; }

Sort

RadListBoxSort

Automatically sorts items alphabetically (based on the Text property) in ascending or descending order.

[Bindable(false)]
public RadListBoxSort Sort { get; set; }

Example:

cs-api-definition
RadListBox1.Sort = RadListBoxSort.Ascending;
RadListBox1.Sort = RadListBoxSort.Descending;
RadListBox1.Sort = RadListBoxSort.None;
cs-api-definition.skip-repl
RadListBox1.Sort = RadListBoxSort.Ascending
RadListBox1.Sort = RadListBoxSort.Descending
RadListBox1.Sort = RadListBoxSort.None

SortCaseSensitive

Gets/sets whether the sorting will be case-sensitive or not. By default is set to true.

[Bindable(false)]
public bool SortCaseSensitive { get; set; }

Example:

cs-api-definition
RadListBox1.SortCaseSensitive = false;
cs-api-definition.skip-repl
RadListBox1.SortCaseSensitive = false

SupportsRenderingMode

protected override bool SupportsRenderingMode { get; }

Overrides: RadDataBoundControl.SupportsRenderingMode

TransferMode

ListBoxTransferMode

Gets or sets the transfer mode used for transfer operations.

[ClientControlProperty]
public ListBoxTransferMode TransferMode { get; set; }

Property Value:

The transfer mode. The default value is Move

If the TransferMode property is set to Move the items would be deleted from the source listbox before inserting them in the destination listbox. The TransferMode property of the listbox whose TransferToID property is set is taken into account.

TransferToID

Gets or sets the ID of the RadListBox which the current listbox should transfer to. Set the TransferToID property only of one of the two listboxes which will transfer items between each other.

public string TransferToID { get; set; }

Property Value:

The ID of the target listbox.

TransferToListBox

RadListBox

Gets the RadListBox which the current list box is configured to transfer to via the TransferToID property.

[Browsable(false)]
public RadListBox TransferToListBox { get; }

Property Value:

The transfer to list box. null (Nothing) if the TransferToID property is not set.

UniqueID

NavigationControlWebServiceSettings

Gets the unique, hierarchically qualified identifier for the server control.

[ClientControlProperty]
[ClientPropertyName("_uniqueId")]
public override string UniqueID { get; }

Property Value:

The fully qualified identifier for the server control.

Overrides: Control.UniqueID

WebServiceSettings

Gets the settings for the web service used to populate items.

[PersistenceMode(PersistenceMode.InnerProperty)]
public NavigationControlWebServiceSettings WebServiceSettings { get; }

Property Value:

An WebServiceSettings that represents the web service used for populating items.

Use the WebServiceSettings property to configure the web service used to populate items on demand. You must specify both Path and Method to fully describe the service.

In order to use the integrated support, the web service should have the following signature:
   <pre><code class="lang-csharp">[ScriptService]
public class WebServiceName : WebService { [WebMethod] public RadListBoxItemData[] WebServiceMethodName(object context) { // We cannot use a dictionary as a parameter, because it is only supported by script services. // The context object should be cast to a dictionary at runtime. IDictionary<string, object> contextDictionary = (IDictionary<string, object>) context;
    //...
}
}

Methods

AddAttributesToRender(HtmlTextWriter)

protected override void AddAttributesToRender(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.AddAttributesToRender(HtmlTextWriter)

ClearChecked()

Clears the checked items. The Checked property of all items is set to false.

public virtual void ClearChecked()

ClearSelection()

Clears the selection. The Selected property of all items is set to false.

public virtual void ClearSelection()

CreateChildControls()

protected override void CreateChildControls()

Overrides: Control.CreateChildControls()

CreateChildItemCollection()

protected override ControlItemCollection CreateChildItemCollection()

Returns:

ControlItemCollection

Overrides: ControlItemContainer.CreateChildItemCollection()

CreateControlRenderer()

protected override IRenderer CreateControlRenderer()

Returns:

IRenderer

Overrides: RadDataBoundControl.CreateControlRenderer()

CreateItem()

protected override ControlItem CreateItem()

Returns:

ControlItem

Overrides: ControlItemContainer.CreateItem()

Delete(IList<RadListBoxItem>)

Deletes the specified list of items. Fires the Deleting and Deleted events.

public virtual void Delete(IList<RadListBoxItem> items)

Parameters:itemsIList<RadListBoxItem>

The list of items which should be deleted.

The Delete method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
RadListBox1.Delete(RadListBox1.SelectedItems);
cs-api-definition.skip-repl
RadListBox1.Delete(RadListBox1.SelectedItems)

Delete(RadListBoxItem)

Deletes the specified item. Fires the Deleting and Deleted events.

public void Delete(RadListBoxItem item)

Parameters:itemRadListBoxItem

The item which should be deleted.

The Delete method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

DescribeComponent(IScriptDescriptor)

protected override void DescribeComponent(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: ControlItemContainer.DescribeComponent(IScriptDescriptor)

FindItem(Predicate<RadListBoxItem>)

Finds the first item for which the specified predicate returns true.

public RadListBoxItem FindItem(Predicate<RadListBoxItem> predicate)

Parameters:predicatePredicate<RadListBoxItem>

The predicate which will test all items.

Returns:

The first item for which the specified predicate returns true. Null (Nothing) is returned if no item matches.

Example:

cs-api-definition
RadListBoxItem item = RadListBox1.FindItem(delegate(RadListBoxItem currentItem) {
return currentItem.Text.StartsWith("A");
});
cs-api-definition.skip-repl
Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load
RadListBox1.FindItem(AddressOf Find)
End Sub
Public Function Find(ByVal currentItem As RadListBoxItem) As Boolean
Find = currentItem.Text.StartsWith("A")
End Function

FindItemByText(string)

Finds the first item whose Text property is the same as the specified text.

public RadListBoxItem FindItemByText(string text)

Parameters:textstring

The text to search for.

Returns:

The first item whose Text property is the same as the specified text. Null (Nothing) otherwise.

FindItemByValue(string)

Finds the first item whose Value property is the same as the specified value.

public RadListBoxItem FindItemByValue(string value)

Parameters:valuestring

The value to search for.

Returns:

The first item whose Value property is the same as the specified value. Null (Nothing) otherwise.

FindItemIndexByValue(string, bool)

Finds the index of the item whose Value property is the same as the specified value.

public int FindItemIndexByValue(string value, bool ignoreCase)

Parameters:valuestring

The value.

ignoreCasebool

if set to true case insensitive comparison is made.

Returns:

int

The index of the item whose Value property is the same as the specified value. -1 if no item is found.

FindItemIndexByValue(string)

Finds the index of the item whose Value property is the same as the specified value.

public int FindItemIndexByValue(string value)

Parameters:valuestring

The value.

Returns:

int

The index of the item whose Value property is the same as the specified value. -1 if no item is found.

GetCheckedIndices()

Gets an array containing the indices of the currently checked items in the RadListBox control.

public virtual int[] GetCheckedIndices()

Returns:

int[]

GetSelectedIndices()

Gets an array containing the indices of the currently selected items in the RadListBox control.

public virtual int[] GetSelectedIndices()

Returns:

int[]

LoadContentFile(string)

Populates the RadListBox control from an XML file

public void LoadContentFile(string xmlFileName)

Parameters:xmlFileNamestring

Name of the XML file.

LoadPostData(string, NameValueCollection)

Loads the posted content of the list control, if it is different from the last posting.

protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)

Parameters:postDataKeystring

The key identifier for the control, used to index the postCollection.

postCollectionNameValueCollection

A NameValueCollection that contains value information indexed by control identifiers.

Returns:

RadListBoxCheckAllCheckEventHandler

true if the posted content is different from the last posting; otherwise, false.

Overrides: RadDataBoundControl.LoadPostData(string, NameValueCollection)

LoadViewState(object)

protected override void LoadViewState(object savedState)

Parameters:savedStateobject

Overrides: ControlItemContainer.LoadViewState(object)

OnCheckAllCheck(RadListBoxCheckAllCheckEventArgs)

Raises the CheckAllCheck event.

protected virtual void OnCheckAllCheck(RadListBoxCheckAllCheckEventArgs e)

Parameters:eRadListBoxCheckAllCheckEventArgs

The EventArgs instance containing the event data.

OnDeleted(RadListBoxEventArgs)

protected virtual void OnDeleted(RadListBoxEventArgs e)

Parameters:eRadListBoxEventArgs

OnDeleting(RadListBoxDeletingEventArgs)

protected virtual void OnDeleting(RadListBoxDeletingEventArgs e)

Parameters:eRadListBoxDeletingEventArgs

OnDropped(RadListBoxDroppedEventArgs)

Raises the Dropped event.

protected virtual void OnDropped(RadListBoxDroppedEventArgs e)

Parameters:eRadListBoxDroppedEventArgs

The RadListBoxDroppedEventArgs instance containing the event data.

OnDropping(RadListBoxDroppingEventArgs)

Raises the Dropping event.

protected virtual void OnDropping(RadListBoxDroppingEventArgs e)

Parameters:eRadListBoxDroppingEventArgs

The RadListBoxDroppingEventArgs instance containing the event data.

OnInserted(RadListBoxEventArgs)

Raises the Inserted event.

protected virtual void OnInserted(RadListBoxEventArgs e)

Parameters:eRadListBoxEventArgs

The RadListBoxEventArgs instance containing the event data.

OnInserting(RadListBoxInsertingEventArgs)

Raises the Inserting event.

protected virtual void OnInserting(RadListBoxInsertingEventArgs e)

Parameters:eRadListBoxInsertingEventArgs

The RadListBoxInsertingEventArgs instance containing the event data.

OnItemCheck(RadListBoxItemEventArgs)

Raises the ItemCheck event.

protected virtual void OnItemCheck(RadListBoxItemEventArgs e)

Parameters:eRadListBoxItemEventArgs

The EventArgs instance containing the event data.

OnItemCreated(RadListBoxItemEventArgs)

Raises the ItemCreated event.

protected virtual void OnItemCreated(RadListBoxItemEventArgs e)

Parameters:eRadListBoxItemEventArgs

The RadListBoxItemEventArgs instance containing the event data.

OnItemDataBound(RadListBoxItemEventArgs)

Raises the ItemDataBound event.

protected virtual void OnItemDataBound(RadListBoxItemEventArgs e)

Parameters:eRadListBoxItemEventArgs

The RadListBoxItemEventArgs instance containing the event data.

OnItemsRequested(RadListBoxItemsRequestedEventArgs)

Raises the ItemsRequested event.

protected virtual void OnItemsRequested(RadListBoxItemsRequestedEventArgs e)

Parameters:eRadListBoxItemsRequestedEventArgs

The RadListBoxItemsRequestedEventArgs instance containing the event data.

OnPreRender(EventArgs)

protected override void OnPreRender(EventArgs e)

Parameters:eEventArgs

Overrides: RadDataBoundControl.OnPreRender(EventArgs)

OnReordered(RadListBoxEventArgs)

Raises the Reordered event.

protected virtual void OnReordered(RadListBoxEventArgs e)

Parameters:eRadListBoxEventArgs

The RadListBoxEventArgs instance containing the event data.

OnReordering(RadListBoxReorderingEventArgs)

Raises the Reordering event.

protected virtual void OnReordering(RadListBoxReorderingEventArgs e)

Parameters:eRadListBoxReorderingEventArgs

The RadListBoxReorderingEventArgs instance containing the event data.

OnSelectedIndexChanged(EventArgs)

Raises the SelectedIndexChanged event.

protected virtual void OnSelectedIndexChanged(EventArgs e)

Parameters:eEventArgs

The EventArgs instance containing the event data.

OnTemplateNeeded(RadListBoxItemEventArgs)

protected virtual void OnTemplateNeeded(RadListBoxItemEventArgs e)

Parameters:eRadListBoxItemEventArgs

OnTextChanged(EventArgs)

Raises the TextChanged event.

protected virtual void OnTextChanged(EventArgs e)

Parameters:eEventArgs

The EventArgs instance containing the event data.

OnTransferred(RadListBoxTransferredEventArgs)

Raises the Transferred event.

protected virtual void OnTransferred(RadListBoxTransferredEventArgs e)

Parameters:eRadListBoxTransferredEventArgs

The RadListBoxTransferredEventArgs instance containing the event data.

OnTransferring(RadListBoxTransferringEventArgs)

Raises the Transferring event.

protected virtual void OnTransferring(RadListBoxTransferringEventArgs e)

Parameters:eRadListBoxTransferringEventArgs

The RadListBoxTransferringEventArgs instance containing the event data.

OnUpdated(RadListBoxEventArgs)

Raises the Updated event.

protected virtual void OnUpdated(RadListBoxEventArgs e)

Parameters:eRadListBoxEventArgs

The RadListBoxEventArgs instance containing the event data.

OnUpdating(RadListBoxUpdatingEventArgs)

Raises the Updating event.

protected virtual void OnUpdating(RadListBoxUpdatingEventArgs e)

Parameters:eRadListBoxUpdatingEventArgs

The RadListBoxUpdatingEventArgs instance containing the event data.

PerformDataBinding(IEnumerable)

protected override void PerformDataBinding(IEnumerable data)

Parameters:dataIEnumerable

Overrides: ControlItemContainer.PerformDataBinding(IEnumerable)

PerformSelect()

protected override void PerformSelect()

Overrides: DataBoundControl.PerformSelect()

RaiseItemCreated(ControlItem)

protected override void RaiseItemCreated(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.RaiseItemCreated(ControlItem)

RaiseItemDataBound(ControlItem)

protected override void RaiseItemDataBound(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.RaiseItemDataBound(ControlItem)

RaisePostBackEvent(string)

protected virtual void RaisePostBackEvent(string eventArgument)

Parameters:eventArgumentstring

RaisePostDataChangedEvent()

Invokes the OnSelectedIndexChanged(EventArgs) method whenever posted data for the RadListBox control has changed.

protected override void RaisePostDataChangedEvent()

Overrides: RadDataBoundControl.RaisePostDataChangedEvent()

RaiseTemplateNeeded(ControlItem)

protected override void RaiseTemplateNeeded(ControlItem item)

Parameters:itemControlItem

Overrides: ControlItemContainer.RaiseTemplateNeeded(ControlItem)

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.RenderContents(HtmlTextWriter)

Reorder(IList<RadListBoxItem>, int)

Reorders the specified items with the specified offset. Fires the Reordering and Reordered events.

public virtual void Reorder(IList<RadListBoxItem> items, int offset)

Parameters:itemsIList<RadListBoxItem>

The items.

offsetint

The offset.

he Reorder method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
//Move all selected items with one position down
RadListBox1.Reorder(RadListBox1.SelectedItems, 1);
cs-api-definition.skip-repl
'Move all selected items with one position down
RadListBox1.Reorder(RadListbox1.SelectedItems, 1)

Reorder(int, int)

Moves the item at old index to new index by calculating the offset. Fires the Reordering and Reordered events.

public void Reorder(int oldIndex, int newIndex)

Parameters:oldIndexint

The old (current) index of the item.

newIndexint

The new index of the item.

The Reorder method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
//Reorder the first item to second place
RadListBox1.Reorder(0, 1);
cs-api-definition.skip-repl
'Reorder the first item to second place
RadListBox1.Reorder(0, 1)

ReorderToIndex(IList<RadListBoxItem>, int)

Reorders the specified items to the specified index. Fires the Reordering and Reordered events.

public virtual void ReorderToIndex(IList<RadListBoxItem> items, int targetIndex)

Parameters:itemsIList<RadListBoxItem>

The items.

targetIndexint

The target index.

The ReorderToIndex method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
//Move all selected items (first and second) to an index below them.
RadListBox1.ReorderToIndex(RadListBox1.SelectedItems, 3);
cs-api-definition.skip-repl
'Move all selected items (first and second) to an index below them.
RadListBox1.Reorder(RadListbox1.SelectedItems, 3)

ReorderToIndex(int, int)

Moves the item at old index to new index. Fires the Reordering and Reordered events.

public void ReorderToIndex(int oldIndex, int newIndex)

Parameters:oldIndexint

The old (current) index of the item.

newIndexint

The new index of the item.

The ReorderToIndex method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
//Reorder the first item to second place
RadListBox1.ReorderToIndex(0, 1);
cs-api-definition.skip-repl
'Reorder the first item to second place
RadListBox1.ReorderToIndex(0, 1)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: ControlItemContainer.SaveViewState()

SetPostDataSelection(int)

Sets the Selected property of a RadListBoxItem after a page is posted back.

protected void SetPostDataSelection(int selectedIndex)

Parameters:selectedIndexint

The index of the Item to select in the Items collection.

SortItems()

Sorts the items in the RadListBox.

public void SortItems()

Example:

cs-api-definition
RadListBox1.Sort=RadListBoxSort.Ascending
RadListBox1.SortItems()
cs-api-definition.skip-repl
RadListBox1.Sort=RadListBoxSort.Ascending;
RadListBox1.SortItems();

Transfer(IList<RadListBoxItem>, RadListBox, RadListBox)

Transfers the specified list of items from the source to the destination listbox. Fires the Transferring and Transferred events.

public virtual void Transfer(IList<RadListBoxItem> itemsToTransfer, RadListBox sourceListBox, RadListBox destinationListBox)

Parameters:itemsToTransferIList<RadListBoxItem>

The items to transfer.

sourceListBoxRadListBox

The source list box.

destinationListBoxRadListBox

The destination list box.

Always call the Transfer method of the RadListBox whose TransferToID property is set! The Transfer method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
RadListBox1.TransferToID = "RadListBox2";
//Transfers all items of RadListBox1 to RadListBox2
RadListBox1.Transfer(RadListBox1.Items, RadListBox1, RadListBox2);
//Transfers all items of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
RadListBox1.Transfer(RadListBox2.Items, RadListBox2, RadListBox1);
cs-api-definition.skip-repl
RadListBox1.TransferToID = "RadListBox2"
'Transfers all items of RadListBox1 to RadListBox2
RadListBox1.Transfer(RadListBox1.Items, RadListBox1, RadListBox2)
'Transfers all items of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
RadListBox1.Transfer(RadListBox2.Items, RadListBox2, RadListBox1);

Transfer(RadListBoxItem, RadListBox, RadListBox)

Transfers the specified item from the source list box to the destination listbox. Fires the Transferring and Transferred events.

public void Transfer(RadListBoxItem item, RadListBox sourceListBox, RadListBox destinationListBox)

Parameters:itemRadListBoxItem

The item to transfer.

sourceListBoxRadListBox

The source list box.

destinationListBoxRadListBox

The destination list box.

Always call the Transfer method of the RadListBox whose TransferToID property is set! The Transfer method updates the underlying datasource if the AllowAutomaticUpdates is set to true.

Example:

cs-api-definition
RadListBox1.TransferToID = "RadListBox2";
//Transfers the first item of RadListBox1 to RadListBox2
RadListBox1.Transfer(RadListBox1.Items[0], RadListBox1, RadListBox2);
//Transfers the first item of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
RadListBox1.Transfer(RadListBox2.Items[0], RadListBox2, RadListBox1);
cs-api-definition.skip-repl
RadListBox1.TransferToID = "RadListBox2"
'Transfers the first item of RadListBox1 to RadListBox2
RadListBox1.Transfer(RadListBox1.Items(0), RadListBox1, RadListBox2)
'Transfers the first item of RadListBox2 to RadListBox1. Notice that we do not use RadListBox2.Transfer
RadListBox1.Transfer(RadListBox2.Items(0), RadListBox2, RadListBox1);

Events

CheckAllCheck

Occurs when the checkAll item is checked

public event RadListBoxCheckAllCheckEventHandler CheckAllCheck

Deleted

RadListBoxDeletingEventHandler

Occurs when items are deleted.

public event RadListBoxEventHandler Deleted

Deleting

Occurs when items are deleted.

public event RadListBoxDeletingEventHandler Deleting

Dropped

RadListBoxDroppedEventHandler

Occurs after drag and drop

public event RadListBoxDroppedEventHandler Dropped

Dropping

RadListBoxDroppingEventHandler

Occurs before drag and drop

public event RadListBoxDroppingEventHandler Dropping

Inserted

RadListBoxInsertingEventHandler

Occurs when item is inserted.

public event RadListBoxEventHandler Inserted

Inserting

Occurs when item is inserted. Can be cancelled by setting the Cancel property to true.

public event RadListBoxInsertingEventHandler Inserting

ItemCheck

Occurs when an item is checked

public event RadListBoxItemEventHandler ItemCheck

ItemCreated

Occurs when item is created.

public event RadListBoxItemEventHandler ItemCreated

The ItemCreated event occurs before ItemDataBound and after postback if ViewState is enabled. ItemCreated is not raised for items defined inline in the ASPX.

ItemDataBound

RadListBoxItemsRequestedEventHandler

Occurs when item is data bound.

public event RadListBoxItemEventHandler ItemDataBound

Use the ItemDataBound event to set additional properties of the databound items.

Example:

cs-api-definition
protected void RadListBox1_ItemDataBound(object sender, RadListBoxItemEventArgs e)
{
e.Item.ToolTip = (string)DataBinder.Eval(e.Item.DataItem, "ToolTipColumn");
}
cs-api-definition.skip-repl
Protected Sub RadListBox1_ItemDataBound(sender As Object, e As RadListBoxItemEventArgs)
e.Item.ToolTip = DirectCast(DataBinder.Eval(e.Item.DataItem, "ToolTipColumn"), String)
End Sub

ItemsRequested

Occurs when the control performs callback.

public event RadListBoxItemsRequestedEventHandler ItemsRequested

Reordered

RadListBoxReorderingEventHandler

Occurs when item is reordered.

public event RadListBoxEventHandler Reordered

Reordering

Occurs when item is reordered. Can be cancelled by setting the Cancel property to true.

public event RadListBoxReorderingEventHandler Reordering

SelectedIndexChanged

EventHandler

Occurs when the selected index has changed.

public event EventHandler SelectedIndexChanged

TemplateNeeded

RadListBoxTransferredEventHandler

Occurs before template is being applied to the item.

public event RadListBoxItemEventHandler TemplateNeeded

The TemplateNeeded event is raised before a template is been applied on the item, both during round-trips (postbacks) and at the time data is bound to the control. The TemplateNeeded event is not raised for items which are defined inline in the page or user control.

The TemplateNeeded event is commonly used for dynamic templating.

Example:

cs-api-definition
protected void RadListBox1_TemplateNeeded(object sender, Telerik.Web.UI.RadListBoxItemEventArgs e)
{
string value = e.Item.Value;
if (value != null)
{
// if the value is an even number
if ((Int32.Parse(value) % 2) == 0)
{
var textBoxTemplate = new TextBoxTemplate();
textBoxTemplate.InstantiateIn(e.Item);
}
}
}
cs-api-definition.skip-repl
Sub RadListBox1_Template(ByVal sender As Object, ByVal e As Telerik.Web.UI.RadListBoxItemEventArgs) Handles RadListBox1.TemplateNeeded
Dim value As String = e.Item.Value
If value IsNot Nothing Then
' if the value is an even number
If ((Int32.Parse(value) Mod 2) = 0) Then
Dim textBoxTemplate As TextBoxTemplate = New TextBoxTemplate()
textBoxTemplate.InstantiateIn(e.Item)
End If
End If
End Sub

TextChanged

EventHandler

Occurs when text was changed.

public event EventHandler TextChanged

Transferred

Occurs when item is transferred.

public event RadListBoxTransferredEventHandler Transferred

Transferring

RadListBoxTransferringEventHandler

Occurs when item is transferred. Can be cancelled by setting the Cancel property to true.

public event RadListBoxTransferringEventHandler Transferring

Updated