IRuntimeFilter.IsFilterActive method
NOTE: This API is now obsolete.
Controls whether the runtime filter is active and visible for different sites.
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 IsFilterActive As Boolean
'Usage
Dim instance As IRuntimeFilter
Dim returnValue As Boolean
returnValue = instance.IsFilterActive()
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[ObsoleteAttribute("Use IRuntimeFilter2 instead.")]
bool IsFilterActive()
Return value
Type: System.Boolean
true if a run-time filter exists for the site; otherwise, false.
Remarks
The IsFilterActive method should return true if a runtime filter exists for the site. Otherwise, it should return false. The Web Part architecture will call this method before calling the CheckRuntimeRender method. If IsFilterActive returns false, the CheckRuntimeRender will not be called and the custom builder will not be rendered for the IsIncludedFilter property in the property sheet. If IsFilterActive method returns true, the CheckRuntimeRender method will be called and the IsIncludedFilter custom builder will be rendered in the property sheet.