Institutions¶
Institutions is an auto-generated strongly typed DataSet for Institutions.xsd. It exposes the single Institution table plus typed InstitutionDataTable, InstitutionRow, and InstitutionRowChangeEvent helpers used by ADO.NET consumers.
Purpose¶
- Wraps the generated
Institutiontable in a typedDataSetwith schema serialization support. - Provides typed row, column, and row-change-event accessors for institution/bank-routing metadata such as
LYONS_ID,LOC,MICR,FEDWIRE, and contact fields.
Context¶
- Namespace:
SAIF.Business.Imaging - Assembly/package:
SAIF.BOF.Business.Imaging - Source artifact: generated by
System.Data.Design.TypedDataSetGenerator
Public members¶
| Member | Signature | Purpose |
|---|---|---|
New |
Public Sub New() |
Initializes the typed DataSet, creates the Institution table, and wires schema-change handlers for Tables and Relations. |
Institution |
Public ReadOnly Property Institution() As InstitutionDataTable |
Returns the typed InstitutionDataTable instance held by the data set. |
SchemaSerializationMode |
Public Overrides Property SchemaSerializationMode() As Global.System.Data.SchemaSerializationMode |
Gets or sets whether the typed data set serializes schema information along with data. |
Tables |
Public Shadows ReadOnly Property Tables() As Global.System.Data.DataTableCollection |
Exposes the underlying DataTableCollection from the base DataSet. |
Relations |
Public Shadows ReadOnly Property Relations() As Global.System.Data.DataRelationCollection |
Exposes the underlying DataRelationCollection from the base DataSet. |
Clone |
Public Overrides Function Clone() As Global.System.Data.DataSet |
Creates another Institutions instance with the typed table and current schema-serialization mode reinitialized. |
GetTypedDataSetSchema |
Public Shared Function GetTypedDataSetSchema(ByVal xs As Global.System.Xml.Schema.XmlSchemaSet) As Global.System.Xml.Schema.XmlSchemaComplexType |
Publishes the XML schema metadata for the typed data set so serializers can recognize the Institutions schema. |
InstitutionRowChangeEventHandler |
Public Delegate Sub InstitutionRowChangeEventHandler(ByVal sender As Object, ByVal e As InstitutionRowChangeEvent) |
Delegate used by the typed InstitutionDataTable row-change events. |
InstitutionDataTable |
Partial Public Class InstitutionDataTable : Inherits Global.System.Data.TypedTableBase(Of InstitutionRow) |
Strongly typed table wrapper for the generated Institution rows. |
InstitutionDataTable.New |
Public Sub New() |
Creates the typed Institution table and initializes all generated DataColumn fields. |
InstitutionDataTable column accessors |
Public ReadOnly Property LYONS_IDColumn() As DataColumn, LOCColumn(), NAMEColumn(), MICRColumn(), FRACColumn(), ACHColumn(), PHYS_ADDR1Column(), PHYS_CITYColumn(), PHYS_STATEColumn(), PHYS_ZIPColumn(), PHONEColumn(), FAXColumn(), FEDWIREColumn(), CORR_RTNOColumn(), _RETURNColumn(), RETURN_EXTColumn(), ADJUSTColumn(), ADJUST_EXTColumn(), WIREPHONEColumn(), WIREPHONE_EXTColumn(), SWIFTColumn(), TELEXColumn(), OLDMICRColumn(), HOMEPAGEColumn(), EMAILColumn(), NOTESColumn(), LYONS_NOTEColumn(), CUST_SVCColumn(), UniWireColumn(), LABAOld2Column(), LABAOld3Column(), LACHOldColumn(), LACHOld2Column(), LACHOld3Column() |
Exposes the 34 generated DataColumn definitions that back the Institution table schema. |
InstitutionDataTable collection helpers |
Public ReadOnly Property Count() As Integer; Public Default ReadOnly Property Item(ByVal index As Integer) As InstitutionRow; Public Overloads Sub AddInstitutionRow(ByVal row As InstitutionRow); Public Overloads Function AddInstitutionRow(ByVal LYONS_ID As String, ByVal LOC As String, ByVal NAME As String, ByVal MICR As String, ByVal FRAC As String, ByVal ACH As String, ByVal PHYS_ADDR1 As String, ByVal PHYS_CITY As String, ByVal PHYS_STATE As String, ByVal PHYS_ZIP As String, ByVal PHONE As String, ByVal FAX As String, ByVal FEDWIRE As String, ByVal CORR_RTNO As String, ByVal _RETURN As String, ByVal RETURN_EXT As String, ByVal ADJUST As String, ByVal ADJUST_EXT As String, ByVal WIREPHONE As String, ByVal WIREPHONE_EXT As String, ByVal SWIFT As String, ByVal TELEX As String, ByVal OLDMICR As String, ByVal HOMEPAGE As String, ByVal EMAIL As String, ByVal NOTES As String, ByVal LYONS_NOTE As String, ByVal CUST_SVC As String, ByVal UniWire As String, ByVal LABAOld2 As String, ByVal LABAOld3 As String, ByVal LACHOld As String, ByVal LACHOld2 As String, ByVal LACHOld3 As String) As InstitutionRow; Public Function NewInstitutionRow() As InstitutionRow; Public Sub RemoveInstitutionRow(ByVal row As InstitutionRow) |
Provides typed row counting, indexed access, row creation, row insertion, and row removal for the Institution table. |
InstitutionDataTable events |
Public Event InstitutionRowChanging As InstitutionRowChangeEventHandler; Public Event InstitutionRowChanged As InstitutionRowChangeEventHandler; Public Event InstitutionRowDeleting As InstitutionRowChangeEventHandler; Public Event InstitutionRowDeleted As InstitutionRowChangeEventHandler |
Raises strongly typed notifications whenever an InstitutionRow changes state inside the table. |
InstitutionDataTable.Clone |
Public Overrides Function Clone() As Global.System.Data.DataTable |
Clones the typed table and rebinds its generated column fields. |
InstitutionDataTable.GetTypedTableSchema |
Public Shared Function GetTypedTableSchema(ByVal xs As Global.System.Xml.Schema.XmlSchemaSet) As Global.System.Xml.Schema.XmlSchemaComplexType |
Publishes the XML schema metadata for the InstitutionDataTable type. |
InstitutionRow |
Partial Public Class InstitutionRow : Inherits Global.System.Data.DataRow |
Strongly typed row wrapper for one Institution record. |
InstitutionRow value properties |
Public Property LYONS_ID() As String, LOC(), NAME(), MICR(), FRAC(), ACH(), PHYS_ADDR1(), PHYS_CITY(), PHYS_STATE(), PHYS_ZIP(), PHONE(), FAX(), FEDWIRE(), CORR_RTNO(), _RETURN(), RETURN_EXT(), ADJUST(), ADJUST_EXT(), WIREPHONE(), WIREPHONE_EXT(), SWIFT(), TELEX(), OLDMICR(), HOMEPAGE(), EMAIL(), NOTES(), LYONS_NOTE(), CUST_SVC(), UniWire(), LABAOld2(), LABAOld3(), LACHOld(), LACHOld2(), LACHOld3() |
Exposes each generated string column on the typed row; getters throw StrongTypingException when the underlying value is DBNull. |
InstitutionRow null helpers |
Public Function IsLYONS_IDNull() As Boolean/SetLYONS_IDNull(), IsLOCNull()/SetLOCNull(), IsNAMENull()/SetNAMENull(), IsMICRNull()/SetMICRNull(), IsFRACNull()/SetFRACNull(), IsACHNull()/SetACHNull(), IsPHYS_ADDR1Null()/SetPHYS_ADDR1Null(), IsPHYS_CITYNull()/SetPHYS_CITYNull(), IsPHYS_STATENull()/SetPHYS_STATENull(), IsPHYS_ZIPNull()/SetPHYS_ZIPNull(), IsPHONENull()/SetPHONENull(), IsFAXNull()/SetFAXNull(), IsFEDWIRENull()/SetFEDWIRENull(), IsCORR_RTNONull()/SetCORR_RTNONull(), Is_RETURNNull()/Set_RETURNNull(), IsRETURN_EXTNull()/SetRETURN_EXTNull(), IsADJUSTNull()/SetADJUSTNull(), IsADJUST_EXTNull()/SetADJUST_EXTNull(), IsWIREPHONENull()/SetWIREPHONENull(), IsWIREPHONE_EXTNull()/SetWIREPHONE_EXTNull(), IsSWIFTNull()/SetSWIFTNull(), IsTELEXNull()/SetTELEXNull(), IsOLDMICRNull()/SetOLDMICRNull(), IsHOMEPAGENull()/SetHOMEPAGENull(), IsEMAILNull()/SetEMAILNull(), IsNOTESNull()/SetNOTESNull(), IsLYONS_NOTENull()/SetLYONS_NOTENull(), IsCUST_SVCNull()/SetCUST_SVCNull(), IsUniWireNull()/SetUniWireNull(), IsLABAOld2Null()/SetLABAOld2Null(), IsLABAOld3Null()/SetLABAOld3Null(), IsLACHOldNull()/SetLACHOldNull(), IsLACHOld2Null()/SetLACHOld2Null(), IsLACHOld3Null()/SetLACHOld3Null() |
Supplies the generated ADO.NET null-check and null-assignment helpers for every typed string field in InstitutionRow. |
InstitutionRowChangeEvent |
Public Class InstitutionRowChangeEvent : Inherits Global.System.EventArgs |
Strongly typed event-args object emitted by the InstitutionDataTable row-change events. |
InstitutionRowChangeEvent.New |
Public Sub New(ByVal row As InstitutionRow, ByVal action As Global.System.Data.DataRowAction) |
Captures the changed row and the DataRowAction that triggered the event. |
InstitutionRowChangeEvent.Row |
Public ReadOnly Property Row() As InstitutionRow |
Returns the typed row instance associated with the event. |
InstitutionRowChangeEvent.Action |
Public ReadOnly Property Action() As Global.System.Data.DataRowAction |
Returns the row-change action (Add, Change, Delete, and so on) associated with the event. |
Behavioral notes¶
InitClassconstructs the singleInstitutionDataTable, names the data setInstitutions, and setsEnforceConstraints = false.InstitutionDataTable.AddInstitutionRow(...)writes the supplied values into anObject()array, assigns that array torowInstitutionRow.ItemArray, and then adds the row toRows.- Each
InstitutionRowstring-property getter throwsGlobal.System.Data.StrongTypingExceptionwhen the backingDataColumncontainsDBNull.
Constraints and usage notes¶
- The file is auto-generated; direct manual edits in
Institutions.Designer.vbwill be overwritten if the typed data set is regenerated. - All generated row fields are typed as
String; callers must use theIs...Null/Set...Nullhelpers when interacting with optional columns.
Sources¶
Business\SAIF.Business.Imaging\Institutions.Designer.vb