Class KbEntryKeywordRows

This table contains all keywords for the faq entries Collection of KbEntryKeywordRow. Each element of the collection represents one row in the KbEntryKeyword table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
KbEntryKeywordRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class KbEntryKeywordRows : 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 KbEntryKeywordRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) KbEntryKeywordRows KbEntryKeywordRows.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(KbEntryKeywordRows.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 KbEntryKeywordRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, KbEntryKeywordTableInfo) 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 KbEntryKeywordRow given its index in the collection.

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

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

Methods

Add(KbEntryKeywordRow)

Add one KbEntryKeywordRow to the collection.

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

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

The index of the added KbEntryKeywordRow.

AddNew()

Add a new instance of KbEntryKeywordRow added to the collection.

Declaration
public KbEntryKeywordRow AddNew()
Returns
Type Description
KbEntryKeywordRow

A new instance of KbEntryKeywordRow added to the collection.

AddRange(IEnumerable<KbEntryKeywordRow>)

Add a range of KbEntryKeywordRow to the collection.

Declaration
public KbEntryKeywordRows AddRange(IEnumerable<KbEntryKeywordRow> rows)
Parameters
Type Name Description
IEnumerable<KbEntryKeywordRow> rows
Returns
Type Description
KbEntryKeywordRows

The updated KbEntryKeywordRows collection object.

CreateChild()

Create a new instance of KbEntryKeywordRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of KbEntryKeywordRow
Overrides

CreateNew()

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

Declaration
public static KbEntryKeywordRows CreateNew()
Returns
Type Description
KbEntryKeywordRows

A new instance of the KbEntryKeywordRows object.

Find(Predicate<KbEntryKeywordRow>)

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

Declaration
public KbEntryKeywordRow Find(Predicate<KbEntryKeywordRow> condition)
Parameters
Type Name Description
Predicate<KbEntryKeywordRow> condition
Returns
Type Description
KbEntryKeywordRow

FindAll(Predicate<KbEntryKeywordRow>)

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

Declaration
public KbEntryKeywordRows FindAll(Predicate<KbEntryKeywordRow> condition)
Parameters
Type Name Description
Predicate<KbEntryKeywordRow> condition
Returns
Type Description
KbEntryKeywordRows

ForEach(Action<KbEntryKeywordRow>)

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

Declaration
public void ForEach(Action<KbEntryKeywordRow> whatToDo)
Parameters
Type Name Description
Action<KbEntryKeywordRow> whatToDo

GetFromCustomSearch(KbEntryKeywordRows.CustomSearch)

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

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

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

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

GetFromIdxKbEntryId(Int32)

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

Declaration
public static KbEntryKeywordRows GetFromIdxKbEntryId(int kbEntryId)
Parameters
Type Name Description
Int32 kbEntryId
Returns
Type Description
KbEntryKeywordRows

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 KbEntryKeyword table. Non-unique indexes have corresponding inner classes and methods in the KbEntryKeywordRows collection, since they may return more than one row.

GetFromIdxKeyword(String)

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

Declaration
public static KbEntryKeywordRows GetFromIdxKeyword(string keyword)
Parameters
Type Name Description
String keyword
Returns
Type Description
KbEntryKeywordRows

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 KbEntryKeyword table. Non-unique indexes have corresponding inner classes and methods in the KbEntryKeywordRows collection, since they may return more than one row.

GetFromReader(SoDataReader, KbEntryKeywordTableInfo)

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

SoDataReader positioned to a valid database row.
KbEntryKeywordTableInfo tableInfo

KbEntryKeywordTableInfo 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
KbEntryKeywordRows

Remove(KbEntryKeywordRow)

Removes the given KbEntryKeywordRow from the collection

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

the KbEntryKeywordRow to be removed

ToArray()

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

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)