This documentation is archived and is not being maintained.

IWebPartParameters Interface

Defines the contract a Web Parts control implements to pass a parameter value in a Web Parts connection.

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public interface IWebPartParameters

The IWebPartParameters type exposes the following members.

Public propertySchemaGets the property descriptors for the data to be received by the consumer.

Public methodGetParametersDataGets the value of the data from the connection provider.
Public methodSetConsumerSchemaSets the property descriptors for the properties that the consumer receives when calling the GetParametersData method.

Data is usually sent from a provider to a consumer in a Web Parts connection. However, in some cases, a provider needs a parameter from the consumer to determine which values it should send back. The IWebPartParameters interface defines members to implement that facilitate the passing of a parameter from a consumer to a provider.

The RowToParametersTransformer class implements the IWebPartParameters interface. Transformers are used to translate data between two Web Parts controls with incompatible connection points. A RowToParametersTransformer object transforms data from a provider implementing the IWebPartRow interface when the provider needs a parameter from the consumer.

The GetParametersData method retrieves the data from the provider and provides a callback method to process the data for the consumer. The callback method can be a customized method within the consumer that sets the return values accordingly.

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