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>, 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
URLRow to it, and use methods like
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(URLRows.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
Item[Int32]
Get a URLRow given its index in the collection.
Declaration
public URLRow this[int index] { get; }
Parameters
Type | Name | Description |
---|---|---|
Int32 | 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
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(URLRows.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(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 |
---|---|
Int32 | 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
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(URLRows.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 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
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(URLRows.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<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
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(URLRows.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 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
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(URLRows.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 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
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(URLRows.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<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
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(URLRows.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<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
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(URLRows.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<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
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(URLRows.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(URLRows.CustomSearch)
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 URLRows GetFromCustomSearch(URLRows.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
URLRows.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
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
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(URLRows.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.
GetFromIdxContactId(Int32)
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 URLRows GetFromIdxContactId(int contactId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | contactId |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromIdxPersonId(Int32)
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 URLRows GetFromIdxPersonId(int personId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | personId |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromIdxProjectId(Int32)
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 URLRows GetFromIdxProjectId(int projectId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | projectId |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromIdxRank(Int16)
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 URLRows GetFromIdxRank(short rank)
Parameters
Type | Name | Description |
---|---|---|
Int16 | rank |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromIdxReservedId1(Int32)
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 URLRows GetFromIdxReservedId1(int reservedId1)
Parameters
Type | Name | Description |
---|---|---|
Int32 | reservedId1 |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromIdxReservedId2(Int32)
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 URLRows GetFromIdxReservedId2(int reservedId2)
Parameters
Type | Name | Description |
---|---|---|
Int32 | reservedId2 |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromIdxUrlAddress(String)
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 URLRows GetFromIdxUrlAddress(string urlAddress)
Parameters
Type | Name | Description |
---|---|---|
String | urlAddress |
Returns
Type | Description |
---|---|
URLRows | Row object that represents the result of the search. |
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.
GetFromReader(SoDataReader, URLTableInfo)
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 URLRows GetFromReader(SoDataReader reader, URLTableInfo tableInfo)
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. |
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
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(URLRows.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(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
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(URLRows.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()
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
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(URLRows.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 |
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
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(URLRows.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.