Class URLRows
Unified Resource Locators, URL to contacts, persons or projects. Collection of URLRow. Each element of the collection represents one row in the URL table.
Implements
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class URLRows : 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
Properties
this[int]
Get a URLRow given its index in the collection.
Declaration
public URLRow this[int index] { get; }
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | Index of the URLRow in the collection |
Property Value
| Type | Description |
|---|---|
| URLRow |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
Methods
Add(URLRow)
Add one URLRow to the collection.
Declaration
public int Add(URLRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| URLRow | row | An instance of URLRow to be added to the collection. |
Returns
| Type | Description |
|---|---|
| int | The index of the added URLRow. |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
AddNew()
Add a new instance of URLRow added to the collection.
Declaration
public URLRow AddNew()
Returns
| Type | Description |
|---|---|
| URLRow | A new instance of URLRow 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
AddRange(IEnumerable<URLRow>)
Add a range of URLRow to the collection.
Declaration
public URLRows AddRange(IEnumerable<URLRow> rows)
Parameters
| Type | Name | Description |
|---|---|---|
| IEnumerable<URLRow> | rows |
Returns
| Type | Description |
|---|---|
| URLRows | The updated URLRows 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
CreateChild()
Create a new instance of URLRow
Declaration
protected override TableRowBase CreateChild()
Returns
| Type | Description |
|---|---|
| TableRowBase | New instance of URLRow |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
CreateNew()
Create a new instance of the URLRows object. This collection will contain no rows.
Declaration
public static URLRows CreateNew()
Returns
| Type | Description |
|---|---|
| URLRows | A new instance of the URLRows 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
Find(Predicate<URLRow>)
Apply the predicate to each element of the collection and return the first row that matches; if no match then return null
Declaration
public URLRow Find(Predicate<URLRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<URLRow> | condition |
Returns
| Type | Description |
|---|---|
| URLRow |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
FindAll(Predicate<URLRow>)
Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection
Declaration
public URLRows FindAll(Predicate<URLRow> condition)
Parameters
| Type | Name | Description |
|---|---|---|
| Predicate<URLRow> | condition |
Returns
| Type | Description |
|---|---|
| URLRows |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
ForEach(Action<URLRow>)
Method that iterates over all members and applies the action parameter to each of them
Declaration
public void ForEach(Action<URLRow> whatToDo)
Parameters
| Type | Name | Description |
|---|---|---|
| Action<URLRow> | 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
GetFromCustomSearchAsync(CustomSearch, CancellationToken)
Create a new instance of the URLRows 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 URLRow objects representing each row will be returned.
Declaration
public static Task<URLRows> GetFromCustomSearchAsync(URLRows.CustomSearch query, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| URLRows.CustomSearch | query | The custom search to execute against the database |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | A new instance of the URLRows 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
GetFromIdxContactIdAsync(int, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLContact_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxContactIdAsync(int contactId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | contactId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromIdxPersonIdAsync(int, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLPerson_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxPersonIdAsync(int personId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | personId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromIdxProjectIdAsync(int, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLProject_id'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxProjectIdAsync(int projectId, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | projectId | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromIdxRankAsync(short, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLRank'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxRankAsync(short rank, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| short | rank | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromIdxReservedId1Async(int, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLReserved_id1'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxReservedId1Async(int reservedId1, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | reservedId1 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromIdxReservedId2Async(int, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLReserved_id2'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxReservedId2Async(int reservedId2, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| int | reservedId2 | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromIdxUrlAddressAsync(string, CancellationToken)
Create a new instance of the URLRow object, by querying the database table via the index 'IDXURLUrl_address'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static Task<URLRows> GetFromIdxUrlAddressAsync(string urlAddress, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| string | urlAddress | |
| CancellationToken | cancellationToken |
Returns
| Type | Description |
|---|---|
| Task<URLRows> | 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 URL table. Non-unique indexes have corresponding inner classes and methods in the URLRows collection, since they may return more than one row.
GetFromReaderAsync(SoDataReader, URLTableInfo, CancellationToken)
Create a new instance of the URLRows 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 URLRow 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<URLRows> GetFromReaderAsync(SoDataReader reader, URLTableInfo tableInfo, CancellationToken cancellationToken = default)
Parameters
| Type | Name | Description |
|---|---|---|
| SoDataReader | reader | SoDataReader positioned to a valid database row. |
| URLTableInfo | tableInfo | URLTableInfo 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<URLRows> |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
Remove(URLRow)
Removes the given URLRow from the collection
Declaration
public void Remove(URLRow row)
Parameters
| Type | Name | Description |
|---|---|---|
| URLRow | row | the URLRow 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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
ToArray()
Unified Resource Locators, URL to contacts, persons or projects. Collection of URLRow. Each element of the collection represents one row in the URL table.
Declaration
public URLRow[] ToArray()
Returns
| Type | Description |
|---|---|
| URLRow[] |
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.
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 URLRow to it, and use methods like Save to operate on the whole collection.
- You can create a (nested) URLRows URLRows.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.