ConvertEditValueEventArgs.Value Property

Gets or sets either the edit or the display value of an editor.

Namespace : DevExpress.XtraEditors.Controls

Assembly : DevExpress.XtraEditors.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

• C#
• VB.NET

public object Value { get; set; }

Public Property Value As Object

Property Value

An object specifying either the edit or the display value of an editor.

|

Remarks

The Value property value depends on the event currently handled.

• If the RepositoryItem.FormatEditValue event is being handled, Value represents the editor’s unformatted value. Setting the Value property updates the editor’s display text.
• If the RepositoryItem.ParseEditValue event is being handled, the Value property represents the editor’s display value. Setting the Value propertyupdates the editor’s BaseEdit.EditValue property.

Note : you must set the ConvertEditValueEventArgs.Handled property value to true to override the default conversion or formatting algorithm.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Value 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#
• VB.NET

xaf-how-to-display-an-enumeration-property-as-a-drop-down-box-with-check-boxes/CS/EFCore/EnumCheckBoxEF/EnumCheckBoxEF.Win/Editors/EnumPropertyEditorEx.cs#L61

private void checkedEdit_ParseEditValue(object sender, ConvertEditValueEventArgs e) {
    if (string.IsNullOrEmpty(Convert.ToString(e.Value))) {
        e.Value = noneValue;

winforms-grid-rename-grid-filters-save-restore-layout/CS/WindowsApplication3/FilterNameProvider.cs#L62

if(fItem != null){
    e.Value = fItem.FilterName;
    e.Handled = true;

winforms-grid-rename-grid-filters-save-restore-layout/VB/WindowsApplication3/FilterNameProvider.vb#L75

If fItem IsNot Nothing Then
    e.Value = fItem.FilterName
    e.Handled = True

See Also

Handled

ConvertEditValueEventArgs Class

ConvertEditValueEventArgs Members

DevExpress.XtraEditors.Controls Namespace