ColumnBase.EditSettings Property

Gets or sets an object that contains the column editor’s settings. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.Core.dll

Declaration

C#

public BaseEditSettings EditSettings { get; set; }

VB.NET

Public Property EditSettings As BaseEditSettings

Property Value

Type	Description
BaseEditSettings	A BaseEditSettings descendant that specifies the column’s editor.

Remarks

Tip

Topic: In-place Editors

Tip

Demo: Cell Editors

Requires installation of the WPF Subscription. Download

The GridControl automatically creates an editor for a column based on its value type. For example, if a column is bound to a DateTime field, the GridControl creates a date editor for it. If a column is bound to a numeric field, the numeric editor is used. Otherwise, the text editor is used.

Each editor has a helper class responsible for the editor’s functionality:

• BarCodeEditSettings
• CheckEditSettings
• ColorEditSettings
• HyperlinkEditSettings
• ImageEditSettings
• ListBoxEditSettings
• PasswordBoxEditSettings
• RatingEditSettings
• SparklineEditSettings
• TextEditSettings
• CalcEditSettings
• DateEditSettings
• LookUpEditSettingsBase
• MemoEditSettings
• PopupColorEditSettings
• PopupImageEditSettings
• SpinEditSettings
• ToggleSwitchEditSettings

Use the column’s EditSettings property to specify an in-place editor for a column.

The following code sample shows how to assign a spin editor to the UnitPrice column:

XAML

<dxg:GridColumn x:Name="colUnitPrice" FieldName="UnitPrice">
    <dxg:GridColumn.EditSettings>
        <dxe:SpinEditSettings MaxValue="999" MinValue="1" DisplayFormat="c2"/>
    </dxg:GridColumn.EditSettings>
</dxg:GridColumn>

Tip

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-assign-a-combobox-editor-to-a-column-e1582.

When the same editor is used in multiple locations, the GridControl uses the helper class to paint its cells. The actual editors are only created when end users start to edit a cell and are automatically destroyed when editing is completed. This improves the application’s performance.

To obtain a column’s actual editor, use the ColumnBase.ActualEditSettings property. This property returns the editor’s helper class that is responsible for the editor’s functionality and behavior.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the EditSettings property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-bind-a-grid-control-to-the-worksheet-data-wpf-spreadsheet-t461395/CS/WpfSpreadsheet_DataBinding/MainWindow.xaml#L38

<dxg:GridColumn FieldName="Column 1" Header="Q1" Width="117">
    <dxg:GridColumn.EditSettings>
        <dxe:TextEditSettings Style="{StaticResource TextEditSettingsStyle}"/>

how-to-automatically-generate-columns-with-predefined-settings-mvvm-e3330/CS/ColumnTemplateSelectorExample/MainPage.xaml#L29

<dxg:GridColumn x:Name="c1" Visible="True">
    <dxg:GridColumn.EditSettings>
        <dxe:ComboBoxEditSettings ItemsSource="{Binding Control.DataContext.Cities}"/>

wpf-data-grid-bind-columns-to-viewmodel-collection/CS/MainPage.xaml#L32

<dxg:GridColumn  FieldName="{Binding Path=(dxci:DependencyObjectExtensions.DataContext).FieldName, RelativeSource={RelativeSource Self}}">
    <dxg:GridColumn.EditSettings>
        <dxe:DateEditSettings/>

how-to-handle-row-double-clicks-e2915/CS/DXGrid_RowDoubleClick/MainWindow.xaml#L11

<dxg:GridColumn FieldName="ProductName">
    <dxg:GridColumn.EditSettings>
        <dxe:TextEditSettings HorizontalContentAlignment="Center" />

how-to-post-values-to-underlying-data-properties-immediately-after-changing-a-cell-value-e1801/CS/DXGrid_AssignComboBoxToColumn/Window1.xaml#L12

<dxg:GridColumn FieldName="ProductName"
                EditSettings="{dxe:ComboBoxSettings DisplayMember=ProductName, ValueMember=ProductName, ItemsSource={x:Static local:NwindData.Data}}" />
<dxg:GridColumn FieldName="UnitPrice">