Class ContactList
ContactList implements a collection of the mini contact entity, suitable for displaying in lists.
Implements
System.Collections.IEnumerable
System.Collections.Generic.IEnumerable<ContactListItem>
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<ContactListItem>
System.Collections.Generic.ICollection<ContactListItem>
Inherited Members
Namespace: SuperOffice.CRM.Archives
Assembly: SoDataBase.dll
Syntax
public sealed class ContactList : ListBase<ContactList.ContactListQuery, ContactListItem>, IEnumerable, IEnumerable<ContactListItem>, IList, ICollection, IList<ContactListItem>, ICollection<ContactListItem>
Remarks
A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.
Methods
ContactExist(Int32)
Checks if the contact described by the contactId exists in the list.
Declaration
public bool ContactExist(int contactId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contactId | The contact |
Returns
Type | Description |
---|---|
System.Boolean | True/false |
GetContact(Int32)
Returns the contact described by the contact_id.
Declaration
public Contact GetContact(int contactId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contactId | The person in question |
Returns
Type | Description |
---|---|
Contact | The contact |
GetContactListItem(Int32)
Will return the ContactListItem described by the contactId.
Declaration
public ContactListItem GetContactListItem(int contactId)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | contactId | The contact |
Returns
Type | Description |
---|---|
ContactListItem | The contact. |
GetIndexOfItem(ContactListItem)
Returns the index of the given item.
Declaration
public int GetIndexOfItem(ContactListItem contact)
Parameters
Type | Name | Description |
---|---|---|
ContactListItem | contact | The contactlistitem to search for. |
Returns
Type | Description |
---|---|
System.Int32 | The index of the ContactListItem. |
OnLoad(ContactList.ContactListQuery, SoDataReader)
Responsible for reading each row with data from the SoDataReader and insert the object each row represents into the class' collection.
Declaration
protected override void OnLoad(ContactList.ContactListQuery query, SoDataReader reader)
Parameters
Type | Name | Description |
---|---|---|
ContactList.ContactListQuery | query | |
SoDataReader | reader | The reader which contains all data in the list. |
Overrides
SuperOffice.CRM.Lists.ListBase<SuperOffice.CRM.Archives.ContactList.ContactListQuery, SuperOffice.CRM.Archives.ContactListItem>.OnLoad(SuperOffice.CRM.Archives.ContactList.ContactListQuery, SuperOffice.Data.SoDataReader)
Implements
System.Collections.IEnumerable
System.Collections.Generic.IEnumerable<>
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<>
System.Collections.Generic.ICollection<T>
Extension Methods
EnumUtil.MapEnums<From, To>(From)