Name 

Description 

 

ButtonImgSrc 

Optional: The path to the image you wish to use for the button.  

 

ButtonText 

The text of the search button if no image is specified.  

 

ContentFieldsetLegend 

Text that appears in the fieldset border around the content check boxes. This property is used only when the EnableContentFieldset property is set to True. The default is: Content Items:  

 

Count 

Indicates the number of elements in the search results.  

 

Current 

Gets the current object in the collection.  

 

Display 

Determines if the search options are in a row (Horizontal) or a column (Vertical).  

 

EkItems 

Array of Ektron.Cms.Common.ContentBase items that correspond to the specified Collection. Holds more information than the exposed strongly typed this[i] index operator.  

 

EmptyResultMsg 

Optional: The return massage if the search returns no hits.  

 

EnableAdvancedLink 

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

 

EnableAjax 

By default, the search is set to PostBack. To enable an Ajax search, set this property to true. Ajax provides a quicker response time because the client only loads the results not the whole page.  

 

EnableArchived 

Set to true to include Archived items in the search results.  

 

EnableArchivedBtn 

Set to true to provide a check box so users can decide if they want to perform a Archived search. When set to False the check box is hidden but still used.  

 

EnableContent 

Set to true to include Content items in the search results.  

 

EnableContentBtn 

Set to true to provide a check box so users can decide if they want to perform a content search. When set to False the check box is hidden but still used.  

 

EnableContentFieldset 

Creates a border around the group of content items in an advanced search. These content items include Content, Forms and DMS Assets. The default is False.  

 

EnableDMSAssets 

Set to true to include DMS-Asset items in the search results.  

 

EnableDMSAssetsBtn 

Set to true to provide a check box so users can decide if they want to perform a DMS-Asset search. When set to False the check box is hidden but still used.  

 

EnableFolderFieldset 

Set to true to wrap the Folder-Descriptions in a fieldset border.  

 

EnableForms 

Set to true to include Form items in the search results.  

 

EnableFormsBtn 

Set to true to provide a check box so users can decide if they want to perform a Forms search. When set to False the check box is hidden but still used.  

 

EnableLibFiles 

Set to true to include Library-File items in the search results.  

 

EnableLibFilesBtn 

Set to true to provide a check box so users can decide if they want to perform a Library-Files search. When set to False the check box is hidden but still used.  

 

EnableLibHyperlinks 

Set to true to include Library-Hyperlink items in the search results.  

 

EnableLibHyperlinksBtn 

Set to true to provide a check box so users can decide if they want to perform a Library-Hyperlinks search. When set to False the check box is hidden but still used.  

 

EnableLibImages 

Set to true to include Library-Image items in the search results.  

 

EnableLibImagesBtn 

Set to true to display the Library-Images check box (false to hide, but still use).  

 

EnableLibraryFieldset 

Set to true to wrap the Library-Group in a fieldset border.  

 

FolderFieldsetLegend 

The Legend-text to display, for the Folder-Descriptions fieldset.  

 

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.  

 

FolderPath 

The Path of the folder you wish to start the search. Root starts at "\".  

 

IncludeIcons 

Determines whether or not to display an icon next to your navigation lists. NOTE: Only works with ecmSummary AND ecmTeaser or or when the [$imageIcon] variable is used in an EkML file.  

 

IsSynchronized 

Gets a value indicating whether the System.Data.InternalDataCollectionBase is synchronized.  

 

LibraryFieldsetLegend 

The Legend-text to display, for the Library-Group in a fieldset.  

 

LinkTarget 

Gets or Sets the target window for the result. The choices are:

• _blank - this target causes the link to always be loaded in a new blank window. This window is not named.
• _self - this target causes the link to always load in the same window the anchor was clicked in. This is useful for overriding a globally assigned base target.
• _parent - This target makes the link load in the immediate frameset parent of the document. This defaults to acting like “_self” if the document has no parent.
• _top - This target makes the link load in the... more 

 

MaxCharacters 

The maximum number of characters the user can enter in the search box.  

 

MaxResults 

The total number of results to display. If set to zero, unlimited results will be set.  

 

MaxTeaserLength 

An optional result formatting parameter. If non-zero, then the matching content items' teaser/summary will be 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).  

 

OrderBy 

Specify the order of the results. Choices are:

• Title - the title of the content
• Id - the ID number content
• DateCreated - the date the creation date of the content
• DateModified - the date the content was last modified
• UserId - ID of a user
• LastEditorLname - the last name of the last content editor
• LastEditorFname - the first name of the last content editor

 

 

OrderDirection 

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

 

PostResultsAt 

The Path of the page you wish to post search results. (NOTE: The search control MUST exists on the posting page.)  

 

Recursive 

Get or set whether to search subfolders of the identified root folder. The root folder is identified in the FolderID property.  

 

RemoveTeaserHtml 

An optional result formatting parameter. If true, any HTML in the content items' teaser/summary is removed before it is sent to the browser. If false then any existing HTML is passed along, (this may then be further filtered by the XSLT).  

 

ResultTagId 

Specify the div tag control ID to display the search results. This property is only active when the EnableAjax property is set to true.  

 

SearchText 

Get or set the default search text.  

 

SearchType 

Get or set the Search Type  

 

ShowDate 

Select true if you wish to display the publication date on each search result.  

 

ShowExtendedSearch 

Allows a user to search via Searchable Property metadata.

• True = Show extended search
• False = Hide extended search

Search type metadata only appears on the search screen if the following are true:

• this property is set to True
• the ShowSearchOptions property is set to True
• at least one content item in the starting folder (and its subfolders if recursive is set to true) has searchable metadata applied to it

 

 

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 

Specify "True" to show search options. Set to false to see a very basic UI.  

 

Stylesheet 

Specify the style sheet relative to site root. Leave blank for default.  

 

SyncRoot 

Gets an object that can be used to synchronize the collection.  

 

TargetFolderDescriptionList 

An optional comma-delimited string, which allows the user to override the folders to search. For example, set to "Photos=1,NewsHeadlines=0" to search only the Photos folder by default, and allow the user to also select the "NewsHeadlines" folder. Also searches these folders' subfolders, returning any matches found there.  

 

TextBoxSize 

The width of the search box, in characters.  

 

XmlDoc 

Returns the Xslt object for the collection.