Keyoti SearchUnit API Docs
SearchResult Class
API DocumentationKeyoti.SearchEngine.WebSearchResult
Keyoti SearchUnit v6
Web control performing search and showing results to the user.
Declaration Syntax
C#Visual Basic
public class SearchResult : WebControl, 
	IPostBackEventHandler, INamingContainer
Public Class SearchResult
	Inherits WebControl
	Implements IPostBackEventHandler, INamingContainer
Members
All MembersConstructorsMethodsPropertiesEvents



IconMemberDescription
SearchResult()()()()
Creates a new instance of the control.

AccessKey
Gets or sets the access key that allows you to quickly navigate to the Web server control.
(Inherited from WebControl.)
Adapter
Gets the browser-specific adapter for the control.
(Inherited from Control.)
AddAttributesToRender(HtmlTextWriter)
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriterTag. This method is used primarily by control developers.
(Inherited from WebControl.)
AddedControl(Control, Int32)
Called after a child control is added to the Controls collection of the Control object.
(Inherited from Control.)
AddParsedSubObject(Object)
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
(Inherited from Control.)
ApplyStyle(Style)
Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
(Inherited from WebControl.)
ApplyStyleSheetSkin(Page)
Applies the style properties defined in the page style sheet to the control.
(Inherited from Control.)
AppRelativeTemplateSourceDirectory
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
(Inherited from Control.)
Attributes
Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
(Inherited from WebControl.)
BackColor
Gets or sets the background color of the Web server control.
(Inherited from WebControl.)
BeginRenderTracing(TextWriter, Object) (Inherited from Control.)
BindingContainer
Gets the control that contains this control's data binding.
(Inherited from Control.)
BorderColor
Gets or sets the border color of the Web control.
(Inherited from WebControl.)
BorderStyle
Gets or sets the border style of the Web server control.
(Inherited from WebControl.)
BorderWidth
Gets or sets the border width of the Web server control.
(Inherited from WebControl.)
BuildProfileTree(String, Boolean)
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
(Inherited from Control.)
ChildControlsCreated
Gets a value that indicates whether the server control's child controls have been created.
(Inherited from Control.)
ClearCachedClientID()()()() (Inherited from Control.)
ClearChildControlState()()()()
Deletes the control-state information for the server control's child controls.
(Inherited from Control.)
ClearChildState()()()()
Deletes the view-state and control-state information for all the server control's child controls.
(Inherited from Control.)
ClearChildViewState()()()()
Deletes the view-state information for all the server control's child controls.
(Inherited from Control.)
ClearEffectiveClientIDMode()()()() (Inherited from Control.)
ClientFilesLocation
Whether to use the internal client files, or external files (for customization).

ClientID
Gets the server control identifier generated by ASP.NET.
(Inherited from Control.)
ClientIDMode (Inherited from Control.)
ClientIDSeparator
Gets a character value representing the separator character used in the ClientID property.
(Inherited from Control.)
Configuration
The instance of the Configuration class that holds the settings to be used.

