NOTE

Helpers Located in the HandyControl.Tools namespace.

Using HandyControl.Tools;

GlobalDataHelper

WARNING

GlobalDataHelper only Available in .NetCore >= 3.0, so you cant use it in .Net Framework with GlobalDataHelper you can save and read your application settings object to a json file

Example:

first of all you need to create a class and inherit from the GlobalDataHelper, Then create your properties.

public class AppConfig : GlobalDataHelper
{
    public string Name { get; set; }
    public string Password { get; set; } = "pass";
    public bool IsHash { get; set; } = true;

    public override string FileName { get; set; }
    public override JsonSerializerOptions JsonSerializerOptions { get; set; }
    public override int FileVersion { get; set; }
}

Note that there are 3 overriding properties: By default, the Json file name is AppConfig.json and will be placed next to the executable file, So if you want to change the name and location of the file, use the FileName property:

public override string FileName { get; set; } = "setting.json";

If you have made major changes to your settings file and you get an error when running the program, you can use the File versioning, if you change the version number, the previous settings file will be deleted, and the new settings will be replaced.

public override int FileVersion { get; set; } = 2;

Read/Write Settings

for reading values

var settings = GlobalDataHelper.Load<AppConfig>();
MessageBox.Show(settings.Name);

if you prefer async:

var settings = await GlobalDataHelper.LoadAsync<AppConfig>();
MessageBox.Show(settings.Name);

for writing values

var settings = GlobalDataHelper.Load<AppConfig>();
settings.IsHash = false;
settings.Name = "Mahdi";
settings.Save();

if you prefer async:

var settings = await GlobalDataHelper.LoadAsync<AppConfig>();
settings.IsHash = false;
settings.Name = "Mahdi";
await settings.SaveAsync();

CryptographyHelper

some method for generate hash and encrypt files

Generate Hash

MD5

string text = CryptographyHelper.GenerateMD5("mahdi");
// result = F9C24B8F961D48841A9838CCA5274D8D

VerifyMD5

bool verify = CryptographyHelper.VerifyMD5("F9C24B8F961D48841A9838CCA5274D8D", "mahdi");

SHA256

string text = CryptographyHelper.GenerateSHA256("mahdi");
// result = 2e0af263c88c69ecc23a51a76b7a2442ed6a9dff080f275a27ec486d1a0e0148

SHA256 for File

string text = CryptographyHelper.GenerateSHA256FromFile(@"D:\test.zip");
// result = 40aff63c88c69ecc23a51a76b7a2442ed6a9dff080f275a27ec486d1a0e0135

VerifySHA256

bool verify = CryptographyHelper.VerifySHA256("2e0af263c88c69ecc23a51a76b7a2442ed6a9dff080f275a27ec486d1a0e0148", "mahdi");

Encrypt & Decrypt Strings

AES

string enc = CryptographyHelper.EncryptStringAES("Mahdi", "password");

string dec = CryptographyHelper.DecryptStringAES("G7Jlxs4gb98msDUOIdN1iA==", "password");

Base64

string enc = CryptographyHelper.EncryptStringBase64("Mahdi");

string dec = CryptographyHelper.DecryptStringBase64("TWFoZGk=");

RSA

first Create your public and private key

var keys = CryptographyHelper.GenerateRSAKey();

Then encrypt and decrypt strings

string enc = CryptographyHelper.EncryptStringRSA("Mahdi", keys.PublicKey);

string dec = CryptographyHelper.DecryptStringRSA(enc, keys.PrivateKey);

Encrypt & Decrypt Files

AES

CryptographyHelper.EncryptFileAESAsync(sourcefile, destination, "password");

CryptographyHelper.DecryptFileAESAsync(sourcefile, destination, "password");

RSA

first Create your public and private key

var keys = CryptographyHelper.GenerateRSAKey();

Then encrypt and decrypt files

CryptographyHelper.EncryptFileRSAAsync(inputFilePath, outputFilePath, keys.PublicKey);

CryptographyHelper.DecryptFileRSAAsync(inputFilePath, outputFilePath, keys.PrivateKey);

Read and Write RSA Key

We have methods for reading and writing public and private keys from/to files

// export public key to file
ExportPublicKeyToFile("publicKey.public", publicKey);

// read public key from file
var pubKey = ReadPublicKey("publicKey.public");

// export private key to file
ExportPrivateKeyToFile("privateKey.enc", privateKey, password);

// read private key from file
var privKey = ReadPrivateKey("privateKey.enc", password);

// export public and private key to file
ExportPublicAndPrivateKeyToFile("publicKey.public", "privateKey.enc", RSAKey, password);

