Class AudienceVisibilityRows
How projects (or whatever) should be made visible in audience Collection of AudienceVisibilityRow. Each element of the collection represents one row in the AudienceVisibility table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class AudienceVisibilityRows : 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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 AudienceVisibilityRow given its index in the collection.
Declaration
public AudienceVisibilityRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the AudienceVisibilityRow in the collection |
Property Value
Type | Description |
---|---|
AudienceVisibilityRow |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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(AudienceVisibilityRow)
Add one AudienceVisibilityRow to the collection.
Declaration
public int Add(AudienceVisibilityRow row)
Parameters
Type | Name | Description |
---|---|---|
AudienceVisibilityRow | row | An instance of AudienceVisibilityRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added AudienceVisibilityRow. |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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 AudienceVisibilityRow added to the collection.
Declaration
public AudienceVisibilityRow AddNew()
Returns
Type | Description |
---|---|
AudienceVisibilityRow | A new instance of AudienceVisibilityRow 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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<AudienceVisibilityRow>)
Add a range of AudienceVisibilityRow to the collection.
Declaration
public AudienceVisibilityRows AddRange(IEnumerable<AudienceVisibilityRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<AudienceVisibilityRow> | rows |
Returns
Type | Description |
---|---|
AudienceVisibilityRows | The updated AudienceVisibilityRows 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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 AudienceVisibilityRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of AudienceVisibilityRow |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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 AudienceVisibilityRows object. This collection will contain no rows.
Declaration
public static AudienceVisibilityRows CreateNew()
Returns
Type | Description |
---|---|
AudienceVisibilityRows | A new instance of the AudienceVisibilityRows 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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<AudienceVisibilityRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public AudienceVisibilityRow Find(Predicate<AudienceVisibilityRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<AudienceVisibilityRow> | condition |
Returns
Type | Description |
---|---|
AudienceVisibilityRow |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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<AudienceVisibilityRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public AudienceVisibilityRows FindAll(Predicate<AudienceVisibilityRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<AudienceVisibilityRow> | condition |
Returns
Type | Description |
---|---|
AudienceVisibilityRows |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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<AudienceVisibilityRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<AudienceVisibilityRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<AudienceVisibilityRow> | 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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 AudienceVisibilityRows 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 AudienceVisibilityRow objects representing each row will be returned.
Declaration
public static AudienceVisibilityRows GetFromCustomSearch(AudienceVisibilityRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
AudienceVisibilityRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
AudienceVisibilityRows | A new instance of the AudienceVisibilityRows 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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.
GetFromIdxControllingTable(short)
Create a new instance of the AudienceVisibilityRow object, by querying the database table via the index 'IControllingTableControllingRecord'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static AudienceVisibilityRows GetFromIdxControllingTable(short controllingTable)
Parameters
Type | Name | Description |
---|---|---|
short | controllingTable |
Returns
Type | Description |
---|---|
AudienceVisibilityRows | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the AudienceVisibility table. Non-unique indexes have corresponding inner classes and methods in the AudienceVisibilityRows collection, since they may return more than one row.
GetFromIdxControllingTableControllingRecord(short, int)
Create a new instance of the AudienceVisibilityRow object, by querying the database table via the index 'IControllingTableControllingRecord'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static AudienceVisibilityRows GetFromIdxControllingTableControllingRecord(short controllingTable, int controllingRecord)
Parameters
Type | Name | Description |
---|---|---|
short | controllingTable | |
int | controllingRecord |
Returns
Type | Description |
---|---|
AudienceVisibilityRows | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the AudienceVisibility table. Non-unique indexes have corresponding inner classes and methods in the AudienceVisibilityRows collection, since they may return more than one row.
GetFromIdxSourceTable(short)
Create a new instance of the AudienceVisibilityRow object, by querying the database table via the index 'ISourceTableSourceRecord'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static AudienceVisibilityRows GetFromIdxSourceTable(short sourceTable)
Parameters
Type | Name | Description |
---|---|---|
short | sourceTable |
Returns
Type | Description |
---|---|
AudienceVisibilityRows | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the AudienceVisibility table. Non-unique indexes have corresponding inner classes and methods in the AudienceVisibilityRows collection, since they may return more than one row.
GetFromIdxSourceTableSourceRecord(short, int)
Create a new instance of the AudienceVisibilityRow object, by querying the database table via the index 'ISourceTableSourceRecord'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static AudienceVisibilityRows GetFromIdxSourceTableSourceRecord(short sourceTable, int sourceRecord)
Parameters
Type | Name | Description |
---|---|---|
short | sourceTable | |
int | sourceRecord |
Returns
Type | Description |
---|---|
AudienceVisibilityRows | Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table |
Remarks
This method represents one of the unique indexes on the AudienceVisibility table. Non-unique indexes have corresponding inner classes and methods in the AudienceVisibilityRows collection, since they may return more than one row.
GetFromReader(SoDataReader, AudienceVisibilityTableInfo)
Create a new instance of the AudienceVisibilityRows 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 AudienceVisibilityRow 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 AudienceVisibilityRows GetFromReader(SoDataReader reader, AudienceVisibilityTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
AudienceVisibilityTableInfo | tableInfo | AudienceVisibilityTableInfo 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 |
---|---|
AudienceVisibilityRows |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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(AudienceVisibilityRow)
Removes the given AudienceVisibilityRow from the collection
Declaration
public void Remove(AudienceVisibilityRow row)
Parameters
Type | Name | Description |
---|---|---|
AudienceVisibilityRow | row | the AudienceVisibilityRow 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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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()
How projects (or whatever) should be made visible in audience Collection of AudienceVisibilityRow. Each element of the collection represents one row in the AudienceVisibility table.
Declaration
public AudienceVisibilityRow[] ToArray()
Returns
Type | Description |
---|---|
AudienceVisibilityRow[] |
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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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 AudienceVisibilityRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) AudienceVisibilityRows AudienceVisibilityRows.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.