Context
Gets the HttpContext object associated with the server control for the current Web request.
(Inherited from Control.)
Controls
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
(Inherited from Control.)
ControlStyle
Gets the style of the Web server control. This property is used primarily by control developers.
(Inherited from WebControl.)
ControlStyleCreated
Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
(Inherited from WebControl.)
CopyBaseAttributes(WebControl)
Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
(Inherited from WebControl.)
CreateChildControls()()()()
Creates the child controls, and performs the search.
(Overrides Control.CreateChildControls()()()().)
CreateControlCollection()()()()
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
(Inherited from Control.)
CreateControlStyle()()()()
Creates the style object that is used internally by the WebControl class to implement all style related properties. This method is used primarily by control developers.
(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
Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
(Inherited from WebControl.)
DataBind()()()()
Binds a data source to the invoked server control and all its child controls.
(Inherited from Control.)
DataBind(Boolean)
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
(Inherited from Control.)
DataBindChildren()()()()
Binds a data source to the server control's child controls.
(Inherited from Control.)
DataBinding
Occurs when the server control binds to a data source.
(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
Gets a value indicating whether a control is being used on a design surface.
(Inherited from Control.)
Dispose()()()()
Enables a server control to perform final clean up before it is released from memory.
(Inherited from Control.)
Disposed
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested.
(Inherited from Control.)
Enabled
Gets or sets a value indicating whether the Web server control is enabled.
(Inherited from WebControl.)
EnableTheming
Gets or sets a value indicating whether themes apply to this control.
(Inherited from WebControl.)
EnableViewState
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client.
(Inherited from Control.)
EndRenderTracing(TextWriter, Object) (Inherited from Control.)
EnsureChildControls()()()()
Determines whether the server control contains child controls. If it does not, it creates child controls.
(Inherited from Control.)
EnsureID()()()()
Creates an identifier for controls that do not have an identifier assigned.
(Inherited from Control.)
Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
ErrorMessageTemplate
The error message template shown when an error occurrs.

Events
Gets a list of event handler delegates for the control. This property is read-only.
(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()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
FindControl(String)
Searches the current naming container for a server control with the specified id parameter.
(Inherited from Control.)
FindControl(String, Int32)
Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl()()()() method.
(Inherited from Control.)
Focus()()()()
Sets input focus to a control.
(Inherited from Control.)
Font
Gets the font properties associated with the Web server control.
(Inherited from WebControl.)
FooterTemplate
The footer template shown below the search results.

ForeColor
Gets or sets the foreground color (typically the color of the text) of the Web server control.
(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()()()()
Gets design-time data for a control.
(Inherited from Control.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(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()()()()
Gets the type of the current instance.
(Inherited from Object.)
GetUniqueIDRelativeTo(Control) (Inherited from Control.)
HasAttributes
Gets a value indicating whether the control has attributes set.
(Inherited from WebControl.)
HasChildViewState
Gets a value indicating whether the current server control's child controls have any saved view-state settings.
(Inherited from Control.)
HasControls()()()()
Determines if the server control contains any child controls.
(Inherited from Control.)
HasEvents()()()()
Returns a value indicating whether events are registered for the control or any child controls.
(Inherited from Control.)
HeaderTemplate
The header template shown above the search results.

Height
Gets or sets the height of the Web server control.
(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
Gets or sets the programmatic identifier assigned to the server control.
(Inherited from Control.)
IdSeparator
Gets the character used to separate control identifiers.
(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
Occurs when the server control is initialized, which is the first step in its lifecycle.
(Inherited from Control.)
InvalidateChildControlHierarchy()()()()
Invalidates child controls to force recreation of result items. Call when results should be regenerated after a postback.

IsChildControlStateCleared
Gets a value indicating whether controls contained within this control have control state.
(Inherited from Control.)
IsEnabled
Gets a value indicating whether the control is enabled.
(Inherited from WebControl.)
IsLiteralContent()()()()
Determines if the server control holds only literal content.
(Inherited from Control.)
IsTrackingViewState
Gets a value that indicates whether the server control is saving changes to its view state.
(Inherited from Control.)
IsViewStateEnabled
Gets a value indicating whether view state is enabled for this control.
(Inherited from Control.)
ItemCreated
Fired when a search result item control is created.

LicenseKey
The license key for the control, see remarks.

Load
Occurs when the server control is loaded into the Page object.
(Inherited from Control.)
LoadConfiguration(String)
Load configuration object values from the Configuration.xml file.

LoadControlState(Object)
Restores control-state information from a previous page request that was saved by the SaveControlState()()()() method.
(Inherited from Control.)
LoadViewState(Object)
Restores view-state information from a previous request that was saved with the SaveViewState()()()() method.
(Inherited from WebControl.)
LoadViewStateByID
Gets a value indicating whether the control participates in loading its view state by ID instead of index.
(Inherited from Control.)
MapPathSecure(String)
Retrieves the physical path that a virtual path, either absolute or relative, maps to.
(Inherited from Control.)
MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
MergeStyle(Style)
Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
(Inherited from WebControl.)
NamingContainer
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value.
(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)
Determines whether the event for the server control is passed up the page's UI server control hierarchy.
(Inherited from Control.)
OnDataBinding(EventArgs)
Raises the DataBinding event.
(Inherited from Control.)
OnInit(EventArgs)
Called during the Init lifecycle stage
(Overrides Control.OnInit(EventArgs).)
OnItemCreated(Control, Object)
Raises the ItemCreated event.

OnLoad(EventArgs)
Raises the Load event.
(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)
Raises the Unload event.
(Inherited from Control.)
OpenFile(String)
Gets a Stream used to read a file.
(Inherited from Control.)
Page
Gets a reference to the Page instance that contains the server control.
(Inherited from Control.)
PageXClicked
Fired when one of the specific page links in the bar is clicked.

Parent
Gets a reference to the server control's parent control in the page control hierarchy.
(Inherited from Control.)
PreRender
Occurs after the Control object is loaded but prior to rendering.
(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)
Assigns any sources of the event and its information to the control's parent.
(Inherited from Control.)
RaisePostBackEvent(String)
Called when a post back occurrs related to this control.

RemovedControl(Control)
Called after a child control is removed from the Controls collection of the Control object.
(Inherited from Control.)
Render(HtmlTextWriter)
Renders the control to the specified HTML writer.
(Inherited from WebControl.)
RenderBeginTag(HtmlTextWriter)
Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
RenderChildren(HtmlTextWriter)
Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
(Inherited from Control.)
RenderContents(HtmlTextWriter)
Renders this control.
(Overrides WebControl.RenderContents(HtmlTextWriter).)
RenderControl(HtmlTextWriter)
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
(Inherited from Control.)
RenderControl(HtmlTextWriter, ControlAdapter)
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
(Inherited from Control.)
RenderEndTag(HtmlTextWriter)
Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
(Inherited from WebControl.)
RenderingCompatibility (Inherited from Control.)
ResolveAdapter()()()()
Gets the control adapter responsible for rendering the specified control.
(Inherited from Control.)
ResolveClientUrl(String)
Gets a URL that can be used by the browser.
(Inherited from Control.)
ResolveUrl(String)
Converts a URL into one that is usable on the requesting client.
(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()()()()
Saves any server control state changes that have occurred since the time the page was posted back to the server.
(Inherited from Control.)
SaveViewState()()()()
Saves any state that was modified after the TrackViewState()()()() method was invoked.
(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 search results.

SetDesignModeState(IDictionary)
Sets design-time data for a control.
(Inherited from Control.)
SetRenderMethodDelegate(RenderMethod)
Assigns an event handler delegate to render the server control and its content into its parent control.
(Inherited from Control.)
SetTraceData(Object, Object) (Inherited from Control.)
SetTraceData(Object, Object, Object) (Inherited from Control.)
Site
Gets information about the container that hosts the current control when rendered on a design surface.
(Inherited from Control.)
SkinID
Gets or sets the skin to apply to the control.
(Inherited from WebControl.)
Style
Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
(Inherited from WebControl.)
SupportsDisabledAttribute (Inherited from WebControl.)
TabIndex
Gets or sets the tab index of the Web server control.
(Inherited from WebControl.)
TagKey
See base.
(Overrides WebControl.TagKey.)
TagName
Gets the name of the control tag. This property is used primarily by control developers.
(Inherited from WebControl.)
TemplateControl
Gets or sets a reference to the template that contains this control.
(Inherited from Control.)
TemplateSourceDirectory
Gets the virtual directory of the Page or UserControl that contains the current server control.
(Inherited from Control.)
ToolTip
Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
(Inherited from WebControl.)
ToString()()()()
Returns a string that represents the current object.
(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()()()()
Causes the control to track changes to its view state so they can be stored in the object's ViewState property.
(Inherited from WebControl.)
UniqueID
Gets the unique, hierarchically qualified identifier for the server control.
(Inherited from Control.)
Unload
Occurs when the server control is unloaded from memory.
(Inherited from Control.)
ValidateRequestMode (Inherited from Control.)
ViewMode
The mode that the control is currently in.

ViewState
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page.
(Inherited from Control.)
ViewStateIgnoresCase
Gets a value that indicates whether the StateBag object is case-insensitive.
(Inherited from Control.)
ViewStateMode (Inherited from Control.)
Visible
Gets or sets a value that indicates whether a server control is rendered as UI on the page.
(Inherited from Control.)
Width
Gets or sets the width of the Web server control.
(Inherited from WebControl.)
Inheritance Hierarchy
Object
Control
 WebControl
  SearchResult

Assembly: Keyoti4.SearchEngine.Web (Module: Keyoti4.SearchEngine.Web.dll) Version: 2022.8.22.610