Class RefCountEntity

A refcount entity for a number allocation

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }

Constructors

RefCountEntity()

Default constructor

Declaration
public RefCountEntity()
Examples

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

Properties

Allocate

Allocate numbers automatically

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

AllowBlank

Allow blank as a valid value

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

CurrentValue

Current value of counter

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

Field

Field identifier in string format table.field

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

ReadOnly

Target field is read only in GUI

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

RecordId

Record id in target table, used when there are separate counters for each target record

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

RefCountsId

Primary key

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

SatPrefix

size of prefix for Satellite use of this counter

Declaration
public virtual uint SatPrefix { get; set; }
Property Value
Type Description
UInt32
Examples

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

SuggestedRecords

List of valid entities, the associated record is selected in the list, used records are filtered out

Declaration
public virtual MDOListItem[] SuggestedRecords { get; set; }
Property Value
Type Description
MDOListItem[]
Examples

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

TravelPrefix

size of prefix for Travel use of ths counter

Declaration
public virtual uint TravelPrefix { get; set; }
Property Value
Type Description
UInt32
Examples

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

Unique

Check that entered value is unique

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

Get RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 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 RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 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 RefCountEntity 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new NumberAllocationAgent();
    var refCountEntity = agent.GetRefCountEntity( 123 );
 }
See Also

See Also