Class ZipToCityRows

Zip codes and city names. Zip codes used during address entry. You will find more information about addressformat on http://techdoc.superoffice.com Collection of ZipToCityRow. Each element of the collection represents one row in the ZipToCity table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
ZipToCityRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ZipToCityRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, 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 ZipToCityRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) ZipToCityRows ZipToCityRows.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(ZipToCityRows.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 ZipToCityRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, ZipToCityTableInfo) 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 ZipToCityRow given its index in the collection.

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

Index of the ZipToCityRow in the collection
Property Value
Type Description
ZipToCityRow

Methods

Add(ZipToCityRow)

Add one ZipToCityRow to the collection.

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

An instance of ZipToCityRow to be added to the collection.
Returns
Type Description
Int32

The index of the added ZipToCityRow.

AddNew()

Add a new instance of ZipToCityRow added to the collection.

Declaration
public ZipToCityRow AddNew()
Returns
Type Description
ZipToCityRow

A new instance of ZipToCityRow added to the collection.

AddRange(IEnumerable<ZipToCityRow>)

Add a range of ZipToCityRow to the collection.

Declaration
public ZipToCityRows AddRange(IEnumerable<ZipToCityRow> rows)
Parameters
Type Name Description
IEnumerable<ZipToCityRow> rows
Returns
Type Description
ZipToCityRows

The updated ZipToCityRows collection object.

CreateChild()

Create a new instance of ZipToCityRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of ZipToCityRow
Overrides

CreateNew()

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

Declaration
public static ZipToCityRows CreateNew()
Returns
Type Description
ZipToCityRows

A new instance of the ZipToCityRows object.

Find(Predicate<ZipToCityRow>)

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

Declaration
public ZipToCityRow Find(Predicate<ZipToCityRow> condition)
Parameters
Type Name Description
Predicate<ZipToCityRow> condition
Returns
Type Description
ZipToCityRow

FindAll(Predicate<ZipToCityRow>)

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

Declaration
public ZipToCityRows FindAll(Predicate<ZipToCityRow> condition)
Parameters
Type Name Description
Predicate<ZipToCityRow> condition
Returns
Type Description
ZipToCityRows

ForEach(Action<ZipToCityRow>)

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

Declaration
public void ForEach(Action<ZipToCityRow> whatToDo)
Parameters
Type Name Description
Action<ZipToCityRow> whatToDo

GetFromCustomSearch(ZipToCityRows.CustomSearch)

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

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

The custom search to execute against the database
Returns
Type Description
ZipToCityRows

A new instance of the ZipToCityRows object, reflecting the result of the query.

GetFromIdxCity(String)

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

Declaration
public static ZipToCityRows GetFromIdxCity(string city)
Parameters
Type Name Description
String city
Returns
Type Description
ZipToCityRows

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

GetFromIdxCountryId(Int32)

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

Declaration
public static ZipToCityRows GetFromIdxCountryId(int countryId)
Parameters
Type Name Description
Int32 countryId
Returns
Type Description
ZipToCityRows

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

GetFromIdxCountryIdZipcode(Int32, String)

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

Declaration
public static ZipToCityRows GetFromIdxCountryIdZipcode(int countryId, string zipcode)
Parameters
Type Name Description
Int32 countryId
String zipcode
Returns
Type Description
ZipToCityRows

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

GetFromReader(SoDataReader, ZipToCityTableInfo)

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

SoDataReader positioned to a valid database row.
ZipToCityTableInfo tableInfo

ZipToCityTableInfo 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
ZipToCityRows

Remove(ZipToCityRow)

Removes the given ZipToCityRow from the collection

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

the ZipToCityRow to be removed

ToArray()

Declaration
public ZipToCityRow[] ToArray()
Returns
Type Description
ZipToCityRow[]

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)