Class DocumentTableInfo

Table 'document': Documents, this table is an extension of the Appointment table. There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record and a record in VisibleFor specifying who may see this.

Inheritance

Object

TableInfo

DocumentTableInfo

Implements

ICloneable

Inherited Members

TableInfo.ToString()

TableInfo.RegisterFields(FieldInfo[])

TableInfo.FieldInfoFromSoField(SoField)

TableInfo.Clone()

TableInfo.IsSameTable(TableInfo)

TableInfo.FindField(String)

TableInfo.ProtAll

TableInfo.HashCheckFields

TableInfo.TableName

TableInfo.DbName

TableInfo.IsDictionaryTable

TableInfo.All

TableInfo.Item[String]

TableInfo.PrimaryKeyField

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Data

Assembly: SoDataBase.dll

Syntax

[DatabaseTable("document")]
public class DocumentTableInfo : TableInfo, ICloneable

Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling .

Fields

DictionaryTableName

Conceptual name of table Document in the database dictionary: document

Declaration

public const string DictionaryTableName = "document"

Field Value

Type	Description
String

Properties

ApplicationId

Field 'application_id' in table 'document': Dictionary type FK, .NET type: Int32

Application this document was made with

Declaration

public Int32FieldInfo ApplicationId { get; }

Property Value

Type	Description
Int32FieldInfo

ApplicationId_InnerJoin_ExtApp

Generated join from the foreign key ApplicationId in this table, to its target table ExtAppTableInfo.

Declaration

public TargetedInnerJoin<ExtAppTableInfo> ApplicationId_InnerJoin_ExtApp { get; }

Property Value

Type	Description
TargetedInnerJoin<ExtAppTableInfo>

AppointmentId

Field 'appointment_id' in table 'document': Dictionary type FK, .NET type: Int32

points back to owning appointment

Declaration

public Int32FieldInfo AppointmentId { get; }

Property Value

Type	Description
Int32FieldInfo

AppointmentId_InnerJoin_Appointment

Generated join from the foreign key AppointmentId in this table, to its target table AppointmentTableInfo.

Declaration

public TargetedInnerJoin<AppointmentTableInfo> AppointmentId_InnerJoin_Appointment { get; }

Property Value

Type	Description
TargetedInnerJoin<AppointmentTableInfo>

ArchiveProvider

Field 'archiveProvider' in table 'document': Dictionary type Id, .NET type: Int32

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

Declaration

public Int32FieldInfo ArchiveProvider { get; }

Property Value

Type	Description
Int32FieldInfo

Attention

Field 'attention' in table 'document': Dictionary type String[100], .NET type: String

Attention/salutation

Declaration

public StringFieldInfo Attention { get; }

Property Value

Type	Description
StringFieldInfo

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration

public override SoTable Definition { get; }

Property Value

Type	Description
SoTable

Overrides

TableInfo.Definition

DictionaryTableNumber

Table number for table Document in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration

public int DictionaryTableNumber { get; }

Property Value

Type	Description
Int32

DocumentId

Field 'document_id' in table 'document': Dictionary type PK, .NET type: Int32

Primary key

Declaration

public Int32FieldInfo DocumentId { get; }

Property Value

Type	Description
Int32FieldInfo

Extref

Field 'extref' in table 'document': Dictionary type String[512], .NET type: String

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

Declaration

public StringFieldInfo Extref { get; }

Property Value

Type	Description
StringFieldInfo

ExtUrl

Field 'ExtUrl' in table 'document': Dictionary type String[1024], .NET type: String

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

Declaration

public StringFieldInfo ExtUrl { get; }

Property Value

Type	Description
StringFieldInfo

Header

Field 'header' in table 'document': Dictionary type String[220], .NET type: String

Visible document name

Declaration

public StringFieldInfo Header { get; }

Property Value

Type	Description
StringFieldInfo

LeftOuterJoin_Appointment_DocumentId

Generated left outer join from the primary key DocumentId on this table, to Appointment.DocumentId.

Declaration

public TargetedLeftOuterJoin<AppointmentTableInfo> LeftOuterJoin_Appointment_DocumentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<AppointmentTableInfo>

LeftOuterJoin_EmailItem_DocumentId

Generated left outer join from the primary key DocumentId on this table, to EmailItem.DocumentId.

Declaration

public TargetedLeftOuterJoin<EmailItemTableInfo> LeftOuterJoin_EmailItem_DocumentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<EmailItemTableInfo>

LeftOuterJoin_Quote_DocumentId

Generated left outer join from the primary key DocumentId on this table, to Quote.DocumentId.

Declaration

public TargetedLeftOuterJoin<QuoteTableInfo> LeftOuterJoin_Quote_DocumentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<QuoteTableInfo>

LeftOuterJoin_QuoteVersionAttachment_DocumentId

Generated left outer join from the primary key DocumentId on this table, to QuoteVersionAttachment.DocumentId.

Declaration

public TargetedLeftOuterJoin<QuoteVersionAttachmentTableInfo> LeftOuterJoin_QuoteVersionAttachment_DocumentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<QuoteVersionAttachmentTableInfo>

LeftOuterJoin_SaleTypeQuoteAttachment_DocumentId

Generated left outer join from the primary key DocumentId on this table, to SaleTypeQuoteAttachment.DocumentId.

Declaration

public TargetedLeftOuterJoin<SaleTypeQuoteAttachmentTableInfo> LeftOuterJoin_SaleTypeQuoteAttachment_DocumentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SaleTypeQuoteAttachmentTableInfo>

