HyperLinkField Class
Assembly: System.Web (in system.web.dll)
The HyperLinkField class is used by data-bound controls (such as GridView and 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 HyperLinkField object is displayed differently depending on the data-bound control in which it is used. For example, the GridView control displays a HyperLinkField object as a column, while the DetailsView control displays it as a row.
To specify the caption to display for the hyperlinks, use the Text property. Use the 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 Target property.
Note: |
|---|
| When the Text and NavigateUrl properties are set, all hyperlinks in the HyperLinkField object share the same caption and navigation URL. Likewise, the Target property also applies to all hyperlinks. |
Alternatively, you can bind the HyperLinkField object to fields in a data source. This allows you to display a different caption for each hyperlink in the HyperLinkField object and to have each hyperlink navigate to a different location. To bind a field to a caption, set the DataTextField property. To create a URL for navigation, set the 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 DataTextFormatString and DataNavigateUrlFormatString properties, respectively.
You can hide a HyperLinkField object in a data-bound control by setting the Visible property to false.
You can customize the header and footer sections of a HyperLinkField object. To display a caption in the header or footer sections, set the HeaderText or FooterText properties, respectively. To display an image in the header section instead of text, set the HeaderImageUrl property. The header section can be hidden in the HyperLinkField object by setting the ShowHeader property to false.
Note: |
|---|
| Some data-bound controls (such as the GridView control) can show or hide only the entire header section of the control. These data-bound controls do not support the 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 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.
| Style property | Description |
|---|---|
| The style settings for the child Web server controls of the HyperLinkField object. | |
| The style settings for the footer section of the HyperLinkField object. | |
| The style settings for the header section of the HyperLinkField object. | |
| The style settings for the data items in the HyperLinkField object. |
The following code example demonstrates how to use a HyperLinkField object to display a column of static hyperlinks in a GridView control. Each hyperlink in the HyperLinkField object shares the same caption and navigation URL specified by the Text and NavigateUrl properties, respectively.
The following code example demonstrates how to bind a HyperLinkField object to fields in a data source. The DataTextField and DataNavigateUrlFields properties are used to specify the fields to bind to the caption and the navigation URL, respectively, of each hyperlink displayed in the HyperLinkField object.
- AspNetHostingPermission for using a HyperLinkField object in a hosted environment. Associated enumeration value: System.Web.AspNetHostingPermissionLevel.Minimal
Reference
HyperLinkField MembersSystem.Web.UI.WebControls Namespace
GridView
GridView.Columns Property
GridView.ShowHeader Property
DetailsView
DetailsView.Fields Property
BoundField
ButtonField
ButtonFieldBase
CheckBoxField
CommandField
DataControlField
TemplateField
DataNavigateUrlFields
DataNavigateUrlFormatString
DataTextField
DataTextFormatString
NavigateUrl
Target
Text
DataControlField.Visible Property
Note: