Web control giving the user a texbox to enter a search query, and submit button to run the search.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public class SearchBox : WebControl, IPostBackEventHandler, INamingContainer
public class SearchBox : WebControl, IPostBackEventHandler, INamingContainer
Public Class SearchBox Inherits WebControl Implements IPostBackEventHandler, INamingContainer
Public Class SearchBox Inherits WebControl Implements IPostBackEventHandler, INamingContainer
public ref class SearchBox : public WebControl, IPostBackEventHandler, INamingContainer
public ref class SearchBox : public WebControl, IPostBackEventHandler, INamingContainer
type SearchBox = class inherit WebControl interface IPostBackEventHandler interface INamingContainer end
type SearchBox = class inherit WebControl interface IPostBackEventHandler interface INamingContainer end
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | SearchBox()()()() |
Creates a new instance.
|
 | AccessKey | (Inherited from WebControl.) |
 | Adapter | (Inherited from Control.) |
 | AddAttributesToRender(HtmlTextWriter) | (Inherited from WebControl.) |
 | AddedControl(Control, Int32) | (Inherited from Control.) |
| AddParsedSubObject(Object) | (Inherited from Control.) |
| ApplyStyle(Style) | (Inherited from WebControl.) |
| ApplyStyleSheetSkin(Page) | (Inherited from Control.) |
| AppRelativeTemplateSourceDirectory | (Inherited from Control.) |
| Attributes | (Inherited from WebControl.) |
| AutoCompleteQuery |
Whether to provide auto-complete suggestions to the user as they type in the query text box (see remarks).
|
| AutoCompleteQueryFailSilent |
Whether to show warning messages about errors - advised to set to false for development.
|
| AutoCompleteQueryHideNoResultSuggestions |
Whether to hide suggestions that would yield no results - this puts more load on the server as it requires additional work.
|
| AutoCompleteQueryIndexDirectory |
The index directory to be used to find auto-complete suggestions.
|
| AutoCompleteQueryLoadPlugin |
Whether to load any plugin assembly from the configuration.
|
| AutoCompleteQueryMaxSuggestions |
The maximum number of auto complete suggestions to make.
|
| AutoCompleteQueryRunSearchOnSelect |
Whether to automatically run the search when the user selects an auto-complete item from the list.
|
| AutoCompleteQueryShowNumberOfResults |
Whether to list the predicated number of results for each auto-complete suggestion - adds server load when true.
|
| AutoCompleteQuerySuggestionSource |
The source of data for auto-complete suggestions.
|
| BackColor | (Inherited from WebControl.) |
| BeginRenderTracing(TextWriter, Object) | (Inherited from Control.) |
| BindingContainer | (Inherited from Control.) |
| BorderColor | (Inherited from WebControl.) |
| BorderStyle | (Inherited from WebControl.) |
| BorderWidth | (Inherited from WebControl.) |
| BuildProfileTree(String, Boolean) | (Inherited from Control.) |
| ChildControlsCreated | (Inherited from Control.) |
| ClearCachedClientID()()()() | (Inherited from Control.) |
| ClearChildControlState()()()() | (Inherited from Control.) |
| ClearChildState()()()() | (Inherited from Control.) |
| ClearChildViewState()()()() | (Inherited from Control.) |
| ClearEffectiveClientIDMode()()()() | (Inherited from Control.) |
| ClientFilesLocation | Whether to use the internal client files, or external files (for customization). |
| ClientID | (Inherited from Control.) |
| ClientIDMode | (Inherited from Control.) |
| ClientIDSeparator | (Inherited from Control.) |
 | Context | (Inherited from Control.) |
