Fork me on GitHub
  • API

    Show / Hide Table of Contents

    Interface IFormatter

    Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.

    Namespace: Lucene.Net.Search.Highlight
    Assembly: Lucene.Net.Highlighter.dll
    Syntax
    public interface IFormatter

    Methods

    HighlightTerm(string, TokenGroup)

    Processes terms found in the original text, typically by applying some form of mark-up to highlight terms in HTML search results pages.

    Declaration
    string HighlightTerm(string originalText, TokenGroup tokenGroup)
    Parameters
    Type Name Description
    string originalText

    The section of text being considered for markup

    TokenGroup tokenGroup

    contains one or several overlapping Tokens along with their scores and positions.

    Returns
    Type Description
    string
    Back to top Copyright © 2024 The Apache Software Foundation, Licensed under the Apache License, Version 2.0
    Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation.
    All other marks mentioned may be trademarks or registered trademarks of their respective owners.