Class DocumentEntity

Partial DocumentEntity class associating the generated DocumentEntity with an interface.

Inheritance
Object
DocumentEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class DocumentEntity : Carrier, IActivityEntityCarrier, IRelationEntityCarrier, ILinksContainerEntityCarrier, IProjectRelationEntityCarrier, IContactPersonRelationEntityCarrier, IEntityCarrier, IUdefFieldCarrier, IExtraFieldCarrier, IPublishedCarrier, IVisibleForCarrier
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );

Constructors

DocumentEntity()

Default constructor

Declaration
public DocumentEntity()
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Properties

Number of active links to sale, document, appointment.

Declaration
public virtual int ActiveLinks { get; set; }
Property Value
Type Description
Int32

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );

Associate

The owner of the document - the associate whose checklist the document is in.

Use MDO List name "associate" to get list items.

Declaration
public virtual Associate Associate { get; set; }
Property Value
Type Description
Associate
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Attention

Attention/salutation

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Completed

Document Completed state. This is the part of the Status property.

Declaration
public virtual ActivityStatus Completed { get; set; }
Property Value
Type Description
ActivityStatus
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Contact

The contact associated with the document. It may also be null if no contact is associated with the document.

Use MDO List name "contact" to get list items.

Declaration
public virtual Contact Contact { get; set; }
Property Value
Type Description
Contact
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

CreatedBy

The person that first created the document. The property is read-only.

Declaration
public virtual Associate CreatedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

CreatedDate

Registered when in UTC.

Declaration
public virtual DateTime CreatedDate { get; set; }
Property Value
Type Description
DateTime
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

CustomFields

Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual ExtraFields and UserDefinedFields properties are deprecated in favor of this combined collection.

Declaration
public StringDictionary CustomFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Extra field data [Extra field name]

Example: 
'x_gorp' = '[I:123]'
User defined field data [Prog-id name]

Example: 
'SuperOffice:1' = '[I:123]'

Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Date

date + start time planned

Declaration
public virtual DateTime Date { get; set; }
Property Value
Type Description
DateTime
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Description

The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

DocumentId

Primary key

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

DocumentTemplate

The template type of the document.

Use MDO List name "doctmpl" to get list items.

Declaration
public virtual DocumentTemplate DocumentTemplate { get; set; }
Property Value
Type Description
DocumentTemplate
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

ExternalRef

External reference for document plugin to resolve document identity (Notes ID, e-mail message ID, whatever)

Declaration
public virtual string ExternalRef { get; set; }
Property Value
Type Description
String
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

ExtraFields

Deprecated: Use CustomFields instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.

Declaration
public StringDictionary ExtraFields { get; set; }
Property Value
Type Description
StringDictionary
Remarks

The naming convention of the key string is as follows:

Plug-in data [Plug-in name].[Property name] Example: DocumentPlugin.DocumentType
Foreign key data The device identity is appended directly to the device name if it exists. This is not commonly used, but the database opens for this as a possibility to have several devices with the same name, and hence we would ensure an unique key if this field is used. Example: Audience.SecretService.DefaultCountry
User defined table data [Table name].[Field name] Example: Phunneling.AggregatedSales
Other Other data sources must ensure an unique name. If the key already exists we do not add the data to the dictionary. We also ensure that SuperOffice data are added first, so that existing data doesnt change when more data sources are added (with duplicate data keys).
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Header

Visible document name

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

IsPublished

Publication is published

Declaration
public bool IsPublished { get; set; }
Property Value
Type Description
Boolean
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

List of all elements linked to the document.

Declaration
public virtual Link[] Links { get; set; }
Property Value
Type Description
Link[]

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );

LockSemantics

Partial DocumentEntity class associating the generated DocumentEntity with an interface.

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Name

File name

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

OurRef

Our reference, searchable field from freetext search

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Person

A document may also be connected to a person; this must be a contact person registered on the current company. This does not mean however that a person is required.

Use MDO List name "person" to get list items.

Declaration
public virtual Person Person { get; set; }
Property Value
Type Description
Person
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Project

A document may also be connected to a project, so you see the document both on the company card, and on the project card. This does not mean however that a project is required.

Use MDO List name "project" to get list items.

Declaration
public virtual Project Project { get; set; }
Property Value
Type Description
Project
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

PublishEventDate

Publish event date

Declaration
public DateTime PublishEventDate { get; set; }
Property Value
Type Description
DateTime
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

PublishFrom

Publication valid from (inclusive)

Declaration
public DateTime PublishFrom { get; set; }
Property Value
Type Description
DateTime
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

PublishTo

Publication valid to (inclusive)

Declaration
public DateTime PublishTo { get; set; }
Property Value
Type Description
DateTime
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Sale

A document may also be connected to a sale, so you see the document on the company card, on the project card and on the sale card. This does not mean however that a sale is required. May be null.

Use MDO List name "sale" to get list items.

Declaration
public virtual Sale Sale { get; set; }
Property Value
Type Description
Sale
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Snum

The sequence number allocated from refcount on used template when creating the document

Declaration
public virtual int Snum { get; set; }
Property Value
Type Description
Int32
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

SuggestedDocumentId

Suggested guide item that this document is an instance of (Note: NOT valid for appointments, they have their own link)

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Type

Is this a normal document or a mail-merge or report?

Declaration
public virtual AppointmentType Type { get; set; }
Property Value
Type Description
AppointmentType
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

UpdatedBy

The person that last updated the appointment.

Declaration
public virtual Associate UpdatedBy { get; set; }
Property Value
Type Description
Associate
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

UpdatedDate

Last updated when in UTC.

Declaration
public virtual DateTime UpdatedDate { get; set; }
Property Value
Type Description
DateTime
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

UserDefinedFields

Deprecated: Use CustomFields instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"

Declaration
public StringDictionary UserDefinedFields { get; set; }
Property Value
Type Description
StringDictionary
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

VisibleFor

The set of users or groups the record is visible for

Declaration
public VisibleFor[] VisibleFor { get; set; }
Property Value
Type Description
VisibleFor[]
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

YourRef

Your reference

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

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

ToString(String)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
String prefix

The line prefix (typically used for indenting)
Returns
Type Description
String

The carrier contents.
Examples

Get DocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var documentEntity = agent.GetDocumentEntity( 123 );
 }

Find all DocumentEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("FindDocument", "...", null, "getAllRows eq 1", null, 0, 100 );
var links = archive.GetArchiveListByColumns2("Links", "...", null, "sourceDocumentRestrictionId eq 123", null, 0, 100 );
See Also

Implements

See Also