// read public and private key from file
var rsaKey = ReadPublicAndPrivateKey("publicKey.public", "privateKey.enc", password);

INIHelper

InIHelper class is for working with ini file in simple way.

Add Value

NOTE

you can use default section and path

InIHelper.AddValue("key1", "test1");
InIHelper.AddValue("key2", "test2");
InIHelper.AddValue("key3", "test3", "mySection");
InIHelper.AddValue("file4", "test4", "mySection");
InIHelper.AddValue("file5", "test5", "mySection");
InIHelper.AddValue("file6", "test6", "mySection2", @"D:\config.ini");

Read Value

MessageBox.Info(InIHelper.ReadValue("key1"));
// OR
MessageBox.Info(InIHelper.ReadValue("key3", "mySection"));
// OR
MessageBox.Info(InIHelper.ReadValue("key3", "mySection", @"D:\config.ini"));

Delete Key

NOTE

you can delete a key or section

InIHelper.DeleteKey("key4", "mySection");
InIHelper.DeleteSection("mySection");
InIHelper.DeleteKey("key4", "mySection", @"D:\config.ini");

Exist Key

NOTE

you can check if a key exist or not

MessageBox.Info(InIHelper.IsKeyExists("key4", "mySection"));

RegistryHelper

RegistryHelper class is for working with windows Registry

Add Key

NOTE

value can be everything (bool, int, string,...), default RegistryKey is CurrentUser for other type you need Admin Access

RegistryHelper.AddOrUpdateKey("myKey", "myFolder", value);
//OR
RegistryHelper.AddOrUpdateKey("myKey2", "myFolder", "test", Registry.LocalMachine);

Get Key

NOTE

you can cast value to any type you want

RegistryHelper.GetValue<bool>("myKey", "myFolder");
RegistryHelper.GetValue<string>("myKey", "myFolder", Registry.LocalMachine);

Delete Key

NOTE

default value for IsDeleteSubKey is False

bool result = RegistryHelper.DeleteKey("myKey", "myFolder");
// OR
bool result = RegistryHelper.DeleteKey("myKey", "myFolder", True);

Delete SubKey Tree

bool result = RegistryHelper.DeleteSubKeyTree("subkey", "myFolder");
// OR
bool result = RegistryHelper.DeleteSubKeyTree("subkey", "myFolder", Registry.LocalMachine);

UpdateHelper

---

title: UpdateHelper

you can use UpdateHelper for checking application updates from github release page

first you must create a new release tag in github repository, tag version must be in this format : 1.0.0.0 now we can check for update with github username and github repository

var update = await UpdateHelper.CheckUpdateAsync("Ghost1372", "HandyControls");

if (update.StableRelease.IsExistNewVersion)
{
    Debug.WriteLine(update.StableRelease.ReleaseUrl);
    Debug.WriteLine(update.StableRelease.CreatedAt.ToString());
    Debug.WriteLine(update.StableRelease.PublishedAt.ToString());
    
    //Asset is List so maybe there is more than one file you can use forech or increase index
    Debug.WriteLine(update.StableRelease.Assets[0].Url);
    Debug.WriteLine(update.StableRelease.IsPreRelease.ToString());
    Debug.WriteLine(update.StableRelease.Assets[0].Size.ToString());
    Debug.WriteLine(update.StableRelease.Version);
    Debug.WriteLine(update.StableRelease.Changelog);
}
else if (update.PreRelease.IsExistNewVersion)
{
    Debug.WriteLine(update.PreRelease.ReleaseUrl);
    Debug.WriteLine(update.PreRelease.CreatedAt.ToString());
    Debug.WriteLine(update.PreRelease.PublishedAt.ToString());
    
    //Asset is List so maybe there is more than one file you can use forech or increase index
    Debug.WriteLine(update.PreRelease.Assets[0].Url);
    Debug.WriteLine(update.PreRelease.IsPreRelease.ToString());
    Debug.WriteLine(update.PreRelease.Assets[0].Size.ToString());
    Debug.WriteLine(update.PreRelease.Version);
    Debug.WriteLine(update.PreRelease.Changelog);
}
else
{
    Debug.WriteLine("You are using latest version");
}

ApplicationHelper

GetEnum

get enum from string

var myenum = ApplicationHelper.GetEnum<MyEnum>("Dark");

IsSingleInstance

you can use IsSingleInstance for Run only one Instance of the program at a time. This method returns a true or false value If the value is true, it means that a Instance of the program is running and automatically closes the program and Brings Window To Front

Example:

if(!ApplicationHelper.IsSingleInstance())
{
    MessageBox("Another Instance Already Running...");
}

