/
HttpHandlersSection.xml
158 lines (141 loc) · 9.97 KB
/
HttpHandlersSection.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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
<Type Name="HttpHandlersSection" FullName="System.Web.Configuration.HttpHandlersSection">
<TypeSignature Language="C#" Value="public sealed class HttpHandlersSection : System.Configuration.ConfigurationSection" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed HttpHandlersSection extends System.Configuration.ConfigurationSection" />
<TypeSignature Language="DocId" Value="T:System.Web.Configuration.HttpHandlersSection" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class HttpHandlersSection
Inherits ConfigurationSection" />
<TypeSignature Language="F#" Value="type HttpHandlersSection = class
 inherit ConfigurationSection" />
<TypeSignature Language="C++ CLI" Value="public ref class HttpHandlersSection sealed : System::Configuration::ConfigurationSection" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationSection</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Configures an HTTP handler for a Web application. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.HttpHandlersSection> class provides a way to programmatically access and modify the `httpHandlers` section of a configuration file. This type is part of a group that includes the <xref:System.Web.Configuration.HttpHandlerAction> and the <xref:System.Web.Configuration.HttpHandlerActionCollection> types.
> [!NOTE]
> The <xref:System.Web.Configuration.HttpHandlersSection> can read and write information from and to the related section of the configuration file according to the <xref:System.Configuration.SectionInformation.AllowDefinition%2A> section property whose value is <xref:System.Configuration.ConfigurationAllowDefinition.Everywhere>.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.HttpHandlersSection> class to access the `httpHandlers` section of an existing Web application.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HttpHandlers/CS/httphandlers.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HttpHandlers/VB/httphandlers.vb" id="Snippet1":::
The following configuration excerpt shows how to specify values declaratively for the `httpHandlers` section.
```
<httpHandlers>
<add path="Calculator.custom"
type="Samples.Aspnet.SystemWebConfiguration.Calculator, CalculatorHandler"
verb="GET" validate="false" />
</httpHandlers>
```
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.HttpHandlerActionCollection" />
<altmember cref="T:System.Web.Configuration.HttpHandlerAction" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/bb398986(v=vs.100)">HTTP Handlers and HTTP Modules Overview</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HttpHandlersSection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.HttpHandlersSection.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 HttpHandlersSection();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.Configuration.HttpHandlersSection" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.HttpHandlersSection.%23ctor%2A> constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the <xref:System.Web.Configuration.HttpHandlersSection> class by using the <xref:System.Configuration.Configuration.GetSection%2A> method.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Handlers">
<MemberSignature Language="C#" Value="public System.Web.Configuration.HttpHandlerActionCollection Handlers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Configuration.HttpHandlerActionCollection Handlers" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.HttpHandlersSection.Handlers" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Handlers As HttpHandlerActionCollection" />
<MemberSignature Language="F#" Value="member this.Handlers : System.Web.Configuration.HttpHandlerActionCollection" Usage="System.Web.Configuration.HttpHandlersSection.Handlers" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Configuration::HttpHandlerActionCollection ^ Handlers { System::Web::Configuration::HttpHandlerActionCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("", IsDefaultCollection=true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Configuration.HttpHandlerActionCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Web.Configuration.HttpHandlerActionCollection" /> collection of <see cref="T:System.Web.Configuration.HttpHandlerAction" /> objects contained by the <see cref="T:System.Web.Configuration.HttpHandlersSection" /> object.</summary>
<value>An <see cref="T:System.Web.Configuration.HttpHandlerActionCollection" /> that contains the <see cref="T:System.Web.Configuration.HttpHandlerAction" /> objects, or handlers.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.HttpHandlersSection.Handlers%2A> property collection returned by this method does not refer to any actual element in the underlying configuration file. It is a <xref:System.Web.Configuration> construct that allows easy access to the handlers it contains. This is a common pattern for handling the elements of a configuration file.
## Examples
The following code example shows how to access the <xref:System.Web.Configuration.HttpHandlerAction> handlers.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.HttpHandlers/CS/httphandlers.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.HttpHandlers/VB/httphandlers.vb" id="Snippet4":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.HttpHandlerActionCollection" />
<altmember cref="T:System.Web.Configuration.HttpHandlerAction" />
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.HttpHandlersSection.Properties" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : System.Configuration.ConfigurationPropertyCollection" Usage="System.Web.Configuration.HttpHandlersSection.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>