Class TextField

A field that is indexed and tokenized, without term vectors. For example this would be used on a 'body' field, that contains the bulk of a document's text.

Inheritance
System.Object
Field
TextField
Implements
System.IFormattable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public sealed class TextField : Field, IIndexableField, IFormattable

Constructors

| Improve this Doc View Source

TextField(String, TokenStream)

Creates a new un-stored TextField with TokenStream value.

Declaration
public TextField(string name, TokenStream stream)
Parameters
Type Name Description
System.String name

field name

TokenStream stream

TokenStream value

Exceptions
Type Condition
System.ArgumentNullException

if the field name or stream is null.

| Improve this Doc View Source

TextField(String, TextReader)

Creates a new un-stored TextField with System.IO.TextReader value.

Declaration
public TextField(string name, TextReader reader)
Parameters
Type Name Description
System.String name

field name

System.IO.TextReader reader

System.IO.TextReader value

Exceptions
Type Condition
System.ArgumentNullException

if the field name or reader is null

| Improve this Doc View Source

TextField(String, String, Field.Store)

Creates a new TextField with System.String value.

Declaration
public TextField(string name, string value, Field.Store store)
Parameters
Type Name Description
System.String name

field name

System.String value

System.String value

Field.Store store

YES if the content should also be stored

Exceptions
Type Condition
System.ArgumentNullException

if the field name or value is null.

Fields

| Improve this Doc View Source

TYPE_NOT_STORED

Indexed, tokenized, not stored.

Declaration
public static readonly FieldType TYPE_NOT_STORED
Field Value
Type Description
FieldType
| Improve this Doc View Source

TYPE_STORED

Indexed, tokenized, stored.

Declaration
public static readonly FieldType TYPE_STORED
Field Value
Type Description
FieldType

Implements

System.IFormattable

Extension Methods