Key Property (FieldLayout)

The key into the FieldLayouts collection

Syntax

Visual Basic

'Declaration
 
Public Property Key As Object

C#

public object Key {get; set;}

Remarks

If a key isn't explicitly set then the Infragistics.Windows.Internal.PropertyDescriptorProvider.Key value will be used as the default key.

Note: in version 9.2 (NA 2009 volume 2) we changed the default value of the Key, initialized from the Infragistics.Windows.Internal.PropertyDescriptorProvider. This was done to make the keys more xaml friendly. The following table describes how the changes affect various data sources:

• "Prior to v.9.2 the key was the System.Data.DataTable instance. As of v9.2 the Key is now the DataTable.TableName."
• "Prior to v.9.2 the key was the data source instance. As of v9.2 the Key is now what is returned from the System.ComponentModel.ITypedList.GetListName() method."
• "Prior to v.9.2 the key was the System.Xml.XmlNode instance. As of v9.2 the Key is now the XmlNode.Name."

The KeyMatchingEnforced property was added to allow the Key to be used to explicitly idenify which data items are compatible when assigning a FieldLayout to a DataRecord.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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