Class AudienceLayoutRows
One layout (of webparts and other stuff) for an audience instance Collection of AudienceLayoutRow. Each element of the collection represents one row in the AudienceLayout table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AudienceLayoutRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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
this[int]
Get a AudienceLayoutRow given its index in the collection.
Declaration
public AudienceLayoutRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the AudienceLayoutRow in the collection |
Property Value
Type | Description |
---|---|
AudienceLayoutRow |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
Methods
Add(AudienceLayoutRow)
Add one AudienceLayoutRow to the collection.
Declaration
public int Add(AudienceLayoutRow row)
Parameters
Type | Name | Description |
---|---|---|
AudienceLayoutRow | row | An instance of AudienceLayoutRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added AudienceLayoutRow. |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
AddNew()
Add a new instance of AudienceLayoutRow added to the collection.
Declaration
public AudienceLayoutRow AddNew()
Returns
Type | Description |
---|---|
AudienceLayoutRow | A new instance of AudienceLayoutRow added to the collection. |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
AddRange(IEnumerable<AudienceLayoutRow>)
Add a range of AudienceLayoutRow to the collection.
Declaration
public AudienceLayoutRows AddRange(IEnumerable<AudienceLayoutRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<AudienceLayoutRow> | rows |
Returns
Type | Description |
---|---|
AudienceLayoutRows | The updated AudienceLayoutRows collection object. |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
CreateChild()
Create a new instance of AudienceLayoutRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of AudienceLayoutRow |
Overrides
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
CreateNew()
Create a new instance of the AudienceLayoutRows object. This collection will contain no rows.
Declaration
public static AudienceLayoutRows CreateNew()
Returns
Type | Description |
---|---|
AudienceLayoutRows | A new instance of the AudienceLayoutRows object. |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
Find(Predicate<AudienceLayoutRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public AudienceLayoutRow Find(Predicate<AudienceLayoutRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<AudienceLayoutRow> | condition |
Returns
Type | Description |
---|---|
AudienceLayoutRow |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
FindAll(Predicate<AudienceLayoutRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public AudienceLayoutRows FindAll(Predicate<AudienceLayoutRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<AudienceLayoutRow> | condition |
Returns
Type | Description |
---|---|
AudienceLayoutRows |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
ForEach(Action<AudienceLayoutRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<AudienceLayoutRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<AudienceLayoutRow> | whatToDo |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the AudienceLayoutRows 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 AudienceLayoutRow objects representing each row will be returned.
Declaration
public static AudienceLayoutRows GetFromCustomSearch(AudienceLayoutRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
AudienceLayoutRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
AudienceLayoutRows | A new instance of the AudienceLayoutRows object, reflecting the result of the query. |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
GetFromReader(SoDataReader, AudienceLayoutTableInfo)
Create a new instance of the AudienceLayoutRows 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 AudienceLayoutRow 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 AudienceLayoutRows GetFromReader(SoDataReader reader, AudienceLayoutTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
AudienceLayoutTableInfo | tableInfo | AudienceLayoutTableInfo 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 |
---|---|
AudienceLayoutRows |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
Remove(AudienceLayoutRow)
Removes the given AudienceLayoutRow from the collection
Declaration
public void Remove(AudienceLayoutRow row)
Parameters
Type | Name | Description |
---|---|---|
AudienceLayoutRow | row | the AudienceLayoutRow to be removed |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
ToArray()
One layout (of webparts and other stuff) for an audience instance Collection of AudienceLayoutRow. Each element of the collection represents one row in the AudienceLayout table.
Declaration
public AudienceLayoutRow[] ToArray()
Returns
Type | Description |
---|---|
AudienceLayoutRow[] |
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
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 AudienceLayoutRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceLayoutRows AudienceLayoutRows.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 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.