Show / Hide Table of Contents

Class DocDocumentTableInfo

Table 'doc_document': This table contains documents.

Inheritance
object
TableInfo
DocDocumentTableInfo
Implements
ICloneable
Inherited Members
TableInfo.ToString()
TableInfo.RegisterFields(params FieldInfo[])
TableInfo.FieldInfoFromSoField(SoField)
TableInfo.Clone()
TableInfo.IsSameTable(TableInfo)
TableInfo.FindField(string)
TableInfo.ProtAll
TableInfo.UseNolockIfPossible
TableInfo.HashCheckFields
TableInfo.TableName
TableInfo.DbName
TableInfo.IsDictionaryTable
TableInfo.All
TableInfo.this[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("doc_document")]
public class DocDocumentTableInfo : 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 TablesInfo.GetDocDocumentInfo().

Fields

DictionaryTableName

Conceptual name of table DocDocument in the database dictionary: doc_document

Declaration
public const string DictionaryTableName = "doc_document"
Field Value
Type Description
string
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 TablesInfo.GetDocDocumentInfo().

Properties

AccessLevel

Field 'access_level' in table 'doc_document': Dictionary type Enum, .NET type: short

The access level of the document
Declaration
public UInt16FieldInfo AccessLevel { get; }
Property Value
Type Description
UInt16FieldInfo
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 TablesInfo.GetDocDocumentInfo().

AttachmentId

Field 'attachment_id' in table 'doc_document': Dictionary type FK, target: Attachment, .NET type: int

The attachment.id for the attachment associated with this document.
Declaration
public Int32FieldInfo AttachmentId { get; }
Property Value
Type Description
Int32FieldInfo
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 TablesInfo.GetDocDocumentInfo().

AttachmentId_InnerJoin_Attachment

Generated join from the foreign key AttachmentId in this table, to its target table AttachmentTableInfo.

Declaration
public TargetedInnerJoin<AttachmentTableInfo> AttachmentId_InnerJoin_Attachment { get; }
Property Value
Type Description
TargetedInnerJoin<AttachmentTableInfo>
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 TablesInfo.GetDocDocumentInfo().

ChangedBy

Field 'changed_by' in table 'doc_document': Dictionary type FK, target: Ejuser, .NET type: int

Who last changed the document
Declaration
public Int32FieldInfo ChangedBy { get; }
Property Value
Type Description
Int32FieldInfo
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 TablesInfo.GetDocDocumentInfo().

ChangedBy_InnerJoin_Ejuser

Generated join from the foreign key ChangedBy in this table, to its target table EjuserTableInfo.

Declaration
public TargetedInnerJoin<EjuserTableInfo> ChangedBy_InnerJoin_Ejuser { get; }
Property Value
Type Description
TargetedInnerJoin<EjuserTableInfo>
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 TablesInfo.GetDocDocumentInfo().

CreatedAt

Field 'created_at' in table 'doc_document': Dictionary type DateTime, .NET type: DateTime

When the document was created
Declaration
public DateTimeFieldInfo CreatedAt { get; }
Property Value
Type Description
DateTimeFieldInfo
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 TablesInfo.GetDocDocumentInfo().

CreatedBy

Field 'created_by' in table 'doc_document': Dictionary type FK, target: Ejuser, .NET type: int

Who created the document
Declaration
public Int32FieldInfo CreatedBy { get; }
Property Value
Type Description
Int32FieldInfo
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 TablesInfo.GetDocDocumentInfo().

CreatedBy_InnerJoin_Ejuser

Generated join from the foreign key CreatedBy in this table, to its target table EjuserTableInfo.

Declaration
public TargetedInnerJoin<EjuserTableInfo> CreatedBy_InnerJoin_Ejuser { get; }
Property Value
Type Description
TargetedInnerJoin<EjuserTableInfo>
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 TablesInfo.GetDocDocumentInfo().

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
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 TablesInfo.GetDocDocumentInfo().

Description

Field 'description' in table 'doc_document': Dictionary type Clob, .NET type: string

A descriptive text for the document
Declaration
public StringFieldInfo Description { get; }
Property Value
Type Description
StringFieldInfo
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 TablesInfo.GetDocDocumentInfo().

DictionaryTableNumber

Table number for table DocDocument 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
int
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 TablesInfo.GetDocDocumentInfo().

DocDocumentId

Field 'id' in table 'doc_document': Dictionary type PK, .NET type: int

The primary key (auto-incremented)
Declaration
public Int32FieldInfo DocDocumentId { get; }
Property Value
Type Description
Int32FieldInfo
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 TablesInfo.GetDocDocumentInfo().

FolderId

Field 'folder_id' in table 'doc_document': Dictionary type FK, target: DocFolder, .NET type: int

The id of the document folder this entry is located in.
Declaration
public Int32FieldInfo FolderId { get; }
Property Value
Type Description
Int32FieldInfo
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 TablesInfo.GetDocDocumentInfo().

FolderId_InnerJoin_DocFolder

Generated join from the foreign key FolderId in this table, to its target table DocFolderTableInfo.

Declaration
public TargetedInnerJoin<DocFolderTableInfo> FolderId_InnerJoin_DocFolder { get; }
Property Value
Type Description
TargetedInnerJoin<DocFolderTableInfo>
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 TablesInfo.GetDocDocumentInfo().

IdString

Field 'id_string' in table 'doc_document': Dictionary type String[256], .NET type: string

A field for an id_string which may be used to access the document
Declaration
public StringFieldInfo IdString { get; }
Property Value
Type Description
StringFieldInfo
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 TablesInfo.GetDocDocumentInfo().

LastChanged

Field 'last_changed' in table 'doc_document': Dictionary type DateTime, .NET type: DateTime

When the document last was changed
Declaration
public DateTimeFieldInfo LastChanged { get; }
Property Value
Type Description
DateTimeFieldInfo
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 TablesInfo.GetDocDocumentInfo().

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
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 TablesInfo.GetDocDocumentInfo().

Status

Field 'status' in table 'doc_document': Dictionary type Enum, .NET type: short

The status of the document
Declaration
public UInt16FieldInfo Status { get; }
Property Value
Type Description
UInt16FieldInfo
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 TablesInfo.GetDocDocumentInfo().

Title

Field 'title' in table 'doc_document': Dictionary type String[256], .NET type: string

The title for the document
Declaration
public StringFieldInfo Title { get; }
Property Value
Type Description
StringFieldInfo
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 TablesInfo.GetDocDocumentInfo().

Implements

ICloneable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top