This documentation is archived and is not being maintained.

IDataSourceDesigner Interface

Defines the basic functionality for a data source designer.

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

public interface IDataSourceDesigner

The IDataSourceDesigner type exposes the following members.

Public propertyCanConfigureGets a value that indicates whether the Configure method can be called.
Public propertyCanRefreshSchemaGets a value that indicates whether the RefreshSchema method can be called.

Public methodConfigureLaunches the underlying data source's configuration wizard.
Public methodGetViewGets the DesignerDataSourceView for the specified view.
Public methodGetViewNamesGets the names of the views in the underlying data source.
Public methodRefreshSchemaRefreshes the schema of the underlying data source.
Public methodResumeDataSourceEventsResumes raising data source events after calling the SuppressDataSourceEvents method.
Public methodSuppressDataSourceEventsSuppresses all events raised by a data source until the ResumeDataSourceEvents method is called.

Public eventDataSourceChangedOccurs when a data source has changed in a way that affects data-bound controls.
Public eventSchemaRefreshedOccurs when the fields or data of the underlying data source have changed.

The IDataSourceDesigner interface defines an interface through which you can implement basic services for a data source designer. A designer is only active at design time, and must be associated with a data source, using a DesignerAttribute, in order to be loaded when a data source of the associated type is created at design time.

The IDataSourceDesigner interface provides methods and properties that you can implement in order to provide custom behavior at design time.

A designer can also use the available design-time services to perform a variety of tasks, including surveying the current design-time environment for components and their properties, reading and setting the values of properties of components, managing the toolbox, managing selected components, or displaying a user interface that can be used to configure values or to apply further processing.

In most cases, implement your custom designer for a data source by deriving it from the DataSourceDesigner class. Data sources whose associated designer does not derive from DataSourceDesigner are displayed in the component tray. The DataSourceDesigner class implements the IDataSourceDesigner interface and provides additional design-time support that may be of use to authors of designers. For more information, see the reference documentation for these classes.

For an overview of creating design components, see Extending Design-Time Support.

.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.