Class DocumentRecordData

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the document table.

Inheritance
object
DocumentRecordData
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class DocumentRecordData
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Constructors

DocumentRecordData()

POCO (Plain Old CLR Object) class that can be used to hold data corresponding to a row from the document table.

Declaration
public DocumentRecordData()
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Fields

ApplicationId

Application this document was made with

Declaration
public int ApplicationId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

AppointmentId

points back to owning appointment

Declaration
public int AppointmentId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ArchiveProvider

Document plugin id copied from the DocTmpl.autoevent_id - tells us where the document content is stored

Declaration
public int ArchiveProvider
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Attention

Attention/salutation

Declaration
public string Attention
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ContentSetCount

Number of times content has been set on this document.

Declaration
public int ContentSetCount
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

DocumentId

Primary key

Declaration
public int DocumentId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

ExtUrl

For DocPlugin-internal use only. Used to optionally cache URL of external documents.

Declaration
public string ExtUrl
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extref

External reference (notes ID, email ID, URL, whatever) for use by document plugin in locating document content

Declaration
public string Extref
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Header

Visible document name

Declaration
public string Header
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Name

File name

Declaration
public string Name
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

OurRef

Our reference, searchable field from freetext search

Declaration
public string OurRef
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Registered

Registered when in UTC.

Declaration
public DateTime Registered
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

RegisteredAssociateId

Registered by whom

Declaration
public int RegisteredAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Searchname

Searchable name (not used?)

Declaration
public string Searchname
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Snum

The sequence number allocated from refcount on used template when creating the document

Declaration
public int Snum
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

TextId

Pointer to optional long description

Declaration
public int TextId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Updated

Last updated when in UTC.

Declaration
public DateTime Updated
Field Value
Type Description
DateTime
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedAssociateId

Last updated by whom

Declaration
public int UpdatedAssociateId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UpdatedCount

Number of updates made to this record

Declaration
public short UpdatedCount
Field Value
Type Description
short
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Userdef2Id

User-defined fields

Declaration
public int Userdef2Id
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

UserdefId

User-defined fields

Declaration
public int UserdefId
Field Value
Type Description
int
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

YourRef

Your reference

Declaration
public string YourRef
Field Value
Type Description
string
Remarks

Please use this class instead of a full DocumentRow object when you do not need to create or update a value in the database. Row objects have a large overhead since they carry the corresponding DocumentTableInfo object, which in turn defines fields and aliases; there may be a Sentry on a row, and various other helper objects.

Extension Methods