Class UDContactSmallRows
User-defined fields for contact Collection of UDContactSmallRow. Each element of the collection represents one row in the UDContactSmall table.
Inheritance
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class UDContactSmallRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
Properties
this[int]
Get a UDContactSmallRow given its index in the collection.
Declaration
public UDContactSmallRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
int | index | Index of the UDContactSmallRow in the collection |
Property Value
Type | Description |
---|---|
UDContactSmallRow |
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
Methods
Add(UDContactSmallRow)
Add one UDContactSmallRow to the collection.
Declaration
public int Add(UDContactSmallRow row)
Parameters
Type | Name | Description |
---|---|---|
UDContactSmallRow | row | An instance of UDContactSmallRow to be added to the collection. |
Returns
Type | Description |
---|---|
int | The index of the added UDContactSmallRow. |
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
AddNew()
Add a new instance of UDContactSmallRow added to the collection.
Declaration
public UDContactSmallRow AddNew()
Returns
Type | Description |
---|---|
UDContactSmallRow | A new instance of UDContactSmallRow 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
AddRange(IEnumerable<UDContactSmallRow>)
Add a range of UDContactSmallRow to the collection.
Declaration
public UDContactSmallRows AddRange(IEnumerable<UDContactSmallRow> rows)
Parameters
Type | Name | Description |
---|---|---|
IEnumerable<UDContactSmallRow> | rows |
Returns
Type | Description |
---|---|
UDContactSmallRows | The updated UDContactSmallRows 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
CreateChild()
Create a new instance of UDContactSmallRow
Declaration
protected override TableRowBase CreateChild()
Returns
Type | Description |
---|---|
TableRowBase | New instance of UDContactSmallRow |
Overrides
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
CreateNew()
Create a new instance of the UDContactSmallRows object. This collection will contain no rows.
Declaration
public static UDContactSmallRows CreateNew()
Returns
Type | Description |
---|---|
UDContactSmallRows | A new instance of the UDContactSmallRows 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
Find(Predicate<UDContactSmallRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public UDContactSmallRow Find(Predicate<UDContactSmallRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<UDContactSmallRow> | condition |
Returns
Type | Description |
---|---|
UDContactSmallRow |
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
FindAll(Predicate<UDContactSmallRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public UDContactSmallRows FindAll(Predicate<UDContactSmallRow> condition)
Parameters
Type | Name | Description |
---|---|---|
Predicate<UDContactSmallRow> | condition |
Returns
Type | Description |
---|---|
UDContactSmallRows |
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
ForEach(Action<UDContactSmallRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<UDContactSmallRow> whatToDo)
Parameters
Type | Name | Description |
---|---|---|
Action<UDContactSmallRow> | 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
GetFromCustomSearch(CustomSearch)
Create a new instance of the UDContactSmallRows 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 UDContactSmallRow objects representing each row will be returned.
Declaration
public static UDContactSmallRows GetFromCustomSearch(UDContactSmallRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
UDContactSmallRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
UDContactSmallRows | A new instance of the UDContactSmallRows 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
GetFromIdxDouble01(double)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallDouble01'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxDouble01(double double01)
Parameters
Type | Name | Description |
---|---|---|
double | double01 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxDouble02(double)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallDouble02'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxDouble02(double double02)
Parameters
Type | Name | Description |
---|---|---|
double | double02 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxDouble03(double)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallDouble03'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxDouble03(double double03)
Parameters
Type | Name | Description |
---|---|---|
double | double03 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxDouble04(double)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallDouble04'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxDouble04(double double04)
Parameters
Type | Name | Description |
---|---|---|
double | double04 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxLong01(int)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallLong01'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxLong01(int long01)
Parameters
Type | Name | Description |
---|---|---|
int | long01 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxLong02(int)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallLong02'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxLong02(int long02)
Parameters
Type | Name | Description |
---|---|---|
int | long02 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxLong03(int)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallLong03'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxLong03(int long03)
Parameters
Type | Name | Description |
---|---|---|
int | long03 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxLong04(int)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallLong04'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxLong04(int long04)
Parameters
Type | Name | Description |
---|---|---|
int | long04 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxString01(string)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallString01'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxString01(string string01)
Parameters
Type | Name | Description |
---|---|---|
string | string01 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxString02(string)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallString02'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxString02(string string02)
Parameters
Type | Name | Description |
---|---|---|
string | string02 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxString03(string)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallString03'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxString03(string string03)
Parameters
Type | Name | Description |
---|---|---|
string | string03 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromIdxString04(string)
Create a new instance of the UDContactSmallRow object, by querying the database table via the index 'IDXUdcontSmallString04'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static UDContactSmallRows GetFromIdxString04(string string04)
Parameters
Type | Name | Description |
---|---|---|
string | string04 |
Returns
Type | Description |
---|---|
UDContactSmallRows | Row object that represents the result of the search. IsNew 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 UDContactSmall table. Non-unique indexes have corresponding inner classes and methods in the UDContactSmallRows collection, since they may return more than one row.
GetFromReader(SoDataReader, UDContactSmallTableInfo)
Create a new instance of the UDContactSmallRows 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 UDContactSmallRow 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 UDContactSmallRows GetFromReader(SoDataReader reader, UDContactSmallTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
UDContactSmallTableInfo | tableInfo | UDContactSmallTableInfo 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 |
---|---|
UDContactSmallRows |
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
Remove(UDContactSmallRow)
Removes the given UDContactSmallRow from the collection
Declaration
public void Remove(UDContactSmallRow row)
Parameters
Type | Name | Description |
---|---|---|
UDContactSmallRow | row | the UDContactSmallRow 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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
ToArray()
User-defined fields for contact Collection of UDContactSmallRow. Each element of the collection represents one row in the UDContactSmall table.
Declaration
public UDContactSmallRow[] ToArray()
Returns
Type | Description |
---|---|
UDContactSmallRow[] |
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.
ToString()
For debugging: Number of members, and the first (up to) 5 items
Declaration
public override string ToString()
Returns
Type | Description |
---|---|
string |
Overrides
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 UDContactSmallRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) UDContactSmallRows UDContactSmallRows.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(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.