IFilterValues.ParameterValues Property

Gets the actual parameter values from the filter provider that will be used by the filter consumer.

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

Syntax

'Declaration
ReadOnly Property ParameterValues As ReadOnlyCollection(Of String)
    Get
'Usage
Dim instance As IFilterValues
Dim value As ReadOnlyCollection(Of String)

value = instance.ParameterValues
ReadOnlyCollection<string> ParameterValues { get; }

Property Value

Type: System.Collections.ObjectModel.ReadOnlyCollection<String>
The collection of values that is sent by the provider.

Remarks

Parameters provide a mechanism that data source controls use to bind to application variables, user identities and choices, and other data.

The ParameterValues property can be a null reference (Nothing in Visual Basic) (Nothing in Visual Basic) to indicate the special "All" value.

An individual value in the ParameterValues collection may be a null reference (Nothing in Visual Basic) (Nothing in Visual Basic) to indicate the special "Empty" value.

The ParameterValues property may also return an empty collection to indicate that the filter provider did not send any items.

Examples

Example 1: If a filter configured to send country names from the provider wants to indicate all countries, it returns a null reference (Nothing in Visual Basic) from the ParameterValues property.

Example 2: If the same filter is configured to return multiple values, it may return a collection of country names.

Example 3: If the same filter has no countries selected, then it returns an empty collection.

See Also

Reference

IFilterValues Interface

IFilterValues Members

Microsoft.SharePoint.WebPartPages Namespace

WebControls

Parameter

ParameterValues