Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/averrunci/charites.bindings
Charites.Bindings is a class library that contains properties for data bindings.
https://github.com/averrunci/charites.bindings
bindings c-sharp
Last synced: 25 days ago
JSON representation
Charites.Bindings is a class library that contains properties for data bindings.
- Host: GitHub
- URL: https://github.com/averrunci/charites.bindings
- Owner: averrunci
- License: mit
- Created: 2018-07-14T05:34:19.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-12-08T04:05:27.000Z (about 1 year ago)
- Last Synced: 2024-09-17T14:31:13.612Z (3 months ago)
- Topics: bindings, c-sharp
- Language: C#
- Homepage:
- Size: 1.57 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
## Overview
Charites.Bindings is a class library that contains properties for data bindings. They are mainly two properties as follows.
### ObservableProperty
The ObservableProperty provides notifications when a value is changed and validations of a value.
The ObservableProperty implements the INotifyPropertyChanged interface and raises the PropertyChanged event when the Value property is changed. This property can be used for data bindings. For example in WinUI, a model code is as follows:
``` csharp
public class User
{
public ObservableProperty Name { get; } = string.Empty.ToObservableProperty();
public ObservableProperty Address { get; } = string.Empty.ToObservableProperty();
}
```
When this model is set to a data context, XAML code is as follows:
``` xml
```
The ObservableProperty can also bind another ObservableProperty as follows:
``` csharp
public class Content
{
public ObservableProperty IsExecuting { get; } = new ObservableProperty(false);
public ObservableProperty CanExecute { get; } = new ObservableProperty(false);
public Content()
{
CanExecute.Bind(IsExecuting, value => !value);
}
}
```
Multiple ObservableProperty can be bound as follows:
``` csharp
public class Content
{
public ObservableProperty Red { get; } = new ObservableProperty(0);
public ObservableProperty Green { get; } = new ObservableProperty(0);
public ObservableProperty Blue { get; } = new ObservableProperty(0);
public ObservableProperty Color { get; } = new ObservableProperty(Colors.Black);
public Content()
{
Color.Bind(
args => Color.FromArgb(args.GetValueAt(0), args.GetValueAt(1), args.GetValueAt(2)),
Red, Green, Blue
);
}
}
```
The ObservableProperty can bind another ObservableProperty in the two-way direction as follows:
``` csharp
public class Content
{
public ObservableProperty Age { get; } = new ObservableProperty(0);
public ObservableProperty InputAge { get; } = new ObservableProperty(string.Empty);
public Content()
{
Age.BindTwoWay(InputAge, int.Parse, value => value.ToString())
}
}
```
In order that the ObservableProperty implements IDataErrorInfo and INotifyDataErrorInfo interfaces, the value of the ObservableProperty can also be validated using the ValidationAttribute as follows:
``` csharp
public class User
{
[Display(Name = "First Name")]
[Required(ErrorMessage = "Please enter {0}.")]
[StringLength(25, ErrorMessage = "Please enter {0} within {1} characters.")]
public ObservableProperty FirstName { get; } = new ObservableProperty(string.Empty);
public User()
{
FirstName.EnableValidation(() => FirstName);
}
}
```
The ObservableProperty can delay a value change with the specified time span as follows:
``` csharp
public class Content
{
public ObservableProperty SearchCriteria { get; } = new ObservableProperty(string.Empty);
public Content()
{
SearchCriteria.EnableDelayValueChange(TimeSpan.FromMilliseconds(500));
}
}
```
The value change is executed with the specified SynchronizationContext. The defalut value is the SynchronizationContext.Current.
### BoundProperty
The BoundProperty provides the same function as the ObservableProperty but it can not change a value directly and can not bind in the two-way direction.
``` csharp
public class Content
{
public ObservableProperty IsExecuting { get; } = new ObservableProperty(false);
public BoundProperty CanExecute { get; }
public Content()
{
CanExecute = BoundProperty.By(IsExecuting, value => !value);
}
}
```
### EditableContentProperty
The EditableContentProperty provides that a value can be edited with a dedicate content. In order to edit the value with the dedicate content, implementations to edit the value must be added when the EditStarted, EditCompleted, or EditCanceled events occurred.
The classes that can be edited with a special content are as follows.
#### EditableTextProperty
The value is edited with a text value.
#### EditableSelectionProperty
The value is edited with selection items.
## NuGet
[Charites.Bindings](https://www.nuget.org/packages/Charites.Bindings/)
## LICENSE
This software is released under the MIT License, see LICENSE.