Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.DataGrid.Toolkit Assembly / Xceed.Wpf.DataGrid Namespace / ForeignKeyConfiguration Class / ForeignKeyConverter Property


In This Topic
    ForeignKeyConverter Property (ForeignKeyConfiguration)
    In This Topic

    Gets or sets a foreign key converter, which allows custom key/value mappings to be provided.

    Syntax
    'Declaration
     
    
    Public Property ForeignKeyConverter As ForeignKeyConverter
    'Usage
     
    
    Dim instance As ForeignKeyConfiguration
    Dim value As ForeignKeyConverter
     
    instance.ForeignKeyConverter = value
     
    value = instance.ForeignKeyConverter
    public ForeignKeyConverter ForeignKeyConverter {get; set;}

    Property Value

    A reference to a ForeignKeyConverter, which allows custom key/value mappings to be provided.

    Remarks

    By default, foreign key constraints defined by a DataTable or DataView as well as enums can be automatically detected; however, through a ForeignKeyConverter, custom key/value mappings can also be defined. When providing custom key/value mappings, a foreign key converter must be created by deriving from the ForeignKeyConverter class and overriding its GetKeyFromValue and GetValueFromKey methods in which the value for a specified key and the key for a specified value should be returned (see implementation of PersonForeignKeyConverter class in Example 2). This converter can then be provided to the ForeignKeyConverter property of either a foreign key description or configuration.

    If a ForeignKeyConverter has not been explicitly provided for a ForeignKeyConfiguration, the converter from its corresponding DataGridForeignKeyDescription will be used.

    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also