Class HeadingEntity

The heading entity contains generic list item information

Carrier object for HeadingEntity. Services for the HeadingEntity Carrier is available from the IListAgent.
Inheritance
Object
HeadingEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
public class HeadingEntity : Carrier
Examples

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }

Constructors

HeadingEntity()

Default constructor

Declaration
public HeadingEntity()
Examples

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

Properties

Deleted

True if the heading is marked as deleted

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

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

HeadingId

Primary key

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

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

Name

The visible heading

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

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

Rank

Rank order

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

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

Tooltip

Tooltip or other description

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

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

UdListDefinitionId

The id of the list which this heading belongs to

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

Get HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 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 HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 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 HeadingEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ListAgent();
    var headingEntity = agent.GetHeadingEntity( 123 );
 }
See Also

See Also