blob: 410945cdf741e95d9d1c1062b2e521410597a346 [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 SortedSetSortField
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SortedSetSortField
| 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="sandbox/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.Sandbox.Queries.SortedSetSortField">
<h1 id="Lucene_Net_Sandbox_Queries_SortedSetSortField" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField" class="text-break">Class SortedSetSortField
</h1>
<div class="markdown level0 summary"><p>SortField for <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Index.SortedSetDocValues.html">SortedSetDocValues</a>.
<p>
A <a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Index.SortedSetDocValues.html">SortedSetDocValues</a> contains multiple values for a field, so sorting with
this technique &quot;selects&quot; a value as the representative sort value for the document.
<p>
By default, the minimum value in the set is selected as the sort value, but
this can be customized. Selectors other than the default do have some limitations
(see below) to ensure that all selections happen in constant-time for performance.
<p>
Like sorting by string, this also supports sorting missing values as first or last,
via <a class="xref" href="Lucene.Net.Sandbox.Queries.SortedSetSortField.html#Lucene_Net_Sandbox_Queries_SortedSetSortField_MissingValue">MissingValue</a>.
<p>
Limitations:
<ul><li>
Fields containing <span class="xref">System.Int32.MaxValue</span> or more unique values
are unsupported.
</li><li>
Selectors other than the default <a class="xref" href="Lucene.Net.Sandbox.Queries.Selector.html#Lucene_Net_Sandbox_Queries_Selector_MIN">MIN</a> require
optional codec support. However several codecs provided by Lucene,
including the current default codec, support this.
</li></ul></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"><span class="xref">Lucene.Net.Search.SortField</span></div>
<div class="level2"><span class="xref">SortedSetSortField</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">Lucene.Net.Search.SortField.FIELD_SCORE</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.FIELD_DOC</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.m_missingValue</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.STRING_FIRST</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.STRING_LAST</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.Field</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.Type</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.Parser</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.IsReverse</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.ComparerSource</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.BytesComparer</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.Rewrite(Lucene.Net.Search.IndexSearcher)</span>
</div>
<div>
<span class="xref">Lucene.Net.Search.SortField.NeedsScores</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</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.Sandbox.Queries.html">Lucene.Net.Sandbox.Queries</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Sandbox.dll</h6>
<h5 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class SortedSetSortField : SortField</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_Sandbox_Queries_SortedSetSortField__ctor_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.%23ctor(System.String%2CSystem.Boolean)%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.Sandbox/Queries/SortedSetSortField.cs/#L66">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField__ctor_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.#ctor*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField__ctor_System_String_System_Boolean_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.#ctor(System.String,System.Boolean)">SortedSetSortField(String, Boolean)</h4>
<div class="markdown level1 summary"><p>Creates a sort, possibly in reverse, by the minimum value in the set
for the document.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedSetSortField(string field, bool reverse)</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">field</span></td>
<td><p>Name of field to sort by. Must not be null.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">reverse</span></td>
<td><p>True if natural order should be reversed.</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_Sandbox_Queries_SortedSetSortField__ctor_System_String_System_Boolean_Lucene_Net_Sandbox_Queries_Selector_.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.%23ctor(System.String%2CSystem.Boolean%2CLucene.Net.Sandbox.Queries.Selector)%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.Sandbox/Queries/SortedSetSortField.cs/#L82">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField__ctor_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.#ctor*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField__ctor_System_String_System_Boolean_Lucene_Net_Sandbox_Queries_Selector_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.#ctor(System.String,System.Boolean,Lucene.Net.Sandbox.Queries.Selector)">SortedSetSortField(String, Boolean, Selector)</h4>
<div class="markdown level1 summary"><p>Creates a sort, possibly in reverse, specifying how the sort value from
the document&apos;s set is selected.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public SortedSetSortField(string field, bool reverse, Selector selector)</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">field</span></td>
<td><p>Name of field to sort by. Must not be null.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">reverse</span></td>
<td><p>True if natural order should be reversed.</p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Sandbox.Queries.Selector.html">Selector</a></td>
<td><span class="parametername">selector</span></td>
<td><p>custom selector for choosing the sort value from the set.
<p>
NOTE: selectors other than <a class="xref" href="Lucene.Net.Sandbox.Queries.Selector.html#Lucene_Net_Sandbox_Queries_Selector_MIN">MIN</a> require optional codec support.</p>
</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_Sandbox_Queries_SortedSetSortField_MissingValue.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.MissingValue%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.Sandbox/Queries/SortedSetSortField.cs/#L133">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField_MissingValue_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.MissingValue*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_MissingValue" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.MissingValue">MissingValue</h4>
<div class="markdown level1 summary"><p>Set how missing values (the empty set) are sorted.
<p>
Note that this must be <span class="xref">Lucene.Net.Search.SortField.STRING_FIRST</span> or
<span class="xref">Lucene.Net.Search.SortField.STRING_LAST</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override object MissingValue { get; set; }</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>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.SortField.MissingValue</span></div>
<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_Sandbox_Queries_SortedSetSortField_Selector.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.Selector%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.Sandbox/Queries/SortedSetSortField.cs/#L94">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField_Selector_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.Selector*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_Selector" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.Selector">Selector</h4>
<div class="markdown level1 summary"><p>Returns the selector in use for this sort</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Selector Selector { 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><a class="xref" href="Lucene.Net.Sandbox.Queries.Selector.html">Selector</a></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_Sandbox_Queries_SortedSetSortField_Equals_System_Object_.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.Equals(System.Object)%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.Sandbox/Queries/SortedSetSortField.cs/#L101">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField_Equals_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.Equals*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_Equals_System_Object_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.Equals(System.Object)">Equals(Object)</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 bool Equals(object obj)</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.Object</span></td>
<td><span class="parametername">obj</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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.SortField.html#Lucene_Net_Search_SortField_Equals_System_Object_">SortField.Equals(Object)</a></div>
<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_Sandbox_Queries_SortedSetSortField_GetComparer_System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.GetComparer(System.Int32%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.Sandbox/Queries/SortedSetSortField.cs/#L200">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField_GetComparer_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.GetComparer*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_GetComparer_System_Int32_System_Int32_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.GetComparer(System.Int32,System.Int32)">GetComparer(Int32, Int32)</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 FieldComparer GetComparer(int numHits, int sortPos)</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.Int32</span></td>
<td><span class="parametername">numHits</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">sortPos</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">Lucene.Net.Search.FieldComparer</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="http://localhost:8080/api/core/Lucene.Net.Search.SortField.html#Lucene_Net_Search_SortField_GetComparer_System_Int32_System_Int32_">SortField.GetComparer(Int32, Int32)</a></div>
<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_Sandbox_Queries_SortedSetSortField_GetHashCode.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.GetHashCode%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.Sandbox/Queries/SortedSetSortField.cs/#L96">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField_GetHashCode_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.GetHashCode*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_GetHashCode" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.GetHashCode">GetHashCode()</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 int GetHashCode()</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.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><span class="xref">Lucene.Net.Search.SortField.GetHashCode()</span></div>
<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_Sandbox_Queries_SortedSetSortField_ToString.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField.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.Sandbox/Queries/SortedSetSortField.cs/#L111">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SortedSetSortField_ToString_" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.ToString*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SortedSetSortField_ToString" data-uid="Lucene.Net.Sandbox.Queries.SortedSetSortField.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">Lucene.Net.Search.SortField.ToString()</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_Sandbox_Queries_SortedSetSortField.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SortedSetSortField%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.Sandbox/Queries/SortedSetSortField.cs/#L53" 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>