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


    ForeignKeyConverter Property (ForeignKeyConfiguration)

    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

    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.

    Requirements

    Target Platforms: Windows 11, Windows 10, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also