Show / Hide Table of Contents

Class CategoryEntity

Carrier object for CategoryEntity. Services for the CategoryEntity Carrier is available from the List Agent.

Inheritance
object
CategoryEntity
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class CategoryEntity : Carrier
Examples

Get CategoryEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

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

Constructors

CategoryEntity()

Default constructor

Declaration
public CategoryEntity()
See Also
IListAgent

Properties

CategoryFamilyId

Optional link to family, for grouping things like multiple kinds of customer category under family 'customer'

Declaration
[DataMember]
public virtual int CategoryFamilyId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

CategoryGroup

Enum of the group this category belongs to, static list of 5 groups

Declaration
[DataMember]
public virtual CategoryGroup CategoryGroup { get; set; }
Property Value
Type Description
CategoryGroup
See Also
IListAgent

CategoryId

Primary key

Declaration
[DataMember]
public virtual int CategoryId { get; set; }
Property Value
Type Description
int
See Also
IListAgent

Deleted

true if the country is deleted

Declaration
[DataMember]
public virtual bool Deleted { get; set; }
Property Value
Type Description
bool
See Also
IListAgent

EnableLeadStatus

True if the category should enable lead stage

Declaration
[DataMember]
public virtual bool EnableLeadStatus { get; set; }
Property Value
Type Description
bool
See Also
IListAgent

Name

Name of the category

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
IListAgent

Rank

Rank of the category

Declaration
[DataMember]
public virtual short Rank { get; set; }
Property Value
Type Description
short
See Also
IListAgent

Tooltip

Tooltip of the category

Declaration
[DataMember]
public virtual string Tooltip { get; set; }
Property Value
Type Description
string
See Also
IListAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IListAgent

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.

See Also
IListAgent

See Also

IListAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top