Back to all docs
API Reference / Telerik.WebAii.Controls.Html / RadComboBox

Class
RadComboBox

Represents the RadComboBox class.

Definition

Namespace:Telerik.WebAii.Controls.Html

Assembly:Telerik.WebAii.Controls.Html.dll

Syntax:
cs-api-definition
public class RadComboBox : HtmlContainerControl

Inheritance: objectControlHtmlControlHtmlContainerControlRadComboBox

Inherited Members HtmlContainerControl.TextContentHtmlContainerControl.InnerTextHtmlControl.FindParentContainer<TContainerControl>()HtmlControl.ValidateTag(string)HtmlControl.ValidateControl()HtmlControl.ParseResponseValue<T>(string, T)HtmlControl.GetAttributeAsString(string)HtmlControl.InitializeMappings(MappingsCollection)HtmlControl.GetRectangle()HtmlControl.IsVisible()HtmlControl.GetStyleValue(string)HtmlControl.GetStyle(string)HtmlControl.GetComputedStyleValue(string)HtmlControl.GetComputedStyle(string)HtmlControl.Parent<TContainerControl>()HtmlControl.Capture()HtmlControl.Capture(string, string)HtmlControl.Capture(string)HtmlControl.InvokeEvent(ScriptEventType)HtmlControl.InvokeEvent(ScriptEventType, bool)HtmlControl.InvokeEvent(ScriptEvent)HtmlControl.InvokeEvent(ScriptEvent, bool)HtmlControl.AddEventListener(string, EventHandler<JavascriptEventArgs>)HtmlControl.RemoveEventListener(string, EventHandler<JavascriptEventArgs>)HtmlControl.MouseClick()HtmlControl.MouseClick(MouseClickType)HtmlControl.MouseClick(MouseClickType, int, int)HtmlControl.MouseClick(MouseClickType, Point, OffsetReference)HtmlControl.MouseClick(MouseClickType, int, int, OffsetReference)HtmlControl.MouseHover()HtmlControl.MouseHover(Point)HtmlControl.MouseHover(int, int)HtmlControl.MouseHover(int, int, OffsetReference)HtmlControl.Click()HtmlControl.Click(bool)HtmlControl.ScrollToVisible()HtmlControl.ScrollToVisible(ScrollToVisibleType)HtmlControl.ScrollToVisible(ScrollToVisibleType, Rectangle)HtmlControl.Download(bool, DownloadOption, string, int)HtmlControl.CallMethod(string)HtmlControl.CallMethod<T>(string)HtmlControl.CallMethod<T>(string, T)HtmlControl.GetValue<T>(string)HtmlControl.GetValue<T>(string, T)HtmlControl.GetValue<T>(string, bool)HtmlControl.GetValue<T>(string, bool, T)HtmlControl.SetValue<T>(string, T)HtmlControl.SetValue<T>(string, T, bool)HtmlControl.Focus()HtmlControl.DragTo(OffsetReference, Point, int, int)HtmlControl.DragTo(OffsetReference, int, int, Rectangle, OffsetReference, int, int)HtmlControl.DragTo(Point)HtmlControl.DragTo(int, int)HtmlControl.DragTo(HtmlControl)HtmlControl.DragTo(HtmlControl, OffsetReference, Point)HtmlControl.DragTo(OffsetReference, Point, HtmlControl)HtmlControl.DragTo(OffsetReference, Point, HtmlControl, OffsetReference, Point)HtmlControl.DragTo(OffsetReference, int, int, bool, HtmlControl, OffsetReference, int, int, bool)HtmlControl.DragToWindowLocation(OffsetReference, int, int, bool, OffsetReference, int, int, bool)HtmlControl.ToString()HtmlControl.AsjQueryControl()HtmlControl.GetElementByTagNameClientSideLocatorHtmlControl.GetElementByIdClientSideLocatorHtmlControl.FindHtmlControl.ScrollTopHtmlControl.ScrollLeftHtmlControl.WaitHtmlControl.IDHtmlControl.CssClassHtmlControl.AttributesHtmlControl.MappingsHtmlControl.StylesHtmlControl.EventsHtmlControl.TagNameHtmlControl.ChildNodesHtmlControl.IsActiveElementHtmlControl.IsEnabledControl.Refresh()Control.AssignFailed(Exception)Control.SetTelerikComponentsVersion(TelerikComponentsVersion?)Control.MatchControl(Element, FindParam)Control.GetFamilyElement(int, Element)Control.ThrowOnInvalidAssignmentControl.TelerikComponentsVersionControl.IsRefreshControl.BaseElementControl.OwnerBrowserControl.Locator

