Class SimpleDocumentInfo
Plain-old-data implementation of IDocumentInfo, intended for situations where the client knows everything and does not want the database to be involved (for instance, when running on unsaved data)
Inherited Members
Namespace: SuperOffice.CRM.Entities.Providers
Assembly: SoDataBase.dll
Syntax
public class SimpleDocumentInfo : IDocumentInfo2, IDocumentInfoConstructors
SimpleDocumentInfo()
Plain-old-data implementation of IDocumentInfo, intended for situations where the client knows everything and does not want the database to be involved (for instance, when running on unsaved data)
Declaration
public SimpleDocumentInfo()Properties
ActiveDate
Active date of the document. Registered is used in SO_ARC for calculating days
Declaration
public DateTime ActiveDate { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
AppointmentId
Primary key of the appointment exteding the document record. This is NOT the appointment the document is linked to.
Declaration
public int AppointmentId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
ArchiveProvider
Reference to archive provider and the Notes Link. Default = 0, this means SOArc plugin.
Declaration
public int ArchiveProvider { get; set; }Property Value
| Type | Description |
|---|---|
| int |
AssociateFullName
Full name of the document owner
Declaration
public string AssociateFullName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
AssociateId
Owner of the document
Declaration
public int AssociateId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
AssociateLoginName
Login name of the document owner
Declaration
public string AssociateLoginName { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Attention
Selected contact in the Document dialog or text that is specified in the Company field for a recipient of the document
Declaration
public string Attention { get; set; }Property Value
| Type | Description |
|---|---|
| string |
ContactId
Primary key of the contact the document is related to
Declaration
public int ContactId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
Description
Description of the document
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
DocumentId
Primary key of the document record
Declaration
public int DocumentId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
DocumentTemplateInfo
Information about the document template
Declaration
public IDocumentTemplateInfo DocumentTemplateInfo { get; }Property Value
| Type | Description |
|---|---|
| IDocumentTemplateInfo |
ExternalReference
Get or set external reference (notes ID, email ID, other ID used by the archive provider)
Declaration
public string ExternalReference { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Header
Visible document name
Declaration
public string Header { get; set; }Property Value
| Type | Description |
|---|---|
| string |
LockSemantics
Locking semantics requested/applied to a document
Declaration
public DocumentLockSemantics LockSemantics { get; set; }Property Value
| Type | Description |
|---|---|
| DocumentLockSemantics |
Name
Get or set file name, without archive path, user or period prefixes
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| string |
OurRef
Our reference
Declaration
public string OurRef { get; set; }Property Value
| Type | Description |
|---|---|
| string |
PersonId
Primary key of the person the document is related to
Declaration
public int PersonId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
ProjectId
Primary key of the project the document is related to
Declaration
public int ProjectId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
PublishEndDate
Document, end date for publishing.
Declaration
public string PublishEndDate { get; set; }Property Value
| Type | Description |
|---|---|
| string |
PublishStartDate
Document, start date for publising.
Declaration
public string PublishStartDate { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Registered
The time the document record is created. This is used to calculate the path of the document in SO_ARC
Declaration
public DateTime Registered { get; set; }Property Value
| Type | Description |
|---|---|
| DateTime |
Salutation
Salutation as entered, or created automatically from the contact (Mr/Ms and last name).
Declaration
public string Salutation { get; set; }Property Value
| Type | Description |
|---|---|
| string |
SerialNumber
Ascending serial number (different for every template)
Declaration
public string SerialNumber { get; set; }Property Value
| Type | Description |
|---|---|
| string |
SimpleTmplInfo
Concrete template info carrier, so it can be populated
Declaration
public SimpleDocumentTemplateInfo SimpleTmplInfo { get; set; }Property Value
| Type | Description |
|---|---|
| SimpleDocumentTemplateInfo |
SuggestedDocumentId
The documents SuggestedDocument ID. Return 0 if document is not part of a sale/project guide
Declaration
public int SuggestedDocumentId { get; set; }Property Value
| Type | Description |
|---|---|
| int |
UdefDecimal
Set the value of a user-defined DECIMAL field, identified by the field number (1-10)
Declaration
public InfoUdefDict UdefDecimal { get; set; }Property Value
| Type | Description |
|---|---|
| InfoUdefDict |
UdefInt
Set the value of a user-defined INT field, identified by the field number (1-60)
Declaration
public InfoUdefDict UdefInt { get; set; }Property Value
| Type | Description |
|---|---|
| InfoUdefDict |
UdefString
Set the value of a user-defined STRING field, identified by the field number. Number 1-40 are short strings, 41-49 are long strings
Declaration
public InfoUdefDict UdefString { get; set; }Property Value
| Type | Description |
|---|---|
| InfoUdefDict |
YourRef
Your reference
Declaration
public string YourRef { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
GetUserDefinedDecimal(int)
User-defined field 1-10 of the decimal (.NET double) number type.
Declaration
public string GetUserDefinedDecimal(int fieldNo)Parameters
| Type | Name | Description |
|---|---|---|
| int | fieldNo | Field number (1-10). |
Returns
| Type | Description |
|---|---|
| string | User-defined field value. |
GetUserDefinedDecimal(string)
NOT SUPPORTED: Get the decimal udef value based on the prog.id name of the udef field.
Declaration
public double GetUserDefinedDecimal(string progId)Parameters
| Type | Name | Description |
|---|---|---|
| string | progId |
Returns
| Type | Description |
|---|---|
| double |
GetUserDefinedInt(int)
Get user-defined field 1-60 of the whole (.NET Int32) number type.
Declaration
public string GetUserDefinedInt(int fieldNo)Parameters
| Type | Name | Description |
|---|---|---|
| int | fieldNo | Field number (1-60). |
Returns
| Type | Description |
|---|---|
| string | User-defined field value. |
GetUserDefinedInt(string)
NOT SUPPORTED: Get the int udef value based on the prog.id name of the udef field.
Declaration
public int GetUserDefinedInt(string progId)Parameters
| Type | Name | Description |
|---|---|---|
| string | progId |
Returns
| Type | Description |
|---|---|
| int |
GetUserDefinedString(int)
Get user-defined field 1-49 of the text (.NET string) type.
Declaration
public string GetUserDefinedString(int fieldNo)Parameters
| Type | Name | Description |
|---|---|---|
| int | fieldNo | Field number (1-39). |
Returns
| Type | Description |
|---|---|
| string | User-defined field value. |
GetUserDefinedString(string)
NOT SUPPORTED: Get the string udef value based on the prog.id name of the udef field.
Declaration
public string GetUserDefinedString(string progId)Parameters
| Type | Name | Description |
|---|---|---|
| string | progId |
Returns
| Type | Description |
|---|---|
| string |