IFilterValues.SetConsumerParameters Method

Called by a filter consumer to indicate what parameters it supports.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No

Syntax

'Declaration
Sub SetConsumerParameters ( _
    parameters As ReadOnlyCollection(Of ConsumerParameter) _
)
'Usage
Dim instance As IFilterValues
Dim parameters As ReadOnlyCollection(Of ConsumerParameter)

instance.SetConsumerParameters(parameters)
void SetConsumerParameters(
    ReadOnlyCollection<ConsumerParameter> parameters
)

Parameters

Remarks

This information is used during WebPart connection configuration to allow the user to select which consumer parameter to filter with a particular filter provider. This method also sets the connection configuration to prevent the connection of incompatible providers and consumers.

Because the ConsumerParameter objects are in a read-only collection, they can be added to or deleted from parameters in the WebPartPage class but not updated on an individual basis.

See Also

Reference

IFilterValues Interface

IFilterValues Members

Microsoft.SharePoint.WebPartPages Namespace

ConsumerParameter

IFilter

ReadOnlyCollection