Ektron CMS400.NET API Documentation
|
The Web Search server control lets you customize the behavior of the search. You place this control on any Web form from which a site visitor can search your site. For information about the site visitor experience, see the Ektron CMS400.NET Administrator Manual section "Searching Your Web Site" > "Web Site Search."
[DefaultProperty("FolderID"), ToolboxData("<{0}:WebSearch runat=server></{0}:WebSearch>")] public class WebSearch : EkXsltBase, ICallbackEventHandler;
<DefaultProperty("FolderID"), ToolboxData("<{0}:WebSearch runat=server></{0}:WebSearch>")> Public Class WebSearch Inherits EkXsltBase Inherits ICallbackEventHandler
WebSearch.cs
Name |
Description |
The methods of the WebSearch class are listed here. | |
The properties of the WebSearch class are listed here. |
|
Name |
Description |
|
Method that can be overridden and used to grab data from the back end for each server control. | |
|
Returns search results to the client callback function | |
|
Search HTML, content, images, multimedia and documents based on content or metadata. This method can be used to perform programmatic search. | |
|
Processes the callback event by performing the search. | |
|
Method that can be overridden and used to wrap an Ektron toolbar corresponding to a particular Control around some Html text. |
|
Name |
Description |
|
Optional: If you want to display an image on the submit button, enter the server path to it. | |
|
The text used for the button if no image source is identified. If an image source is identified, this is alternative text for the button. | |
|
Order search results by a custom property. Set this property to the friendly name of the property defined in the Indexing Service. If an invalid property is specified, no search results are returned. If this is left empty, the OrderBy property is used to order search results. | |
|
Optional: If you want to display an image on the submit button, enter the server path to it. | |
| ||
|
Determines the display of the search results page.
| |
|
Get or sets the template of dynamic content. If specified control will not use dynamic box. | |
|
Set to True to display the link that makes the advanced properties visible. | |
|
Get the numerical record of the first item on a page. | |
|
The folder at which the search begins. The starting folder need not be the root folder. The Recursive property determines if the search examines this folder’s subfolders. | |
|
Is server control in workarea | |
|
Gets or sets the target window for the hyperlinks in the search result. The choices are:
| |
|
Identify the template markup file that controls the display of the search results. For example, mysearchmarkup.ekml. Enter the path relative to site root. For example, \workarea\customfiles\markup\mysearchmarkup.ekml. If you enter a valid EkML file, the DisplayXslt property value is ignored. | |
|
The maximum number of characters the Search text box accepts. If you enter a value less than 50, it is a good idea to set the TextBoxSize property to the same number. | |
|
An optional result formatting parameter. If non-zero, then the matching content items' teaser/summary is truncated to the given maximum number of characters - followed by an ellipsis (...). If zero, then the entire teaser/summary will be returned (which might be further filtered by the XSLT). | |
|
Optional: If you want to display an image on the submit button, enter the server path to it. | |
|
The order of the search results. Choices are:
| |
|
Specify the order direction of the results. Choices are Ascending or Descending. | |
|
Select True if you wish to search sub-folders of the starting folder. The starting folder is identified in the FolderID property. | |
|
An optional result formatting parameter. If set to True, any HTML in the content items' teaser/summary is removed before it is sent to the browser. If set to False, any existing HTML is passed along, (this may then be further filtered by the XSLT). | |
|
The number of search results. This is a read-only property. | |
|
Allows a developer to get results from the search control as a DataTable | |
|
An optional result formatting parameter. If non-zero, then the matching content items' teaser/summary is truncated to the given maximum number of characters - followed by an ellipsis (...). If zero, then the entire teaser/summary will be returned (which might be further filtered by the XSLT). | |
|
Lets you designate where search results appear. You can place search criteria in one area of a Web form and the results in another. For example, you have the following tag. <span id="results"></span> In this case, enter results for the property value. | |
|
Allows a developer to get results from the search control as XML. | |
|
Choose the type of content to search.
| |
|
If set to True, the search results will search for synonyms configured for term. The default is True.
| |
|
Get or set default search text. This is optional. | |
|
If set to True, taxonomy categories will also be searched for the search text specified. The default is False. True = Search across taxonomy categories False = Do not search across taxonomy categories | |
|
If set to True, custom summary is used in search results. The default is False. True = Display custom summary in search results. False = Display characterization generated by indexing service in search results. | |
|
If set to False, the search box does not appear on PostBack. The default is True. True = Display search box on PostBack False = Do not display search box on PostBack | |
| ||
|
If set to True, the search results include Suggested Results if any exist. The default is True.
| |
|
Get the numerical record of the last item on a page. | |
|
Specify the location of the style sheet for the search results page. Set the location relative to the site root folder. For example: csslib\mytest.css. Leave blank to use the default style sheet, | |
|
Is server control in workarea | |
|
Taxonomy operator used in filtering search results by taxonomy category.
| |
|
The size of the Search text box for user input. The width is based on the number of characters. | |
|
Gets the amount of time, in seconds, it has taken to perform the search. | |
|
This property is not supported by WebSearch. The underlying XML can be displayed using an XSLT specified by the DisplayXslt property of the WebSearch server control. The XSLT filename is specified relative to the current directory. |
|
Name |
Description |
|
Constructor for the WebSearch class. |
Copyright (c) 2008. All rights reserved.
|
What do you think about this topic? Send feedback!
|