ShowValueEditorEventArgs.CustomRepositoryItem Property

Allows you to specify a custom editor to be opened instead of the default one, specified by the Editor property.

Namespace: DevExpress.XtraEditors.Filtering

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public RepositoryItem CustomRepositoryItem { get; set; }

VB.NET

Public Property CustomRepositoryItem As RepositoryItem

Property Value

Type	Description
RepositoryItem	A RepositoryItem descendant identifying the custom editor that will be created and displayed instead of the default one.

Remarks

To provide a custom editor instead of the default editor, create a corresponding descendant of the RepositoryItem class and assign it to the CustomRepositoryItem property.

Example

This example handles the FilterControl.CustomValueEditor event to assign custom editors (Spin Editor and Calc Editor) to value operands in Data Grid’s embedded FilterControl.

The Data Grid’s ColumnView.FilterEditorCreated event is used to subscribe to the FilterControl.CustomValueEditor event.

Form1.cs

private void gridView1_FilterEditorCreated(object sender, FilterControlEventArgs e) {
    e.FilterEditor.CustomValueEditor += FilterEditor_CustomValueEditor;
}

readonly RepositoryItemSpinEdit spinEdit = new RepositoryItemSpinEdit();
readonly RepositoryItemCalcEdit calcEdit = new RepositoryItemCalcEdit();

private void FilterEditor_CustomValueEditor(object sender, CustomValueEditorArgs e) {
    if (e.Node.FirstOperand.PropertyName != "Payment") return;
    RepositoryItemTextEdit item = null;
    if (e.ElementIndex == 2)
        item = spinEdit;
    else
        item = calcEdit;
    var settings = item.MaskSettings.Configure<MaskSettings.Numeric>();
    settings.MaskExpression = "c";
    e.RepositoryItem = item;
}

Form1.vb

Private Sub gridView1_FilterEditorCreated(ByVal sender As Object, ByVal e As FilterControlEventArgs) Handles gridView1.FilterEditorCreated
    AddHandler e.FilterControl.CustomValueEditor, AddressOf FilterControl_CustomValueEditor
End Sub

Private ReadOnly spinEdit As New RepositoryItemSpinEdit()
Private ReadOnly calcEdit As New RepositoryItemCalcEdit()

Private Sub FilterControl_CustomValueEditor(ByVal sender As Object, ByVal e As CustomValueEditorArgs)
    If e.Node.FirstOperand.PropertyName <> "Payment" Then
        Return
    End If
    Dim item As RepositoryItemTextEdit = Nothing
    If e.ElementIndex = 2 Then
        item = spinEdit
    Else
        item = calcEdit
    End If
    Dim settings As MaskSettings.Numeric = item.MaskSettings.Configure(Of MaskSettings.Numeric)()
    settings.MaskExpression = "c"
    e.RepositoryItem = item
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomRepositoryItem 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-create-and-register-custom-filter-editor-functions/CS/DXApplication5/Main.cs#L30

    if(node != null && node.Property.Type == typeof(DateTime) && Equals(node.FunctionType, IsDaysInterval.FunctionName))
        e.CustomRepositoryItem = spinEdit;
}

VB.NET

how-to-create-and-register-custom-filter-editor-functions/VB/DXApplication5/Main.vb#L32

If node IsNot Nothing AndAlso node.Property.Type Is GetType(Date) AndAlso Equals(node.FunctionType, IsDaysInterval.FunctionName) Then
    e.CustomRepositoryItem = spinEdit
End If