BionicUtilities.Net 1.1.4

BionicUtilities.Net

Reusable utility and class library for WPF.

NuGet package

Class Reference

Contains

• BaseViewModel

• AsyncRelayCommand<T>

• 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>

• ValueConverters

  • BoolToStringConverter
  • BooleanMultiValueConverter
  • FilePathTruncateConverter
  • InvertValueConverter

• Collections

  • ObservablePropertyChangedCollection<T>

• MarkupExtensions

  • PrimitiveTypeExtension

• Profiler

BaseViewModel

implements INotifyPropertyChanged and INotifyDataErrorInfo

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.

    // 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.

    // 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.

    // 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;
      (bool HasError, string Message) oldValue = e.OldValue;
    }