Show / Hide Table of Contents

Class ContactList

ContactList implements a collection of the mini contact entity, suitable for displaying in lists.

Inheritance
Object
ListBase<ContactList.ContactListQuery, ContactListItem>
ContactList
Implements
IEnumerable
IEnumerable<ContactListItem>
IList
ICollection
IList<ContactListItem>
ICollection<ContactListItem>
Inherited Members
ListBase<ContactList.ContactListQuery, ContactListItem>.CopyTo(Array, Int32)
ListBase<ContactList.ContactListQuery, ContactListItem>.CopyTo(ContactListItem[], Int32)
ListBase<ContactList.ContactListQuery, ContactListItem>.IndexOf(ContactListItem)
ListBase<ContactList.ContactListQuery, ContactListItem>.Contains(ContactListItem)
ListBase<ContactList.ContactListQuery, ContactListItem>.OnLoad(ContactList.ContactListQuery, SoDataReader)
ListBase<ContactList.ContactListQuery, ContactListItem>.GetEnumerator()
ListBase<ContactList.ContactListQuery, ContactListItem>.Item[Int32]
ListBase<ContactList.ContactListQuery, ContactListItem>.ListCollection
ListBase<ContactList.ContactListQuery, ContactListItem>.Count
ListBase<ContactList.ContactListQuery, ContactListItem>.IsFixedSize
ListBase<ContactList.ContactListQuery, ContactListItem>.IsReadOnly
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
Int32 contactId

The contact

Returns
Type Description
Boolean

True/false

Remarks

A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.

See Also
ContactListItem
Contact

GetContact(Int32)

Returns the contact described by the contact_id.

Declaration
public Contact GetContact(int contactId)
Parameters
Type Name Description
Int32 contactId

The person in question

Returns
Type Description
Contact

The contact

Remarks

A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.

See Also
ContactListItem
Contact

GetContactListItem(Int32)

Will return the ContactListItem described by the contactId.

Declaration
public ContactListItem GetContactListItem(int contactId)
Parameters
Type Name Description
Int32 contactId

The contact

Returns
Type Description
ContactListItem

The contact.

Remarks

A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.

See Also
ContactListItem
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
Int32

The index of the ContactListItem.

Remarks

A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.

See Also
ContactListItem
Contact

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)
Remarks

A ContactList contains many contact list items. Each item is a sub-set of a full contact entity.

See Also
ContactListItem
Contact

Implements

System.Collections.IEnumerable
System.Collections.Generic.IEnumerable<T>
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)

See Also

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