Show / Hide Table of Contents

Class SoapAccessRows

Table that contains constraints on the access to the soap interface Collection of SoapAccessRow. Each element of the collection represents one row in the SoapAccess table.

Inheritance
object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
SoapAccessRows
Implements
INestedPersist
IEnumerable<INestedPersist>
INotifyCollectionChanged
IBindingList
IList
ICollection
IEnumerable
Inherited Members
TableRowsBase._innerList
TableRowsBase._allHasBeenMarkedForDelete
TableRowsBase._sentries
TableRowsBase._idx
TableRowsBase.OnIndexChanged(IdxBase)
TableRowsBase.LoadAsync(IdxBase, CancellationToken)
TableRowsBase.RowsLoadAsync(CancellationToken)
TableRowsBase.RowsLoadAsync(ITableRowLoadHandlerFactory, CancellationToken)
TableRowsBase.DeleteAsync()
TableRowsBase.GetEnumerator()
TableRowsBase.Add(TableRowBase)
TableRowsBase.Remove(TableRowBase)
TableRowsBase.Clear()
TableRowsBase.Sort(IComparer)
TableRowsBase.GetPrimaryKeys()
TableRowsBase.OnAdded(object, int)
TableRowsBase.CopyTo(Array, int)
TableRowsBase.IndexOf(object)
TableRowsBase.Contains(object)
TableRowsBase.AddIndex(PropertyDescriptor)
TableRowsBase.ApplySort(PropertyDescriptor, ListSortDirection)
TableRowsBase.Find(PropertyDescriptor, object)
TableRowsBase.RemoveIndex(PropertyDescriptor)
TableRowsBase.RemoveSort()
TableRowsBase.Load(IdxBase)
TableRowsBase.RowsLoad()
TableRowsBase.RowsLoad(ITableRowLoadHandlerFactory)
TableRowsBase.Sentries
TableRowsBase.IsDirty
TableRowsBase.Index
TableRowsBase.Count
TableRowsBase.IsMarkedForDelete
TableRowsBase.IsFixedSize
TableRowsBase.IsReadOnly
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.IsDeleted
NestedPersistFacade.OnPreIdUpdateAsync()
NestedPersistFacade.OnPrimaryKeyRequestAsync(PKContainer)
NestedPersistFacade.OnPrimaryKeyUpdateAsync(PKContainer)
NestedPersistFacade.OnIdUpdateAsync()
NestedPersistFacade.OnSaveAsync(BatchSave)
NestedPersistFacade.OnSavedAsync(bool)
NestedPersist._saveOwner
NestedPersist._isSaving
NestedPersist.SetSaveOwner(INestedPersist)
NestedPersist.SaveAsync()
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 SoapAccessRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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

this[int]

Get a SoapAccessRow given its index in the collection.

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

Index of the SoapAccessRow in the collection

Property Value
Type Description
SoapAccessRow
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

Methods

Add(SoapAccessRow)

Add one SoapAccessRow to the collection.

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

An instance of SoapAccessRow to be added to the collection.

Returns
Type Description
int

The index of the added SoapAccessRow.

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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

AddNew()

Add a new instance of SoapAccessRow added to the collection.

Declaration
public SoapAccessRow AddNew()
Returns
Type Description
SoapAccessRow

A new instance of SoapAccessRow 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

AddRange(IEnumerable<SoapAccessRow>)

Add a range of SoapAccessRow to the collection.

Declaration
public SoapAccessRows AddRange(IEnumerable<SoapAccessRow> rows)
Parameters
Type Name Description
IEnumerable<SoapAccessRow> rows
Returns
Type Description
SoapAccessRows

The updated SoapAccessRows 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

CreateChild()

Create a new instance of SoapAccessRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of SoapAccessRow

Overrides
TableRowsBase.CreateChild()
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

CreateNew()

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

Declaration
public static SoapAccessRows CreateNew()
Returns
Type Description
SoapAccessRows

A new instance of the SoapAccessRows 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

Find(Predicate<SoapAccessRow>)

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

Declaration
public SoapAccessRow Find(Predicate<SoapAccessRow> condition)
Parameters
Type Name Description
Predicate<SoapAccessRow> condition
Returns
Type Description
SoapAccessRow
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

FindAll(Predicate<SoapAccessRow>)

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

Declaration
public SoapAccessRows FindAll(Predicate<SoapAccessRow> condition)
Parameters
Type Name Description
Predicate<SoapAccessRow> condition
Returns
Type Description
SoapAccessRows
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

ForEach(Action<SoapAccessRow>)

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

Declaration
public void ForEach(Action<SoapAccessRow> whatToDo)
Parameters
Type Name Description
Action<SoapAccessRow> 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

GetFromCustomSearchAsync(CustomSearch, CancellationToken)

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

Declaration
public static Task<SoapAccessRows> GetFromCustomSearchAsync(SoapAccessRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoapAccessRows.CustomSearch query

The custom search to execute against the database

CancellationToken cancellationToken
Returns
Type Description
Task<SoapAccessRows>

A new instance of the SoapAccessRows 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

GetFromReaderAsync(SoDataReader, SoapAccessTableInfo, CancellationToken)

Create a new instance of the SoapAccessRows 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 SoapAccessRow 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 Task<SoapAccessRows> GetFromReaderAsync(SoDataReader reader, SoapAccessTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.

SoapAccessTableInfo tableInfo

SoapAccessTableInfo 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.

CancellationToken cancellationToken
Returns
Type Description
Task<SoapAccessRows>
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

Remove(SoapAccessRow)

Removes the given SoapAccessRow from the collection

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

the SoapAccessRow 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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

ToArray()

Table that contains constraints on the access to the soap interface Collection of SoapAccessRow. Each element of the collection represents one row in the SoapAccess table.

Declaration
public SoapAccessRow[] ToArray()
Returns
Type Description
SoapAccessRow[]
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

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()
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 SoapAccessRow to it, and use methods like Save to operate on the whole collection.
  • You can create a (nested) SoapAccessRows SoapAccessRows.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 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 SoapAccessRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a SuperOffice.CRM.Rows.SoapAccessRows.GetFromReader 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).

Implements

INestedPersist
IEnumerable<T>
INotifyCollectionChanged
IBindingList
IList
ICollection
IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)
Converters.MapEnums<From, To>(From)
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top