IsFilterActive Method

The IsFilterActive method of the IRuntimeFilter interface is used to control whether the runtime filter is active and visible for different sites.

Return Value

true if a runtime 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 achitecture 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.

Requirements

Platforms: Windows Server 2003

Security: Code Access Security