Show / Hide Table of Contents

Class PersonRows

Persons in a company or an organizations. All associates have a corresponding person record Collection of PersonRow. Each element of the collection represents one row in the Person table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
PersonRows
Implements
INestedPersist
IEnumerable<INestedPersist>
ISoCollection
IEnumerable
IList
ICollection
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.CopyTo(Array, Int32)
TableRowsBase.IndexOf(Object)
TableRowsBase.Contains(Object)
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.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.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.add_OnElementSaved(OnSaved)
NestedPersist.remove_OnElementSaved(OnSaved)
NestedPersist.add_OnElementIdUpdate(OnIdUpdate)
NestedPersist.remove_OnElementIdUpdate(OnIdUpdate)
NestedPersist.IsSaving
NestedPersist.OnElementSaved
NestedPersist.OnElementIdUpdate
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class PersonRows : 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 PersonRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) PersonRows PersonRows.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(PersonRows.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 PersonRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, PersonTableInfo) 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 PersonRow given its index in the collection.

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

Index of the PersonRow in the collection

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

Add one PersonRow to the collection.

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

An instance of PersonRow to be added to the collection.

Returns
Type Description
Int32

The index of the added PersonRow.

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 PersonRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) PersonRows PersonRows.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(PersonRows.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 PersonRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, PersonTableInfo) 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 PersonRow added to the collection.

Declaration
public PersonRow AddNew()
Returns
Type Description
PersonRow

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

Add a range of PersonRow to the collection.

Declaration
public PersonRows AddRange(IEnumerable<PersonRow> rows)
Parameters
Type Name Description
IEnumerable<PersonRow> rows
Returns
Type Description
PersonRows

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

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of PersonRow

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 PersonRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) PersonRows PersonRows.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(PersonRows.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 PersonRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, PersonTableInfo) 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 PersonRows object. This collection will contain no rows.

Declaration
public static PersonRows CreateNew()
Returns
Type Description
PersonRows

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

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

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

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

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

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

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

GetFromCustomSearch(PersonRows.CustomSearch)

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

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

The custom search to execute against the database

Returns
Type Description
PersonRows

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

GetFromIdxBusinessIdx(Int32)

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

Declaration
public static PersonRows GetFromIdxBusinessIdx(int businessIdx)
Parameters
Type Name Description
Int32 businessIdx
Returns
Type Description
PersonRows

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

GetFromIdxCategoryIdx(Int32)

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

Declaration
public static PersonRows GetFromIdxCategoryIdx(int categoryIdx)
Parameters
Type Name Description
Int32 categoryIdx
Returns
Type Description
PersonRows

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

GetFromIdxContactId(Int32)

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

Declaration
public static PersonRows GetFromIdxContactId(int contactId)
Parameters
Type Name Description
Int32 contactId
Returns
Type Description
PersonRows

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

GetFromIdxContactIdRank(Int32, Int16)

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

Declaration
public static PersonRows GetFromIdxContactIdRank(int contactId, short rank)
Parameters
Type Name Description
Int32 contactId
Int16 rank
Returns
Type Description
PersonRows

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

GetFromIdxCreatedByFormId(Int32)

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

Declaration
public static PersonRows GetFromIdxCreatedByFormId(int createdByFormId)
Parameters
Type Name Description
Int32 createdByFormId
Returns
Type Description
PersonRows

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

GetFromIdxDbiAgentId(Int32)

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

Declaration
public static PersonRows GetFromIdxDbiAgentId(int dbiAgentId)
Parameters
Type Name Description
Int32 dbiAgentId
Returns
Type Description
PersonRows

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

GetFromIdxDbiKey(String)

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

Declaration
public static PersonRows GetFromIdxDbiKey(string dbiKey)
Parameters
Type Name Description
String dbiKey
Returns
Type Description
PersonRows

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

GetFromIdxDbiLastModified(DateTime)

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

Declaration
public static PersonRows GetFromIdxDbiLastModified(DateTime dbiLastModified)
Parameters
Type Name Description
DateTime dbiLastModified
Returns
Type Description
PersonRows

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

GetFromIdxDbiLastSyncronized(DateTime)

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

Declaration
public static PersonRows GetFromIdxDbiLastSyncronized(DateTime dbiLastSyncronized)
Parameters
Type Name Description
DateTime dbiLastSyncronized
Returns
Type Description
PersonRows

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

GetFromIdxDeletedDate(DateTime)

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

Declaration
public static PersonRows GetFromIdxDeletedDate(DateTime deletedDate)
Parameters
Type Name Description
DateTime deletedDate
Returns
Type Description
PersonRows

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

GetFromIdxFirstname(String)

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

Declaration
public static PersonRows GetFromIdxFirstname(string firstname)
Parameters
Type Name Description
String firstname
Returns
Type Description
PersonRows

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

GetFromIdxKanafname(String)

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

Declaration
public static PersonRows GetFromIdxKanafname(string kanafname)
Parameters
Type Name Description
String kanafname
Returns
Type Description
PersonRows

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

GetFromIdxKanalname(String)

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

Declaration
public static PersonRows GetFromIdxKanalname(string kanalname)
Parameters
Type Name Description
String kanalname
Returns
Type Description
PersonRows

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

GetFromIdxLastname(String)

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

Declaration
public static PersonRows GetFromIdxLastname(string lastname)
Parameters
Type Name Description
String lastname
Returns
Type Description
PersonRows

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

GetFromIdxMiddleName(String)

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

Declaration
public static PersonRows GetFromIdxMiddleName(string middleName)
Parameters
Type Name Description
String middleName
Returns
Type Description
PersonRows

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

GetFromIdxModifiedByWorkflowId(Int32)

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

Declaration
public static PersonRows GetFromIdxModifiedByWorkflowId(int modifiedByWorkflowId)
Parameters
Type Name Description
Int32 modifiedByWorkflowId
Returns
Type Description
PersonRows

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

GetFromIdxPersonNumber(String)

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

Declaration
public static PersonRows GetFromIdxPersonNumber(string personNumber)
Parameters
Type Name Description
String personNumber
Returns
Type Description
PersonRows

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

GetFromIdxSource(Int16)

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

Declaration
public static PersonRows GetFromIdxSource(short source)
Parameters
Type Name Description
Int16 source
Returns
Type Description
PersonRows

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

GetFromIdxUserdef2Id(Int32)

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

Declaration
public static PersonRows GetFromIdxUserdef2Id(int userdef2Id)
Parameters
Type Name Description
Int32 userdef2Id
Returns
Type Description
PersonRows

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

GetFromIdxUserdefId(Int32)

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

Declaration
public static PersonRows GetFromIdxUserdefId(int userdefId)
Parameters
Type Name Description
Int32 userdefId
Returns
Type Description
PersonRows

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

GetFromReader(SoDataReader, PersonTableInfo)

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

SoDataReader positioned to a valid database row.

PersonTableInfo tableInfo

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

Removes the given PersonRow from the collection

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

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

Persons in a company or an organizations. All associates have a corresponding person record Collection of PersonRow. Each element of the collection represents one row in the Person table.

Declaration
public PersonRow[] ToArray()
Returns
Type Description
PersonRow[]
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 PersonRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) PersonRows PersonRows.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(PersonRows.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 PersonRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, PersonTableInfo) 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
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 PersonRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) PersonRows PersonRows.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(PersonRows.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 PersonRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, PersonTableInfo) 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
System.Collections.Generic.IEnumerable<T>
ISoCollection
System.Collections.IEnumerable
System.Collections.IList
System.Collections.ICollection
System.Collections.Specialized.INotifyCollectionChanged
System.ComponentModel.IBindingList

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