Class DocumentInfoProvider
Implementation of IDocumentInfo; create through factory (see remarks)
Inheritance
DocumentInfoProvider
Assembly: SoDataBase.dll
Syntax
public class DocumentInfoProvider : IDocumentInfo2, IDocumentInfo
Properties
ActiveDate
Declaration
public DateTime ActiveDate { get; }
Property Value
AppointmentId
Declaration
public int AppointmentId { get; }
Property Value
ArchiveProvider
Declaration
public int ArchiveProvider { get; }
Property Value
AssociateFullName
Declaration
public string AssociateFullName { get; }
Property Value
AssociateId
Declaration
public int AssociateId { get; }
Property Value
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
Attention
Declaration
public string Attention { get; }
Property Value
Declaration
public int ContactId { get; }
Property Value
Description
Declaration
public string Description { get; }
Property Value
Document
Declaration
public Document Document { get; }
Property Value
DocumentId
Declaration
public int DocumentId { get; }
Property Value
DocumentTemplateInfo
Declaration
public IDocumentTemplateInfo DocumentTemplateInfo { get; }
Property Value
ExternalReference
Declaration
public string ExternalReference { get; }
Property Value
FileName
Declaration
public string FileName { get; }
Property Value
Declaration
public string Header { get; }
Property Value
LockSemantics
Locking semantics requested/applied to a document
Declaration
public DocumentLockSemantics LockSemantics { get; }
Property Value
Name
Declaration
public string Name { get; }
Property Value
OurRef
Declaration
public string OurRef { get; }
Property Value
PersonId
Declaration
public int PersonId { get; }
Property Value
ProjectId
Declaration
public int ProjectId { get; }
Property Value
PublishEndDate
Declaration
public string PublishEndDate { get; }
Property Value
PublishStartDate
Declaration
public string PublishStartDate { get; }
Property Value
Registered
Declaration
public DateTime Registered { get; }
Property Value
Salutation
Declaration
public string Salutation { get; }
Property Value
SerialNumber
Declaration
public string SerialNumber { get; }
Property Value
SuggestedDocumentId
Get the suggested document ID for the document.
Return 0 is not a suggested document
Declaration
public int SuggestedDocumentId { get; }
Property Value
YourRef
Declaration
public string YourRef { get; }
Property Value
Methods
Create(Document)
Declaration
public static IDocumentInfo2 Create(Document document)
Parameters
Returns
Create(Int32)
Declaration
public static IDocumentInfo2 Create(int documentId)
Parameters
Type |
Name |
Description |
Int32 |
documentId |
|
Returns
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
Extension Methods
EnumUtil.MapEnums<From, To>(From)