Name 

Description 

 

ButtonImgSrc 

Optional: If you want to display an image on the submit button, enter the server path to it.  

 

ButtonText 

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.  

 

CustomOrderBy 

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.  

 

CustomSearch 

Optional: If you want to display an image on the submit button, enter the server path to it.  

 

DisableForumSearch 

Enable Forum Search.  

 

DisplayXslt 

Determines the display of the search results page.

• None - databind only
• ecmNavigation - lists the title of every content item found by the search
• ecmTeaser - lists the title and the summary of every content item found by the search
• ecmUnOrderedList - sorts the list in no particular order. Shows the title and content summary
• Path to Custom Xslt - enter the path to an Xslt that determines the display of the page

 

 

DynamicContentTemplate 

Get or sets the template of dynamic content. If specified control will not use dynamic box.  

 

EnableAdvancedLink 

Set to True to display the link that makes the advanced properties visible.  

 

EndCount 

Get the numerical record of the first item on a page.  

 

FolderID 

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.  

 

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 

 

MarkupLanguage 

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.  

 

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 

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

 

MultipleFolders 

Optional: If you want to display an image on the submit button, enter the server path to it.  

 

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 

Specify the order direction of the results. Choices are Ascending or Descending.  

 

Recursive 

Select True if you wish to search sub-folders of the starting folder. The starting folder is identified in the FolderID property.  

 

RemoveTeaserHtml 

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

 

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.  

 

SearchFor 

Choose the type of content to search.

• All
• HTML
• Documents
• Images
• Multimedia
• Discussion Forums
• Tags

 

 

SearchSynonyms 

If set to True, the search results will search for synonyms configured for term. The default is True.

• True - Display search for synonym of term specified.
• False - Do not search synonyms.

 

 

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  

 

ShowSearchOptions 

If set to True, the following options appear above the Search box.

• Site
• Html
• Documents
• Images
• Multimedia
• Tags

 

 

ShowSuggestedResults 

If set to True, the search results include Suggested Results if any exist. The default is True.

• True = Display Suggested Results
• False = Do not display Suggested Results

 

 

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 

Taxonomy operator used in filtering search results by taxonomy category.

• and - selected taxonomy categories are AND-ed
• or - selected taxonomy categories are OR-ed

 

 

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.