EditorDescriptorsFactory.RegisterListEditorAlias(String, Type, IsClassCompatibleHandler) Method

Registers a List Editor‘s alias name and specifies the handler which provides a logic to choose if the alias is appropriate for the given type.

Namespace: DevExpress.ExpressApp.Editors

Assembly: DevExpress.ExpressApp.v23.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public void RegisterListEditorAlias(
    string aliasName,
    Type elementType,
    IsClassCompatibleHandler classHandler
)

VB.NET

Public Sub RegisterListEditorAlias(
    aliasName As String,
    elementType As Type,
    classHandler As IsClassCompatibleHandler
)

Parameters

Name	Type	Description
aliasName	String	A string specifying the List Editor’s alias name.
elementType	Type	A Type object specifying the List Editor’s target type.
classHandler	DevExpress.ExpressApp.Editors.IsClassCompatibleHandler	The IsClassCompatibleHandler object which allows you to choose if the aliasName is appropriate for the elementType.

Remarks

The classHandler parameter is used if you want to register a number of editors for one type and choose the appropriate editor according to the logic implemented in it. In different situations, the editor satisfying the conditions will be applied to current type first.

C#

public class MyModule : ModuleBase {
    //...
    protected override void RegisterEditorDescriptors(EditorDescriptorsFactory 
    editorDescriptorsFactory) {
        //...
        editorDescriptorsFactory.RegisterListEditorAlias("MyAlias", typeof(object), 
        IsCriteriaProperty); 
    }
    private static bool IsCriteriaProperty(IModelClass modelClass) {
        //...    
    }
}

VB.NET

Public Class MyModule
    Inherits ModuleBase
    '...
    Protected Overrides Sub RegisterEditorDescriptors(ByVal editorDescriptorsFactory _
    As EditorDescriptorsFactory)
        '...
        editorDescriptorsFactory.RegisterListEditorAlias("MyAlias", GetType(Object), _
        AddressOf IsCriteriaProperty)
    End Sub
    Private Shared Function IsCriteriaProperty(ByVal modelClass As IModelClass) As Boolean
        '...    
    End Function
End Class