| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class SpanGradientFormatter |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class SpanGradientFormatter |
| | Apache Lucene.NET 4.8.0-beta00009 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="highlighter/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Search.Highlight.SpanGradientFormatter"> |
| |
| |
| <h1 id="Lucene_Net_Search_Highlight_SpanGradientFormatter" data-uid="Lucene.Net.Search.Highlight.SpanGradientFormatter" class="text-break">Class SpanGradientFormatter |
| </h1> |
| <div class="markdown level0 summary"><p>Formats text with different color intensity depending on the score of the |
| term using the span tag. <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html">GradientFormatter</a> uses a bgcolor argument to the font tag which |
| doesn't work in Mozilla, thus this class.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html">GradientFormatter</a></div> |
| <div class="level2"><span class="xref">SpanGradientFormatter</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Highlight.IFormatter.html">IFormatter</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_fgRMin">GradientFormatter.m_fgRMin</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_fgGMin">GradientFormatter.m_fgGMin</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_fgBMin">GradientFormatter.m_fgBMin</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_fgRMax">GradientFormatter.m_fgRMax</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_fgGMax">GradientFormatter.m_fgGMax</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_fgBMax">GradientFormatter.m_fgBMax</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_highlightForeground">GradientFormatter.m_highlightForeground</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_bgRMin">GradientFormatter.m_bgRMin</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_bgGMin">GradientFormatter.m_bgGMin</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_bgBMin">GradientFormatter.m_bgBMin</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_bgRMax">GradientFormatter.m_bgRMax</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_bgGMax">GradientFormatter.m_bgGMax</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_bgBMax">GradientFormatter.m_bgBMax</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_m_highlightBackground">GradientFormatter.m_highlightBackground</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_GetForegroundColorString_System_Single_">GradientFormatter.GetForegroundColorString(Single)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_GetBackgroundColorString_System_Single_">GradientFormatter.GetBackgroundColorString(Single)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_HexToInt32_System_String_">GradientFormatter.HexToInt32(String)</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Highlight.html">Lucene.Net.Search.Highlight</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Highlighter.dll</h6> |
| <h5 id="Lucene_Net_Search_Highlight_SpanGradientFormatter_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class SpanGradientFormatter : GradientFormatter, IFormatter</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Highlight_SpanGradientFormatter__ctor_System_Single_System_String_System_String_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.SpanGradientFormatter.%23ctor(System.Single%2CSystem.String%2CSystem.String%2CSystem.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Highlighter/Highlight/SpanGradientFormatter.cs/#L34">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_SpanGradientFormatter__ctor_" data-uid="Lucene.Net.Search.Highlight.SpanGradientFormatter.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_SpanGradientFormatter__ctor_System_Single_System_String_System_String_System_String_System_String_" data-uid="Lucene.Net.Search.Highlight.SpanGradientFormatter.#ctor(System.Single,System.String,System.String,System.String,System.String)">SpanGradientFormatter(Single, String, String, String, String)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public SpanGradientFormatter(float maxScore, string minForegroundColor, string maxForegroundColor, string minBackgroundColor, string maxBackgroundColor)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">maxScore</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">minForegroundColor</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">maxForegroundColor</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">minBackgroundColor</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">maxBackgroundColor</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Highlight_SpanGradientFormatter_HighlightTerm_System_String_Lucene_Net_Search_Highlight_TokenGroup_.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.SpanGradientFormatter.HighlightTerm(System.String%2CLucene.Net.Search.Highlight.TokenGroup)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/Shazwazza/lucenenet/blob/docs-poc/src/Lucene.Net.Highlighter/Highlight/SpanGradientFormatter.cs/#L40">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Highlight_SpanGradientFormatter_HighlightTerm_" data-uid="Lucene.Net.Search.Highlight.SpanGradientFormatter.HighlightTerm*"></a> |
| <h4 id="Lucene_Net_Search_Highlight_SpanGradientFormatter_HighlightTerm_System_String_Lucene_Net_Search_Highlight_TokenGroup_" data-uid="Lucene.Net.Search.Highlight.SpanGradientFormatter.HighlightTerm(System.String,Lucene.Net.Search.Highlight.TokenGroup)">HighlightTerm(String, TokenGroup)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override string HighlightTerm(string originalText, TokenGroup tokenGroup)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">originalText</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Highlight.TokenGroup.html">TokenGroup</a></td> |
| <td><span class="parametername">tokenGroup</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html#Lucene_Net_Search_Highlight_GradientFormatter_HighlightTerm_System_String_Lucene_Net_Search_Highlight_TokenGroup_">GradientFormatter.HighlightTerm(String, TokenGroup)</a></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Search.Highlight.IFormatter.html">IFormatter</a> |
| </div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.Highlight.GradientFormatter.html">GradientFormatter</a></div> |
| </div> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00009/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Highlight_SpanGradientFormatter.md&value=---%0Auid%3A%20Lucene.Net.Search.Highlight.SpanGradientFormatter%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/docs-poc/src/Lucene.Net.Highlighter/Highlight/SpanGradientFormatter.cs/#L28" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |