Show / Hide Table of Contents

Class DocumentInfoProvider

Implementation of IDocumentInfo; create through factory (see remarks)

Inheritance
Object
DocumentInfoProvider
Implements
IDocumentInfo2
IDocumentInfo
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Object.GetType()
Object.MemberwiseClone()
Namespace: SuperOffice.CRM.Entities.Providers
Assembly: SoDataBase.dll
Syntax
public class DocumentInfoProvider : IDocumentInfo2, IDocumentInfo
Remarks

To create an instance of DocumentInfoProvider, use

var info = ClassFactory.Create<IDocumentInfo>(doc);

where doc is a Document, to use an already-loaded entity object (that may also contain unsaved data); or where doc is an int that is a documentId, which will cause database fetches. The factory methods at the bottom of this class will handle both cases.

If you are in the Cpp world, or otherwise have unsaved data that you would want to use without incurring the overhead of an entity object, instantiate a SimpleDocumentInfo instead, fully populate it, and pass that to the factory.

Properties

ActiveDate

Declaration
public DateTime ActiveDate { get; }
Property Value
Type Description
DateTime

AppointmentId

Declaration
public int AppointmentId { get; }
Property Value
Type Description
Int32

ArchiveProvider

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

AssociateFullName

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

AssociateId

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

AssociateLoginName

Get associate login name from the associate pointed to by the appointment.associate_id; if it does not exist then fall back to AssociateHistory. That table is populated automagically when an associate is deleted.

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

Attention

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

ContactId

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

Description

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

Document

Declaration
public Document Document { get; }
Property Value
Type Description
Document

DocumentId

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

DocumentTemplateInfo

Declaration
public IDocumentTemplateInfo DocumentTemplateInfo { get; }
Property Value
Type Description
IDocumentTemplateInfo

ExternalReference

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

FileName

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

Header

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

LockSemantics

Locking semantics requested/applied to a document

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

Name

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

OurRef

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

PersonId

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

ProjectId

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

PublishEndDate

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

PublishStartDate

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

Registered

Declaration
public DateTime Registered { get; }
Property Value
Type Description
DateTime

Salutation

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

SerialNumber

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

SuggestedDocumentId

Get the suggested document ID for the document. Return 0 is not a suggested document

Declaration
public int SuggestedDocumentId { get; }
Property Value
Type Description
Int32

YourRef

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

Methods

Create(Document)

Declaration
public static IDocumentInfo2 Create(Document document)
Parameters
Type Name Description
Document document
Returns
Type Description
IDocumentInfo2

Create(Int32)

Declaration
public static IDocumentInfo2 Create(int documentId)
Parameters
Type Name Description
Int32 documentId
Returns
Type Description
IDocumentInfo2

GetUserDefinedDecimal(Int32)

Return a user defined value of type decimal

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

Index of field to retrieve value for

Returns
Type Description
String

String representation of the value of specified field

GetUserDefinedDecimal(String)

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

Program name of udef field

Returns
Type Description
Double

double value of field, or NAN if field not found

GetUserDefinedInt(Int32)

Return a user defined value of type int

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

Index of field to retrieve value for

Returns
Type Description
String

String representation of the value of specified field

GetUserDefinedInt(String)

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

Program name of udef field

Returns
Type Description
Int32

int value of field, or MINVALUE if field not found

GetUserDefinedString(Int32)

Return a user defined value of type string

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

Index of field to retrieve value for

Returns
Type Description
String

Value of specified field

GetUserDefinedString(String)

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

Program name of udef field

Returns
Type Description
String

string value of field, or NULL if field not found

Implements

IDocumentInfo2
IDocumentInfo

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