Defines a provider interface for connecting two server controls using an entire table of data.
Assembly: System.Web (in System.Web.dll)
This interface is designed to be used with Web Parts connections. In a Web Parts connection, two server controls that reside in a WebPartZoneBase zone establish a connection and share data, with one control acting as the consumer and the other control acting as a provider. The mechanism for sharing data in a Web Parts connection is an interface instance, which the provider serves to the consumer by means of a callback method. To establish a connection, the consumer and provider must both work with the same interface type for sharing data. If the consumer does not recognize the interface type sent by the provider, it is still possible to connect the controls by means of a transformer (a WebPartTransformer object) that translates the interface instance sent by the provider into a type that the consumer recognizes. For details on connections, see WebPartConnection and Web Parts Connections Overview.
The IWebPartField interface), row (for details, see the IWebPartRow interface), or table from the data source. In a typical connection, a WebPart control acting as a provider would implement the interface and provide an instance of the interface to consumers in a special callback method. For example, the provider might implement an interface for a table that contains financial performance data. Another WebPart control acting as a consumer would define a special method to receive the interface instance, and could then extract the data and render a chart to display the resulting information.interface is a provider interface included with the Web Parts control set as a standard interface for creating connections based on a data table. You can also create custom interfaces to use with Web Parts connections, but in many data-driven Web applications, it is useful to create connections based on a common field (for details, see the
The Schema property returns schema information about the data table encapsulated in a PropertyDescriptorCollection object. The GetTableData method declares a method that an implementer (such as a provider control) uses to retrieve the interface instance's table data when the callback method is invoked.interface has two exposed members. The
The following code example demonstrates how to create a static connection between two controls using theinterface. The code example has three parts:
Source code for two custom WebPart controls that can form a connection using the interface, with one control acting as the provider and the other acting as the consumer.
A Web page that hosts the controls and declares the static connection in persistence format.
A description of what happens when the example code runs.
The first part of the code example is the source code for the two custom controls. First is the code for the provider, which implements the GetConnectionInterface method serves as the provider's connection point, the callback method that returns the interface instance to the consumer. As for the consumer, it retrieves the interface instance from the provider in its method named SetConnectionInterface, which is marked with a ConnectionConsumer attribute. After retrieving the instance of the interface, the consumer, in its OnPreRender method, calls the implementation of the GetTableData method in the provider, to retrieve the actual data and write it to the page.interface. For simplicity in the example, the provider creates a table with some data rather than connecting to a database. The
For the code example to run, you must compile this source code. You can compile it explicitly and put the resulting assembly in your Web site's Bin folder or the global assembly cache. Alternatively, you can put the source code in your site's App_Code folder, where it will be dynamically compiled at run time. This code example uses dynamic compilation. For a walkthrough that demonstrates how to compile, see Walkthrough: Developing and Using a Custom Web Server Control.
The second part of the code example is the Web page that declares the static connection and hosts the controls. Near the top of the page is a Register directive that declares the namespace of the source code contained in the App_Code directory. The connection is declared using an <asp:webpartconnection> element. The custom consumer and provider controls are declared in a <zonetemplate> element within an <asp:webpartzone> element, which is required for them to be able to connect (they must reside within a zone that inherits from the WebPartZoneBase class).
Load the page in a browser. The consumer control displays the data provided from the specified table, which the provider makes available through an instance of theinterface.
Available since 2.0