-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
ScriptControl.xml
246 lines (234 loc) · 17.6 KB
/
ScriptControl.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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<Type Name="ScriptControl" FullName="System.Web.UI.ScriptControl">
<TypeSignature Language="C#" Value="public abstract class ScriptControl : System.Web.UI.WebControls.WebControl, System.Web.UI.IScriptControl" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ScriptControl extends System.Web.UI.WebControls.WebControl implements class System.Web.UI.IScriptControl" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.ScriptControl" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ScriptControl
Inherits WebControl
Implements IScriptControl" />
<TypeSignature Language="F#" Value="type ScriptControl = class
 inherit WebControl
 interface IScriptControl" />
<TypeSignature Language="C++ CLI" Value="public ref class ScriptControl abstract : System::Web::UI::WebControls::WebControl, System::Web::UI::IScriptControl" />
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.WebControl</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.UI.IScriptControl</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>Provides an abstract base class for a script control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Web.UI.ScriptControl> inherits from the <xref:System.Web.UI.WebControls.WebControl> class and implements the <xref:System.Web.UI.IScriptControl> interface. The <xref:System.Web.UI.WebControls.WebControl> class is a base class for ASP.NET Web server controls. The <xref:System.Web.UI.ScriptControl> is an abstract class, which you cannot instantiate directly. Instead, you derive a class based on this abstract class.
The <xref:System.Web.UI.ScriptControl> base class tests the page for a <xref:System.Web.UI.ScriptManager> control during the `PreRender` stage of the derived control. The <xref:System.Web.UI.ScriptControl> base class also makes sure that the derived control calls methods of the <xref:System.Web.UI.ScriptManager> control to register script during the `Render` event. This includes registering <xref:System.Web.UI.ScriptDescriptor> objects for the <xref:System.Web.UI.ScriptControl> when the <xref:System.Web.UI.ScriptControl.Render%2A> method is called. The <xref:System.Web.UI.ScriptControl.Render%2A> method makes sure that <xref:System.Web.UI.ScriptDescriptor> objects are not rendered unless the <xref:System.Web.UI.ScriptControl> itself is rendered. This enables a <xref:System.Web.UI.ScriptControl> to work inside a closed <xref:System.Web.UI.WebControls.WebParts.WebPart> control.
You can add as many descriptors and types as necessary to any class that you derive from <xref:System.Web.UI.ScriptControl>.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ScriptControl ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 ScriptControl();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.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.UI.ScriptControl" /> class in a derived class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetScriptDescriptors">
<MemberSignature Language="C#" Value="protected abstract System.Collections.Generic.IEnumerable<System.Web.UI.ScriptDescriptor> GetScriptDescriptors ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class System.Web.UI.ScriptDescriptor> GetScriptDescriptors() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.GetScriptDescriptors" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function GetScriptDescriptors () As IEnumerable(Of ScriptDescriptor)" />
<MemberSignature Language="F#" Value="abstract member GetScriptDescriptors : unit -> seq<System.Web.UI.ScriptDescriptor>" Usage="scriptControl.GetScriptDescriptors " />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::Collections::Generic::IEnumerable<System::Web::UI::ScriptDescriptor ^> ^ GetScriptDescriptors();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Web.UI.ScriptDescriptor></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>When overridden in a derived class, returns the <see cref="T:System.Web.UI.ScriptDescriptor" /> objects for the control.</summary>
<returns>An <see cref="T:System.Collections.IEnumerable" /> collection of <see cref="T:System.Web.UI.ScriptDescriptor" /> objects.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetScriptReferences">
<MemberSignature Language="C#" Value="protected abstract System.Collections.Generic.IEnumerable<System.Web.UI.ScriptReference> GetScriptReferences ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class System.Web.UI.ScriptReference> GetScriptReferences() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.GetScriptReferences" />
<MemberSignature Language="VB.NET" Value="Protected MustOverride Function GetScriptReferences () As IEnumerable(Of ScriptReference)" />
<MemberSignature Language="F#" Value="abstract member GetScriptReferences : unit -> seq<System.Web.UI.ScriptReference>" Usage="scriptControl.GetScriptReferences " />
<MemberSignature Language="C++ CLI" Value="protected:
 abstract System::Collections::Generic::IEnumerable<System::Web::UI::ScriptReference ^> ^ GetScriptReferences();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Web.UI.ScriptReference></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>When overridden in a derived class, returns the script files for the control.</summary>
