ConvertEditValueEventArgs.Handled Property

Gets or sets a value specifying whether default edit value conversion/formatting is required.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.2.dll

Declaration

C#

public bool Handled { get; set; }

VB.NET

Public Property Handled As Boolean

Property Value

Type	Description
Boolean	true to prohibit default edit value conversion/formatting; otherwise, false.

Remarks

Events used to convert and format the edit value (RepositoryItem.ParseEditValue and RepositoryItem.FormatEditValue) fire when the end-user accepts input. The Handled property specifies whether default conversion/formatting should be performed. By default, this property value is false. Hence, you must set the Handled property value to true when it is necessary to override default edit value conversion/formatting.

Note: if the Handled property value is false and the ConvertEditValueEventArgs.Value property has been modified, the default formatting/parsing algorithm will be applied to the value specified by the ConvertEditValueEventArgs.Value property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Handled 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#

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

    e.Value = fItem.FilterName;
    e.Handled = true;
}

VB.NET

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

    e.Value = fItem.FilterName
    e.Handled = True
End If