This documentation is archived and is not being maintained.

HyperLinkColumn.NavigateUrl Property

Gets or sets the URL to link to when a hyperlink in the column is clicked.

[Visual Basic]
Public Overridable Property NavigateUrl As String
[C#]
public virtual string NavigateUrl {get; set;}
[C++]
public: __property virtual String* get_NavigateUrl();
public: __property virtual void set_NavigateUrl(String*);
[JScript]
public function get NavigateUrl() : String;
public function set NavigateUrl(String);

Property Value

The URL to link to when a hyperlink in the column is clicked.

Remarks

Use the NavigateUrl property to specify the URL to link to when a hyperlink in the column is clicked.

Note   When this property is set, all hyperlinks in the column share the same URL link.

To provide a separate URL for each hyperlink in the column, use the DataNavigateUrlField property.

Note   The DataNavigateUrlField and NavigateUrl properties cannot both be set at the same time. If both properties are set, the DataNavigateUrlField property takes precedence.

Example

[Visual Basic, C#] The following example demonstrates how to use the NavigateUrl property to specify the URL to link to for hyperlinks in the HyperLinkColumn. Notice that all hyperlinks in the column link to the same page.

[Visual Basic] 
<%@ Page Language="VB" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<html>

<head>

   <script runat="server">

      Function CreateDataSource() As ICollection 
      
         Dim dt As DataTable = New DataTable()
         Dim dr As DataRow
         Dim i As Integer

         dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32)))
         dt.Columns.Add(New DataColumn("PriceValue", GetType(Double)))
       
         For i = 0 to 2 
         
            dr = dt.NewRow()

            dr(0) = i
            dr(1) = CDbl(i) * 1.23

            dt.Rows.Add(dr)

         Next i

         Dim dv As DataView = New DataView(dt)
         Return dv

      End Function

      Sub Page_Load(sender As Object, e As EventArgs) 
    
         MyDataGrid.DataSource = CreateDataSource()
         MyDataGrid.DataBind()

      End Sub

   </script>

</head>

<body>

   <form runat="server">

      <h3>HyperLinkColumn Example<h3>

      <asp:DataGrid id="MyDataGrid" 
           BorderColor="black"
           BorderWidth="1"
           GridLines="Both"
           AutoGenerateColumns="false"
           runat="server">

         <HeaderStyle BackColor="#aaaadd"/>

         <Columns>

            <asp:HyperLinkColumn
                 HeaderText="Select an Item"
                 NavigateUrl="detailspage.aspx"
                 Text="Click Me"
                 Target="_blank"/>
           
         </Columns>

      </asp:DataGrid>

   </form>

</body>
</html>

[C#] 
<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ Import Namespace="System.Data" %>

<html>

<head>

   <script runat="server">

      ICollection CreateDataSource() 
      {
         DataTable dt = new DataTable();
         DataRow dr;

         dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32)));
         dt.Columns.Add(new DataColumn("PriceValue", typeof(Double)));
       
         for (int i = 0; i < 3; i++) 
         {
            dr = dt.NewRow();

            dr[0] = i;
            dr[1] = (Double)i * 1.23;

            dt.Rows.Add(dr);
         }

         DataView dv = new DataView(dt);
         return dv;
      }

      void Page_Load(Object sender, EventArgs e) 
      {
         MyDataGrid.DataSource = CreateDataSource();
         MyDataGrid.DataBind();
      }

   </script>

</head>

<body>

   <form runat="server">

      <h3>HyperLinkColumn Example<h3>

      <asp:DataGrid id="MyDataGrid" 
           BorderColor="black"
           BorderWidth="1"
           GridLines="Both"
           AutoGenerateColumns="false"
           runat="server">

         <HeaderStyle BackColor="#aaaadd"/>

         <Columns>

            <asp:HyperLinkColumn
                 HeaderText="Select an Item"
                 NavigateUrl="detailspage.aspx"
                 Text="Click Me"
                 Target="_blank"/>
           
         </Columns>

      </asp:DataGrid>

   </form>

</body>
</html>

[Visual Basic, C#] The following corresponding example is a sample Web Forms page to link to when a hyperlink in the previous example is clicked.

[Visual Basic] 
<%@ Page Language="VB" %>
<html>
<head>
 
</head>
<body>
 
   <h3>Details page for DataGrid</h3>
 
   Welcome to the new page.
 
</body>
</html>


[C#] 
<%@ Page Language="C#" %>
<html>
<head>
 
</head>
<body>
 
   <h3>Details page for DataGrid</h3>
 
   Welcome to the new page.
 
</body>
</html>

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 2000, Windows XP Professional, Windows Server 2003 family

See Also

HyperLinkColumn Class | HyperLinkColumn Members | System.Web.UI.WebControls Namespace | Text | DataNavigateUrlField

Show: