IDataSourceDesigner Interface


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

Defines the basic functionality for a data source designer.

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

public interface IDataSourceDesigner


Gets a value that indicates whether the Configure method can be called.


Gets a value that indicates whether the RefreshSchema method can be called.


Launches the underlying data source's configuration wizard.


Gets the DesignerDataSourceView for the specified view.


Gets the names of the views in the underlying data source.


Refreshes the schema of the underlying data source.


Resumes raising data source events after calling the SuppressDataSourceEvents method.


Suppresses all events raised by a data source until the ResumeDataSourceEvents method is called.


Occurs when a data source has changed in a way that affects data-bound controls.


Occurs 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
Available since 2.0
Return to top