Oakrey.Applications.ControlObjects 4.1.1

Oakrey.Applications.ControlObjects

A .NET / WPF library that provides a hierarchy of base classes and interfaces for building interactive, validated control objects. It covers object validation, keyboard gesture binding, device communication, timer-driven and cancelable operations, observable collections with automatic JSON persistence, and supporting WPF converters.

Main features

• Property-level validation via ValidableObject with per-property error messages and an aggregate IsValid / Errors surface
• Generic SendingObject<TData> base with reactive IObservable<TData> data stream, IObservable<Exception> error stream, and multi-key gesture support
• EnableObject<TData> - toggle-based enable/disable with Color and ToolTip bindings
• TimerObject<TData> - periodic sending driven by a configurable Period (TimeSpan)
• CancelableObject<TData> - async operation with cooperative cancellation via CancellationToken; exposes visual Color state
• ISendingDevice<TData> abstraction for downstream hardware or service targets with IObservable<DeviceStatus> status stream
• SendingObjectCollection<TData, TSendingObject> - ObservableCollection that auto-saves and auto-loads its items as JSON, reacts to device status changes, and routes gestures
• ICollectionService<TItem> - lightweight add/remove collection interface
• GestureControlMainViewModelBase - ViewModel base for windows/pages that own multiple gesture controllers; exposes a page-switch observable
• WPF SelectionHighlightConverter<T> and SelectionHighlightConverterFactoryExtension for reference-equality-based selection highlighting

Architecture

classDiagram
    class ValidableObject {
        +bool IsValid
        +string Errors
        +SetValid()
        +SetInvalid(errorMessage)
    }
    class CollectionObject {
        +string Name
        +string Description
    }
    class SendingObject~TData~ {
        +IObservable~TData~ DataToSend
        +IObservable~Exception~ Error
        +IObservable~string~ Info
        +MultiKeyGesture Gesture
        +ICommand Click
    }
    class EnableObject~TData~ {
        +bool IsEnabled
        +Brush Color
        +string ToolTip
    }
    class TimerObject~TData~ {
        +TimeSpan Period
        +string PeriodString
    }
    class CancelableObject~TData~ {
        +bool IsEnabled
        +Brush Color
        #Task Run(CancellationToken)
    }
    class SendingObjectCollection~TData~ {
        +IEnumerable~IGesture~ Gestures
        #string ConfigFileName
        #bool DisableObjectsWhenDeviceDisconnected
    }

    ValidableObject <|-- CollectionObject
    CollectionObject <|-- SendingObject
    SendingObject <|-- EnableObject
    EnableObject <|-- TimerObject
    SendingObject <|-- CancelableObject
    SendingObjectCollection --> SendingObject : contains
    SendingObjectCollection --> ISendingDevice : routes to

Key types

Requirements

• .NET 10 or higher
• Windows 10 version 1809 (build 17763) or higher (WPF dependency)
• Oakrey.UI 2.0.1
• Oakrey.Log.Toast 2.1.0
• System.Drawing.Common 10.0.8

Installation

.NET CLI

dotnet add package Oakrey.Applications.ControlObjects

Package Manager Console

Install-Package Oakrey.Applications.ControlObjects

NuGet Package Manager

Search for Oakrey.Applications.ControlObjects in Tools > NuGet Package Manager > Manage NuGet Packages for Solution.

Configuration

SendingObjectCollection automatically persists its items to a JSON file. The file path is resolved as:

<directory of ISettingsService.AppSettingPath>\<ConfigFileName>

Override the ConfigFileName property in each concrete collection to control the file name. If the file does not exist on first run, an empty collection is written automatically.

Example usage

Define a concrete sending object

public class MyCommand : EnableObject<string>
{
    public override void Disable() => IsEnabled = false;
}

Define a concrete collection

public class MyCommandCollection : SendingObjectCollection<string, MyCommand>
{
    protected override string ConfigFileName => "myCommands.json";

    public MyCommandCollection(
        ISendingDevice<string> device,
        IJsonService jsonService,
        ISettingsService settings)
        : base(device, jsonService, settings) { }
}

Subscribe to outgoing data

foreach (MyCommand cmd in collection)
{
    cmd.DataToSend.Subscribe(data => device.SendData(data, cmd.Name));
    cmd.Error.Subscribe(ex => logger.Error(ex.Message));
}

Implement a ViewModel with gesture support

public class MainViewModel : GestureControlMainViewModelBase
{
    public MainViewModel(IEnumerable<IGestureController> controllers)
        : base(controllers) { }
}

WPF selection highlight in XAML

<Border.Visibility>
    <MultiBinding Converter="{local:SelectionHighlightConverterFactory}">
        <Binding Path="." />
        <Binding Path="DataContext.SelectedItem" RelativeSource="{RelativeSource AncestorType=Window}" />
    </MultiBinding>
</Border.Visibility>

Development notes

• All SendingObject subclasses implement IDisposable. Ensure collections are disposed when the owning ViewModel is torn down to release Rx subscriptions.
• CancelableObject.Run returns Task.CompletedTask by default; override it to add async logic. Errors thrown inside Run are forwarded through the Error observable.
• GestureControlMainViewModelBase implements IAutoConfigurable. Override LoadBasicGestures and LoadSwitchGestures to register application-level shortcuts.
• TimerObject validates PeriodString on set; it must parse as a TimeSpan between 1 ms and 1 day.

Project information

• Author: Oakrey
• License: MIT
• Repository: ApplicationServices
• Package URL: NuGet - Oakrey.Applications.ControlObjects

License

This project is licensed under the MIT License. See the LICENSE file for details.