Search Component

Properties   Methods   Events   Config Settings   Errors  

The Search component provides a simple way to search for documents in search indexes.

Syntax

nsoftware.IPWorksSearch.Search

Remarks

The Search component provides a simple way to search for documents in Lucene 4.8 search indexes. The component supports different types of search operations, including basic searches and boolean query construction. The component also provides control over query text processing via various query and analyzer types.

Loading the Search Index

It is important to note that any external changes made to the index after it is loaded are not visible to the component until the OpenIndex method is called again. The method can be called as many times as needed to reload the index and reflect its latest changes in subsequent search operations. For example:

component.OpenIndex(); // Load the search index // ... Perform operations on the index ... component.OpenIndex(); // Reload the index to reflect any new updates

Simple Search

// Search the index for a document with a field named "content" that has text matching the expression "Getting started" search.DoSimpleSearch("content", "Getting started");

Retrieving Search Results

Highlighting Relevant Terms

The Highlight method can be called from within the SearchResult event to retrieve the most relevant text snippet of a field from a search result. The most relevant terms within this snippet will be highlighted using the HTML tag specified in the HighlightTag property. search.HighlightTag = "<em>"; // Tell the component we want to highlight each relevant term with <em> tags search.OnSearchResult += (s, e) => { // If the current search result has a field named "content" with // a value of "Getting started with IPWorksSearch", this method will return // "<em>Getting started</em> with IPWorksSearch" search.HighlightField("content"); };

Pagination

The component handles pagination automatically. After performing a search operation with DoSimpleSearch or DoSearch, the HasMorePages property will indicate whether more pages of results are available. A subsequent call to the same method will retrieve the next page of results if HasMorePages is true. // Search the index until there are no more pages left do { component.DoSearch(); } while (search.HasMorePages);

Boolean Queries

Creating Boolean Queries

To begin a boolean search, call AddQuery to add queries to the Queries collection. Each query specifies the field to search, the value to look for, the type of content to look for, and how the query relates to other queries. For more information on the different supported query types please see the documentation for the QueryType field.

// Add a term query to search for documents containing "nsoftware" in the "company" field component.AddQuery("company", "nsoftware", (int)TQueryTypes.qtTerm, (int)TOccurTypes.otMust); // Add a phrase query to search for documents containing the phrase "software development" in the "content" field component.AddQuery("content", "software development", (int)TQueryTypes.qtPhrase, (int)TOccurTypes.otMust);

After populating the Queries collection with search queries, call the DoSearch method to start the boolean search operation. This will combine all of the queries added to the Queries collection based on their occur types. The SearchResult event will then fire for each document in the index that matches the combined queries. For more information on how these queries are combined, please see the documentation for the OccurType field. component.DoSearch();

Unloading the Index

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Analyzer Property (Search Component)

The analyzer used in search operations.

Syntax

• C#
• VB.NET

public SearchAnalyzers Analyzer { get; set; }

enum SearchAnalyzers {
  atStandard,
  atStop,
  atWhitespace,
  atSimple,
  atEmail
}

Public Property Analyzer As SearchAnalyzers

Enum SearchAnalyzers
  atStandard
  atStop
  atWhitespace
  atSimple
  atEmail
End Enum

Default Value

1

Remarks

Specifies the analyzer used in search operations.

Possible values are:

Analyzers and Tokenization

The way tokens are created directly affects the precision and relevance of search results. For example, if an analyzer does not break down the terms "WORD" and "word" as the same value, searches for one may not bring up results for the other.

Stop Words

The full list of stop words that are ignored by these analyzers can be found below:

a, an, and, are, as, at, be, but, by, for, if, in, into, is, it, no, not, of, on,
or, such, that, the, their, then, there, these, they, this, to, was, will, with

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

This property is not available at design time.

HasMorePages Property (Search Component)

Whether or not more pages of results are available for the ongoing search operation.

Syntax

• C#
• VB.NET

public bool HasMorePages { get; }

Public ReadOnly Property HasMorePages As Boolean

Default Value

False

Remarks

Indicates whether or not more pages of results are available for the ongoing search operation.

Pagination

When DoSearch is called, the component will retrieve a single page of search results. If additional results are available, HasMorePages will be automatically set to true. Subsequent calls to DoSearch will then retrieve the next page of results, if one is available.

The example below retrieves all of the search results that match the queries in the Queries collection.

Example: // Search through every page of results do { search.DoSearch(); } while (search.HasMorePages);

This property is read-only.

HighlightTag Property (Search Component)

