HyperLinkColumn Class
TOC
Collapse the table of content
Expand the table of content

HyperLinkColumn Class

 

A column type for the DataGrid control that contains a hyperlink for each item in the column.

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

System.Object
  System.Web.UI.WebControls.DataGridColumn
    System.Web.UI.WebControls.HyperLinkColumn

public class HyperLinkColumn : DataGridColumn

NameDescription
System_CAPS_pubmethodHyperLinkColumn()

Initializes a new instance of the HyperLinkColumn class.

NameDescription
System_CAPS_pubpropertyDataNavigateUrlField

Gets or sets the field from a data source to bind to the URL of the hyperlinks in the HyperLinkColumn.

System_CAPS_pubpropertyDataNavigateUrlFormatString

Gets or sets the display format for the URL of the hyperlinks in the HyperLinkColumn when the URL is data-bound to a field in a data source.

System_CAPS_pubpropertyDataTextField

Gets or sets the field from a data source to bind to the text caption of the hyperlinks in the HyperLinkColumn.

System_CAPS_pubpropertyDataTextFormatString

Gets or sets the display format for the text caption of the hyperlinks in the HyperLinkColumn column.

System_CAPS_protpropertyDesignMode

Gets a value that indicates whether the column is in design mode.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyFooterStyle

Gets the style properties for the footer section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyFooterText

Gets or sets the text displayed in the footer section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderImageUrl

Gets or sets the location of an image to display in the header section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderStyle

Gets the style properties for the header section of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderText

Gets or sets the text displayed in the header section of the column.(Inherited from DataGridColumn.)

System_CAPS_protpropertyIsTrackingViewState

Gets a value that determines whether the DataGridColumn object is marked to save its state.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyItemStyle

Gets the style properties for the item cells of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyNavigateUrl

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

System_CAPS_protpropertyOwner

Gets the DataGrid control that the column is a member of.(Inherited from DataGridColumn.)

System_CAPS_pubpropertySortExpression

Gets or sets the name of the field or expression to pass to the OnSortCommand method when a column is selected for sorting.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyTarget

Gets or sets the target window or frame to display the Web page content that is linked to when the hyperlink in the column is clicked.

System_CAPS_pubpropertyText

Gets or sets the text caption to display for the hyperlinks in the column.

System_CAPS_protpropertyViewState

Gets the System.Web.UI.StateBag object that allows a column derived from the DataGridColumn class to store its properties.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyVisible

Gets or sets a value that indicates whether the column is visible in the DataGrid control.(Inherited from DataGridColumn.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodFormatDataNavigateUrlValue(Object)

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

System_CAPS_protmethodFormatDataTextValue(Object)

Formats a data-bound text caption using the format specified by the DataTextFormatString property.

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Provides the base implementation to reset a column derived from the DataGridColumn class to its initial state.(Overrides DataGridColumn.Initialize().)

System_CAPS_pubmethodInitializeCell(TableCell, Int32, ListItemType)

Initializes the cell representing this column with the contained hyperlink.(Overrides DataGridColumn.InitializeCell(TableCell, Int32, ListItemType).)

System_CAPS_protmethodLoadViewState(Object)

Loads the state of the DataGridColumn object.(Inherited from DataGridColumn.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnColumnChanged()

Calls the DataGridDesigner.OnColumnsChanged method.(Inherited from DataGridColumn.)

System_CAPS_protmethodSaveViewState()

Saves the current state of the DataGridColumn object.(Inherited from DataGridColumn.)

System_CAPS_pubmethodToString()

Returns the string representation of the column.(Inherited from DataGridColumn.)

System_CAPS_protmethodTrackViewState()

Causes tracking of view-state changes to the server control so they can be stored in the server control's System.Web.UI.StateBag object.(Inherited from DataGridColumn.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Loads previously saved state.(Inherited from DataGridColumn.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns an object containing state changes.(Inherited from DataGridColumn.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Starts tracking state changes.(Inherited from DataGridColumn.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

This API supports the product infrastructure and is not intended to be used directly from your code. Gets a value that indicates whether the column is tracking view state changes.(Inherited from DataGridColumn.)

Use the HyperLinkColumn column type in a DataGrid control to create a hyperlink for each row in the DataGrid. Set the Text property to specify the caption text for the hyperlink. To specify the URL to link to when the hyperlink is clicked, set the NavigateUrl property.

System_CAPS_noteNote

If you set the Text and NavigateUrl properties, all hyperlinks in the column will share the same caption and URL.

You can also bind the text caption and URL of the hyperlinks in the HyperLinkColumn to a field in a data source instead of setting the Text and NavigateUrl properties. This allows you to display a different caption and to specify a different URL for each hyperlink in the column.

Use the DataTextField property to specify a field in a data source to bind to the text caption of the hyperlinks in the column.

System_CAPS_noteNote

The DataTextField and Text properties cannot both be set at the same time. If both properties are set, the DataTextField property takes precedence.

Specify the field to bind to the URL of the hyperlink by setting the DataNavigateUrlField property.

System_CAPS_noteNote

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

The Target property allows you to specify the window or frame to display the Web page content linked to when the hyperlink is clicked.

When using data binding, you can format the text caption and URL of the hyperlink by setting the DataTextFormatString and DataNavigateUrlFormatString properties, respectively.

System_CAPS_cautionCaution

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. You can use validation controls to verify user input before displaying the input text in a control. ASP.NET provides an input request validation feature to block script and HTML in user input. For more information, see Securing Standard ControlsHow to: Protect Against Script Exploits in a Web Application by Applying HTML Encoding to Strings, and Validating User Input in ASP.NET Web Pages.

The following example demonstrates how to create a HyperLinkColumn that links to a separate page.

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.

<%@ Page Language="C#" AutoEventWireup="True" %>
<%@ 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">

      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 id="form1" 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"
                 DataNavigateUrlField="IntegerValue"
                 DataNavigateUrlFormatString="detailspage.aspx?id={0}"
                 DataTextField="PriceValue"
                 DataTextFormatString="{0:c}"
                 Target="_blank"/>

         </Columns>

      </asp:DataGrid>

   </form>

</body>
</html>

The following corresponding example displays the item selected in the previous example.

<%@ 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 xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>Details page for DataGrid</title>
<script runat="server">

      void Page_Load(Object sender, EventArgs e) 
      {
         Label1.Text = "You selected item: " + Request.QueryString["id"];
      }

   </script>

</head>
<body>

   <h3>Details page for DataGrid</h3>

   <asp:Label id="Label1"
        runat="server"/>

</body>
</html>

.NET Framework
Available since 1.1

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

Return to top
Show:
© 2016 Microsoft