LeftOuterJoin_SMessage_DocumentMessage

Generated left outer join from the primary key DocumentId on this table, to SMessage.DocumentMessage.

Declaration

public TargetedLeftOuterJoin<SMessageTableInfo> LeftOuterJoin_SMessage_DocumentMessage { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SMessageTableInfo>

LeftOuterJoin_SShipment_GeneratedDocumentId

Generated left outer join from the primary key DocumentId on this table, to SShipment.GeneratedDocumentId.

Declaration

public TargetedLeftOuterJoin<SShipmentTableInfo> LeftOuterJoin_SShipment_GeneratedDocumentId { get; }

Property Value

Type	Description
TargetedLeftOuterJoin<SShipmentTableInfo>

Name

Field 'name' in table 'document': Dictionary type String[512], .NET type: String

File name

Declaration

public StringFieldInfo Name { get; }

Property Value

Type	Description
StringFieldInfo

OurRef

Field 'our_ref' in table 'document': Dictionary type String[100], .NET type: String

Our reference, searchable field from freetext search

Declaration

public StringFieldInfo OurRef { get; }

Property Value

Type	Description
StringFieldInfo

Registered

Field 'registered' in table 'document': Dictionary type UtcDateTime, .NET type: DateTime

Registered when

Declaration

public DateTimeFieldInfo Registered { get; }

Property Value

Type	Description
DateTimeFieldInfo

RegisteredAssociateId

Field 'registered_associate_id' in table 'document': Dictionary type FK, .NET type: Int32

Registered by whom

Declaration

public Int32FieldInfo RegisteredAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

RegisteredAssociateId_InnerJoin_Associate

Generated join from the foreign key RegisteredAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> RegisteredAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration

[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }

Property Value

Type	Description
SoTable

Searchname

Field 'searchname' in table 'document': Dictionary type String[100], .NET type: String

Searchable name (not used?)

Declaration

public StringFieldInfo Searchname { get; }

Property Value

Type	Description
StringFieldInfo

Snum

Field 'snum' in table 'document': Dictionary type Int, .NET type: Int32

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

Declaration

public Int32FieldInfo Snum { get; }

Property Value

Type	Description
Int32FieldInfo

TextId

Field 'text_id' in table 'document': Dictionary type FK, .NET type: Int32

Pointer to optional long description

Declaration

public Int32FieldInfo TextId { get; }

Property Value

Type	Description
Int32FieldInfo

TextId_InnerJoin_Text

Generated join from the foreign key TextId in this table, to its target table TextTableInfo.

Declaration

public TargetedInnerJoin<TextTableInfo> TextId_InnerJoin_Text { get; }

Property Value

Type	Description
TargetedInnerJoin<TextTableInfo>

Updated

Field 'updated' in table 'document': Dictionary type UtcDateTime, .NET type: DateTime

Last updated when

Declaration

public DateTimeFieldInfo Updated { get; }

Property Value

Type	Description
DateTimeFieldInfo

UpdatedAssociateId

Field 'updated_associate_id' in table 'document': Dictionary type FK, .NET type: Int32

Last updated by whom

Declaration

public Int32FieldInfo UpdatedAssociateId { get; }

Property Value

Type	Description
Int32FieldInfo

UpdatedAssociateId_InnerJoin_Associate

Generated join from the foreign key UpdatedAssociateId in this table, to its target table AssociateTableInfo.

Declaration

public TargetedInnerJoin<AssociateTableInfo> UpdatedAssociateId_InnerJoin_Associate { get; }

Property Value

Type	Description
TargetedInnerJoin<AssociateTableInfo>

UpdatedCount

Field 'updatedCount' in table 'document': Dictionary type UShort, .NET type: Int16

Number of updates made to this record

Declaration

public UInt16FieldInfo UpdatedCount { get; }

Property Value

Type	Description
UInt16FieldInfo

Userdef2Id

Field 'userdef2_id' in table 'document': Dictionary type FK, .NET type: Int32

User-defined fields

Declaration

public Int32FieldInfo Userdef2Id { get; }

Property Value

Type	Description
Int32FieldInfo

Userdef2Id_InnerJoin_UDDocLarge

Generated join from the foreign key Userdef2Id in this table, to its target table UDDocLargeTableInfo.

Declaration

public TargetedInnerJoin<UDDocLargeTableInfo> Userdef2Id_InnerJoin_UDDocLarge { get; }

Property Value

Type	Description
TargetedInnerJoin<UDDocLargeTableInfo>

UserdefId

Field 'userdef_id' in table 'document': Dictionary type FK, .NET type: Int32

User-defined fields

Declaration

public Int32FieldInfo UserdefId { get; }

Property Value

Type	Description
Int32FieldInfo

UserdefId_InnerJoin_UDDocSmall

Generated join from the foreign key UserdefId in this table, to its target table UDDocSmallTableInfo.

Declaration

public TargetedInnerJoin<UDDocSmallTableInfo> UserdefId_InnerJoin_UDDocSmall { get; }

Property Value

Type	Description
TargetedInnerJoin<UDDocSmallTableInfo>

YourRef

Field 'your_ref' in table 'document': Dictionary type String[100], .NET type: String

Your reference

Declaration

public StringFieldInfo YourRef { get; }

Property Value

Type	Description
StringFieldInfo

Implements

System.ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)