Keyoti SearchUnit API Docs
Document Class
API DocumentationKeyoti.SearchEngine.DocumentsDocument
Keyoti SearchUnit v6
Represents an indexed document.
Declaration Syntax
C#Visual Basic
[SerializableAttribute]
public class Document
<SerializableAttribute>
Public Class Document
Members
All MembersConstructorsMethodsPropertiesFields



IconMemberDescription
Document(DocumentRecord, Configuration)
Creates a new Document.

Document(String, Configuration)
Creates a new Document.

CalculateWordRelevancies(WordCollection)
Calculate the weight field value for the words in the list.

CalculateWordsRelevancy(ArrayList) Obsolete.
Calculate the weight field value for the words in the list.

Configuration
The instance of the Configuration class that holds the settings to be used.

ContentCategories
The content categories of type ContentCategoryRecord that this document belongs to.

CustomData
Any custom data that should be stored for the document.

Description
Description of the document, if specified.

Dispose()()()()
Removes all references held by this object.

DocumentId
The ID of the document in the data layer.

DocumentRecord
The DocumentRecord instance that stores the data.

DontIndex
Whether to ignore the document during index creation.

Encoding
The document's character encoding.

Equals(Object)
Determines if documents are equal
(Overrides Object.Equals(Object).)
FileType Obsolete.
The mime-type for the document.

Finalize()()()()
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
GetFileType()()()()
The mime-type for the document.

GetHashCode()()()()
Gets the hashcode for the document, based on it's DocumentRecord.
(Overrides Object.GetHashCode()()()().)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
InBodyCoefficient
Coefficient used for weighting words found in the document body.

IndexableSourceId
The ID of the indexable source this belongs to, or -1 if none.

InTitleCoefficient
Coefficient used for weighting words found in the document title.

InUrlCoefficient
Coefficient used for weighting words found in the document Uri.

IsDocumentChanged()()()()
Whether the document can be identified to have changed between the last time it was indexed and when LoadResponseStream was called.

IsIndexed()()()()
Whether this document has been indexed.

LastDateIndexed
The date the document was last indexed.

LastModifiedDate
The LastModifiedDate for the document.

LastResponseStatusCode
The URI provided with the last server response, HttpStatusCode.Unused if not available.

LastResponseUri
The URI provided with the last server response, null if not available.

LocationCategory
The location category that this document belongs to.

LoginPage
Whether this page is a 'login page' (for Forms Authentication).

MemberwiseClone()()()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Parser
The Parser instance used to parse words from the remote document.

ParserProvider
The ParserProvider to use to obtain the correct parser to parse the document.

Reader
The Reader instance used to read the document and links from the remote document.

ReadLinks()()()()
Retrieves a list of links, calling ReadLinks() from the Parser property

ReadText()()()()
Retrieves the document's words as an ArrayList, and title if available.

SecurityGroups
The securityGroup category that this document belongs to.

stream
The document stream.

Title
The title of the document.

ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
Uri
The document's Uri (URL).

Inheritance Hierarchy

Assembly: Keyoti4.SearchEngine.Core (Module: Keyoti4.SearchEngine.Core.dll) Version: 2022.8.22.610