Class ProjectCollection
Projects
Collection of Project. Each element of the collection represents one entity based on Project.Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Entities
Assembly: SoDataBase.dll
Syntax
public class ProjectCollection : EntityCollectionBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, 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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
Constructors
ProjectCollection(ProjectCollectionIdx)
Constructor for class ProjectCollection.
This object represents a collection of rows in table 'project'.
Table contact: Projects
Declaration
protected ProjectCollection(ProjectCollection.ProjectCollectionIdx idx)
Parameters
Type | Name | Description |
---|---|---|
ProjectCollection.ProjectCollectionIdx | 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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
Fields
_idx
Fetcher class the collection is based on
Declaration
protected ProjectCollection.ProjectCollectionIdx _idx
Field Value
Type | Description |
---|---|
ProjectCollection.ProjectCollectionIdx |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
_rows
Row objects that the collection is based on.
Declaration
protected ProjectRows _rows
Field Value
Type | Description |
---|---|
ProjectRows |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
Properties
Index
Retrieve the index for ProjectCollection
Declaration
public ProjectCollection.ProjectCollectionIdx Index { get; }
Property Value
Type | Description |
---|---|
ProjectCollection.ProjectCollectionIdx |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
this[int]
Get a Project from the collection from its zero-based index.
Declaration
public Project this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Zero-based index in the collection. |
Property Value
Type | Description |
---|---|
Project |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
Rows
The ecapsulated object ProjectRows.
Declaration
public ProjectRows Rows { get; }
Property Value
Type | Description |
---|---|
ProjectRows |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
Methods
Add(Project)
Add one Project to the collection.
Declaration
public int Add(Project project)
Parameters
Type | Name | Description |
---|---|---|
Project | project | An instance of Project to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added Project. |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
AddNew()
Get a new instance of Project added to the collection.
Declaration
public Project AddNew()
Returns
Type | Description |
---|---|
Project | A new instance of Project 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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
CreateChild()
Create a new instance of Project
Declaration
protected override EntityBase CreateChild()
Returns
Type | Description |
---|---|
EntityBase | New instance of Project |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
CreateNew()
Create a new instance of the ProjectCollection.
Declaration
public static ProjectCollection CreateNew()
Returns
Type | Description |
---|---|
ProjectCollection | A new instance of the ProjectCollection. |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
GetFromCustomSearch(CustomSearch)
Create a new instance of the ProjectCollection 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 ProjectRow objects representing each row will be returned.
Declaration
public static ProjectCollection GetFromCustomSearch(ProjectCollection.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ProjectCollection.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ProjectCollection | A new instance of the ProjectCollection 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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
GetFromIdxName(string)
Create a new instance of the ProjectRows object, and populate it with ProjectRow objects based on the result of a query on the table Project. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProjectCollection GetFromIdxName(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | Project name |
Returns
Type | Description |
---|---|
ProjectCollection | New ProjectRows 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 IDXProjName. Unique indexes have corresponding Create methods directly on the ProjectRow object, since such indexes always return zero or one rows.
GetFromIdxProjectNumber(string)
Create a new instance of the ProjectRows object, and populate it with ProjectRow objects based on the result of a query on the table Project. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProjectCollection GetFromIdxProjectNumber(string projectNumber)
Parameters
Type | Name | Description |
---|---|---|
string | projectNumber | Automatically generated number |
Returns
Type | Description |
---|---|
ProjectCollection | New ProjectRows 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 IDXProjPnum. Unique indexes have corresponding Create methods directly on the ProjectRow object, since such indexes always return zero or one rows.
GetFromIdxSoundEx(string)
Create a new instance of the ProjectRows object, and populate it with ProjectRow objects based on the result of a query on the table Project. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProjectCollection GetFromIdxSoundEx(string soundEx)
Parameters
Type | Name | Description |
---|---|---|
string | soundEx | What the name sounds like, for duplicate detection |
Returns
Type | Description |
---|---|
ProjectCollection | New ProjectRows 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 IDXProjSoundEx. Unique indexes have corresponding Create methods directly on the ProjectRow object, since such indexes always return zero or one rows.
GetFromIdxSource(short)
Create a new instance of the ProjectRows object, and populate it with ProjectRow objects based on the result of a query on the table Project. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProjectCollection GetFromIdxSource(short source)
Parameters
Type | Name | Description |
---|---|---|
short | source | How did we get this project? For future integration needs |
Returns
Type | Description |
---|---|
ProjectCollection | New ProjectRows 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 IDXProjSource. Unique indexes have corresponding Create methods directly on the ProjectRow object, since such indexes always return zero or one rows.
GetFromIdxUserdef2Id(int)
Create a new instance of the ProjectRows object, and populate it with ProjectRow objects based on the result of a query on the table Project. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProjectCollection GetFromIdxUserdef2Id(int userdef2Id)
Parameters
Type | Name | Description |
---|---|---|
int | userdef2Id | User-defined table record 2 |
Returns
Type | Description |
---|---|
ProjectCollection | New ProjectRows 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 IDXProjUdef2_id. Unique indexes have corresponding Create methods directly on the ProjectRow object, since such indexes always return zero or one rows.
Remove(Project)
Removes the given Project from the collection
Declaration
public void Remove(Project project)
Parameters
Type | Name | Description |
---|---|---|
Project | project | the Project 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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
ToArray()
Projects
Collection of Project. Each element of the collection represents one entity based on Project.Declaration
public Project[] ToArray()
Returns
Type | Description |
---|---|
Project[] |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |
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.Project to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) ProjectCollection ProjectCollection.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(CustomSearch) 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 |
---|---|
ProjectId | ProjectId: Primary key Nested index class: Project.IdxProjectIdStatic Get method: GetFromIdxProjectId(int) |
Index fields | Nested index class name |
---|---|
SoundEx | SoundEx: What the name sounds like, for duplicate detection Nested index class: ProjectCollection.IdxSoundExStatic Get method: GetFromIdxSoundEx(string) |
Source | Source: How did we get this project? For future integration needs Nested index class: ProjectCollection.IdxSourceStatic Get method: GetFromIdxSource(short) |
ProjectNumber | ProjectNumber: Automatically generated number Nested index class: ProjectCollection.IdxProjectNumberStatic Get method: GetFromIdxProjectNumber(string) |
Userdef2Id | Userdef2Id: User-defined table record 2 Nested index class: ProjectCollection.IdxUserdef2IdStatic Get method: GetFromIdxUserdef2Id(int) |
Name | Name: Project name Nested index class: ProjectCollection.IdxNameStatic Get method: GetFromIdxName(string) |