Class Document

Represents an unparsed document (a file on the filesystem, byte[] from a database, etc)

Inheritance

System.Object

Document

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)

System.Object.ToString()

Namespace: Textkernel.Tx.Models

Assembly: Textkernel.Tx.SDK.dll

Syntax

public class Document

Constructors

Document(Byte[], DateTime)

Create a Document from a file byte[]

Declaration

public Document(byte[] fileBytes, DateTime lastModified)

Parameters

Type	Name	Description
System.Byte[]	fileBytes	The file byte array
System.DateTime	lastModified	The last-revised date for this file. This is extremely important so that the Parser knows how to interpret dates in the document that are expressed as "current" or "as of" (or similar) to correctly calculate date spans

Document(String)

Create a Document from a file on the filesystem.
NOTE: this will automatically set the LastModified using System.IO.File.GetLastWriteTime(System.String).
If your files do not have an accurate 'LastWrite' or 'LastModified' time, you must use a different constructor

Declaration

public Document(string path)

Parameters

Type	Name	Description
System.String	path

Properties

AsBase64

The base-64 encoded byte[] for this file. This is what is sent over HTTPS to the API

Declaration

public string AsBase64 { get; protected set; }

Property Value

Type	Description
System.String

LastModified

The last revised/modified date for this file.

Declaration

public DateTime LastModified { get; protected set; }

Property Value

Type	Description
System.DateTime