Class SuggestedDocumentEntity

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

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

SuggestedDocumentEntity()

Default constructor

Declaration
public SuggestedDocumentEntity()
Examples

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

Deleted

0 -> record is active 1 -> record is 'deleted' and should not be shown in lists

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DocTmpl

Document template

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

DoctmplId

Type of the suggested document

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Header

Suggested 'header'

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Name

Item name, visible in Guide

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

OurRef

Suggested 'our reference'

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Project type and project status link info

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Rank

Rank, controls rank of non-instantiated items in Guide

Declaration
public virtual short Rank { get; set; }
Property Value
Type Description
Int16
Examples

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Sale type and stage link info.

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

SuggestedDocumentId

Primary key

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Tooltip

Tooltip / description

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

Get SuggestedDocumentEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

See Also