ConvertEditValueEventArgs.Value Property

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

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public object Value { get; set; }

VB.NET

Public Property Value As Object

Property Value

Type	Description
Object	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#

how-to-retain-the-formatting-of-percentage-values-during-editing-e730/CS/Form1.cs#L167

private void repositoryItemTextEdit1_ParseEditValue(object sender, DevExpress.XtraEditors.Controls.ConvertEditValueEventArgs e) {
    if(e.Value is string) {
        string strValue = (string)e.Value;

how-to-implement-the-autoheight-feature-in-a-custom-editor-e2482/CS/CustomEditor/RepositoryItemMyCheckedComboBoxEdit.cs#L53

ConvertEditValueEventArgs result = base.DoFormatEditValue(val);
result.Value = MyFormatEditValue(result.Value);
result.Handled = true;

how-to-create-a-complex-filter-that-uses-mathematic-calculations-for-gridview-e2800/CS/WindowsApplication1/ComplexFilterHelper.cs#L95

{
    e.Value = e.Value.ToString().Replace(LastOperator.ToString(), FilterColumn.UnboundExpression);
    e.Handled = true;

dateedit-how-to-select-multiple-dates-e2007/CS/DatePeriodEdit/DatePeriodEdit.cs#L187

   protected override PopupBaseForm CreatePopupForm() { return new PopupDatePeriodEditForm(this); }
   protected override object ExtractParsedValue(ConvertEditValueEventArgs e) { return e.Value; }
}

how-to-set-custom-names-for-grid-filters-and-save-restore-these-names-with-a-grid-layout-t329217/CS/WindowsApplication3/FilterNameProvider.cs#L62

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

VB.NET

how-to-retain-the-formatting-of-percentage-values-during-editing-e730/VB/Form1.vb#L156

Private Sub repositoryItemTextEdit1_ParseEditValue(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.ConvertEditValueEventArgs) Handles repositoryItemTextEdit1.ParseEditValue
    If TypeOf e.Value Is String Then
        Dim strValue As String = CStr(e.Value)

how-to-implement-the-autoheight-feature-in-a-custom-editor-e2482/VB/CustomEditor/RepositoryItemMyCheckedComboBoxEdit.vb#L50

Dim result As ConvertEditValueEventArgs = MyBase.DoFormatEditValue(val)
result.Value = MyFormatEditValue(result.Value)
result.Handled = True

how-to-create-a-complex-filter-that-uses-mathematic-calculations-for-gridview-e2800/VB/ComplexFilterHelper.vb#L92

If (Not ReferenceEquals(LastOperator, Nothing)) Then
    e.Value = e.Value.ToString().Replace(LastOperator.ToString(), FilterColumn.UnboundExpression)
    e.Handled = True

dateedit-how-to-select-multiple-dates-e2007/VB/DatePeriodEdit/DatePeriodEdit.vb#L194

Protected Overrides Function ExtractParsedValue(ByVal e As ConvertEditValueEventArgs) As Object
    Return e.Value
End Function

how-to-set-custom-names-for-grid-filters-and-save-restore-these-names-with-a-grid-layout-t329217/VB/WindowsApplication3/FilterNameProvider.vb#L63

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