New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

C#
[EmbeddedSkin("SearchBox", typeof(RadSearchBox))]
[EmbeddedSkin("SearchBox", "Default", typeof(RadSearchBox))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadSearchBox))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredScript(typeof(jQueryPlugins), 1)]
[RequiredScript(typeof(DropDown), 2)]
[RequiredScript(typeof(ChangeLog), 3)]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadSearchBox", "Telerik.Web.UI.SearchBox.RadSearchBoxScripts.js")]
[TelerikToolboxCategory("Data Editing")]
public class RadSearchBox : RadDataBoundControl, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, IPostBackEventHandler, ICallbackEventHandler, IFlatBoundContainer, INamingContainer

Inheritance: objectRadDataBoundControlRadSearchBox

Implements: ICallbackEventHandlerIControlIControlResolverIFeatureGroupIFlatBoundContainerINamingContainerIPostBackDataHandlerIPostBackEventHandlerIScriptControlISkinnableControl...

Inherited Members RadDataBoundControl.ResolveRenderMode()RadDataBoundControl.CanRenderInMode(RenderModeBrowserAdaptor, RenderMode)RadDataBoundControl.PreferredRenderMode(RenderModeBrowserAdaptor)RadDataBoundControl.GetSkinSuffix()RadDataBoundControl.OnPreRender(EventArgs)RadDataBoundControl.ControlPreRender()RadDataBoundControl.RenderSmartPasteDescriptionAttribute()RadDataBoundControl.ConfigureCombinedScriptFile()RadDataBoundControl.ConfigureCombinedBaseSkinFile()RadDataBoundControl.RegisterScriptControl()RadDataBoundControl.RegisterCssReferences()RadDataBoundControl.RegisterScriptDescriptors()RadDataBoundControl.LoadClientState(Dictionary<string, object>)RadDataBoundControl.SaveClientState()RadDataBoundControl.RenderClientStateField(HtmlTextWriter)RadDataBoundControl.RenderBeginTag(HtmlTextWriter)RadDataBoundControl.RenderEndTag(HtmlTextWriter)RadDataBoundControl.Render(HtmlTextWriter)RadDataBoundControl.RenderScriptsNoScriptManager(HtmlTextWriter)RadDataBoundControl.RenderDescriptorsNoScriptManager(HtmlTextWriter)RadDataBoundControl.ApplyConditionalRendering(HtmlTextWriter)RadDataBoundControl.RenderClassic(HtmlTextWriter)RadDataBoundControl.RenderLite(HtmlTextWriter)RadDataBoundControl.RenderNative(HtmlTextWriter)RadDataBoundControl.InitializeRenderMode()RadDataBoundControl.OnInit(EventArgs)RadDataBoundControl.DescribeRenderingMode(IScriptDescriptor)RadDataBoundControl.DescribeProperty<T>(IScriptDescriptor, string, T, T)RadDataBoundControl.DescribeEvent(IScriptDescriptor, string, string)RadDataBoundControl.GetEmbeddedSkinNames()RadDataBoundControl.GetScriptDescriptors()RadDataBoundControl.GetScriptReferences()RadDataBoundControl.GetViewScriptReference()RadDataBoundControl.RaisePostDataChangedEvent()RadDataBoundControl.GetViewStateValue<T>(string, T)RadDataBoundControl.FeatureGroupIDRadDataBoundControl.RegisterWithScriptManagerRadDataBoundControl.SkinRadDataBoundControl.EnableRippleEffectRadDataBoundControl.EnableEmbeddedScriptsRadDataBoundControl.EnableEmbeddedSkinsRadDataBoundControl.EnableEmbeddedBaseStylesheetRadDataBoundControl.ODataDataSourceIDRadDataBoundControl.ClientDataSourceIDRadDataBoundControl.DataModelIDRadDataBoundControl.RuntimeSkinRadDataBoundControl.EnableAjaxSkinRenderingRadDataBoundControl.ClientStateFieldIDRadDataBoundControl.RenderModeRadDataBoundControl.ResolvedRenderModeRadDataBoundControl.SupportsAdaptiveRenderingRadDataBoundControl.SupportsNativeRenderingRadDataBoundControl.SupportsLightweightRenderingRadDataBoundControl.DefaultCssClassRadDataBoundControl.IsRenderModeSetRadDataBoundControl.IsBoundUsingODataRadDataBoundControl.IsBoundUsingClientDataSourceRadDataBoundControl.RenderingCompatibilityRadDataBoundControl.ClientIDModeRadDataBoundControl.ScriptManagerRadDataBoundControl.RadScriptManagerRadDataBoundControl.RadStyleSheetManagerRadDataBoundControl.RendererRadDataBoundControl.AccessKeyRadDataBoundControl.BackColorRadDataBoundControl.BorderColorRadDataBoundControl.BorderStyleRadDataBoundControl.BorderWidthRadDataBoundControl.CssClassRadDataBoundControl.EnabledRadDataBoundControl.EnableThemingRadDataBoundControl.ForeColorRadDataBoundControl.FontRadDataBoundControl.SkinIDRadDataBoundControl.VisibleRadDataBoundControl.WidthRadDataBoundControl.TabIndexRadDataBoundControl.ToolTipRadDataBoundControl.DataMemberRadDataBoundControl.DataSourceRadDataBoundControl.DataSourceIDRadDataBoundControl.EnableViewState...

Constructors

C#
public RadSearchBox()

Properties

C#
public SearchBoxButtonCollection Buttons { get; }
C#
protected SearchBoxButtonCollection Children { get; }
C#
public AnimationSettings CollapseAnimation { get; }
C#
public string ControlId { get; }
C#
protected override string CssClassFormatString { get; }

