Class EntityCollection

Namespace

Sage.CRM.Data

Assembly

SageCRMNet.dll

Collection of related records from a CRM table. GetSubCollection(string)

public class EntityCollection

Inheritance

object

EntityCollection

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

Add()

Adds a new entity object to the collection with all null values. An actual new record will be created when SaveChanges is called.

public Entity Add()

Returns

Entity

Entity - an entity object representing the new record.

Add(Entity)

Adds an existing entity object to the collection.

public Entity Add(Entity NewEntity)

Parameters

NewEntity Entity

Entity to add.

Returns

Entity

The entity that was added.

Add(string, string)

Adds an entity object to the collection with the specified values already set. An actual new record will be created on SaveChanges.

public Entity Add(string fieldName, string fieldValue)

Parameters

fieldName string

Field name to set - must be a field that exists on the parent entity.

fieldValue string

Field value to set.

Returns

Entity

The new entity object.

Bof()

Checks if this is the first record in the collection.

public bool Bof()

Returns

bool

true/false.

Delete(int)

Deletes a record from a collection by index. The actual record will be deleted when SaveChanges is called.

public void Delete(int Index)

Parameters

Index int

Position (index) of the record.

Eof()

Checks is this the last record in the collection.

public bool Eof()

Returns

bool

true/false.

~EntityCollection()

Destructor for EntityCollection class.

protected ~EntityCollection()

GetFirst()

Creates an entity object representing the first record in the collection.

public Entity GetFirst()

Returns

Entity

Entity.

GetLast()

Creates an entity object representing the last record in the collection.

public Entity GetLast()

Returns

Entity

Entity.

GetNext()

Creates an entity object representing the next record in the collection.

public Entity GetNext()

Returns

Entity

Entity.