IResultFilter Interface

  • Reference

Definition

Namespace:
Microsoft.AspNetCore.Mvc.Filters
Assembly:
Microsoft.AspNetCore.Mvc.Abstractions.dll
Package:
Microsoft.AspNetCore.Mvc.Abstractions v1.0.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v1.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.0.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.1.0
Package:
Microsoft.AspNetCore.Mvc.Abstractions v2.2.0
Package:
Microsoft.AspNetCore.App.Ref v3.0.1
Package:
Microsoft.AspNetCore.App.Ref v3.1.10
Package:
Microsoft.AspNetCore.App.Ref v5.0.0
Package:
Microsoft.AspNetCore.App.Ref v6.0.6
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.0

A filter that surrounds execution of action results successfully returned from an action.

public interface class IResultFilter : Microsoft::AspNetCore::Mvc::Filters::IFilterMetadata
public interface IResultFilter : Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata
type IResultFilter = interface
    interface IFilterMetadata
Public Interface IResultFilter
Implements IFilterMetadata
Derived
Implements
IFilterMetadata

Remarks

IResultFilter and IAsyncResultFilter implementations are executed around the action result only when the action method (or action filters) complete successfully.

IResultFilter and IAsyncResultFilter instances are not executed in cases where an authorization filter or resource filter short-circuits the request to prevent execution of the action. IResultFilter. IResultFilter and IAsyncResultFilter implementations are also not executed in cases where an exception filter handles an exception by producing an action result.

To create a result filter that surrounds the execution of all action results, implement either the IAlwaysRunResultFilter or the IAsyncAlwaysRunResultFilter interface.

Methods

OnResultExecuted(ResultExecutedContext)

Called after the action result executes.
OnResultExecuting(ResultExecutingContext)

Called before the action result executes.

Applies to