| Controls | (Inherited from Control.) |
| ControlStyle | (Inherited from WebControl.) |
| ControlStyleCreated | (Inherited from WebControl.) |
| CopyBaseAttributes(WebControl) | (Inherited from WebControl.) |
| CreateChildControls()()()() |
Creates and adds child controls.
(Overrides Control.CreateChildControls()()()().) |
| CreateControlCollection()()()() | (Inherited from Control.) |
| CreateControlStyle()()()() | (Inherited from WebControl.) |
| CssClass | (Inherited from WebControl.) |
| DataBind()()()() | (Inherited from Control.) |
| DataBind(Boolean) | (Inherited from Control.) |
| DataBindChildren()()()() | (Inherited from Control.) |
 | DataBinding | (Inherited from Control.) |
| DataItemContainer | (Inherited from Control.) |
| DataKeysContainer | (Inherited from Control.) |
| DesignMode | (Inherited from Control.) |
| Dispose()()()() | (Inherited from Control.) |
| Disposed | (Inherited from Control.) |
| Enabled | (Inherited from WebControl.) |
| EnableTheming | (Inherited from WebControl.) |
| EnableViewState | (Inherited from Control.) |
| EndRenderTracing(TextWriter, Object) | (Inherited from Control.) |
| EnsureChildControls()()()() | (Inherited from Control.) |
| EnsureID()()()() | (Inherited from Control.) |
| EnterSubmitsSearch |
Whether to submit the search when the user presses enter and focus is in the search text box (default=true).
|
| Equals(Object) | (Inherited from Object.) |
| Events | (Inherited from Control.) |
| Finalize()()()() | (Inherited from Object.) |
| FindControl(String) | (Inherited from Control.) |
| FindControl(String, Int32) | (Inherited from Control.) |
| Focus()()()() | (Inherited from Control.) |
| Font | (Overrides WebControl.Font.) |
| ForeColor | (Overrides WebControl.ForeColor.) |
| GetDesignModeState()()()() | (Inherited from Control.) |
| GetHashCode()()()() | (Inherited from Object.) |
| GetRouteUrl(Object) | (Inherited from Control.) |
| GetRouteUrl(String, Object) | (Inherited from Control.) |
| GetRouteUrl(RouteValueDictionary) | (Inherited from Control.) |
| GetRouteUrl(String, RouteValueDictionary) | (Inherited from Control.) |
| GetType()()()() | (Inherited from Object.) |
| GetUniqueIDRelativeTo(Control) | (Inherited from Control.) |
| HasAttributes | (Inherited from WebControl.) |
| HasChildViewState | (Inherited from Control.) |
| HasControls()()()() | (Inherited from Control.) |
| HasEvents()()()() | (Inherited from Control.) |
| Height | (Inherited from WebControl.) |
| ID | (Inherited from Control.) |
| IdSeparator | (Inherited from Control.) |
| Init | (Inherited from Control.) |
| IsChildControlStateCleared | (Inherited from Control.) |
| IsEnabled | (Inherited from WebControl.) |
| IsLiteralContent()()()() | (Inherited from Control.) |
| IsTrackingViewState | (Inherited from Control.) |
| IsViewStateEnabled | (Inherited from Control.) |
| Load | (Inherited from Control.) |
| LoadControlState(Object) | (Inherited from Control.) |
| LoadViewState(Object) | (Inherited from WebControl.) |
| LoadViewStateByID | (Inherited from Control.) |
| MapPathSecure(String) | (Inherited from Control.) |
| MemberwiseClone()()()() | (Inherited from Object.) |
| MergeStyle(Style) | (Inherited from WebControl.) |
| NamingContainer | (Inherited from Control.) |
| OnBubbleEvent(Object, EventArgs) | (Inherited from Control.) |
| OnDataBinding(EventArgs) | (Inherited from Control.) |
| OnInit(EventArgs) | (Inherited from Control.) |
| OnLoad(EventArgs) | (Inherited from Control.) |
| OnPreRender(EventArgs) |
Called at the PreRender stage.
(Overrides Control.OnPreRender(EventArgs).) |
| OnSearch(EventArgs) | Called after the Search button is pressed. |
| OnUnload(EventArgs) | (Inherited from Control.) |
| OpenFile(String) | (Inherited from Control.) |
| Page | (Inherited from Control.) |
| Parent | (Inherited from Control.) |
| PreRender | (Inherited from Control.) |
| QueryTextBox |
The query text box.
|
| RaiseBubbleEvent(Object, EventArgs) | (Inherited from Control.) |
| RaisePostBackEvent(String) |
Called on postbacks related to this control
|
| RedirectToSearchResults()()()() |
Forces a redirect to 'ResultPageURL' with the query entered in the query text box.
|
 | RegisterSearch(String, String, ICache, String, array<String>[]()[][]) |