The HTML tag used to highlight the most relevant terms in a highlighted field.

Syntax

• C#
• VB.NET

public string HighlightTag { get; set; }

Public Property HighlightTag As String

Default Value

"<b>"

Remarks

Specifies the HTML tag used to highlight the most relevant terms in the value returned by the Highlight method.

Highlighting Relevant Terms

For example, if HighlightTag is set to <em> and a search operation for the word "sample" is performed, the output of the method might look like this: This is a <em>sample</em> sentence.

Example: // Assuming we only have a single term query with a value of "sample" search.HighlightTag = "<em>"; // Tell the component we want to highlight each relevant term with <em> tags search.OnSearchResult += (s, e) => { // If the current search result has a field named "content" with // a value of "This is a sample sentence", this method will return // the value "This is a <em>sample</em> sentence." search.HighlightField("content"); };

IndexPath Property (Search Component)

The path to the search index.

Syntax

• C#
• VB.NET

public string IndexPath { get; set; }

Public Property IndexPath As String

Default Value

""

Remarks

The filesystem path to the Lucene search index that will be searched. This property must be specified before calling the OpenIndex method.

Loading a Search Index

Example: component.IndexPath = "PATH\\TO\\INDEX"; // Specify the path to the search index component.OpenIndex(); // Load the index // ... Perform operations on the index ... component.CloseIndex();

Relative and Absolute Paths

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

PageSize Property (Search Component)

The maximum number of documents that can be retrieved per each page of search results.

Syntax

• C#
• VB.NET

public int PageSize { get; set; }

Public Property PageSize As Integer

Default Value

20

Remarks

Specifies the maximum number of documents that can be retrieved per each page of search results. This value can be used to control the maximum number of results that will be returned after calling DoSearch.

Example: // Tell the component to return at most 5 documents per each page of results component.PageSize = 5; // Search through every page of results do { // The "SearchResult" event will fire at most 5 times every time DoSearch is called component.DoSearch(); } while (component.HasMorePages);

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

Queries Property (Search Component)

A collection of queries that determine the criteria for finding documents in the search index.

Syntax

• C#
• VB.NET

public QueryList Queries { get; }

Public Property Queries As QueryList

Remarks

Contains a collection of queries that determine the search criteria for finding documents in the search index. A query can be added by accessing this property directly, or by calling the AddQuery method.

Adding Queries

Example (Simple): // Look for text that matches "Sample query text" in a document field named "content" component.AddQuery("content", "Sample query text", (int)TQueryTypes.qtParsed, (int)TOccurTypes.otMust); // This will return documents with fields that match the query. // Results will be accessible via the SearchResult event. component.DoSearch();

Example (Advanced): // Look for text that matches "Sample query text" in a document field with the name "content" // The "otMust" occur type indicates that this criteria must be met for the document to appear in the results component.AddQuery("content", "Sample query text", (int)TQueryTypes.qtParsed, (int)TOccurTypes.otMust); // Look for text that starts with "IP" in a document field with the name "toolkit" component.AddQuery("toolkit", "IP", (int)TQueryTypes.qtPrefix, (int)TOccurTypes.otMust); // This will return documents with fields that match both queries. // Results will be accessible via the SearchResult event. component.DoSearch();

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

This property is not available at design time.

ResultCount Property (Search Component)

The total number of search results returned after a search is performed.

Syntax

• C#
• VB.NET

public int ResultCount { get; }

Public ReadOnly Property ResultCount As Integer

Default Value

0

Remarks

Contains the total number of search results returned after a search operation is performed. When DoSearch is called to search the index, this property is automatically set to the total number of documents that match the search Queries.

The maximum number of documents that can be returned can be controlled with the PageSize property.

This property is read-only.

ResultFields Property (Search Component)

The fields of the current search result document.

Syntax

• C#
• VB.NET

public ResultFieldList ResultFields { get; }

Public Property ResultFields As ResultFieldList

Remarks

Contains the fields of the current search result document.

Retrieving Search Results

