Personal library targeting .NET Standard
Class Libraries Table of Contents
-
-
-
public bool GetNodeAttributeValueAsBool(String, String, String, String, String)
-
public int GetNodeAttributeValueAsInt(String, String, String, String, String)
-
public void SetNodeAttributeValueFromBool(String, String, String, String, String, Boolean)
-
public void SetNodeAttributeValueFromInt(String, String, String, String, String, Int32)
-
public XmlNode GetNodeFromNodeList(XmlNodeList, String, String)
-
public XmlAttribute GetAttributeFromNodeList(XmlNodeList, String, String, String)
-
EncryptionManager [Obsolete]
Methods
public String GetTextResponse(String)
public Char GetCharResponse(String)
public Int32 GetNumericResponse(String, Int32, Int32)
public Void ChangeTextColour(ConsoleColor)
public Void SetConsoleTitle(String)
public Void PrintToCenterScreen(String)
Summary
Reads a string (word) from the console using Console.ReadLine. Method will loop until a valid string is entered. (Unacceptable values includes non-letters and whitespaces).
Declaration
public string GetTextResponse(string DisplayText)Parameter
string DisplayText
String to be displayed before user input.
Return
string
A String in lowercase.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
string response = textUI.GetTextResponse("Enter name");Summary
Reads a String (single letter) from the console using Console.ReadLine. Method will loop until a valid string is entered. (Unacceptable values includes non-letters and whitespaces).
Declaration
public char GetCharResponse(string DisplayText)Parameter
string DisplayText
String to be displayed before user input.
Return
char
A Char in lowercase.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
char response = textUI.GetCharResponse("Enter initial");Summary
Reads a String (numbers) from the console using Console.ReadLine. Method will loop until a valid number is entered. (Unacceptable values includes non-numeric or Values outside of Min/Max Scope).
Declaration
public int GetNumericResponse(string DisplayText, int minSelection, int maxSelection)Parameter
string DisplayText
String to be displayed before user input.
int minSelection
The minimum Int to be accepted.
int maxSelection
the Maximum Int to be accepted.
Return
int
An Int.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
int response = textUI.GetNumericResponse("Enter age", 0, 120);Summary
Executes Console.ReadLine Method.
Declaration
public string GetResponse()Return
string
String of characters from input stream.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
string response = textUI.GetResponse();Summary
Waits for user input by using the Console.ReadKey Method.
Declaration
public void AwaitResponse()Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.AwaitResponse();Summary
Sets the foreground colour of the console.
Declaration
public void ChangeTextColour(ConsoleColor colour)Parameter
<param name="colour">The enum of a specified colour.</param>Usage
using System;
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.ChangeTextColour(ConsoleColor.Green);Summary
Resets the console colour to default.
Declaration
public void ResetTextColour()Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.ResetTextColour();Summary
Sets the console title bar text.
Declaration
public void SetConsoleTitle(string title)Parameter
string title
Text to be displayed in the console title bar.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.SetConsoleTitle("MobileApp");Summary
Prints a string to the console.
Declaration
public void Print(string text)Parameter
string text
String value to be printed.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.Print("Sample Text");Summary
Prints a string Aligned to the center of the console. Can be used with decoration if used inside menu or header.
Declaration
public void PrintToCenterScreen(string text)Parameter
string text
Content to center.
Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.PrintToCenterScreen("<- Center Screen! ->");Summary
Prints a blank line using the newline string (Uses Environment.NewLine (\r\n)).
Declaration
public void PrintBlankLine()Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.PrintBlankLine();Summary
Clears console.
Declaration
public void ClearScreen()Usage
EVLib.ConsoleTools.TextUI textUI = new EVLib.ConsoleTools.TextUI();
textUI.ClearScreen();EVLib.ConsoleTools.TextHeader : TextUI
Methods :
public Void PrintHeader(String)
public Void PrintHeader(String, String)
public Void PrintHeader(String, String, String)
public Void PrintHeader(String, String, String, String)
public Void PrintHeader(String, String, String, String, String)
Summary
Application header, also sets the console title.
Declaration
public void PrintHeader()Usage
EVLib.ConsoleTools.TextHeader textHeader = new EVLib.ConsoleTools.TextHeader();
textHeader.PrintHeader();Summary
Application header, also sets the console title, with the Authors contact information.
Declaration
public void PrintHeader(string contact)Parameter
string contact
Authors contact information.
Usage
EVLib.ConsoleTools.TextHeader textHeader = new EVLib.ConsoleTools.TextHeader();
textHeader.PrintHeader("https://www.contoso.com");Summary
Application header, also sets the console title, with Authors contact information & Message to dismiss header.
Declaration
public void PrintHeader(string contact, string dismiss)Parameter
string contact
Authors contact information.
string dismiss
Message to dismiss header.
Usage
EVLib.ConsoleTools.TextHeader textHeader = new EVLib.ConsoleTools.TextHeader();
textHeader.PrintHeader("https://www.contoso.com", "Press any key to dismiss...");Summary
Application header, also sets the console title, with Version of application & Date of build.
Declaration
public void PrintHeader(string title, string version, string release)Parameter
string title
Title of application.
string version
Version of application.
string release
Date of build.
Usage
EVLib.ConsoleTools.TextHeader textHeader = new EVLib.ConsoleTools.TextHeader();
textHeader.PrintHeader("MobileApp", "Version 1.0.0", "01/Jan/2000");Summary
Application header, also sets the console title, with Version of application, Date of build & Authors contact information.
Declaration
public void PrintHeader(string title, string version, string release, string contact)Parameter
string title
Title of application.
string version
Version of application.
string release
Date of build.
string contact
Authors contact information.
Usage
EVLib.ConsoleTools.TextHeader textHeader = new EVLib.ConsoleTools.TextHeader();
textHeader.PrintHeader("MobileApp", "Version 1.0.0", "01/Jan/2000", "https://www.contoso.com");Summary
Application header, also sets the console title, with Version of application, Date of build, Authors contact information & Message to dismiss header.
Declaration
public void PrintHeader(string title, string version, string release, string contact, string dismiss)Parameter
string title
Title of application.
string version
Version of application.
string release
Date of build.
string contact
Authors contact information.
string dismiss
Message to dismiss header.
Usage
EVLib.ConsoleTools.TextHeader textHeader = new EVLib.ConsoleTools.TextHeader();
textHeader.PrintHeader("MobileApp", "Version 1.0.0", "01/Jan/2000", "https://www.contoso.com", "Press any key to dismiss...");Methods :
public Object Convert(Object, Type, Object, CultureInfo)
public Object ConvertBack(Object, Type, Object, CultureInfo)
Summary
Convert Boolean to Visibility.
Declaration
public object Convert(object value, Type targetType, object parameter, CultureInfo culture)Parameter
Object value
Boolean.
Type targetType
Visibility.
Object parameter
Null.
CultureInfo culture
Null.
Return
Object
Visible or Hidden.
Usage
<!--Define Resource-->
<BooleanToVisibilityConverter x:Key="BoolToVisibilityConverter"/>
<!--Use it in binding-->
<Button Visibility="{Binding AllowEditing, Converter={StaticResource BoolToVisibilityConverter}}"/>Summary
Convert Visibility to Boolean.
Declaration
public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture)Parameter
Object value
Boolean.
Type targetType
Visibility.
Object parameter
Null.
CultureInfo culture
Null.
Return
Object
Boolean Value.
Usage
<!--Define Resource-->
<BooleanToVisibilityConverter x:Key="BoolToVisibilityConverter"/>
<!--Use it in binding-->
<Button Visibility="{Binding AllowEditing, Converter={StaticResource BoolToVisibilityConverter}}"/>Methods :
public static Void Time(Action)
Summary
Times how long it takes to perform an action.
Declaration
public static string Time(Action action)Parameter
Action action
Method with no parameters.
Return
string
Time elapsed (minutes\seconds\hundredths).
Usage
string timeElapsed = EVLib.Debugging.Actions.Time(() =>
{
ActionToMeasure()
});
Debug.Print(timeElapsed);Summary
Gets or Sets the user interface (UI) visibility of this element.
Declaration
Values :
0 : Visible,
1 : Hidden,
2 : CollapsedUsage
return (bool)value ? Visibility.Visible : Visibility.Hidden;Methods :
public static void ShallowCopy(this Object, Object)
Summary
Copies all fields and properties from one Object to another.
Declaration
public static void ShallowCopy(this object destinationObject, object sourceObject)Parameter
object destinationObject
The destination Object.
object sourceObject
The source Object.
Usage
using EVLib.Extensions;
destinationObject.ShallowCopy(sourceObject);Methods :
public static string Between(this String, String, String)
public static string Before(this String, String)
public static string After(this String, String)
public static string RemoveWords(this String, String[])
public static string ReplaceLetters(this String, Char, Char)
public static string ReduceWhitespaces(this String)
Summary
Find the substring value between the First (a) and Last (b) values and return the string value between.
Declaration
public static string Between(this string value, string a, string b)Parameter
string a
First String value.
string b
Last String value.
Returns
string
The substring between the 2 string values.
Usage
using EVLib.Extensions;
string testString = "Hello! i am a simple string for testing";
string results = testString.Between("a ", "for");
Console.WriteLine(results);Output
simple string
Summary
Find the first substring value (a) and return the string value before.
Declaration
public static string Before(this string value, string a)Parameter
string a
First String.
Returns
string
The substring before the first string value.
Usage
using EVLib.Extensions;
string testString = "Hello! i am a simple string for testing";
string results = testString.Before(" for testing");
Console.WriteLine(results);Output
Hello! i am a simple string
Summary
Find the first substring value (a) and return the string value after.
Declaration
public static string After(this string value, string a)Parameter
string a
Last String.
Returns
string
The substring After the first string value.
Usage
using EVLib.Extensions;
string testString = "Hello! i am a simple string for testing";
string results = testString.After("for ");
Console.WriteLine(results);Output
testing
Summary
Find each string from the [excludedWords] array and remove the equivalent match in the source string.
Declaration
public static string RemoveWords(this string value, string[] excludedWords)Parameter
string[] excludedWords
Array of strings.
Returns
string
The substring with the excluded words removed.
Usage
using EVLib.Extensions;
string testString = "Hello! i am a simple string for testing";
string results = testString.RemoveWords(new string[] { "simple", "for", "testing" });
Console.WriteLine(results);Output
Hello! i am a string
Summary
Find all char (letterToFind) within the source string and replace with alternative char (letterToReplace).
Declaration
public static string ReplaceLetters(this string wordToSearch, char letterToFind, char letterToReplace)Parameter
char letterToFind
Char to find in source string.
char letterToReplace
Char to replace.
Returns
string
The substring with letters replaced upon match.
Usage
using EVLib.Extensions;
string testString = "Hello! i am a simple string for testing";
string results = testString.ReplaceLetters("e", "3");
Console.WriteLine(results);Output
H3llo! i am a simpl3 string for t3sting
Summary
Get string value after removing any extra white spaces.
Declaration
public static string ReduceWhitespaces(this string value)Parameter
string value
String to inspect for any extra white spaces.
Returns
string
A Single spaced string.
Usage
using EVLib.Extensions;
string testString = "Hello! i am a simple string for testing";
string results = testString.ReduceWhitespaces();
Console.WriteLine(results);Output
Hello! i am a simple string for testing"
Methods :
public Boolean IsFolderCreated(String)
public Boolean IsFileCreated(String)
public Void CreateFolder(String)
public Void CreateFile(String)
public Void DeleteFolder(String)
public Void DeleteFile(String)
public Void SaveToFile(String, String)
public Void SaveToFile(String, Byte[])
public String ReadStringFromFile(String)
public Byte[] ReadBytesFromFile(String)
public String ReadLineFromFile(String, Int32)
Summary
Checks if folder exists.
Declaration
public bool IsFolderCreated(string folderPath)Parameter
string folderPath
Path to folder.
Return
bool
Boolean true if folder exists, false if folder does not exist.
Usage
private string folderName = "TestFolder";
private string[] fullFolderPath = new string[] { Directory.GetCurrentDirectory(), folderName };
private string folderPath = Path.Combine(fullFolderPath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
if (!fileManager.IsFolderCreated(folderPath))
{
fileManager.CreateFolder(folderPath);
}Summary
Checks if file exists.
Declaration
public bool IsFileCreated(string filePath)Parameter
string filePath
Path to file.
Return
bool
Boolean true if file exists, false if file does not exist.
Usage
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
if (!fileManager.IsFileCreated(filePath))
{
fileManager.CreateFile(filePath);
}Summary
Creates folder in the specified path.
Declaration
public void CreateFolder(string folderPath)Parameter
string folderPath
Path to folder.
Usage
private string folderName = "TestFolder";
private string[] fullFolderPath = new string[] { Directory.GetCurrentDirectory(), folderName };
private string folderPath = Path.Combine(fullFolderPath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.CreateFolder(folderPath);Summary
Creates file in the specified path.
Declaration
public void CreateFile(string filePath)Parameter
string filePath
Path to a file.
Usage
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.CreateFile(filePath);Summary
Overwrites file with an empty string.
Declaration
public void ClearFile(string filePath)Parameter
string filePath
Path to file.
Usage
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.ClearFile(fileName);Summary
Deletes folder from the specified path.
Declaration
public void DeleteFolder(string folderPath)Parameter
string folderPath
Path to folder.
Usage
private string folderName = "TestFolder";
private string[] fullFolderPath = new string[] { Directory.GetCurrentDirectory(), folderName };
private string folderPath = Path.Combine(fullFolderPath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.DeleteFolder(folderName);Remarks
This operation is recursive and will delete all subdirectories and files.
Summary
Deletes file from the specified path and in case of error will wait and try again.
Declaration
public void DeleteFile(string filePath)Parameter
string filePath
Path to file.
Usage
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.DeleteFile(filePath);Remarks
Retry pattern tries 3 times (NumberOfRetries) with a 1 second delay (DelayOnretry).
Summary
Writes a String to a file on disk.
Declaration
public void SaveToFile(string filePath, string Value)Parameter
string filePath
Path to file.
string Value.
String value to save.
Usage
private string sampleString = "Some sample text";
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.SaveToFile(filePath, sampleString);Summary
Writes an array of bytes to a file on disk.
Declaration
public void SaveToFile(string filePath, byte[] Value)Parameter
string filePath
Path to file.
byte[] Value
Byte array to save.
Usage
private byte[] sampleBytes = { 72, 101, 108, 108, 111, 44, 32, 73, 32, 104, 97, 118, 101, 32, 110, 111, 116, 104, 105, 110, 103, 32, };
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
fileManager.SaveToFile(testFile, sampleBytes);Summary
Reads text from file on disk.
Declaration
public string ReadStringFromFile(string filePath)Parameter
string filePath
Path to file.
Return
string
String containing all text from file.
Usage
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
string textFromFile = fileManager.ReadStringFromFile(filePath);Summary
Reads bytes from file on disk.
Declaration
public byte[] ReadBytesFromFile(string filePath)Parameter
string filePath
Path to file.
Return
byte[]
Byte Array containing all text from file.
Usage
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
byte[] bytesFromFile = fileManager.ReadBytesFromFile(filePath);Summary
Reads a specific line from a file on disk.
Declaration
public string ReadLineFromFile(string filePath, int lineNumber)Parameter
string filePath
Path to file.
int
Line number to read.
Return
string
String containing text from specific line number.
Usage
private int lineToRead = 11;
private string fileName = "TestFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.FileManager fileManager = new EVLib.FileIO.FileManager();
string lineFromFile = fileManager.ReadLineFromFile(filePath, lineToRead);EVLib.FileIO.CalendarManager : FileManager
Methods :
public DateTime ParseDateTimeToUTC(String)
public DateTime ParseDateTimeToLocal(String)
public Void CreateCalendarEntry(String)
public Void CreateGMTCalendarTimeZoneEntry()
public Void CreateCalendarEvent(DateTime, DateTime, String, String, String)
public Void CreateCalendarAlarmEntry(Int32, String)
public Void CloseCalendarEntry()
public String CreateICSFile(String)
public String ReadICSFile(String)
public String DeleteICSFile(String)
Summary
Converts a String to a UTC DateTime equivalent.
Declaration
public DateTime ParseDateTimeToUTC(string dateTime)Parameter
string dateTime
String representation of a date and time.
Return
DateTime
UTC DateTime.
Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
DateTime HalloweenDateTime = calendarManager.ParseDateTimeToUTC("2021-10-31T15:34:56+03:00");
Console.WriteLine(HalloweenDateTime.ToString());Output
31/10/2021 12:34:56
Summary
converts a String to a Local DateTime equivalent.
Declaration
public DateTime ParseDateTimeToLocal(string dateTime)Parameter
string dateTime
String representation of a date and time.
Return
DateTime
Local DateTime.
Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
DateTime HalloweenDateTime = calendarManager.ParseDateTimeToLocal("2021-10-31T15:34:56+03:00");
Console.WriteLine(HalloweenDateTime.ToString());Output
31/10/2021 12:34:56
Summary
Starts an iCaldendar entry.
Declaration
public void CreateCalendarEntry(string productID)Parameter
string productID
Specifies the identifier for the product that created the iCalendar object.
Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
calendarManager.CreateCalendarEntry("Plus1XP//ReadMe//EN");Remarks
(Note: Product ID must be in the format - CompanyName//Product//EN)
Summary
Adds GMT timezone to the iCalendar entry.
Declaration
public void CreateGMTCalendarTimeZoneEntry()Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
calendarManager.CreateGMTCalendarTimeZoneEntry();Summary
Starts an iCalendar event.
Declaration
public void CreateCalendarEvent(DateTime startTime, DateTime endTime, string subject, string location, string description)Parameter
DateTime startTime
Event UTC DateTime Start.
DateTime endTime
Event UTC DateTime End.
string subject
Event Subject.
string location
Event location.
string description
Event Description.
Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
calendarManager.CreateCalendarEvent("2021-10-31T18:00:00+00:00", "2021-10-31T20:00:00+00:00", "Halloween Party", "Plaza Hotel, London", "Annual Halloween party");Summary
Adds alarm to the iCalendar entry.
Declaration
public void CreateCalendarAlarmEntry(int trigger, string subject)Parameter
int trigger
Specifies when the alarm will trigger (minutes).
string subject
Alarm Subject.
Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
calendarManager.CreateCalendarAlarmEntry(-30, "Halloween Party");Remarks
-PT will alaram before the trigger, PT will alarma after the trigger.
Summary
Closes the iCalendar event.
Declaration
public void CloseEventEntry()Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
calendarManager.CloseEventEntry();Summary
Closes the iCalendar entry.
Declaration
public void CloseCalendarEntry()Usage
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
calendarManager.CloseCalendarEntry();Summary
Writes all iCalendar entries to an ICS file.
Declaration
public string CreateICSFile(string filePath)Parameter
string filePath
Path to file.
Return
string
Validaton string if succesfull.
Usage
private string fileName = "TestCalendar.ics";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
string validation = calendarManager.CreateICSFile(string filePath)Summary
Checks if ICS file exists then reads it.
Declaration
public string ReadICSFile(string filePath)Parameter
string filePath
Path to file.
Return
string
All lines from ICS file, or "No Data" depending on if file exists.
Usage
private string fileName = "TestCalendar.ics";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
string results = calendarManager.ReadICSFile(string filePath)Summary
Checks if ICS file exists then deletes it.
Declaration
public string DeleteICSFile(string filePath)Parameter
string filePath
Path to file.
Return
string
Confirmation on if the ICS file was deleted.
Usage
private string fileName = "TestCalendar.ics";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.CalendarManager calendarManager = new EVLib.FileIO.CalendarManager();
string confirmation = calendarManager.DeleteICSFile(string filePath)EVLib.FileIO.XMLManager : FileManager
Samples
Methods :
public bool GetNodeAttributeValueAsBool(String, String, String, String, String)
public int GetNodeAttributeValueAsInt(String, String, String, String, String)
public void SetNodeAttributeValueFromBool(String, String, String, String, String, Boolean)
public void SetNodeAttributeValueFromInt(String, String, String, String, String, Int32)
public XmlDocument LoadXmlDocument(String)
public XmlNodeList LoadNodeList(XmlDocument, String)
public void SaveXmlDocument(XmlDocument, String)
public XmlNode GetNodeFromNodeList(XmlNodeList, String, String)
public XmlAttribute GetAttributeFromNodeList(XmlNodeList, String, String, String)
public string GetAttributeValueAsString(XmlAttribute)
public int GetAttributeValueAsInt(XmlAttribute)
public bool GetAttributeValueAsBool(XmlAttribute)
<?xml version="1.0" encoding="UTF-8"?>
<Settings>
<Formula1>
<Event Name="Practice" Saved="True" />
<Event Name="Qualifying" Saved="True" />
<Event Name="Race" Saved="True" />
<Event Name="Reminder" Saved="True" />
<Event Name="Trigger" Saved="15" />
</Formula1>
<MotoGP>
<Event Name="Practice" Saved="True" />
<Event Name="Qualifying" Saved="True" />
<Event Name="Warmup" Saved="False" />
<Event Name="Race" Saved="True" />
<Event Name="Moto2" Saved="False" />
<Event Name="Moto3" Saved="False" />
<Event Name="BehindTheScenes" Saved="False" />
<Event Name="AfterTheFlag" Saved="False" />
<Event Name="Reminder" Saved="True" />
<Event Name="Trigger" Saved="15" />
</MotoGP>
<WorldSBK>
<Event Name="Practice" Saved="True" />
<Event Name="Superpole" Saved="True" />
<Event Name="Warmup" Saved="False" />
<Event Name="Race" Saved="True" />
<Event Name="Reminder" Saved="True" />
<Event Name="Trigger" Saved="15" />
</WorldSBK>
</Settings>Summary
Gets boolean value from attribute in XML node.
Declaration
public bool GetNodeAttributeValueAsBool(string xmlFileLocation, string nodePath, string nodeName, string nodeValue, string attributeName)Parameter
string xmlFileLocation
Path to XML file.
string nodePath
XML node path.
string nodeName
XML node name.
string nodeValue
XML node value.
string attributeName
XML attribute name.
Return
bool
XML attribute value as boolean.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
bool isQualifyingSaved = xmlManager.GetNodeAttributeValueAsBool(filePath, "/Settings/Formula1/Event", "Name", "Qualifying", "Saved");Summary
Gets Integer value from attribute in XML node.
Declaration
public int GetNodeAttributeValueAsInt(string xmlFileLocation, string nodePath, string nodeName, string nodeValue, string attributeName)Parameter
string xmlFileLocation
Path to XML file.
string nodePath
XML node path.
string nodeName
XML node name.
string nodeValue
XML node value.
string attributeName
XML attribute name.
Return
int
XML attribute value as integer.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
int reminderTriggerMins = xmlManager.GetNodeAttributeValueAsInt(filePath, "/Settings/Formula1/Event", "Name", "Trigger", "Saved");Summary
Sets boolean value to attribute in XML node.
Declaration
public void SetNodeAttributeValueFromBool(string xmlFileLocation, string nodePath, string nodeName, string nodeValue, string attributeName, bool attributeValue)Parameter
string xmlFileLocation
Path to XML file.
string nodePath
XML node path.
string nodeName
XML node name.
string nodeValue
XML node value.
string attributeName
XML attribute name.
string attributeValue
Boolean value to set XML attribute value.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
xmlManager.SetNodeAttributeValueFromBool(filePath, "/Settings/Formula1/Event", "Name", "Qualifying", "Saved", true);Summary
Sets integer value to attribute in XML node.
Declaration
public void SetNodeAttributeValueFromInt(string xmlFileLocation, string nodePath, string nodeName, string nodeValue, string attributeName, int attributeValue)Parameter
string xmlFileLocation
Path to XML file.
string nodePath
XML node path.
string nodeName
XML node name.
string nodeValue
XML node value.
string attributeName
XML attribute name.
string attributeValue
Boolean value to set XML attribute value.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
xmlManager.SetNodeAttributeValueFromInt(filePath, "/Settings/Formula1/Event", "Name", "Trigger", "Saved", -15);Summary
Loads XML document from file.
Declaration
public XmlDocument LoadXmlDocument(string xmlFileLocation)Parameter
string xmlFileLocation
Path to XML file.
Return
XmlDocument
XML Document.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);Summary
Loads XML node list from XML document.
Declaration
public XmlNodeList LoadNodeList(XmlDocument xmlDoc, string nodePath)Parameter
XmlDocument xmlDoc
XML Document to load.
string nodePath
XML node path.
Return
XmlNodeList
XML node list.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlNodeList nodeList = xmlManager.LoadNodeList(xmlManager.LoadXmlDocument(filePath), "/Settings/Formula1/Event");Summary
Saves XML document to file.
Declaration
public void SaveXmlDocument(XmlDocument xmlDoc, string xmlFileLocation)Parameter
XmlDocument xmlDoc
XML Document to load.
string xmlFileLocation
Path to XML file.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);
// Amend xmlDoc here.
xmlManager.SaveXmlDocument(xmlDoc, filePath);Summary
Gets a single node from an XML node list.
Declaration
public XmlNode GetNodeFromNodeList(XmlNodeList nodeList, string nodeName, string nodeValue)Parameter
XmlNodeList nodeList
XML node list.
string nodeName
XML node name.
string nodeValue
XML node value.
Return
XmlNode
Single node.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);
XmlNodeList nodeList = xmlManager.LoadNodeList(xmlDoc, "/Settings/Formula1/Event");
XmlNode node = xmlManager.GetNodeFromNodeList(nodeList, "Name", "Qualifying");Summary
Gets attribute from XML node list.
Declaration
public XmlAttribute GetAttributeFromNodeList(XmlNodeList nodeList, string nodeName, string nodeValue, string attributeName)Parameter
XmlNodeList nodeList
XML node list.
string nodeName
XML node name.
string nodeValue
XML node value.
string attributeName
XML attribute name.
Return
XmlAttribute
XML attribute.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);
XmlNodeList nodeList = xmlManager.LoadNodeList(xmlDoc, "/Settings/Formula1/Event");
XmlAttribute elementAttribute = xmlManager.GetAttributeFromNodeList(nodeList, "Name", "Qualifying", "Saved");Summary
Gets attribute string value from XML attribute.
Declaration
public string GetAttributeValueAsString(XmlAttribute attribute)Parameter
XmlAttribute attribute
XML attribute.
Return
string
XML attribute value as string.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);
XmlNodeList nodeList = xmlManager.LoadNodeList(xmlDoc, "/Settings/Formula1/Event");
XmlAttribute elementAttribute = xmlManager.GetAttributeFromNodeList(nodeList, "Name", "Qualifying", "Saved");
string stringAttributeValue = xmlManager.GetAttributeValueAsString(elementAttribute);Summary
Gets attribute integer value from XML attribute.
Declaration
public int GetAttributeValueAsInt(XmlAttribute attribute)Parameter
XmlAttribute attribute
XML attribute.
Return
int
XML attribute value as integer.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);
XmlNodeList nodeList = xmlManager.LoadNodeList(xmlDoc, "/Settings/Formula1/Event");
XmlAttribute elementAttribute = xmlManager.GetAttributeFromNodeList(nodeList, "Name", "Qualifying", "Saved");
int intAttributeValue = xmlManager.GetAttributeValueAsInt(elementAttribute);Remarks
If attribute is null method will return 0.
Summary
Gets attribute boolean value from XML attribute.
Declaration
public bool GetAttributeValueAsBool(XmlAttribute attribute)Parameter
XmlAttribute attribute
XML attribute.
Return
bool
XML attribute value as boolean.
Usage
private string fileName = "Settings.xml";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.XMLManager xmlManager = new EVLib.FileIO.XMLManager();
XmlDocument xmlDoc = xmlManager.LoadXmlDocument(filePath);
XmlNodeList nodeList = xmlManager.LoadNodeList(xmlDoc, "/Settings/Formula1/Event");
XmlAttribute elementAttribute = xmlManager.GetAttributeFromNodeList(nodeList, "Name", "Qualifying", "Saved");
bool boolAttributeValue = xmlManager.GetAttributeValueAsBool(elementAttribute);Remarks
If attribute is null method will return false.
EVLib.FileIO.EncryptorManager : FileManager
Methods :
public Void EncryptToFile(String, String, String)
public String EncryptToString(String, String)
public Byte[] EncryptToByteArray(String, String)
public String DecryptFromFile(String, String)
public String DecryptFromString(String, String)
public String DecryptFromByteArray(Byte[], String)
Summary
Encrypts a String of data to a file on disk using AES.
Declaration
public void EncryptToFile(string filePath, string stringToEncrypt, string password)Parameter
string filePath
Path to file.
string stringToEncrypt
String of data to encrypt.
string password
Password used to encrypt / decrypt data.
Usage
private string decryptedSampleText = "I am sample text to be encrypted";
private string encryptionKey = "7pGG9!ech449*10";
private string fileName = "EncryptedFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.EncryptorManager encryptor = new EVLib.FileIO.EncryptorManager();
encryptor.EncryptToFile(filePath, decryptedSampleText, encryptionKey);Summary
Encrypts a String of data to Base64 using AES.
Declaration
public string EncryptToString(string stringToEncrypt, string password)Parameter
string stringToEncrypt
String of data to encrypt.
string password
Password used to encrypt / decrypt data.
Return
string
AES Encrypted String in Base64.
Usage
private string decryptedSampleText = "I am sample text to be encrypted";
private string encryptionKey = "7pGG9!ech449*10";
EVLib.FileIO.EncryptorManager encryptor = new EVLib.FileIO.EncryptorManager();
string encryptedString = encryptor.EncryptToString(decryptedSampleText, encryptionKey);
Console.WriteLine(encryptedString);Output
Mpoy/4sA77ouuB3AjBPAlt+QigWa6xt7fmAv1gvEmxVQoioEcnr80e2537bFQevhH8mqOkWvMlJUtkWROZqjdKtNF9h/dQBhtE5PmD8Epqtm/7BJGI8vi/Z/sMMZTBbOZ1daYhCLOFO6v3fhgfjm6JgRPiQn1n6r5ulRNz3mm18=
Remarks
Encoding.UTF8.GetString(bytes) does not convert a byte array containing arbitrary bytes to a string. Instead, it converts a byte array that is supposed to contain bytes making up an UTF8 encoded string back to that string.
If the byte array contains arbitrary bytes, such as the result of encrypting text, it is almost certain to corrupt the data and/or lose bytes. Instead, you should use a different method of converting a byte array to a string and back.
Base64 encoding has been choosen for this purpose.
Summary
Encrypts a String of data as a Byte Array using AES.
Declaration
public byte[] EncryptToByteArray(string stringToEncrypt, string password)Parameter
string stringToEncrypt
String of data to encrypt.
string password
Password used to encrypt / decrypt data.
Return
byte[]
AES Encrypted String as Byte Array.
Usage
private string decryptedSampleText = "I am sample text to be encrypted";
private string encryptionKey = "7pGG9!ech449*10";
EVLib.FileIO.EncryptorManager encryptor = new EVLib.FileIO.EncryptorManager();
byte[] encryptedBytes = encryptor.EncryptToByteArray(decryptedSampleText, encryptionKey);
System.Text.StringBuilder encryptedByteValues = new System.Text.StringBuilder();
foreach (byte byteValue in encryptedBytes)
{
encryptedByteValues.Append($"{byteValue} ");
}
Console.WriteLine(encryptedByteValues.ToString());Output
143, 110, 29, 111, 47, 41, 235, 67, 167, 18, 126, 10, 29, 167, 66, 8, 92, 105, 184, 7, 170, 46, 183, 200, 208, 71, 50, 117, 187, 14, 91, 121, 232, 245, 213, 229, 142, 114, 127, 183, 148, 54, 97, 51, 70, 81, 54, 128, 192, 126, 250, 33, 143, 73, 194, 174, 59, 90, 45, 245, 254, 3, 13, 237, 80, 126, 161, 71, 125, 179, 251, 172, 71, 85, 8, 92, 214, 123, 8, 51, 13, 225, 31, 57, 54, 141, 17, 30, 161, 121, 244, 172, 121, 224, 20, 59, 41, 164, 216, 5, 29, 224, 89, 44, 140, 12, 238, 202, 95, 226, 46, 151, 129, 37, 101, 218, 113, 253, 108, 60, 139, 83, 80, 91, 116, 162, 107, 42
Summary
Decrypts data to a String from a file on disk using AES.
Declaration
public string DecryptFromFile(string filePath, string password)Parameter
string filePath
Path to file.
string password
Password used to encrypt / decrypt data.
Return
string
Decrypted String.
Usage
private string encryptionKey = "7pGG9!ech449*10";
private string fileName = "EncryptedFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.EncryptorManager encryptor = new EVLib.FileIO.EncryptorManager();
string decryptedFile = encryptor.DecryptFromFile(filePath, encryptionKey);Summary
Decrypts a Base64 String encrypted of data using AES.
Declaration
public string DecryptFromString(string stringToDecrypt, string password)Parameter
string stringToDecrypt
String of data to encrypt.
string password
Password used to encrypt / decrypt data.
Return
string
Decrypted String.
Usage
private string encryptedSampleText = "Mpoy/4sA77ouuB3AjBPAlt+QigWa6xt7fmAv1gvEmxVQoioEcnr80e2537bFQevhH8mqOkWvMlJUtkWROZqjdKtNF9h/dQBhtE5PmD8Epqtm/7BJGI8vi/Z/sMMZTBbOZ1daYhCLOFO6v3fhgfjm6JgRPiQn1n6r5ulRNz3mm18=";
private string encryptionKey = "7pGG9!ech449*10";
EVLib.FileIO.EncryptorManager encryptor = new EVLib.FileIO.EncryptorManager();
string decryptedString = encryptor.DecryptFromString(encryptedString, encryptionKey);
Console.WriteLine(encryptedSampleText);Output
I am sample text to be encrypted
Remarks
Encoding.UTF8.GetString(bytes) does not convert a byte array containing arbitrary bytes to a string. Instead, it converts a byte array that is supposed to contain bytes making up an UTF8 encoded string back to that string.
If the byte array contains arbitrary bytes, such as the result of encrypting text, it is almost certain to corrupt the data and/or lose bytes. Instead, you should use a different method of converting a byte array to a string and back.
Base64 encoding has been choosen for this purpose.
Summary
Decrypts a Byte Array of encrypted data using AES.
Declaration
public string DecryptFromByteArray(byte[] byteArrayToDecrypt, string password)Parameter
byte[] byteArrayToDecrypt
Byte Array to decrypt.
string password
Password used to encrypt / decrypt data.
Return
string
Decrypted String.
Usage
private byte[] EncryptedSampleBytes = { 143, 110, 29, 111, 47, 41, 235, 67, 167, 18, 126, 10, 29, 167, 66, 8, 92, 105, 184, 7, 170, 46, 183, 200, 208, 71, 50, 117, 187, 14, 91, 121, 232, 245, 213, 229, 142, 114, 127, 183, 148, 54, 97, 51, 70, 81, 54, 128, 192, 126, 250, 33, 143, 73, 194, 174, 59, 90, 45, 245, 254, 3, 13, 237, 80, 126, 161, 71, 125, 179, 251, 172, 71, 85, 8, 92, 214, 123, 8, 51, 13, 225, 31, 57, 54, 141, 17, 30, 161, 121, 244, 172, 121, 224, 20, 59, 41, 164, 216, 5, 29, 224, 89, 44, 140, 12, 238, 202, 95, 226, 46, 151, 129, 37, 101, 218, 113, 253, 108, 60, 139, 83, 80, 91, 116, 162, 107, 42 };
private string encryptionKey = "7pGG9!ech449*10";
EVLib.FileIO.EncryptorManager encryptor = new EVLib.FileIO.EncryptorManager();
string decryptedSampleText = encryptor.DecryptFromByteArray(EncryptedSampleBytes, encryptionKey);
Console.WriteLine(decryptedSampleText);Output
I am sample text to be encrypted
EVLib.FileIO.EncryptionManager : FileManager
Constructors :
Methods :
public void EncryptStringToFile(String, String, String)
public string DecryptStringF romFile(String, String)
Summary
Create a new instance of the default AES implementation class
Declaration
public EncryptionManager()Usage
EVLib.FileIO.EncryptionManager encryptionManager = new EVLib.FileIO.EncryptionManager();Summary
Encrypts a String of data to a file on disk using AES.
Declaration
public void EncryptStringToFile(string filePath, string dataToEncrypt, string keyPhrase)Parameter
string filePath
Path to file.
string dataToEncrypt
String of data to encrypt.
string keyPhrase
Key to encrypt the data stream.
Usage
private string decryptedSampleText = "I am sample text to be encrypted";
private string encryptionKey = "7pGG9!ech449*10";
private string fileName = "EncryptedFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.EncryptionManager encryptionManager = new EVLib.FileIO.EncryptionManager();
encryptionManager.EncryptStringToFile(filePath, decryptedSampleText, encryptionKey);Summary
Decrypts data from a file on disk to a String using AES.
Declaration
public string DecryptStringFromFile(string filePath, string keyPhrase)Parameter
string filePath
Path to file.
string keyPhrase
Key to encrypt the data stream.
Return
string
Decrypted String.
Usage
private string encryptionKey = "7pGG9!ech449*10";
private string fileName = "EncryptedFile.txt";
private string[] fullFilePath = new string[] { Directory.GetCurrentDirectory(), fileName };
private string filePath = Path.Combine(fullFilePath);
EVLib.FileIO.EncryptionManager encryptionManager = new EVLib.FileIO.EncryptionManager();
string decryptedSampleText = encryptionManager.DecryptStringFromFile(filePath, encryptionKey);Methods :
public abstract Object Convert(Object, Type, Object, CultureInfo)
public abstract Object ConvertBack(Object, Type, Object, CultureInfo)
Summary
Converts a value.
Declaration
object Convert(object value, Type targetType, object parameter, CultureInfo culture);Parameter
object value
The value produced by the binding source.
Type targetType
The type of the binding target property.
object parameter
The converter parameter to use.
CultureInfo culture
The culture to use in the converter.
Return
object
A converted value. If the method returns null, the valid null value is used.
Summary
Converts a value.
Declaration
object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture);Parameter
object value
The value produced by the binding source.
Type targetType
The type of the binding target property.
object parameter
The converter parameter to use.
CultureInfo culture
The culture to use in the converter.
Return
object
A converted value. If the method returns null, the valid null value is used.
Fields :
Constructors :
public Client(String, Int32, Boolean)
public Client(String, Int32, String, String, Boolean)
Methods :
public String Send(MessageField messageField)
public String Send(String, String, String, String, String, String, String)
Summary
Initializes client for sending emails via STMP.
Declaration
public Client()Usage
EVLib.Mail.Client mail = new EVLib.Mail.Client();Summary
Initializes client for sending emails via STMP.
Declaration
public Client(ServerSettings serverSettings)Parameter
ServerSettings serverSettings
Initializes a new instance of the Server Settings class with the specified settings.
Usage
EVLib.Mail.ServerSettings serverSettings = new EVLib.Mail.erverSettings()
{
Host = "smtp.host.com",
Port = 587,
Username = "[email protected]",
Password = "StrongPassword1",
EnableSsl = true
};
EVLib.Mail.Client mail = new EVLib.Mail.Client(serverSettings);Summary
Initializes client for sending emails via STMP.
Declaration
public Client(string host, int port, bool enableSsl)Parameter
string host
Email servers host address.
int port
Email servers port.
bool enableSsl
Specifies whether the email server requires SSL.
Usage
EVLib.Mail.Client mail = new EVLib.Mail.Client("smtp.host.com", 587, true);Remarks
This overload sets "UseDefaultCredentials" to true. This will use the credentials of the current logged in user.
Summary
Initializes client for sending emails via STMP.
Declaration
public Client(string host, int port, string username, string password, bool enableSsl)Parameter
string host
Email servers host address.
int port
Email servers port.
string username
Username to login to email Server.
string password
Password to login to email server.
bool enableSsl
Specifies whether the email server requires SSL.
Usage
EVLib.Mail.Client mail = new EVLib.Mail.Client("smtp.host.com", 587, "[email protected]", "StrongPassword1", true);Summary
Sends an email via SMTP
Declaration
public String Send()Return
string
Sent confirmation as String.
Usage
ServerSettings serverSettings = new ServerSettings()
{
Host = "smtp.host.com",
Port = 587,
Username = "[email protected]",
Password = "StrongPassword1",
EnableSsl = true
};
MessageField messageField = new MessageField()
{
SenderName = "Sender",
SenderEmail = "[email protected]",
RecipientName = "Recipient",
RecipientEmail = "[email protected]",
Subject = "Test Message",
Body = "Testing mail-flow"
};
EVLib.Mail.Client mail = new EVLib.Mail.Client();
mail.Server = serverSettings;
mail.Field = messageField;
string confirmation = mail.Send();Summary
Sends an email via SMTP
Declaration
public string Send(MessageField messageField)Parameter
MessageField messageField
Initializes a new instance of the MessageField class with the specified fields.
Return
string
Sent confirmation as String.
Usage
ServerSettings serverSettings = new ServerSettings()
{
Host = "smtp.host.com",
Port = 587,
Username = "[email protected]",
Password = "StrongPassword1",
EnableSsl = true
};
MessageField messageField = new MessageField()
{
SenderName = "Sender",
SenderEmail = "[email protected]",
RecipientName = "Recipient",
RecipientEmail = "[email protected]",
Subject = "Test Message",
Body = "Testing mail-flow"
};
EVLib.Mail.Client mail = new EVLib.Mail.Client(serverSettings);
string confirmation = mail.Send(messageField);Summary
Sends an email via SMTP.
Declaration
public string Send(string senderName, string senderEmail, string recipientName, string recipientEmail, string subject, string body, string attachmentPath = null)Parameter
string senderName
Display name of Sender.
string senderEmail
Email address of sender.
string recipientName
Display name of recipient.
string recipientEmail
Email address of recipient.
string subject
Email subject.
string body
Email message body.
string attachmentPath
Email attachment file path.
Return
string
Sent confirmation as String.
Usage
EVLib.Mail.Client mail = new EVLib.Mail.Client("smtp.host.com", 587, "[email protected]", "StrongPassword1", true);
string confirmation = mail.Send("Sender", "[email protected]", "Recipient", "[email protected]", "Test Message", "Testing mail-flow");Methods :
public MessageField(String, String, String, String, String, String, String)
Summary
Provides the properties required to compose an email.
Declaration
public MessageField(string senderName, string senderEmail, string recipientName, string recipientEmail, string subject, string body, string attachmentPath = null)Parameter
string senderName
Display name of Sender.
string senderEmail
Email address of sender.
string recipientName
Display name of recipient.
string recipientEmail
Email address of recipient.
string subject
Email subject.
string body
Email message body.
string attachmentPath
Email attachment file path.
Usage
EVLib.Mail.MessageField messageField = new EVLib.Mail.MessageField()
{
SenderName = "Sender",
SenderEmail = "[email protected]",
RecipientName = "Recipient",
RecipientEmail = "[email protected]",
Subject = "Test Message",
Body = "Testing mail-flow"
};Methods :
public ServerSettings(String, Int32, String, String, Boolean)
public ServerSettings(String, Int32, Boolean)
Summary
Provides the properties required to send an email.
Declaration
public ServerSettings(string host, int port, string username, string password, bool enableSsl)Parameter
string host
Email servers host address.
int port
Email servers port.
string username
Username to login to email Server.
string password
Password to login to email server.
bool enableSsl
Specifies whether the email server requires SSL.
Usage
EVLib.Mail.ServerSettings serverSettings = new EVLib.Mail.ServerSettings()
{
Host = "smtp.host.com",
Port = 587,
Username = "[email protected]",
Password = "StrongPassword1",
EnableSsl = true
};Summary
Provides the properties required to send an email.
Declaration
public ServerSettings(string host, int port, bool enableSsl)Parameter
string host
Email servers host address.
int port
Email servers port.
bool enableSsl
Specifies whether the email server requires SSL.
Usage
EVLib.Mail.ServerSettings serverSettings = new EVLib.Mail.ServerSettings()
{
Host = "smtp.host.com",
Port = 587,
EnableSsl = true
};Remarks
This overload sets "UseDefaultCredentials" to true. This will use the credentials of the current logged in user.
Methods :
public Int64 Power(Int32, Int32)
public Double Average(List <Double>)
public Int32 RandomNumber(Int32, Int32)
Summary
Returns the power of an Interger without using the Math.Pow Method.
Declaration
public long Power(int baseNumber, int exponent)Parameter
int baseNumber
he base number to be multiplied.
int exponent
The number of times to multiply the base.
Return
long
The power of the result.
Usage
EVLib.Mathamatics.Calculate calculate = new EVLib.Mathamatics.Calculate();
int baseNumber = 8;
int exponent = 2;
long result = calculate.Power(baseNumber, exponent);
Console.WriteLine(result.ToString());Output
64
Remarks
The power or exponent of a number says how many times to use the number in multiplication.
Summary
Calculate the average value of a List, using a foreach loop.
Declaration
public double Average(List<double> listOfNumbers)Parameter
List<double> listOfNumbers
List of Doubles to be divided by the total amount of numbers in the list.
Return
double
The average of a set of numbers.
Usage
EVLib.Mathamatics.Calculate calculate = new EVLib.Mathamatics.Calculate();
System.Collections.Generic.List<double> numbers = new System.Collections.Generic.List<double>{ 5, 20, 15, 80, 26, 19 };
double result = calculate.Average(numbers);
Console.WriteLine(result.toString());Output
27.5
Remarks
The average of a set of numbers is simply the sum of the numbers divided by the total number of values in the set.
Summary
Create truely random numbers using an instance of an encryption class (RNGCryptoServiceProvider).
Declaration
public int RandomNumber(int minimumValue, int maximumValue)Parameter
int minimumValue
Minimum number.
int maximumValue
Maximium number.
Return
int
Random number.
Usage
EVLib.Mathamatics.Calculate calculate = new EVLib.Mathamatics.Calculate();
int randomResult = calculate.RandomNumber(1, 10);Remarks
"Random" The .Net framework's built-in random number generating class, doesn’t produce numbers that are really random.
Using an instance of an encryption class (RNGCryptoServiceProvider) is better at not following a pattern when it creates random numbers.
Methods :
public String Encode(String, String)
public String Decode(String, String)
Summary
A practical implementation of the XOR encryption technology in C# which is extended from the Vernam cipher.
Declaration
public string Encode(string data, string key)Parameter
string data
Data to be encoded.
string key
Key used to perform cipher.
Return
string
base64 encoded cipher.
Usage
string decodedData = "Hello World!";
string key = "7H1y23oiws";
EVLib.Mathamatics.Cipher cipher = new EVLib.Mathamatics.Cipher();
string encodedText = cipher.Encode(decodedData, key);
Console.WriteLine(encodedText);Output
g.OfYdG/YdG3QJGDA9KnU1eP
Remarks
The longer the key phrase, the longer it will take to crack.
However, this also makes it more easy it is to decode.
The optimal solution is to have a key of the same length than the source string.
Summary
A practical implementation of the XOR encryption technology in C# which is extended from the Vernam cipher.
Declaration
public string Decode(string data, string key)Parameter
string data
Data to be decoded.
string key
Key used to perform cipher.
Return
string
Decoded cipher.
Usage
string encodedData = "g.OfYdG/YdG3QJGDA9KnU1eP";
string key = "7H1y23oiws";
EVLib.Mathamatics.Cipher cipher = new EVLib.Mathamatics.Cipher();
string decodedText = cipher.Decode(encodedData, key);
Console.WriteLine(decodedText);Output
Hello World!
Remarks
The longer the key phrase, the longer it will take to crack.
However, this also makes it more easy it is to decode.
The optimal solution is to have a key of the same length than the source string.