TechnicalUtilities 2.0.1

TechnicalUtilities

Technical Library By Developer Ben

Setup

dotnet add package TechnicalUtilities --version 2.0.1

Support version: net5, net6, net7

New Feature

• Technical Excel Utilities
• CreateFile

I - Type Convert

• Can check object, number, string, ... to object need convert

Use:

1. ToString

value.ToString();
value.ToString("{0}")

2. ToSafetyString

var value = null;
value.ToSafetyString();
// Result: Empty

string value = "demo example";
value.ToSafetyString();
//Result: "demo example"

3. ToByte, ToSByte, ToShort, ToUInt, ToUShort, ToInt, ToFloat , ToLong, ToULong, ToDecimal

var value = null;
value.ToByte();
//Result: 0

string value = " ";
value.ToByte();
//Result: 0

4. ToChar

var value = null;
value.ToChar();
//Result: " "

string value = "";
value.ToChar();
//Result:  " "

string value = "example";
value.ToChar();
//Result:  " "

string value = "a"
value.ToChar();
//Result:  'a'

5. ToDateTime

string value = "a"
value.ToChar();
//Result:  'a'

6. ToVNDCurrency

number money = 200000;
money.ToVNDCurrency();
//Result: 200,000

money.ToVNDCurrency(true);
//Result: 200,000 VND

7. ToNoSignFormat

string value = " Xin Chào ";
value.ToNoSignFormat();
//Result: " xin chao ";

value.ToNoSignFormat(true);
//Result: "xin chao";

8. ReverseString

string value = " example ";
value.ReverseString();
//Result: " elpmaxe ";

value.ReverseString(true);
//Result: "elpmaxe";

9. ConvertStringToListString

string str = "apple, orange, tomato";
str.ConvertStringToListString(',');
//Result: ["apple", "orange", "tomato"]

10. ConvertListStringToString

List<string> values = new List<string>{"apple", "orange", "tomato"};
values.ConvertListStringToString(';');
//Result: "apple;orange;tomato";

11. DatetimeToDateNotHour

DateTime dt = new DateTime();
dt.DatetimeToDateNotHour();
//Result: "2023/12/22 00:00:00";

12. CurrentTimeAgo (Apply for Vietnamese)

DateTime past = new DateTime(2023, 12, 22, 20, 0,0);
# example now is 2023/12/22 23:00:00

past.CurrentTimeAgo();
//Result: "3 Giờ Trước"

13. CurrentTimeNext (Apply for Vietnamese)

DateTime future = new DateTime(2023, 12, 22, 23, 0,0);
# example now is 2023/12/22 20:00:00

future.CurrentTimeNext();
//Result: "Còn 3 giờ"

14. CheckOutTime

DateTime past = new DateTime(2023, 12, 22, 20, 0,0);
example now is 2023/12/22 23:00:00

future.CheckOutTime();
//Result: True

15. FormatSpaceText

string text = " Hello         guys   ";
text.FormatSpaceText();
//Result: "Hello guys"

16. ToCapitalize

string text = "HOW ARE YOU, TO DAY?";
text.ToCapitalize();
//Result: "How are you, to day?"

17. ToTitleCase

string text = "how are you, to day?";
text.ToTitleCase();
//Result: "How Are You, To Day?"

18. StringFormat

string format = "hello {0}";
format.StringFormat("TOM");
//Result: "hello TOM";

II - Generate

• Generate string, guid, number, string and number ascending

Use

1. RandomNumber

string random = TechnicalGenerateUtility.RandomNumber(3);
//Result: 123

string random = TechnicalGenerateUtility.RandomNumber(1,9);
//Result: 4

2. RandomString

// * Normal
string random = TechnicalGenerateUtility.RandomString(1,6);
//Result: abcjsc

// * Has Number
string random = TechnicalGenerateUtility.RandomString(1,6,true);
//Result: abc123

// * Has Symboy
string random = TechnicalGenerateUtility.RandomString(1,6,true, true);
//Result: abc$123

// * Has UpperCase
string random = TechnicalGenerateUtility.RandomString(1,6,true, true, true);
//Result: ABC$123

3. RandomStringUpper

string random = TechnicalGenerateUtility.RandomStringUpper(5)
//Result: ABCDRF

4. RandomGuid

string random = TechnicalGenerateUtility.RandomGuid();
//Result: c17d172b-5829-4931-ba9f-d426bdaaa2ca

5. GenerateNumberAscending

string random = TechnicalGenerateUtility.GenerateNumberAscending(1, 6);
//Result: 000002