Constructors

RadComboBox()

Initializes a new instance of the RadComboBox class.

Declaration

cs-api-definition
public RadComboBox()

RadComboBox(Element)

Initializes a new instance of the RadComboBox class.

Declaration

cs-api-definition
public RadComboBox(Element element)

Parameters

element

Element

Properties

CheckBoxesEnabled

Get whether the ComboBox check box support is enabled.

Declaration

cs-api-definition
public bool CheckBoxesEnabled { get; }

Property Value

bool

CheckedItems

Declaration

cs-api-definition
public IList<RadComboBoxItem> CheckedItems { get; }

Property Value

IList<RadComboBoxItem>

ClientSideLocator

Get the locator FindParam.

Declaration

cs-api-definition
public override string ClientSideLocator { get; }

Property Value

string

Overrides HtmlControl.ClientSideLocator

ComboBoxValue

Gets or set the ComboBox value.

Declaration

cs-api-definition
public string ComboBoxValue { get; set; }

Property Value

string

DropDownDiv

Get the drop down div.

Declaration

cs-api-definition
public HtmlDiv DropDownDiv { get; }

Property Value

HtmlDiv

DropDownVisible

Gets whether the drop down is visible.

Declaration

cs-api-definition
public bool DropDownVisible { get; }

Property Value

bool

DropDownWidth

Get the drop down width.

Declaration

cs-api-definition
public int DropDownWidth { get; }

Property Value

int

ElementOffsetWidth

Get the offset width of the combobox element.

Declaration

cs-api-definition
public int ElementOffsetWidth { get; }

Property Value

int

EmptyMessage

Gets or set the empty message text of the RadComboBox.

Declaration

cs-api-definition
public string EmptyMessage { get; set; }

Property Value

string

Enabled

Get whether combobox is enabled.

Declaration

cs-api-definition
public bool Enabled { get; }

Property Value

bool

FilterEnabled

Get whether combobox filtering is enabled.

Declaration

cs-api-definition
public bool FilterEnabled { get; }

Property Value

bool

ItemCount

Used for verifications when SimpleRendering is enabled.

Declaration

cs-api-definition
public int ItemCount { get; }

Property Value

int

Items

Get the list of items.

Declaration

cs-api-definition
public IList<RadComboBoxItem> Items { get; }

Property Value

IList<RadComboBoxItem>

LastWord

Gets the word after the last separator in the text of the combobox. If a separator is not set, returns the text itself.

Declaration

cs-api-definition
public string LastWord { get; }

Property Value

string

LocatorExpression

Get the FindExpression.

Declaration

cs-api-definition
public override IFindExpression LocatorExpression { get; }

Property Value

IFindExpression

Overrides Control.LocatorExpression

RenderMode

Render mode of combobox.

Declaration

cs-api-definition
public RenderMode RenderMode { get; }

Property Value

RenderMode

SelectedIndex

Gets the selected index of the RadComboBox. Returns '-1' if there is no selected item.

Declaration

cs-api-definition
public int SelectedIndex { get; }

Property Value

int

SimpleRendering

Get whether combobox simple rendering is enabled.

Declaration

cs-api-definition
[Obsolete]
public bool SimpleRendering { get; }

Property Value

bool

Text

Gets or set the text of the RadComboBox.

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

VisibleItems

Get the list of the visible items.

Declaration

cs-api-definition
public IList<RadComboBoxItem> VisibleItems { get; }

Property Value

IList<RadComboBoxItem>

Methods

AssignElement(Element)

Assign the DOM element to be the RadComboBox control.

Declaration

cs-api-definition
public override void AssignElement(Element e)

Parameters

e

Element

Overrides HtmlContainerControl.AssignElement(Element)

ClearItems()

Clears all items of the combobox.

Declaration

cs-api-definition
public void ClearItems()

ClearSelection()

Clears the selection.

Declaration

cs-api-definition
public void ClearSelection()

ControlAssert()

Returns RadControlAssert instance initialized for this control.

Declaration

cs-api-definition
public RadControlAssert ControlAssert()

Returns

RadControlAssert

RadControlAssert instance initialized for this control.

Disable()

Disables the combo box.

Declaration

cs-api-definition
public void Disable()

Enable()

Enables the combo box.

Declaration

cs-api-definition
public void Enable()

FindItem(Predicate<RadComboBoxItem>)

Find item by given predicate.

Declaration