If for any reason the method does not work properly, specify the name of the program manually

ApplicationHelper.IsSingleInstance("myApplication");

IsAdministrator

Check if Running Application runs with admin access or not

if(ApplicationHelper.IsAdministrator())
{
    MessageBox("Your application is running in admin mode");
}

BringWindowToFront

You can use this method to find and focus MainWindow that is running

ApplicationHelper.BringWindowToFront();

StartProfileOptimization

Faster application execution at startup by caching

ApplicationHelper.StartProfileOptimization();

// OR Change Default Cache Path
// var CachePath = $"{AppDomain.CurrentDomain.BaseDirectory}AppCache"
// ApplicationHelper.StartProfileOptimization(CachePath);

WARNING

StartProfileOptimization is not Available in .Net 4.0

IsConnectedToInternet

Check if the internet is connected or not

bool IsConnected = ApplicationHelper.IsConnectedToInternet();

GetAbsoluteUri

Get Absolute Uri path

var uri = ApplicationHelper.GetAbsoluteUri("myApp", @"Resource/Theme.xaml");
// result => pack://application:,,,/myApp;component/Resource/Theme.xaml

RegisterContextMenuToDirectory

Register Context Menu in Windows Directory

string command = $"\"{Process.GetCurrentProcess().MainModule.FileName}\" \"%1\"";
ApplicationHelper.RegisterContextMenuToDirectory("MyApp", command);

for UnRegister Context Menu from Windows Directory

bool result = ApplicationHelper.UnRegisterContextMenuFromDirectory("MyApp");

RegisterContextMenuToFile

Register Context Menu in Windows File

string command = $"\"{Process.GetCurrentProcess().MainModule.FileName}\" \"%1\"";
ApplicationHelper.RegisterContextMenuToFile("MyApp", command);

for UnRegister Context Menu from Windows File

ApplicationHelper.UnRegisterContextMenuFromFile("MyApp");

RegisterContextMenuToBackground

Register Context Menu in Windows Background

string command = $"\"{Process.GetCurrentProcess().MainModule.FileName}\" \"%1\"";
ApplicationHelper.RegisterContextMenuToBackground("MyApp", command);

for UnRegister Context Menu from Windows File

ApplicationHelper.UnRegisterContextMenuFromBackground("MyApp");

RegisterContextMenuToDrive

Register Context Menu in Windows Background

string command = $"\"{Process.GetCurrentProcess().MainModule.FileName}\" \"%1\"";
ApplicationHelper.RegisterContextMenuToDrive("MyApp", command);

for UnRegister Context Menu from Windows File

ApplicationHelper.UnRegisterContextMenuFromDrive("MyApp");

NOTE

All of the above methods have an additional method, That contain Cascade Use these methods when you want to create a Cascade Context Menu.

WARNING

Registring and Unregsitring Registering and UnRegistering ContextMenu To Drive and Cascade Mode requires Administrator Access.

Restart

Restart Application

ApplicationHelper.Restart();

// Or Restart as Administrator
// ApplicationHelper.Restart(true);

GetExecutablePathNative

this is a P/Invoke Method to get current application executable path, this method work fine in .net framework and .net core in portable and publish mode release.

var path = ApplicationHelper.GetExecutablePathNative();

GetExecutablePath

this is a Assembly based Method to get current application executable path, this method work fine in .net framework and .net core in portable and publish mode release. for .net 5.0, GetExecutablePathNative method is used in this method.

var path = ApplicationHelper.GetExecutablePath();

SendMessageToAnotherProcess and ListenToReceiveMessageFromAnotherProcess

if you want to send message between different applications you can use this native method

ApplicationHelper.SendMessageToAnotherProcess("MainWindowTitle", "Message");

now You must register a listener to receive the message

private void MainWindow_Loaded(object sender, RoutedEventArgs e)
{
    ApplicationHelper.ListenToReceiveMessageFromAnotherProcess(this, message =>
    {
        MessageBox.Show(message);
    });
}

ColorHelper

GetColorFromBrush

Get Color from LinearGradientBrush, SolidColorBrush and Brush

var color = GetColorFromBrush(brush);

GetColorFromHex

Creates a Color from a XAML color string.

var color = GetColorFromHex("#3260a8");

GetHexFromColor

Get Hex Code from Color

var color = GetHexFromColor(color);

GetHexFromBrush

Get Hex Code from Brush

var color = GetHexFromBrush(brush);

LightenColor

Tints the color by the given percent.

Color ColorHelper.LightenColor(color, percent);

DarkenColor

Tints the color by the given percent.

Color ColorHelper.DarkenColor(color, percent);

GetColorFromHsl

