blob: 54b4d29a790236952cec074e0761dc9ee2b18ca8 [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 TermRangeFilter
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class TermRangeFilter
| 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="core/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.TermRangeFilter">
<h1 id="Lucene_Net_Search_TermRangeFilter" data-uid="Lucene.Net.Search.TermRangeFilter" class="text-break">Class TermRangeFilter
</h1>
<div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Search.Filter.html">Filter</a> that restricts search results to a range of term
values in a given field.</p>
<p><p>This filter matches the documents looking for terms that fall into the
supplied range according to
<span class="xref">System.Byte.CompareTo(System.Byte)</span>, It is not intended
for numerical ranges; use <a class="xref" href="Lucene.Net.Search.NumericRangeFilter.html">NumericRangeFilter</a> instead.</p>
<p><p>If you construct a large number of range filters with different ranges but on the
same field, <a class="xref" href="Lucene.Net.Search.FieldCacheRangeFilter.html">FieldCacheRangeFilter</a> may have significantly better performance.
<p>
@since 2.9</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.Filter.html">Filter</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html">MultiTermQueryWrapperFilter</a>&lt;<a class="xref" href="Lucene.Net.Search.TermRangeQuery.html">TermRangeQuery</a>&gt;</div>
<div class="level3"><span class="xref">TermRangeFilter</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html#Lucene_Net_Search_MultiTermQueryWrapperFilter_1_m_query">MultiTermQueryWrapperFilter&lt;TermRangeQuery&gt;.m_query</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html#Lucene_Net_Search_MultiTermQueryWrapperFilter_1_ToString">MultiTermQueryWrapperFilter&lt;TermRangeQuery&gt;.ToString()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html#Lucene_Net_Search_MultiTermQueryWrapperFilter_1_Equals_System_Object_">MultiTermQueryWrapperFilter&lt;TermRangeQuery&gt;.Equals(Object)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html#Lucene_Net_Search_MultiTermQueryWrapperFilter_1_GetHashCode">MultiTermQueryWrapperFilter&lt;TermRangeQuery&gt;.GetHashCode()</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html#Lucene_Net_Search_MultiTermQueryWrapperFilter_1_Field">MultiTermQueryWrapperFilter&lt;TermRangeQuery&gt;.Field</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.MultiTermQueryWrapperFilter-1.html#Lucene_Net_Search_MultiTermQueryWrapperFilter_1_GetDocIdSet_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_">MultiTermQueryWrapperFilter&lt;TermRangeQuery&gt;.GetDocIdSet(AtomicReaderContext, IBits)</a>
</div>
<div>
<a class="xref" href="Lucene.Net.Search.Filter.html#Lucene_Net_Search_Filter_NewAnonymous_System_Func_Lucene_Net_Index_AtomicReaderContext_Lucene_Net_Util_IBits_Lucene_Net_Search_DocIdSet__">Filter.NewAnonymous(Func&lt;AtomicReaderContext, IBits, DocIdSet&gt;)</a>
</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.Search.html">Lucene.Net.Search</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Search_TermRangeFilter_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class TermRangeFilter : MultiTermQueryWrapperFilter&lt;TermRangeQuery&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_TermRangeFilter__ctor_System_String_Lucene_Net_Util_BytesRef_Lucene_Net_Util_BytesRef_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.%23ctor(System.String%2CLucene.Net.Util.BytesRef%2CLucene.Net.Util.BytesRef%2CSystem.Boolean%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/Search/TermRangeFilter.cs/#L48">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter__ctor_" data-uid="Lucene.Net.Search.TermRangeFilter.#ctor*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter__ctor_System_String_Lucene_Net_Util_BytesRef_Lucene_Net_Util_BytesRef_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.TermRangeFilter.#ctor(System.String,Lucene.Net.Util.BytesRef,Lucene.Net.Util.BytesRef,System.Boolean,System.Boolean)">TermRangeFilter(String, BytesRef, BytesRef, Boolean, Boolean)</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 TermRangeFilter(string fieldName, BytesRef lowerTerm, BytesRef upperTerm, bool includeLower, bool includeUpper)</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">fieldName</span></td>
<td><p>The field this range applies to </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">lowerTerm</span></td>
<td><p>The lower bound on this range </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">upperTerm</span></td>
<td><p>The upper bound on this range </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">includeLower</span></td>
<td><p>Does this range include the lower bound? </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">includeUpper</span></td>
<td><p>Does this range include the upper bound? </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.ArgumentException</span></td>
<td><p>if both terms are <code>null</code> or if
lowerTerm is <code>null</code> and includeLower is <code>true</code> (similar for upperTerm
and includeUpper) </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_Search_TermRangeFilter_IncludesLower.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.IncludesLower%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/Search/TermRangeFilter.cs/#L91">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_IncludesLower_" data-uid="Lucene.Net.Search.TermRangeFilter.IncludesLower*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_IncludesLower" data-uid="Lucene.Net.Search.TermRangeFilter.IncludesLower">IncludesLower</h4>
<div class="markdown level1 summary"><p>Returns <code>true</code> if the lower endpoint is inclusive </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool IncludesLower { 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.Boolean</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_TermRangeFilter_IncludesUpper.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.IncludesUpper%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/Search/TermRangeFilter.cs/#L95">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_IncludesUpper_" data-uid="Lucene.Net.Search.TermRangeFilter.IncludesUpper*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_IncludesUpper" data-uid="Lucene.Net.Search.TermRangeFilter.IncludesUpper">IncludesUpper</h4>
<div class="markdown level1 summary"><p>Returns <code>true</code> if the upper endpoint is inclusive </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool IncludesUpper { 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.Boolean</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_TermRangeFilter_LowerTerm.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.LowerTerm%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/Search/TermRangeFilter.cs/#L83">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_LowerTerm_" data-uid="Lucene.Net.Search.TermRangeFilter.LowerTerm*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_LowerTerm" data-uid="Lucene.Net.Search.TermRangeFilter.LowerTerm">LowerTerm</h4>
<div class="markdown level1 summary"><p>Returns the lower value of this range filter </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual BytesRef LowerTerm { 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.Util.BytesRef.html">BytesRef</a></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_TermRangeFilter_UpperTerm.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.UpperTerm%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/Search/TermRangeFilter.cs/#L87">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_UpperTerm_" data-uid="Lucene.Net.Search.TermRangeFilter.UpperTerm*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_UpperTerm" data-uid="Lucene.Net.Search.TermRangeFilter.UpperTerm">UpperTerm</h4>
<div class="markdown level1 summary"><p>Returns the upper value of this range filter </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual BytesRef UpperTerm { 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.Util.BytesRef.html">BytesRef</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_Search_TermRangeFilter_Less_System_String_Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.Less(System.String%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/Search/TermRangeFilter.cs/#L67">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_Less_" data-uid="Lucene.Net.Search.TermRangeFilter.Less*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_Less_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Search.TermRangeFilter.Less(System.String,Lucene.Net.Util.BytesRef)">Less(String, BytesRef)</h4>
<div class="markdown level1 summary"><p>Constructs a filter for field <code data-dev-comment-type="paramref" class="paramref">fieldName</code> matching
less than or equal to <code data-dev-comment-type="paramref" class="paramref">upperTerm</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static TermRangeFilter Less(string fieldName, BytesRef upperTerm)</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">fieldName</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">upperTerm</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><a class="xref" href="Lucene.Net.Search.TermRangeFilter.html">TermRangeFilter</a></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_TermRangeFilter_More_System_String_Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.More(System.String%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/Search/TermRangeFilter.cs/#L76">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_More_" data-uid="Lucene.Net.Search.TermRangeFilter.More*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_More_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Search.TermRangeFilter.More(System.String,Lucene.Net.Util.BytesRef)">More(String, BytesRef)</h4>
<div class="markdown level1 summary"><p>Constructs a filter for field <code data-dev-comment-type="paramref" class="paramref">fieldName</code> matching
greater than or equal to <code data-dev-comment-type="paramref" class="paramref">lowerTerm</code>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static TermRangeFilter More(string fieldName, BytesRef lowerTerm)</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">fieldName</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">lowerTerm</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><a class="xref" href="Lucene.Net.Search.TermRangeFilter.html">TermRangeFilter</a></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_TermRangeFilter_NewStringRange_System_String_System_String_System_String_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter.NewStringRange(System.String%2CSystem.String%2CSystem.String%2CSystem.Boolean%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/Search/TermRangeFilter.cs/#L56">View Source</a>
</span>
<a id="Lucene_Net_Search_TermRangeFilter_NewStringRange_" data-uid="Lucene.Net.Search.TermRangeFilter.NewStringRange*"></a>
<h4 id="Lucene_Net_Search_TermRangeFilter_NewStringRange_System_String_System_String_System_String_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Search.TermRangeFilter.NewStringRange(System.String,System.String,System.String,System.Boolean,System.Boolean)">NewStringRange(String, String, String, Boolean, Boolean)</h4>
<div class="markdown level1 summary"><p>Factory that creates a new <a class="xref" href="Lucene.Net.Search.TermRangeFilter.html">TermRangeFilter</a> using <span class="xref">System.String</span>s for term text.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static TermRangeFilter NewStringRange(string field, string lowerTerm, string upperTerm, bool includeLower, bool includeUpper)</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></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">lowerTerm</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">upperTerm</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">includeLower</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">includeUpper</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><a class="xref" href="Lucene.Net.Search.TermRangeFilter.html">TermRangeFilter</a></td>
<td></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_TermRangeFilter.md&amp;value=---%0Auid%3A%20Lucene.Net.Search.TermRangeFilter%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/Search/TermRangeFilter.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>