November Happy Hour will be moved to Thursday December 5th.

Interface IPageFilter

Interface for filters that can be applied to remove or sort pages for a PageDataCollection.

Namespace: EPiServer.Filters
Assembly: EPiServer.Cms.AspNet.dll
Version: 11.20.7
Syntax
public interface IPageFilter

Methods

Filter(PageDataCollection)

Filters the specified pages.

Declaration
void Filter(PageDataCollection pages)
Parameters
Type Name Description
PageDataCollection pages

The pages that should be filtered.

Filter(Object, FilterEventArgs)

Event handler that applies the filter for a PageDataCollection.

Declaration
void Filter(object sender, FilterEventArgs e)
Parameters
Type Name Description
System.Object sender

The class/instance that initiated the Filter event.

FilterEventArgs e

The FilterEventArgs arguments containing the event data.

ShouldFilter(PageData)

If the page should be filtered.

Declaration
bool ShouldFilter(PageData page)
Parameters
Type Name Description
PageData page

The page that you want to check.

Returns
Type Description
System.Boolean

True if the filter will remove the page; otherwise false.

Extension Methods