Interface ICanTrackProperties
Indicates this item can track the original values of certain properties before any changes are made
Namespace: LemonEdge.Utils
Assembly: Utils.dll
Syntax
public interface ICanTrackProperties
Methods
ClearTrackedOriginalValues()
Clears the values of all tracked properties back to their original values
Declaration
void ClearTrackedOriginalValues()
GetAllOriginalTrackedPropertyValues()
Returns a dictionary of all the original values currently being tracked by this item. An entry for a property means the property has been changed. No entry means it still has its original value and has not been changed yet.
Declaration
IReadOnlyDictionary<string, object> GetAllOriginalTrackedPropertyValues()
Returns
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyDictionary<System.String, System.Object> | A dictionary of all the original values currently being tracked by this item |
HasTrackedPropertyChanged(String)
Indicates if the specified property (propName
) has had its value changed
Declaration
bool HasTrackedPropertyChanged(string propName)
Parameters
Type | Name | Description |
---|---|---|
System.String | propName | The name of the property to check if its value has been changed |
Returns
Type | Description |
---|---|
System.Boolean | True if the specified property has had its value changed |
OriginalTrackedPropertyValue(String)
Returns the original value of the specified property before it was changed.
Declaration
object OriginalTrackedPropertyValue(string propName)
Parameters
Type | Name | Description |
---|---|---|
System.String | propName | The name of the property to return the original value for |
Returns
Type | Description |
---|---|
System.Object | The original value for the specified property before it was changed |
Exceptions
Type | Condition |
---|---|
System.Collections.Generic.KeyNotFoundException | Throws an error if this property still has its original value and has not been changed |
OriginalTrackedPropertyValue<T>(String)
Returns the original value of the specified property before it was changed.
Declaration
T OriginalTrackedPropertyValue<T>(string propName)
Parameters
Type | Name | Description |
---|---|---|
System.String | propName | The name of the property to return the original value for |
Returns
Type | Description |
---|---|
T | The original value for the specified property before it was changed |
Type Parameters
Name | Description |
---|---|
T | The type of the specified property |
Exceptions
Type | Condition |
---|---|
System.Collections.Generic.KeyNotFoundException | Throws an error if this property still has its original value and has not been changed |