ASPxGridViewCommandButtonSettings.EditButton Property

Gets the Edit command button‘s settings.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public GridViewCommandButtonSettings EditButton { get; }

VB.NET

Public ReadOnly Property EditButton As GridViewCommandButtonSettings

Property Value

Type	Description
GridViewCommandButtonSettings	A GridViewCommandButtonSettings object that specifies the button’s settings.

Property Paths

You can access this nested property as listed below:

Library	Object Type	Path to EditButton
ASP.NET Web Forms Controls	ASPxGridView	.SettingsCommandButton .EditButton
	GridViewProperties	.SettingsCommandButton .EditButton
ASP.NET MVC Extensions	GridViewSettings	.SettingsCommandButton .EditButton
	MVCxGridViewProperties	.SettingsCommandButton .EditButton

Remarks

The Edit button switches the ASPxGridView to edit mode. Use the EditButton property to specify the button’s image, caption and type. The button’s visibility in a column is specified by the GridViewCommandColumn.ShowEditButton property.

The following example illustrates how to show the Edit command button as a button with an image.

ASPX

<dx:ASPxGridView ID="ASPxGridView1" runat="server" AutoGenerateColumns="False" DataSourceID="SqlDataSource1" KeyFieldName="ProductID">
    <Columns>
    ...
        <dx:GridViewCommandColumn ShowEditButton="true"></dx:GridViewCommandColumn>
    </Columns>
    <SettingsCommandButton>
        <EditButton RenderMode="Button" Text="Edit Record">
            <Image ToolTip="Click button to edit" Url="icon.png" AlternateText="Edit Record" />
        </EditButton>
    </SettingsCommandButton>
</dx:ASPxGridView>

Note that the Edit command button’s GridCommandButtonSettings.Text property value is not encoded by default. Use the ASPxGridViewCommandButtonSettings.EncodeHtml property to specify whether to display the button’s text that is HTML as HTML, or instead, strip out the HTML markers.

C#

<SettingsCommandButton EncodeHtml="true">
    <EditButton>
    ...
    </EditButton>
</SettingsCommandButton>

Note

Specify the ASPxGridBase.KeyFieldName property when you add a new and delete an existing grid row.