IDataConnectionProperties Interface

  • Article

 

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

public interface IDataConnectionProperties

public interface class IDataConnectionProperties

type IDataConnectionProperties = interface end

Public Interface IDataConnectionProperties

Properties

Name Description
System_CAPS_pubproperty 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.
System_CAPS_pubproperty 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.
System_CAPS_pubproperty Item[String]

Represents a property instance of specified type and value.

Methods

Name Description
System_CAPS_pubmethod Add(String)

Adds a custom property to the existing set of data connection properties recognized by the data provider.
System_CAPS_pubmethod Contains(String)

Tests whether a given set of connection properties contains a specified property.
System_CAPS_pubmethod Parse(String)

Parses a data connection string that is built from a set of properties into the corresponding set of connection properties.
System_CAPS_pubmethod Remove(String)

Removes a custom property from a specified set of data connection properties.
System_CAPS_pubmethod Reset()

Resets all connection properties and restores the object to its initial state.
System_CAPS_pubmethod Reset(String)

Resets a specified connection property to its initial value.
System_CAPS_pubmethod Test()

Tests whether the current set of connection properties can successfully open a connection.
System_CAPS_pubmethod ToDisplayString()

Retrieves a connection string for on-screen display reflecting the current set of connection properties, minus "sensitive" information that should not be displayed.
System_CAPS_pubmethod ToFullString()

Retrieves the complete connection string representing the current set of connection properties.

Events

Name Description
System_CAPS_pubevent PropertyChanged

Event that is raised when a data provider connection property is changed.

See Also

Microsoft.Data.ConnectionUI Namespace
DDEX Data Connection UI
DDEX Providers

Return to top