







![]() ![]() ![]() |
UltimateSearch Class Library |
UltimateSearchOutput Members |
UltimateSearchOutput Class Constructors Methods Properties Events See Also Send Feedback |
The UltimateSearchOutput type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | UltimateSearchOutput |
Initializes a new instance of the UltimateSearchOutput class.
|
Methods
Name | Description | |
---|---|---|
![]() | AddToIndexByCrawling |
Add to index by crawling the specified urls. It will crawl and index the pages based on
the configuration in the UltimateSearch.config file. It will also follow the links in
those pages to keep crawling and indexing. If you don't want it to follow the links in
those pages, please use the "BeforeIndex" event handler in order to override the "noFollow"
flag programmatically. You can check the "Events" sample to learn more.
|
![]() | AddToIndexWithContent |
Add to index with content and all other page descriptions.
|
![]() | CancelIndexing |
Cancel indexing in the middle of the process, and keep using the old index.
|
![]() | DeleteIndex |
Delete the current index.
|
![]() | Find(String) |
Finds the search terms.
|
![]() | Find(String, SearchType) |
Finds the search terms using the specified search type.
|
![]() | GetIndexedPages |
Gets the indexed pages.
|
![]() | GetIndexedWords |
Gets the indexed words.
|
![]() | IndexFull |
Index everything from scratch based on the configuration settings in the UltimateSearch.config file.
|
![]() | IndexIncremental |
Index only the modified pages. It will also remove deleted pages from the current index.
However, if you have a new page to be indexed, it will index it only if you have a link
to that page from a modified page.
|
![]() | LoadCopiedIndex |
Load index copied from another machine. If you have permission restrictions that prevent you
from indexing your website on the production machine, you can index it on a different machine
with the necessary permissions by either indexing your website remotely, or by using
the "devProdMapPathList" in the UltimateSearch.config file to generate links
for the production environment. Then you can copy the Index folder onto your production machine,
and click this button to load the index.
|
![]() | OnBeforeIndex |
Invokes delegates registered with the BeforeIndex event.
|
![]() | RemoveFromIndex |
Remove the specified urls from the index.
|
![]() | StopIndexing |
Stop indexing in the middle of the process, and use the new index created so far.
|
Properties
Name | Description | |
---|---|---|
![]() | AllowPaging |
Gets or sets a value that indicates whether paging is enabled.
|
![]() | CounterCssClass |
Gets or sets the CSS class name applied to counter if DisplayCounter is true.
|
![]() | CurrentPageLinkCssClass |
Gets or sets the CSS class name applied to the current page link number.
|
![]() | DisplayCounter |
Gets or sets a value that indicates whether a counter is displayed for each search result.
|
![]() | FilterResultsByCategory |
Gets or sets the categories to filter the search results.
|
![]() | FilterResultsByFileType |
Gets or sets the file types to filter the search results.
|
![]() | FirstPageText |
Gets or sets the text to display in place of [FirstPageText].
|
![]() | FooterFormat |
Gets or sets the formatted text displayed at the footer.
|
![]() | HeaderFormat |
Gets or sets the formatted text displayed at the header.
|
![]() | HighlightCssClass |
Gets or sets the CSS class name to highlight the search terms.
|
![]() | HighlightInResultPages |
Gets or sets a value that indicates whether to highlight search terms in result pages.
|
![]() | LastPageText |
Gets or sets the text to display in place of [LastPageText].
|
![]() | MaxPartialMatchCount |
Gets or sets the maximum number of words that start with each search term for partial match search type.
|
![]() | MaxStemmingCount |
Gets or sets the maximum number of stemmings to add for each search term.
|
![]() | MaxSynonymCount |
Gets or sets the maximum number of synonyms to add for each search term.
|
![]() | MaxTextLength |
Gets or sets the maximum number of characters displayed in text.
|
![]() | MaxTitleLength |
Gets or sets the maximum number of characters displayed in title.
|
![]() | MaxUrlLength |
Gets or sets the maximum number of characters displayed in url.
|
![]() | NextPageImage |
Gets or sets the image to display in place of [NextPageImage].
|
![]() | NextPageText |
Gets or sets the text to display in place of [NextPageText].
|
![]() | NoDocumentsFoundFormat |
Gets or sets the formatted text displayed when no documents are found.
|
![]() | PageLinkCount |
Gets or sets the number of page links to display.
|
![]() | PageLinkCssClass |
Gets or sets the CSS class name applied to page link numbers.
|
![]() | PageLinkSeparator |
Gets or sets the separator between page link numbers.
|
![]() | PageSize |
Gets or sets the number of items to display on a single page.
|
![]() | PrevPageImage |
Gets or sets the image to display in place of [PrevPageImage].
|
![]() | PrevPageText |
Gets or sets the text to display in place of [PrevPageText].
|
![]() | ReturnCurrentPageOnly |
Gets or sets a value that indicates whether it should return current page results only.
|
![]() | SearchStemmings |
Gets or sets a value that indicates whether to search for stemmings of each search term.
|
![]() | SearchSynonyms |
Gets or sets a value that indicates whether to search for synonyms of each search term.
|
![]() | SearchTimeDigitCount |
Gets or sets the number of digits displayed in search time.
|
![]() | SearchTimeInSeconds |
Gets or sets a value that indicates whether search time is displayed in seconds.
|
![]() | SpellCheck |
Gets or sets a value that indicates whether to spell check the search terms using UltimateSpell.
|
![]() | SpellDictionary |
Gets or sets the dictionary to use for spell checking.
|
![]() | SpellIncludeDirectory |
Gets or sets the spell include directory.
|
![]() | SpellSuggestFormat |
Gets or sets the formatted text displayed for spell check suggestions.
|
![]() | Target |
Gets or sets the Target window to open the url.
|
![]() | TextCssClass |
Gets or sets the CSS class name applied to text.
|
![]() | TitleCssClass |
Gets or sets the CSS class name applied to title.
|
![]() | UrlCssClass |
Gets or sets the CSS class name applied to url.
|
![]() | XHTML |
Gets or sets a value that indicates whether UltimateSearchOutput is located on a page with document type of XHTML.
|
Events
Name | Description | |
---|---|---|
![]() | AfterSearch |
Raised after the search operation is completed.
|
![]() | BeforeIndex |
Raised before a page is indexed.
|
![]() | BeforeSearch |
Raised after the search operation is completed.
|