| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DocumentExtensions |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DocumentExtensions |
| | 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.Documents.Extensions.DocumentExtensions"> |
| |
| |
| <h1 id="Lucene_Net_Documents_Extensions_DocumentExtensions" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions" class="text-break">Class DocumentExtensions |
| </h1> |
| <div class="markdown level0 summary"><p>LUCENENET specific extensions to the <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a> class.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">DocumentExtensions</span></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> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Documents.Extensions.html">Lucene.Net.Documents.Extensions</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Documents_Extensions_DocumentExtensions_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static class DocumentExtensions</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_Documents_Extensions_DocumentExtensions_AddBinaryDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddBinaryDocValuesField(Lucene.Net.Documents.Document%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L69">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddBinaryDocValuesField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddBinaryDocValuesField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddBinaryDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddBinaryDocValuesField(Lucene.Net.Documents.Document,System.String,Lucene.Net.Util.BytesRef)">AddBinaryDocValuesField(Document, String, BytesRef)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.BinaryDocValuesField.html">BinaryDocValuesField</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static BinaryDocValuesField AddBinaryDocValuesField(this Document document, string name, BytesRef 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>binary content </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><a class="xref" href="Lucene.Net.Documents.BinaryDocValuesField.html">BinaryDocValuesField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field name is null </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_Documents_Extensions_DocumentExtensions_AddDoubleDocValuesField_Lucene_Net_Documents_Document_System_String_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleDocValuesField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Double)%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/Support/Document/Extensions/DocumentExtensions.cs/#L94">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleDocValuesField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleDocValuesField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleDocValuesField_Lucene_Net_Documents_Document_System_String_System_Double_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleDocValuesField(Lucene.Net.Documents.Document,System.String,System.Double)">AddDoubleDocValuesField(Document, String, Double)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.DoubleDocValuesField.html">DoubleDocValuesField</a> field with the specified 64-bit double value </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DoubleDocValuesField AddDoubleDocValuesField(this Document document, string name, double 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>64-bit double value </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><a class="xref" href="Lucene.Net.Documents.DoubleDocValuesField.html">DoubleDocValuesField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleDocValuesField_Lucene_Net_Documents_Document_System_String_System_Double__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>Syntactic sugar for encoding doubles as <a class="xref" href="Lucene.Net.Index.NumericDocValues.html">NumericDocValues</a> |
| via <span class="xref">J2N.BitConversion.DoubleToRawInt64Bits(System.Double)</span>. |
| <p> |
| Per-document double values can be retrieved via |
| <a class="xref" href="Lucene.Net.Search.IFieldCache.html#Lucene_Net_Search_IFieldCache_GetDoubles_Lucene_Net_Index_AtomicReader_System_String_System_Boolean_">GetDoubles(AtomicReader, String, Boolean)</a>. |
| <p> |
| <strong>NOTE</strong>: In most all cases this will be rather inefficient, |
| requiring eight bytes per document. Consider encoding double |
| values yourself with only as much precision as you require.</p> |
| </div> |
| <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.ArgumentNullException</span></td> |
| <td><p>if the field name is <code>null</code> </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_Documents_Extensions_DocumentExtensions_AddDoubleField_Lucene_Net_Documents_Document_System_String_System_Double_Lucene_Net_Documents_Field_Store_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Double%2CLucene.Net.Documents.Field.Store)%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/Support/Document/Extensions/DocumentExtensions.cs/#L112">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleField_Lucene_Net_Documents_Document_System_String_System_Double_Lucene_Net_Documents_Field_Store_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleField(Lucene.Net.Documents.Document,System.String,System.Double,Lucene.Net.Documents.Field.Store)">AddDoubleField(Document, String, Double, Field.Store)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.DoubleField.html">DoubleField</a> with the provided value |
| and default <code>precisionStep</code> |
| <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DoubleField AddDoubleField(this Document document, string name, double value, Field.Store stored)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>64-bit <span class="xref">System.Double</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.Field.Store.html">Field.Store</a></td> |
| <td><span class="parametername">stored</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Documents.Field.Store.html#Lucene_Net_Documents_Field_Store_YES">YES</a> if the content should also be stored </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><a class="xref" href="Lucene.Net.Documents.DoubleField.html">DoubleField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field name is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddDoubleField_Lucene_Net_Documents_Document_System_String_System_Double_Lucene_Net_Documents_FieldType_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Double%2CLucene.Net.Documents.FieldType)%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/Support/Document/Extensions/DocumentExtensions.cs/#L132">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddDoubleField_Lucene_Net_Documents_Document_System_String_System_Double_Lucene_Net_Documents_FieldType_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddDoubleField(Lucene.Net.Documents.Document,System.String,System.Double,Lucene.Net.Documents.FieldType)">AddDoubleField(Document, String, Double, FieldType)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.DoubleField.html">DoubleField</a> with the provided value. |
| <p> |
| Expert: allows you to customize the <a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DoubleField AddDoubleField(this Document document, string name, double value, FieldType type)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>64-bit double value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>customized field type: must have <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> |
| of <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_DOUBLE">DOUBLE</a>. </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><a class="xref" href="Lucene.Net.Documents.DoubleField.html">DoubleField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field name or type is <code>null</code>, or |
| if the field type does not have a <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_DOUBLE">DOUBLE</a> <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> </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_Documents_Extensions_DocumentExtensions_AddInt32Field_Lucene_Net_Documents_Document_System_String_System_Int32_Lucene_Net_Documents_Field_Store_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt32Field(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Int32%2CLucene.Net.Documents.Field.Store)%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/Support/Document/Extensions/DocumentExtensions.cs/#L202">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt32Field_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt32Field*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt32Field_Lucene_Net_Documents_Document_System_String_System_Int32_Lucene_Net_Documents_Field_Store_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt32Field(Lucene.Net.Documents.Document,System.String,System.Int32,Lucene.Net.Documents.Field.Store)">AddInt32Field(Document, String, Int32, Field.Store)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.Int32Field.html">Int32Field</a> with the provided value |
| and default <code>precisionStep</code> |
| <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Int32Field AddInt32Field(this Document document, string name, int value, Field.Store stored)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>32-bit <span class="xref">System.Int32</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.Field.Store.html">Field.Store</a></td> |
| <td><span class="parametername">stored</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Documents.Field.Store.html#Lucene_Net_Documents_Field_Store_YES">YES</a> if the content should also be stored </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><a class="xref" href="Lucene.Net.Documents.Int32Field.html">Int32Field</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddInt32Field_Lucene_Net_Documents_Document_System_String_System_Int32_Lucene_Net_Documents_FieldType_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt32Field(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Int32%2CLucene.Net.Documents.FieldType)%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/Support/Document/Extensions/DocumentExtensions.cs/#L224">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt32Field_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt32Field*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt32Field_Lucene_Net_Documents_Document_System_String_System_Int32_Lucene_Net_Documents_FieldType_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt32Field(Lucene.Net.Documents.Document,System.String,System.Int32,Lucene.Net.Documents.FieldType)">AddInt32Field(Document, String, Int32, FieldType)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.Int32Field.html">Int32Field</a> with the provided value. |
| <p> |
| Expert: allows you to customize the |
| <a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Int32Field AddInt32Field(this Document document, string name, int value, FieldType type)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>32-bit <span class="xref">System.Int32</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>customized field type: must have <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> |
| of <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_INT32">INT32</a>. </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><a class="xref" href="Lucene.Net.Documents.Int32Field.html">Int32Field</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">type</code> is <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_NONE">NONE</a> </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>if the field type does not have a |
| <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> of <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_INT32">INT32</a> </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_Documents_Extensions_DocumentExtensions_AddInt64Field_Lucene_Net_Documents_Document_System_String_System_Int64_Lucene_Net_Documents_Field_Store_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt64Field(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Int64%2CLucene.Net.Documents.Field.Store)%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/Support/Document/Extensions/DocumentExtensions.cs/#L242">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt64Field_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt64Field*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt64Field_Lucene_Net_Documents_Document_System_String_System_Int64_Lucene_Net_Documents_Field_Store_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt64Field(Lucene.Net.Documents.Document,System.String,System.Int64,Lucene.Net.Documents.Field.Store)">AddInt64Field(Document, String, Int64, Field.Store)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.Int64Field.html">Int64Field</a> with the provided value |
| and default <code>precisionStep</code> |
| <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> (4). </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Int64Field AddInt64Field(this Document document, string name, long value, Field.Store stored)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>64-bit <span class="xref">System.Int64</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.Field.Store.html">Field.Store</a></td> |
| <td><span class="parametername">stored</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Documents.Field.Store.html#Lucene_Net_Documents_Field_Store_YES">YES</a> if the content should also be stored </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><a class="xref" href="Lucene.Net.Documents.Int64Field.html">Int64Field</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddInt64Field_Lucene_Net_Documents_Document_System_String_System_Int64_Lucene_Net_Documents_FieldType_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt64Field(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Int64%2CLucene.Net.Documents.FieldType)%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/Support/Document/Extensions/DocumentExtensions.cs/#L263">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt64Field_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt64Field*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddInt64Field_Lucene_Net_Documents_Document_System_String_System_Int64_Lucene_Net_Documents_FieldType_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddInt64Field(Lucene.Net.Documents.Document,System.String,System.Int64,Lucene.Net.Documents.FieldType)">AddInt64Field(Document, String, Int64, FieldType)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.Int64Field.html">Int64Field</a> with the provided value. |
| <p> |
| Expert: allows you to customize the <a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static Int64Field AddInt64Field(this Document document, string name, long value, FieldType type)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>64-bit <span class="xref">System.Int64</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>customized field type: must have <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> |
| of <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_INT64">INT64</a>. </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><a class="xref" href="Lucene.Net.Documents.Int64Field.html">Int64Field</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">type</code> is <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_NONE">NONE</a> </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>if the field type does not have a |
| <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> of <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_INT64">INT64</a> </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_Documents_Extensions_DocumentExtensions_AddNumericDocValuesField_Lucene_Net_Documents_Document_System_String_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddNumericDocValuesField(Lucene.Net.Documents.Document%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L281">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddNumericDocValuesField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddNumericDocValuesField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddNumericDocValuesField_Lucene_Net_Documents_Document_System_String_System_Int64_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddNumericDocValuesField(Lucene.Net.Documents.Document,System.String,System.Int64)">AddNumericDocValuesField(Document, String, Int64)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.NumericDocValuesField.html">NumericDocValuesField</a> field with the specified 64-bit <span class="xref">System.Int64</span> value </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static NumericDocValuesField AddNumericDocValuesField(this Document document, string name, 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>64-bit <span class="xref">System.Int64</span> value </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><a class="xref" href="Lucene.Net.Documents.NumericDocValuesField.html">NumericDocValuesField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddNumericDocValuesField_Lucene_Net_Documents_Document_System_String_System_Int64__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>If you also need to store the value, you should add a |
| separate <a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a> instance.</p> |
| </div> |
| <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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code> </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_Documents_Extensions_DocumentExtensions_AddSingleDocValuesField_Lucene_Net_Documents_Document_System_String_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleDocValuesField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Single)%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/Support/Document/Extensions/DocumentExtensions.cs/#L146">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSingleDocValuesField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleDocValuesField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSingleDocValuesField_Lucene_Net_Documents_Document_System_String_System_Single_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleDocValuesField(Lucene.Net.Documents.Document,System.String,System.Single)">AddSingleDocValuesField(Document, String, Single)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.SingleDocValuesField.html">SingleDocValuesField</a> field with the specified 32-bit <span class="xref">System.Single</span> value </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static SingleDocValuesField AddSingleDocValuesField(this Document document, string name, float 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>32-bit <span class="xref">System.Single</span> value </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><a class="xref" href="Lucene.Net.Documents.SingleDocValuesField.html">SingleDocValuesField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field name is <code>null</code> </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_Documents_Extensions_DocumentExtensions_AddSingleField_Lucene_Net_Documents_Document_System_String_System_Single_Lucene_Net_Documents_Field_Store_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Single%2CLucene.Net.Documents.Field.Store)%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/Support/Document/Extensions/DocumentExtensions.cs/#L164">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSingleField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSingleField_Lucene_Net_Documents_Document_System_String_System_Single_Lucene_Net_Documents_Field_Store_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleField(Lucene.Net.Documents.Document,System.String,System.Single,Lucene.Net.Documents.Field.Store)">AddSingleField(Document, String, Single, Field.Store)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.SingleField.html">SingleField</a> with the provided value |
| and default <code>precisionStep</code> <a class="xref" href="Lucene.Net.Util.NumericUtils.html#Lucene_Net_Util_NumericUtils_PRECISION_STEP_DEFAULT">PRECISION_STEP_DEFAULT</a> |
| (4).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static SingleField AddSingleField(this Document document, string name, float value, Field.Store stored)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>32-bit <span class="xref">System.Single</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.Field.Store.html">Field.Store</a></td> |
| <td><span class="parametername">stored</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Documents.Field.Store.html#Lucene_Net_Documents_Field_Store_YES">YES</a> if the content should also be stored </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><a class="xref" href="Lucene.Net.Documents.SingleField.html">SingleField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddSingleField_Lucene_Net_Documents_Document_System_String_System_Single_Lucene_Net_Documents_FieldType_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Single%2CLucene.Net.Documents.FieldType)%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/Support/Document/Extensions/DocumentExtensions.cs/#L184">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSingleField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSingleField_Lucene_Net_Documents_Document_System_String_System_Single_Lucene_Net_Documents_FieldType_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSingleField(Lucene.Net.Documents.Document,System.String,System.Single,Lucene.Net.Documents.FieldType)">AddSingleField(Document, String, Single, FieldType)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored or un-stored <a class="xref" href="Lucene.Net.Documents.SingleField.html">SingleField</a> with the provided value. |
| <p> |
| Expert: allows you to customize the <a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static SingleField AddSingleField(this Document document, string name, float value, FieldType type)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p>32-bit <span class="xref">System.Single</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.FieldType.html">FieldType</a></td> |
| <td><span class="parametername">type</span></td> |
| <td><p>customized field type: must have <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a> |
| of <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_SINGLE">SINGLE</a>. </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><a class="xref" href="Lucene.Net.Documents.SingleField.html">SingleField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">type</code> is <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_NONE">NONE</a> </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.ArgumentException</span></td> |
| <td><p>if the field type does not have a <a class="xref" href="Lucene.Net.Documents.NumericType.html#Lucene_Net_Documents_NumericType_SINGLE">SINGLE</a> <a class="xref" href="Lucene.Net.Documents.FieldType.html#Lucene_Net_Documents_FieldType_NumericType">NumericType</a></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_Documents_Extensions_DocumentExtensions_AddSortedDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddSortedDocValuesField(Lucene.Net.Documents.Document%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L299">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSortedDocValuesField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSortedDocValuesField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSortedDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSortedDocValuesField(Lucene.Net.Documents.Document,System.String,Lucene.Net.Util.BytesRef)">AddSortedDocValuesField(Document, String, BytesRef)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.SortedDocValuesField.html">SortedDocValuesField</a> field. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static SortedDocValuesField AddSortedDocValuesField(this Document document, string name, BytesRef bytes)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td> |
| <td><span class="parametername">bytes</span></td> |
| <td><p>binary content </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><a class="xref" href="Lucene.Net.Documents.SortedDocValuesField.html">SortedDocValuesField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSortedDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>If you also need to store the value, you should add a |
| separate <a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a> instance.</p> |
| </div> |
| <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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code> </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_Documents_Extensions_DocumentExtensions_AddSortedSetDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddSortedSetDocValuesField(Lucene.Net.Documents.Document%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L317">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSortedSetDocValuesField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSortedSetDocValuesField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSortedSetDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddSortedSetDocValuesField(Lucene.Net.Documents.Document,System.String,Lucene.Net.Util.BytesRef)">AddSortedSetDocValuesField(Document, String, BytesRef)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.SortedSetDocValuesField.html">SortedSetDocValuesField</a> field. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static SortedSetDocValuesField AddSortedSetDocValuesField(this Document document, string name, BytesRef bytes)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td> |
| <td><span class="parametername">bytes</span></td> |
| <td><p>binary content </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><a class="xref" href="Lucene.Net.Documents.SortedSetDocValuesField.html">SortedSetDocValuesField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddSortedSetDocValuesField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>If you also need to store the value, you should add a |
| separate <a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a> instance.</p> |
| </div> |
| <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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code> </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L370">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,Lucene.Net.Util.BytesRef)">AddStoredField(Document, String, BytesRef)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given binary value. |
| <p>NOTE: the provided <a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a> is not copied so be sure |
| not to change it until you're done with this field.</p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, BytesRef 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a> pointing to binary content (not copied) </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Byte___.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Byte%5B%5D)%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/Support/Document/Extensions/DocumentExtensions.cs/#L334">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Byte___" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.Byte[])">AddStoredField(Document, String, Byte[])</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given binary value. |
| <p>NOTE: the provided <span class="xref">byte[]</span> is not copied so be sure |
| not to change it until you're done with this field.</p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, byte[] 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">value</span></td> |
| <td><p>byte array pointing to binary content (not copied) </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Byte___System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Byte%5B%5D%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L353">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Byte___System_Int32_System_Int32_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.Byte[],System.Int32,System.Int32)">AddStoredField(Document, String, Byte[], Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given binary value. |
| <p>NOTE: the provided <span class="xref">byte[]</span> is not copied so be sure |
| not to change it until you're done with this field.</p></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, byte[] value, int offset, int length)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.Byte</span> array pointing to binary content (not copied) </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">offset</span></td> |
| <td><p>starting position of the byte array </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">length</span></td> |
| <td><p>valid length of the byte array </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Double_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Double)%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/Support/Document/Extensions/DocumentExtensions.cs/#L440">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Double_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.Double)">AddStoredField(Document, String, Double)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given <span class="xref">System.Double</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, double 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Double</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.Double</span> value </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.String%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/Support/Document/Extensions/DocumentExtensions.cs/#L398">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Int32_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.Int32)">AddStoredField(Document, String, Int32)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given <span class="xref">System.Int32</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, int 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.Int32</span> value </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.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/Support/Document/Extensions/DocumentExtensions.cs/#L426">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Int64_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.Int64)">AddStoredField(Document, String, Int64)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given <span class="xref">System.Int64</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int64</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.Int64</span> value </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.Single)%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/Support/Document/Extensions/DocumentExtensions.cs/#L412">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_Single_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.Single)">AddStoredField(Document, String, Single)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given <span class="xref">System.Single</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, float 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.Single</span> value </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Document/Extensions/DocumentExtensions.cs/#L384">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStoredField_Lucene_Net_Documents_Document_System_String_System_String_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStoredField(Lucene.Net.Documents.Document,System.String,System.String)">AddStoredField(Document, String, String)</h4> |
| <div class="markdown level1 summary"><p>Adds a stored-only field with the given <span class="xref">System.String</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StoredField AddStoredField(this Document document, string name, string 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><a class="xref" href="Lucene.Net.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.String</span> value </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><a class="xref" href="Lucene.Net.Documents.StoredField.html">StoredField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddStringField_Lucene_Net_Documents_Document_System_String_System_String_Lucene_Net_Documents_Field_Store_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddStringField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.String%2CLucene.Net.Documents.Field.Store)%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/Support/Document/Extensions/DocumentExtensions.cs/#L456">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStringField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStringField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddStringField_Lucene_Net_Documents_Document_System_String_System_String_Lucene_Net_Documents_Field_Store_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddStringField(Lucene.Net.Documents.Document,System.String,System.String,Lucene.Net.Documents.Field.Store)">AddStringField(Document, String, String, Field.Store)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.StringField.html">StringField</a> (a field that is indexed but not tokenized)</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static StringField AddStringField(this Document document, string name, string value, Field.Store stored)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.String</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.Field.Store.html">Field.Store</a></td> |
| <td><span class="parametername">stored</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Documents.Field.Store.html#Lucene_Net_Documents_Field_Store_YES">YES</a> if the content should also be stored </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><a class="xref" href="Lucene.Net.Documents.StringField.html">StringField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddTextField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Analysis_TokenStream_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField(Lucene.Net.Documents.Document%2CSystem.String%2CLucene.Net.Analysis.TokenStream)%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/Support/Document/Extensions/DocumentExtensions.cs/#L499">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddTextField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddTextField_Lucene_Net_Documents_Document_System_String_Lucene_Net_Analysis_TokenStream_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField(Lucene.Net.Documents.Document,System.String,Lucene.Net.Analysis.TokenStream)">AddTextField(Document, String, TokenStream)</h4> |
| <div class="markdown level1 summary"><p>Adds a new un-stored <a class="xref" href="Lucene.Net.Documents.TextField.html">TextField</a> with <a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TextField AddTextField(this Document document, string name, TokenStream stream)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a></td> |
| <td><span class="parametername">stream</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Analysis.TokenStream.html">TokenStream</a> value </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><a class="xref" href="Lucene.Net.Documents.TextField.html">TextField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">stream</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_AddTextField_Lucene_Net_Documents_Document_System_String_System_IO_TextReader_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.IO.TextReader)%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/Support/Document/Extensions/DocumentExtensions.cs/#L470">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddTextField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddTextField_Lucene_Net_Documents_Document_System_String_System_IO_TextReader_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField(Lucene.Net.Documents.Document,System.String,System.IO.TextReader)">AddTextField(Document, String, TextReader)</h4> |
| <div class="markdown level1 summary"><p>Adds a new un-stored <a class="xref" href="Lucene.Net.Documents.TextField.html">TextField</a> with <span class="xref">System.IO.TextReader</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TextField AddTextField(this Document document, string name, TextReader reader)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td><span class="parametername">reader</span></td> |
| <td><p><span class="xref">System.IO.TextReader</span> value </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><a class="xref" href="Lucene.Net.Documents.TextField.html">TextField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">reader</code> is <code>null</code> </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_Documents_Extensions_DocumentExtensions_AddTextField_Lucene_Net_Documents_Document_System_String_System_String_Lucene_Net_Documents_Field_Store_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField(Lucene.Net.Documents.Document%2CSystem.String%2CSystem.String%2CLucene.Net.Documents.Field.Store)%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/Support/Document/Extensions/DocumentExtensions.cs/#L485">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddTextField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_AddTextField_Lucene_Net_Documents_Document_System_String_System_String_Lucene_Net_Documents_Field_Store_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.AddTextField(Lucene.Net.Documents.Document,System.String,System.String,Lucene.Net.Documents.Field.Store)">AddTextField(Document, String, String, Field.Store)</h4> |
| <div class="markdown level1 summary"><p>Adds a new <a class="xref" href="Lucene.Net.Documents.TextField.html">TextField</a> with <span class="xref">System.String</span> value. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static TextField AddTextField(this Document document, string name, string value, Field.Store stored)</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>field name </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">value</span></td> |
| <td><p><span class="xref">System.String</span> value </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Documents.Field.Store.html">Field.Store</a></td> |
| <td><span class="parametername">stored</span></td> |
| <td><p><a class="xref" href="Lucene.Net.Documents.Field.Store.html#Lucene_Net_Documents_Field_Store_YES">YES</a> if the content should also be stored </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><a class="xref" href="Lucene.Net.Documents.TextField.html">TextField</a></td> |
| <td><p>The field that was added to this <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</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.ArgumentNullException</span></td> |
| <td><p>if the field <code data-dev-comment-type="paramref" class="paramref">name</code> or <code data-dev-comment-type="paramref" class="paramref">value</code> is <code>null</code>. </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_Documents_Extensions_DocumentExtensions_GetField__1_Lucene_Net_Documents_Document_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.GetField%60%601(Lucene.Net.Documents.Document%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Document/Extensions/DocumentExtensions.cs/#L39">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_GetField_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.GetField*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_GetField__1_Lucene_Net_Documents_Document_System_String_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.GetField``1(Lucene.Net.Documents.Document,System.String)">GetField<T>(Document, String)</h4> |
| <div class="markdown level1 summary"><p>Returns a field with the given name if any exist in this document cast to type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>, or |
| <code>null</code>. If multiple fields exists with this name, this method returns the |
| first value added.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static T GetField<T>(this Document document, string name) |
| where T : IIndexableField</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>Field name</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">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></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.InvalidCastException</span></td> |
| <td><p>If the field type cannot be cast to <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>.</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_Documents_Extensions_DocumentExtensions_GetFields__1_Lucene_Net_Documents_Document_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions.GetFields%60%601(Lucene.Net.Documents.Document%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Support/Document/Extensions/DocumentExtensions.cs/#L53">View Source</a> |
| </span> |
| <a id="Lucene_Net_Documents_Extensions_DocumentExtensions_GetFields_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.GetFields*"></a> |
| <h4 id="Lucene_Net_Documents_Extensions_DocumentExtensions_GetFields__1_Lucene_Net_Documents_Document_System_String_" data-uid="Lucene.Net.Documents.Extensions.DocumentExtensions.GetFields``1(Lucene.Net.Documents.Document,System.String)">GetFields<T>(Document, String)</h4> |
| <div class="markdown level1 summary"><p>Returns an array of <a class="xref" href="Lucene.Net.Index.IIndexableField.html">IIndexableField</a>s with the given name, cast to type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>. |
| This method returns an empty array when there are no |
| matching fields. It never returns <code>null</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 T[] GetFields<T>(this Document document, string name) |
| where T : IIndexableField</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.Documents.Document.html">Document</a></td> |
| <td><span class="parametername">document</span></td> |
| <td><p>This <a class="xref" href="Lucene.Net.Documents.Document.html">Document</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">name</span></td> |
| <td><p>the name of the field </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>T[]</td> |
| <td><p>a <span class="xref">IndexableField[]</span> array </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></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.InvalidCastException</span></td> |
| <td><p>If the field type cannot be cast to <typeparam name="T"></typeparam>.</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_Documents_Extensions_DocumentExtensions.md&value=---%0Auid%3A%20Lucene.Net.Documents.Extensions.DocumentExtensions%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/Support/Document/Extensions/DocumentExtensions.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> |
