IWebPartParameters IWebPartParameters IWebPartParameters IWebPartParameters Interface

Definition

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

public interface class IWebPartParameters
public interface IWebPartParameters
type IWebPartParameters = interface
Public Interface IWebPartParameters
Derived

Remarks

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.

Properties

Schema Schema Schema Schema

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

Methods

GetParametersData(ParametersCallback) GetParametersData(ParametersCallback) GetParametersData(ParametersCallback) GetParametersData(ParametersCallback)

Gets the value of the data from the connection provider.

SetConsumerSchema(PropertyDescriptorCollection) SetConsumerSchema(PropertyDescriptorCollection) SetConsumerSchema(PropertyDescriptorCollection) SetConsumerSchema(PropertyDescriptorCollection)

Sets the property descriptors for the properties that the consumer receives when calling the GetParametersData(ParametersCallback) method.

Applies to