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
object
Field
TextField
Inherited Members
Namespace: Lucene.Net.Documents
Assembly: Lucene.Net.dll
Syntax
public sealed class TextField : Field, IIndexableField, IFormattable

Constructors

TextField(string, TokenStream)

Creates a new un-stored TextField with TokenStream value.

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

field name
TokenStream stream

TokenStream value
Exceptions
Type Condition
ArgumentNullException

if the field name or stream is null.

TextField(string, TextReader)

Creates a new un-stored TextField with TextReader value.

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

field name
TextReader reader

TextReader value
Exceptions
Type Condition
ArgumentNullException

if the field name or reader is null

TextField(string, string, Store)

Creates a new TextField with string value.

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

field name
string value

string value
Field.Store store

YES if the content should also be stored
Exceptions
Type Condition
ArgumentNullException

if the field name or value is null.

Fields

TYPE_NOT_STORED

Indexed, tokenized, not stored.

Declaration
public static readonly FieldType TYPE_NOT_STORED
Field Value
Type Description
FieldType

TYPE_STORED

Indexed, tokenized, stored.

Declaration
public static readonly FieldType TYPE_STORED
Field Value
Type Description
FieldType

Implements

Extension Methods