Skip to main content

DiagramDataBindingControllerBase.KeySelector Property

Gets or sets the selector that returns the data field that identifies the data item.

Namespace: DevExpress.XtraDiagram

Assembly: DevExpress.XtraDiagram.v24.1.dll

NuGet Package: DevExpress.Win.Diagram

Declaration

[DiagramCategory(DiagramCategory.Data)]
public virtual IKeySelector KeySelector { get; set; }

Property Value

Type Description
DevExpress.Diagram.Core.IKeySelector

An object implementing the DevExpress.Diagram.Core.IKeySelector interface.

Remarks

Use the KeySelector property to define a custom logic for choosing the data field that identifies the data item (e.g., when binding to data with multiple types of data objects). To do this, implement the GetKey method of the DevExpress.Diagram.Core.IKeySelector interface, so that it returns the data field that identifies the data item. See the example below.

diagramDataBindingController1.KeySelector = new DatabaseDefinitionKeySelector();
//...
    public class DatabaseDefinitionKeySelector : IKeySelector {
        object IKeySelector.GetKey(object obj) {
            if(obj is TableDefinition)
                return ((TableDefinition)obj).Name;
            else if(obj is ColumnDefinition)
                return ((ColumnDefinition)obj).Id;
            return obj;
        }
    }

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the KeySelector 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.

See Also