Highlighting results in network

Search results in the search network can be highlighted in the text of the found document using the Highlight method of the Searcher class. The found document is passed to the method as a NetworkFoundDocument object obtained from a search result.

The set of available classes for highlighting text, as well as the highlighting options, are identical to those used for highlighting search results in a single index. Please see also the Highlighting search results page.

The examples on this page use the master node of a running search network. The following code creates and starts the master node as described on the Search network deployment page; the slave nodes must be started beforehand.

C#

string basePath = @"c:\SearchNetwork\";
int basePort = 49100;

// Loading the search network configuration from a file
Configuration configuration = Configuration.Load(basePath + "Configuration.xml");

// Creating, configuring and starting the master node; the timeouts are specified in milliseconds
SearchNetworkNode node = SearchNetworkNode.CreateMasterNode(
    0,
    basePath + "Node0",
    new TcpSettings(basePort, 3000, 3000, 3000, 1000),
    new FileLogger(basePath + "Log.txt", 4.0),
    configuration);
node.ConfigureAllNodes();
node.Start();

The following code example, which continues the previous one, demonstrates highlighting search results on the search network.

C#

string query = "Einstein";
int maxFragments = 5; // The maximum number of fragments to output for each field

Searcher searcher = node.Searcher;

// Searching in the search network
NetworkSearchResult searchResult = searcher.SearchFirst(query, new SearchOptions());
if (searchResult.DocumentCount > 0)
{
    // Getting the first found document
    NetworkFoundDocument document = searchResult.GetFoundDocument(0);

    FragmentHighlighter highlighter = new FragmentHighlighter(OutputFormat.PlainText);

    HighlightOptions options = new HighlightOptions();
    options.TermsAfter = 5;
    options.TermsBefore = 5;
    options.TermsTotal = 15;
    searcher.Highlight(document, highlighter, options);

    FragmentContainer[] result = highlighter.GetResult();
    Console.WriteLine();
    for (int i = 0; i < result.Length; i++)
    {
        FragmentContainer container = result[i];
        if (container.Count == 0) continue;

        string[] fragments = container.GetFragments();
        Console.WriteLine(container.FieldName);
        int count = Math.Min(fragments.Length, maxFragments);
        for (int j = 0; j < count; j++)
        {
            Console.WriteLine("\t" + fragments[j]);
        }
    }
}

More resources

GitHub examples

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

Free online document search App

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.

Close
Loading

Analyzing your prompt, please hold on...

An error occurred while retrieving the results. Please refresh the page and try again.