HtmlMeta Class (System.Web.UI.HtmlControls)

Switch View

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

HtmlMeta Class

Allows programmatic access to the HTML <meta> tag on the server.

Namespace: System.Web.UI.HtmlControls
Assembly: System.Web (in System.Web.dll)

Syntax

Visual Basic (Declaration)

<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class HtmlMeta _
    Inherits HtmlControl

Visual Basic (Usage)

Dim instance As HtmlMeta

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class HtmlMeta : HtmlControl

Visual C++

[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class HtmlMeta : public HtmlControl

JScript

public class HtmlMeta extends HtmlControl

ASP.NET

<asp:HtmlMeta />

Remarks

The 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 HtmlMeta control's Name property to specify the metadata property name, and the Content property to specify the metadata property value. Use the Scheme property to specify additional information to user agents on how to interpret the metadata property. Use the HttpEquiv property in place of the Name property when the resulting metadata property will be retrieved using HTTP.

You can get a reference to the page <head> element using the Header property of the Page object.

Topic	Location
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications in Visual Studio
How to: Add HTML Server Controls to a Web Page Using ASP.NET Syntax	Building ASP .NET Web Applications in Visual Studio
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications in Visual Studio
How to: Set HTML Server Control Properties Programmatically	Building ASP .NET Web Applications in Visual Studio

Examples

The following code example demonstrates how to use the 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.

Visual Basic

<%@ Page Language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

    ' Create two instances of an HtmlMeta control.
    Dim hm1 As New HtmlMeta()
    Dim hm2 As New HtmlMeta()

    ' Get a reference to the page header element.
    Dim head As HtmlHead = Page.Header

    ' Define an HTML <meta> element that is useful for search engines.
    hm1.Name = "keywords"
    hm1.Content = "words that describe your web page"
    head.Controls.Add(hm1)

    ' Define an HTML <meta> element with a Scheme attribute.
    hm2.Name = "date"
    hm2.Content = DateTime.Now.ToString("yyyy-MM-dd")
    hm2.Scheme = "YYYY-MM-DD"
    head.Controls.Add(hm2)

  End Sub
</script>

<html  >
<head runat="server">
    <title>HtmlMeta Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    View the HTML source code of the page to see the two HTML meta elements added.
    </div>
    </form>
</body>
</html>

<%@ Page Language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_Load(object sender, EventArgs e)
  {
    // Create two instances of an HtmlMeta control.
    HtmlMeta hm1 = new HtmlMeta();
    HtmlMeta hm2 = new HtmlMeta();    

    // Get a reference to the page header element.
    HtmlHead head = (HtmlHead)Page.Header;

    // Define an HTML <meta> element that is useful for search engines.
    hm1.Name = "keywords";
    hm1.Content = "words that describe your web page";
    head.Controls.Add(hm1);

    // Define an HTML <meta> element with a Scheme attribute.
    hm2.Name = "date";
    hm2.Content = DateTime.Now.ToString("yyyy-MM-dd");
    hm2.Scheme = "YYYY-MM-DD";
    head.Controls.Add(hm2);

  }
</script>

<html  >
<head runat="server">
    <title>HtmlMeta Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
    View the HTML source code of the page to see the two HTML meta elements added.
    </div>
    </form>
</body>
</html>

.NET Framework Security

AspNetHostingPermission
for operating in a hosted environment. Demand value: LinkDemand; Permission value: Minimal.
AspNetHostingPermission
for operating in a hosted environment. Demand value: InheritanceDemand; Permission value: Minimal.

Inheritance Hierarchy

System..::.Object
  System.Web.UI..::.Control
    System.Web.UI.HtmlControls..::.HtmlControl
      System.Web.UI.HtmlControls..::.HtmlMeta

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

HtmlMeta Members

System.Web.UI.HtmlControls Namespace

HtmlTitle

Header