Class Document

Carrier object for Document. Services for the Document Carrier is available from the IDocumentAgent.

Inheritance
Object
Document
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class Document : Carrier
Examples

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

Document()

Default constructor

Declaration
public Document()
Examples

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

Properties

AssociateFullName

The associate's culture formatted fullname (firstname, middleName and lastname)

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

AssociateId

ID of associate whose diary the appointment is in, REQUIRED

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

Attention

Attention/salutation

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

ContactId

Contact ID of owning contact, may be 0

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

ContactName

Contact name

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
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 Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

DocumentId

Primary key

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

DocumentTemplate

Carrier object for Document. Services for the Document Carrier is available from the IDocumentAgent.

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

Header

Visible document name

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

IsPublished

True if document have an entry in published table

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

Name

File name

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

OurRef

Our reference, searchable field from freetext search

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

PersonFullName

The full name of the person this document belongs to.

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

PersonId

Person ID of person the appointment is with, may be 0

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

ProjectId

ID of project referred to, may be 0

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

ProjectName

Project name

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

SaleId

Owning sale, if any (may be 0)

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

SaleName

Heading of Owning sale, if any. (may be blank)

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
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 Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

YourRef

Your reference

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

Get Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
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 Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
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 Document 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new DocumentAgent();
    var document = agent.GetDocument( 123 );
 }
See Also

See Also