IWebPartParameters Interface
TOC
Collapse the table of content
Expand the table of content

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

NameDescription
System_CAPS_pubpropertySchema

Gets the property descriptors for the data to be received by the consumer.

NameDescription
System_CAPS_pubmethodGetParametersData(ParametersCallback)

Gets the value of the data from the connection provider.

System_CAPS_pubmethodSetConsumerSchema(PropertyDescriptorCollection)

Sets 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
Available since 2.0
Return to top
Show:
© 2016 Microsoft