This documentation is archived and is not being maintained.

IDataEnvironment Interface

Defines an interface to data services that enables control designers to integrate data store or database-related functionality into their design environment.

Namespace:  System.ComponentModel.Design.Data
Assembly:  System.Design (in System.Design.dll)

public interface IDataEnvironment

The IDataEnvironment type exposes the following members.

Public propertyConnectionsGets a collection of data connections defined in the current design session.

Public methodBuildConnectionCreates a new data connection or edits an existing connection using the design tool's new connection user interface.
Public methodBuildQueryLaunches a dialog to build a SQL query string.
Public methodConfigureConnectionWrites a connection string to the application's configuration file.
Public methodGetCodeExpressionReturns a code expression that contains the source code required to retrieve a connection string from the application's configuration file.
Public methodGetConnectionSchemaGets the schema for the specified data connection.
Public methodGetDesignTimeConnectionGets a database connection that can be used at design time.

An object that implements the IDataEnvironment interface can access the data connections available to an application at design time. The IDataEnvironment interface provides methods to list available data connections, create new data connections, retrieve schema information from a connection, and save data-connection configuration information to the application's configuration file.

The IDataEnvironment interface enables you to interact with data connections in the design environment, but it is not intended as a data-management API.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.