Skip to content

Commit 246e8ef

Browse files
ChrisPulmanChrisPulman
authored
breaking change: Make Bind use non-generic IViewFor (#3676)
<!-- Please be sure to read the [Contribute](https://github.com/reactiveui/reactiveui#contribute) section of the README --> **What kind of change does this PR introduce?** <!-- Bug fix, feature, docs update, ... --> Fix for #3644 **What is the current behavior?** <!-- You can also link to an open issue here. --> BindCommand requires a view inherited from `IViewFor<TViewModel>` ReactiveUserControl inherits `IViewFor<TViewModel>` which requires Generics which WinForms does not work well with. **What is the new behavior?** <!-- If this is a feature change --> Add BindCommandNonGeneric this is to avoid the request of not changing the existing code, therefore adding to the available options. NOTE: Bind only requires `IViewFor` and `IViewFor<TViewModel>` inherits `IViewFor` therefore would still be an API change if BindCommand were relaxed to IViewFor in the same way as Bind, but perhaps the best route. add ReactiveUserControlNonGeneric for WinForms - inherits `IViewFor` **What might this PR break?** Non due to new functions **Please check if the PR fulfills these requirements** - [ ] Tests for the changes have been added (for bug fixes / features) - [ ] Docs have been added / updated (for bug fixes / features) **Other information**:
1 parent 45a92af commit 246e8ef

16 files changed

+487
-35
lines changed

‎src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet6_0.verified.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,18 @@ namespace ReactiveUI
9292
where TView : class, ReactiveUI.IViewFor<TViewModel>
9393
where TViewModel : class
9494
where TProp : System.Windows.Input.ICommand { }
95+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
96+
where TView : class, ReactiveUI.IViewFor
97+
where TViewModel : class
98+
where TProp : System.Windows.Input.ICommand { }
99+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
100+
where TView : class, ReactiveUI.IViewFor
101+
where TViewModel : class
102+
where TProp : System.Windows.Input.ICommand { }
103+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
104+
where TView : class, ReactiveUI.IViewFor
105+
where TViewModel : class
106+
where TProp : System.Windows.Input.ICommand { }
95107
}
96108
public class CommandBinderImplementation : Splat.IEnableLogger
97109
{
@@ -104,6 +116,14 @@ namespace ReactiveUI
104116
where TView : class, ReactiveUI.IViewFor<TViewModel>
105117
where TViewModel : class
106118
where TProp : System.Windows.Input.ICommand { }
119+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
120+
where TView : class, ReactiveUI.IViewFor
121+
where TViewModel : class
122+
where TProp : System.Windows.Input.ICommand { }
123+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
124+
where TView : class, ReactiveUI.IViewFor
125+
where TViewModel : class
126+
where TProp : System.Windows.Input.ICommand { }
107127
}
108128
public static class ComparerChainingExtensions
109129
{

‎src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet7_0.verified.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,18 @@ namespace ReactiveUI
9292
where TView : class, ReactiveUI.IViewFor<TViewModel>
9393
where TViewModel : class
9494
where TProp : System.Windows.Input.ICommand { }
95+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
96+
where TView : class, ReactiveUI.IViewFor
97+
where TViewModel : class
98+
where TProp : System.Windows.Input.ICommand { }
99+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
100+
where TView : class, ReactiveUI.IViewFor
101+
where TViewModel : class
102+
where TProp : System.Windows.Input.ICommand { }
103+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
104+
where TView : class, ReactiveUI.IViewFor
105+
where TViewModel : class
106+
where TProp : System.Windows.Input.ICommand { }
95107
}
96108
public class CommandBinderImplementation : Splat.IEnableLogger
97109
{
@@ -104,6 +116,14 @@ namespace ReactiveUI
104116
where TView : class, ReactiveUI.IViewFor<TViewModel>
105117
where TViewModel : class
106118
where TProp : System.Windows.Input.ICommand { }
119+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
120+
where TView : class, ReactiveUI.IViewFor
121+
where TViewModel : class
122+
where TProp : System.Windows.Input.ICommand { }
123+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
124+
where TView : class, ReactiveUI.IViewFor
125+
where TViewModel : class
126+
where TProp : System.Windows.Input.ICommand { }
107127
}
108128
public static class ComparerChainingExtensions
109129
{

‎src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.DotNet8_0.verified.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,18 @@ namespace ReactiveUI
9292
where TView : class, ReactiveUI.IViewFor<TViewModel>
9393
where TViewModel : class
9494
where TProp : System.Windows.Input.ICommand { }
95+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
96+
where TView : class, ReactiveUI.IViewFor
97+
where TViewModel : class
98+
where TProp : System.Windows.Input.ICommand { }
99+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
100+
where TView : class, ReactiveUI.IViewFor
101+
where TViewModel : class
102+
where TProp : System.Windows.Input.ICommand { }
103+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
104+
where TView : class, ReactiveUI.IViewFor
105+
where TViewModel : class
106+
where TProp : System.Windows.Input.ICommand { }
95107
}
96108
public class CommandBinderImplementation : Splat.IEnableLogger
97109
{
@@ -104,6 +116,14 @@ namespace ReactiveUI
104116
where TView : class, ReactiveUI.IViewFor<TViewModel>
105117
where TViewModel : class
106118
where TProp : System.Windows.Input.ICommand { }
119+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
120+
where TView : class, ReactiveUI.IViewFor
121+
where TViewModel : class
122+
where TProp : System.Windows.Input.ICommand { }
123+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
124+
where TView : class, ReactiveUI.IViewFor
125+
where TViewModel : class
126+
where TProp : System.Windows.Input.ICommand { }
107127
}
108128
public static class ComparerChainingExtensions
109129
{

‎src/ReactiveUI.Tests/API/ApiApprovalTests.ReactiveUI.Net4_7.verified.txt

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,18 @@ namespace ReactiveUI
9090
where TView : class, ReactiveUI.IViewFor<TViewModel>
9191
where TViewModel : class
9292
where TProp : System.Windows.Input.ICommand { }
93+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, string? toEvent = null)
94+
where TView : class, ReactiveUI.IViewFor
95+
where TViewModel : class
96+
where TProp : System.Windows.Input.ICommand { }
97+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.IObservable<TParam?> withParameter, string? toEvent = null)
98+
where TView : class, ReactiveUI.IViewFor
99+
where TViewModel : class
100+
where TProp : System.Windows.Input.ICommand { }
101+
public static ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(this TView view, TViewModel? viewModel, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> propertyName, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlName, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
102+
where TView : class, ReactiveUI.IViewFor
103+
where TViewModel : class
104+
where TProp : System.Windows.Input.ICommand { }
93105
}
94106
public class CommandBinderImplementation : Splat.IEnableLogger
95107
{
@@ -102,6 +114,14 @@ namespace ReactiveUI
102114
where TView : class, ReactiveUI.IViewFor<TViewModel>
103115
where TViewModel : class
104116
where TProp : System.Windows.Input.ICommand { }
117+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.IObservable<TParam?> withParameter, string? toEvent = null)
118+
where TView : class, ReactiveUI.IViewFor
119+
where TViewModel : class
120+
where TProp : System.Windows.Input.ICommand { }
121+
public ReactiveUI.IReactiveBinding<TView, TProp> BindCommandNonGeneric<TView, TViewModel, TProp, TControl, TParam>(TViewModel? viewModel, TView view, System.Linq.Expressions.Expression<System.Func<TViewModel, TProp?>> vmProperty, System.Linq.Expressions.Expression<System.Func<TView, TControl>> controlProperty, System.Linq.Expressions.Expression<System.Func<TViewModel, TParam?>> withParameter, string? toEvent = null)
122+
where TView : class, ReactiveUI.IViewFor
123+
where TViewModel : class
124+
where TProp : System.Windows.Input.ICommand { }
105125
}
106126
public static class ComparerChainingExtensions
107127
{

‎src/ReactiveUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet6_0.verified.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ namespace ReactiveUI.Winforms
3232
public PlatformOperations() { }
3333
public string? GetOrientation() { }
3434
}
35+
public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
36+
{
37+
public ReactiveUserControlNonGeneric() { }
38+
protected override void Dispose(bool disposing) { }
39+
}
3540
public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
3641
where TViewModel : class
3742
{

‎src/ReactiveUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet7_0.verified.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ namespace ReactiveUI.Winforms
3232
public PlatformOperations() { }
3333
public string? GetOrientation() { }
3434
}
35+
public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
36+
{
37+
public ReactiveUserControlNonGeneric() { }
38+
protected override void Dispose(bool disposing) { }
39+
}
3540
public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
3641
where TViewModel : class
3742
{

‎src/ReactiveUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.DotNet8_0.verified.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,11 @@ namespace ReactiveUI.Winforms
3232
public PlatformOperations() { }
3333
public string? GetOrientation() { }
3434
}
35+
public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
36+
{
37+
public ReactiveUserControlNonGeneric() { }
38+
protected override void Dispose(bool disposing) { }
39+
}
3540
public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
3641
where TViewModel : class
3742
{

‎src/ReactiveUI.Tests/Platforms/winforms/API/WinformsApiApprovalTests.Winforms.Net4_7.verified.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,11 @@ namespace ReactiveUI.Winforms
3030
public PlatformOperations() { }
3131
public string? GetOrientation() { }
3232
}
33+
public class ReactiveUserControlNonGeneric : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor
34+
{
35+
public ReactiveUserControlNonGeneric() { }
36+
protected override void Dispose(bool disposing) { }
37+
}
3338
public class ReactiveUserControl<TViewModel> : System.Windows.Forms.UserControl, ReactiveUI.IActivatableView, ReactiveUI.IViewFor, ReactiveUI.IViewFor<TViewModel>
3439
where TViewModel : class
3540
{

‎src/ReactiveUI.Winforms/ReactiveUserControlNonGeneric.Designer.cs

Lines changed: 23 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎src/ReactiveUI.Winforms/ReactiveUserControlNonGeneric.cs

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Copyright (c) 2023 .NET Foundation and Contributors. All rights reserved.
2+
// Licensed to the .NET Foundation under one or more agreements.
3+
// The .NET Foundation licenses this file to you under the MIT license.
4+
// See the LICENSE file in the project root for full license information.
5+
6+
using System.Windows.Forms;
7+
8+
namespace ReactiveUI.Winforms;
9+
10+
/// <summary>
11+
/// This is an UserControl that is both and UserControl and has a ReactiveObject powers
12+
/// (i.e. you can call RaiseAndSetIfChanged).
13+
/// </summary>
14+
/// <seealso cref="System.Windows.Forms.UserControl" />
15+
/// <seealso cref="ReactiveUI.IViewFor" />
16+
public partial class ReactiveUserControlNonGeneric : UserControl, IViewFor
17+
{
18+
/// <summary>
19+
/// Initializes a new instance of the <see cref="ReactiveUserControlNonGeneric"/> class.
20+
/// </summary>
21+
public ReactiveUserControlNonGeneric() => InitializeComponent();
22+
23+
/// <inheritdoc/>
24+
object? IViewFor.ViewModel { get; set; }
25+
26+
/// <summary>
27+
/// Clean up any resources being used.
28+
/// </summary>
29+
/// <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
30+
protected override void Dispose(bool disposing)
31+
{
32+
if (disposing)
33+
{
34+
components?.Dispose();
35+
}
36+
37+
base.Dispose(disposing);
38+
}
39+
}

0 commit comments

Comments
 (0)