Lucene.Net.Search.Highlight.IFormatter Interface Reference

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

Inherited by Lucene.Net.Search.Highlight.GradientFormatter, and Lucene.Net.Search.Highlight.SimpleHTMLFormatter.

Public Member Functions
string	HighlightTerm (System.String originalText, TokenGroup tokenGroup)

Detailed Description

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

Definition at line 22 of file IFormatter.cs.

Member Function Documentation

string Lucene.Net.Search.Highlight.IFormatter.HighlightTerm	(	System.String	originalText,
		TokenGroup	tokenGroup
	)

Parameters

originalText	The section of text being considered for markup
tokenGroup	contains one or several overlapping Tokens along with their scores and positions.

Implemented in Lucene.Net.Search.Highlight.SimpleHTMLFormatter.

---

The documentation for this interface was generated from the following file:

• contrib/Highlighter/IFormatter.cs