Class Area

Carrier object for Area. Services for the Area Carrier is available from the IReplicationAgent.

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

Get Area 123 using the agent:

 using SuperOffice;
 using SuperOffice.CRM.Services;

 using (SoSession mySession = SoSession.Authenticate("user", "pass"))
 {
    var agent = new ReplicationAgent();
    var area = agent.GetArea( 123 );
 }

Constructors

Area()

Default constructor

Declaration
public Area()

Properties

AreaId

Primary key

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

FreetextEnabeled

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

MaxDataAge

Max age of data when generating db's based on this area

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

Name

Area name

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

NumberOfLogins

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

NumberOfUsers

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

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
String

The carrier contents.

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