Class SPictureFolderRows

This table contains all picture folders Collection of SPictureFolderRow. Each element of the collection represents one row in the SPictureFolder table.

Inheritance
System.Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
SPictureFolderRows
Implements
System.Collections.Generic.IEnumerable<INestedPersist>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SPictureFolderRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IEnumerable, IList, ICollection, 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 SPictureFolderRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) SPictureFolderRows SPictureFolderRows.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(SPictureFolderRows.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.
Unique indexes are handled through the SPictureFolderRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SPictureFolderTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

Item[Int32]

Get a SPictureFolderRow given its index in the collection.

Declaration
public SPictureFolderRow this[int index] { get; }
Parameters
Type Name Description
System.Int32 index

Index of the SPictureFolderRow in the collection
Property Value
Type Description
SPictureFolderRow

Methods

Add(SPictureFolderRow)

Add one SPictureFolderRow to the collection.

Declaration
public int Add(SPictureFolderRow row)
Parameters
Type Name Description
SPictureFolderRow row

An instance of SPictureFolderRow to be added to the collection.
Returns
Type Description
System.Int32

The index of the added SPictureFolderRow.

AddNew()

Add a new instance of SPictureFolderRow added to the collection.

Declaration
public SPictureFolderRow AddNew()
Returns
Type Description
SPictureFolderRow

A new instance of SPictureFolderRow added to the collection.

AddRange(IEnumerable<SPictureFolderRow>)

Add a range of SPictureFolderRow to the collection.

Declaration
public SPictureFolderRows AddRange(IEnumerable<SPictureFolderRow> rows)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<SPictureFolderRow> rows
Returns
Type Description
SPictureFolderRows

The updated SPictureFolderRows collection object.

CreateChild()

Create a new instance of SPictureFolderRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SPictureFolderRow
Overrides

CreateNew()

Create a new instance of the SPictureFolderRows object. This collection will contain no rows.

Declaration
public static SPictureFolderRows CreateNew()
Returns
Type Description
SPictureFolderRows

A new instance of the SPictureFolderRows object.

Find(Predicate<SPictureFolderRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration
public SPictureFolderRow Find(Predicate<SPictureFolderRow> condition)
Parameters
Type Name Description
System.Predicate<SPictureFolderRow> condition
Returns
Type Description
SPictureFolderRow

FindAll(Predicate<SPictureFolderRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration
public SPictureFolderRows FindAll(Predicate<SPictureFolderRow> condition)
Parameters
Type Name Description
System.Predicate<SPictureFolderRow> condition
Returns
Type Description
SPictureFolderRows

ForEach(Action<SPictureFolderRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration
public void ForEach(Action<SPictureFolderRow> whatToDo)
Parameters
Type Name Description
System.Action<SPictureFolderRow> whatToDo

GetFromCustomSearch(SPictureFolderRows.CustomSearch)

Create a new instance of the SPictureFolderRows 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 SPictureFolderRow objects representing each row will be returned.

Declaration
public static SPictureFolderRows GetFromCustomSearch(SPictureFolderRows.CustomSearch query)
Parameters
Type Name Description
SPictureFolderRows.CustomSearch query

The custom search to execute against the database
Returns
Type Description
SPictureFolderRows

A new instance of the SPictureFolderRows object, reflecting the result of the query.

GetFromIdxFolderType(Int16)

Create a new instance of the SPictureFolderRow object, by querying the database table via the index 'IDXS_picture_folderFolder_type'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static SPictureFolderRows GetFromIdxFolderType(short folderType)
Parameters
Type Name Description
System.Int16 folderType
Returns
Type Description
SPictureFolderRows

Row object that represents the result of the search. 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 SPictureFolder table. Non-unique indexes have corresponding inner classes and methods in the SPictureFolderRows collection, since they may return more than one row.

GetFromIdxParentId(Int32)

Create a new instance of the SPictureFolderRow object, by querying the database table via the index 'IParent_idFolder_type'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static SPictureFolderRows GetFromIdxParentId(int parentId)
Parameters
Type Name Description
System.Int32 parentId
Returns
Type Description
SPictureFolderRows

Row object that represents the result of the search. 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 SPictureFolder table. Non-unique indexes have corresponding inner classes and methods in the SPictureFolderRows collection, since they may return more than one row.

GetFromIdxParentIdFolderType(Int32, Int16)

Create a new instance of the SPictureFolderRow object, by querying the database table via the index 'IParent_idFolder_type'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static SPictureFolderRows GetFromIdxParentIdFolderType(int parentId, short folderType)
Parameters
Type Name Description
System.Int32 parentId
System.Int16 folderType
Returns
Type Description
SPictureFolderRows

Row object that represents the result of the search. 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 SPictureFolder table. Non-unique indexes have corresponding inner classes and methods in the SPictureFolderRows collection, since they may return more than one row.

GetFromReader(SoDataReader, SPictureFolderTableInfo)

Create a new instance of the SPictureFolderRows 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 SPictureFolderRow 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 SPictureFolderRows GetFromReader(SoDataReader reader, SPictureFolderTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
SPictureFolderTableInfo tableInfo

SPictureFolderTableInfo 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
SPictureFolderRows

Remove(SPictureFolderRow)

Removes the given SPictureFolderRow from the collection

Declaration
public void Remove(SPictureFolderRow row)
Parameters
Type Name Description
SPictureFolderRow row

the SPictureFolderRow to be removed

ToArray()

Declaration
public SPictureFolderRow[] ToArray()
Returns
Type Description
SPictureFolderRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
System.String

Implements

System.Collections.Generic.IEnumerable<>
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)