Class SLinkRows

Links in messages to measure success rate of a campaign. Collection of SLinkRow. Each element of the collection represents one row in the SLink table.

Inheritance

Object

NestedPersist

NestedPersistFacade

NestedCollectionPersist

TableRowsBase

SLinkRows

Implements

INestedPersist

IEnumerable<INestedPersist>

ISoCollection

IList

ICollection

IEnumerable

INotifyCollectionChanged

IBindingList

Inherited Members

TableRowsBase._innerList

TableRowsBase._allHasBeenMarkedForDelete

TableRowsBase._sentries

TableRowsBase._idx

TableRowsBase.OnIndexChanged(IdxBase)

TableRowsBase.Load(IdxBase)

TableRowsBase.RowsLoad()

TableRowsBase.RowsLoad(ITableRowLoadHandlerFactory)

TableRowsBase.Delete()

TableRowsBase.GetEnumerator()

TableRowsBase.Add(TableRowBase)

TableRowsBase.Remove(TableRowBase)

TableRowsBase.Clear()

TableRowsBase.Sort(IComparer)

TableRowsBase.GetPrimaryKeys()

TableRowsBase.OnAdded(Object, Int32)

TableRowsBase.ISoCollection.Add(ISoItem)

TableRowsBase.ISoCollection.AddNew()

TableRowsBase.IList.get_Item(Int32)

TableRowsBase.IList.set_Item(Int32, Object)

TableRowsBase.CopyTo(Array, Int32)

TableRowsBase.IList.Add(Object)

TableRowsBase.IList.Remove(Object)

TableRowsBase.IndexOf(Object)

TableRowsBase.Contains(Object)

TableRowsBase.IList.Clear()

TableRowsBase.IList.Insert(Int32, Object)

TableRowsBase.IList.RemoveAt(Int32)

TableRowsBase.AddIndex(PropertyDescriptor)

TableRowsBase.ApplySort(PropertyDescriptor, ListSortDirection)

TableRowsBase.Find(PropertyDescriptor, Object)

TableRowsBase.RemoveIndex(PropertyDescriptor)

TableRowsBase.RemoveSort()

TableRowsBase.Sentries

TableRowsBase.IsDirty

TableRowsBase.Index

TableRowsBase.Count

TableRowsBase.IsMarkedForDelete

TableRowsBase.IList.Item[Int32]

TableRowsBase.ICollection.Count

TableRowsBase.IsFixedSize

TableRowsBase.IsReadOnly

TableRowsBase.ICollection.IsSynchronized

TableRowsBase.ICollection.SyncRoot

TableRowsBase.AllowEdit

TableRowsBase.AllowNew

TableRowsBase.AllowRemove

TableRowsBase.IsSorted

TableRowsBase.SortDirection

TableRowsBase.SortProperty

TableRowsBase.SupportsChangeNotification

TableRowsBase.SupportsSearching

TableRowsBase.SupportsSorting

TableRowsBase._onCollectionChanged

TableRowsBase.CollectionChanged

TableRowsBase.ListChanged

NestedCollectionPersist.GetFacadingItems()

NestedCollectionPersist.IEnumerable<INestedPersist>.GetEnumerator()

NestedCollectionPersist.IsDeleted

NestedPersistFacade.OnPreIdUpdate()

NestedPersistFacade.OnPrimaryKeyRequest(PKContainer)

NestedPersistFacade.OnPrimaryKeyUpdate(PKContainer)

NestedPersistFacade.OnIdUpdate()

NestedPersistFacade.OnSave(BatchSave)

NestedPersistFacade.OnSaved(Boolean)

NestedPersist._saveOwner

NestedPersist._isSaving

NestedPersist.SetSaveOwner(INestedPersist)

NestedPersist.Save()

NestedPersist.INestedPersist.OnPreIdUpdate()

NestedPersist.INestedPersist.OnPrimaryKeyRequest(PKContainer)

NestedPersist.INestedPersist.OnPrimaryKeyUpdate(PKContainer)

