Class ListEntity

The list entity contains information about a specific list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Constructors

ListEntity()

Default constructor

Declaration
public ListEntity()
Examples

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Properties

Deleted

True if the list item is marked as deleted

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Id

The identity of the list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

InUseByUserDefinedFields

True if this in use by one or more udfields

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

IsCustomList

Indicates if this is a custom list or a standard list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

IsMDOList

Indicates if this is a MDO list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

ListType

The type of this list, often indicated by the database name, but not necessarily

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Name

The name of the list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Rank

The rank of the list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

Tooltip

The tooltip of the list

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

UseGroupsAndHeadings

Indicates if this list should use groups and headings

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

Get ListEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

 using SuperOffice;
 using SuperOffice.CRM.Services;

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

See Also