Class SuperListColumnSizeRows
Stores the relative size (in percent) or in characters of a column in a SuperList Collection of SuperListColumnSizeRow. Each element of the collection represents one row in the SuperListColumnSize table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SuperListColumnSizeRows : 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
SuperListColumnSizeRow to it, and use methods like
to operate on the whole collection. - You can create a (nested) SuperListColumnSizeRows SuperListColumnSizeRows.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(SuperListColumnSizeRows.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 SuperListColumnSizeRow given its index in the collection.
Declaration
public SuperListColumnSizeRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | index | Index of the SuperListColumnSizeRow in the collection |
Property Value
Type | Description |
---|---|
SuperListColumnSizeRow |
Methods
Add(SuperListColumnSizeRow)
Add one SuperListColumnSizeRow to the collection.
Declaration
public int Add(SuperListColumnSizeRow row)
Parameters
Type | Name | Description |
---|---|---|
SuperListColumnSizeRow | row | An instance of SuperListColumnSizeRow to be added to the collection. |
Returns
Type | Description |
---|---|
Int32 | The index of the added SuperListColumnSizeRow. |
AddNew()
Add a new instance of SuperListColumnSizeRow added to the collection.
Declaration
public SuperListColumnSizeRow AddNew()
Returns
Type | Description |
---|---|
SuperListColumnSizeRow | A new instance of SuperListColumnSizeRow added to the collection. |
AddRange(IEnumerable<SuperListColumnSizeRow>)
Add a range of SuperListColumnSizeRow to the collection.
Declaration
public SuperListColumnSizeRows AddRange(IEnumerable<SuperListColumnSizeRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<SuperListColumnSizeRow> | rows |
Returns
Type | Description |
---|---|
SuperListColumnSizeRows | The updated SuperListColumnSizeRows collection object. |
CreateChild()
Create a new instance of SuperListColumnSizeRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of SuperListColumnSizeRow |
Overrides
CreateNew()
Create a new instance of the SuperListColumnSizeRows object. This collection will contain no rows.
Declaration
public static SuperListColumnSizeRows CreateNew()
Returns
Type | Description |
---|---|
SuperListColumnSizeRows | A new instance of the SuperListColumnSizeRows object. |
Find(Predicate<SuperListColumnSizeRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public SuperListColumnSizeRow Find(Predicate<SuperListColumnSizeRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<SuperListColumnSizeRow> | condition |
Returns
Type | Description |
---|---|
SuperListColumnSizeRow |
FindAll(Predicate<SuperListColumnSizeRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public SuperListColumnSizeRows FindAll(Predicate<SuperListColumnSizeRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<SuperListColumnSizeRow> | condition |
Returns
Type | Description |
---|---|
SuperListColumnSizeRows |
ForEach(Action<SuperListColumnSizeRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<SuperListColumnSizeRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<SuperListColumnSizeRow> | whatToDo |
GetFromCustomSearch(SuperListColumnSizeRows.CustomSearch)
Create a new instance of the SuperListColumnSizeRows 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 SuperListColumnSizeRow objects representing each row will be returned.
Declaration
public static SuperListColumnSizeRows GetFromCustomSearch(SuperListColumnSizeRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
SuperListColumnSizeRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
SuperListColumnSizeRows | A new instance of the SuperListColumnSizeRows object, reflecting the result of the query. |
GetFromIdxAssocId(Int32)
Create a new instance of the SuperListColumnSizeRow object, by querying the database table via the index 'IAssoc_idListOwner'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SuperListColumnSizeRows GetFromIdxAssocId(int assocId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | assocId |
Returns
Type | Description |
---|---|
SuperListColumnSizeRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the SuperListColumnSize table. Non-unique indexes have corresponding inner classes and methods in the SuperListColumnSizeRows collection, since they may return more than one row.
GetFromIdxAssocIdListOwner(Int32, String)
Create a new instance of the SuperListColumnSizeRow object, by querying the database table via the index 'IAssoc_idListOwner'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SuperListColumnSizeRows GetFromIdxAssocIdListOwner(int assocId, string listOwner)
Parameters
Type | Name | Description |
---|---|---|
Int32 | assocId | |
String | listOwner |
Returns
Type | Description |
---|---|
SuperListColumnSizeRows | Row object that represents the result of the search. |
Remarks
This method represents one of the unique indexes on the SuperListColumnSize table. Non-unique indexes have corresponding inner classes and methods in the SuperListColumnSizeRows collection, since they may return more than one row.
GetFromReader(SoDataReader, SuperListColumnSizeTableInfo)
Create a new instance of the SuperListColumnSizeRows 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 SuperListColumnSizeRow 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 SuperListColumnSizeRows GetFromReader(SoDataReader reader, SuperListColumnSizeTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
SuperListColumnSizeTableInfo | tableInfo | SuperListColumnSizeTableInfo 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 |
---|---|
SuperListColumnSizeRows |
Remove(SuperListColumnSizeRow)
Removes the given SuperListColumnSizeRow from the collection
Declaration
public void Remove(SuperListColumnSizeRow row)
Parameters
Type | Name | Description |
---|---|---|
SuperListColumnSizeRow | row | the SuperListColumnSizeRow to be removed |
ToArray()
Declaration
public SuperListColumnSizeRow[] ToArray()
Returns
Type | Description |
---|---|
SuperListColumnSizeRow[] |
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
String |