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

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

Declaration

public DateTime ActiveDate { get; }

Property Value

Type	Description
DateTime

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.

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; }

Property Value

Type	Description
int

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.

ArchiveProvider

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

Declaration

public int ArchiveProvider { get; }

Property Value

Type	Description
int

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.

AssociateFullName

Full name of the document owner

Declaration

public string AssociateFullName { get; }

Property Value

Type	Description
string

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.

AssociateId

Owner of the document

Declaration

public int AssociateId { get; }

Property Value

Type	Description
int

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.

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

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.

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; }

Property Value

Type	Description
string

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.

ContactId

Primary key of the contact the document is related to

Declaration

public int ContactId { get; }

Property Value

Type	Description
int

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.

Description

Description of the document

Declaration

public string Description { get; }

Property Value

Type	Description
string

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.

Document

Implementation of IDocumentInfo; create through factory (see remarks)

Declaration

public Document Document { get; }

Property Value

Type	Description
Document

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.

DocumentId

Primary key of the document record

Declaration

public int DocumentId { get; }

Property Value

Type	Description
int

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.

DocumentTemplateInfo

Information about the document template

Declaration

public IDocumentTemplateInfo DocumentTemplateInfo { get; }

Property Value

Type	Description
IDocumentTemplateInfo

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.

ExternalReference

Get or set external reference (notes ID, email ID, other ID used by the archive provider)

Declaration

public string ExternalReference { get; }

Property Value

Type	Description
string

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.

FileName

Implementation of IDocumentInfo; create through factory (see remarks)

Declaration

public string FileName { get; }

Property Value

Type	Description
string

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.

Header

Visible document name

Declaration

public string Header { get; }

Property Value

Type	Description
string

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.

LockSemantics

Locking semantics requested/applied to a document

Declaration

public DocumentLockSemantics LockSemantics { get; }

Property Value

Type	Description
DocumentLockSemantics

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.

Name

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

Declaration

public string Name { get; }

Property Value

Type	Description
string

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.

OurRef

Our reference

Declaration

public string OurRef { get; }

Property Value

Type	Description
string

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.

PersonId

Primary key of the person the document is related to

Declaration

public int PersonId { get; }

Property Value

Type	Description
int

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.

ProjectId

Primary key of the project the document is related to

Declaration

public int ProjectId { get; }

Property Value

Type	Description
int

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.

PublishEndDate

Document, end date for publishing.

Declaration

public string PublishEndDate { get; }

Property Value

Type	Description
string

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.

PublishStartDate

Document, start date for publising.

Declaration

public string PublishStartDate { get; }

Property Value

Type	Description
string

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.

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; }

Property Value

Type	Description
DateTime

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.

Salutation

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

Declaration

public string Salutation { get; }

Property Value

Type	Description
string

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.

SerialNumber

Ascending serial number (different for every template)

Declaration

public string SerialNumber { get; }

Property Value

Type	Description
string

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.

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
int

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.

YourRef

Your reference

Declaration

public string YourRef { get; }

Property Value

Type	Description
string

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.

Methods

Create(Document)

Implementation of IDocumentInfo; create through factory (see remarks)

Declaration

public static IDocumentInfo2 Create(Document document)

Parameters

Type	Name	Description
Document	document

Returns

Type	Description
IDocumentInfo2

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.

Create(int)

Implementation of IDocumentInfo; create through factory (see remarks)

Declaration

public static IDocumentInfo2 Create(int documentId)

Parameters

Type	Name	Description
int	documentId

Returns

Type	Description
IDocumentInfo2

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.

GetUserDefinedDecimal(int)

Return a user defined value of type decimal

Declaration

public string GetUserDefinedDecimal(int fieldNo)

Parameters

Type	Name	Description
int	fieldNo	Index of field to retrieve value for

Returns

Type	Description
string	String representation of the value of specified field

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.

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

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.

GetUserDefinedInt(int)

Return a user defined value of type int

Declaration

public string GetUserDefinedInt(int fieldNo)

Parameters

Type	Name	Description
int	fieldNo	Index of field to retrieve value for

Returns

Type	Description
string	String representation of the value of specified field

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.

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
int	int value of field, or MINVALUE if field not found

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.

GetUserDefinedString(int)

Return a user defined value of type string

Declaration

public string GetUserDefinedString(int fieldNo)

Parameters

Type	Name	Description
int	fieldNo	Index of field to retrieve value for

Returns

Type	Description
string	Value of specified field

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.

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

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.

Implements

IDocumentInfo2

IDocumentInfo

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)