Share via


IDataConnectionProperties Interface

Provides a set of methods and properties that enable the Data Connection dialog box to interact with a specified data provider's connection properties.

Namespace:  Microsoft.Data.ConnectionUI
Assembly:  Microsoft.Data.ConnectionUI (in Microsoft.Data.ConnectionUI.dll)

Syntax

'Declaration
Public Interface IDataConnectionProperties
public interface IDataConnectionProperties
public interface class IDataConnectionProperties
type IDataConnectionProperties =  interface end
public interface IDataConnectionProperties

The IDataConnectionProperties type exposes the following members.

Properties

  Name Description
Public property IsComplete Retrieves a Boolean value indicating whether the current set of connection property values provides sufficient information to open a connection to the data source.
Public property IsExtensible Retrieves a Boolean value indicating whether the specified set of connection properties is extensible; that is, whether it is possible to add and remove custom properties to the set of connection properties.
Public property Item Represents a property instance of specified type and value.

Top

Methods

  Name Description
Public method Add Adds a custom property to the existing set of data connection properties recognized by the data provider.
Public method Contains Tests whether a given set of connection properties contains a specified property.
Public method Parse Parses a data connection string that is built from a set of properties into the corresponding set of connection properties.
Public method Remove Removes a custom property from a specified set of data connection properties.
Public method Reset() Resets all connection properties and restores the object to its initial state.
Public method Reset(String) Resets a specified connection property to its initial value.
Public method Test Tests whether the current set of connection properties can successfully open a connection.
Public method ToDisplayString Retrieves a connection string for on-screen display reflecting the current set of connection properties, minus "sensitive" information that should not be displayed.
Public method ToFullString Retrieves the complete connection string representing the current set of connection properties.

Top

Events

  Name Description
Public event PropertyChanged Event that is raised when a data provider connection property is changed.

Top

See Also

Reference

Microsoft.Data.ConnectionUI Namespace

Other Resources

DDEX Data Connection UI

DDEX Providers