This library is a .NET library designed to facilitate property modification detection within your classes. It provides a simple and efficient way to implement property change detection within your own classes.
This library is a .NET library designed to facilitate property modification detection within your classes. It provides a simple and efficient way to implement property change detection within your own classes.
Features
Property Modification Detection: Detect modifications to properties within your classes.
Modified Property List Retrieval: Easily retrieve a list of properties that have been modified.
Getting Started
To get started with ModifyDetector, follow these simple steps:
Install the ModifyDetector package: You can install the ModifyDetector library via NuGet Package Manager or NuGet CLI:
dotnet add package EdwardHsu.ModifyDetector
Inherit from ModifyDetector class: In the class where you want to implement modification detection, inherit from the ModifyDetector class.
using EdwardHsu.ModifyDetector;
public class YourClass : ModifyDetector
{
// Your class implementation
}
Add ModifyDetectTargetAttribute attribute: Mark the properties or fields you want to monitor for modifications with the ModifyDetectTargetAttribute attribute.
using EdwardHsu.ModifyDetector;
public class YourClass : ModifyDetector
{
[ModifyDetectTarget(Order = 0)]
public Guid Id { get; set; }
[ModifyDetectTarget(Order = 1)]
public string Name { get; set; }
}
Initialize Modification Detection: After setting initial values in your class constructor, call the UpdateDetectorState() method to initialize modification detection.
public class YourClass : ModifyDetector
{
public YourClass()
{
Id = Guid.NewGuid();
Name = "Untitled";
UpdateDetectorState();
}
[ModifyDetectTarget(Order = 0)]
public Guid Id { get; set; }
[ModifyDetectTarget(Order = 1)]
public string Name { get; set; }
}
Access modification information: You can access information about property modifications using the HasModified(out IEnumerable<ModifiedMember> modifiedMembers) method.
var instance = new YourClass();
// Modify properties...
var hasModified = instance.HasModified(out var modifiedProperties);
Example
using EdwardHsu.ModifyDetector;
public class YourClass : ModifyDetector
{
public YourClass()
{
Id = Guid.NewGuid();
Name = "Untitled";
UpdateDetectorState();
}
[ModifyDetectTarget(Order = 0)]
public Guid Id { get; set; }
[ModifyDetectTarget(Order = 1)]
public string Name { get; set; }
}
public class Program
{
static void Main(string[] args)
{
var instance = new YourClass();
instance.Name = "New Name";
var hasModified = instance.HasModified(out var modifiedProperties);
// ...Do something...
}
}
