IndexSearch Class

Use the IndexSearch server control to display a Smart Form’s search screen on any Web form. This lets a user search your site based on XML parameters.

Class Hierarchy

[DefaultProperty("XmlConfigId"), ToolboxData("<{0}:IndexSearch runat=server></{0}:IndexSearch>"), PersistChildren(true)]
public class IndexSearch : EkXsltBase, IEnumerator, IEnumerable, IListSource, IDataSource;

Visual Basic

<DefaultProperty("XmlConfigId"), ToolboxData("<{0}:IndexSearch runat=server></{0}:IndexSearch>"), PersistChildren(true)>
Public Class IndexSearch
Inherits EkXsltBase
Inherits IEnumerator
Inherits IEnumerable
Inherits IListSource
Inherits IDataSource

IndexSearch.cs

Name	Description
IndexSearch Structures	The structures of the IndexSearch class are listed here.
IndexSearch Methods	The methods of the IndexSearch class are listed here.
IndexSearch Properties	The properties of the IndexSearch class are listed here.

IndexSearch Methods

	Name	Description
	AddParm	This is the overview for the AddParm method overload.
	CopyTo	Copies all the elements of the current System.Data.InternalDataCollectionBase to a one-dimensional System.Array, starting at the specified System.Data.InternalDataCollectionBase index.
	Fill	Calls up the database and updates the contents of the collection if the data is out of sync with the specified parameters.
	GetEnumerator	Gets a System.Collections.IEnumerator for the collection.
	GetSearchParmDataType	Returns the search parameter data type.
	GetSearchParmSearchType	Returns the search parameter search type.
	GetXPathValues	Returns array of strings using Xpaths.
	MoveNext	Moves up the index of the Collection. Returns false if the end of the collection has been surpassed.
	Reset	Brings the index of the collection back to zero. Does not clear the collection.
	Search	This is the overview for the Search method overload.
	this	Index operator into a strongly typed dataset holding some common properties for a Collection item.
	Wrap	Overrideable method that can be used to wrap an Ektron toolbar corresponding to a particular Control around some HTML text.

IndexSearch Properties

	Name	Description
	ButtonImgSrc	If you want to display an image on the submit button, enter the server path to it. (Optional)
	ButtonText	The text that appears on the Search button.
	ContentParameter	Checks the QueryString for this value and replaces the search results with that content block when specified. Leave blank to always display the search results.
	Count	Indicates the number of elements in your Collection.
	Current	Gets the current object in the collection.
	CustomOrderBy	Order search results by an indexed field in the smart form. Set this property to the XPATH of that indexed field. If invalid XPATH is specified, search result ordering defaults to Rank.
	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	The message that is displayed when the search returns no hits. (Optional)
	EncodeContentHtml	Set the property to true if you wish to html encode the Content Html in returned result."
	FolderId	The ID of the folder where to start the search. Root starts at "0".
	FormName	The form name.
	IsSynchronized	Gets a value indicating whether the System.Data.InternalDataCollectionBase is synchronized.
	Labelafter	Specify a label for the date field where search criteria is "After".
	Labelbefore	Specify a label for the date field where search criteria is "Before".
	LabelBetween	Specify label for numeric field where search criteria is based on range of values.
	LabelContains	Specify the label for a string field where search criteria "Contains".
	LabeldateBetween	Specify a label for the date field where search criteria based on a range of dates.
	LabelEqual	Specify label for numeric field where search criteria is "Equal".
	LabelExactPhrase	Specify a label for the string field where search criteria "Exact Phrase".
	LabelGreaterThan	Specify label for numeric field where search criteria is "Greater Than".
	Labelinputdate	Specify a label for the message that appears when date entered are blank/incorrect.
	Labelinputnumber	Specify a label for the message that appears when values entered are blank/incorrect.
	LabelLessThan	Specify label for numeric field where search criteria "Less Than".
	Labelon	Specify a label for the Date field where search criteria is "On".
	LabelSelect	Specify labels for first item on selection dropdown.
	LinkTarget	Gets or sets the target window for the result to be displayed.
	MaxResults	The total number of results to display. If set to zero, unlimited results will be set.
	OrderBy	Specify the order of the results. Choices are: Title - the title of the content block ID - the XML content block ID number Date Created - the date the content block was created Date Modified - the date the content block was last modified AuthorLName - the last author’s last name AuthorFname - the last author’s first name StartDate - the GoLive date
	OrderByDirection	The direction the results will be sorted in. This property works with the OrderBy property only. Choices are: Ascending Descending
	Recursive	Select True if you wish to search the subfolders of the selected FolderPath.
	SearchParmXML	Predefine a set of search criteria.
	ShowSearchBoxAlways	If this property is set to False, the search box will not be visible on PostBack.
	SyncRoot	Gets an object that can be used to synchronize the collection.
	Weighted	Select True if you wish perform a weighted search.
	XmlConfigId	ID of the Smart Form whose indexed fields will appear on the search screen.
	XmlDoc	Returns the XSLT object for the collection.

Public Methods

	Name	Description
	IndexSearch	Constructor for IndexSearch class.

IndexSearch Structures

	Name	Description
	SearchPram	parameter structure used for search.

Links

IndexSearch Structures, IndexSearch Methods, IndexSearch Properties, Classes, Legend, Members, Topics, IndexSearch Methods, IndexSearch Properties, Public Methods, IndexSearch Structures

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!