Converts the HSL values to a Color.

Color ColorHelper.GetColorFromHsl(alpha, hue, saturation, lighting);

GetBrightnessFromColor

Gets the brightness of the color.

float ColorHelper.GetBrightnessFromColor(color);

GetHueFromColor

Gets the hue of the color.

float ColorHelper.GetHueFromColor(color);

GetSaturationFromColor

Gets the saturation of the color.

float ColorHelper.GetSaturationFromColor(color);

OSVersionHelper

get os version

OSVersionHelper.GetOSVersion();
var win10_1909 = OSVersionHelper.IsWindows10_1909_OrGreater();

GenericCompare

Check if there is an specific item in the collection or not

var model = new Model
{
    Id = 1,
    Name = "Test"
};
var contain = DataList.Contains(model, new GenericCompare<Model>(x=>x.Id));

DispatcherHelper

Run codes in Main Thread

DispatcherHelper.RunOnMainThread(() =>
{
    //action
});

ConvertHelper

BytesToBitmapImage

convert byte[] to BitmapImage

var bitmap = BytesToBitmapImage(bytes);

BitmapImageToBytes

convert BitmapImage to byte[]

var bytes = BitmapImageToBytes(bitmap);

BitmapImageToBase64

convert BitmapImage to Base64

var base64 = BitmapImageToBase64(bitmap);

Base64ToBitmapImage

convert Base64 to BitmapImage

var bitmap = Base64ToBitmapImage(base64);

ToFileSize

Translate numeric file size in bytes to a human-readable shorter string format.

string fileSize = ToFileSize(564654644);
//Result: 538/5 MB

XmlHelper

Serialize and Deserialize properties of a class to xml file.

Person person = new Person() { Name = "Mahdi", Age = 27 };
XmlHelper.Serialize<Person>(person, @"output.xml");

Person person2 = new Person();
person2 = XmlHelper.Deserialize<Person>(@"output.xml");

Console.WriteLine("Name: {0}", person2.Name);
Console.WriteLine("Age: {0}", person2.Age);

WindowHelper

DetermineIfInLightThemeMode

you can determine if windows theme is light or Dark

bool isLight = WindowHelper.DetermineIfInLightThemeMode();

MicaHelper

ApplyMicaEffect

You can enable mica material for Windows

NOTE

You do not need to use this helper to activate mica on hc:Window, hc:GlowWindow and BlurWindow, Mica is available on these windows by default through ApplyBackdropMaterial Property.

Use this helper for System.Windows.Window or any other type

WARNING

Mica only works on Windows 11 and above

1.First we need to Create a WindowChrome and then change the background to Transparent

public MainWindow()
{
    var chrome = new WindowChrome
    {
        CornerRadius = new CornerRadius(),
        ResizeBorderThickness = new Thickness(8),
        GlassFrameThickness = new Thickness(-1),
        NonClientFrameEdges = NonClientFrameEdges.None,
        UseAeroCaptionButtons = false
    };
    WindowChrome.SetWindowChrome(this, chrome);
    InitializeComponent();
    this.Background = Brushes.Transparent;
}

2. Now we can Activate mica

MicaHelper.ApplyMicaEffect(this);

or you can use another method with support dark mode

MicaHelper.ApplyMicaEffect(handle, isDark);

WARNING

If your Windows uses a dark theme, you need to set isDark to true

if you need to remove Mica you can use RemoveMicaEffect method

MicaHelper.RemoveMicaEffect();
// OR
MicaHelper.RemoveMicaEffect(handle);

if you want to know that mica effect is applied you can use:

bool isApplied = MicaHelper.IsMicaEffectApplied;

TaskbarHelper

You can control your app Taskbar Progressbar with this helper class

for changing Progressbar state:

TaskbarHelper.SetProgressState(handle, TaskbarStates.Error);

for changing Progressbar value:

TaskbarHelper.SetProgressValue(handle, 10, 100);

ProcessInfoHelper

Property

Name
Version
VersionWithPrefix
ProductName
ProductNameAndVersion
GetVersion
GetFileVersionInfo
GetProcess

var stringVersion = ProcessInfoHelper.Version; // 1.0.0
var stringVersionWithPrefix = ProcessInfoHelper.VersionWithPrefix; // v1.0.0
var productName = ProcessInfoHelper.ProductName; // MyAppName
var productNameAndVersion = ProcessInfoHelper.ProductNameAndVersion; // MyAppName v1.0.0
var version = ProcessInfoHelper.GetVersion(); // 1.0.0.0
var fileVersionInfo = ProcessInfoHelper.GetFileVersionInfo();
var process = ProcessInfoHelper.GetProcess();