Show / Hide Table of Contents

Interface IDocumentInfo

Interface providing information about the document.

Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public interface IDocumentInfo

Properties

ActiveDate

Active date of the document. Registered is used in SO_ARC for calculating days

Declaration
DateTime ActiveDate { get; }
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
int AppointmentId { get; }
Property Value
Type Description
Int32

ArchiveProvider

Reference to archive provider and the Notes Link. Default = 0, this means SOArc plugin.

Declaration
int ArchiveProvider { get; }
Property Value
Type Description
Int32

AssociateFullName

Full name of the document owner

Declaration
string AssociateFullName { get; }
Property Value
Type Description
String

AssociateId

Owner of the document

Declaration
int AssociateId { get; }
Property Value
Type Description
Int32

AssociateLoginName

Login name of the document owner

Declaration
string AssociateLoginName { get; }
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
string Attention { get; }
Property Value
Type Description
String

ContactId

Primary key of the contact the document is related to

Declaration
int ContactId { get; }
Property Value
Type Description
Int32

Description

Description of the document

Declaration
string Description { get; }
Property Value
Type Description
String

DocumentId

Primary key of the document record

Declaration
int DocumentId { get; }
Property Value
Type Description
Int32

DocumentTemplateInfo

Information about the document template

Declaration
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
string ExternalReference { get; }
Property Value
Type Description
String

Header

Visible document name

Declaration
string Header { get; }
Property Value
Type Description
String

LockSemantics

Locking semantics requested/applied to a document

Declaration
DocumentLockSemantics LockSemantics { get; }
Property Value
Type Description
DocumentLockSemantics

Name

Get or set file name, without archive path, user or period prefixes

Declaration
string Name { get; }
Property Value
Type Description
String

OurRef

Our reference

Declaration
string OurRef { get; }
Property Value
Type Description
String

PersonId

Primary key of the person the document is related to

Declaration
int PersonId { get; }
Property Value
Type Description
Int32

ProjectId

Primary key of the project the document is related to

Declaration
int ProjectId { get; }
Property Value
Type Description
Int32

PublishEndDate

Document, end date for publishing.

Declaration
string PublishEndDate { get; }
Property Value
Type Description
String

PublishStartDate

Document, start date for publising.

Declaration
string PublishStartDate { get; }
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
DateTime Registered { get; }
Property Value
Type Description
DateTime

Salutation

Salutation as entered, or created automatically from the contact (Mr/Ms and last name).

Declaration
string Salutation { get; }
Property Value
Type Description
String

SerialNumber

Ascending serial number (different for every template)

Declaration
string SerialNumber { get; }
Property Value
Type Description
String

YourRef

Your reference

Declaration
string YourRef { get; }
Property Value
Type Description
String

Methods

GetUserDefinedDecimal(Int32)

User-defined field 1-10 of the decimal (.NET double) number type.

Declaration
string GetUserDefinedDecimal(int fieldNo)
Parameters
Type Name Description
Int32 fieldNo

Field number (1-10).

Returns
Type Description
String

User-defined field value.

GetUserDefinedDecimal(String)

Get the decimal udef value based on the prog.id name of the udef field.

Declaration
double GetUserDefinedDecimal(string progId)
Parameters
Type Name Description
String progId

Program name of udef field

Returns
Type Description
Double

double value of field, or NAN if field not found

GetUserDefinedInt(Int32)

Get user-defined field 1-60 of the whole (.NET Int32) number type.

Declaration
string GetUserDefinedInt(int fieldNo)
Parameters
Type Name Description
Int32 fieldNo

Field number (1-60).

Returns
Type Description
String

User-defined field value.

GetUserDefinedInt(String)

Get the int udef value based on the prog.id name of the udef field.

Declaration
int GetUserDefinedInt(string progId)
Parameters
Type Name Description
String progId

Program name of udef field

Returns
Type Description
Int32

int value of field, or MINVALUE if field not found

GetUserDefinedString(Int32)

Get user-defined field 1-49 of the text (.NET string) type.

Declaration
string GetUserDefinedString(int fieldNo)
Parameters
Type Name Description
Int32 fieldNo

Field number (1-39).

Returns
Type Description
String

User-defined field value.

GetUserDefinedString(String)

Get the string udef value based on the prog.id name of the udef field.

Declaration
string GetUserDefinedString(string progId)
Parameters
Type Name Description
String progId

Program name of udef field

Returns
Type Description
String

string value of field, or NULL if field not found

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