NestedPersist.INestedPersist.OnIdUpdate()

NestedPersist.INestedPersist.OnSave(BatchSave)

NestedPersist.INestedPersist.OnSaved(Boolean)

NestedPersist.IsSaving

NestedPersist.OnElementSaved

NestedPersist.OnElementIdUpdate

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class SLinkRows : 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 SLinkRow to it, and use methods like to operate on the whole collection.
• You can create a (nested) SLinkRows SLinkRows.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(SLinkRows.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 SLinkRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SLinkTableInfo) 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 SLinkRow given its index in the collection.

Declaration

public SLinkRow this[int index] { get; }

Parameters

Type	Name	Description
Int32	index	Index of the SLinkRow in the collection

Property Value

Type	Description
SLinkRow

Methods

Add(SLinkRow)

Add one SLinkRow to the collection.

Declaration

public int Add(SLinkRow row)

Parameters

Type	Name	Description
SLinkRow	row	An instance of SLinkRow to be added to the collection.

Returns

Type	Description
Int32	The index of the added SLinkRow.

AddNew()

Add a new instance of SLinkRow added to the collection.

Declaration

public SLinkRow AddNew()

Returns

Type	Description
SLinkRow	A new instance of SLinkRow added to the collection.

AddRange(IEnumerable<SLinkRow>)

Add a range of SLinkRow to the collection.

Declaration

public SLinkRows AddRange(IEnumerable<SLinkRow> rows)

Parameters

Type	Name	Description
IEnumerable<SLinkRow>	rows

Returns

Type	Description
SLinkRows	The updated SLinkRows collection object.

CreateChild()

Create a new instance of SLinkRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of SLinkRow

Overrides

TableRowsBase.CreateChild()

CreateNew()

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

Declaration

public static SLinkRows CreateNew()

Returns

Type	Description
SLinkRows	A new instance of the SLinkRows object.

Find(Predicate<SLinkRow>)

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

Declaration

public SLinkRow Find(Predicate<SLinkRow> condition)

Parameters

Type	Name	Description
Predicate<SLinkRow>	condition

Returns

Type	Description
SLinkRow

FindAll(Predicate<SLinkRow>)

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

Declaration

public SLinkRows FindAll(Predicate<SLinkRow> condition)

Parameters

Type	Name	Description
Predicate<SLinkRow>	condition

Returns

Type	Description
SLinkRows

ForEach(Action<SLinkRow>)

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

Declaration

public void ForEach(Action<SLinkRow> whatToDo)

Parameters

Type	Name	Description
Action<SLinkRow>	whatToDo

GetFromCustomSearch(SLinkRows.CustomSearch)

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

Declaration

public static SLinkRows GetFromCustomSearch(SLinkRows.CustomSearch query)

Parameters

Type	Name	Description
SLinkRows.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
SLinkRows	A new instance of the SLinkRows object, reflecting the result of the query.

GetFromIdxAddContactInterest(Int32)

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

Declaration

public static SLinkRows GetFromIdxAddContactInterest(int addContactInterest)

Parameters

Type	Name	Description
Int32	addContactInterest

Returns

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

GetFromIdxAddContactSelection(Int32)

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

Declaration

public static SLinkRows GetFromIdxAddContactSelection(int addContactSelection)

Parameters

Type	Name	Description
Int32	addContactSelection

Returns

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

GetFromIdxAddPersonInterest(Int32)

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

Declaration

public static SLinkRows GetFromIdxAddPersonInterest(int addPersonInterest)

Parameters

Type	Name	Description
Int32	addPersonInterest

Returns

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

GetFromIdxAddProject(Int32)

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

Declaration

public static SLinkRows GetFromIdxAddProject(int addProject)

Parameters

Type	Name	Description
Int32	addProject

Returns

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

GetFromIdxAddToSelection(Int32)

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

Declaration

public static SLinkRows GetFromIdxAddToSelection(int addToSelection)

Parameters

