ServiceFilterAttribute Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc

Assembly:: Microsoft.AspNetCore.Mvc.Core.dll

Package:: Microsoft.AspNetCore.Mvc.Core v1.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v1.1.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.0.0

Package:: Microsoft.AspNetCore.Mvc.Core v2.1.0

Package:: Microsoft.AspNetCore.Mvc.Core 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

Package:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

Source:: ServiceFilterAttribute.cs

Source:: ServiceFilterAttribute.cs

Source:: ServiceFilterAttribute.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A filter that finds another filter in an IServiceProvider.

public ref class ServiceFilterAttribute : Attribute, Microsoft::AspNetCore::Mvc::Filters::IFilterFactory, Microsoft::AspNetCore::Mvc::Filters::IOrderedFilter

[System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)]
public class ServiceFilterAttribute : Attribute, Microsoft.AspNetCore.Mvc.Filters.IFilterFactory, Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter

[<System.AttributeUsage(System.AttributeTargets.Class | System.AttributeTargets.Method, AllowMultiple=true, Inherited=true)>]
type ServiceFilterAttribute = class
    inherit Attribute
    interface IFilterFactory
    interface IFilterMetadata
    interface IOrderedFilter

Public Class ServiceFilterAttribute
Inherits Attribute
Implements IFilterFactory, IOrderedFilter

Inheritance: Attribute
ServiceFilterAttribute

Derived: Microsoft.AspNetCore.Mvc.ServiceFilterAttribute<TFilter>

Attributes: AttributeUsageAttribute

Implements: IFilterFactory IFilterMetadata IOrderedFilter

Remarks

Primarily used in FilterCollection.AddService calls.

Similar to the TypeFilterAttribute in that both use constructor injection. Use TypeFilterAttribute instead if the filter is not itself a service.

Constructors

ServiceFilterAttribute(Type)

Instantiates a new ServiceFilterAttribute instance.

Properties

IsReusable	Gets a value that indicates if the result of CreateInstance(IServiceProvider) can be reused across requests.
Order	Gets the order value for determining the order of execution of filters. Filters execute in ascending numeric value of the Order property.
ServiceType	Gets the Type of filter to find.

Methods

CreateInstance(IServiceProvider)

Creates an instance of the executable filter.

Applies to

Share via