Overrides: RadDataBoundControl.CssClassFormatString

C#
public CultureInfo Culture { get; set; }
C#
public virtual string DataContextKeyField { get; set; }
C#
[SuppressMessage("Microsoft.Performance", "CA1819:PropertiesShouldNotReturnArrays")]
[TypeConverter(typeof(ListConverter))]
public virtual string[] DataKeyNames { get; set; }
C#
public virtual string DataTextField { get; set; }

Implements: IFlatBoundContainer.DataTextField

C#
public virtual string DataTextFormatString { get; set; }
C#
public virtual string DataValueField { get; set; }

Implements: IFlatBoundContainer.DataValueField

C#
public DropDownSettings DropDownSettings { get; }
C#
[ClientControlProperty]
[ClientPropertyName("_emptyMessage")]
[Bindable(false)]
public virtual string EmptyMessage { get; set; }
C#
[ClientControlProperty]
[ClientPropertyName("_enableAriaSupport")]
public bool EnableAriaSupport { get; set; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableAutoComplete")]
public virtual bool EnableAutoComplete { get; set; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableDirectionDetection")]
public bool EnableDirectionDetection { get; set; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_enableScreenBoundaryDetection")]
public bool EnableScreenBoundaryDetection { get; set; }
C#
public AnimationSettings ExpandAnimation { get; }
C#
[Bindable(false)]
[ClientControlProperty]
public SearchBoxFilter Filter { get; set; }

Height

Unit

C#
public override Unit Height { get; }

Overrides: RadDataBoundControl.Height

C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_highlightFirstMatch")]
public virtual bool HighlightFirstMatch { get; set; }
C#
protected SearchContext InnerContext { get; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("isCaseSensitive")]
public bool IsCaseSensitive { get; set; }
C#
public string Label { get; set; }
C#
public string LabelCssClass { get; set; }
C#
public Unit LabelWidth { get; set; }
C#
[TypeConverter(typeof(ExpandableObjectConverter))]
public SearchBoxLocalization Localization { get; }
C#
public string LocalizationPath { get; set; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("maxResultCount")]
public virtual int MaxResultCount { get; set; }
C#
[ClientControlProperty]
public virtual int MinFilterLength { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("buttonCommand")]
public string OnClientButtonCommand { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("dataRequesting")]
public string OnClientDataRequesting { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }
C#
[ClientControlEvent]
[ClientPropertyName("search")]
public string OnClientSearch { get; set; }
C#
public SearchContext SearchContext { get; }

SelectArguments

DataSourceSelectArguments

C#
protected DataSourceSelectArguments SelectArguments { get; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("showLoadingIcon")]
public bool ShowLoadingIcon { get; set; }
C#
[Bindable(false)]
[ClientControlProperty]
[ClientPropertyName("_showSearchButton")]
public virtual bool ShowSearchButton { get; set; }
C#
protected override bool SupportsRenderingMode { get; }

Overrides: RadDataBoundControl.SupportsRenderingMode

TagKey

HtmlTextWriterTag

C#
protected override HtmlTextWriterTag TagKey { get; }
C#
[Browsable(false)]
[Bindable(false)]
public virtual string Text { get; set; }
C#
[ClientControlProperty]
[ClientPropertyName("_uniqueId")]
public override string UniqueID { get; }
C#
public WebServiceSettings WebServiceSettings { get; }

Methods

C#
protected override void AddAttributesToRender(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.AddAttributesToRender(HtmlTextWriter)

C#
protected override void CreateChildControls()
C#
protected override IRenderer CreateControlRenderer()
Returns:

IRenderer

Overrides: RadDataBoundControl.CreateControlRenderer()

C#
protected override DataSourceSelectArguments CreateDataSourceSelectArguments()
Returns:

DataSourceSelectArguments

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientProperties(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeClientProperties(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadDataBoundControl.DescribeComponent(IScriptDescriptor)

C#
[SuppressMessage("Microsoft.Design", "CA1063:ImplementIDisposableCorrectly")]
public override void Dispose()
C#
protected virtual void Dispose(bool disposing)
Parameters:disposingbool
C#
public override void Focus()
C#
protected string GetPostbackEventReference()
Returns:

string

C#
protected void LoadDropDownItems(SearchBoxContext context)
Parameters:contextSearchBoxContext
C#
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)
Parameters:postDataKeystringpostCollectionNameValueCollectionReturns:

bool

Overrides: RadDataBoundControl.LoadPostData(string, NameValueCollection)

C#
protected override void LoadViewState(object savedState)
Parameters:savedStateobject
C#
protected void OnButtonCommand(SearchBoxButtonEventArgs e)
Parameters:eSearchBoxButtonEventArgs
C#
protected bool OnDataSourceSelect(SearchBoxDataSourceSelectEventArgs e)
Parameters:eSearchBoxDataSourceSelectEventArgsReturns:

bool

C#
protected override void OnPagePreLoad(object sender, EventArgs e)
Parameters:senderobjecteEventArgs
C#
protected void OnSearch(SearchBoxEventArgs e)
Parameters:eSearchBoxEventArgs
C#
protected virtual void RaisePostBackEvent(string eventArgument)
Parameters:eventArgumentstring
C#
protected override void RenderContents(HtmlTextWriter writer)
Parameters:writerHtmlTextWriter

Overrides: RadDataBoundControl.RenderContents(HtmlTextWriter)

C#
protected override object SaveViewState()
Returns:

object

C#
protected override void TrackViewState()

Events

C#
public event SearchBoxButtonEventHandler ButtonCommand
C#
public event SearchBoxDataSourceSelectEventHandler DataSourceSelect
C#
public event SearchBoxEventHandler Search