Type	Name	Description
Int32	addToSelection

Returns

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

GetFromIdxRemoveContactInterest(Int32)

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

Declaration

public static SLinkRows GetFromIdxRemoveContactInterest(int removeContactInterest)

Parameters

Type	Name	Description
Int32	removeContactInterest

Returns

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

GetFromIdxRemoveContactSelection(Int32)

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

Declaration

public static SLinkRows GetFromIdxRemoveContactSelection(int removeContactSelection)

Parameters

Type	Name	Description
Int32	removeContactSelection

Returns

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

GetFromIdxRemoveFromSelection(Int32)

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

Declaration

public static SLinkRows GetFromIdxRemoveFromSelection(int removeFromSelection)

Parameters

Type	Name	Description
Int32	removeFromSelection

Returns

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

GetFromIdxRemovePersonInterest(Int32)

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

Declaration

public static SLinkRows GetFromIdxRemovePersonInterest(int removePersonInterest)

Parameters

Type	Name	Description
Int32	removePersonInterest

Returns

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

GetFromIdxRemoveProject(Int32)

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

Declaration

public static SLinkRows GetFromIdxRemoveProject(int removeProject)

Parameters

Type	Name	Description
Int32	removeProject

Returns

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

GetFromIdxScriptId(Int32)

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

Declaration

public static SLinkRows GetFromIdxScriptId(int scriptId)

Parameters

Type	Name	Description
Int32	scriptId

Returns

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

GetFromIdxTaskAssociateId(Int32)

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

Declaration

public static SLinkRows GetFromIdxTaskAssociateId(int taskAssociateId)

Parameters

Type	Name	Description
Int32	taskAssociateId

Returns

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

GetFromIdxTaskCreatingAssociateId(Int32)

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

Declaration

public static SLinkRows GetFromIdxTaskCreatingAssociateId(int taskCreatingAssociateId)

Parameters

Type	Name	Description
Int32	taskCreatingAssociateId

Returns

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

GetFromIdxTaskIdx(Int32)

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

Declaration

public static SLinkRows GetFromIdxTaskIdx(int taskIdx)

Parameters

Type	Name	Description
Int32	taskIdx

Returns

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

GetFromIdxTaskProject(Int32)

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

Declaration

public static SLinkRows GetFromIdxTaskProject(int taskProject)

Parameters

Type	Name	Description
Int32	taskProject

Returns

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

GetFromIdxTicketCategory(Int32)

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

Declaration

public static SLinkRows GetFromIdxTicketCategory(int ticketCategory)

Parameters

Type	Name	Description
Int32	ticketCategory

Returns

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

GetFromIdxTicketOwnedBy(Int32)

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

Declaration

public static SLinkRows GetFromIdxTicketOwnedBy(int ticketOwnedBy)

Parameters

Type	Name	Description
Int32	ticketOwnedBy

Returns

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

GetFromIdxTicketPriority(Int32)

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

Declaration

public static SLinkRows GetFromIdxTicketPriority(int ticketPriority)

Parameters

Type	Name	Description
Int32	ticketPriority

Returns

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

GetFromReader(SoDataReader, SLinkTableInfo)

Create a new instance of the SLinkRows 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 SLinkRow 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 SLinkRows GetFromReader(SoDataReader reader, SLinkTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
SLinkTableInfo	tableInfo	SLinkTableInfo 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
SLinkRows

Remove(SLinkRow)

Removes the given SLinkRow from the collection

Declaration

public void Remove(SLinkRow row)

Parameters

Type	Name	Description
SLinkRow	row	the SLinkRow to be removed

ToArray()

Declaration

public SLinkRow[] ToArray()

Returns

Type	Description
SLinkRow[]

ToString()

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

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Implements

INestedPersist

System.Collections.Generic.IEnumerable<T>

ISoCollection

System.Collections.IList

System.Collections.ICollection

System.Collections.IEnumerable

System.Collections.Specialized.INotifyCollectionChanged

System.ComponentModel.IBindingList

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)