/
IOrderedFilter.xml
93 lines (93 loc) · 6.2 KB
/
IOrderedFilter.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
<Type Name="IOrderedFilter" FullName="Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter">
<TypeSignature Language="C++ CLI" Value="public interface class IOrderedFilter : Microsoft::AspNetCore::Mvc::Filters::IFilterMetadata" />
<TypeSignature Language="C#" Value="public interface IOrderedFilter : Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IOrderedFilter implements class Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter" />
<TypeSignature Language="VB.NET" Value="Public Interface IOrderedFilter
Implements IFilterMetadata" />
<TypeSignature Language="F#" Value="type IOrderedFilter = interface
 interface IFilterMetadata" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IOrderedFilter implements class Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata" FrameworkAlternate="aspnetcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.AspNetCore.Mvc.Filters.IFilterMetadata</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
A filter that specifies the relative order it should run.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Order">
<MemberSignature Language="C++ CLI" Value="public:
 property int Order { int get(); };" />
<MemberSignature Language="C#" Value="public int Order { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Order" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Order As Integer" />
<MemberSignature Language="F#" Value="member this.Order : int" Usage="Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Mvc.Abstractions</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the order value for determining the order of execution of filters. Filters execute in
ascending numeric value of the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" /> property.
</summary>
<value>To be added.</value>
<remarks>
<para>
Filters are executed in an ordering determined by an ascending sort of the <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" /> property.
</para>
<para>
Asynchronous filters, such as <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter" />, surround the execution of subsequent
filters of the same filter kind. An asynchronous filter with a lower numeric <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />
value will have its filter method, such as <see cref="M:Microsoft.AspNetCore.Mvc.Filters.IAsyncActionFilter.OnActionExecutionAsync(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext,Microsoft.AspNetCore.Mvc.Filters.ActionExecutionDelegate)" />,
executed before that of a filter with a higher value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />.
</para>
<para>
Synchronous filters, such as <see cref="T:Microsoft.AspNetCore.Mvc.Filters.IActionFilter" />, have a before-method, such as
<see cref="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuting(Microsoft.AspNetCore.Mvc.Filters.ActionExecutingContext)" />, and an after-method, such as
<see cref="M:Microsoft.AspNetCore.Mvc.Filters.IActionFilter.OnActionExecuted(Microsoft.AspNetCore.Mvc.Filters.ActionExecutedContext)" />. A synchronous filter with a lower numeric <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />
value will have its before-method executed before that of a filter with a higher value of
<see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />. During the after-stage of the filter, a synchronous filter with a lower
numeric <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" /> value will have its after-method executed after that of a filter with a higher
value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />.
</para>
<para>
If two filters have the same numeric value of <see cref="P:Microsoft.AspNetCore.Mvc.Filters.IOrderedFilter.Order" />, then their relative execution order
is determined by the filter scope.
</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>