string random = TechnicalGenerateUtility.GenerateNumberAscending(1, 6, 'Z');
//Result: ZZZZZ2

5. GenerateCodeIdentity

string last = "AB00001";
string random = TechnicalGenerateUtility.GenerateCodeIdentity("AB", last.Code.Substring(2));

III - Security - Hash string - salt

• has a string to value need hash ( MD5, SHA256, SHA512 )

Use

1. ToMD5

string strHashMD5 = "demo";
string result = strHashMD5.ToMD5();
//Result: 95FD23D0F1F3C610AC831F5FB8598B16

// Has Salt
string result = strHashMD5.ToMD5("salt");
//Result: E3C5E837570015A39BC0CC075E3B449D

2. ToSHA256

string strHashMD5 = "demo";
string result = strHashMD5.ToSHA256();
//Result: 95FD23D0F1F3C610AC831F5FB8598B16

// Has Salt
string result = strHashMD5.ToSHA256("salt");
//Result: E3C5E837570015A39BC0CC075E3B449D

3. ToSHA512

string strHashMD5 = "demo";
string result = strHashMD5.ToSHA512();
//Result: 95FD23D0F1F3C610AC831F5FB8598B16

// Has Salt
string result = strHashMD5.ToSHA512("salt");
// Result: E3C5E837570015A39BC0CC075E3B449D

IV - File

• Control with url of file

V - Base Class Utilities

• Class base for Base Result

Use

1. OperationResult

// Interface 
Task<OperationResult> Demo();

// Service
public Async Task<OperationResult> Demo()
{
  
    return new OperationResult(){
        Success = true,
        StatusCode = 200,
        Message = string.Empty,
        Caption = "Caption",
        Data = null
    };
}

// Operation has constructor that:
OperationResult(string message)
OperationResult(bool success)
OperationResult(bool success, string message)
OperationResult(bool success, string message, string caption)
OperationResult(bool success, int statusCode, string message, string caption)

2. BaseResult T is class

// Class 
public class People()
{
    public int Id { get; set;}
    public string FullName { get; set;}
}

// Interface 
Task<BaseResult<People>> GetPeople();
Task<BaseResult<List<People>>> GetPeoples();

// Service
public Task<BaseResult<People>> GetPeople()
{
    // return one or three
    return new SuccessResult<People>(); // auto Status Code is 200
    // or
    return new ErrorResult<People>(); // auto Status Code is 400
    // or
    return new AuthorizeResult<People>(); // auto Status Code is 401
}

// SuccessResult  has constructor that:
SuccessResult(string message)
SuccessResult(T result)
SuccessResult(T data, string message)
// ErrorResult  has constructor that:
ErrorResult(string message)
ErrorResult(T result)
ErrorResult(T data, string message)
// AuthorizeResult  has constructor that:
AuthorizeResult(string message)

3. PaginationUtility T is Class

- Class

public class People
{
    public int Id { get; set;}
    public string FullName { get; set;}
}

- Interface

using TechnicalUtilities;

public interface IDemoServices
{
      Task<PaginationUtility<People>> GetPeoples(PaginationParam param);
}

- Services

using TechnicalUtilities;
public class DemoServices : IDemoServices {
 public async Task<PaginationUtility<People>> GetPeoples(PaginationParam param);
 {
   		var listPeoples = await ..... ; // get data from Database
   		return new PaginationUtility<People>.Create(listPeoples, param.PageNumber, param.PageSize)
 }
 // Or
 public async Task<PaginationUtility<People>> GetPeoples(PaginationParam param);
 {
   		IQueryable<People> queryable = ......; // raw queryable
   		return await PaginationUtility<People>.CreateAsync(queryable, param.PageNumber, param.PageSize)
 }
}

VI - Technical Excel Utilities

1. Install

-- Add file Aspose.Total.lic to folder Resources
Folder: \\Resources\\Aspose.Total.lic

// at Program.cs
TechnicalExcelUtilities.Install();
TechnicalExcelUtilities.Install("\\Folder\\Aspose.Total.lic");

2. Methods

3. Example

var style = TechnicalExcelUtilities.Style();
TechnicalExcelUtilities.SetAllBorders(style);
TechnicalExcelUtilities.SetAllNoneBorders(style);
TechnicalExcelUtilities.SetAlignCenter(style);
TechnicalExcelUtilities.SetAlignMiddle(style);
TechnicalExcelUtilities.SetFontColor(style, Color.FromArgb(255, 0, 0));
TechnicalExcelUtilities.SetBackground(style, Color.FromArgb(255, 0, 0));

