Class ReportEntity

Carrier object for ReportEntity. Services for the ReportEntity Carrier is available from the IReportAgent.

Inheritance
object
ReportEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class ReportEntity : Carrier
Examples

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }

Constructors

ReportEntity()

Default constructor

Declaration
public ReportEntity()
Examples

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

Properties

AssociateId

The owner of the report.

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

Description

The description of the report.

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

Name

The name of the report

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

Published

Is the report published?

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

ReportCategory

The category of the report.

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

ReportId

The id of the report.

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

ReportLayout

The layout of the report.

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

TemplateId

The id of report template.

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

Get ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 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 ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 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 ReportEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReportAgent();
    var reportEntity = agent.GetReportEntity( 123 );
 }
See Also

See Also