ITableEntry.Identity Property

Definition

The identifier.

public:
 property System::Object ^ Identity { System::Object ^ get(); };
public:
 property Platform::Object ^ Identity { Platform::Object ^ get(); };
public object Identity { get; }
member this.Identity : obj
Public ReadOnly Property Identity As Object

Property Value

Returns Object.

Remarks

Two entries are considered equivalent if their Identity are equal using Equals(Object, Object).

This property (and the related properties in ITableEntriesSnapshot are used to persist various attributes like selection state when an ITableEntry is replaced with a new ITableEntry. Entries that replace an existing entry will have their attributes set based on the attributes of the replaced entry.

When ReplaceEntries(IReadOnlyList<ITableEntry>, IReadOnlyList<ITableEntry>) is called, every entry in the list of old entries is checked to see if it has state and there is a corresponding entry among the added entries. If there is, then the two entries are considered equivalent and the old entry's attributes are copied to the new entry.

When a ITableEntriesSnapshotFactory replaces its snapshot with a new version, the entry state is transfered over exactly as if ReplaceSnapshot(ITableEntriesSnapshot, ITableEntriesSnapshot) had been called on the factory's old and new snapshots.

Applies to