Click or drag to resize

StringExtensionsGetSnippet Method (String, String, SnippetsOptions)

Gets a snippet for an attribute or a string.

Namespace:  SphinxConnector.FluentApi.Util
Assembly:  SphinxConnector (in SphinxConnector.dll) Version: 5.4.1
Syntax
Copy
public static string GetSnippet(
	this string highlightSource,
	string query,
	SnippetsOptions options
)

Parameters

highlightSource
Type: SystemString
The attribute or text to highlight.
query
Type: SystemString
The query.
options
Type: SphinxConnector.FluentApiSnippetsOptions
The options for building the Snippet. Supported with Sphinx 2.2.1 and Manticore.

Return Value

Type: String
The highlighted text.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Examples
Copy
using (IFulltextSession fulltextSession = fulltextStore.StartSession())
{
    string query = "my query";

    var snippetOptions = new SnippetsOptions  {  BeforeMatch = "<i>",  AfterMatch = "</i>" }

    var results = fulltextSession.Query<Product>().
                                  Match(query).
                                  Select(product => new
                                  {
                                      product.Id,
                                      product.Name,
                                      Snippet = product.Description.GetSnippet(query, snippetOptions)
                                  }).ToList();
}
See Also