The name of the action which caused the event.
Declaration Syntax| C# | C# | Visual Basic | Visual Basic | Visual C++ | Visual C++ | F# | F# |
public enum ActionName
public enum ActionName
Public Enumeration ActionName
Public Enumeration ActionName
public enum class ActionName
public enum class ActionName
type ActionName
type ActionName
Members| Member | Description |
|---|---|
| AutoAssignContent | The content category for a document was auto assigned, Data contains DocumentRecord object. |
| AutoAssignLocation | The location category for a document was auto assigned, Data contains DocumentRecord object. |
| AutoAssignSecurityGroup | The security group a document was auto assigned to, Data contains DocumentRecord object. |
| AutoCompleteSuggestionsGenerated | The autocomplete suggestions have been generated, Data contains an ArrayList of SuggestionResultPair objects, the sender of this event is SearchBoxAutoCompleteHelper and it has properties 'Query' and 'Segments' which may be of use - NOTE that this event is only fired when SearchBox.AutoCompleteQueryLoadPlugin is true. |
| CalculateWordRelevancies | The words have been read from a document that is being indexed and each word has been assigned a weight, Data contains WordCollection from Document.CalculateWordRelevancies method argument. |
| DocumentBeingCrawled | The crawlable links in a document are being processed, Data contains a 2 element object array - the 1st element is the Document object being crawled, and the 2nd element is an ArrayList of Uri objects found as links in the Document. |
| DocumentImporterAddedDocument | A document has been imported to an indexable source, Data contains AddDocumentEventArgs object. |
| DocumentImporterAddingDocument | A document is about to be imported from an indexable source, Data contains AddDocumentEventArgs object, which has a Cancel property to enable canceling of this action. |
| DocumentIndexBuild | The index has been built, Data is null/nothing. |
| DocumentIndexed | A document has been indexed, Data is the Document object. |
| DiscoveredLinkedURLs | New URLs have been found by reading document links, Data contains an ArrayList of string objects (the link URLs), which may not be changed. |
| DiscoverLinkedURLs | New URLs have been found by reading document links, Data contains an ArrayList of string objects (the link URLs). |
| GetIndexableSourceRecords | The data-access layer is returning a list of IndexableSourceRecords. Note that changing the list may make the search engine unstable - as any CRUD operations on the indexable source record table may not reflect changes made during this event, handle NeedObject for XmlIndexableSourceRecordTable instead. |
| GetWordVariations | Variations (typically lemmas via stemming) of a word are required. Data contains a 2 element object array; first element is a Word object for the word that variations are needed for, and the second element is an ArrayList of strings holding the variations. The second element can be modified as desired. |
| ImportStarted | An import operation has started, Data contains the IndexableSourceRecord instance that is being imported. |
| ImportFinished | An import operation has ended, Data contains either an ArrayList of Uri objects that were imported, or if an exception occurred, it contains an Exception object. |
| IsDocumentToBeCrawled | The document has been checked to see if it will be crawled, Data contains IsDocumentToBeCrawledEventData and the WillCrawl property may be changed. |
| IsDocumentToBeIndexed | The document has been checked to see if it will be crawled, Data contains IsDocumentToBeIndexedEventData and WillIndex property may be changed. |
| IsFileSystemDocumentToBeIndexed | A document, found during a file system import is about to be indexed, Data contains IsFileSystemDocumentToBeIndexedEventData and WillIndex property may be changed. |
| IsResultCustomDataFilteredThrough | Whether a ResultItem should be included in the search results, Data contains CustomDataFilterActionData and its IsFilteredThrough property may be changed. |
| QueryExpressionGroupCreated | The raw query text has been parsed in to a GroupElement object, Data contains the GroupElement object which may be changed. |
| ReadLinks | The links in a document have been read, Data contains ArrayList of URL strings. |
| ReadingText | The text in a document has been parsed and is about to be weighted, use this event to modify the document text before it's weighted, Data contains DocumentText object. |
| ReadText | The text in a document has been read and weighted, Data contains DocumentText object. |
| RequestingUri | A HttpWebRequest object has been created and is about to be sent for a response from the server, Data contains the HttpWebRequest which can be modified. |
| ResponseFromServerReceived | A HttpWebResponse object has been created from a response from the server, Data contains the HttpWebResponse. |
| ResultItemsFinalized | The search result items have been found and sorted, Data contains an ResultItemList of ResultItem objects - the order and content of which may be changed. Ideal for result filtering. |
| ResultPreviewTextLoaded | The result preview text has been loaded, Data contains a StringBuilder containing the document text, the StringBuilder is modifiable when handling this event, use (sender as SearchResultPreviewHelper).Uri to get the document Uri. |
| SearchBegin | A search is beginning, the parameters are known and may be modified, Data contains the SearchParameters object with the query etc. |
| UseDocumentEncoding | The Encoding of a document is about to be used, Data contains the Document - the Encoding property may be read and/or set to the required value. |
Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2015.6.15.120