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

HyperLinkField Class

 

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

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

System.Object
  System.Web.UI.WebControls.DataControlField
    System.Web.UI.WebControls.HyperLinkField

public class HyperLinkField : DataControlField

NameDescription
System_CAPS_pubmethodHyperLinkField()

Initializes a new instance of the HyperLinkField class.

NameDescription
System_CAPS_pubpropertyAccessibleHeaderText

Gets or sets text that is rendered as the AbbreviatedText property value in some controls.(Inherited from DataControlField.)

System_CAPS_protpropertyControl

Gets a reference to the data control that the DataControlField object is associated with.(Inherited from DataControlField.)

System_CAPS_pubpropertyControlStyle

Gets the style of any Web server controls contained by the DataControlField object.(Inherited from DataControlField.)

System_CAPS_pubpropertyDataNavigateUrlFields

Gets or sets the names of the fields from the data source used to construct the URLs for the hyperlinks in the HyperLinkField object.

System_CAPS_pubpropertyDataNavigateUrlFormatString

Gets or sets the string that specifies the format in which the URLs for the hyperlinks in a HyperLinkField object are rendered.

System_CAPS_pubpropertyDataTextField

Gets or sets the name of the field from the data source containing the text to display for the hyperlink captions in the HyperLinkField object.

System_CAPS_pubpropertyDataTextFormatString

Get or sets the string that specifies the format in which the hyperlink captions in a HyperLinkField object are displayed.

System_CAPS_protpropertyDesignMode

Gets a value indicating whether a data control field is currently viewed in a design-time environment.(Inherited from DataControlField.)

System_CAPS_pubpropertyFooterStyle

Gets or sets the style of the footer of the data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyFooterText

Gets or sets the text that is displayed in the footer item of a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyHeaderImageUrl

Gets or sets the URL of an image that is displayed in the header item of a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyHeaderStyle

Gets or sets the style of the header of the data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyHeaderText

Gets or sets the text that is displayed in the header item of a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyInsertVisible

Gets a value indicating whether the DataControlField object is visible when its parent data-bound control is in insert mode.(Inherited from DataControlField.)

System_CAPS_protpropertyIsTrackingViewState

Gets a value indicating whether the DataControlField object is saving changes to its view state.(Inherited from DataControlField.)

System_CAPS_pubpropertyItemStyle

Gets the style of any text-based content displayed by a data control field.(Inherited from DataControlField.)

System_CAPS_pubpropertyNavigateUrl

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the URL to navigate to when a hyperlink in a HyperLinkField object is clicked.

System_CAPS_pubpropertyShowHeader

Gets or sets a value indicating whether the header item of a data control field is rendered.(Inherited from DataControlField.)

System_CAPS_pubpropertySortExpression

Gets or sets a sort expression that is used by a data source control to sort data.(Inherited from DataControlField.)

System_CAPS_pubpropertyTarget

Gets or sets the target window or frame in which to display the Web page linked to when a hyperlink in a HyperLinkField object is clicked.

System_CAPS_pubpropertyText

Gets or sets the text to display for each hyperlink in the HyperLinkField object.

System_CAPS_protpropertyValidateRequestMode

Gets or sets a value that specifies whether the control validates client input.(Inherited from DataControlField.)

System_CAPS_protpropertyViewState

Gets a dictionary of state information that allows you to save and restore the view state of a DataControlField object across multiple requests for the same page.(Inherited from DataControlField.)

System_CAPS_pubpropertyVisible

Gets or sets a value indicating whether a data control field is rendered.(Inherited from DataControlField.)

NameDescription
System_CAPS_protmethodCloneField()

This API supports the product infrastructure and is not intended to be used directly from your code. Creates a duplicate copy of the current DataControlField-derived object.(Inherited from DataControlField.)

System_CAPS_protmethodCopyProperties(DataControlField)

Copies the properties of the current HyperLinkField object to the specified object.(Overrides DataControlField.CopyProperties(DataControlField).)

System_CAPS_protmethodCreateField()

Returns a new instance of the HyperLinkField class.(Overrides DataControlField.CreateField().)

System_CAPS_pubmethodEquals(Object)

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

System_CAPS_pubmethodExtractValuesFromCell(IOrderedDictionary, DataControlFieldCell, DataControlRowState, Boolean)

Extracts the value of the data control field from the current table cell and adds the value to the specified IDictionary collection.(Inherited from DataControlField.)

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 the navigation URL using the format string specified by the DataNavigateUrlFormatString property.

System_CAPS_protmethodFormatDataTextValue(Object)

Formats the caption text using the format string 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(Boolean, Control)

Initializes the HyperLinkField object.(Overrides DataControlField.Initialize(Boolean, Control).)

System_CAPS_pubmethodInitializeCell(DataControlFieldCell, DataControlCellType, DataControlRowState, Int32)
System_CAPS_protmethodLoadViewState(Object)

Restores the data source view's previously saved view state.(Inherited from DataControlField.)

System_CAPS_protmethodMemberwiseClone()

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

System_CAPS_protmethodOnFieldChanged()

Raises the FieldChanged event.(Inherited from DataControlField.)

System_CAPS_protmethodSaveViewState()

Saves the changes made to the DataControlField view state since the time the page was posted back to the server.(Inherited from DataControlField.)

System_CAPS_pubmethodToString()

Returns a string that represents this DataControlField object.(Inherited from DataControlField.)

System_CAPS_protmethodTrackViewState()

Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.(Inherited from DataControlField.)

System_CAPS_pubmethodValidateSupportsCallback()

Indicates that the controls contained by the HyperLinkField object support callbacks.(Overrides DataControlField.ValidateSupportsCallback().)

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. Restores the data control field's previously saved view state.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Saves the changes made to the DataControlField view state since the time the page was posted back to the server.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Causes the DataControlField object to track changes to its view state so they can be stored in the control's ViewState property and persisted across requests for the same page.(Inherited from DataControlField.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIDataSourceViewSchemaAccessor.DataSourceViewSchema

This API supports the product infrastructure and is not intended to be used directly from your code. Gets or sets the schema associated with this DataControlField object.(Inherited from DataControlField.)

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 indicating whether the DataControlField object is saving changes to its view state.(Inherited from DataControlField.)

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.

System_CAPS_noteNote

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.

System_CAPS_noteNote

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

ControlStyle

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

FooterStyle

The style settings for the footer section of the HyperLinkField object.

HeaderStyle

The style settings for the header section of the HyperLinkField object.

ItemStyle

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.


<%@ Page language="C#" %>

<!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 runat="server">
    <title>HyperLinkField Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>HyperLinkField Example</h3>

      <!-- Populate the Columns collection declaratively. -->
      <!-- Set the HyperLinkField field column to a static     -->
      <!-- caption and URL.                                    -->
      <asp:gridview id="OrdersGridView" 
        datasourceid="OrdersSqlDataSource" 
        autogeneratecolumns="false"
        runat="server">

        <columns>

          <asp:boundfield datafield="OrderID" 
            headertext="OrderID"/>
          <asp:boundfield datafield="CustomerID" 
            headertext="Customer ID"/>
          <asp:boundfield datafield="OrderDate" 
            headertext="Order Date"
            dataformatstring="{0:d}" />
          <asp:hyperlinkfield text="Details..."
            navigateurl="~\details.aspx"            
            headertext="Order Details"
            target="_blank" />

        </columns>

      </asp:gridview>

      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Northwind sample database.                   -->
      <asp:sqldatasource id="OrdersSqlDataSource"  
        selectcommand="SELECT [OrderID], [CustomerID], [OrderDate] FROM [Orders]"
        connectionstring="server=localhost;database=northwind;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>

    </form>
  </body>
</html>

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.


<%@ Page language="C#" %>

<!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 runat="server">
    <title>HyperLinkField Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <h3>HyperLinkField Example</h3>

      <!-- Populate the Columns collection declaratively. -->
      <!-- The UnitPrice field values are bound to the         -->
      <!-- captions of the hyperlinks in the HyperLinkField    -->
      <!-- field column, formatted as currency. The ProductID  -->
      <!-- field values are bound to the navigate URLs of the  -->
      <!-- hyperlinks. However, instead of being the actual    -->
      <!-- URL values, the product ID is passed to the linked  -->
      <!-- page as a parameter in the URL specified by the     -->
      <!-- DataNavigateUrlFormatString property.               -->
      <asp:gridview id="OrdersGridView" 
        datasourceid="OrdersSqlDataSource" 
        autogeneratecolumns="false"
        runat="server">

        <columns>

          <asp:boundfield datafield="OrderID" 
            headertext="Order ID"/>
          <asp:boundfield datafield="ProductID" 
            headertext="Product ID"/>
          <asp:hyperlinkfield datatextfield="UnitPrice"
            datatextformatstring="{0:c}"
            datanavigateurlfields="ProductID"
            datanavigateurlformatstring="~\details.aspx?ProductID={0}"          
            headertext="Price"
            target="_blank" />
          <asp:boundfield datafield="Quantity" 
            headertext="Quantity"/>

        </columns>

      </asp:gridview>

      <!-- This example uses Microsoft SQL Server and connects -->
      <!-- to the Northwind sample database.                   -->
      <asp:sqldatasource id="OrdersSqlDataSource"  
        selectcommand="SELECT [OrderID], [ProductID], [UnitPrice], [Quantity] FROM [Order Details]"
        connectionstring="server=localhost;database=northwind;integrated security=SSPI"
        runat="server">
      </asp:sqldatasource>

    </form>
  </body>
</html>

.NET Framework
Available since 2.0

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