| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Interface IFragmentsBuilder |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Interface IFragmentsBuilder |
| | Apache Lucene.NET 4.8.0-beta00010 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.VectorHighlight.IFragmentsBuilder"> |
| |
| |
| <h1 id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder" class="text-break">Interface IFragmentsBuilder |
| </h1> |
| <div class="markdown level0 summary"><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> is an interface for fragments (snippets) builder classes. |
| A <a class="xref" href="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.html">IFragmentsBuilder</a> class can be plugged in to |
| <a class="xref" href="Lucene.Net.Search.VectorHighlight.FastVectorHighlighter.html">FastVectorHighlighter</a>.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.VectorHighlight.html">Lucene.Net.Search.VectorHighlight</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Highlighter.dll</h6> |
| <h5 id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public interface IFragmentsBuilder</code></pre> |
| </div> |
| <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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragment_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragment(Lucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CLucene.Net.Search.VectorHighlight.FieldFragList)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs/#L40">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragment_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragment*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragment_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragment(Lucene.Net.Index.IndexReader,System.Int32,System.String,Lucene.Net.Search.VectorHighlight.FieldFragList)">CreateFragment(IndexReader, Int32, String, FieldFragList)</h4> |
| <div class="markdown level1 summary"><p>create a fragment.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string CreateFragment(IndexReader reader, int docId, string fieldName, FieldFragList fieldFragList)</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">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a></td> |
| <td><span class="parametername">fieldFragList</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a> object</p> |
| </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><p>a created fragment or null when no fragment created</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragment_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragment(Lucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CLucene.Net.Search.VectorHighlight.FieldFragList%2CSystem.String%5B%5D%2CSystem.String%5B%5D%2CLucene.Net.Search.Highlight.IEncoder)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs/#L71">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragment_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragment*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragment_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragment(Lucene.Net.Index.IndexReader,System.Int32,System.String,Lucene.Net.Search.VectorHighlight.FieldFragList,System.String[],System.String[],Lucene.Net.Search.Highlight.IEncoder)">CreateFragment(IndexReader, Int32, String, FieldFragList, String[], String[], IEncoder)</h4> |
| <div class="markdown level1 summary"><p>create a fragment.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string CreateFragment(IndexReader reader, int docId, string fieldName, FieldFragList fieldFragList, string[] preTags, string[] postTags, IEncoder encoder)</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">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a></td> |
| <td><span class="parametername">fieldFragList</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">preTags</span></td> |
| <td><p>pre-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">postTags</span></td> |
| <td><p>post-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Highlight.IEncoder.html">IEncoder</a></td> |
| <td><span class="parametername">encoder</span></td> |
| <td><p>an encoder that generates encoded text</p> |
| </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><p>a created fragment or null when no fragment created</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragments_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragments(Lucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CLucene.Net.Search.VectorHighlight.FieldFragList%2CSystem.Int32)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs/#L56">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragments_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragments*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragments_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_System_Int32_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragments(Lucene.Net.Index.IndexReader,System.Int32,System.String,Lucene.Net.Search.VectorHighlight.FieldFragList,System.Int32)">CreateFragments(IndexReader, Int32, String, FieldFragList, Int32)</h4> |
| <div class="markdown level1 summary"><p>create multiple fragments.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string[] CreateFragments(IndexReader reader, int docId, string fieldName, FieldFragList fieldFragList, int maxNumFragments)</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">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighter</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a></td> |
| <td><span class="parametername">fieldFragList</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxNumFragments</span></td> |
| <td><p>maximum number of fragments</p> |
| </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><p>created fragments or null when no fragments created. |
| size of the array can be less than <code data-dev-comment-type="paramref" class="paramref">maxNumFragments</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragments_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_System_Int32_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragments(Lucene.Net.Index.IndexReader%2CSystem.Int32%2CSystem.String%2CLucene.Net.Search.VectorHighlight.FieldFragList%2CSystem.Int32%2CSystem.String%5B%5D%2CSystem.String%5B%5D%2CLucene.Net.Search.Highlight.IEncoder)%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/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs/#L91">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragments_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragments*"></a> |
| <h4 id="Lucene_Net_Search_VectorHighlight_IFragmentsBuilder_CreateFragments_Lucene_Net_Index_IndexReader_System_Int32_System_String_Lucene_Net_Search_VectorHighlight_FieldFragList_System_Int32_System_String___System_String___Lucene_Net_Search_Highlight_IEncoder_" data-uid="Lucene.Net.Search.VectorHighlight.IFragmentsBuilder.CreateFragments(Lucene.Net.Index.IndexReader,System.Int32,System.String,Lucene.Net.Search.VectorHighlight.FieldFragList,System.Int32,System.String[],System.String[],Lucene.Net.Search.Highlight.IEncoder)">CreateFragments(IndexReader, Int32, String, FieldFragList, Int32, String[], String[], IEncoder)</h4> |
| <div class="markdown level1 summary"><p>create multiple fragments.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">string[] CreateFragments(IndexReader reader, int docId, string fieldName, FieldFragList fieldFragList, int maxNumFragments, string[] preTags, string[] postTags, IEncoder encoder)</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">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">Lucene.Net.Index.IndexReader</span> of the index</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">docId</span></td> |
| <td><p>document id to be highlighter</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">fieldName</span></td> |
| <td><p>field of the document to be highlighted</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a></td> |
| <td><span class="parametername">fieldFragList</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Search.VectorHighlight.FieldFragList.html">FieldFragList</a> object</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxNumFragments</span></td> |
| <td><p>maximum number of fragments</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">preTags</span></td> |
| <td><p>pre-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span>[]</td> |
| <td><span class="parametername">postTags</span></td> |
| <td><p>post-tags to be used to highlight terms</p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Highlight.IEncoder.html">IEncoder</a></td> |
| <td><span class="parametername">encoder</span></td> |
| <td><p>an encoder that generates encoded text</p> |
| </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><p>created fragments or null when no fragments created. |
| size of the array can be less than <code data-dev-comment-type="paramref" class="paramref">maxNumFragments</code></p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_VectorHighlight_IFragmentsBuilder.md&value=---%0Auid%3A%20Lucene.Net.Search.VectorHighlight.IFragmentsBuilder%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net.Highlighter/VectorHighlight/FragmentsBuilder.cs/#L29" 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> |