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


In This Topic
    DataGridForeignKeyDescription Class
    In This Topic
    Class that provides descriptive information about a foreign key or enumeration.
    Object Model
    DataGridForeignKeyDescription ClassForeignKeyConverter Class
    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
     NameDescription
    Public ConstructorDataGridForeignKeyDescription Constructor  
    Top
    Public Fields
     NameDescription
    Public Fieldstatic (Shared in Visual Basic)DisplayMemberPathProperty  
    Public Fieldstatic (Shared in Visual Basic)ForeignKeyConverterPropertyIdentifies the ForeignKeyConverter dependency property.  
    Public Fieldstatic (Shared in Visual Basic)ItemsSourcePropertyIdentifies the ItemsSource dependency property.  
    Public Fieldstatic (Shared in Visual Basic)ValuePathPropertyIdentifies the ValuePath dependency property.  
    Top
    Public Properties
     NameDescription
    Public PropertyDependencyObjectType (Inherited from System.Windows.DependencyObject)
    Public PropertyDispatcher (Inherited from System.Windows.Threading.DispatcherObject)
    Public PropertyDisplayMemberPath  
    Public PropertyForeignKeyConverterGets or sets a foreign key converter, which allows custom key/value mappings to be provided.  
    Public PropertyIsSealed (Inherited from System.Windows.DependencyObject)
    Public PropertyItemsSourceGets or sets the source from which the values to be displayed are retrieved.  
    Public PropertyValuePathGets or sets the path in the ItemsSource that contains the values to be displayed.  
    Top
    Public Methods
     NameDescription
    Public MethodClearValueOverloaded.  (Inherited from System.Windows.DependencyObject)
    Public MethodCoerceValue (Inherited from System.Windows.DependencyObject)
    Public MethodEquals (Inherited from System.Windows.DependencyObject)
    Public MethodGetHashCode (Inherited from System.Windows.DependencyObject)
    Public MethodGetLocalValueEnumerator (Inherited from System.Windows.DependencyObject)
    Public MethodGetValue (Inherited from System.Windows.DependencyObject)
    Public MethodInvalidateProperty (Inherited from System.Windows.DependencyObject)
    Public MethodReadLocalValue (Inherited from System.Windows.DependencyObject)
    Public MethodSetCurrentValue (Inherited from System.Windows.DependencyObject)
    Public MethodSetValueOverloaded.  (Inherited from System.Windows.DependencyObject)
    Top
    Protected Methods
     NameDescription
    Protected MethodOnPropertyChanged (Inherited from System.Windows.DependencyObject)
    Protected MethodSetForeignKeyConverter  
    Protected Internal MethodShouldSerializeProperty (Inherited from System.Windows.DependencyObject)
    Top
    Extension Methods
     NameDescription
    Public Extension MethodFindLogicalAncestor<T>Finds the logical ancenster
    Public Extension MethodFindLogicalAncestorsAndSelf
    Public Extension MethodFindLogicalChildren<T>Find the logical children.
    Public Extension MethodFindVisualAncestor<T>Finds the visual ancestor.
    Public Extension MethodFindVisualChildren<T>Finds the visual children.
    Public Extension MethodFindVisualTreeRootFinds the visual tree root.
    Public Extension MethodShowDialogOverloaded. 
    Top
    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

    Reference

    DataGridForeignKeyDescription Members
    Xceed.Wpf.DataGrid Namespace

    Send Feedback