-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
PageHandlerFactory.xml
137 lines (130 loc) · 9.24 KB
/
PageHandlerFactory.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
<Type Name="PageHandlerFactory" FullName="System.Web.UI.PageHandlerFactory">
<TypeSignature Language="C#" Value="public class PageHandlerFactory" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PageHandlerFactory extends System.Object implements class System.Web.IHttpHandlerFactory" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.PageHandlerFactory" />
<TypeSignature Language="VB.NET" Value="Public Class PageHandlerFactory" />
<TypeSignature Language="F#" Value="type PageHandlerFactory = class
 interface IHttpHandlerFactory" />
<TypeSignature Language="C++ CLI" Value="public ref class PageHandlerFactory" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.IHttpHandlerFactory</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Creates instances of classes that inherit from the <see cref="T:System.Web.UI.Page" /> class and implement the <see cref="T:System.Web.IHttpHandler" /> interface. Instances are created dynamically to handle requests for ASP.NET files. The <see cref="T:System.Web.UI.PageHandlerFactory" /> class is the default handler factory implementation for ASP.NET pages.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.PageHandlerFactory> class implements the <xref:System.Web.IHttpHandlerFactory> interface to provide the default HTTP handler for ASP.NET files. The <xref:System.Web.UI.PageHandlerFactory> calls the ASP.NET compilation system to compile, if necessary, and return the exact type corresponding to the URL, and then creates an instance of that type. The page type inherits from the <xref:System.Web.UI.Page> class and implements the <xref:System.Web.IHttpHandler> interface.
To build a custom page handler factory, implement the <xref:System.Web.IHttpHandlerFactory> and register the custom <xref:System.Web.UI.PageHandlerFactory> class in the Web.config file for the application in the [httpHandlers Element (ASP.NET Settings Schema)](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/bya7fh0a(v=vs.100)) configuration section.
]]></format>
</remarks>
<altmember cref="T:System.Web.IHttpHandler" />
<altmember cref="T:System.Web.IHttpHandlerFactory" />
<altmember cref="T:System.Web.Services.Protocols.WebServiceHandlerFactory" />
<related type="Article" href="https://learn.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="protected internal PageHandlerFactory ();" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.PageHandlerFactory.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Friend Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected public:
 PageHandlerFactory();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.PageHandlerFactory" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.PageHandlerFactory.%23ctor%2A> constructor is the parameterless constructor and initializes any fields to their default values.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="GetHandler">
<MemberSignature Language="C#" Value="public virtual System.Web.IHttpHandler GetHandler (System.Web.HttpContext context, string requestType, string virtualPath, string path);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Web.IHttpHandler GetHandler(class System.Web.HttpContext context, string requestType, string virtualPath, string path) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.PageHandlerFactory.GetHandler(System.Web.HttpContext,System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function GetHandler (context As HttpContext, requestType As String, virtualPath As String, path As String) As IHttpHandler" />
<MemberSignature Language="F#" Value="abstract member GetHandler : System.Web.HttpContext * string * string * string -> System.Web.IHttpHandler
override this.GetHandler : System.Web.HttpContext * string * string * string -> System.Web.IHttpHandler" Usage="pageHandlerFactory.GetHandler (context, requestType, virtualPath, path)" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual System::Web::IHttpHandler ^ GetHandler(System::Web::HttpContext ^ context, System::String ^ requestType, System::String ^ virtualPath, System::String ^ path);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Web.IHttpHandlerFactory.GetHandler(System.Web.HttpContext,System.String,System.String,System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.IHttpHandler</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="context" Type="System.Web.HttpContext" />
<Parameter Name="requestType" Type="System.String" />
<Parameter Name="virtualPath" Type="System.String" />
<Parameter Name="path" Type="System.String" />
</Parameters>
<Docs>
<param name="context">An instance of the <see cref="T:System.Web.HttpContext" /> class that provides references to intrinsic server objects (for example, Request, Response, Session, and Server) used to service HTTP requests.</param>
<param name="requestType">The HTTP data transfer method (GET or POST) that the client uses.</param>
<param name="virtualPath">The virtual path to the requested resource.</param>
<param name="path">The <see cref="P:System.Web.HttpRequest.PhysicalApplicationPath" /> property to the requested resource.</param>
<summary>Returns an instance of the <see cref="T:System.Web.IHttpHandler" /> interface to process the requested resource.</summary>
<returns>A new <see cref="T:System.Web.IHttpHandler" /> that processes the request; otherwise, <see langword="null" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.PageHandlerFactory.GetHandler%2A> method is called by the ASP.NET run time and returns either a valid instance of the <xref:System.Web.IHttpHandler> interface or `null`.
]]></format>
</remarks>
<altmember cref="M:System.Web.IHttpHandlerFactory.GetHandler(System.Web.HttpContext,System.String,System.String,System.String)" />
</Docs>
</Member>
<Member MemberName="ReleaseHandler">
<MemberSignature Language="C#" Value="public virtual void ReleaseHandler (System.Web.IHttpHandler handler);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void ReleaseHandler(class System.Web.IHttpHandler handler) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.PageHandlerFactory.ReleaseHandler(System.Web.IHttpHandler)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub ReleaseHandler (handler As IHttpHandler)" />
<MemberSignature Language="F#" Value="abstract member ReleaseHandler : System.Web.IHttpHandler -> unit
override this.ReleaseHandler : System.Web.IHttpHandler -> unit" Usage="pageHandlerFactory.ReleaseHandler handler" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void ReleaseHandler(System::Web::IHttpHandler ^ handler);" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Web.IHttpHandlerFactory.ReleaseHandler(System.Web.IHttpHandler)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="System.Web.IHttpHandler" />
</Parameters>
<Docs>
<param name="handler">The <see cref="T:System.Web.IHttpHandler" /> to reuse.</param>
<summary>Enables a factory to reuse an existing instance of a handler.</summary>
<remarks>To be added.</remarks>
<altmember cref="M:System.Web.IHttpHandlerFactory.ReleaseHandler(System.Web.IHttpHandler)" />
</Docs>
</Member>
</Members>
</Type>