RoomSharp.Reactive.WinForms 0.5.5

RoomSharp.Reactive.WinForms

WinForms bindings for RoomSharp.Reactive observable queries.

Installation

dotnet add package RoomSharp.Reactive.WinForms

Bind to BindingList

using RoomSharp.Reactive;
using RoomSharp.Reactive.WinForms;

var list = new BindingList<Todo>();

using var sub = query
    .AsObservable()
    .BindToBindingList(
        list,
        keySelector: t => t.Id,
        mergeExisting: (existing, incoming) =>
        {
            existing.Title = incoming.Title;
            existing.IsDone = incoming.IsDone;
        },
        onError: error => Log(error));

For larger lists or more explicit behavior, pass WinFormsBindingOptions<T>:

using RoomSharp.Reactive;
using RoomSharp.Reactive.WinForms;

var list = new BindingList<Todo>();

using var sub = query
    .AsObservable()
    .BindToBindingList(
        list,
        new WinFormsBindingOptions<Todo>
        {
            KeySelector = todo => todo.Id,
            UpdateMode = ReactiveCollectionUpdateMode.MergeByKey,
            MergeExisting = (existing, incoming) =>
            {
                existing.Title = incoming.Title;
                existing.IsDone = incoming.IsDone;
            },
            OnError = error => Log(error)
        });

Bind to BindingSource (with UI dispatch)

using RoomSharp.Reactive;
using RoomSharp.Reactive.WinForms;

var source = new BindingSource();

using var sub = query
    .AsObservable()
    .BindToBindingSource(
        source,
        this, // Control for UI dispatch
        keySelector: t => t.Id,
        onError: error => Log(error));

The BindingSource overload can suspend binding during updates and preserve sort/filter strings:

using var sub = query
    .AsObservable()
    .BindToBindingSource(
        source,
        this,
        new WinFormsBindingOptions<Todo>
        {
            KeySelector = todo => todo.Id,
            SuspendBindingDuringUpdate = true,
            PreserveSort = true,
            PreserveFilter = true,
            OnError = error => Log(error)
        });

Bind to DataGridView (optional helper)

using RoomSharp.Reactive;
using RoomSharp.Reactive.WinForms;

using var sub = query
    .AsObservable()
    .BindToDataGridView(
        dataGridView1,
        keySelector: t => t.Id,
        onError: error => Log(error));

Control-based overloads dispatch safely to the UI thread and dispose the subscription when the control is disposed. Binding updates report source and merge/update failures through onError instead of silently swallowing them.

BindToDataGridView preserves the current row and first displayed row by default. Disable either behavior when the grid owns navigation explicitly:

using var sub = query
    .AsObservable()
    .BindToDataGridView(
        dataGridView1,
        new WinFormsBindingOptions<Todo>
        {
            KeySelector = todo => todo.Id,
            PreserveCurrentRow = true,
            PreserveScrollPosition = true,
            AutoDisposeWithControl = true,
            OnError = error => Log(error)
        });