Register a user search, so that it can be tallied and considered by the popular search query autocompleter.
|
| RememberQuery |
Whether to remember the user's query and reshow it next time the control renders (default=true).
|
| RemovedControl(Control) | (Inherited from Control.) |
| Render(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderBeginTag(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderChildren(HtmlTextWriter) | (Inherited from Control.) |
| RenderContents(HtmlTextWriter) |
Render this control to the output parameter specified.
(Overrides WebControl.RenderContents(HtmlTextWriter).) |
| RenderControl(HtmlTextWriter) | (Inherited from Control.) |
| RenderControl(HtmlTextWriter, ControlAdapter) | (Inherited from Control.) |
| RenderEndTag(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderingCompatibility | (Inherited from Control.) |
| ResolveAdapter()()()() | (Inherited from Control.) |
| ResolveClientUrl(String) | (Inherited from Control.) |
| ResolveUrl(String) | (Inherited from Control.) |
| ResultPageURL |
The URL of the page holding the SearchResult control.
|
| SaveControlState()()()() | (Inherited from Control.) |
| SaveViewState()()()() | (Inherited from WebControl.) |
| Search | Fired when Search button is pressed. |
| SearchButton |
The button that starts the search.
|
| SearchOptions | |
| ServerFarmSynchronizationIPs |
Comma delimited list of IP addresses (or server names) of other servers that need to be synchronized with popular query based autocomplete.
|
| SetDesignModeState(IDictionary) | (Inherited from Control.) |
| SetRenderMethodDelegate(RenderMethod) | (Inherited from Control.) |
| SetTraceData(Object, Object) | (Inherited from Control.) |
| SetTraceData(Object, Object, Object) | (Inherited from Control.) |
| Site | (Inherited from Control.) |
| SkinID | (Inherited from WebControl.) |
| Style | (Inherited from WebControl.) |
| SupportsDisabledAttribute | (Inherited from WebControl.) |
| TabIndex | (Inherited from WebControl.) |
| TagKey | (Inherited from WebControl.) |
| TagName | (Inherited from WebControl.) |
| TemplateControl | (Inherited from Control.) |
| TemplateSourceDirectory | (Inherited from Control.) |
| Text |
The text to show in the textbox when it renders - is overridden by RememberQuery.
|
| ToolTip | (Inherited from WebControl.) |
| ToString()()()() | (Inherited from Object.) |
| TrackViewState()()()() | (Inherited from WebControl.) |
| UniqueID | (Inherited from Control.) |
| Unload | (Inherited from Control.) |
| ValidateRequestMode | (Inherited from Control.) |
| ViewState | (Inherited from Control.) |
| ViewStateIgnoresCase | (Inherited from Control.) |
| ViewStateMode | (Inherited from Control.) |
| Visible | (Inherited from Control.) |
| WatermarkColor |
Watermark color.
|
| WatermarkText |
Text to use as the watermark.
|
| WatermarkVisible |
Whether to show a 'Search' watermark in the textbox.
|
| Width | (Inherited from WebControl.) |
Remarks
This control is used to launch the search, which it does by redirecting the request to the page containing the SearchResult control.
Inheritance Hierarchy| Object | |||
 | Control | ||
| WebControl | ||
| SearchBox | ||
Assembly: Keyoti4.SearchEngine.Web (Module: Keyoti4.SearchEngine.Web.dll) Version: 2015.6.15.120