-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
HtmlMeta.xml
319 lines (278 loc) · 20.2 KB
/
HtmlMeta.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
<Type Name="HtmlMeta" FullName="System.Web.UI.HtmlControls.HtmlMeta">
<TypeSignature Language="C#" Value="public class HtmlMeta : System.Web.UI.HtmlControls.HtmlControl" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HtmlMeta extends System.Web.UI.HtmlControls.HtmlControl" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.HtmlControls.HtmlMeta" />
<TypeSignature Language="VB.NET" Value="Public Class HtmlMeta
Inherits HtmlControl" />
<TypeSignature Language="F#" Value="type HtmlMeta = class
 inherit HtmlControl" />
<TypeSignature Language="C++ CLI" Value="public ref class HtmlMeta : System::Web::UI::HtmlControls::HtmlControl" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.HtmlControls.HtmlControl</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.ControlBuilder(typeof(System.Web.UI.HtmlControls.HtmlEmptyTagControlBuilder))]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.ControlBuilder(typeof(System.Web.UI.HtmlControls.HtmlEmptyTagControlBuilder))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Allows programmatic access to the HTML <see langword="<meta>" /> tag on the server.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.HtmlControls.HtmlMeta> control provides programmatic access to the HTML `<meta>` element on the server. The HTML `<meta>` element is a container for data about the rendered page, but not page content itself. The `<meta>` tag is placed between the opening and closing HTML `<head>` elements. Each `<meta>` element describes a metadata property name and its associated value.
Use the <xref:System.Web.UI.HtmlControls.HtmlMeta> control's <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property to specify the metadata property name, and the <xref:System.Web.UI.HtmlControls.HtmlMeta.Content%2A> property to specify the metadata property value. Use the <xref:System.Web.UI.HtmlControls.HtmlMeta.Scheme%2A> property to specify additional information to user agents on how to interpret the metadata property. Use the <xref:System.Web.UI.HtmlControls.HtmlMeta.HttpEquiv%2A> property in place of the <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property when the resulting metadata property will be retrieved using HTTP.
You can get a reference to the page `<head>` element using the <xref:System.Web.UI.Page.Header%2A> property of the <xref:System.Web.UI.Page> object.
## Examples
The following code example demonstrates how to use the <xref:System.Web.UI.HtmlControls.HtmlMeta> control to define HTML `<meta>` elements for a Web page. Two `<meta>` elements are defined, one listing keywords describing the page and one listing the date the page was created.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/cs/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/vb/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.HtmlControls.HtmlTitle" />
<altmember cref="P:System.Web.UI.Page.Header" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HtmlMeta ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.HtmlControls.HtmlMeta.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 HtmlMeta();" />
<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.HtmlMeta" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to create and initialize a new instance of the <xref:System.Web.UI.HtmlControls.HtmlMeta> control.
The following table shows initial property values for an instance of <xref:System.Web.UI.HtmlControls.HtmlMeta>.
|Property|Initial Value|
|--------------|-------------------|
|<xref:System.Web.UI.HtmlControls.HtmlControl.TagName%2A>|The "meta" literal string.|
## Examples
For an example of how to use the <xref:System.Web.UI.HtmlControls.HtmlMeta.%23ctor%2A> constructor, see the <xref:System.Web.UI.HtmlControls.HtmlMeta> class overview topic.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Content">
<MemberSignature Language="C#" Value="public virtual string Content { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Content" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlMeta.Content" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property Content As String" />
<MemberSignature Language="F#" Value="member this.Content : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlMeta.Content" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Content { 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>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the metadata property value defined by the <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control.</summary>
<value>The metadata property value.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.HtmlControls.HtmlMeta.Content%2A> property, together with the <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property, defines a metadata property of the page.
The <xref:System.Web.UI.HtmlControls.HtmlMeta.Content%2A> property is rendered to the `content` attribute of the resulting HTML `<meta>` element.
## Examples
The following code example demonstrates how to use the <xref:System.Web.UI.HtmlControls.HtmlMeta> control to define HTML `<meta>` elements for a Web page. Two `<meta>` elements are defined, one listing keywords describing the page and one listing the date the page was created. The <xref:System.Web.UI.HtmlControls.HtmlMeta.Content%2A> property is used to define the `content` attribute for each `<meta>` tag.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/cs/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/vb/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Name" />
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Scheme" />
</Docs>
</Member>
<Member MemberName="HttpEquiv">
<MemberSignature Language="C#" Value="public virtual string HttpEquiv { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HttpEquiv" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlMeta.HttpEquiv" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property HttpEquiv As String" />
<MemberSignature Language="F#" Value="member this.HttpEquiv : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlMeta.HttpEquiv" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ HttpEquiv { 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>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets an <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control property that is included in the HTTP response header.</summary>
<value>The name of the HTTP response header item.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.HtmlControls.HtmlMeta.HttpEquiv%2A> property in place of the <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property to identify information that should be included in the response headers of an HTTP request.
The <xref:System.Web.UI.HtmlControls.HtmlMeta.HttpEquiv%2A> property is rendered to the `http-equiv` attribute of the resulting HTML `<meta>` element.
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Name" />
<altmember cref="T:System.Web.HttpResponse" />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public virtual string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlMeta.Name" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlMeta.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Name { 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>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the metadata property name defined by the <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control.</summary>
<value>The property name.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property, together with the <xref:System.Web.UI.HtmlControls.HtmlMeta.Content%2A> property, defines a metadata property of the page.
The <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property is rendered to the `name` attribute of the resulting HTML `<meta>` element.
## Examples
The following code example demonstrates how to use the <xref:System.Web.UI.HtmlControls.HtmlMeta> control to define HTML `<meta>` elements for a Web page. Two `<meta>` tags are defined, one listing keywords describing the page and one listing the date the page was created. The <xref:System.Web.UI.HtmlControls.HtmlMeta.Name%2A> property is used to define the `name` attribute of each `<meta>` tag.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/cs/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/vb/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Content" />
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Scheme" />
</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.HtmlControls.HtmlMeta.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="htmlMeta.Render writer" />
<MemberSignature Language="C++ CLI" Value="protected public:
 override void Render(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">The <see cref="T:System.Web.UI.HtmlTextWriter" /> used to render the <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control's content on the client's browser.</param>
<summary>Renders the <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control to the client's browser using the specified <see cref="T:System.Web.UI.HtmlTextWriter" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.HtmlControls.HtmlMeta> control renders a <xref:System.Web.UI.HtmlTextWriter.SelfClosingTagEnd> HTML bracket (/>) on the `<meta>` element if the client's browser is XHTML compliant. For more information on configuring ASP.NET for non-XHTML rendering, see [How to: Configure XHTML Rendering in ASP.NET Web Sites](https://learn.microsoft.com/previous-versions/aspnet/ms178159(v=vs.100)).
]]></format>
</remarks>
<block subset="none" type="overrides">
<para>When extending the <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control, override the <see cref="M:System.Web.UI.HtmlControls.HtmlMeta.Render(System.Web.UI.HtmlTextWriter)" /> method to provide custom rendering.</para>
</block>
<altmember cref="F:System.Web.UI.HtmlTextWriter.SelfClosingTagEnd" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/exc57y7e(v=vs.100)">ASP.NET and XHTML Compliance</related>
</Docs>
</Member>
<Member MemberName="Scheme">
<MemberSignature Language="C#" Value="public virtual string Scheme { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Scheme" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.HtmlControls.HtmlMeta.Scheme" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property Scheme As String" />
<MemberSignature Language="F#" Value="member this.Scheme : string with get, set" Usage="System.Web.UI.HtmlControls.HtmlMeta.Scheme" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Scheme { 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>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a <see langword="scheme" /> attribute used to interpret the metadata property value defined by the <see cref="T:System.Web.UI.HtmlControls.HtmlMeta" /> control.</summary>
<value>The <see langword="scheme" /> attribute.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.HtmlControls.HtmlMeta.Scheme%2A> property allows you to specify a `scheme` attribute of the rendered HTML `<meta>` element. The `scheme` attribute can be used to provide user agents, such as client browsers or search engines, additional context for interpreting the metadata property.
The <xref:System.Web.UI.HtmlControls.HtmlMeta.Scheme%2A> property is rendered to the `scheme` attribute of the resulting HTML `<meta>` element.
## Examples
The following code example demonstrates how to use the <xref:System.Web.UI.HtmlControls.HtmlMeta> control to define HTML `<meta>` elements for a Web page. Two `<meta>` tags are defined, one listing keywords describing the page and one listing the date the page was created. The <xref:System.Web.UI.HtmlControls.HtmlMeta.Scheme%2A> property is used for the date-related `<meta>` tag to aid user agents reading the date value.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/cs/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.HtmlControls.HtmlMeta/vb/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Content" />
<altmember cref="P:System.Web.UI.HtmlControls.HtmlMeta.Name" />
</Docs>
</Member>
</Members>
</Type>