ApplicationOptions 2.0.0
.NET 6.0
This package targets .NET 6.0. The package is compatible with this framework or higher.
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
dotnet add package ApplicationOptions --version 2.0.0
NuGet\Install-Package ApplicationOptions -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="ApplicationOptions" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ApplicationOptions --version 2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: ApplicationOptions, 2.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install ApplicationOptions as a Cake Addin #addin nuget:?package=ApplicationOptions&version=2.0.0 // Install ApplicationOptions as a Cake Tool #tool nuget:?package=ApplicationOptions&version=2.0.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
ApplicationOptions
A very simple library for creating easy to use to use application settings that use json serialization.
What it does?
This library allows you to quickly and easily create application settings classes. I generally use this in my WPF apps.
Prerequisites
- .Net Standard 2+,.Net 6+
Installation and sources
<pre> nuget install ApplicationOptions </pre>
Example app settings class
public class AppSettings : BaseOptions<AppSettings>
{
// Override base folder
protected override string BaseFolder => @"settings\";
// Override file name (Default is $"options.{typeof(T).Name}.json")
protected override string FileName => "appsettings.json";
public DateTime LastLaunch { get; set; }
public string ApiKey { get; set; }
public string ApiEndpoint { get; set; }
//Sets a default value when initializing new settings
public Rectangle WindowPosition { get; set; } = new Rectangle(100, 100, 850, 900);
}
Example subscribing to events
BaseOptionSettings.WatchForOptionChanges = true;
AppSettings.Instance.Loaded += () => Console.WriteLine("AppSettings Loaded");
AppSettings.Instance.Saved += () => Console.WriteLine("AppSettings Saved");
Example usage
public class MyWindow : Window
{
private Settings => AppSettings.Instance;
public MyWindow()
{
Top = Settings.WindowPosition.Y;
Left = Settings.WindowPosition.X;
Width = Settings.WindowPosition.Width;
Height = Settings.WindowPosition.Height;
}
private void OnClosing()
{
BaseOptionSettings.LoadedOptions.ForEach(o => o.Save());
}
}
Global settings usage
The BaseOptionSettings
class lets you configure how the BaseOptions class.
// Watch for changes in the settings files
BaseOptionSettings.WatchForOptionChanges = true;
// Save all loaded options
BaseOptionSettings.LoadedOptions.ForEach(o => o.Save());
// Indent the json files or not
BaseOptionSettings.IndentJson = false;
Quick contributing guide
- Fork and clone locally
- Create a topic specific branch. Add some nice feature.
- Send a Pull Request to spread the fun!
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Newtonsoft.Json (>= 13.0.3)
-
net6.0
- Newtonsoft.Json (>= 13.0.3)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.0.0 | 243 | 11/18/2023 |