Example: search.OnSearchResult += (s, e) => { foreach (ResultField field in search.ResultFields) { // Display the name and text content of every field Console.WriteLine(field.Name + ": " + field.Text); } };

Alternatively, the GetResultField method can be used inside the event to retrieve the text value of a known field from the current search result.

Example: search.OnSearchResult += (s, e) => { // Display a specific field value string authorFieldValue = search.GetResultField("author"); Console.WriteLine("author: " + authorFieldValue); };

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

AddQuery Method (Search Component)

Creates a search query.

Syntax

• C#
• VB.NET

public void AddQuery(string field, string value, int queryType, int occurType);

Public Sub AddQuery(ByVal field As String, ByVal value As String, ByVal queryType As Integer, ByVal OccurType As Integer)

Remarks

Creates a search query and adds it to the Queries collection.

When DoSearch is called, the added queries are combined to search the index and the SearchResult event will fire for each document that matches the combined queries.

Field specifies the exact name of the document field to be searched.

Value specifies the text content to look for in the specified document field. Its format depends on the value passed into the QueryType parameter.

QueryType defines the type of search query that will be performed. Its value determines how the Field and Value parameters are used to identify matching documents.

OccurType determines how queries relate to each other when they are combined. Possible values are:

Example (Simple): // Look for text that matches "Sample query text" in a document field named "content" component.AddQuery("content", "Sample query text", (int)TQueryTypes.qtParsed, (int)TOccurTypes.otMust); // This will return documents with fields that match the query. // Results will be accessible via the SearchResult event. component.DoSearch();

Example (Advanced): // Look for text that matches "Sample query text" in a document field with the name "content" // The "otMust" occur type indicates that this criteria must be met for the document to appear in the results component.AddQuery("content", "Sample query text", (int)TQueryTypes.qtParsed, (int)TOccurTypes.otMust); // Look for text that starts with "IP" in a document field with the name "toolkit" component.AddQuery("toolkit", "IP", (int)TQueryTypes.qtPrefix, (int)TOccurTypes.otMust); // This will return documents with fields that match both queries. // Results will be accessible via the SearchResult event. component.DoSearch();

Parsed Query Notes

Example: component.AnalyzerType = (int)TSearchAnalyzerTypes.atWhitespace; // the Whitespace analyzer keeps stop words and uppercase characters // This query value will be broken down into the following list of term queries: "This, is, a, SAMPLE, query" component.AddQuery("data", "This is a SAMPLE query", (int)TQueryTypes.qtParsed, (int)TOccurTypes.otMust); component.AnalyzerType = (int)TSearchAnalyzerTypes.atWhitespace; // the Standard analyzer converts all letters to lowercase and removes stop words // This query value will be broken down into the following list of term queries: "this, sample, query" component.AddQuery("data", "This is a SAMPLE query", (int)TQueryTypes.qtParsed, (int)TOccurTypes.otMust);

Numeric Range Query Notes

If both of the values in the range are integers numbers without a suffix, the the range query will exclusively target Int32 fields. To include Int64 fields instead, the l or L characters can be appended to one of the integer values specified in the query Value.

Example: // Range query over a range of integer values // Since both of the values in the range are integers without special syntax, the component will only // look for Int32 fields that match this query component.AddQuery("data", "5 - 10", (int)TQueryTypes.qtNumericRange, (int)TOccurTypes.otMust); // Range query over a range of long values // To include Int64 fields in the search results, an 'l' or 'L' must be appended to one of the bound values // in the specified range component.AddQuery("data", "2000 - 192039l", (int)TQueryTypes.qtNumericRange, (int)TOccurTypes.otMust);

If a decimal is present without any suffix, the range query will ignore Float fields and target Double fields. To target Float fields instead, the f or F characters can be appended to one of the floating-point values specified in the query Value.

Example: // Range query over a range of double values // If a decimal is present without any suffix, the query will only target double fields component.AddQuery("data", "3 - 4.14592", (int)TQueryTypes.qtNumericRange, (int)TOccurTypes.otMust); // Range query over a range of float values // Adding a 'f' or 'F' character next to a floating point number will make the query applicable to float fields component.AddQuery("data", "5.13f - 10", (int)TQueryTypes.qtNumericRange, (int)TOccurTypes.otMust);

Term Range Query Notes

Example: // Term range query over a range of dates // Since hyphens are part of the date format, they need to be escaped. // This query specifies a range from "5-7-2024" to "5-8-2024" component.AddQuery("data", "5\\-7\\-2024 - 5\\-8\\-2024", (int)TQueryTypes.qtTermRange, (int)TOccurTypes.otMust);

CloseIndex Method (Search Component)

Unloads the search index.

Syntax

• C#
• VB.NET

public void CloseIndex();

Public Sub CloseIndex()

Remarks

Unloads the search index.

Config Method (Search Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoSearch Method (Search Component)

Searches the index for documents that match one or more queries.

Syntax

• C#
• VB.NET

public void DoSearch();

Public Sub DoSearch()

Remarks

Searches the index for any documents that match the queries specified in the Queries collection.

Note: This method does not clear the contents of the Queries collection.

Retrieving Search Results

Example: search.OnSearchResult += (s, e) => { foreach (ResultField field in search.ResultFields) { // Display the name and text content of every field Console.WriteLine(field.Name + ": " + field.Text); } };

Alternatively, the GetResultField method can be used inside the event to retrieve the text value of a known field from the current search result.

Example: search.OnSearchResult += (s, e) => { // Display a specific field value string authorFieldValue = search.GetResultField("author"); Console.WriteLine("author: " + authorFieldValue); };

Pagination

The example below retrieves all of the search results that match the queries in the Queries collection.

Example: // Search through every page of results do { search.DoSearch(); } while (search.HasMorePages);

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

DoSimpleSearch Method (Search Component)

Searches the index for documents that match a single search query.

Syntax

• C#
• VB.NET

public void DoSimpleSearch(string fieldName, string queryText);

Public Sub DoSimpleSearch(ByVal FieldName As String, ByVal QueryText As String)

Remarks

Searches the index for documents that match a single search query. To search for documents that match multiple queries, use DoSearch instead.

FieldName specifies the exact name of the document field to be searched.

QueryText defines what to look for in the specified document field. Its value may be a human-readable search query that makes use of the Lucene 4.8 query syntax, as defined in the Lucene query parser documentation.

Example:

component.DoSimpleSearch();

Retrieving Search Results

Example: search.OnSearchResult += (s, e) => { foreach (ResultField field in search.ResultFields) { // Display the name and text content of every field Console.WriteLine(field.Name + ": " + field.Text); } };

Alternatively, the GetResultField method can be used inside the event to retrieve the text value of a known field from the current search result.

Example: search.OnSearchResult += (s, e) => { // Display a specific field value string authorFieldValue = search.GetResultField("author"); Console.WriteLine("author: " + authorFieldValue); };

Pagination

The example below retrieves all of the search results that match the specified search query.

Example: // Search through every page of results do { search.DoSimpleSearch(); } while (search.HasMorePages);

GetResultField Method (Search Component)

Retrieves the text value of a field from the current search result.

Syntax

• C#
• VB.NET

public string GetResultField(string fieldName);

Public Function GetResultField(ByVal fieldName As String) As String

Remarks

Retrieves the text value of a field from the current search result document during an ongoing search operation. This method should only be called within an event handler for the SearchResult event.

FieldName specifies the name of the document field for which the text value is retrieved.

Multi-Valued Fields

Additional values for multi-valued fields may be accessed through the ResultFields collection.

Example: // This should only be done within the SearchResult event for (ResultField field in search.ResultFields) { // Display the text value of each field in the current search result document // this includes fields that have the same name Console.WriteLine(field.Text); }

Highlight Method (Search Component)

Retrieves the most relevant text snippet of a field from the current search result.

Syntax

• C#
• VB.NET

public string Highlight(string fieldName);

Public Function Highlight(ByVal fieldName As String) As String

Remarks

Retrieves the most relevant text snippet of a document field from the current search result document. This method should only be called within an event handler for the SearchResult event.

FieldName specifies the name of the document field for which the relevant text snippet will be retrieved. If the specified field does not contain any relevant terms, this method will return an empty string.

Highlighting Relevant Terms

For example, if HighlightTag is set to <em> and a search operation for the word "sample" is performed, the output of the method might look like this: This is a <em>sample</em> sentence.

Example: // Assuming we only have a single term query with a value of "sample" search.HighlightTag = "<em>"; // Tell the component we want to highlight each relevant term with <em> tags search.OnSearchResult += (s, e) => { // If the current search result has a field named "content" with // a value of "This is a sample sentence", this method will return // the value "This is a <em>sample</em> sentence." search.HighlightField("content"); };

Multi-Valued Fields

The HighlightFieldIndex configuration setting can be used to specify which occurrence to highlight among fields with the same name when multiple are present in the document. It takes in a zero-based index that identifies one of these similarly-named fields. This index value only applies to fields that match the FieldName parameter, and does not consider fields with different names.

Example: // Assuming the current result is a document with two separate fields that share the same name but have different values, like so: // { // author: "John Smith", // author: "Robert Roe" // } search.OnSearchResult += (s, e) => { search.Config("HighlightFieldIndex=1"); // Tell the component we want to retrieve the second field search.HighlightField("author"); // Returns the most relevant text snippet for the field with the value "Robert Roe" };

OpenIndex Method (Search Component)

Loads the search index.

Syntax

• C#
• VB.NET

public void OpenIndex();

Public Sub OpenIndex()

Remarks

Loads the search index located in the path specified by IndexPath. This method should be called at least once before searching the index with DoSearch. To unload the search index, call CloseIndex instead.

Index Updates

This method can be called multiple times to reload the index and reflect its latest changes in search operations. Example:

component.OpenIndex(); // Load the search index // ... Perform operations on the index ... component.OpenIndex(); // Reload the index to reflect any new updates

Resetting Pagination

The component will automatically reset its pagination state if the OpenIndex method is called or if there are changes to Queries, Analyzer, IndexPath, ResultFields, or PageSize. When this happens, the next call to DoSearch or DoSimpleSearch will start over from the first page of results.

Example: // Search through every page of results do { component.DoSearch(); } while (component.HasMorePages); // Call OpenIndex(), or make changes to the Queries, AnalyzerType, IndexPath, ResultFields, or PageSize properties component.OpenIndex(); // After that, the current search operation will cease and automatically start over // from the first page of results the next time DoSearch() or DoSimpleSearch() is called component.DoSearch();

Error Event (Search Component)

Fires to provide information about errors during search operations.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SearchErrorEventArgs e);

public class SearchErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SearchErrorEventArgs)

Public Class SearchErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

Fires in case of exceptional conditions during search operations. Normally, the component will raise an exception instead.

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (Search Component)

This event fires once for each log message.

Syntax

• C#
• VB.NET

public event OnLogHandler OnLog;

public delegate void OnLogHandler(object sender, SearchLogEventArgs e);

public class SearchLogEventArgs : EventArgs {
  public int LogLevel { get; }
  public string Message { get; }
  public string LogType { get; }
}

Public Event OnLog As OnLogHandler

Public Delegate Sub OnLogHandler(sender As Object, e As SearchLogEventArgs)

Public Class SearchLogEventArgs Inherits EventArgs
  Public ReadOnly Property LogLevel As Integer
  Public ReadOnly Property Message As String
  Public ReadOnly Property LogType As String
End Class

Remarks

This event fires once for each log message generated by the component. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of detail of the log message. Possible values are:

Message is the log entry.

LogType identifies the type of log entry.

SearchResult Event (Search Component)

Fires for each document returned from a search operation.

Syntax

• C#
• VB.NET

public event OnSearchResultHandler OnSearchResult;

public delegate void OnSearchResultHandler(object sender, SearchSearchResultEventArgs e);

public class SearchSearchResultEventArgs : EventArgs {
  public string score { get; }
}

Public Event OnSearchResult As OnSearchResultHandler

Public Delegate Sub OnSearchResultHandler(sender As Object, e As SearchSearchResultEventArgs)

Public Class SearchSearchResultEventArgs Inherits EventArgs
  Public ReadOnly Property score As String
End Class

Remarks

Fires for each document that matches the search queries specified in the Queries collection when a search operation is performed with DoSearch.

Score represents how closely the current document matches the search queries for the ongoing search operation. Higher Score values indicate a more relevant match.

Retrieving Search Results

Example: search.OnSearchResult += (s, e) => { foreach (ResultField field in search.ResultFields) { // Display the name and text content of every field Console.WriteLine(field.Name + ": " + field.Text); } };

Alternatively, the GetResultField method can be used inside the event to retrieve the text value of a known field from the current search result.

Example: search.OnSearchResult += (s, e) => { // Display a specific field value string authorFieldValue = search.GetResultField("author"); Console.WriteLine("author: " + authorFieldValue); };

Query Type

Holds information about a search query.

Remarks

This is used to define the search criteria for finding documents in the search index.

Fields

Constructors

• C#
• VB.NET

public Query();

Public Query()

• C#
• VB.NET

public Query(string documentField, string value, TQueryTypes queryType);

Public Query(ByVal DocumentField As String, ByVal Value As String, ByVal QueryType As TQueryTypes)

• C#
• VB.NET

public Query(string documentField, string value, TQueryTypes queryType, TOccurTypes occurType);

Public Query(ByVal DocumentField As String, ByVal Value As String, ByVal QueryType As TQueryTypes, ByVal OccurType As TOccurTypes)

ResultField Type

Holds information about a field from a search result document.

Remarks

This is used to access the data associated with a specific field in a search result document.

Fields

Constructors

• C#
• VB.NET

public ResultField();

Public ResultField()

Config Settings (Search Component)

Search Config Settings

Base Config Settings

Trappable Errors (Search Component)