ExpressionEditorControl Class

The Expression Editor in the AutoComplete mode.

Namespace: DevExpress.Xpf.ExpressionEditor

Assembly: DevExpress.Xpf.ExpressionEditor.v24.2.dll

NuGet Package: DevExpress.Wpf.ExpressionEditor

Declaration

C#

public class ExpressionEditorControl :
    Control,
    IAutoCompleteExpressionEditor,
    ISupportExpressionString

VB.NET

Public Class ExpressionEditorControl
    Inherits Control
    Implements IAutoCompleteExpressionEditor,
               ISupportExpressionString

Related API Members

The following members return ExpressionEditorControl objects:

• ExpressionEditorControl.GetEditor(DependencyObject)

Remarks

The Expression Editor provides the capability to create and edit expressions in DevExpress WPF controls (for example, Data Grid). The expression editor supports numerous standard functions and operators that allow you to perform different string, date-time, logical and math operations over data. See the Invoking Expression Editor topic to learn how to invoke the expression editor.

The AutoComplete mode supports intelligent code completion, syntax highlighting and immediate error indication. Refer to the Expression Editor Capabilities topic to learn more.

The expression editor in AutoComplete mode is an ExpressionEditorControl class instance that is included in the DevExpress.Xpf.ExpressionEditor assembly. If the Global Assembly Cache stores this assembly, the AutoComplete mode is used by default.

Refer to the following help topic for more information on how to customize the expression editor: Expression Editor Customization.

Standalone Mode

You can use the Expression Editor as a standalone control:

1. Add the control to the window:

   XAML

   <Window ...
           xmlns:dxexpression="http://schemas.devexpress.com/winfx/2008/xaml/expressioneditor">
       <dxexpression:ExpressionEditorControl Name="editor"/>
   </Window>
   

2. Use the ExpressionEditorContextHelper.GetContext method to define columns:

   C#

   var context = ExpressionEditorContextHelper.GetContext(true, true, true);
   context.Columns.Add(new ColumnInfo("Custom Category") {
       Name = "Custom variable",
       Description = "Custom variable description",
       Type = typeof(string)
   });
   editor.Context = context;
   editor.EditValue = "CustomVariable + 1"
   

   VB.NET

   Dim context = ExpressionEditorContextHelper.GetContext(True, True, True)
   context.Columns.Add(New ColumnInfo("Custom Category") With {
       .Name = "Custom variable",
       .Description = "Custom variable description",
       .Type = GetType(String)
   })
   editor.Context = context
   editor.EditValue = "CustomVariable + 1"
   

3. Execute the SaveCommand to update the editor value:

   C#

   void Button_Click(object sender, RoutedEventArgs e) {
       editor.SaveCommand.Execute(null);
       MessageBox.Show(editor.EditValue);
   }
   

   VB.NET

   Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
       editor.SaveCommand.Execute(Nothing)
       MessageBox.Show(editor.EditValue)
   End Sub
   

Inheritance

Object

DispatcherObject

DependencyObject

Visual

UIElement

FrameworkElement

Control

ExpressionEditorControl