IDataEnvironment Interface

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

NameDescription
System_CAPS_pubpropertyConnections

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

NameDescription
System_CAPS_pubmethodBuildConnection(IWin32Window, DesignerDataConnection)

Creates a new data connection or edits an existing connection using the design tool's new connection user interface.

System_CAPS_pubmethodBuildQuery(IWin32Window, DesignerDataConnection, QueryBuilderMode, String)

Launches a dialog to build a SQL query string.

System_CAPS_pubmethodConfigureConnection(IWin32Window, DesignerDataConnection, String)

Writes a connection string to the application's configuration file.

System_CAPS_pubmethodGetCodeExpression(DesignerDataConnection)

Returns a code expression that contains the source code required to retrieve a connection string from the application's configuration file.

System_CAPS_pubmethodGetConnectionSchema(DesignerDataConnection)

Gets the schema for the specified data connection.

System_CAPS_pubmethodGetDesignTimeConnection(DesignerDataConnection)

Gets 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
Available since 2.0
Return to top
Show: