This documentation is archived and is not being maintained.

CommandField.CancelImageUrl Property

Note: This property is new in the .NET Framework version 2.0.

Gets or sets the URL to an image to display for the Cancel button in a CommandField field.

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

public virtual string CancelImageUrl { get; set; }
/** @property */
public String get_CancelImageUrl ()

/** @property */
public void set_CancelImageUrl (String value)

public function get CancelImageUrl () : String

public function set CancelImageUrl (value : String)

Property Value

The URL to an image to display for the Cancel button in a CommandField. The default is an empty string (""), which indicates that this property is not set.

When the ButtonType property of a CommandField field is set to ButtonType.Image, use the CancelImageUrl property to specify the image to display for the Cancel button. This image can be in any file format (.jpg, .gif, .bmp, and so on), as long as the client's browser supports that format.


As an alternative to displaying an image for the Cancel button, you can display text by first setting the ButtonType property to ButtonType.Button or ButtonType.Link and then setting the CancelText property.

The following code example demonstrates how to use the CancelImageUrl property to specify a custom image to display for a Cancel button in a CommandField field of a GridView control. The ButtonType property must be set to ButtonType.Image for a Cancel button to display an image.

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

    <form runat="server">
      <h3>CommandField Example</h3>

      <asp:gridview id="CustomersGridView" 
          <asp:commandfield showeditbutton="true"
            headertext="Edit Controls"/>
          <asp:boundfield datafield="CustomerID"
            headertext="Customer ID" />
          <asp:boundfield datafield="CompanyName"
            headertext="Company Name"/>
          <asp:boundfield datafield="Address"
          <asp:boundfield datafield="City"
          <asp:boundfield datafield="PostalCode"
            headertext="ZIP Code"/>
          <asp:boundfield datafield="Country"
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="CustomersSqlDataSource"  
        selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]"
        updatecommand="Update Customers Set CompanyName=@CompanyName, Address=@Address, City=@City, PostalCode=@PostalCode, Country=@Country Where (CustomerID = @CustomerID)"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>"

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0