IRuntimeFilter.ValidateIsIncludedFilter method

NOTE: This API is now obsolete.

Checks that the values in the IsIncludedFilter property are valid before they are saved to the database.

Namespace:  Microsoft.SharePoint.WebPartPages
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
<PermissionSetAttribute(SecurityAction.InheritanceDemand, Name := "FullTrust")> _
<ObsoleteAttribute("Use IRuntimeFilter2 instead.")> _
Function ValidateIsIncludedFilter ( _
    persistedString As String _
) As String
'Usage
Dim instance As IRuntimeFilter
Dim persistedString As String
Dim returnValue As String

returnValue = instance.ValidateIsIncludedFilter(persistedString)
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[ObsoleteAttribute("Use IRuntimeFilter2 instead.")]
string ValidateIsIncludedFilter(
    string persistedString
)

Parameters

  • persistedString
    Type: System.String

    Contains the values of the IsIncludedFilter property.

Return value

Type: System.String
String   Contains the string IsIncludedFilter.

Remarks

The ValidateIsIncludedFilter method will throw an exception if the IsIncludedFilter property can't be validated, in which case, the Framework will detect this and follow the standard tool pane error display. The following message will be displayed: "The value for the property <third-party friendly name for IsIncludedFilter> cannot be validated."

See also

Reference

IRuntimeFilter interface

IRuntimeFilter members

Microsoft.SharePoint.WebPartPages namespace