ProductSearch Class

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."

Class Hierarchy

[DefaultProperty("CatalogId"), ToolboxData("<{0}:ProductSearch runat=server></{0}:ProductSearch>")]
public class ProductSearch : ECommerceControl, ICallbackEventHandler;

Visual Basic

<DefaultProperty("CatalogId"), ToolboxData("<{0}:ProductSearch runat=server></{0}:ProductSearch>")>
Public Class ProductSearch
Inherits ECommerceControl
Inherits ICallbackEventHandler

ProductSearch.cs

Name	Description
ProductSearch Methods	The methods of the ProductSearch class are listed here.
ProductSearch Properties	The properties of the ProductSearch class are listed here.

ProductSearch Methods

	Name	Description
	Fill	Method that can be overridden and used to grab data from the back end for each server control.
	GetCallbackResult	Returns search results to the client callback function
	RaiseCallbackEvent	Processes the callback event by performing the search.
	Wrap	Method that can be overridden and used to wrap an Ektron toolbar corresponding to a particular Control around some Html text.

ProductSearch Properties

	Name	Description
	ButtonImgSrc	If you want to display an image on the Submit button, enter the server path to it.
	ButtonText	The text used for the Submit button if no image source is identified. If an image source is identified, this is alternative text for the button.
	CacheInterval	Sets the amount of time the server control’s data is cached. The default is 0 (zero). This is the amount of time, in seconds, a control’s data is cached. For example, if you want to cache the data for five minutes, you set the CacheInterval property to 300 (three hundred).
	CatalogId	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.
	CustomOrderBy	Provide a property’s Friendly Name defined in the Indexing Service to sort search results by that property. Results can be ascending or descending based on OrderDirection. If you enter an invalid property, no search results are returned. If you specify CustomOrderBy and OrderBy, the OrderBy property is ignored. The Friendly Name of a property can be found in Computer Management > Services and Applications > Indexing Service > Your Index > Properties > Friendly Name column.
	DisplayXslt	Specify an external XSLT file to render the control. By default, the control uses ProductSearch.xsl. This file is located in:
	DynamicProductParameter	The QueryString parameter name which is used to pass the product ID to the product details page.
	EnableAdvancedLink	Set to True to display an additional tab (Advanced) on the ProductSearch control.
	EndCount	Get the numerical record of the first item on a page.
	IsInWorkArea	Is server control in workarea
	LinkTarget	Gets or sets the target window for the hyperlinks in the search result. The choices are: _blank - loads the link in a new blank window. This window is not named. _self - loads the link in the same window the anchor was clicked in. This is useful for overriding a globally assigned base target. _parent - loads the link in the immediate frameset parent of the document. This defaults to acting like “_self” if the document has no parent. _top - loads the link in the full body of the window. This defaults to acting like “_self” if the... more
	LoadingImage	Image to show while Ajax is fetching data. The default is ajax-loader_circle_lg.gif".
	MaxCharacters	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.
	MaxTeaserLength	Limits the length of any returned content’s abstract. To allow unlimited length, set to zero. This property is active only if both of these conditions are true. you use the DisplayXslt property to identify an XSLT and ecmteaser as a value of that property. the ShowCustomSummary property is set to false. If ShowCustomSummary is set to true, the entire summary appears in search results.
	OrderBy	The order of the search results. Choices are: Title - The content title (alphabetical) ID - The content ID number Date Created - The date the content was created Date Modified - The date the content was most recently modified Editor - The user who last edited the content (alphabetical) Rank - The rank assigned to the content. See Also: Ektron CMS400.NET Administrator manual section "Searching Your Web Site" > "Display of Search Results" > "Search Result Ranking"
	OrderDirection	The direction in which search results are sorted. The default is Ascending. Ascending - Alphabetical results from A to Z; numeric values low to high; dates from oldest to most recent Descending - Alphabetical results from Z to A; numeric values high to low; dates from most recent to oldest
	Recursive	Set to True to search sub-folders of the starting folder. The starting folder is identified in the CatalogID property.
	ResultCount	The number of search results. This is a read-only property.
	ResultDataTable	Allows a developer to get results from the search control as a DataTable
	ResultsPageSize	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.
	ResultTagId	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.
	ResultXml	Allows a developer to get results from the search control as XML.
	SearchText	Get or set default search text. This is optional.
	ShowCategories	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
	ShowCustomSummary	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.
	ShowSearchBoxAlways	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
	StartCount	Get the numerical record of the last item on a page.
	Stylesheet	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,
	TaxCategories	Is server control in workarea
	TaxonomyOperator	Select whether to use an And or Or operator when filtering results by taxonomy. By default, the property is set to Or. This allows for a wider range of returned results. And - Only results that match all categories selected in the Filter by Category tree appear. For example, if you are searching for a medical document in the Hospital and Doctor’s Office categories, the document must be assigned to both categories or it is not shown. Or - when more than one category is selected in the Filter by Category tree, results must match at least one category... more
	TemplateCart	The URL for the page that contains a basket control (the URL is used when the customer clicks the 'Add to cart' button).
	TemplateProduct	The URL for the page that contains a product control (the URL is used when the customer clicks the image or title link).
	TextBoxSize	The size of the Search text box for user input. The width is based on the number of characters.
	TimeTaken	Gets the amount of time, in seconds, it has taken to perform the search.
	XmlDoc	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.

Public Methods

	Name	Description
	ProductSearch	Constructor for the WebSearch class.

Links

ProductSearch Methods, ProductSearch Properties, Classes, Legend, Members, Topics, ProductSearch Methods, ProductSearch Properties, Public Methods

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!