HyperLinkColumn.FormatDataNavigateUrlValue Method (Object)

 

Formats a data-bound URL using the format specified by the DataNavigateUrlFormatString property.

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

Protected Overridable Function FormatDataNavigateUrlValue (
	dataUrlValue As Object
) As String

Parameters

dataUrlValue
Type: System.Object

The data-bound URL to format.

Return Value

Type: System.String

The data-bound URL in the format specified by the DataNavigateUrlFormatString property.

Use the FormatDataNavigateUrlValue method to format a data-bound URL value with the format specified by the DataNavigateUrlFormatString property.

System_CAPS_noteNote

The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Forms Page Code Model.

<!-- 
This example demonstrates using a hyperlink column. The code below
should be copied into a file called HyperTextColumnVB.aspx.  The file
should be stored in the same directory as the file DetailsPageVB.aspx
described below.
-->
<%@ Page language="VB" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
    private dv As DataView
    private dt As New DataTable()

    Private Sub Page_Load(sender As Object, e As System.EventArgs)
        ' Create a DataTable to use as the data source for 
        ' the DataGrid.
        dt.Columns.Add(new DataColumn("ItemNumber"))
        dt.Columns("ItemNumber").Caption = "Item Number"
        dt.Columns.Add(new DataColumn("Item"))
        dt.Columns("ItemNumber").Caption = "Item"
        dt.Columns.Add(new DataColumn("Price"))
        dt.Columns("ItemNumber").Caption = "Price"

        ' Add some data to the DataTable.
        Dim myDataRow As DataRow
        Dim i As Integer
        For i = 0 To 4
            myDataRow = dt.NewRow()
            myDataRow(0) = i
            myDataRow(1) = "Item " & i.ToString()
            myDataRow(2) = 1.23 * (i + 1)
            dt.Rows.Add(myDataRow)
        Next i

        ' Use the table to create a DataView.
        dv = new DataView(dt)

        ' Create hyperlink columns that contain the item name
        ' and price.
        Dim nameCol As New HyperLinkColumn()
        nameCol.DataNavigateUrlField = "ItemNumber"
        nameCol.DataTextField = "Item"
        nameCol.DataNavigateUrlFormatString = _
            "DetailspageVB.aspx?id={0}"
        nameCol.HeaderText = dt.Columns("Item").Caption

        Dim priceCol As New HyperLinkColumn()
        priceCol.DataNavigateUrlField = "ItemNumber"
        priceCol.DataTextField = "Price"
        priceCol.DataNavigateUrlFormatString = _
            "DetailspageVB.aspx?id={0}"
        priceCol.DataTextFormatString = "{0:c}"
        priceCol.HeaderText = dt.Columns("Price").Caption

        ' Add the new columns to the DataGrid.
        DataGrid1.Columns.Add(nameCol)
        DataGrid1.Columns.Add(priceCol)

        ' Set the DataView as the data source, and bind 
        ' it to the DataGrid.
        DataGrid1.DataSource = dv
        DataGrid1.DataBind()

    End Sub

    Private Sub DataGrid1_ItemDataBound(sender As Object, _
        e As System.Web.UI.WebControls.DataGridItemEventArgs)
        Dim itemType As ListItemType = _
            CType(e.Item.ItemType, ListItemType)

        if itemType <> ListItemType.Header AndAlso _
            itemType <> ListItemType.Footer AndAlso _
            itemType <> ListItemType.Separator Then

            ' Get the IntegerValue cell from the grid's column 
            ' collection.
            Dim currentCell As TableCell = _
                CType(e.Item.Controls(0), TableCell)
            DataGrid1.Columns(1).InitializeCell(currentCell, 1, _
                ListItemType.Item)

            ' Add attributes to the cell.
            currentCell.Attributes.Add("id", "currentCell" & _ 
                e.Item.ItemIndex.ToString())
            currentCell.Attributes.Add("OnClick", _
                "Update_currentCell" & _
                e.Item.ItemIndex.ToString() & _
                "()")
        End If
    End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
    <title>HyperLinkColumn Example</title>
</head>
    <body>
        <form id="form1" runat="server">
            <h3>HyperLinkColumn Example</h3>
                <asp:DataGrid Runat="server" ID="DataGrid1" CellPadding="4"
                    AutoGenerateColumns="False" BorderStyle="None" GridLines="None">
                    <HeaderStyle Font-Bold="True" ForeColor="White" BackColor="Black">
                    </HeaderStyle>
                </asp:DataGrid>
                <p>Click on an item name or price to add the item to your order.</p>
        </form>
    </body>
</html>
<!-- 
This example demonstrates using a hyperlink column. The code below
should be copied into a file called DetailsPageVB.aspx. The file
should be stored in the same directory as the file HyperTextColumnVB.aspx
described above.
-->
<%@ Page language="VB" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<%@ Import Namespace="System.Data" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
    <head>
    <title>HyperLinkColumn Example</title>
<script runat="server">
            Private dv As DataView
            Private dt As New DataTable()

            Private Sub Page_Load(sender As Object, e As System.EventArgs) _
                Handles MyBase.Load

                ' Get the item value that was passed on the query string.
                Dim myCollection As NameValueCollection = Request.QueryString
                Dim selectedItem As String = myCollection.Get("id")

                Label1.Text = "Item " & selectedItem & _ 
                    " has been added to your order."
            End Sub
        </script>
    </head>
    <body>
        <form id="form1" runat="server">
            <h3>HyperLinkColumn Example</h3>
                <p><asp:Label id="Label1" runat="server">Label</asp:Label></p>
                <p><asp:HyperLink id="HyperLink1" runat="server" 
                    BorderColor="#8080FF" BorderStyle="Groove" ForeColor="Blue"
                    NavigateUrl="HyperTextColumnVB.aspx"> return to items page 
                   </asp:HyperLink></p>
        </form>
    </body>
</html>

.NET Framework
Available since 1.1
Return to top
Show: