System.Web.UI.WebControls.HyperLinkField Class

Represents a field that is displayed as a hyperlink in a data-bound control.

See Also: HyperLinkField Members


public class HyperLinkField : DataControlField


The System.Web.UI.WebControls.HyperLinkField class is used by data-bound controls (such as System.Web.UI.WebControls.GridView and System.Web.UI.WebControls.DetailsView) to display a hyperlink for each record displayed. When the user clicks a hyperlink, he or she is directed to the Web page associated with the hyperlink. The System.Web.UI.WebControls.HyperLinkField object is displayed differently depending on the data-bound control in which it is used. For example, the System.Web.UI.WebControls.GridView control displays a System.Web.UI.WebControls.HyperLinkField object as a column, while the System.Web.UI.WebControls.DetailsView control displays it as a row.

To specify the caption to display for the hyperlinks, use the HyperLinkField.Text property. Use the HyperLinkField.NavigateUrl property to specify the URL to navigate to when a hyperlink is clicked. If you want to display the linked content in a specific window or frame, set the HyperLinkField.Target property.


When the HyperLinkField.Text and HyperLinkField.NavigateUrl properties are set, all hyperlinks in the System.Web.UI.WebControls.HyperLinkField object share the same caption and navigation URL. Likewise, the HyperLinkField.Target property also applies to all hyperlinks.

Alternatively, you can bind the System.Web.UI.WebControls.HyperLinkField object to fields in a data source. This allows you to display a different caption for each hyperlink in the System.Web.UI.WebControls.HyperLinkField object and to have each hyperlink navigate to a different location. To bind a field to a caption, set the HyperLinkField.DataTextField property. To create a URL for navigation, set the HyperLinkField.DataNavigateUrlFields property to a comma-separated list of fields to use to create the URL.

You can specify a custom format for the captions and navigation URLs by setting the HyperLinkField.DataTextFormatString and HyperLinkField.DataNavigateUrlFormatString properties, respectively.

You can hide a System.Web.UI.WebControls.HyperLinkField object in a data-bound control by setting the DataControlField.Visible property to false.

You can customize the header and footer sections of a System.Web.UI.WebControls.HyperLinkField object. To display a caption in the header or footer sections, set the DataControlField.HeaderText or DataControlField.FooterText properties, respectively. To display an image in the header section instead of text, set the DataControlField.HeaderImageUrl property. The header section can be hidden in the System.Web.UI.WebControls.HyperLinkField object by setting the DataControlField.ShowHeader property to false.


Some data-bound controls (such as the System.Web.UI.WebControls.GridView control) can show or hide only the entire header section of the control. These data-bound controls do not support the DataControlField.ShowHeader property for an individual bound field. To show or hide the entire header section of a data-bound control, use the control's ShowHeader property (if available).

You also can customize the appearance of the System.Web.UI.WebControls.HyperLinkField object (font color, background color, and so on) by setting the style properties for the different parts of the field. The following table lists the different style properties.


The style settings for the child Web server controls of the System.Web.UI.WebControls.HyperLinkField object.


The style settings for the footer section of the System.Web.UI.WebControls.HyperLinkField object.


The style settings for the header section of the System.Web.UI.WebControls.HyperLinkField object.


The style settings for the data items in the System.Web.UI.WebControls.HyperLinkField object.


Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)
Assembly Versions:
Since: .NET 2.0