<returns>An <see cref="T:System.Collections.IEnumerable" /> collection that contains ECMAScript (JavaScript) files that have been registered as embedded resources.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="OnPreRender">
<MemberSignature Language="C#" Value="protected internal override void OnPreRender (EventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void OnPreRender(class System.EventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.OnPreRender(System.EventArgs)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub OnPreRender (e As EventArgs)" />
<MemberSignature Language="F#" Value="override this.OnPreRender : EventArgs -> unit" Usage="scriptControl.OnPreRender e" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void OnPreRender(EventArgs ^ e);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<param name="e">An <see cref="T:System.EventArgs" /> object that contains the event data.</param>
<summary>Raises the <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)" /> event and registers the script control with the <see cref="T:System.Web.UI.ScriptManager" /> control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
After the <xref:System.Web.UI.Control.PreRender> event of the base class is raised, the <xref:System.Web.UI.Control.OnPreRender%2A> method registers the script control with the <xref:System.Web.UI.ScriptManager> control.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="protected internal override void Render (System.Web.UI.HtmlTextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void Render(class System.Web.UI.HtmlTextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.Render(System.Web.UI.HtmlTextWriter)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub Render (writer As HtmlTextWriter)" />
<MemberSignature Language="F#" Value="override this.Render : System.Web.UI.HtmlTextWriter -> unit" Usage="scriptControl.Render writer" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void Render(System::Web::UI::HtmlTextWriter ^ writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<param name="writer">The <see cref="T:System.Web.UI.HtmlTextWriter" /> object that receives the server control content.</param>
<summary>Raises the <see cref="M:System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter)" /> event and sends server control content to a provided <see cref="T:System.Web.UI.HtmlTextWriter" /> object, which writes the content to be rendered to the browser.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.UI.HtmlTextWriter" />
</Docs>
</Member>
<Member MemberName="System.Web.UI.IScriptControl.GetScriptDescriptors">
<MemberSignature Language="C#" Value="System.Collections.Generic.IEnumerable<System.Web.UI.ScriptDescriptor> IScriptControl.GetScriptDescriptors ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class System.Web.UI.ScriptDescriptor> System.Web.UI.IScriptControl.GetScriptDescriptors() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.System#Web#UI#IScriptControl#GetScriptDescriptors" />
<MemberSignature Language="VB.NET" Value="Function GetScriptDescriptors () As IEnumerable(Of ScriptDescriptor) Implements IScriptControl.GetScriptDescriptors" />
<MemberSignature Language="F#" Value="abstract member System.Web.UI.IScriptControl.GetScriptDescriptors : unit -> seq<System.Web.UI.ScriptDescriptor>
override this.System.Web.UI.IScriptControl.GetScriptDescriptors : unit -> seq<System.Web.UI.ScriptDescriptor>" Usage="scriptControl.System.Web.UI.IScriptControl.GetScriptDescriptors " />
<MemberSignature Language="C++ CLI" Value=" virtual System::Collections::Generic::IEnumerable<System::Web::UI::ScriptDescriptor ^> ^ System.Web.UI.IScriptControl.GetScriptDescriptors() = System::Web::UI::IScriptControl::GetScriptDescriptors;" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Web.UI.IScriptControl.GetScriptDescriptors</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.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>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Web.UI.ScriptDescriptor></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>When overridden in a derived class, registers the <see cref="T:System.Web.UI.ScriptDescriptor" /> objects for the control.</summary>
<returns>An <see cref="T:System.Collections.IEnumerable" /> collection of <see cref="T:System.Web.UI.ScriptDescriptor" /> objects.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This member is an explicit interface member implementation. It can be used only when the <xref:System.Web.UI.ScriptControl> instance is cast to an <xref:System.Web.UI.IScriptControl> interface.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="System.Web.UI.IScriptControl.GetScriptReferences">
<MemberSignature Language="C#" Value="System.Collections.Generic.IEnumerable<System.Web.UI.ScriptReference> IScriptControl.GetScriptReferences ();" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance class System.Collections.Generic.IEnumerable`1<class System.Web.UI.ScriptReference> System.Web.UI.IScriptControl.GetScriptReferences() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ScriptControl.System#Web#UI#IScriptControl#GetScriptReferences" />
<MemberSignature Language="VB.NET" Value="Function GetScriptReferences () As IEnumerable(Of ScriptReference) Implements IScriptControl.GetScriptReferences" />
<MemberSignature Language="F#" Value="abstract member System.Web.UI.IScriptControl.GetScriptReferences : unit -> seq<System.Web.UI.ScriptReference>
override this.System.Web.UI.IScriptControl.GetScriptReferences : unit -> seq<System.Web.UI.ScriptReference>" Usage="scriptControl.System.Web.UI.IScriptControl.GetScriptReferences " />
<MemberSignature Language="C++ CLI" Value=" virtual System::Collections::Generic::IEnumerable<System::Web::UI::ScriptReference ^> ^ System.Web.UI.IScriptControl.GetScriptReferences() = System::Web::UI::IScriptControl::GetScriptReferences;" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Web.UI.IScriptControl.GetScriptReferences</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Web.Extensions</AssemblyName>
<AssemblyVersion>3.5.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>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Web.UI.ScriptReference></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>When overridden in a derived class, registers script files for the control.</summary>
<returns>An <see cref="T:System.Collections.IEnumerable" /> collection that contains ECMAScript (JavaScript) files that have been registered as embedded resources.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This member is an explicit interface member implementation. It can be used only when the <xref:System.Web.UI.ScriptControl> instance is cast to an <xref:System.Web.UI.IScriptControl> interface.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>