Class ContactCollection
Companies and Organisations.
This table features a special record containing information about the contact that owns the database.
Collection of Contact. Each element of the collection represents one entity based on Contact.Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class ContactCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
Constructors
ContactCollection(ContactCollectionIdx)
Constructor for class ContactCollection.
This object represents a collection of rows in table 'contact'.
Table contact: Companies and Organisations
Declaration
protected ContactCollection(ContactCollection.ContactCollectionIdx idx)
Parameters
| Type | Name | Description |
|---|---|---|
| ContactCollection.ContactCollectionIdx | idx |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
Fields
_idx
Fetcher class the collection is based on
Declaration
protected ContactCollection.ContactCollectionIdx _idx
Field Value
| Type | Description |
|---|---|
| ContactCollection.ContactCollectionIdx |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
_rows
Row objects that the collection is based on.
Declaration
protected ContactRows _rows
Field Value
| Type | Description |
|---|---|
| ContactRows |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
Properties
Index
Retrieve the index for ContactCollection
Declaration
public ContactCollection.ContactCollectionIdx Index { get; }
Property Value
| Type | Description |
|---|---|
| ContactCollection.ContactCollectionIdx |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
this[int]
Get a Contact from the collection from its zero-based index.
Declaration
public Contact this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Zero-based index in the collection. |
Property Value
| Type | Description |
|---|---|
| Contact |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
Rows
The ecapsulated object ContactRows.
Declaration
public ContactRows Rows { get; }
Property Value
| Type | Description |
|---|---|
| ContactRows |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
Sentries
The collection of sentries that are guarding this collection of rows. This collection is used by RDB entities which return HDB collections.
For example, the contact.Faxes returns a PhoneRows collection in which each row will need to check the contact's sentry for permission to read/write their field
Declaration
public override SentryCollection Sentries { get; }
Property Value
| Type | Description |
|---|---|
| SentryCollection |
Overrides
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
Methods
Add(Contact)
Add one Contact to the collection.
Declaration
public int Add(Contact contact)
Parameters
| Type | Name | Description |
|---|---|---|
| Contact | contact | An instance of Contact to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added Contact. |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
AddNew()
Get a new instance of Contact added to the collection.
Declaration
public Contact AddNew()
Returns
| Type | Description |
|---|---|
| Contact | A new instance of Contact added to the collection. |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
CreateChild()
Create a new instance of Contact
Declaration
protected override EntityBase CreateChild()
Returns
| Type | Description |
|---|---|
| EntityBase | New instance of Contact |
Overrides
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
CreateNew()
Create a new instance of the ContactCollection.
Declaration
public static ContactCollection CreateNew()
Returns
| Type | Description |
|---|---|
| ContactCollection | A new instance of the ContactCollection. |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the ContactCollection object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of ContactRow objects representing each row will be returned.
Declaration
public static Task<ContactCollection> GetFromCustomSearchAsync(ContactCollection.CustomSearch query, CancellationToken cancellationToken)
Parameters
| Type | Name | Description |
|---|---|---|
| ContactCollection.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | A new instance of the ContactCollection object, reflecting the result of the query. |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
GetFromIdxBusinessIdxAsync(int, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxBusinessIdxAsync(int businessIdx, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | businessIdx | List: business |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContBusn_idx. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxCategoryIdxAsync(int, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxCategoryIdxAsync(int categoryIdx, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | categoryIdx | List: category |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContCatg_idx. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxDepartmentAsync(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxDepartmentAsync(string department, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | department | Department |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContDept. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxKananameAsync(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxKananameAsync(string kananame, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | kananame | JPN |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContKname. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxMotherIdAsync(int, CancellationToken)
Companies and Organisations.
This table features a special record containing information about the contact that owns the database.
Collection of Contact. Each element of the collection represents one entity based on Contact.Declaration
public static Task<ContactCollection> GetFromIdxMotherIdAsync(int motherId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | motherId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
GetFromIdxNameAsync(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxNameAsync(string name, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContName. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxNameDepartmentAsync(string, string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxNameDepartmentAsync(string name, string department, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | Name |
| string | department | Department |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index INameDept. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxNumber1Async(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxNumber1Async(string number1, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | number1 | Alphanumeric user field, contains auto-assigned number if numbering is in use. |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContNum1. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxNumber2Async(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxNumber2Async(string number2, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | number2 | Alphanumeric user field |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContNum2. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxOrgNrAsync(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxOrgNrAsync(string orgNr, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | orgNr | VAT number or similar, takes dynamic lead text from Country table |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContOrgNr. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxSoundExAsync(string, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxSoundExAsync(string soundEx, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | soundEx | What the name sounds like, for duplicate detection |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContSoundEx. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxSourceAsync(short, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxSourceAsync(short source, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| short | source | How did we get this contact? For future integration needs |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContSource. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxUserdef2IdAsync(int, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxUserdef2IdAsync(int userdef2Id, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | userdef2Id | User-defined table record 2 |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContUdef2_id. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
GetFromIdxUserdefIdAsync(int, CancellationToken)
Create a new instance of the ContactRows object, and populate it with ContactRow objects based on the result of a query on the table Contact. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<ContactCollection> GetFromIdxUserdefIdAsync(int userdefId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | userdefId | User-defined table record 1 |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<ContactCollection> | New ContactRows collection containing the result of the index query. If no rows matched, the collection will be empty. |
Remarks
The query matches the fields on the non-unique index IDXContUdef_id. Unique indexes have corresponding Create methods directly on the ContactRow object, since such indexes always return zero or one rows.
Remove(Contact)
Removes the given Contact from the collection
Declaration
public void Remove(Contact contact)
Parameters
| Type | Name | Description |
|---|---|---|
| Contact | contact | the Contact to be removed |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
ToArray()
Companies and Organisations.
This table features a special record containing information about the contact that owns the database.
Collection of Contact. Each element of the collection represents one entity based on Contact.Declaration
public Contact[] ToArray()
Returns
| Type | Description |
|---|---|
| Contact[] |
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
| Type | Description |
|---|---|
| string |
Overrides
Remarks
Entity collections can be created in several ways.
- Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SuperOffice.CRM.Rows.Contact to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ContactCollection ContactCollection.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch method to apply the query to the database and obtain the result as an EntityCollection object, with one item for each table row that matched your query.
- For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.
| Index fields | Nested index class name |
|---|---|
| ContactId | ContactId: Primary key Nested index class: Contact.IdxContactIdStatic Get method: GetFromIdxContactId(int) |
| Index fields | Nested index class name |
|---|---|
| SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ContactCollection.IdxSoundExStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSoundEx |
| Kananame | Kananame: JPN Nested index class: ContactCollection.IdxKananameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxKananame |
| MotherId | MotherId: <not used> Nested index class: ContactCollection.IdxMotherIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxMotherId |
| BusinessIdx | BusinessIdx: List: business Nested index class: ContactCollection.IdxBusinessIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxBusinessIdx |
| Name | Name: Name Nested index class: ContactCollection.IdxNameStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxName |
| UserdefId | UserdefId: User-defined table record 1 Nested index class: ContactCollection.IdxUserdefIdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdefId |
| OrgNr | OrgNr: VAT number or similar, takes dynamic lead text from Country table Nested index class: ContactCollection.IdxOrgNrStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxOrgNr |
| Number1 | Number1: Alphanumeric user field, contains auto-assigned number if numbering is in use. Nested index class: ContactCollection.IdxNumber1Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber1 |
| Number2 | Number2: Alphanumeric user field Nested index class: ContactCollection.IdxNumber2Static Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNumber2 |
| Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ContactCollection.IdxUserdef2IdStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxUserdef2Id |
| Department | Department: Department Nested index class: ContactCollection.IdxDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxDepartment |
| Name, Department | Name: Name Department:Department Nested index class: ContactCollection.IdxNameDepartmentStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxNameDepartment |
| CategoryIdx | CategoryIdx: List: category Nested index class: ContactCollection.IdxCategoryIdxStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxCategoryIdx |
| Source | Source: How did we get this contact? For future integration needs Nested index class: ContactCollection.IdxSourceStatic Get method: SuperOffice.CRM.Entities.ContactCollection.GetFromIdxSource |