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.v19.2.dll

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

In this example, custom editors are provided to edit value operands in the FilterControl.

The custom editors (SpinEdit and CalcEdit) are supplied by handling the BeforeShowValueEditor event. To supply the editors, corresponding repository items are created and assigned to the event's CustomRepositoryItem parameter.In the example, the FilterControl is used within a GridControl. To get access and subscribe to the FilterControl's BeforeShowValueEditor event, the GridView.FilterEditorCreated event is handled.

The following image shows the result.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-provide-custom-editors-to-edit-value-operands-in-the-filtercontrol-e1519

Form1.cs

        private void gridView1_FilterEditorCreated(object sender, FilterControlEventArgs e) {
            e.FilterControl.BeforeShowValueEditor += 
new ShowValueEditorEventHandler(FilterControl_BeforeShowValueEditor);
        }

        void FilterControl_BeforeShowValueEditor(object sender, ShowValueEditorEventArgs e) {
            if(e.CurrentNode.FirstOperand.PropertyName != "Payment") return;
            RepositoryItemTextEdit item = null;
            if(e.FocusedElementIndex == 2)
                item = new RepositoryItemSpinEdit();
            else
                item = new RepositoryItemCalcEdit();
            item.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric;
            item.Mask.EditMask = "c";
            e.CustomRepositoryItem = item;
        }

Form1.vb

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

Private Sub FilterControl_BeforeShowValueEditor(ByVal sender As Object, _
ByVal e As ShowValueEditorEventArgs)
    If e.CurrentNode.FirstOperand.PropertyName <> "Payment" Then
        Return
    End If

    Dim item As RepositoryItemTextEdit = Nothing

    If e.FocusedElementIndex = 2 Then
        item = New RepositoryItemSpinEdit()
    Else
        item = New RepositoryItemCalcEdit()
    End If

    item.Mask.MaskType = DevExpress.XtraEditors.Mask.MaskType.Numeric
    item.Mask.EditMask = "c"

    e.CustomRepositoryItem = item
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references 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#

winforms-filtercontrol-assign-custom-editors-to-value-operands/CS/CustomEditor/Form1.cs#L45

    item.Mask.EditMask = "c";
    e.CustomRepositoryItem = item;
}

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

    if (e.CurrentNode.FirstOperand.PropertyName != DefaultFieldName) return;
    e.CustomRepositoryItem = FilterEditorRepositoryItem;
}

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

winforms-filtercontrol-assign-custom-editors-to-value-operands/VB/CustomEditor/Form1.vb#L53

    item.Mask.EditMask = "c"
    e.CustomRepositoryItem = item
End Sub

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

    End If
    e.CustomRepositoryItem = FilterEditorRepositoryItem
End Sub

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