cs-api-definition
public RadComboBoxItem FindItem(Predicate<RadComboBoxItem> predicate)

Parameters

predicate

Predicate<RadComboBoxItem>

The predicate used as a search criteria.

Returns

RadComboBoxItem

The item found or 'null' if no item matches the given search criteria.

FindItemByIndex(int)

Finds item by Index.

Declaration

cs-api-definition
public RadComboBoxItem FindItemByIndex(int itemIndex)

Parameters

itemIndex

int

Returns

RadComboBoxItem

FindItemByText(string)

Finds item by Text.

Declaration

cs-api-definition
public RadComboBoxItem FindItemByText(string itemText)

Parameters

itemText

string

Returns

RadComboBoxItem

FindItemByValue(string)

Finds item by Value.

Declaration

cs-api-definition
public RadComboBoxItem FindItemByValue(string itemValue)

Parameters

itemValue

string

Returns

RadComboBoxItem

FindItemIndexByText(string)

Finds item index by text.

Declaration

cs-api-definition
public int FindItemIndexByText(string itemText)

Parameters

itemText

string

Returns

int

FindItemIndexByValue(string)

Finds item index by value.

Declaration

cs-api-definition
public int FindItemIndexByValue(string itemValue)

Parameters

itemValue

string

Returns

int

FindItems(Predicate<RadComboBoxItem>)

Get a list of items matching the given predicate.

Declaration

cs-api-definition
public IList<RadComboBoxItem> FindItems(Predicate<RadComboBoxItem> predicate)

Parameters

predicate

Predicate<RadComboBoxItem>

The predicate, i.e. (item => item.Text == myText).

Returns

IList<RadComboBoxItem>

The items matching the given predicate.

HideDropDown()

Hide the drop down of RadComboBox.

Declaration

cs-api-definition
public void HideDropDown()

SelectItemByIndex(int)

Selects item by index.

Declaration

cs-api-definition
public void SelectItemByIndex(int itemIndex)

Parameters

itemIndex

int

SelectItemByText(string)

Selects item by Text.

Declaration

cs-api-definition
public void SelectItemByText(string itemText)

Parameters

itemText

string

SelectItemByValue(string)

Selects item by Value.

Declaration

cs-api-definition
public void SelectItemByValue(string itemValue)

Parameters

itemValue

string

SetText(string, ScrollToVisibleType)

Types the given text to the ComboBox input using default typing speed. Swows the drop down as well.

Declaration

cs-api-definition
public void SetText(string text, ScrollToVisibleType scrollToVisibleType = ScrollToVisibleType.ElementTopAtWindowTop)

Parameters

text

string

The text to set.

scrollToVisibleType

ScrollToVisibleType

Specifies how element should be put into view.

SetText(string, int, ScrollToVisibleType)

Types the given text to the ComboBox input using default typing speed. Swows the drop down as well.

Declaration

cs-api-definition
public void SetText(string text, int typeSpeed, ScrollToVisibleType scrollToVisibleType = ScrollToVisibleType.ElementTopAtWindowTop)

Parameters

text

string

The text to set.

typeSpeed

int

The typing speed (characters typing) in milliseconds.

scrollToVisibleType

ScrollToVisibleType

Specifies how element should be put into view.

ShowDropDown()

Show the drop down of RadComboBox.

Declaration

cs-api-definition
public void ShowDropDown()

ToggleDropDown()

Toggle the drop down of RadComboBox.

Declaration

cs-api-definition
public void ToggleDropDown()
In this article
DefinitionConstructorsRadComboBox()RadComboBox(Element)PropertiesCheckBoxesEnabledCheckedItemsClientSideLocatorComboBoxValueDropDownDivDropDownVisibleDropDownWidthElementOffsetWidthEmptyMessageEnabledFilterEnabledItemCountItemsLastWordLocatorExpressionRenderModeSelectedIndexSimpleRenderingTextVisibleItemsMethodsAssignElement(Element)ClearItems()ClearSelection()ControlAssert()Disable()Enable()FindItem(Predicate<RadComboBoxItem>)FindItemByIndex(int)FindItemByText(string)FindItemByValue(string)FindItemIndexByText(string)FindItemIndexByValue(string)FindItems(Predicate<RadComboBoxItem>)HideDropDown()SelectItemByIndex(int)SelectItemByText(string)SelectItemByValue(string)SetText(string, ScrollToVisibleType)SetText(string, int, ScrollToVisibleType)ShowDropDown()ToggleDropDown()
Not finding the help you need?
Contact Support