Class Document

Class to represent a document

Inheritance

System.Object

Document

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Simplic.Document

Assembly: Simplic.Document.dll

Syntax

public class Document

Constructors

Document()

Initializes a new instance of type Document

Declaration

public Document()

Properties

Barcode

Gets or sets the barcode

Declaration

public string Barcode { get; set; }

Property Value

Type	Description
System.String

BeginEdit

Gets or sets the begin edit date and time

Declaration

public DateTime BeginEdit { get; set; }

Property Value

Type	Description
System.DateTime

BlobGuid

Gets or sets the blob guid

Declaration

public Guid BlobGuid { get; set; }

Property Value

Type	Description
System.Guid

CreateDate

Gets or sets the create date

Declaration

public DateTime CreateDate { get; set; }

Property Value

Type	Description
System.DateTime

CreateDateTime

Gets or sets the create date time

Declaration

public DateTime CreateDateTime { get; set; }

Property Value

Type	Description
System.DateTime

CreateUserName

Gets or sets the create user name

Declaration

public string CreateUserName { get; set; }

Property Value

Type	Description
System.String

Description

Gets or sets the description

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String

DocTypeId

Gets or sets the doc type id

Declaration

public Guid DocTypeId { get; set; }

Property Value

Type	Description
System.Guid

DocumentDate

Gets or sets the document date

Declaration

public DateTime DocumentDate { get; set; }

Property Value

Type	Description
System.DateTime

DocumentId

Gets or sets the document id

Declaration

public long DocumentId { get; set; }

Property Value

Type	Description
System.Int64

DocumentSource

Gets or sets the document source.

Declaration

public string DocumentSource { get; set; }

Property Value

Type	Description
System.String

DocumentTime

Gets or sets the document title

Declaration

public TimeSpan DocumentTime { get; set; }

Property Value

Type	Description
System.TimeSpan

EditFilePath

Gets or sets the edit file path

Declaration

public string EditFilePath { get; set; }

Property Value

Type	Description
System.String

EditUserId

Gets or sets the edit userid

Declaration

public int? EditUserId { get; set; }

Property Value

Type	Description
System.Nullable<System.Int32>

FileExtension

Gets or sets the file extension

Declaration

public string FileExtension { get; set; }

Property Value

Type	Description
System.String

FileName

Gets oe sets the file name

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String

Guid

Gets or sets the guid

Declaration

public Guid Guid { get; set; }

Property Value

Type	Description
System.Guid

IsDeleted

Gets or sets wherther the document is deleted

Declaration

public bool IsDeleted { get; set; }

Property Value

Type	Description
System.Boolean

IsInEditMode

Gets or sets the mode

Declaration

public bool IsInEditMode { get; }

Property Value

Type	Description
System.Boolean

LatestVersion

Gets the latest document version

Declaration

public DocumentVersion LatestVersion { get; }

Property Value

Type	Description
DocumentVersion

MimeType

Gets or sets the mime type

Declaration

public string MimeType { get; set; }

Property Value

Type	Description
System.String

ReferenceNumber

gets or sts the reference number

Declaration

public string ReferenceNumber { get; set; }

Property Value

Type	Description
System.String

ReleasedDocumentChanged

Gets or sets wherther the released document has changed

Declaration

public bool ReleasedDocumentChanged { get; set; }

Property Value

Type	Description
System.Boolean

ReleasedVersion

Gets or sets the released version

Declaration

public DocumentVersion ReleasedVersion { get; set; }

Property Value

Type	Description
DocumentVersion

TenantId

Gets or sets the tenant id

Declaration

public Guid TenantId { get; set; }

Property Value

Type	Description
System.Guid

UpdateDateTime

Gets or sets the update date time

Declaration

public DateTime UpdateDateTime { get; set; }

Property Value

Type	Description
System.DateTime

UpdateUserName

Gets or sets the update user name

Declaration

public string UpdateUserName { get; set; }

Property Value

Type	Description
System.String

Versions

Gets or sets the versions

Declaration

public StatefulCollection<DocumentVersion> Versions { get; protected set; }

Property Value

Type	Description
StatefulCollection<DocumentVersion>

Methods

AddVersion(DocumentVersion)

Add new version to document

Declaration

public void AddVersion(DocumentVersion version)

Parameters

Type	Name	Description
DocumentVersion	version	Document version instance

CommitChanges(DocumentVersion, Boolean)

Commits the given version and can release it

Declaration

public void CommitChanges(DocumentVersion version, bool releaseVersion)

Parameters

Type	Name	Description
DocumentVersion	version
System.Boolean	releaseVersion	True if the new version should ve released

GetCurrentBlob()

Gets the current blob

Declaration

public byte[] GetCurrentBlob()

Returns

Type	Description
System.Byte[]

LoadVersions()

Loads all document versions

Declaration

public StatefulCollection<DocumentVersion> LoadVersions()

Returns

Type	Description
StatefulCollection<DocumentVersion>

ReleaseVersion(DocumentVersion)

Release document version

Declaration

public void ReleaseVersion(DocumentVersion version)

Parameters

Type	Name	Description
DocumentVersion	version	Version to release