BionicUtilities.Net 1.4.1

BionicUtilities.Net

Reusable utility and class library for WPF.

NuGet package

Class Reference

GitHub

Contains (snippet - full read me here)

(Click class link to load example)

• BaseViewModel - Encapsulation of basic view model behavior and features.
• AsyncRelayCommand<T> - Asynchronous ICommand implementation.
• Extension Methods for WPF e.g.
  • TryFindVisualParentElement<TParent> : bool
  • TryFindVisualParentElementByName : bool
  • TryFindVisualChildElement<TChild> : bool
  • TryFindVisualChildElementByName : bool
  • FindVisualChildElements<TChildren> : IEnumerable<TChildren>
  • ICollection.AddRange<T>
• EventArgs
  • ValueChangedEventArgs<T> - EventArgs that exposes OldValue and NewValue properties
  • ValueEventArgs<T> - EventArg thar holds a value T
• ValueConverters
  • BoolToStringConverter
  • BooleanMultiValueConverter
  • FilePathTruncateConverter
  • InvertValueConverter
• Collections
  • ObservablePropertyChangedCollection<T>
• MarkupExtensions
  • PrimitiveTypeExtension
• Profiler - Profiling API
• AppSettingsConnector - A default API to the AppSettings that provides strongly typed reading and writing (e.g. boo, int, double, string) of key-value pair values
• MruManager - Most Recently Used (MRU) file manager. An API that maintains an MRU table stored in the Application Settings file.
• EventAggregator - Implememtation of the EventAggregator pattern that supports dynamic aggregation of different typed event sources
• Easy to use Dialog Attached Behavior and infrastructure to allow MVVM friendly dialog handling from the view models in a fire-and-forget manner. To display dialogs implement IDialogViewModel classes and create a DataTemplate for each implementation. The DataTemplate is the rendered in a native Window. Addition attached properties allow for styling of the dialog Window or to assign an optional DataTemplateSelector. The attached behavior will handle showing and closing of the dialog.

BaseViewModel

• Implements and encapsulates INotifyPropertyChanged and INotifyDataErrorInfo.
• Allows to control whether invalid data is set on a property or neglected until validation passes by setting the default parameter isRejectInvalidValueEnabled of TrySetValue() to true (neglects invalid values by default).
• Also allows to control whether to throw an exception on validation error or not (silent) by setting the default parameter isThrowExceptionOnValidationErrorEnabled of TrySetValue() to true (is silent by default).
• Additionally exposes a PropertyValueChanged event which is raised in tandem with INotifyPropertyChanged.PropertyChanged but additionally carries old value and new value as event args.

Example with validation

private string name;
public string Name
{
  get => this.name;
  set
  {
    if (TrySetValue(
      value,
      (stringValue) =>
      {
        var messages = new List<string>() {"Name must start with an underscore"};
        return (stringValue.StartsWith("_"), messages);
      },
      ref this.name))
    {
      DoSomething(this.name);
    }
  }
}

Example without validation

private string name;
public string Name
{
  get => this.name;
  set
  {
    if (TrySetValue(value, ref this.name))
    {
      DoSomething(this.name);
    }
  }
}

AsyncRelayComand<T>

Reusable generic command class that encapsulates ICommand and allows asynchronous execution. When used with a Binding the command will execute asynchronously when an awaitable execute handler is assigned to the command.

Example

// ICommand property
public IAsyncRelayCommand<string> StringAsyncCommand => new AsyncRelayCommand<string>(ProcessStringAsync);
    
// Execute asynchronously
await StringAsyncCommand.ExecuteAsync("String value");
    
// Execute synchronously
StringAsyncCommand.Execute("String value");
    

Profiler

Static helper methods to measure performance e.g. the execution time of a code portion.

Example

// Specify a custom output
Profiler.LogPrinter = (timeSpan) => PrintToFile(timeSpan);
    
// Measure the average execution time of a specified number of iterations.
TimeSpan elapsedTime = Profiler.LogAverageTime(() => ReadFromDatabase(), 1000);
    
// Measure the execution times of a specified number of iterations.
List<TimeSpan> elapsedTime = Profiler.LogTimes(() => ReadFromDatabase(), 1000);
    
// Measure the execution time.
TimeSpan elapsedTime = Profiler.LogTime(() => ReadFromDatabase());

ValueChangedEventArgs<T>

Generic EventArgs implementation that provides value change information like OldValue and NewValue.

Example

// Specify a named ValueTuple as event argument
event EventHandler<ValueChangedEventArgs<(bool HasError, string Message)>> Completed;    
    
protected virtual void RaiseCompleted((bool HasError, string Message) oldValue, (bool HasError, string Message) newValue)
{
  this.Completed?.Invoke(this, new ValueChangedEventArgs<(bool HasError, string Message)>(oldValue, newValue));
}

private void OnCompleted(object sender, ValueChangedEventArgs<(bool HasError, string Message)> e)
{
  (bool HasError, string Message) newValue = e.NewValue;
  if (newValue.HasError)
  {
    this.TaskCompletionSource.TrySetException(new InvalidOperationException(newValue.Message));
  }
  this.TaskCompletionSource.TrySetResult(true);
}

AppSettingsConnector

A static default API to the AppSettings that provides strongly typed reading and writing (e.g. boo, int, double, string) of key-value pair values.

Example

// Write the Most Recently Used file count to the AppSettings file
AppSettingsConnector.WriteInt("mruCount", 10);

// If key exists read the Most Recently Used file count from the AppSettings file
if (TryReadInt("mruCount", out int mruCount))
{
  this.MruCount = mruCount;
}

GitHub (full read me here)