Class ElementProfileRows
The new (4.0) profile table. Contains profile for a single Html-element. Connected through element_profile_link Collection of ElementProfileRow. Each element of the collection represents one row in the ElementProfile table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ElementProfileRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
Remarks
Row 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
ElementProfileRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) ElementProfileRows ElementProfileRows.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(ElementProfileRows.CustomSearch) method to apply the query to the database and obtain the result as a Rows 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.
Properties
Item[Int32]
Get a ElementProfileRow given its index in the collection.
Declaration
public ElementProfileRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of the ElementProfileRow in the collection |
Property Value
Type | Description |
---|---|
ElementProfileRow |
Methods
Add(ElementProfileRow)
Add one ElementProfileRow to the collection.
Declaration
public int Add(ElementProfileRow row)
Parameters
Type | Name | Description |
---|---|---|
ElementProfileRow | row | An instance of ElementProfileRow to be added to the collection. |
Returns
Type | Description |
---|---|
Int32 | The index of the added ElementProfileRow. |
AddNew()
Add a new instance of ElementProfileRow added to the collection.
Declaration
public ElementProfileRow AddNew()
Returns
Type | Description |
---|---|
ElementProfileRow | A new instance of ElementProfileRow added to the collection. |
AddRange(IEnumerable<ElementProfileRow>)
Add a range of ElementProfileRow to the collection.
Declaration
public ElementProfileRows AddRange(IEnumerable<ElementProfileRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<ElementProfileRow> | rows |
Returns
Type | Description |
---|---|
ElementProfileRows | The updated ElementProfileRows collection object. |
CreateChild()
Create a new instance of ElementProfileRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of ElementProfileRow |
Overrides
CreateNew()
Create a new instance of the ElementProfileRows object. This collection will contain no rows.
Declaration
public static ElementProfileRows CreateNew()
Returns
Type | Description |
---|---|
ElementProfileRows | A new instance of the ElementProfileRows object. |
Find(Predicate<ElementProfileRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public ElementProfileRow Find(Predicate<ElementProfileRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ElementProfileRow> | condition |
Returns
Type | Description |
---|---|
ElementProfileRow |
FindAll(Predicate<ElementProfileRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public ElementProfileRows FindAll(Predicate<ElementProfileRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<ElementProfileRow> | condition |
Returns
Type | Description |
---|---|
ElementProfileRows |
ForEach(Action<ElementProfileRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<ElementProfileRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<ElementProfileRow> | whatToDo |
GetFromCustomSearch(ElementProfileRows.CustomSearch)
Create a new instance of the ElementProfileRows 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 ElementProfileRow objects representing each row will be returned.
Declaration
public static ElementProfileRows GetFromCustomSearch(ElementProfileRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ElementProfileRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ElementProfileRows | A new instance of the ElementProfileRows object, reflecting the result of the query. |
GetFromIdxOwnedByUser(Int32)
Create a new instance of the ElementProfileRow object, by querying the database table via the index 'IDXElement_profileOwned_by_user'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ElementProfileRows GetFromIdxOwnedByUser(int ownedByUser)
Parameters
Type | Name | Description |
---|---|---|
Int32 | ownedByUser |
Returns
Type | Description |
---|---|
ElementProfileRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the ElementProfile table. Non-unique indexes have corresponding inner classes and methods in the ElementProfileRows collection, since they may return more than one row.
GetFromIdxScreenDefinitionElement(Int32)
Create a new instance of the ElementProfileRow object, by querying the database table via the index 'IDXElement_profileScreen_definition_element'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ElementProfileRows GetFromIdxScreenDefinitionElement(int screenDefinitionElement)
Parameters
Type | Name | Description |
---|---|---|
Int32 | screenDefinitionElement |
Returns
Type | Description |
---|---|
ElementProfileRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the ElementProfile table. Non-unique indexes have corresponding inner classes and methods in the ElementProfileRows collection, since they may return more than one row.
GetFromReader(SoDataReader, ElementProfileTableInfo)
Create a new instance of the ElementProfileRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of ElementProfileRow objects representing each row will be returned.
Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.
Declaration
public static ElementProfileRows GetFromReader(SoDataReader reader, ElementProfileTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ElementProfileTableInfo | tableInfo | ElementProfileTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object. |
Returns
Type | Description |
---|---|
ElementProfileRows |
Remove(ElementProfileRow)
Removes the given ElementProfileRow from the collection
Declaration
public void Remove(ElementProfileRow row)
Parameters
Type | Name | Description |
---|---|---|
ElementProfileRow | row | the ElementProfileRow to be removed |
ToArray()
Declaration
public ElementProfileRow[] ToArray()
Returns
Type | Description |
---|---|
ElementProfileRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |