Class PageFilterBase
Base class for filters implementing IPageFilter
Inheritance
System.Object
PageFilterBase
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Filters
Assembly: EPiServer.dll
Version: 7.19.2Syntax
public abstract class PageFilterBase : IPageFilter, IContentFilterConstructors
PageFilterBase()
Initializes a new instance of the PageFilterBase class.
Declaration
protected PageFilterBase()Properties
RequestTime
Gets or sets the request time.
Declaration
public virtual DateTime? RequestTime { get; set; }Property Value
| Type | Description |
|---|---|
| System.Nullable<System.DateTime> | The request time. |
Methods
Filter(PageDataCollection)
Filters the specified pages.
Declaration
public virtual void Filter(PageDataCollection pages)Parameters
| Type | Name | Description |
|---|---|---|
| PageDataCollection | pages | The pages that should be filtered. |
Filter(IList<IContent>)
Declaration
public virtual void Filter(IList<IContent> contents)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<IContent> | contents |
Filter(Object, ContentFilterEventArgs)
Declaration
public void Filter(object sender, ContentFilterEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | |
| ContentFilterEventArgs | e |
Filter(Object, FilterEventArgs)
Eventhandler that applies the filter for a PageDataCollection.
Declaration
public virtual void Filter(object sender, FilterEventArgs e)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | sender | The class/instance that initiated the Filter event. |
| FilterEventArgs | e | The see cref="EPiServer.Filters.FilterEventArgs"/> arguments containing the event data. |
ShouldFilter(IContent)
If the content should be filtered.
Declaration
public abstract bool ShouldFilter(IContent content)Parameters
| Type | Name | Description |
|---|---|---|
| IContent | content |
Returns
| Type | Description |
|---|---|
| System.Boolean | True if the filter will remove the page; otherwise false. |
ShouldFilter(PageData)
If the page should be filtered.
Declaration
public abstract 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. |
