https://github.com/lucasteles/modelviewbinder
A simple model view binder for .NET
https://github.com/lucasteles/modelviewbinder
Last synced: 6 months ago
JSON representation
A simple model view binder for .NET
- Host: GitHub
- URL: https://github.com/lucasteles/modelviewbinder
- Owner: lucasteles
- Created: 2017-03-28T13:43:28.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-19T14:00:03.000Z (over 6 years ago)
- Last Synced: 2025-02-11T14:00:09.064Z (8 months ago)
- Language: C#
- Homepage:
- Size: 73.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://ci.appveyor.com/project/lucasteles/modelviewbinder)
[](http://csmacnz.mit-license.org)
[](https://www.nuget.org/packages/ModelViewBinder/)
ModelViewBinder
=======
ModelViewBinder aims to support a simple two way binding definition.
*(For Windows Forms see the section bellow)
## Installing
To install from Nuget
```powershell
Install-Package ModelViewBinder
```
Projects
--------
* **ModelViewBinder:**
* Contains the base binder tool
* **ModelViewBinder.Forms:**
* Contains a implementation for winforms
Code Examples
-------------
### Basic Binding
##### Create a root binder for the view model
```C#
var binder = new ModelViewBinder(source);
```
##### Dispose of a binder
Diposing of a binder removes all bindings and disposes of all subcriptions created by the binder.
```C#
binder.Dispose();
```
##### Register external disposables with the binder
This can be used to tie the lifetime of other objects to the binder's lifetime.
```C#
binder.RegisterDispose(disposable);
```
##### Bind a view model property to other class property
```C#
binder.Bind(src => src.A, target, tgt => tgt.X);
```
##### Multiple Binds
```C#
binder
.Bind(src => src.A, target, tgt => tgt.X)
.Bind(src => src.B, target, tgt => tgt.Y)
;
```
##### Bind an integer view model property to a string property
```C#
binder.Bind(src => src.A, target, tgt => tgt.X, Convert.ToString);
```
##### Two way bind of an integer view model property to a string property
```C#
binder.Bind(src => src.A, target, tgt => tgt.X, Convert.ToString, int.Parse);
```
##### Update all view model properties
```C#
binder.FillSource();
```
##### Update all target properties
```C#
binder.FillTargets();
```
##### Automatic update View Model when target changes
You have to implement the `ITargetWithChangeEvent` interface and fire the `ValueChanged` event
##### More simple bind
If are you working with some type of control, you can implement `ITargetWithValue` or `ITargetWithValue`, it has a `Value` property which is automatically recognized by the binder
```C#
binder.Bind(src => src.A, target);
```
##### Enable or disable targets
If are you working with some type of control, you can implement `ITargetWithEnabled`, it has a Enabled property, commonly used in UI controls, if you want to set this property of all binded targets you can use:
For disable
```C#
binder.DisableAll();
```
For enable
```C#
binder.EnableAll();
```
##### Bind Callback
```C#
binder.Bind(src => src.A, target, tgt => tgt.X).Then(() => /* ... */);
```
##### Interface for Dependency Injection
If do you want to inject the `ModelViewBinder` as a dependency you can use `IModelViewBinder` interface.
## Windows Forms Binder [](https://www.nuget.org/packages/ModelViewBinder.Forms/)
### Installing
To install from Nuget
```powershell
Install-Package ModelViewBinder.Forms
```
For window form you should use `FormModelViewBinder`
```C#
var source = new Source();
var binder = new FormModelViewBinder(source);
binder
.Bind(src => src.ValueForTextbox, textBox1, tgt => tgt.Text)
.Bind(src => src.ValueForRichText, richTextBox1, tgt => tgt.Text)
.Bind(src => src.ValueForComboBox, comboBox1, tgt => tgt.SelectedValue)
.Bind(src => src.ValueForUpDown, numericUpDown1, tgt => tgt.Value)
.Bind(src => src.ValueForDatePicker, dateTimePicker1, tgt => tgt.Value)
.Bind(src => src.ValueForCheckBox, checkBox1, tgt => tgt.Checked)
;
binder.FillTargets();
```
The `FormModelViewBinder` automatically will bind the change events of the forms controls fot update de view model.
if you dont want this behavior you can disable:
```C#
binder.AutoFillSourceWhenTargetChanges = false;
```
For targets derivated of Windows.Form.Control, you dont need to implement `ITargetWithEnabled`, the methods `EnableAll` and `DisableAll` will recognize the Control and change properly the `Enabled` property
Tks