ConsumerParameterCapabilities Enumeration
Used by a consumer Web part to indicate supported filter parameter capabilities.
This enumeration has a FlagsAttribute attribute that allows a bitwise combination of its member values.
Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: No
Syntax
'Declaration
<FlagsAttribute> _
Public Enumeration ConsumerParameterCapabilities
'Usage
Dim instance As ConsumerParameterCapabilities
[FlagsAttribute]
public enum ConsumerParameterCapabilities
Members
| Member name | Description | |
|---|---|---|
| SupportsSingleValue | Indicates that the consumer supports a single value for the specified parameter. This is the default value; the capability to consume a single parameter value is always implied by all of the other ConsumerParameterCapabilities. | |
| SupportsAllValue | Indicates that the consumer supports the "All" value for the specified parameter. | |
| SupportsEmptyValue | Indicates that the consumer supports the "Empty" value for the specified filter parameter. | |
| SupportsMultipleValues | Indicates that the consumer supports multiple values for the specified filter parameter. |
Remarks
These capabilities are used by the filter framework to enable or disable specific types of incompatible connections and specific types of provider Web Part options. For example, a provider Web Part is not allowed to send multiple values when it is connected to a consumer that only supports single-valued parameters.
For a specified filter parameter, a consumer may have the ability to receive a single-valued parameter or multivalued parameter. In addition, it may support the special "All" or "Empty" values.
If the "All" filter value is passed to a consumer, it indicates that the consumer should interpret the parameter as multivalued and as one that contains every value possible for that parameter. For example, if "All" is passed to a parameter that represents countries, the consumer should interpret that filter value as including all countries. In many cases, the effect is that when the consumer receives the "All" value it does not filter on that parameter.
The "Empty" value typically represents missing or NULL data. For example, a consumer may be asked to filter based on a field that has no value, such as customers who have no sales.
See Also
Reference
Microsoft.SharePoint.WebPartPages Namespace