DataSourceProviderService.AddDataSourceInstance Method

Reference

Definition

Namespace:: System.ComponentModel.Design.Data

Assembly:: System.Design.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

When overridden in a derived class, creates and returns an instance of the given data source, and adds it to the design surface.

public:
 abstract System::Object ^ AddDataSourceInstance(System::ComponentModel::Design::IDesignerHost ^ host, System::ComponentModel::Design::Data::DataSourceDescriptor ^ dataSourceDescriptor);

public abstract object AddDataSourceInstance (System.ComponentModel.Design.IDesignerHost host, System.ComponentModel.Design.Data.DataSourceDescriptor dataSourceDescriptor);

abstract member AddDataSourceInstance : System.ComponentModel.Design.IDesignerHost * System.ComponentModel.Design.Data.DataSourceDescriptor -> obj

Public MustOverride Function AddDataSourceInstance (host As IDesignerHost, dataSourceDescriptor As DataSourceDescriptor) As Object

Parameters

host: IDesignerHost

The designer host.

dataSourceDescriptor: DataSourceDescriptor

The data source.

Returns

Object

An Object representing an instance of the added data source.

Exceptions

ArgumentException

The type name cannot be created or resolved.

Remarks

You should only call the AddDataSourceInstance method on data sources that are designable for example, if the IsDesignable value is true.

This method enables the service implementer to perform custom actions when a data source is added to the design surface.

Applies to