-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
HtmlHead.xml
353 lines (325 loc) · 19.6 KB
/
HtmlHead.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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
<Type Name="HtmlHead" FullName="System.Web.UI.HtmlControls.HtmlHead">
<TypeSignature Language="C#" Value="public sealed class HtmlHead : System.Web.UI.HtmlControls.HtmlGenericControl" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit HtmlHead extends System.Web.UI.HtmlControls.HtmlGenericControl" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.HtmlControls.HtmlHead" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class HtmlHead
Inherits HtmlGenericControl" />
<TypeSignature Language="F#" Value="type HtmlHead = class
 inherit HtmlGenericControl" />
<TypeSignature Language="C++ CLI" Value="public ref class HtmlHead sealed : System::Web::UI::HtmlControls::HtmlGenericControl" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.HtmlControls.HtmlGenericControl</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.ControlBuilder(typeof(System.Web.UI.HtmlControls.HtmlHeadBuilder))]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.ControlBuilder(typeof(System.Web.UI.HtmlControls.HtmlHeadBuilder))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides programmatic access to the HTML <see langword="head" /> element in server code.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The HTML `head` element is a container that can contain additional information about the page. The <xref:System.Web.UI.HtmlControls.HtmlHead> control is useful for specifying page formatting information that can be accessed at run time.
> [!NOTE]
> Adding styles or style rules programmatically during asynchronous postbacks is not supported. When you add AJAX capabilities to an ASP.NET Web page, asynchronous postbacks update regions of the page without updating the whole page. For more information, see [Microsoft Ajax Overview](https://learn.microsoft.com/previous-versions/aspnet/bb398874(v=vs.100)).
## Examples
The following example shows how to programmatically access the <xref:System.Web.UI.HtmlControls.HtmlHead> control to dynamically add `title` and `style` elements to the `head` element of the page.
[!code-aspx-csharp[System.Web.UI.HtmlControls.HtmlHeadClass#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlHeadClass/CS/htmlheadclasscs.aspx#1)]
[!code-aspx-vb[System.Web.UI.HtmlControls.HtmlHeadClass#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlHeadClass/VB/htmlheadclassvb.aspx#1)]
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.Page.Header" />
<altmember cref="T:System.Web.UI.HtmlControls.HtmlLink" />
<altmember cref="T:System.Web.UI.HtmlControls.HtmlMeta" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlHead" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HtmlHead ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlHead.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 HtmlHead();" />
<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.HtmlControls.HtmlHead" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the initial property value for an instance of <xref:System.Web.UI.HtmlControls.HtmlHead>.
|Property|Initial value|
|--------------|-------------------|
|<xref:System.Web.UI.HtmlControls.HtmlControl.TagName%2A>|The string "head".|
## Examples
The following example shows how to programmatically add an <xref:System.Web.UI.HtmlControls.HtmlHead> control to a page and add `title` and `link` elements to it.
[!code-aspx-csharp[System.Web.UI.HtmlControls.HtmlHeadCstr#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlHeadCstr/CS/htmlheadcstrcs.aspx#1)]
[!code-aspx-vb[System.Web.UI.HtmlControls.HtmlHeadCstr#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlHeadCstr/VB/htmlheadcstrvb.aspx#1)]
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.Page.Header" />
<altmember cref="M:System.Web.UI.ControlCollection.AddAt(System.Int32,System.Web.UI.Control)" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HtmlHead (string tag);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string tag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlHead.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tag As String)" />
<MemberSignature Language="F#" Value="new System.Web.UI.HtmlControls.HtmlHead : string -> System.Web.UI.HtmlControls.HtmlHead" Usage="new System.Web.UI.HtmlControls.HtmlHead tag" />
<MemberSignature Language="C++ CLI" Value="public:
 HtmlHead(System::String ^ tag);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tag" Type="System.String" />
</Parameters>
<Docs>
<param name="tag">A string that specifies the tag name of the control.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.HtmlControls.HtmlHead" /> class by using the specified tag.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The following table shows the initial property value for an instance of <xref:System.Web.UI.HtmlControls.HtmlHead>.
|Property|Initial value|
|--------------|-------------------|
|<xref:System.Web.UI.HtmlControls.HtmlControl.TagName%2A>|The value of the `tag` parameter.|
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="AddedControl">
<MemberSignature Language="C#" Value="protected internal override void AddedControl (System.Web.UI.Control control, int index);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void AddedControl(class System.Web.UI.Control control, int32 index) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlHead.AddedControl(System.Web.UI.Control,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub AddedControl (control As Control, index As Integer)" />
<MemberSignature Language="F#" Value="override this.AddedControl : System.Web.UI.Control * int -> unit" Usage="htmlHead.AddedControl (control, index)" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void AddedControl(System::Web::UI::Control ^ control, int index);" />
<MemberType>Method</MemberType>
<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="control" Type="System.Web.UI.Control" />
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="control">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Description" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlHead.Description" />
<MemberSignature Language="VB.NET" Value="Public Property Description As String" />
<MemberSignature Language="F#" Value="member this.Description : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlHead.Description" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Description { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the content of the "description" <see langword="meta" /> element.</summary>
<value>The content of the "description" <see langword="meta" /> element.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For information about this property, see the <xref:System.Web.UI.Page.MetaDescription%2A?displayProperty=nameWithType> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Keywords">
<MemberSignature Language="C#" Value="public string Keywords { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Keywords" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlHead.Keywords" />
<MemberSignature Language="VB.NET" Value="Public Property Keywords As String" />
<MemberSignature Language="F#" Value="member this.Keywords : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlHead.Keywords" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Keywords { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the content of the "keywords" <see langword="meta" /> element.</summary>
<value>The content of the "keywords" <see langword="meta" /> element.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For information about this property, see the <xref:System.Web.UI.Page.MetaKeywords%2A?displayProperty=nameWithType> property.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="OnInit">
<MemberSignature Language="C#" Value="protected internal override void OnInit (EventArgs e);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void OnInit(class System.EventArgs e) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlHead.OnInit(System.EventArgs)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub OnInit (e As EventArgs)" />
<MemberSignature Language="F#" Value="override this.OnInit : EventArgs -> unit" Usage="htmlHead.OnInit e" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void OnInit(EventArgs ^ e);" />
<MemberType>Method</MemberType>
<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="e" Type="System.EventArgs" />
</Parameters>
<Docs>
<param name="e">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemovedControl">
<MemberSignature Language="C#" Value="protected internal override void RemovedControl (System.Web.UI.Control control);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void RemovedControl(class System.Web.UI.Control control) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlHead.RemovedControl(System.Web.UI.Control)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub RemovedControl (control As Control)" />
<MemberSignature Language="F#" Value="override this.RemovedControl : System.Web.UI.Control -> unit" Usage="htmlHead.RemovedControl control" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void RemovedControl(System::Web::UI::Control ^ control);" />
<MemberType>Method</MemberType>
<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="control" Type="System.Web.UI.Control" />
</Parameters>
<Docs>
<param name="control">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RenderChildren">
<MemberSignature Language="C#" Value="protected internal override void RenderChildren (System.Web.UI.HtmlTextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyorassemblyhidebysig virtual instance void RenderChildren(class System.Web.UI.HtmlTextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlHead.RenderChildren(System.Web.UI.HtmlTextWriter)" />
<MemberSignature Language="VB.NET" Value="Protected Friend Overrides Sub RenderChildren (writer As HtmlTextWriter)" />
<MemberSignature Language="F#" Value="override this.RenderChildren : System.Web.UI.HtmlTextWriter -> unit" Usage="htmlHead.RenderChildren writer" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void RenderChildren(System::Web::UI::HtmlTextWriter ^ writer);" />
<MemberType>Method</MemberType>
<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="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<param name="writer">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StyleSheet">
<MemberSignature Language="C#" Value="public System.Web.UI.IStyleSheet StyleSheet { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.IStyleSheet StyleSheet" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlHead.StyleSheet" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property StyleSheet As IStyleSheet" />
<MemberSignature Language="F#" Value="member this.StyleSheet : System.Web.UI.IStyleSheet" Usage="System.Web.UI.HtmlControls.HtmlHead.StyleSheet" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::UI::IStyleSheet ^ StyleSheet { System::Web::UI::IStyleSheet ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.IStyleSheet</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets an <see cref="T:System.Web.UI.IStyleSheet" /> instance that represents the style rules in the <see cref="T:System.Web.UI.HtmlControls.HtmlHead" /> control.</summary>
<value>An object that represents the style rules in the <see cref="T:System.Web.UI.HtmlControls.HtmlHead" /> control.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.HtmlControls.HtmlHead.StyleSheet%2A> property returns an <xref:System.Web.UI.IStyleSheet> that represents the embedded style rules in the <xref:System.Web.UI.HtmlControls.HtmlHead> control.
> [!NOTE]
> Adding styles or style rules programmatically during asynchronous postbacks is not supported. When you add AJAX capabilities to an ASP.NET Web page, asynchronous postbacks update regions of the page without updating the whole page. For more information, see [Microsoft Ajax Overview](https://learn.microsoft.com/previous-versions/aspnet/bb398874(v=vs.100)).
## Examples
The following example shows how to programmatically add an embedded style rule for the HTML `body` element. This example is part of a larger example provided for the <xref:System.Web.UI.HtmlControls.HtmlHead> class.
[!code-csharp[System.Web.UI.HtmlControls.HtmlHeadClass#2](~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlHeadClass/CS/htmlheadclasscs.aspx#2)]
[!code-vb[System.Web.UI.HtmlControls.HtmlHeadClass#2](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlHeadClass/VB/htmlheadclassvb.aspx#2)]
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.IStyleSheet" />
</Docs>
</Member>
<Member MemberName="Title">
<MemberSignature Language="C#" Value="public string Title { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Title" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlHead.Title" />
<MemberSignature Language="VB.NET" Value="Public Property Title As String" />
<MemberSignature Language="F#" Value="member this.Title : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlHead.Title" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Title { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the page title.</summary>
<value>The page title.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.Web.UI.HtmlControls.HtmlTitle" />
</Docs>
</Member>
</Members>
</Type>