// Compare file upload and file template
ExcelResult result = TechnicalExcelUtilities.CompareTemplateExcel(file, "\\Folder\\Demo.xlsx");

// * Model pattent
var modelProps = new List<FieldProperties>()
{
    new(0, true, ProductName , "Product name", "message error format {0} in cell {1}"),
    new(0, true, Description , "Product description", "message error format {0} in cell {1}"),
};

// * Validate Error with model pattent and return data follow properties
ExcelUploadValidateData validateResult = TechnicalExcelUtilities.ValidateUploadData(productFields, result.WorksheetPatent, result.Worksheet);

// * Worksheet to download
var worksheet = new ExcelWookSheet("result", "Error Sheet Name")
{
    Configs = new ConfigDownload(true),
    DataColumns = new List<ExcelColumn>() {
        new("I2", TechnicalExcelUtilities.ExcelBuiltInNumberFormats.Decimal_1),
        new("M2", style, true)
    }
};

// * Start row to render data
int startRow = 1; 
int column = 0; 

// * Value of cell to fill data
worksheet.DataCells = new List<ExcelCell>();
foreach (var model in validateResult.Result)
{
    worksheet.DataCells.AddRange(TechnicalExcelUtilities.GenerateExcelCellsFromProperties(model.Properties, startRow, column));
    startRow++;
}

// Fill data to file pattent 
var resultExport = TechnicalExcelUtilities.DownloadExcel(worksheet, @"/Folder/FilePattentDownload.xlsx");

// return result success or error
return new ErrorResult<object>(resultExport.Result, string.Empty);
return new SuccessResult<object>(resultExport.Result, string.Empty);

VII - Technical Mail Utility

1. TechnicalMailUtility

Exception error = null;
TechnicalMailUtility mail = new(MailSettingConstant.Gmail, MailSettingConstant.GPBase.ReverseString())
{
    Port = 465, //587
    // mail.Port = 587; //587
    EnableSSL = true,
    IsBodyHtml = false,

    Host = "smtp.gmail.com",
    To = to,
    Subject = "Subject",
    Body = $"A message or html body"
};

try
{
    mail.Send();
    // Do something
}
catch
{
    // Do something
    throw;
}

2. MailAppSetting

• 1. Setting

using TechnicalUtilities;
// Add Dependency Injection to Services
builder.Services.AddScoped<IMailUtility,MailUtility>();

• 2. Config AppSetting

{
    "MailAppSetting": {
        "Server": "smtp.gmail.com",
        "UserName": "demo@gmail.com",
        "Password": "Password",
        "FromEmail": "Your Gmail",
        "FromName": "Your fullName",
        "Port": "465 | 587",
        "EnableSsl": "true",
        "DefaultCredentials": "false"
    }
}

• 3.1 Use - Sent with a mail

// Inject IConfiguration 
private readonly IConfiguration _configuration;

var mailSetting = new MailUtility("MailAppSetting",_configuration);
string toMail = ""; // Mail receive
string subject = "Subject Title";
string content = "content";
bool isHtml = false; // True or False
string attachmentFilePath = @"...."; // file path

try
{
 
    mailSetting.SendMail(toMail,subject,content);
    await mailSetting.SendMailAsync(toMail,subject,content); // with async
    // Or
    mailSetting.SendMail(toMail,subject,content,isHtml, attachmentFilePath)
    await mailSetting.SendMailAsync(toMail,subject,content,isHtml, attachmentFilePath); // with async
}
catch (System.Exception)
{
    // Do something
    throw;
}

• 3.2 Use - Sent with multiple mails

// Inject IConfiguration 
private readonly IConfiguration _configuration;

var mailSetting = new MailUtility("MailAppSetting",_configuration);
string listMails = new List<string>(){
    "gmail1@gmail.com",
    "gmail2@gmail.com",
    "gmail3@gmail.com",
}; 

// Mail receive
string subject = "Subject Title";
string content = "content";
bool isHtml = false; // True or False
string attachmentFilePath = @"...."; // file path
string ccMail = "mail CC";

try
{
    // Normaly
    await mailSetting.SendListMailAsync(listMails,subject,content);
    // Or with html or attachment File
    await mailSetting.SendListMailAsync(listMails,subject,content,isHtml, attachmentFilePath);
    // Or with CC mail
      await mailSetting.SendListMailAsync(listMails,subject,content,isHtml, ccMail,attachmentFilePath);
}
catch (System.Exception)
{
    // Do something
    throw;
}