HtmlAnchor Class (System.Web.UI.HtmlControls)

HtmlAnchor Class

.NET Framework Class Library

HtmlAnchor Class

Allows programmatic access to the HTML <a> element on the server.

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

Syntax

Visual Basic (Declaration)

<AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
<AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level := AspNetHostingPermissionLevel.Minimal)> _
Public Class HtmlAnchor _
    Inherits HtmlContainerControl _
    Implements IPostBackEventHandler

Visual Basic (Usage)

Dim instance As HtmlAnchor

[AspNetHostingPermissionAttribute(SecurityAction.InheritanceDemand, Level = AspNetHostingPermissionLevel.Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.Minimal)]
public class HtmlAnchor : HtmlContainerControl, IPostBackEventHandler

Visual C++

[AspNetHostingPermissionAttribute(SecurityAction::InheritanceDemand, Level = AspNetHostingPermissionLevel::Minimal)]
[AspNetHostingPermissionAttribute(SecurityAction::LinkDemand, Level = AspNetHostingPermissionLevel::Minimal)]
public ref class HtmlAnchor : public HtmlContainerControl, 
    IPostBackEventHandler

JScript

public class HtmlAnchor extends HtmlContainerControl implements IPostBackEventHandler

ASP.NET

<asp:HtmlAnchor />

Remarks

There are two ways to use the HtmlAnchor class. The first is for navigation: using the HRef property to define the location of the page to link to. The second is for postback events: using the ServerClick event to programmatically handle the user's clicking a link.

Caution:
This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see Validation Server Control Syntax.

Caution:

This control can be used to display user input, which might include malicious client script. Check any information that is sent from a client for executable script, SQL statements, or other code before displaying it in your application. ASP.NET provides an input request validation feature to block script and HTML in user input. Validation server controls are also provided to assess user input. For more information, see Validation Server Control Syntax.

For a list of initial property values for an instance of HtmlAnchor, see the HtmlAnchor constructor.

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 ServerClick event to display a message when the HtmlAnchor control is clicked.

Visual Basic

<%@ Page Language="VB" AutoEventWireup="True" %>

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

      Sub AnchorBtn_Click(sender As Object, e As EventArgs)

         ' Display a message when the HtmlAnchor control is clicked.
         Message.InnerHtml = "Hello World!"

      End Sub

   </script>

<head runat="server">
    <title> HtmlAnchor Control Example </title>
</head>
<body>

   <form id="form1" runat="server">

      <h3> HtmlAnchor Control Example </h3> 

      <a id="AnchorButton"
         onserverclick="AnchorBtn_Click" 
         title="Hello World!"
         runat="server">

         Click here

      </a>

      <h1>
         <span id="Message" runat="server"/>
      </h1>

   </form>

</body>
</html>

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

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

      void AnchorBtn_Click(Object sender, EventArgs e)
      {
         // Display a message when the HtmlAnchor control is clicked.
         Message.InnerHtml = "Hello World!";
      }

   </script>

<head runat="server">
    <title> HtmlAnchor Control Example </title>
</head>
<body>

   <form id="form1" runat="server">

      <h3> HtmlAnchor Control Example </h3> 

      <a id="AnchorButton"
         onserverclick="AnchorBtn_Click"
         title="Hello World!" 
         runat="server">

         Click here

      </a>

      <h1>
         <span id="Message" runat="server"/>
      </h1>

   </form>

</body>
</html>

JScript

<%@ Page Language="JScript" AutoEventWireup="True" %>

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

      function AnchorBtn_Click(sender : Object, e : EventArgs)
      {
         // Display a message when the HtmlAnchor control is clicked.
         Message.InnerHtml = "Hello World!";
      }

   </script>

<head runat="server">
    <title> HtmlAnchor Control Example </title>
</head>
<body>

   <form id="form1" runat="server">

      <h3> HtmlAnchor Control Example </h3> 

      <a id="AnchorButton"
         onserverclick="AnchorBtn_Click" 
         title="Hello World!"
         runat="server">

         Click here

      </a>

      <h1>
         <span id="Message" runat="server"/>
      </h1>

   </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..::.HtmlContainerControl
        System.Web.UI.HtmlControls..::.HtmlAnchor

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, 1.1, 1.0

Reference

HtmlAnchor Members

System.Web.UI.HtmlControls Namespace

HtmlContainerControl

Other Resources

HtmlAnchor Server Control Declarative Syntax

HTML Server Controls