Class
RadSearchBox

Represents the RadSearchBox class.

Definition

Namespace:Telerik.WebAii.Controls.Html

Assembly:Telerik.WebAii.Controls.Html.dll

Syntax:

cs-api-definition
public class RadSearchBox : HtmlContainerControl

Inheritance: objectControlHtmlControlHtmlContainerControlRadSearchBox

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

RadSearchBox()

Initializes a new instance of the SearchBox class.

Declaration

cs-api-definition
public RadSearchBox()

RadSearchBox(Element)

Initializes a new instance of the SearchBox class.

Declaration

cs-api-definition
public RadSearchBox(Element element)

Parameters

element

Element

Properties

ClientSideLocator

Get the locator FindParam.

Declaration

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

Property Value

string

Overrides HtmlControl.ClientSideLocator

ContextText

Gets the text of the context of the SearchBox.

Declaration

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

Property Value

string

Delimiter

Get the delimiter of the control.

Declaration

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

Property Value

string

DropDownItemCount

Get the drop down item count.

Declaration

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

Property Value

int

EmptyMessage

Gets or set the empty message text of the SearchBox.

Declaration

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

Property Value

string

Enabled

Get whether searchbox is enabled.

Declaration

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

Property Value

bool

LocatorExpression

Get the FindExpression.

Declaration

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

Property Value

IFindExpression

Overrides Control.LocatorExpression

PopupDiv

Get the popup div.

Declaration

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

Property Value

HtmlDiv

PopupVisible

Get whether the popup is visible.

Declaration

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

Property Value

bool

SearchContextDropDownItemCount

Get the search context drop down item count.

Declaration

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

Property Value

int

SearchContextEnabled

Get whether searchbox search context is enabled.

Declaration

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

Property Value

bool

SearchContextPopupDiv

Get the searchbox context popup div.

Declaration

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

Property Value

HtmlDiv

SearchContextPopupVisible

Get whether the search context popup is visible.

Declaration

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

Property Value

bool

Text

Gets the text of the SearchBox.

Declaration

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

Property Value

string

Methods

AssignElement(Element)

Assign the DOM element to be the SearchBox control.

Declaration

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

Parameters

e

Element

Overrides HtmlContainerControl.AssignElement(Element)

ControlAssert()

Returns RadControlAssert instance initialized for this control.

Declaration

cs-api-definition
public RadControlAssert ControlAssert()

Returns

RadControlAssert

RadControlAssert instance initialized for this control.

HideSearchBoxContextPopup()

Hide the search context popup of the SearchBox.

Declaration

cs-api-definition
public void HideSearchBoxContextPopup()

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

Declaration

cs-api-definition
public void Search()

SetText(string, ScrollToVisibleType)

Types the given text to the SearchBox 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 SearchBox 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.

ShowSearchBoxContextPopup()

Show the search context popup of the SearchBox.

Declaration

cs-api-definition
public void ShowSearchBoxContextPopup()