DataConnectionCollection Class

Definition

Namespace:

Microsoft.Office.InfoPath

Assembly:

Microsoft.Office.InfoPath.dll

Contains a data connection object corresponding to each data connection used within a form template.

public ref class DataConnectionCollection abstract : System::Collections::IEnumerable

public abstract class DataConnectionCollection : System.Collections.IEnumerable

type DataConnectionCollection = class
    interface IEnumerable

Public MustInherit Class DataConnectionCollection
Implements IEnumerable

Inheritance

Object

DataConnectionCollection

Implements

IEnumerable

Remarks

Each data connection is used to retrieve data (inserted into the main data source or into a secondary data source) or to submit data.

A data connection used to retrieve or submit data for the main data source will correspond to one of the following data connection object types:

• AdoQueryConnection
• AdoSubmitConnection
• WebServiceConnection

A data connection used to retrieve data for a secondary data source will correspond to one of the following data connection object types:

• AdoQueryConnection
• BdcQueryConnection
• FileQueryConnection
• SharePointListRWQueryConnection
• WebServiceConnection

A data connection used only for submitting data will correspond to one of the following data connection object types:

• BdcSubmitConnection
• EmailSubmitConnection
• FileSubmitConnection
• SharePointListRWSubmitConnection
• WebServiceConnection

To access a DataConnection object for a particular kind of data connection, use the DataConnectionCollection object associated with the form template. To access the DataConnectionCollection object, use the DataConnections property of the XmlForm class.

To use the properties or methods of the object returned from the DataConnectionCollection, you must cast that object to the type that represents the kind of data connection you are working with before you can access those members. For example, to work with an AdoQueryConnection object (which represents a data connection for retrieving data from an Access or SQL Server database), you must cast the object returned from the DataConnectionCollection as shown in the following examples.

// Get the Employees connection from the 
// DataConnections collection.
AdoQueryConnection myAdoQueryConnection =
   (AdoQueryConnection)(this.DataConnections["Employees"]);

' Get the Employees connection from the 
' DataConnections collection.
Dim myAdoQueryConnection As AdoQueryConnection = _
   DirectCast(Me.DataConnections("Employees"), AdoQueryConnection)

For more information about working with data connections, see How to: Access External Data Sources.

Constructors

DataConnectionCollection()

Properties

Count	Gets the count of the number of DataConnection objects in the collection.
Item[Int32]	Gets a reference to the specified DataConnection object from the collection by index value.
Item[String]	Gets a reference to the specified DataConnection object from the collection by name.

Methods

GetEnumerator()

Gets an IEnumerator object that iterates over all entries in the collection.