Back to Devexpress

SpreadsheetCustomCellEditEventArgs.EditSettings Property

wpf-devexpress-dot-xpf-dot-spreadsheet-dot-spreadsheetcustomcellediteventargs.md

latest4.3 KB
Original Source

SpreadsheetCustomCellEditEventArgs.EditSettings Property

Gets or sets an object that contains the custom cell editor’s settings.

Namespace : DevExpress.Xpf.Spreadsheet

Assembly : DevExpress.Xpf.Spreadsheet.v25.2.dll

NuGet Package : DevExpress.Wpf.Spreadsheet

Declaration

csharp
public BaseEditSettings EditSettings { get; set; }
vb
Public Property EditSettings As BaseEditSettings

Property Value

TypeDescription
BaseEditSettings

A BaseEditSettings descendant providing edit settings used to create an in-place editor.

|

Remarks

The EditSettings property allows you to assign custom editors from the DXEditors Library to edited cells. Note that this property requires not the editor itself, but its helper class (the BaseEditSettings descendant). This class provides all the information needed to create a fully-functional editor. The actual editor is created when a user starts to edit a cell, and is automatically destroyed when editing is completed.

Refer to the Custom Cell In-place Editors topic for more information on how to embed custom in-place editors in worksheet cells.

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.

wpf-spreadsheet-assign-custom-in-place-editors/CS/WpfSpreadsheet_CustomCellEditors/MainWindow.xaml.cs#L64

csharp
settings.IsFloatValue = false;
    e.EditSettings = settings;
}

wpf-spreadsheet-control-create-a-data-entry-form/CS/WpfDataEntryFormSample/MainWindow.xaml.cs#L69

csharp
if (e.ValueObject.IsText)
    e.EditSettings = CreateCustomEditorSettings(e.ValueObject.TextValue);

wpf-spreadsheet-assign-custom-in-place-editors/VB/WpfSpreadsheet_CustomCellEditors/MainWindow.xaml.vb#L55

vb
settings.IsFloatValue = False
    e.EditSettings = settings
End If

wpf-spreadsheet-control-create-a-data-entry-form/VB/WpfDataEntryFormSample/MainWindow.xaml.vb#L69

vb
If e.ValueObject.IsText Then
    e.EditSettings = CreateCustomEditorSettings(e.ValueObject.TextValue)
End If

See Also

Custom Cell In-place Editors

SpreadsheetCustomCellEditEventArgs Class

SpreadsheetCustomCellEditEventArgs Members

DevExpress.Xpf.Spreadsheet Namespace