DataConnectionCollection Class (Microsoft.Office.InfoPath)

  • Article

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

Namespace: Microsoft.Office.InfoPath
Assembly: Microsoft.Office.InfoPath (in microsoft.office.infopath.dll)

Syntax

'Declaration
<DefaultMemberAttribute("Item")> _
Public MustInherit Class DataConnectionCollection
    Implements IEnumerable
'Usage
Dim instance As DataConnectionCollection

[DefaultMemberAttribute("Item")] 
public abstract class DataConnectionCollection : 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:

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

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

To access an instance of the DataConnectionCollection class associated with a form template, 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.

Inheritance Hierarchy

System.Object
  Microsoft.Office.InfoPath.DataConnectionCollection

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

DataConnectionCollection Members
Microsoft.Office.InfoPath Namespace