blob: d3afce08e70bbb6163f2492c50b882eeb38dceab [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Lookup.LookupResult
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Lookup.LookupResult
| 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="suggest/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.Suggest.Lookup.LookupResult">
<h1 id="Lucene_Net_Search_Suggest_Lookup_LookupResult" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult" class="text-break">Class Lookup.LookupResult
</h1>
<div class="markdown level0 summary"><p>Result of a lookup.</p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></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"><span class="xref">Lookup.LookupResult</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IComparable</span>&lt;<a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a>&gt;</div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<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>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Search.Suggest.html">Lucene.Net.Search.Suggest</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6>
<h5 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class LookupResult : IComparable&lt;Lookup.LookupResult&gt;</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.%23ctor(System.String%2CSystem.Int64)%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.Suggest/Suggest/Lookup.cs/#L65">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor(System.String,System.Int64)">LookupResult(String, Int64)</h4>
<div class="markdown level1 summary"><p>Create a new result from a key+weight pair.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LookupResult(string key, long value)</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">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></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_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.%23ctor(System.String%2CSystem.Int64%2CLucene.Net.Util.BytesRef)%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.Suggest/Suggest/Lookup.cs/#L73">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor(System.String,System.Int64,Lucene.Net.Util.BytesRef)">LookupResult(String, Int64, BytesRef)</h4>
<div class="markdown level1 summary"><p>Create a new result from a key+weight+payload triple.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LookupResult(string key, long value, BytesRef payload)</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">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.BytesRef</span></td>
<td><span class="parametername">payload</span></td>
<td></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_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_Lucene_Net_Util_BytesRef_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.%23ctor(System.String%2CSystem.Int64%2CLucene.Net.Util.BytesRef%2CSystem.Collections.Generic.IEnumerable%7BLucene.Net.Util.BytesRef%7D)%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.Suggest/Suggest/Lookup.cs/#L89">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_Lucene_Net_Util_BytesRef_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor(System.String,System.Int64,Lucene.Net.Util.BytesRef,System.Collections.Generic.IEnumerable{Lucene.Net.Util.BytesRef})">LookupResult(String, Int64, BytesRef, IEnumerable&lt;BytesRef&gt;)</h4>
<div class="markdown level1 summary"><p>Create a new result from a key+weight+payload+contexts triple.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LookupResult(string key, long value, BytesRef payload, IEnumerable&lt;BytesRef&gt; contexts)</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">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.BytesRef</span></td>
<td><span class="parametername">payload</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</td>
<td><span class="parametername">contexts</span></td>
<td></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_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_System_Collections_Generic_ISet_Lucene_Net_Util_BytesRef__.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.%23ctor(System.String%2CSystem.Int64%2CSystem.Collections.Generic.ISet%7BLucene.Net.Util.BytesRef%7D)%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.Suggest/Suggest/Lookup.cs/#L97">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Int64_System_Collections_Generic_ISet_Lucene_Net_Util_BytesRef__" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor(System.String,System.Int64,System.Collections.Generic.ISet{Lucene.Net.Util.BytesRef})">LookupResult(String, Int64, ISet&lt;BytesRef&gt;)</h4>
<div class="markdown level1 summary"><p>Create a new result from a key+weight+contexts triple.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LookupResult(string key, long value, ISet&lt;BytesRef&gt; contexts)</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">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.ISet</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</td>
<td><span class="parametername">contexts</span></td>
<td></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_Suggest_Lookup_LookupResult__ctor_System_String_System_Object_System_Int64_Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.%23ctor(System.String%2CSystem.Object%2CSystem.Int64%2CLucene.Net.Util.BytesRef)%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.Suggest/Suggest/Lookup.cs/#L81">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Object_System_Int64_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor(System.String,System.Object,System.Int64,Lucene.Net.Util.BytesRef)">LookupResult(String, Object, Int64, BytesRef)</h4>
<div class="markdown level1 summary"><p>Create a new result from a key+highlightKey+weight+payload triple.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LookupResult(string key, object highlightKey, long value, BytesRef payload)</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">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">highlightKey</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.BytesRef</span></td>
<td><span class="parametername">payload</span></td>
<td></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_Suggest_Lookup_LookupResult__ctor_System_String_System_Object_System_Int64_Lucene_Net_Util_BytesRef_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.%23ctor(System.String%2CSystem.Object%2CSystem.Int64%2CLucene.Net.Util.BytesRef%2CSystem.Collections.Generic.IEnumerable%7BLucene.Net.Util.BytesRef%7D)%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.Suggest/Suggest/Lookup.cs/#L105">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult__ctor_System_String_System_Object_System_Int64_Lucene_Net_Util_BytesRef_System_Collections_Generic_IEnumerable_Lucene_Net_Util_BytesRef__" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.#ctor(System.String,System.Object,System.Int64,Lucene.Net.Util.BytesRef,System.Collections.Generic.IEnumerable{Lucene.Net.Util.BytesRef})">LookupResult(String, Object, Int64, BytesRef, IEnumerable&lt;BytesRef&gt;)</h4>
<div class="markdown level1 summary"><p>Create a new result from a key+highlightKey+weight+payload+contexts triple.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public LookupResult(string key, object highlightKey, long value, BytesRef payload, IEnumerable&lt;BytesRef&gt; contexts)</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">key</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">highlightKey</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">value</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.BytesRef</span></td>
<td><span class="parametername">payload</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</td>
<td><span class="parametername">contexts</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</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_Suggest_Lookup_LookupResult_Contexts.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.Contexts%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.Suggest/Suggest/Lookup.cs/#L60">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Contexts_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Contexts*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Contexts" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Contexts">Contexts</h4>
<div class="markdown level1 summary"><p>the key&apos;s contexts (null if not present) </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public IEnumerable&lt;BytesRef&gt; Contexts { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Collections.Generic.IEnumerable</span>&lt;<span class="xref">Lucene.Net.Util.BytesRef</span>&gt;</td>
<td></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_Suggest_Lookup_LookupResult_HighlightKey.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.HighlightKey%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.Suggest/Suggest/Lookup.cs/#L48">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_HighlightKey_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.HighlightKey*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_HighlightKey" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.HighlightKey">HighlightKey</h4>
<div class="markdown level1 summary"><p>Expert: custom Object to hold the result of a
highlighted suggestion. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public object HighlightKey { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Object</span></td>
<td></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_Suggest_Lookup_LookupResult_Key.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.Key%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.Suggest/Suggest/Lookup.cs/#L42">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Key_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Key*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Key" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Key">Key</h4>
<div class="markdown level1 summary"><p>the key&apos;s text </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Key { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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>
<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_Suggest_Lookup_LookupResult_Payload.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.Payload%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.Suggest/Suggest/Lookup.cs/#L56">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Payload_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Payload*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Payload" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Payload">Payload</h4>
<div class="markdown level1 summary"><p>the key&apos;s payload (null if not present) </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public BytesRef Payload { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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">Lucene.Net.Util.BytesRef</span></td>
<td></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_Suggest_Lookup_LookupResult_Value.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.Value%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.Suggest/Suggest/Lookup.cs/#L52">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Value_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Value*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_Value" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.Value">Value</h4>
<div class="markdown level1 summary"><p>the key&apos;s weight </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public long Value { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</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.Int64</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Lookup_LookupResult_CompareTo_Lucene_Net_Search_Suggest_Lookup_LookupResult_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.CompareTo(Lucene.Net.Search.Suggest.Lookup.LookupResult)%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.Suggest/Suggest/Lookup.cs/#L121">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_CompareTo_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.CompareTo*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_CompareTo_Lucene_Net_Search_Suggest_Lookup_LookupResult_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.CompareTo(Lucene.Net.Search.Suggest.Lookup.LookupResult)">CompareTo(Lookup.LookupResult)</h4>
<div class="markdown level1 summary"><p>Compare alphabetically. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int CompareTo(Lookup.LookupResult o)</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><a class="xref" href="Lucene.Net.Search.Suggest.Lookup.LookupResult.html">Lookup.LookupResult</a></td>
<td><span class="parametername">o</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.Int32</span></td>
<td></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_Suggest_Lookup_LookupResult_ToString.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult.ToString%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.Suggest/Suggest/Lookup.cs/#L114">View Source</a>
</span>
<a id="Lucene_Net_Search_Suggest_Lookup_LookupResult_ToString_" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.ToString*"></a>
<h4 id="Lucene_Net_Search_Suggest_Lookup_LookupResult_ToString" data-uid="Lucene.Net.Search.Suggest.Lookup.LookupResult.ToString">ToString()</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 ToString()</code></pre>
</div>
<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><span class="xref">System.Object.ToString()</span></div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IComparable&lt;T&gt;</span>
</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Suggest_Lookup_LookupResult.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.Suggest.Lookup.LookupResult%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.Suggest/Suggest/Lookup.cs/#L38" 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>