Web control performing search and showing results to the user.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public class SearchResult : WebControl, IPostBackEventHandler, INamingContainer
public class SearchResult : WebControl, IPostBackEventHandler, INamingContainer
Public Class SearchResult Inherits WebControl Implements IPostBackEventHandler, INamingContainer
Public Class SearchResult Inherits WebControl Implements IPostBackEventHandler, INamingContainer
public ref class SearchResult : public WebControl, IPostBackEventHandler, INamingContainer
public ref class SearchResult : public WebControl, IPostBackEventHandler, INamingContainer
type SearchResult = class inherit WebControl interface IPostBackEventHandler interface INamingContainer end
type SearchResult = class inherit WebControl interface IPostBackEventHandler interface INamingContainer end
Members| All Members | Constructors | Methods | Properties | Events | |
| Icon | Member | Description |
|---|---|---|
 | SearchResult()()()() |
Creates a new instance of the control.
|
 | 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.) |
| 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.) |
| Configuration |
The instance of the Configuration class that holds the settings to be used.
|
 | Context | (Inherited from Control.) |
| Controls | (Inherited from Control.) |
| ControlStyle | (Inherited from WebControl.) |
| ControlStyleCreated | (Inherited from WebControl.) |
| CopyBaseAttributes(WebControl) | (Inherited from WebControl.) |
| CreateChildControls()()()() |
Creates the child controls, and performs the search.
(Overrides Control.CreateChildControls()()()().) |
| CreateControlCollection()()()() | (Inherited from Control.) |
| CreateControlStyle()()()() | (Inherited from WebControl.) |
| CreateDefaultErrorMessageTemplate()()()() |
Creates a DefaultErrorMessageTemplate instance with default layout for the error message.
|
| CreateDefaultFooterTemplate()()()() |
Creates a DefaultHeaderTemplate instance with default layout for the footer.
|
| CreateDefaultHeaderTemplate()()()() |
Creates a DefaultHeaderTemplate instance with default layout for the header.
|
| CreateDefaultNoQueryTemplate()()()() |
Creates a DefaultNoQueryTemplate instance with default layout for the no query item.
|
| CreateDefaultNoResultsTemplate()()()() |
Creates a DefaultNoResultsTemplate instance with default layout for the no results message.
|
| CreateDefaultResultItemTemplate()()()() |
Creates a DefaultResultItemTemplate instance with default layout for the result item.
|
| 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.) |
| DataSource | An optional DataSet instance that will be used as the source of the search results (see remarks). |
| 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.) |
| Equals(Object) | (Inherited from Object.) |
| ErrorMessageTemplate |
The error message template shown when an error occurrs.
|
| Events | (Inherited from Control.) |
| FilterLoadLevel |
Specifies what amount of data to load for any filtering by a ResultItemsFinalized event handler or by an AddResultItemToResults override.
|
| Finalize()()()() | (Inherited from Object.) |
| FindControl(String) | (Inherited from Control.) |
| FindControl(String, Int32) | (Inherited from Control.) |
| Focus()()()() | (Inherited from Control.) |
| Font | (Inherited from WebControl.) |
| FooterTemplate |
The footer template shown below the search results.
|
| ForeColor | (Inherited from WebControl.) |
| FromURIPattern |
If necessary URLs in the results can be mapped to other domains/paths, specify the from match here, eg. http://localhost
|
| GenerateDefaultTemplatesIfNeeded()()()() |
Creates the default templates if the specified ones are null.
|
| 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.) |
| GetSearchResults(SearchOptions) | Returns the results used to create ResultItems, this can be either a DataSet or a SearchResult.
|
| 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.) |
| HeaderTemplate |
The header template shown above the search results.
|
| Height | (Inherited from WebControl.) |
| HighlightQueryWordsInSummary |
Whether to highlight the query words in the summary.
|
| HighlightQueryWordsInSummaryHTML |
How to highlight the query words in the summary. Eg. <b>{0}</b>
|
| ID | (Inherited from Control.) |
| IdSeparator | (Inherited from Control.) |
| IgnoredWords |
Comma delimited list of words which were not searched for (stop-list).
|
| IndexDirectory |
The directory where the document index files should be stored, this must already exist, and can be specified as an absolute file path, or a relative URL.
|
| Init | (Inherited from Control.) |
| InvalidateChildControlHierarchy()()()() |
Invalidates child controls to force recreation of result items. Call when results should be regenerated after a postback.
|
| IsChildControlStateCleared | (Inherited from Control.) |
| IsEnabled | (Inherited from WebControl.) |
| IsLiteralContent()()()() | (Inherited from Control.) |
| IsTrackingViewState | (Inherited from Control.) |
| IsViewStateEnabled | (Inherited from Control.) |
| ItemCreated |
Fired when a search result item control is created.
|
| LicenseKey |
The license key for the control, see remarks.
|
| Load | (Inherited from Control.) |
| LoadConfiguration(String) |
Load configuration object values from the Configuration.xml file.
|
| 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.) |
| NextPageClicked |
Fired when 'next page' link is clicked.
|
| NextPageLink |
Link to the next page of results, is empty string if on last page.
|
| NextPageLinkText |
Link text to the next page of results
|
| NoQueryTemplate |
The template shown when there is no search query present when the page loads.
|
| NoResultsTemplate |
The template shown when there are no results.
|
| NumberOfResults |
The number of results found.
|
| NumberOfResultsFinalized |
Fired when the number of results is known and the NumberOfResults property is set.
|
| NumberOfResultsPerPage |
The number of results per page to show.
|
| OnBubbleEvent(Object, EventArgs) | (Inherited from Control.) |
| OnDataBinding(EventArgs) | (Inherited from Control.) |
| OnInit(EventArgs) |
Called during the Init lifecycle stage
(Overrides Control.OnInit(EventArgs).) |
| OnItemCreated(Control, Object) |
Raises the ItemCreated event.
|
| OnLoad(EventArgs) | (Inherited from Control.) |
| OnNextPageClicked(EventArgs) | Called when 'next page' link is clicked. |
| OnNumberOfResultsFinalized(EventArgs) | Called when 'next page' link is clicked. |
| OnPageXClicked(ResultsPageClickEventArgs) | Called when one of the specific page links in the bar is clicked. |
| OnPreRender(EventArgs) | (Overrides Control.OnPreRender(EventArgs).) |
| OnPrevPageClicked(EventArgs) | Called when 'previous page' link is clicked. |
| OnUnload(EventArgs) | (Inherited from Control.) |
| OpenFile(String) | (Inherited from Control.) |
| Page | (Inherited from Control.) |
| PageXClicked |
Fired when one of the specific page links in the bar is clicked.
|
| Parent | (Inherited from Control.) |
| PreRender | (Inherited from Control.) |
| PreviousPageLink |
Link to the previous page of results, is empty string if on first page.
|
| PreviousPageLinkText |
Link text to the previous page of results
|
| PrevPageClicked |
Fired when 'previous page' link is clicked.
|
| QueryExpression |
The query used in the search.
|
| RaiseBubbleEvent(Object, EventArgs) | (Inherited from Control.) |
| RaisePostBackEvent(String) |
Called when a post back occurrs related to this control.
|
| RemovedControl(Control) | (Inherited from Control.) |
| Render(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderBeginTag(HtmlTextWriter) | (Inherited from WebControl.) |
| RenderChildren(HtmlTextWriter) | (Inherited from Control.) |
| RenderContents(HtmlTextWriter) | Renders this control. (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.) |
| ResultItemTemplate |
The template for result items.
|
| ResultPreviewerCharacterLimit |
Maximum number of characters to show in the result preview text (limits the amount of text sent to the browser).
|
| ResultPreviewerEnabled |
Whether to allow the user to see an AJAX based preview of a result.
|
| ResultPreviewerHighlightHTML |
HTML code used to highlight hits in the result preview, {0} represents the hit.
|
| ResultPreviewerLoadPlugin |
Whether to load any plugin during an AJAX based preview of a result - this allows for serverside modification of the preview text.
|
| ResultsPage |
The results page number shown to the user.
|
| ResultSummaryType |
What type of result summary to show
|
| SaveControlState()()()() | (Inherited from Control.) |
| SaveViewState()()()() | (Inherited from WebControl.) |
| SearchAgent |
SearchAgent instance that will be used to search the index.
|
| SearchOptions | The SearchOptions object controlling the search parameters. |
| SearchResults | Specifies the |
| 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 |
See base.
(Overrides WebControl.TagKey.) |
| TagName | (Inherited from WebControl.) |
| TemplateControl | (Inherited from Control.) |
| TemplateSourceDirectory | (Inherited from Control.) |
| ToolTip | (Inherited from WebControl.) |
| ToString()()()() | (Inherited from Object.) |
| ToURIPattern |
If necessary URLs in the results can be mapped to other domains/paths, specify the to match here, eg. http://www.domain.com
|
| TrackViewState()()()() | (Inherited from WebControl.) |
| UniqueID | (Inherited from Control.) |
| Unload | (Inherited from Control.) |
| ValidateRequestMode | (Inherited from Control.) |
| ViewMode |
The mode that the control is currently in.
|
| ViewState | (Inherited from Control.) |
| ViewStateIgnoresCase | (Inherited from Control.) |
| ViewStateMode | (Inherited from Control.) |
| Visible | (Inherited from Control.) |
| Width | (Inherited from WebControl.) |
Inheritance Hierarchy| Object | |||
 | Control | ||
| WebControl | ||
| SearchResult | ||
Assembly: Keyoti4.SearchEngine.Web (Module: Keyoti4.SearchEngine.Web.dll) Version: 2015.6.15.120