Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.DataGrid.Toolkit Assembly / Xceed.Wpf.DataGrid Namespace / DataGridForeignKeyDescription Class
Members


In This Topic
    DataGridForeignKeyDescription Class
    In This Topic
    Class that provides descriptive information about a foreign key or enumeration.
    Syntax
    'Declaration
     
    <TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
    <NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
    Public Class DataGridForeignKeyDescription 
       Inherits System.Windows.DependencyObject
    'Usage
     
    Dim instance As DataGridForeignKeyDescription
    [TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
    [NameScopeProperty("NameScope", System.Windows.NameScope)]
    public class DataGridForeignKeyDescription : System.Windows.DependencyObject 
    Remarks

    If AutoCreateForeignKeyDescriptions is set to false or the underlying data source is not a DataTable or DataView, the foreign key descriptions can be manually specified for each constraint or enum through the ForeignKeyDescription property of the item property that represents the constraint or enum. When manually defining foreign key descriptions because the AutoCreateForeignKeyDescriptions property is set to false, the ItemsSource property and the ValuePath properties must be set in order to specify the source from which the values will be retrieved as well as their path, which represents the primary key of the foreign item in the ItemsSource

    Foreign key descriptions can also be specified when the constraints are automatically detected in the case where modifications need to be made to the descriptions. In that case, if the ItemsSource property has not been set, it will be updated to match the value that was automatically detected.

    Inheritance Hierarchy

    System.Object
       System.Windows.Threading.DispatcherObject
          System.Windows.DependencyObject
             Xceed.Wpf.DataGrid.DataGridForeignKeyDescription
                Xceed.Wpf.DataGrid.DataTableForeignKeyDescription

    Public Constructors
    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)  
    Public Fieldstatic (Shared in Visual Basic)Identifies the ForeignKeyConverter dependency property.  
    Public Fieldstatic (Shared in Visual Basic)Identifies the ItemsSource dependency property.  
    Public Fieldstatic (Shared in Visual Basic)Identifies the ValuePath dependency property.  
    Top
    Public Properties
     NameDescription
    Public Property (Inherited from System.Windows.DependencyObject)
    Public Property (Inherited from System.Windows.Threading.DispatcherObject)
    Public Property  
    Public PropertyGets or sets a foreign key converter, which allows custom key/value mappings to be provided.  
    Public Property (Inherited from System.Windows.DependencyObject)
    Public PropertyGets or sets the source from which the values to be displayed are retrieved.  
    Public PropertyGets or sets the path in the ItemsSource that contains the values to be displayed.  
    Top
    Public Methods
    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