RadComboBox
The RadComboBox control supports the following features:
- Databinding that allows the control to be populated from various datasources
- Programmatic access to the RadComboBox object model which allows to dynamic creation of comboboxes, populate items, set properties.
- Customizable appearance through built-in or user-defined skins.
Items
Each item has a Text and a Value property. The value of the Text property is displayed in the RadComboBox 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.
You can find information on the server API of RadComboBox at .
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[EmbeddedSkin("ComboBox", typeof(RadComboBox))]
[EmbeddedSkin("ComboBox", "Default", typeof(RadComboBox))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadComboBox))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredScript(typeof(OData))]
[RequiredScript(typeof(DropDown))]
[RequiredScript(typeof(jQueryPlugins))]
[ClientScriptResource("Telerik.Web.UI.RadComboBox", "Telerik.Web.UI.ComboBox.RadComboBoxScripts.js")]
[RequiredScript(typeof(TouchScrollExtender))]
[RequiredScript(typeof(MaterialRipple))]
[ValidationProperty("Text")]
[ControlValueProperty("SelectedValue")]
[TelerikToolboxCategory("Data Editing")]
[ToolboxBitmap(typeof(RadComboBox), "Toolbox.Icons.ComboBox.png")]
public class RadComboBox : ControlItemContainer, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainer, IXmlSerializable, IControlItemContainer, IPostBackEventHandler, ICallbackEventHandler, IEditableTextControl, ITextControl, IFlatBoundContainerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlControlItemContainerRadComboBox...
Implements:
Inherited Members
Constructors
public RadComboBox()Properties
Determines whether the noscript tag containing select element to be rendered.
[Bindable(true)]
public bool AccessibilityMode { get; set; }Determines whether custom text can be entered into the input field of RadComboBox.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("allowCustomText")]
public bool AllowCustomText { get; set; }Gets the object that controls the Wai-Aria settings applied on the control's element.
[PersistenceMode(PersistenceMode.InnerProperty)]
public WaiAriaSettings AriaSettings { get; }Gets or sets a list of separators: autocomplete logic is reset afer a separator is entered and users can autocomplete multiple items.
[ClientControlProperty]
[ClientPropertyName("autoCompleteSeparator")]
[Bindable(false)]
public string AutoCompleteSeparator { get; set; }You can use several separators at once.
Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the RadComboBox selection.
[Bindable(false)]
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.
protected HttpBrowserCapabilities Browser { get; }Determines whether the text can be entered into the input field of RadComboBox during keyboard navigation
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("changeText")]
public bool ChangeTextOnKeyBoardNavigation { get; set; }Gets or sets a value indicating whether the combobox should display the checkboxes for its items.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_checkBoxes")]
public bool CheckBoxes { get; set; }Gets the currently checked items in the RadComboBox.
[Browsable(false)]
public virtual IList<RadComboBoxItem> CheckedItems { get; }Gets or sets a value indicating whether the combobox should display the checked items texts in case they do not fit in the control input.
[ClientControlProperty]
[ClientPropertyName("_checkedItemsTexts")]
public RadComboBoxCheckedItemsTexts CheckedItemsTexts { get; set; }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<RadComboBoxItem>> ClientChanges { get; }A list of ClientOperation<T> objects which represent all client-side changes the user has performed. By default the ClientChanges property returns empty list. Client-changes are recorded if and only if the client-side methods trackChanges()/commitChanges() have been invoked.
You can use the ClientChanges property to respond to client-side modifications such as
- adding a new item
- removing existing item
- clearing the children of an item or the control itself
- changing a property of the item
The ClientChanges property is available in the first postback (ajax) request after the client-side modifications have taken place. After this moment the property will return empty list.
Gets or sets the template for displaying the items in RadcomboBox.
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
public virtual string ClientItemTemplate { get; set; }Determines whether drop down should be closed on blur
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("closeDropDownOnBlur")]
public bool CloseDropDownOnBlur { get; set; }Gets the settings for the animation played when an item closes.
[PersistenceMode(PersistenceMode.InnerProperty)]
public AnimationSettings CollapseAnimation { get; }An AnimationSettings that represents the collapse animation.
Use the CollapseAnimation property to customize the collapse animation of RadComboBox. You can specify the Type, Duration and the items are collapsed.
To disable collapse animation effects you should set the Type to AnimationType.None. To customize the expand animation you can use the CollapseAnimation property.
Gets or sets a value indicating the timeout after which a dropdown starts to close.
[ClientControlProperty]
[ClientPropertyName("collapseDelay")]
public int CollapseDelay { get; set; }An integer specifying the timeout measured in milliseconds. The default value is 0 milliseconds.
Use the CollapseDelay property to delay dropdown closing. To cause immediate item closing set this property to 0 (zero).
To customize the timeout prior to item closing use the ExpandDelay property.
The client-side id of the inner input element used for intergation with RadLabel
public string ControlId { get; }Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
public override ControlCollection Controls { get; }The collection of child controls for the specified server control.
Overrides:
The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }Overrides:
Gets or sets the the selected culture. Localization strings will be loaded based on this value.
public CultureInfo Culture { get; set; }The culture.
Gets or sets which datasource field will represent the "Checked" state of an item checkbox.
[Bindable(true)]
public string DataCheckedField { get; set; }DefaultItem
RadComboBoxDefaultItem
Gets or set the default item in the RadComboBox.
[Browsable(false)]
public virtual RadComboBoxDefaultItem DefaultItem { get; set; }Gets or sets whether to enable/disable the RadComboBox drop down auto width.
[Bindable(true)]
[ClientControlProperty]
[ClientPropertyName("_dropDownAutoWidth")]
public RadComboBoxDropDownAutoWidth DropDownAutoWidth { get; set; }Gets or sets an additional Cascading Style Sheet (CSS) class applied to the Drop Down.
[ClientPersistedProperty]
public virtual string DropDownCssClass { get; set; }By default the visual appearance of the Drop Down is defined in the skin CSS file. You can use the DropDownCssClass property to specify a CSS class to be applied in addition to the default CSS class.
Gets or sets the width of the dropdown in pixels.
[Bindable(true)]
public Unit DropDownWidth { get; set; }Gets or sets the empty message.
[Themeable(true)]
[ClientControlProperty]
public virtual string EmptyMessage { get; set; }The empty message.
When set to true enables support for WAI-ARIA.
[ClientControlProperty]
[ClientPropertyName("enableAriaSupport")]
public bool EnableAriaSupport { get; set; }Gets or sets a value indicating whether the combobox should handle the items request automatically on the server.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_lodIsAutomatic")]
public bool EnableAutomaticLoadOnDemand { get; set; }Gets or sets a value indicating whether the combobox should display the checkboxes for its items.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableCheckAllItemsCheckBox")]
public bool EnableCheckAllItemsCheckBox { get; set; }Gets or sets a value indicating whether any databinding expressions specified in the ItemTemplate should be evaluated for unbound items (items added inline or programmatically).
public bool EnableItemBindingExpressions { get; set; }true if databinding expressions should be evaluated; otherwise false; The default value is false.
Gets or sets a value indicating whether the combobox should cache items loaded on demand or via webservice
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("enableItemCaching")]
public bool EnableItemCaching { get; set; }Gets or sets a value indicating whether the combobox should issue a callback to the server whenever end-users change the text of the combo (keypress, paste, etc).
[Bindable(false)]
public bool EnableLoadOnDemand { get; set; }In Load On Demand mode, the combobox starts a callback after a specified amount of time (see ItemRequestTimeout) and calls the server-side ItemsRequested event. Depending on the value of the event arguments, you can add new items to the combobox object and the items will be propagated to the browser after the request.
Gets or sets a value indicating whether the Overlay element is rendered when supported. True by default.
[ClientControlProperty]
[ClientPropertyName("_enableOverlay")]
public bool EnableOverlay { get; set; }The enable overlay.
Determines whether the Screen Boundaries Detection is enabled or not.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableScreenBoundaryDetection")]
public bool EnableScreenBoundaryDetection { get; set; }Gets or sets a value indicating whether the text of combobox should be selected
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("enableTextSelection")]
public bool EnableTextSelection { get; set; }Gets or sets a value indicating whether the combobox should load items on demand (via callback) during scrolling-down the drop-down area.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_virtualScroll")]
public bool EnableVirtualScrolling { get; set; }Determines the custom error message to be shown after the Load On Demand Callback error appears.
[Bindable(false)]
public string ErrorMessage { get; set; }Gets the settings for the animation played when the dropdown opens.
[PersistenceMode(PersistenceMode.InnerProperty)]
public AnimationSettings ExpandAnimation { get; }An AnimationSettings that represents the expand animation.
Use the ExpandAnimation property to customize the expand animation of RadComboBox. You can specify the Type, Duration and the To disable expand animation effects you should set the Type to AnimationType.None.
To customize the collapse animation you can use the CollapseAnimation property.
Gets or sets a value indicating the timeout after which a dropdown starts to open.
[ClientControlProperty]
[ClientPropertyName("expandDelay")]
public int ExpandDelay { get; set; }An integer specifying the timeout measured in milliseconds. The default value is 0 milliseconds.
Use the ExpandDelay property to delay dropdown opening.
To customize the timeout prior to item closing use the CollapseDelay property.
Gets or sets a value indicating the opening direction of RadComboBox dropdown. If this property is not set - by default dropdown opens downwards.
[ClientControlProperty]
[ClientPropertyName("expandDirection")]
public virtual RadComboBoxExpandDirection ExpandDirection { get; set; }Gets or sets a value indicating whether the combobox should automatically autocomplete and highlight the currently typed text to the all items text match.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("filter")]
public RadComboBoxFilter Filter { get; set; }Get a footer of RadcomboBox.
[Browsable(false)]
public WebControl Footer { get; }Gets or sets the template for displaying footer in RadcomboBox.
[TemplateContainer(typeof(RadComboBoxItem))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate FooterTemplate { get; set; }Get a header of RadcomboBox.
[Browsable(false)]
public WebControl Header { get; }Gets or sets the template for displaying header in RadcomboBox.
[TemplateContainer(typeof(RadComboBoxItem))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate HeaderTemplate { get; set; }Gets or sets a value indicating whether items defined in the ItemTemplate template should be automatically highlighted on mouse hover or keyboard navigation.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("highlightTemplatedItems")]
public bool HighlightTemplatedItems { get; set; }Gets or sets an additional Cascading Style Sheet (CSS) class applied to the Input.
public virtual string InputCssClass { get; set; }By default the visual appearance of the Input is defined in the skin CSS file. You can use the InputCssClass property to specify a CSS class to be applied in addition to the default CSS class.
Gets or sets a value that indicates whether the combobox autocompletion logic is case-sensitive or not.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("isCaseSensitive")]
public bool IsCaseSensitive { get; set; }Gets a value indicating whether the current instance of the combobox has child items.
[Browsable(false)]
[Bindable(false)]
public bool IsEmpty { get; }Specifies the timeout after each keypress before RadComboBox fires an AJAX callback to the ItemsRequested server-side event.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("itemRequestTimeout")]
public int ItemRequestTimeout { get; set; }In miliseconds. ItemRequestTimeout = 500 is equal to half a second delay.
Gets a RadComboBoxItemCollection object that contains the items of the current RadComboBox control.
[PersistenceMode(PersistenceMode.InnerProperty)]
public RadComboBoxItemCollection Items { get; }A RadComboBoxItemCollection that contains the items of the current RadComboBox control. By default the collection is empty (RadComboBox has no children).
Use the Items property to access the child items of RadComboBox You can add, remove or modify items from the Items collection.
Gets or sets the number of Items the RadComboBox will load per Item request.
public int ItemsPerRequest { get; set; }Set this property to -1 to load all Items when EnableAutomaticLoadOnDemand is set to true and disable Virtual Scrolling/Show More Results. The default is -1.
Gets or sets the template for displaying the items in RadcomboBox.
[TemplateContainer(typeof(RadComboBoxItem))]
[PersistenceMode(PersistenceMode.InnerProperty)]
[Browsable(false)]
[Bindable(false)]
public virtual ITemplate ItemTemplate { get; set; }A ITemplate implemented object that contains the template for displaying combo 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 combo items.
Gets or sets the label of the control.
public virtual string Label { get; set; }The label of the control.
Gets or sets the css class of the label.
public virtual string LabelCssClass { get; set; }The label CSS class.
The value of the message that is shown in RadComboBox while AJAX callback call is in effect.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("loadingMessage")]
public string LoadingMessage { get; set; }This property can be used for customizing and localizing the text of the loading message.
Gets the localization.
[PersistenceMode(PersistenceMode.InnerProperty)]
public ComboBoxStrings Localization { get; }The localization.
Gets or sets a value indicating where RadComboBox will look for its .resx localization files.
public string LocalizationPath { get; set; }The localization path.
Gets or sets a value indicating whether the combobox should automatically autocomplete and highlight the currently typed text to the closest item text match.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("markFirstMatch")]
public bool MarkFirstMatch { get; set; }Gets or sets the max height of the dropdown in pixels.
[Bindable(true)]
public Unit MaxHeight { get; set; }Gets or sets the maximum number of characters allowed in the combobox.
public virtual int MaxLength { get; set; }Gets or sets the minimum length of the typed text before the control initiates a request for new Items when EnableLoadOnDemand is True.
[ClientControlProperty]
[ClientPropertyName("_minFilterLength")]
public int MinFilterLength { get; set; }The length of the min filter.
Gets or sets a value indicating whether the text in a combobox item automatically continues on the next line when it reaches the end of the dropdown.
[Bindable(false)]
public bool NoWrap { get; set; }Gets or sets a value indicating the horizontal offset of the combobox dropdown
[ClientControlProperty]
[ClientPropertyName("offsetX")]
public int OffsetX { get; set; }An integer specifying the horizontal offset of the combobox dropdown (measured in pixels). The default value is 0 (no offset).
Use the OffsetX property to change the position of the combobox dropdown
To customize the vertical offset use the OffsetY property.
Gets or sets a value indicating the vertical offset of the combobox dropdown.
[ClientControlProperty]
[ClientPropertyName("offsetY")]
public int OffsetY { get; set; }An integer specifying the vertical offset of the combobox dropdown(measured in pixels). The default value is 0 (no offset).
Use the OffsetY property to change the position where the combobox dropdown will appear.
To customize the horizontal offset use the OffsetX property.
The client-side event that is fired when when the combo loses focus
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("onClientBlur")]
public string OnClientBlur { get; set; }The event handler receives two parameter: the instance of the combobox client-side object and event args.
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.
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.
The client-side event that is fired after the dropdown of the combobox is closed.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownClosed")]
public string OnClientDropDownClosed { get; set; }The event handler receives two parameter: the instance of the combobox client-side object and event args. The event can not be cancelled
The client-side event that is fired before the dropdown of the combobox is closed.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownClosing")]
public string OnClientDropDownClosing { get; set; }The event handler receives two parameter: the instance of the combobox client-side object and event args. The event can be cancelled - simply set args.set_cancel to true args.set_cancel(true); from the event handler and the combobox dropdown will not be closed.
The client-side event that is fired after the dropdown of the combobox is opened.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownOpened")]
public string OnClientDropDownOpened { get; set; }The event handler receives two parameter: the instance of the combobox client-side object and event args. The event cannot be cancelled.
The client-side event that is fired before the dropdown of the combobox is opened.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("dropDownOpening")]
public string OnClientDropDownOpening { get; set; }The event handler receives two parameter: the instance of the combobox client-side object and event args. The event can be cancelled - simply set args.set_cancel to true args.set_cancel(true); from the event handler and the combobox dropdown will not be opened.
The client-side event that is fired when when the combo gains focus
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("onClientFocus")]
public string OnClientFocus { get; set; }The event handler receives two parameter: the instance of the combobox client-side object and event args.
The client-side event that is fired after a RadComboBox item has been checked.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemChecked")]
public string OnClientItemChecked { get; set; }The event handler receives two parameters: the instance of of the combobox client-side object and event argument with the newly checked item.
The client-side event that is fired when a RadComboBox item is about to be checked.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemChecking")]
public string OnClientItemChecking { get; set; }The event handler receives two parameters: the instance of of the RadComboBox client-side object and event argument of the newly checked item.
The event can be cancelled - simply call args.set_cancel(true); from the event handler and the item will not be changed.
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; }Gets or sets a value indicating the client-side event handler that is called when the RadComboBox items were just populated (for example from web service).
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemsRequested")]
public string OnClientItemsRequested { get; set; }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 RadComboBox 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.
Gets or sets a value indicating the client-side event handler that is called when the operation for populating the RadComboBox has failed.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemsRequestFailed")]
public string OnClientItemsRequestFailed { get; set; }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 RadComboBox 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.
Gets or sets a value indicating the client-side event handler that is called when the RadComboBox is about to be populated (for example from web service).
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("itemsRequesting")]
public string OnClientItemsRequesting { get; set; }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 RadComboBox is about to be populated. Two parameters are passed to the handler:
- sender, the menu 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.
The client-side event that is fired when the user presses a key inside the combobox.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("keyPressing")]
public string OnClientKeyPressing { get; set; }The event handler receives two parameters:
- the instance of the combobox client-side object;
- browser event arguments.
You can use the browser event arguments (and the keyCode property in particular) to detect which key was pressed and to write your own custom logic.
Gets or sets a value indicating the client-side event handler that is called after the RadComboBox client-side object is initialized.
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClienLoad client-side event handler is called after the combobox is fully initialized on the client.
A single parameter - the combobox client object - is passed to the handler.
This event cannot be cancelled.
The client-side event that is fired after the selected index of the RadComboBox has been changed.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("selectedIndexChanged")]
public string OnClientSelectedIndexChanged { get; set; }The event handler receives two parameters: the instance of of the combobox client-side object and event argument with the newly selected item.
The client-side event that is fired when the selected index of the RadComboBox is about to be changed.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("selectedIndexChanging")]
public string OnClientSelectedIndexChanging { get; set; }The event handler receives two parameters: the instance of of the RadComboBox client-side object and event argument of the newly selected item.
The event can be cancelled - simply call args.set_cancel(true); from the event handler and the item will not be changed.
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; }The client-side event that is fired when the selected index of RadCombobox has changed.
[Bindable(false)]
[ClientControlEvent]
[ClientPropertyName("textChange")]
public string OnClientTextChange { get; set; }The on client text change.
Gets or sets a value that indicates whether the dropdown of the combobox should be opened by default on loadnig the page.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_openDropDownOnLoad")]
public bool OpenDropDownOnLoad { get; set; }Sets or gets the position (left or right) of the arrow image dropdown.
[Bindable(false)]
public RadComboBoxImagePosition RadComboBoxImagePosition { get; set; }By default the image is shown on the right. Left can be used in RTL (right-to-left) language scenarios.
Gets or sets a value indicating whether the ComboBox should render as a <select> element. When enabled the ComboBox will have its functionality reduced to that of the <select> element.
[Obsolete("This property is obsolete. Use RenderMode.Native instead")]
public RadComboBoxRenderingMode RenderingMode { get; set; }protected DataSourceSelectArguments SelectArguments { get; }Gets the index of the currently selected item in the combobox.
[Bindable(true)]
[Browsable(false)]
[ClientControlProperty]
[ClientPropertyName("selectedIndex")]
public virtual int SelectedIndex { get; set; }Gets the currently selected item in the combobox.
[Bindable(false)]
[Browsable(false)]
public virtual RadComboBoxItem SelectedItem { get; }SelectedItem can be null in load-on-demand or AllowCustomText modes. End-users can type any text.
Gets the value of the currently selected item in the combobox.
[Browsable(false)]
[Bindable(true, BindingDirection.TwoWay)]
[Themeable(false)]
[ClientControlProperty]
[ClientPropertyName("_value")]
public virtual string SelectedValue { get; set; }Determines whether the dropdown shows when the user clicks in the input field.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_showDropDownOnTextboxClick")]
public bool ShowDropDownOnTextboxClick { get; set; }Gets or sets a value indicating whether the combobox should display the box for requesting additional items
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_showMoreResultsBox")]
public bool ShowMoreResultsBox { get; set; }Gets or sets a value indicating whether the dropdown image next to the combobox text area should be displayed.
[Bindable(false)]
public bool ShowToggleImage { get; set; }The dropdown image is located in the Skins folder of the combo - by default ~/RadControls/ComboBox/Skins/{SkinName}/DropArrow.gif. You can custmoize or modify the image and place it in the respective folder of the skin you are using.
Indicates whether the combobox will be visible while loading.
[Bindable(false)]
public bool ShowWhileLoading { get; set; }public virtual string SmartPasteDescription { get; set; }Automatically sorts items alphabetically (based on the Text property) in ascending or descending order.
[Bindable(false)]
public RadComboBoxSort Sort { get; set; }Gets/sets whether the sorting will be case-sensitive or not. By default is set to true.
[Bindable(false)]
public bool SortCaseSensitive { get; set; }protected override bool SupportsRenderingMode { get; }Overrides:
Gets or sets the text content of the RadComboBox control.
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_text")]
public string Text { get; set; }In standard mode, the currently selected text can be accessed using both the Text property or RadCombobox.SelectedItem.Text. In AJAX callback modes, only the Text property can be used because end-users can type or paste text that does not match the text of any item and SelectedItem can be null.
Gets the unique, hierarchically qualified identifier for the server control.
[ClientControlProperty]
[ClientPropertyName("_uniqueId")]
public override string UniqueID { get; }The fully qualified identifier for the server control.
Overrides:
Gets the settings for the web service used to populate items.
[PersistenceMode(PersistenceMode.InnerProperty)]
public NavigationControlWebServiceSettings WebServiceSettings { get; }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 RadComboBoxItemData[] 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;
//... }}
The HTML Z-index of the items dropdown of RadComboBox.Its default value is 6000.
[Bindable(false)]
public int ZIndex { get; set; }Can be used when the dropdown is to be shown over content with a specified Z-index. If the combobox items dropdown is displayed below the content, set the ZIndex property to a value higher than the value of the HTML content below.
Methods
protected override void AddAttributesToRender(HtmlTextWriter writer)Overrides:
Clears the checked items. The Checked property of all items is set to false.
public virtual void ClearCheckedItems()Clears out the list selection and sets the Selected property of all items to false.
public virtual void ClearSelection()Use this method to reset the control so that no items are selected.
protected override void CreateChildControls()Overrides:
protected override ControlItemCollection CreateChildItemCollection()Overrides:
Creates a DataSourceSelectArguments object that is configured for paging if the underlying data source supports it.
protected override DataSourceSelectArguments CreateDataSourceSelectArguments()A DataSourceSelectArguments initialized for paging if the underlying data source supports it.
Overrides:
Binds a data source to the invoked RadComboBox and all its child controls. Does not bind the control if EnableAutomaticLoadOnDemand is true and the page request is not a callback.
public override void DataBind()Overrides:
protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
Returns the first RadComboBoxItem that matches the conditions defined by the specified predicate. The predicate should returns a boolean value.
public RadComboBoxItem FindItem(Predicate<RadComboBoxItem> match)The Predicate <> that defines the conditions of the element to search for.
Returns:Finds the first RadComboBoxItem with Text that matches the given text value.
public RadComboBoxItem FindItemByText(string text, bool ignoreCase)The string to search for.
ignoreCaseboolA Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
Returns:The first RadComboBoxItem that matches the specified text value.
Finds the first RadComboBoxItem with Text that matches the given text value.
public RadComboBoxItem FindItemByText(string text)The string to search for.
Returns:The first RadComboBoxItem that matches the specified text value.
Finds the first RadComboBoxItem with Value that matches the given value.
public RadComboBoxItem FindItemByValue(string value, bool ignoreCase)The value to search for.
ignoreCaseboolA Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison).
Returns:The first RadComboBoxItem that matches the specified value.
Finds the first RadComboBoxItem with Value that matches the given value.
public RadComboBoxItem FindItemByValue(string value)The value to search for.
Returns:The first RadComboBoxItem that matches the specified value.
Returns the index of the first RadComboBoxItem with Text that matches the given text value.
Returns the index of the first RadComboBoxItem with Value that matches the given value.
public override void Focus()Overrides:
Gets an array containing the indices of the currently checked items in the RadComboBox control.
Loads combobox items from an XML content file.
protected override void LoadControlState(object savedState)Overrides:
Executed when post data is loaded from the request
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)Overrides:
Raises the CheckAllCheck event.
protected virtual void OnCheckAllCheck(RadComboBoxCheckAllCheckEventArgs e)The RadComboBoxCheckAllCheckEventArgs instance containing the event data.
Raises the ItemChecked event.
protected virtual void OnItemChecked(RadComboBoxItemEventArgs e)The RadComboBoxItemEventArgs instance containing the event data.
Raises the ItematCreated event.
protected virtual void OnItemCreated(RadComboBoxItemEventArgs e)Raises the ItemDataBound event.
protected virtual void OnItemDataBound(RadComboBoxItemEventArgs e)Raises the ItemRequestEvent event. This allows you to handle the event directly.
protected virtual void OnItemsRequested(RadComboBoxItemsRequestedEventArgs args)Raises the SelectedIndexChanged event. This allows you to handle the event directly.
protected virtual void OnSelectedIndexChanged()protected virtual void OnTemplateNeeded(RadComboBoxItemEventArgs e)Raises the TextChanged event. This allows you to handle the event directly.
protected override void PerformDataBinding(IEnumerable dataSource)Overrides:
protected override void PerformSelect()Overrides:
protected override void RaiseItemDataBound(ControlItem item)Overrides:
Signals the RadComboBox control to notify the ASP.NET application that the state of the control has changed.
protected override void RaisePostDataChangedEvent()Overrides:
protected virtual void RaiseSelectedIndexChandedEvent()protected override void RaiseTemplateNeeded(ControlItem item)Overrides:
Raises the TextChange event. This allows you to handle the event directly.
protected virtual void RaiseTextChandedEvent()Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
public override void RenderBeginTag(HtmlTextWriter writer)A HtmlTextWriter that represents the output stream to render HTML content on the client.
Overrides:
protected virtual void RenderBrowserSpecificStyles(HtmlTextWriter writer)protected override void RenderContents(HtmlTextWriter writer)Overrides:
Override in an inheritor and return false in order to skip Loading/Saving ControlState.
Sorts the items in the RadComboBox.
public void SortItems()Sorts the items in the RadComboBox.
public void SortItems(IComparer comparer)An object from IComparer interface.
Events
Occurs when the CheckAll checkbox is checked or unchecked.
public event RadComboBoxCheckAllCheckEventHandler CheckAllCheckOccurs when an item is checked
public event RadComboBoxItemEventHandler ItemCheckedOccurs on the server when an item in the RadComboBox control is created.
public event RadComboBoxItemEventHandler ItemCreatedThe 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 RadComboBoxItem to be equal to the Text property.
Occurs after an item is data bound to the RadComboBox control.
public event RadComboBoxItemEventHandler ItemDataBoundThis event provides you with the last opportunity to access the data item before it is displayed on the client. After this event is raised, the data item is nulled out and no longer available.
Occurs when RadComboBox initiates an AJAX callback to the server.
public event RadComboBoxItemsRequestedEventHandler ItemsRequestedOccurs when the SelectedIndex property has changed.
public event RadComboBoxSelectedIndexChangedEventHandler SelectedIndexChangedYou can create an event handler for this event to determine when the selected index in the RadComboBox has been changed. This can be useful when you need to display information in other controls based on the current selection in the RadComboBox. You can use the event handler to load the information in the other controls.
Occurs before template is being applied to the item.
public event RadComboBoxItemEventHandler TemplateNeededThe 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.
Occurs when the text of the RadComboBox changes between postbacks to the server.
public event EventHandler TextChangedImplements: