ASPxVerticalGridCommandButtonSettings.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 VerticalGridCommandButtonSettings EditButton { get; }

VB.NET

Public ReadOnly Property EditButton As VerticalGridCommandButtonSettings

Property Value

Type	Description
VerticalGridCommandButtonSettings	A VerticalGridCommandButtonSettings 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	ASPxVerticalGrid	.SettingsCommandButton .EditButton
ASP.NET MVC Extensions	VerticalGridSettings	.SettingsCommandButton .EditButton

Remarks

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

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

ASPX

<dx:ASPxVerticalGrid ID="ASPxVerticalGrid1" runat="server" AutoGenerateColumns="False" DataSourceID="SqlDataSource1" KeyFieldName="ProductID">
    <Rows>
        ...
        <dx:VerticalGridCommandRow ShowEditButton="True" VisibleIndex="0">
        </dx:VerticalGridCommandRow>
    </Rows>
    <SettingsCommandButton>
        <EditButton RenderMode="Button" Text="Edit Record">
            <Image ToolTip="Click button to edit" Url="icon.png" AlternateText="Edit Record" />
        </EditButton>
    </SettingsCommandButton>
</dx:ASPxGridView>

Note

The Edit command button’s GridCommandButtonSettings.Text property value is not encoded by default. Use the ASPxVerticalGridCommandButtonSettings.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 record.