From 735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Fri, 19 Apr 2024 23:12:24 -0500 Subject: [PATCH] Documentation + Unfinished SecurityHelper Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle. --- CapyKit/CapyKit.csproj | 1 + CapyKit/CapyKit.sln | 8 +- CapyKit/Color.cs | 1916 ++++++++ CapyKit/Helpers/SecurityHelper.cs | 161 + CapyKit/Password.cs | 217 + .../Content/VersionHistory/VersionHistory.aml | 33 + .../Content/VersionHistory/v1.0.0.0.aml | 28 + Documentation/Content/Welcome.aml | 55 + Documentation/ContentLayout.content | 18 + Documentation/Documentation.shfbproj | 103 + .../7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md | 17 + .../849aa079-3d64-4cf1-966f-44af23c73160.md | 27 + .../F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md | 43 + .../Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md | 43 + .../Help/Fields_T_CapyKit_Pbkdf2Algorithm.md | 21 + Documentation/Help/Home.md | 27 + ...Attributes_EnumerationAttribute_1__ctor.md | 47 + ...s_EnumerationDescriptionAttribute__ctor.md | 47 + .../Help/M_CapyKit_CapyEventArgs__ctor.md | 59 + .../M_CapyKit_CapyEventReporter_Subscribe.md | 62 + ...M_CapyKit_CapyEventReporter_Unsubscribe.md | 51 + ...ns_EnumerationExtensions_GetDescription.md | 61 + ...xtensions_EnumerationExtensions_GetName.md | 61 + ...ons_EnumerationExtensions_GetPrettyName.md | 61 + ...tensions_EnumerationExtensions_GetValue.md | 61 + ...tensions_EnumerationExtensions_Parse__1.md | 73 + ...nsions_EnumerationExtensions_Parse__1_1.md | 77 + ...t_Extensions_LINQExtensions_Distinct__2.md | 70 + ...Kit_Extensions_LINQExtensions_Filter__1.md | 71 + ...t_Extensions_LINQExtensions_Filter__1_1.md | 71 + ...ensions_LINQExtensions_LeftOuterJoin__4.md | 91 + ...sions_LINQExtensions_LeftOuterJoin__4_1.md | 91 + ..._Extensions_LINQExtensions_PageCount__1.md | 78 + ...xtensions_LINQExtensions_PageCount__1_1.md | 78 + ...pyKit_Extensions_LINQExtensions_Page__1.md | 85 + ...Kit_Extensions_LINQExtensions_Page__1_1.md | 85 + ...tensions_StringExtensions_IfNullOrEmpty.md | 66 + ...ons_StringExtensions_IfNullOrWhiteSpace.md | 66 + ...yKit_Helpers_CompressionHelper_Compress.md | 51 + ...pers_CompressionHelper_CompressToString.md | 51 + ...rs_CompressionHelper_DecompressToString.md | 51 + ...Helpers_CompressionHelper_Decompress__1.md | 57 + ...lpers_CompressionHelper_Decompress__1_1.md | 57 + ...LanguageHelper_CamelCaseToHumanReadable.md | 51 + .../M_CapyKit_Helpers_LanguageHelper__ctor.md | 37 + ...rs_SecurityHelper_CompareHashedPassword.md | 55 + ...Helpers_SecurityHelper_CompareSessionID.md | 55 + ...t_Helpers_SecurityHelper_GetCalendarKey.md | 41 + ...elpers_SecurityHelper_GetRandomPassword.md | 51 + ...Kit_Helpers_SecurityHelper_HashPassword.md | 51 + ...M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md | 55 + ...pyKit_Helpers_SecurityHelper_SHA256Hash.md | 51 + .../M_CapyKit_Helpers_SecurityHelper__ctor.md | 37 + ...pers_SerializationHelper_Deserialize__1.md | 64 + ...rs_SerializationHelper_Deserialize__1_1.md | 64 + ...rs_SerializationHelper_Deserialize__1_2.md | 57 + ...rs_SerializationHelper_SerializeToBytes.md | 51 + ...s_SerializationHelper_SerializeToString.md | 51 + .../M_CapyKit_IPasswordAlgorithm_Compare.md | 62 + .../M_CapyKit_IPasswordAlgorithm_Encrypt.md | 54 + .../Help/M_CapyKit_Password_ToString.md | 42 + .../Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md | 64 + .../Help/M_CapyKit_Pbkdf2Algorithm__ctor.md | 37 + .../Help/M_CapyKit_PoolItem_1_ReleaseLock.md | 40 + .../Help/M_CapyKit_PoolItem_1_SetLock.md | 44 + .../Help/M_CapyKit_PoolItem_1_ToString.md | 42 + .../Help/M_CapyKit_Pool_1_GetAvailableItem.md | 41 + .../Help/M_CapyKit_Pool_1_ReleaseItem.md | 50 + Documentation/Help/M_CapyKit_Pool_1__ctor.md | 48 + .../Help/M_CapyKit_Pool_1__ctor_1.md | 48 + .../Help/M_CapyKit_Pool_1__ctor_2.md | 52 + .../M_CapyKit_PropertyComparer_2_Equals.md | 63 + ..._CapyKit_PropertyComparer_2_GetHashCode.md | 65 + .../M_CapyKit_PropertyComparer_2__ctor.md | 47 + ...pyKit_Attributes_EnumerationAttribute_1.md | 39 + ...ributes_EnumerationDescriptionAttribute.md | 39 + .../Help/Methods_T_CapyKit_CapyEventArgs.md | 33 + .../Methods_T_CapyKit_CapyEventReporter.md | 21 + ...apyKit_Extensions_EnumerationExtensions.md | 33 + ...ods_T_CapyKit_Extensions_LINQExtensions.md | 42 + ...s_T_CapyKit_Extensions_StringExtensions.md | 21 + ...ods_T_CapyKit_Helpers_CompressionHelper.md | 30 + ...ethods_T_CapyKit_Helpers_LanguageHelper.md | 36 + ...ethods_T_CapyKit_Helpers_SecurityHelper.md | 54 + ...s_T_CapyKit_Helpers_SerializationHelper.md | 30 + .../Methods_T_CapyKit_IPasswordAlgorithm.md | 21 + .../Help/Methods_T_CapyKit_Password.md | 33 + .../Help/Methods_T_CapyKit_Pbkdf2Algorithm.md | 36 + .../Help/Methods_T_CapyKit_PoolItem_1.md | 33 + .../Help/Methods_T_CapyKit_Pool_1.md | 39 + .../Methods_T_CapyKit_PropertyComparer_2.md | 39 + Documentation/Help/N_CapyKit.md | 55 + Documentation/Help/N_CapyKit_Attributes.md | 16 + Documentation/Help/N_CapyKit_Extensions.md | 19 + Documentation/Help/N_CapyKit_Helpers.md | 22 + ..._Extensions_EnumerationExtensions_Parse.md | 19 + ...apyKit_Extensions_LINQExtensions_Filter.md | 19 + ...Extensions_LINQExtensions_LeftOuterJoin.md | 19 + ..._CapyKit_Extensions_LINQExtensions_Page.md | 19 + ...Kit_Extensions_LINQExtensions_PageCount.md | 19 + ...it_Helpers_CompressionHelper_Decompress.md | 19 + ...Helpers_SerializationHelper_Deserialize.md | 22 + .../Help/Overload_CapyKit_Pool_1__ctor.md | 22 + ...rload_CapyKit_PropertyComparer_2_Equals.md | 19 + ..._CapyKit_PropertyComparer_2_GetHashCode.md | 19 + ...Attributes_EnumerationAttribute_1_Value.md | 44 + .../Help/P_CapyKit_CapyEventArgs_Level.md | 43 + .../Help/P_CapyKit_CapyEventArgs_Message.md | 43 + .../P_CapyKit_CapyEventArgs_MethodName.md | 43 + ...apyKit_IPasswordAlgorithm_AlgorithmName.md | 42 + .../Help/P_CapyKit_Password_Algorithm.md | 43 + Documentation/Help/P_CapyKit_Password_Hash.md | 43 + Documentation/Help/P_CapyKit_Password_Salt.md | 43 + ...P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md | 48 + .../Help/P_CapyKit_PoolItem_1_Index.md | 44 + .../Help/P_CapyKit_PoolItem_1_Item.md | 44 + .../Help/P_CapyKit_PoolItem_1_Locked.md | 44 + .../Help/P_CapyKit_PoolItem_1_TypeName.md | 44 + ...pyKit_Attributes_EnumerationAttribute_1.md | 21 + ...ributes_EnumerationDescriptionAttribute.md | 21 + .../Properties_T_CapyKit_CapyEventArgs.md | 24 + ...Properties_T_CapyKit_IPasswordAlgorithm.md | 18 + .../Help/Properties_T_CapyKit_Password.md | 24 + .../Properties_T_CapyKit_Pbkdf2Algorithm.md | 18 + .../Help/Properties_T_CapyKit_PoolItem_1.md | 27 + ...pyKit_Attributes_EnumerationAttribute_1.md | 94 + ...ributes_EnumerationDescriptionAttribute.md | 88 + Documentation/Help/T_CapyKit_CapyEventArgs.md | 84 + .../Help/T_CapyKit_CapyEventHandler.md | 46 + .../Help/T_CapyKit_CapyEventReporter.md | 53 + Documentation/Help/T_CapyKit_Color.md | 3839 +++++++++++++++++ Documentation/Help/T_CapyKit_EventLevel.md | 59 + ...apyKit_Extensions_EnumerationExtensions.md | 65 + .../T_CapyKit_Extensions_LINQExtensions.md | 74 + .../T_CapyKit_Extensions_StringExtensions.md | 53 + .../T_CapyKit_Helpers_CompressionHelper.md | 59 + .../Help/T_CapyKit_Helpers_LanguageHelper.md | 70 + .../Help/T_CapyKit_Helpers_SecurityHelper.md | 88 + .../T_CapyKit_Helpers_SerializationHelper.md | 59 + .../Help/T_CapyKit_IPasswordAlgorithm.md | 52 + Documentation/Help/T_CapyKit_Password.md | 73 + .../Help/T_CapyKit_Pbkdf2Algorithm.md | 92 + Documentation/Help/T_CapyKit_PoolItem_1.md | 82 + Documentation/Help/T_CapyKit_Pool_1.md | 84 + .../Help/T_CapyKit_PropertyComparer_2.md | 86 + Documentation/Help/_Footer.md | 6 + Documentation/Help/_Sidebar.md | 135 + .../fa7407d1-9116-4ad7-a9ab-ed094685b070.md | 15 + Documentation/Help/icons/Help.png | Bin 0 -> 4942 bytes Documentation/Help/media/AlertCaution.png | Bin 0 -> 334 bytes Documentation/Help/media/AlertLanguage.png | Bin 0 -> 543 bytes Documentation/Help/media/AlertNote.png | Bin 0 -> 429 bytes Documentation/Help/media/AlertSecurity.png | Bin 0 -> 434 bytes Documentation/Help/media/AlertToDo.png | Bin 0 -> 341 bytes Documentation/icons/Help.png | Bin 0 -> 4942 bytes 155 files changed, 13030 insertions(+), 1 deletion(-) create mode 100644 CapyKit/Color.cs create mode 100644 CapyKit/Helpers/SecurityHelper.cs create mode 100644 CapyKit/Password.cs create mode 100644 Documentation/Content/VersionHistory/VersionHistory.aml create mode 100644 Documentation/Content/VersionHistory/v1.0.0.0.aml create mode 100644 Documentation/Content/Welcome.aml create mode 100644 Documentation/ContentLayout.content create mode 100644 Documentation/Documentation.shfbproj create mode 100644 Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md create mode 100644 Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md create mode 100644 Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md create mode 100644 Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md create mode 100644 Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md create mode 100644 Documentation/Help/Home.md create mode 100644 Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md create mode 100644 Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md create mode 100644 Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md create mode 100644 Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md create mode 100644 Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md create mode 100644 Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md create mode 100644 Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md create mode 100644 Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md create mode 100644 Documentation/Help/M_CapyKit_Password_ToString.md create mode 100644 Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md create mode 100644 Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md create mode 100644 Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md create mode 100644 Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md create mode 100644 Documentation/Help/M_CapyKit_PoolItem_1_ToString.md create mode 100644 Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md create mode 100644 Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md create mode 100644 Documentation/Help/M_CapyKit_Pool_1__ctor.md create mode 100644 Documentation/Help/M_CapyKit_Pool_1__ctor_1.md create mode 100644 Documentation/Help/M_CapyKit_Pool_1__ctor_2.md create mode 100644 Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md create mode 100644 Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md create mode 100644 Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md create mode 100644 Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md create mode 100644 Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md create mode 100644 Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Password.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md create mode 100644 Documentation/Help/Methods_T_CapyKit_PoolItem_1.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Pool_1.md create mode 100644 Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md create mode 100644 Documentation/Help/N_CapyKit.md create mode 100644 Documentation/Help/N_CapyKit_Attributes.md create mode 100644 Documentation/Help/N_CapyKit_Extensions.md create mode 100644 Documentation/Help/N_CapyKit_Helpers.md create mode 100644 Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md create mode 100644 Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md create mode 100644 Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md create mode 100644 Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md create mode 100644 Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md create mode 100644 Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md create mode 100644 Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md create mode 100644 Documentation/Help/Overload_CapyKit_Pool_1__ctor.md create mode 100644 Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md create mode 100644 Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md create mode 100644 Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md create mode 100644 Documentation/Help/P_CapyKit_CapyEventArgs_Level.md create mode 100644 Documentation/Help/P_CapyKit_CapyEventArgs_Message.md create mode 100644 Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md create mode 100644 Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md create mode 100644 Documentation/Help/P_CapyKit_Password_Algorithm.md create mode 100644 Documentation/Help/P_CapyKit_Password_Hash.md create mode 100644 Documentation/Help/P_CapyKit_Password_Salt.md create mode 100644 Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md create mode 100644 Documentation/Help/P_CapyKit_PoolItem_1_Index.md create mode 100644 Documentation/Help/P_CapyKit_PoolItem_1_Item.md create mode 100644 Documentation/Help/P_CapyKit_PoolItem_1_Locked.md create mode 100644 Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md create mode 100644 Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md create mode 100644 Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md create mode 100644 Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md create mode 100644 Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md create mode 100644 Documentation/Help/Properties_T_CapyKit_Password.md create mode 100644 Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md create mode 100644 Documentation/Help/Properties_T_CapyKit_PoolItem_1.md create mode 100644 Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md create mode 100644 Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md create mode 100644 Documentation/Help/T_CapyKit_CapyEventArgs.md create mode 100644 Documentation/Help/T_CapyKit_CapyEventHandler.md create mode 100644 Documentation/Help/T_CapyKit_CapyEventReporter.md create mode 100644 Documentation/Help/T_CapyKit_Color.md create mode 100644 Documentation/Help/T_CapyKit_EventLevel.md create mode 100644 Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md create mode 100644 Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md create mode 100644 Documentation/Help/T_CapyKit_Extensions_StringExtensions.md create mode 100644 Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md create mode 100644 Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md create mode 100644 Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md create mode 100644 Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md create mode 100644 Documentation/Help/T_CapyKit_IPasswordAlgorithm.md create mode 100644 Documentation/Help/T_CapyKit_Password.md create mode 100644 Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md create mode 100644 Documentation/Help/T_CapyKit_PoolItem_1.md create mode 100644 Documentation/Help/T_CapyKit_Pool_1.md create mode 100644 Documentation/Help/T_CapyKit_PropertyComparer_2.md create mode 100644 Documentation/Help/_Footer.md create mode 100644 Documentation/Help/_Sidebar.md create mode 100644 Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md create mode 100644 Documentation/Help/icons/Help.png create mode 100644 Documentation/Help/media/AlertCaution.png create mode 100644 Documentation/Help/media/AlertLanguage.png create mode 100644 Documentation/Help/media/AlertNote.png create mode 100644 Documentation/Help/media/AlertSecurity.png create mode 100644 Documentation/Help/media/AlertToDo.png create mode 100644 Documentation/icons/Help.png diff --git a/CapyKit/CapyKit.csproj b/CapyKit/CapyKit.csproj index fa71b7a..5e7c51b 100644 --- a/CapyKit/CapyKit.csproj +++ b/CapyKit/CapyKit.csproj @@ -4,6 +4,7 @@ net8.0 enable enable + True diff --git a/CapyKit/CapyKit.sln b/CapyKit/CapyKit.sln index 486de70..a9c487d 100644 --- a/CapyKit/CapyKit.sln +++ b/CapyKit/CapyKit.sln @@ -3,13 +3,15 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.8.34408.163 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CapyKit", "CapyKit.csproj", "{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}" +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "CapyKit", "CapyKit.csproj", "{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{BE8D96CA-FC33-4F28-AF49-0E4AEC6D3FD9}" ProjectSection(SolutionItems) = preProject .editorconfig = .editorconfig EndProjectSection EndProject +Project("{7CF6DF6D-3B04-46F8-A40B-537D21BCA0B4}") = "Documentation", "..\Documentation\Documentation.shfbproj", "{E23D3844-E594-487E-979B-2D35B1B9AAE8}" +EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU @@ -20,6 +22,10 @@ Global {D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Debug|Any CPU.Build.0 = Debug|Any CPU {D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Release|Any CPU.ActiveCfg = Release|Any CPU {D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Release|Any CPU.Build.0 = Release|Any CPU + {E23D3844-E594-487E-979B-2D35B1B9AAE8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {E23D3844-E594-487E-979B-2D35B1B9AAE8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {E23D3844-E594-487E-979B-2D35B1B9AAE8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {E23D3844-E594-487E-979B-2D35B1B9AAE8}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE diff --git a/CapyKit/Color.cs b/CapyKit/Color.cs new file mode 100644 index 0000000..2761e41 --- /dev/null +++ b/CapyKit/Color.cs @@ -0,0 +1,1916 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace CapyKit +{ + /// + /// Enum representing a set of named colors with their corresponding HEX values. These colors are + /// inspired by the XKCD color palette (Link). + /// + public enum Color + { + /// A color described as Cloudy Blue with a HEX value of #ACC2D9. + CloudyBlue = 0xACC2D9, + /// A color described as Dark Pastel Green with a HEX value of #56AE57. + DarkPastelGreen = 0x56AE57, + /// A color described as Dust with a HEX value of #B2996E. + Dust = 0xB2996E, + /// A color described as Electric Lime with a HEX value of #A8FF04. + ElectricLime = 0xA8FF04, + /// A color described as Fresh Green with a HEX value of #69D84F. + FreshGreen = 0x69D84F, + /// A color described as Light Eggplant with a HEX value of #894585. + LightEggplant = 0x894585, + /// A color described as Nasty Green with a HEX value of #70B23F. + NastyGreen = 0x70B23F, + /// A color described as Really Light Blue with a HEX value of #D4FFFF. + ReallyLightBlue = 0xD4FFFF, + /// A color described as Tea with a HEX value of #65AB7C. + Tea = 0x65AB7C, + /// A color described as Warm Purple with a HEX value of #952E8F. + WarmPurple = 0x952E8F, + /// A color described as Yellowish Tan with a HEX value of #FCFC81. + YellowishTan = 0xFCFC81, + /// A color described as Cement with a HEX value of #A5A391. + Cement = 0xA5A391, + /// A color described as Dark Grass Green with a HEX value of #388004. + DarkGrassGreen = 0x388004, + /// A color described as Dusty Teal with a HEX value of #4C9085. + DustyTeal = 0x4C9085, + /// A color described as Grey Teal with a HEX value of #5E9B8A. + GreyTeal = 0x5E9B8A, + /// A color described as Macaroni And Cheese with a HEX value of #EFB435. + MacaroniAndCheese = 0xEFB435, + /// A color described as Pinkish Tan with a HEX value of #D99B82. + PinkishTan = 0xD99B82, + /// A color described as Spruce with a HEX value of #0A5F38. + Spruce = 0x0A5F38, + /// A color described as Strong Blue with a HEX value of #0C06F7. + StrongBlue = 0x0C06F7, + /// A color described as Toxic Green with a HEX value of #61DE2A. + ToxicGreen = 0x61DE2A, + /// A color described as Windows Blue with a HEX value of #3778BF. + WindowsBlue = 0x3778BF, + /// A color described as Blue Blue with a HEX value of #2242C7. + BlueBlue = 0x2242C7, + /// A color described as Blue With A Hint Of Purple with a HEX value of #533CC6. + BlueWithAHintOfPurple = 0x533CC6, + /// A color described as Booger with a HEX value of #9BB53C. + Booger = 0x9BB53C, + /// A color described as Bright Sea Green with a HEX value of #05FFA6. + BrightSeaGreen = 0x05FFA6, + /// A color described as Dark Green Blue with a HEX value of #1F6357. + DarkGreenBlue = 0x1F6357, + /// A color described as Deep Turquoise with a HEX value of #017374. + DeepTurquoise = 0x017374, + /// A color described as Green Teal with a HEX value of #0CB577. + GreenTeal = 0x0CB577, + /// A color described as Strong Pink with a HEX value of #FF0789. + StrongPink = 0xFF0789, + /// A color described as Bland with a HEX value of #AFA88B. + Bland = 0xAFA88B, + /// A color described as Deep Aqua with a HEX value of #08787F. + DeepAqua = 0x08787F, + /// A color described as Lavender Pink with a HEX value of #DD85D7. + LavenderPink = 0xDD85D7, + /// A color described as Light Moss Green with a HEX value of #A6C875. + LightMossGreen = 0xA6C875, + /// A color described as Light Seafoam Green with a HEX value of #A7FFB5. + LightSeafoamGreen = 0xA7FFB5, + /// A color described as Olive Yellow with a HEX value of #C2B709. + OliveYellow = 0xC2B709, + /// A color described as Pig Pink with a HEX value of #E78EA5. + PigPink = 0xE78EA5, + /// A color described as Deep Lilac with a HEX value of #966EBD. + DeepLilac = 0x966EBD, + /// A color described as Desert with a HEX value of #CCAD60. + Desert = 0xCCAD60, + /// A color described as Dusty Lavender with a HEX value of #AC86A8. + DustyLavender = 0xAC86A8, + /// A color described as Purpley Grey with a HEX value of #947E94. + PurpleyGrey = 0x947E94, + /// A color described as Purply with a HEX value of #983FB2. + Purply = 0x983FB2, + /// A color described as Candy Pink with a HEX value of #FF63E9. + CandyPink = 0xFF63E9, + /// A color described as Light Pastel Green with a HEX value of #B2FBA5. + LightPastelGreen = 0xB2FBA5, + /// A color described as Boring Green with a HEX value of #63B365. + BoringGreen = 0x63B365, + /// A color described as Kiwi Green with a HEX value of #8EE53F. + KiwiGreen = 0x8EE53F, + /// A color described as Light Grey Green with a HEX value of #B7E1A1. + LightGreyGreen = 0xB7E1A1, + /// A color described as Orange Pink with a HEX value of #FF6F52. + OrangePink = 0xFF6F52, + /// A color described as Tea Green with a HEX value of #BDF8A3. + TeaGreen = 0xBDF8A3, + /// A color described as Very Light Brown with a HEX value of #D3B683. + VeryLightBrown = 0xD3B683, + /// A color described as Egg Shell with a HEX value of #FFFCC4. + EggShell = 0xFFFCC4, + /// A color described as Eggplant Purple with a HEX value of #430541. + EggplantPurple = 0x430541, + /// A color described as Powder Pink with a HEX value of #FFB2D0. + PowderPink = 0xFFB2D0, + /// A color described as Reddish Grey with a HEX value of #997570. + ReddishGrey = 0x997570, + /// A color described as Baby Shit Brown with a HEX value of #AD900D. + BabyShitBrown = 0xAD900D, + /// A color described as Liliac with a HEX value of #C48EFD. + Liliac = 0xC48EFD, + /// A color described as Stormy Blue with a HEX value of #507B9C. + StormyBlue = 0x507B9C, + /// A color described as Ugly Brown with a HEX value of #7D7103. + UglyBrown = 0x7D7103, + /// A color described as Custard with a HEX value of #FFFD78. + Custard = 0xFFFD78, + /// A color described as Darkish Pink with a HEX value of #DA467D. + DarkishPink = 0xDA467D, + /// A color described as Deep Brown with a HEX value of #410200. + DeepBrown = 0x410200, + /// A color described as Greenish Beige with a HEX value of #C9D179. + GreenishBeige = 0xC9D179, + /// A color described as Manilla with a HEX value of #FFFA86. + Manilla = 0xFFFA86, + /// A color described as Off Blue with a HEX value of #5684AE. + OffBlue = 0x5684AE, + /// A color described as Battleship Grey with a HEX value of #6B7C85. + BattleshipGrey = 0x6B7C85, + /// A color described as Browny Green with a HEX value of #6F6C0A. + BrownyGreen = 0x6F6C0A, + /// A color described as Bruise with a HEX value of #7E4071. + Bruise = 0x7E4071, + /// A color described as Kelley Green with a HEX value of #009337. + KelleyGreen = 0x009337, + /// A color described as Sickly Yellow with a HEX value of #D0E429. + SicklyYellow = 0xD0E429, + /// A color described as Sunny Yellow with a HEX value of #FFF917. + SunnyYellow = 0xFFF917, + /// A color described as Azul with a HEX value of #1D5DEC. + Azul = 0x1D5DEC, + /// A color described as Darkgreen with a HEX value of #054907. + Darkgreen = 0x054907, + /// A color described as Green/Yellow with a HEX value of #B5CE08. + GreenYellow = 0xB5CE08, + /// A color described as Lichen with a HEX value of #8FB67B. + Lichen = 0x8FB67B, + /// A color described as Light Light Green with a HEX value of #C8FFB0. + LightLightGreen = 0xC8FFB0, + /// A color described as Pale Gold with a HEX value of #FDDE6C. + PaleGold = 0xFDDE6C, + /// A color described as Sun Yellow with a HEX value of #FFDF22. + SunYellow = 0xFFDF22, + /// A color described as Tan Green with a HEX value of #A9BE70. + TanGreen = 0xA9BE70, + /// A color described as Burple with a HEX value of #6832E3. + Burple = 0x6832E3, + /// A color described as Butterscotch with a HEX value of #FDB147. + Butterscotch = 0xFDB147, + /// A color described as Toupe with a HEX value of #C7AC7D. + Toupe = 0xC7AC7D, + /// A color described as Dark Cream with a HEX value of #FFF39A. + DarkCream = 0xFFF39A, + /// A color described as Indian Red with a HEX value of #850E04. + IndianRed = 0x850E04, + /// A color described as Light Lavendar with a HEX value of #EFC0FE. + LightLavendar = 0xEFC0FE, + /// A color described as Poison Green with a HEX value of #40FD14. + PoisonGreen = 0x40FD14, + /// A color described as Baby Puke Green with a HEX value of #B6C406. + BabyPukeGreen = 0xB6C406, + /// A color described as Bright Yellow Green with a HEX value of #9DFF00. + BrightYellowGreen = 0x9DFF00, + /// A color described as Charcoal Grey with a HEX value of #3C4142. + CharcoalGrey = 0x3C4142, + /// A color described as Squash with a HEX value of #F2AB15. + Squash = 0xF2AB15, + /// A color described as Cinnamon with a HEX value of #AC4F06. + Cinnamon = 0xAC4F06, + /// A color described as Light Pea Green with a HEX value of #C4FE82. + LightPeaGreen = 0xC4FE82, + /// A color described as Radioactive Green with a HEX value of #2CFA1F. + RadioactiveGreen = 0x2CFA1F, + /// A color described as Raw Sienna with a HEX value of #9A6200. + RawSienna = 0x9A6200, + /// A color described as Baby Purple with a HEX value of #CA9BF7. + BabyPurple = 0xCA9BF7, + /// A color described as Cocoa with a HEX value of #875F42. + Cocoa = 0x875F42, + /// A color described as Light Royal Blue with a HEX value of #3A2EFE. + LightRoyalBlue = 0x3A2EFE, + /// A color described as Orangeish with a HEX value of #FD8D49. + Orangeish = 0xFD8D49, + /// A color described as Rust Brown with a HEX value of #8B3103. + RustBrown = 0x8B3103, + /// A color described as Sand Brown with a HEX value of #CBA560. + SandBrown = 0xCBA560, + /// A color described as Swamp with a HEX value of #698339. + Swamp = 0x698339, + /// A color described as Tealish Green with a HEX value of #0CDC73. + TealishGreen = 0x0CDC73, + /// A color described as Burnt Siena with a HEX value of #B75203. + BurntSiena = 0xB75203, + /// A color described as Camo with a HEX value of #7F8F4E. + Camo = 0x7F8F4E, + /// A color described as Dusk Blue with a HEX value of #26538D. + DuskBlue = 0x26538D, + /// A color described as Fern with a HEX value of #63A950. + Fern = 0x63A950, + /// A color described as Old Rose with a HEX value of #C87F89. + OldRose = 0xC87F89, + /// A color described as Pale Light Green with a HEX value of #B1FC99. + PaleLightGreen = 0xB1FC99, + /// A color described as Peachy Pink with a HEX value of #FF9A8A. + PeachyPink = 0xFF9A8A, + /// A color described as Rosy Pink with a HEX value of #F6688E. + RosyPink = 0xF6688E, + /// A color described as Light Bluish Green with a HEX value of #76FDA8. + LightBluishGreen = 0x76FDA8, + /// A color described as Light Bright Green with a HEX value of #53FE5C. + LightBrightGreen = 0x53FE5C, + /// A color described as Light Neon Green with a HEX value of #4EFD54. + LightNeonGreen = 0x4EFD54, + /// A color described as Light Seafoam with a HEX value of #A0FEBF. + LightSeafoam = 0xA0FEBF, + /// A color described as Tiffany Blue with a HEX value of #7BF2DA. + TiffanyBlue = 0x7BF2DA, + /// A color described as Washed Out Green with a HEX value of #BCF5A6. + WashedOutGreen = 0xBCF5A6, + /// A color described as Browny Orange with a HEX value of #CA6B02. + BrownyOrange = 0xCA6B02, + /// A color described as Nice Blue with a HEX value of #107AB0. + NiceBlue = 0x107AB0, + /// A color described as Sapphire with a HEX value of #2138AB. + Sapphire = 0x2138AB, + /// A color described as Greyish Teal with a HEX value of #719F91. + GreyishTeal = 0x719F91, + /// A color described as Orangey Yellow with a HEX value of #FDB915. + OrangeyYellow = 0xFDB915, + /// A color described as Parchment with a HEX value of #FEFCAF. + Parchment = 0xFEFCAF, + /// A color described as Straw with a HEX value of #FCF679. + Straw = 0xFCF679, + /// A color described as Very Dark Brown with a HEX value of #1D0200. + VeryDarkBrown = 0x1D0200, + /// A color described as Terracota with a HEX value of #CB6843. + Terracota = 0xCB6843, + /// A color described as Ugly Blue with a HEX value of #31668A. + UglyBlue = 0x31668A, + /// A color described as Clear Blue with a HEX value of #247AFD. + ClearBlue = 0x247AFD, + /// A color described as Creme with a HEX value of #FFFFB6. + Creme = 0xFFFFB6, + /// A color described as Foam Green with a HEX value of #90FDA9. + FoamGreen = 0x90FDA9, + /// A color described as Grey/Green with a HEX value of #86A17D. + GreyGreen = 0x86A17D, + /// A color described as Light Gold with a HEX value of #FDDC5C. + LightGold = 0xFDDC5C, + /// A color described as Seafoam Blue with a HEX value of #78D1B6. + SeafoamBlue = 0x78D1B6, + /// A color described as Topaz with a HEX value of #13BBAF. + Topaz = 0x13BBAF, + /// A color described as Violet Pink with a HEX value of #FB5FFC. + VioletPink = 0xFB5FFC, + /// A color described as Wintergreen with a HEX value of #20F986. + Wintergreen = 0x20F986, + /// A color described as Yellow Tan with a HEX value of #FFE36E. + YellowTan = 0xFFE36E, + /// A color described as Dark Fuchsia with a HEX value of #9D0759. + DarkFuchsia = 0x9D0759, + /// A color described as Indigo Blue with a HEX value of #3A18B1. + IndigoBlue = 0x3A18B1, + /// A color described as Light Yellowish Green with a HEX value of #C2FF89. + LightYellowishGreen = 0xC2FF89, + /// A color described as Pale Magenta with a HEX value of #D767AD. + PaleMagenta = 0xD767AD, + /// A color described as Rich Purple with a HEX value of #720058. + RichPurple = 0x720058, + /// A color described as Sunflower Yellow with a HEX value of #FFDA03. + SunflowerYellow = 0xFFDA03, + /// A color described as Green/Blue with a HEX value of #01C08D. + GreenBlue = 0x01C08D, + /// A color described as Leather with a HEX value of #AC7434. + Leather = 0xAC7434, + /// A color described as Racing Green with a HEX value of #014600. + RacingGreen = 0x014600, + /// A color described as Vivid Purple with a HEX value of #9900FA. + VividPurple = 0x9900FA, + /// A color described as Dark Royal Blue with a HEX value of #02066F. + DarkRoyalBlue = 0x02066F, + /// A color described as Hazel with a HEX value of #8E7618. + Hazel = 0x8E7618, + /// A color described as Muted Pink with a HEX value of #D1768F. + MutedPink = 0xD1768F, + /// A color described as Booger Green with a HEX value of #96B403. + BoogerGreen = 0x96B403, + /// A color described as Canary with a HEX value of #FDFF63. + Canary = 0xFDFF63, + /// A color described as Cool Grey with a HEX value of #95A3A6. + CoolGrey = 0x95A3A6, + /// A color described as Dark Taupe with a HEX value of #7F684E. + DarkTaupe = 0x7F684E, + /// A color described as Darkish Purple with a HEX value of #751973. + DarkishPurple = 0x751973, + /// A color described as True Green with a HEX value of #089404. + TrueGreen = 0x089404, + /// A color described as Coral Pink with a HEX value of #FF6163. + CoralPink = 0xFF6163, + /// A color described as Dark Sage with a HEX value of #598556. + DarkSage = 0x598556, + /// A color described as Dark Slate Blue with a HEX value of #214761. + DarkSlateBlue = 0x214761, + /// A color described as Flat Blue with a HEX value of #3C73A8. + FlatBlue = 0x3C73A8, + /// A color described as Mushroom with a HEX value of #BA9E88. + Mushroom = 0xBA9E88, + /// A color described as Rich Blue with a HEX value of #021BF9. + RichBlue = 0x021BF9, + /// A color described as Dirty Purple with a HEX value of #734A65. + DirtyPurple = 0x734A65, + /// A color described as Greenblue with a HEX value of #23C48B. + Greenblue = 0x23C48B, + /// A color described as Icky Green with a HEX value of #8FAE22. + IckyGreen = 0x8FAE22, + /// A color described as Light Khaki with a HEX value of #E6F2A2. + LightKhaki = 0xE6F2A2, + /// A color described as Warm Blue with a HEX value of #4B57DB. + WarmBlue = 0x4B57DB, + /// A color described as Dark Hot Pink with a HEX value of #D90166. + DarkHotPink = 0xD90166, + /// A color described as Deep Sea Blue with a HEX value of #015482. + DeepSeaBlue = 0x015482, + /// A color described as Carmine with a HEX value of #9D0216. + Carmine = 0x9D0216, + /// A color described as Dark Yellow Green with a HEX value of #728F02. + DarkYellowGreen = 0x728F02, + /// A color described as Pale Peach with a HEX value of #FFE5AD. + PalePeach = 0xFFE5AD, + /// A color described as Plum Purple with a HEX value of #4E0550. + PlumPurple = 0x4E0550, + /// A color described as Golden Rod with a HEX value of #F9BC08. + GoldenRod = 0xF9BC08, + /// A color described as Neon Red with a HEX value of #FF073A. + NeonRed = 0xFF073A, + /// A color described as Old Pink with a HEX value of #C77986. + OldPink = 0xC77986, + /// A color described as Very Pale Blue with a HEX value of #D6FFFE. + VeryPaleBlue = 0xD6FFFE, + /// A color described as Blood Orange with a HEX value of #FE4B03. + BloodOrange = 0xFE4B03, + /// A color described as Grapefruit with a HEX value of #FD5956. + Grapefruit = 0xFD5956, + /// A color described as Sand Yellow with a HEX value of #FCE166. + SandYellow = 0xFCE166, + /// A color described as Clay Brown with a HEX value of #B2713D. + ClayBrown = 0xB2713D, + /// A color described as Dark Blue Grey with a HEX value of #1F3B4D. + DarkBlueGrey = 0x1F3B4D, + /// A color described as Flat Green with a HEX value of #699D4C. + FlatGreen = 0x699D4C, + /// A color described as Light Green Blue with a HEX value of #56FCA2. + LightGreenBlue = 0x56FCA2, + /// A color described as Warm Pink with a HEX value of #FB5581. + WarmPink = 0xFB5581, + /// A color described as Dodger Blue with a HEX value of #3E82FC. + DodgerBlue = 0x3E82FC, + /// A color described as Gross Green with a HEX value of #A0BF16. + GrossGreen = 0xA0BF16, + /// A color described as Ice with a HEX value of #D6FFFA. + Ice = 0xD6FFFA, + /// A color described as Metallic Blue with a HEX value of #4F738E. + MetallicBlue = 0x4F738E, + /// A color described as Pale Salmon with a HEX value of #FFB19A. + PaleSalmon = 0xFFB19A, + /// A color described as Sap Green with a HEX value of #5C8B15. + SapGreen = 0x5C8B15, + /// A color described as Algae with a HEX value of #54AC68. + Algae = 0x54AC68, + /// A color described as Bluey Grey with a HEX value of #89A0B0. + BlueyGrey = 0x89A0B0, + /// A color described as Greeny Grey with a HEX value of #7EA07A. + GreenyGrey = 0x7EA07A, + /// A color described as Highlighter Green with a HEX value of #1BFC06. + HighlighterGreen = 0x1BFC06, + /// A color described as Light Light Blue with a HEX value of #CAFFFB. + LightLightBlue = 0xCAFFFB, + /// A color described as Light Mint with a HEX value of #B6FFBB. + LightMint = 0xB6FFBB, + /// A color described as Raw Umber with a HEX value of #A75E09. + RawUmber = 0xA75E09, + /// A color described as Vivid Blue with a HEX value of #152EFF. + VividBlue = 0x152EFF, + /// A color described as Deep Lavender with a HEX value of #8D5EB7. + DeepLavender = 0x8D5EB7, + /// A color described as Dull Teal with a HEX value of #5F9E8F. + DullTeal = 0x5F9E8F, + /// A color described as Light Greenish Blue with a HEX value of #63F7B4. + LightGreenishBlue = 0x63F7B4, + /// A color described as Mud Green with a HEX value of #606602. + MudGreen = 0x606602, + /// A color described as Pinky with a HEX value of #FC86AA. + Pinky = 0xFC86AA, + /// A color described as Red Wine with a HEX value of #8C0034. + RedWine = 0x8C0034, + /// A color described as Shit Green with a HEX value of #758000. + ShitGreen = 0x758000, + /// A color described as Tan Brown with a HEX value of #AB7E4C. + TanBrown = 0xAB7E4C, + /// A color described as Darkblue with a HEX value of #030764. + Darkblue = 0x030764, + /// A color described as Rosa with a HEX value of #FE86A4. + Rosa = 0xFE86A4, + /// A color described as Lipstick with a HEX value of #D5174E. + Lipstick = 0xD5174E, + /// A color described as Pale Mauve with a HEX value of #FED0FC. + PaleMauve = 0xFED0FC, + /// A color described as Claret with a HEX value of #680018. + Claret = 0x680018, + /// A color described as Dandelion with a HEX value of #FEDF08. + Dandelion = 0xFEDF08, + /// A color described as Orangered with a HEX value of #FE420F. + Orangered = 0xFE420F, + /// A color described as Poop Green with a HEX value of #6F7C00. + PoopGreen = 0x6F7C00, + /// A color described as Ruby with a HEX value of #CA0147. + Ruby = 0xCA0147, + /// A color described as Dark with a HEX value of #1B2431. + Dark = 0x1B2431, + /// A color described as Greenish Turquoise with a HEX value of #00FBB0. + GreenishTurquoise = 0x00FBB0, + /// A color described as Pastel Red with a HEX value of #DB5856. + PastelRed = 0xDB5856, + /// A color described as Piss Yellow with a HEX value of #DDD618. + PissYellow = 0xDDD618, + /// A color described as Bright Cyan with a HEX value of #41FDFE. + BrightCyan = 0x41FDFE, + /// A color described as Dark Coral with a HEX value of #CF524E. + DarkCoral = 0xCF524E, + /// A color described as Algae Green with a HEX value of #21C36F. + AlgaeGreen = 0x21C36F, + /// A color described as Darkish Red with a HEX value of #A90308. + DarkishRed = 0xA90308, + /// A color described as Reddy Brown with a HEX value of #6E1005. + ReddyBrown = 0x6E1005, + /// A color described as Blush Pink with a HEX value of #FE828C. + BlushPink = 0xFE828C, + /// A color described as Camouflage Green with a HEX value of #4B6113. + CamouflageGreen = 0x4B6113, + /// A color described as Lawn Green with a HEX value of #4DA409. + LawnGreen = 0x4DA409, + /// A color described as Putty with a HEX value of #BEAE8A. + Putty = 0xBEAE8A, + /// A color described as Vibrant Blue with a HEX value of #0339F8. + VibrantBlue = 0x0339F8, + /// A color described as Dark Sand with a HEX value of #A88F59. + DarkSand = 0xA88F59, + /// A color described as Purple/Blue with a HEX value of #5D21D0. + PurpleBlue = 0x5D21D0, + /// A color described as Saffron with a HEX value of #FEB209. + Saffron = 0xFEB209, + /// A color described as Twilight with a HEX value of #4E518B. + Twilight = 0x4E518B, + /// A color described as Warm Brown with a HEX value of #964E02. + WarmBrown = 0x964E02, + /// A color described as Bluegrey with a HEX value of #85A3B2. + Bluegrey = 0x85A3B2, + /// A color described as Bubble Gum Pink with a HEX value of #FF69AF. + BubbleGumPink = 0xFF69AF, + /// A color described as Duck Egg Blue with a HEX value of #C3FBF4. + DuckEggBlue = 0xC3FBF4, + /// A color described as Greenish Cyan with a HEX value of #2AFEB7. + GreenishCyan = 0x2AFEB7, + /// A color described as Petrol with a HEX value of #005F6A. + Petrol = 0x005F6A, + /// A color described as Royal with a HEX value of #0C1793. + Royal = 0x0C1793, + /// A color described as Butter with a HEX value of #FFFF81. + Butter = 0xFFFF81, + /// A color described as Dusty Orange with a HEX value of #F0833A. + DustyOrange = 0xF0833A, + /// A color described as Off Yellow with a HEX value of #F1F33F. + OffYellow = 0xF1F33F, + /// A color described as Pale Olive Green with a HEX value of #B1D27B. + PaleOliveGreen = 0xB1D27B, + /// A color described as Orangish with a HEX value of #FC824A. + Orangish = 0xFC824A, + /// A color described as Leaf with a HEX value of #71AA34. + Leaf = 0x71AA34, + /// A color described as Light Blue Grey with a HEX value of #B7C9E2. + LightBlueGrey = 0xB7C9E2, + /// A color described as Dried Blood with a HEX value of #4B0101. + DriedBlood = 0x4B0101, + /// A color described as Lightish Purple with a HEX value of #A552E6. + LightishPurple = 0xA552E6, + /// A color described as Rusty Red with a HEX value of #AF2F0D. + RustyRed = 0xAF2F0D, + /// A color described as Lavender Blue with a HEX value of #8B88F8. + LavenderBlue = 0x8B88F8, + /// A color described as Light Grass Green with a HEX value of #9AF764. + LightGrassGreen = 0x9AF764, + /// A color described as Light Mint Green with a HEX value of #A6FBB2. + LightMintGreen = 0xA6FBB2, + /// A color described as Sunflower with a HEX value of #FFC512. + Sunflower = 0xFFC512, + /// A color described as Velvet with a HEX value of #750851. + Velvet = 0x750851, + /// A color described as Brick Orange with a HEX value of #C14A09. + BrickOrange = 0xC14A09, + /// A color described as Lightish Red with a HEX value of #FE2F4A. + LightishRed = 0xFE2F4A, + /// A color described as Pure Blue with a HEX value of #0203E2. + PureBlue = 0x0203E2, + /// A color described as Twilight Blue with a HEX value of #0A437A. + TwilightBlue = 0x0A437A, + /// A color described as Violet Red with a HEX value of #A50055. + VioletRed = 0xA50055, + /// A color described as Yellowy Brown with a HEX value of #AE8B0C. + YellowyBrown = 0xAE8B0C, + /// A color described as Carnation with a HEX value of #FD798F. + Carnation = 0xFD798F, + /// A color described as Muddy Yellow with a HEX value of #BFAC05. + MuddyYellow = 0xBFAC05, + /// A color described as Dark Seafoam Green with a HEX value of #3EAF76. + DarkSeafoamGreen = 0x3EAF76, + /// A color described as Deep Rose with a HEX value of #C74767. + DeepRose = 0xC74767, + /// A color described as Dusty Red with a HEX value of #B9484E. + DustyRed = 0xB9484E, + /// A color described as Grey/Blue with a HEX value of #647D8E. + GreyBlue = 0x647D8E, + /// A color described as Lemon Lime with a HEX value of #BFFE28. + LemonLime = 0xBFFE28, + /// A color described as Purple/Pink with a HEX value of #D725DE. + PurplePink = 0xD725DE, + /// A color described as Brown Yellow with a HEX value of #B29705. + BrownYellow = 0xB29705, + /// A color described as Purple Brown with a HEX value of #673A3F. + PurpleBrown = 0x673A3F, + /// A color described as Wisteria with a HEX value of #A87DC2. + Wisteria = 0xA87DC2, + /// A color described as Banana Yellow with a HEX value of #FAFE4B. + BananaYellow = 0xFAFE4B, + /// A color described as Lipstick Red with a HEX value of #C0022F. + LipstickRed = 0xC0022F, + /// A color described as Water Blue with a HEX value of #0E87CC. + WaterBlue = 0x0E87CC, + /// A color described as Brown Grey with a HEX value of #8D8468. + BrownGrey = 0x8D8468, + /// A color described as Vibrant Purple with a HEX value of #AD03DE. + VibrantPurple = 0xAD03DE, + /// A color described as Baby Green with a HEX value of #8CFF9E. + BabyGreen = 0x8CFF9E, + /// A color described as Barf Green with a HEX value of #94AC02. + BarfGreen = 0x94AC02, + /// A color described as Eggshell Blue with a HEX value of #C4FFF7. + EggshellBlue = 0xC4FFF7, + /// A color described as Sandy Yellow with a HEX value of #FDEE73. + SandyYellow = 0xFDEE73, + /// A color described as Cool Green with a HEX value of #33B864. + CoolGreen = 0x33B864, + /// A color described as Pale with a HEX value of #FFF9D0. + Pale = 0xFFF9D0, + /// A color described as Blue/Grey with a HEX value of #758DA3. + BlueGrey = 0x758DA3, + /// A color described as Hot Magenta with a HEX value of #F504C9. + HotMagenta = 0xF504C9, + /// A color described as Greyblue with a HEX value of #77A1B5. + Greyblue = 0x77A1B5, + /// A color described as Purpley with a HEX value of #8756E4. + Purpley = 0x8756E4, + /// A color described as Baby Shit Green with a HEX value of #889717. + BabyShitGreen = 0x889717, + /// A color described as Brownish Pink with a HEX value of #C27E79. + BrownishPink = 0xC27E79, + /// A color described as Dark Aquamarine with a HEX value of #017371. + DarkAquamarine = 0x017371, + /// A color described as Diarrhea with a HEX value of #9F8303. + Diarrhea = 0x9F8303, + /// A color described as Light Mustard with a HEX value of #F7D560. + LightMustard = 0xF7D560, + /// A color described as Pale Sky Blue with a HEX value of #BDF6FE. + PaleSkyBlue = 0xBDF6FE, + /// A color described as Turtle Green with a HEX value of #75B84F. + TurtleGreen = 0x75B84F, + /// A color described as Bright Olive with a HEX value of #9CBB04. + BrightOlive = 0x9CBB04, + /// A color described as Dark Grey Blue with a HEX value of #29465B. + DarkGreyBlue = 0x29465B, + /// A color described as Greeny Brown with a HEX value of #696006. + GreenyBrown = 0x696006, + /// A color described as Lemon Green with a HEX value of #ADF802. + LemonGreen = 0xADF802, + /// A color described as Light Periwinkle with a HEX value of #C1C6FC. + LightPeriwinkle = 0xC1C6FC, + /// A color described as Seaweed Green with a HEX value of #35AD6B. + SeaweedGreen = 0x35AD6B, + /// A color described as Sunshine Yellow with a HEX value of #FFFD37. + SunshineYellow = 0xFFFD37, + /// A color described as Ugly Purple with a HEX value of #A442A0. + UglyPurple = 0xA442A0, + /// A color described as Medium Pink with a HEX value of #F36196. + MediumPink = 0xF36196, + /// A color described as Puke Brown with a HEX value of #947706. + PukeBrown = 0x947706, + /// A color described as Very Light Pink with a HEX value of #FFF4F2. + VeryLightPink = 0xFFF4F2, + /// A color described as Viridian with a HEX value of #1E9167. + Viridian = 0x1E9167, + /// A color described as Bile with a HEX value of #B5C306. + Bile = 0xB5C306, + /// A color described as Faded Yellow with a HEX value of #FEFF7F. + FadedYellow = 0xFEFF7F, + /// A color described as Very Pale Green with a HEX value of #CFFDBC. + VeryPaleGreen = 0xCFFDBC, + /// A color described as Vibrant Green with a HEX value of #0ADD08. + VibrantGreen = 0x0ADD08, + /// A color described as Bright Lime with a HEX value of #87FD05. + BrightLime = 0x87FD05, + /// A color described as Spearmint with a HEX value of #1EF876. + Spearmint = 0x1EF876, + /// A color described as Light Aquamarine with a HEX value of #7BFDC7. + LightAquamarine = 0x7BFDC7, + /// A color described as Light Sage with a HEX value of #BCECAC. + LightSage = 0xBCECAC, + /// A color described as Yellowgreen with a HEX value of #BBF90F. + Yellowgreen = 0xBBF90F, + /// A color described as Baby Poo with a HEX value of #AB9004. + BabyPoo = 0xAB9004, + /// A color described as Dark Seafoam with a HEX value of #1FB57A. + DarkSeafoam = 0x1FB57A, + /// A color described as Deep Teal with a HEX value of #00555A. + DeepTeal = 0x00555A, + /// A color described as Heather with a HEX value of #A484AC. + Heather = 0xA484AC, + /// A color described as Rust Orange with a HEX value of #C45508. + RustOrange = 0xC45508, + /// A color described as Dirty Blue with a HEX value of #3F829D. + DirtyBlue = 0x3F829D, + /// A color described as Fern Green with a HEX value of #548D44. + FernGreen = 0x548D44, + /// A color described as Bright Lilac with a HEX value of #C95EFB. + BrightLilac = 0xC95EFB, + /// A color described as Weird Green with a HEX value of #3AE57F. + WeirdGreen = 0x3AE57F, + /// A color described as Peacock Blue with a HEX value of #016795. + PeacockBlue = 0x016795, + /// A color described as Avocado Green with a HEX value of #87A922. + AvocadoGreen = 0x87A922, + /// A color described as Faded Orange with a HEX value of #F0944D. + FadedOrange = 0xF0944D, + /// A color described as Grape Purple with a HEX value of #5D1451. + GrapePurple = 0x5D1451, + /// A color described as Hot Green with a HEX value of #25FF29. + HotGreen = 0x25FF29, + /// A color described as Lime Yellow with a HEX value of #D0FE1D. + LimeYellow = 0xD0FE1D, + /// A color described as Mango with a HEX value of #FFA62B. + Mango = 0xFFA62B, + /// A color described as Shamrock with a HEX value of #01B44C. + Shamrock = 0x01B44C, + /// A color described as Bubblegum with a HEX value of #FF6CB5. + Bubblegum = 0xFF6CB5, + /// A color described as Purplish Brown with a HEX value of #6B4247. + PurplishBrown = 0x6B4247, + /// A color described as Vomit Yellow with a HEX value of #C7C10C. + VomitYellow = 0xC7C10C, + /// A color described as Pale Cyan with a HEX value of #B7FFFA. + PaleCyan = 0xB7FFFA, + /// A color described as Key Lime with a HEX value of #AEFF6E. + KeyLime = 0xAEFF6E, + /// A color described as Tomato Red with a HEX value of #EC2D01. + TomatoRed = 0xEC2D01, + /// A color described as Lightgreen with a HEX value of #76FF7B. + Lightgreen = 0x76FF7B, + /// A color described as Merlot with a HEX value of #730039. + Merlot = 0x730039, + /// A color described as Night Blue with a HEX value of #040348. + NightBlue = 0x040348, + /// A color described as Purpleish Pink with a HEX value of #DF4EC8. + PurpleishPink = 0xDF4EC8, + /// A color described as Apple with a HEX value of #6ECB3C. + Apple = 0x6ECB3C, + /// A color described as Baby Poop Green with a HEX value of #8F9805. + BabyPoopGreen = 0x8F9805, + /// A color described as Green Apple with a HEX value of #5EDC1F. + GreenApple = 0x5EDC1F, + /// A color described as Heliotrope with a HEX value of #D94FF5. + Heliotrope = 0xD94FF5, + /// A color described as Yellow/Green with a HEX value of #C8FD3D. + YellowGreen = 0xC8FD3D, + /// A color described as Almost Black with a HEX value of #070D0D. + AlmostBlack = 0x070D0D, + /// A color described as Cool Blue with a HEX value of #4984B8. + CoolBlue = 0x4984B8, + /// A color described as Leafy Green with a HEX value of #51B73B. + LeafyGreen = 0x51B73B, + /// A color described as Mustard Brown with a HEX value of #AC7E04. + MustardBrown = 0xAC7E04, + /// A color described as Dusk with a HEX value of #4E5481. + Dusk = 0x4E5481, + /// A color described as Dull Brown with a HEX value of #876E4B. + DullBrown = 0x876E4B, + /// A color described as Frog Green with a HEX value of #58BC08. + FrogGreen = 0x58BC08, + /// A color described as Vivid Green with a HEX value of #2FEF10. + VividGreen = 0x2FEF10, + /// A color described as Bright Light Green with a HEX value of #2DFE54. + BrightLightGreen = 0x2DFE54, + /// A color described as Fluro Green with a HEX value of #0AFF02. + FluroGreen = 0x0AFF02, + /// A color described as Kiwi with a HEX value of #9CEF43. + Kiwi = 0x9CEF43, + /// A color described as Seaweed with a HEX value of #18D17B. + Seaweed = 0x18D17B, + /// A color described as Navy Green with a HEX value of #35530A. + NavyGreen = 0x35530A, + /// A color described as Ultramarine Blue with a HEX value of #1805DB. + UltramarineBlue = 0x1805DB, + /// A color described as Iris with a HEX value of #6258C4. + Iris = 0x6258C4, + /// A color described as Pastel Orange with a HEX value of #FF964F. + PastelOrange = 0xFF964F, + /// A color described as Yellowish Orange with a HEX value of #FFAB0F. + YellowishOrange = 0xFFAB0F, + /// A color described as Perrywinkle with a HEX value of #8F8CE7. + Perrywinkle = 0x8F8CE7, + /// A color described as Tealish with a HEX value of #24BCA8. + Tealish = 0x24BCA8, + /// A color described as Dark Plum with a HEX value of #3F012C. + DarkPlum = 0x3F012C, + /// A color described as Pear with a HEX value of #CBF85F. + Pear = 0xCBF85F, + /// A color described as Pinkish Orange with a HEX value of #FF724C. + PinkishOrange = 0xFF724C, + /// A color described as Midnight Purple with a HEX value of #280137. + MidnightPurple = 0x280137, + /// A color described as Light Urple with a HEX value of #B36FF6. + LightUrple = 0xB36FF6, + /// A color described as Dark Mint with a HEX value of #48C072. + DarkMint = 0x48C072, + /// A color described as Greenish Tan with a HEX value of #BCCB7A. + GreenishTan = 0xBCCB7A, + /// A color described as Light Burgundy with a HEX value of #A8415B. + LightBurgundy = 0xA8415B, + /// A color described as Turquoise Blue with a HEX value of #06B1C4. + TurquoiseBlue = 0x06B1C4, + /// A color described as Ugly Pink with a HEX value of #CD7584. + UglyPink = 0xCD7584, + /// A color described as Sandy with a HEX value of #F1DA7A. + Sandy = 0xF1DA7A, + /// A color described as Electric Pink with a HEX value of #FF0490. + ElectricPink = 0xFF0490, + /// A color described as Muted Purple with a HEX value of #805B87. + MutedPurple = 0x805B87, + /// A color described as Mid Green with a HEX value of #50A747. + MidGreen = 0x50A747, + /// A color described as Greyish with a HEX value of #A8A495. + Greyish = 0xA8A495, + /// A color described as Neon Yellow with a HEX value of #CFFF04. + NeonYellow = 0xCFFF04, + /// A color described as Banana with a HEX value of #FFFF7E. + Banana = 0xFFFF7E, + /// A color described as Carnation Pink with a HEX value of #FF7FA7. + CarnationPink = 0xFF7FA7, + /// A color described as Tomato with a HEX value of #EF4026. + Tomato = 0xEF4026, + /// A color described as Sea with a HEX value of #3C9992. + Sea = 0x3C9992, + /// A color described as Muddy Brown with a HEX value of #886806. + MuddyBrown = 0x886806, + /// A color described as Turquoise Green with a HEX value of #04F489. + TurquoiseGreen = 0x04F489, + /// A color described as Buff with a HEX value of #FEF69E. + Buff = 0xFEF69E, + /// A color described as Fawn with a HEX value of #CFAF7B. + Fawn = 0xCFAF7B, + /// A color described as Muted Blue with a HEX value of #3B719F. + MutedBlue = 0x3B719F, + /// A color described as Pale Rose with a HEX value of #FDC1C5. + PaleRose = 0xFDC1C5, + /// A color described as Dark Mint Green with a HEX value of #20C073. + DarkMintGreen = 0x20C073, + /// A color described as Amethyst with a HEX value of #9B5FC0. + Amethyst = 0x9B5FC0, + /// A color described as Blue/Green with a HEX value of #0F9B8E. + BlueGreen = 0x0F9B8E, + /// A color described as Chestnut with a HEX value of #742802. + Chestnut = 0x742802, + /// A color described as Sick Green with a HEX value of #9DB92C. + SickGreen = 0x9DB92C, + /// A color described as Pea with a HEX value of #A4BF20. + Pea = 0xA4BF20, + /// A color described as Rusty Orange with a HEX value of #CD5909. + RustyOrange = 0xCD5909, + /// A color described as Stone with a HEX value of #ADA587. + Stone = 0xADA587, + /// A color described as Rose Red with a HEX value of #BE013C. + RoseRed = 0xBE013C, + /// A color described as Pale Aqua with a HEX value of #B8FFEB. + PaleAqua = 0xB8FFEB, + /// A color described as Deep Orange with a HEX value of #DC4D01. + DeepOrange = 0xDC4D01, + /// A color described as Earth with a HEX value of #A2653E. + Earth = 0xA2653E, + /// A color described as Mossy Green with a HEX value of #638B27. + MossyGreen = 0x638B27, + /// A color described as Grassy Green with a HEX value of #419C03. + GrassyGreen = 0x419C03, + /// A color described as Pale Lime Green with a HEX value of #B1FF65. + PaleLimeGreen = 0xB1FF65, + /// A color described as Light Grey Blue with a HEX value of #9DBCD4. + LightGreyBlue = 0x9DBCD4, + /// A color described as Pale Grey with a HEX value of #FDFDFE. + PaleGrey = 0xFDFDFE, + /// A color described as Asparagus with a HEX value of #77AB56. + Asparagus = 0x77AB56, + /// A color described as Blueberry with a HEX value of #464196. + Blueberry = 0x464196, + /// A color described as Purple Red with a HEX value of #990147. + PurpleRed = 0x990147, + /// A color described as Pale Lime with a HEX value of #BEFD73. + PaleLime = 0xBEFD73, + /// A color described as Greenish Teal with a HEX value of #32BF84. + GreenishTeal = 0x32BF84, + /// A color described as Caramel with a HEX value of #AF6F09. + Caramel = 0xAF6F09, + /// A color described as Deep Magenta with a HEX value of #A0025C. + DeepMagenta = 0xA0025C, + /// A color described as Light Peach with a HEX value of #FFD8B1. + LightPeach = 0xFFD8B1, + /// A color described as Milk Chocolate with a HEX value of #7F4E1E. + MilkChocolate = 0x7F4E1E, + /// A color described as Ocher with a HEX value of #BF9B0C. + Ocher = 0xBF9B0C, + /// A color described as Off Green with a HEX value of #6BA353. + OffGreen = 0x6BA353, + /// A color described as Purply Pink with a HEX value of #F075E6. + PurplyPink = 0xF075E6, + /// A color described as Lightblue with a HEX value of #7BC8F6. + Lightblue = 0x7BC8F6, + /// A color described as Dusky Blue with a HEX value of #475F94. + DuskyBlue = 0x475F94, + /// A color described as Golden with a HEX value of #F5BF03. + Golden = 0xF5BF03, + /// A color described as Light Beige with a HEX value of #FFFEB6. + LightBeige = 0xFFFEB6, + /// A color described as Butter Yellow with a HEX value of #FFFD74. + ButterYellow = 0xFFFD74, + /// A color described as Dusky Purple with a HEX value of #895B7B. + DuskyPurple = 0x895B7B, + /// A color described as French Blue with a HEX value of #436BAD. + FrenchBlue = 0x436BAD, + /// A color described as Ugly Yellow with a HEX value of #D0C101. + UglyYellow = 0xD0C101, + /// A color described as Greeny Yellow with a HEX value of #C6F808. + GreenyYellow = 0xC6F808, + /// A color described as Orangish Red with a HEX value of #F43605. + OrangishRed = 0xF43605, + /// A color described as Shamrock Green with a HEX value of #02C14D. + ShamrockGreen = 0x02C14D, + /// A color described as Orangish Brown with a HEX value of #B25F03. + OrangishBrown = 0xB25F03, + /// A color described as Tree Green with a HEX value of #2A7E19. + TreeGreen = 0x2A7E19, + /// A color described as Deep Violet with a HEX value of #490648. + DeepViolet = 0x490648, + /// A color described as Gunmetal with a HEX value of #536267. + Gunmetal = 0x536267, + /// A color described as Blue/Purple with a HEX value of #5A06EF. + BluePurple = 0x5A06EF, + /// A color described as Cherry with a HEX value of #CF0234. + Cherry = 0xCF0234, + /// A color described as Sandy Brown with a HEX value of #C4A661. + SandyBrown = 0xC4A661, + /// A color described as Warm Grey with a HEX value of #978A84. + WarmGrey = 0x978A84, + /// A color described as Dark Indigo with a HEX value of #1F0954. + DarkIndigo = 0x1F0954, + /// A color described as Midnight with a HEX value of #03012D. + Midnight = 0x03012D, + /// A color described as Bluey Green with a HEX value of #2BB179. + BlueyGreen = 0x2BB179, + /// A color described as Grey Pink with a HEX value of #C3909B. + GreyPink = 0xC3909B, + /// A color described as Soft Purple with a HEX value of #A66FB5. + SoftPurple = 0xA66FB5, + /// A color described as Blood with a HEX value of #770001. + Blood = 0x770001, + /// A color described as Brown Red with a HEX value of #922B05. + BrownRed = 0x922B05, + /// A color described as Medium Grey with a HEX value of #7D7F7C. + MediumGrey = 0x7D7F7C, + /// A color described as Berry with a HEX value of #990F4B. + Berry = 0x990F4B, + /// A color described as Poo with a HEX value of #8F7303. + Poo = 0x8F7303, + /// A color described as Purpley Pink with a HEX value of #C83CB9. + PurpleyPink = 0xC83CB9, + /// A color described as Light Salmon with a HEX value of #FEA993. + LightSalmon = 0xFEA993, + /// A color described as Snot with a HEX value of #ACBB0D. + Snot = 0xACBB0D, + /// A color described as Easter Purple with a HEX value of #C071FE. + EasterPurple = 0xC071FE, + /// A color described as Light Yellow Green with a HEX value of #CCFD7F. + LightYellowGreen = 0xCCFD7F, + /// A color described as Dark Navy Blue with a HEX value of #00022E. + DarkNavyBlue = 0x00022E, + /// A color described as Drab with a HEX value of #828344. + Drab = 0x828344, + /// A color described as Light Rose with a HEX value of #FFC5CB. + LightRose = 0xFFC5CB, + /// A color described as Rouge with a HEX value of #AB1239. + Rouge = 0xAB1239, + /// A color described as Purplish Red with a HEX value of #B0054B. + PurplishRed = 0xB0054B, + /// A color described as Slime Green with a HEX value of #99CC04. + SlimeGreen = 0x99CC04, + /// A color described as Baby Poop with a HEX value of #937C00. + BabyPoop = 0x937C00, + /// A color described as Irish Green with a HEX value of #019529. + IrishGreen = 0x019529, + /// A color described as Pink/Purple with a HEX value of #EF1DE7. + PinkPurple = 0xEF1DE7, + /// A color described as Dark Navy with a HEX value of #000435. + DarkNavy = 0x000435, + /// A color described as Greeny Blue with a HEX value of #42B395. + GreenyBlue = 0x42B395, + /// A color described as Light Plum with a HEX value of #9D5783. + LightPlum = 0x9D5783, + /// A color described as Pinkish Grey with a HEX value of #C8ACA9. + PinkishGrey = 0xC8ACA9, + /// A color described as Dirty Orange with a HEX value of #C87606. + DirtyOrange = 0xC87606, + /// A color described as Rust Red with a HEX value of #AA2704. + RustRed = 0xAA2704, + /// A color described as Pale Lilac with a HEX value of #E4CBFF. + PaleLilac = 0xE4CBFF, + /// A color described as Orangey Red with a HEX value of #FA4224. + OrangeyRed = 0xFA4224, + /// A color described as Primary Blue with a HEX value of #0804F9. + PrimaryBlue = 0x0804F9, + /// A color described as Kermit Green with a HEX value of #5CB200. + KermitGreen = 0x5CB200, + /// A color described as Brownish Purple with a HEX value of #76424E. + BrownishPurple = 0x76424E, + /// A color described as Murky Green with a HEX value of #6C7A0E. + MurkyGreen = 0x6C7A0E, + /// A color described as Wheat with a HEX value of #FBDD7E. + Wheat = 0xFBDD7E, + /// A color described as Very Dark Purple with a HEX value of #2A0134. + VeryDarkPurple = 0x2A0134, + /// A color described as Bottle Green with a HEX value of #044A05. + BottleGreen = 0x044A05, + /// A color described as Watermelon with a HEX value of #FD4659. + Watermelon = 0xFD4659, + /// A color described as Deep Sky Blue with a HEX value of #0D75F8. + DeepSkyBlue = 0x0D75F8, + /// A color described as Fire Engine Red with a HEX value of #FE0002. + FireEngineRed = 0xFE0002, + /// A color described as Yellow Ochre with a HEX value of #CB9D06. + YellowOchre = 0xCB9D06, + /// A color described as Pumpkin Orange with a HEX value of #FB7D07. + PumpkinOrange = 0xFB7D07, + /// A color described as Pale Olive with a HEX value of #B9CC81. + PaleOlive = 0xB9CC81, + /// A color described as Light Lilac with a HEX value of #EDC8FF. + LightLilac = 0xEDC8FF, + /// A color described as Lightish Green with a HEX value of #61E160. + LightishGreen = 0x61E160, + /// A color described as Carolina Blue with a HEX value of #8AB8FE. + CarolinaBlue = 0x8AB8FE, + /// A color described as Mulberry with a HEX value of #920A4E. + Mulberry = 0x920A4E, + /// A color described as Shocking Pink with a HEX value of #FE02A2. + ShockingPink = 0xFE02A2, + /// A color described as Auburn with a HEX value of #9A3001. + Auburn = 0x9A3001, + /// A color described as Bright Lime Green with a HEX value of #65FE08. + BrightLimeGreen = 0x65FE08, + /// A color described as Celadon with a HEX value of #BEFDB7. + Celadon = 0xBEFDB7, + /// A color described as Pinkish Brown with a HEX value of #B17261. + PinkishBrown = 0xB17261, + /// A color described as Poo Brown with a HEX value of #885F01. + PooBrown = 0x885F01, + /// A color described as Bright Sky Blue with a HEX value of #02CCFE. + BrightSkyBlue = 0x02CCFE, + /// A color described as Celery with a HEX value of #C1FD95. + Celery = 0xC1FD95, + /// A color described as Dirt Brown with a HEX value of #836539. + DirtBrown = 0x836539, + /// A color described as Strawberry with a HEX value of #FB2943. + Strawberry = 0xFB2943, + /// A color described as Dark Lime with a HEX value of #84B701. + DarkLime = 0x84B701, + /// A color described as Copper with a HEX value of #B66325. + Copper = 0xB66325, + /// A color described as Medium Brown with a HEX value of #7F5112. + MediumBrown = 0x7F5112, + /// A color described as Muted Green with a HEX value of #5FA052. + MutedGreen = 0x5FA052, + /// A color described as Robin'S Egg with a HEX value of #6DEDFD. + RobinsEgg = 0x6DEDFD, + /// A color described as Bright Aqua with a HEX value of #0BF9EA. + BrightAqua = 0x0BF9EA, + /// A color described as Bright Lavender with a HEX value of #C760FF. + BrightLavender = 0xC760FF, + /// A color described as Ivory with a HEX value of #FFFFCB. + Ivory = 0xFFFFCB, + /// A color described as Very Light Purple with a HEX value of #F6CEFC. + VeryLightPurple = 0xF6CEFC, + /// A color described as Light Navy with a HEX value of #155084. + LightNavy = 0x155084, + /// A color described as Pink Red with a HEX value of #F5054F. + PinkRed = 0xF5054F, + /// A color described as Olive Brown with a HEX value of #645403. + OliveBrown = 0x645403, + /// A color described as Poop Brown with a HEX value of #7A5901. + PoopBrown = 0x7A5901, + /// A color described as Mustard Green with a HEX value of #A8B504. + MustardGreen = 0xA8B504, + /// A color described as Ocean Green with a HEX value of #3D9973. + OceanGreen = 0x3D9973, + /// A color described as Very Dark Blue with a HEX value of #000133. + VeryDarkBlue = 0x000133, + /// A color described as Dusty Green with a HEX value of #76A973. + DustyGreen = 0x76A973, + /// A color described as Light Navy Blue with a HEX value of #2E5A88. + LightNavyBlue = 0x2E5A88, + /// A color described as Minty Green with a HEX value of #0BF77D. + MintyGreen = 0x0BF77D, + /// A color described as Adobe with a HEX value of #BD6C48. + Adobe = 0xBD6C48, + /// A color described as Barney with a HEX value of #AC1DB8. + Barney = 0xAC1DB8, + /// A color described as Jade Green with a HEX value of #2BAF6A. + JadeGreen = 0x2BAF6A, + /// A color described as Bright Light Blue with a HEX value of #26F7FD. + BrightLightBlue = 0x26F7FD, + /// A color described as Light Lime with a HEX value of #AEFD6C. + LightLime = 0xAEFD6C, + /// A color described as Dark Khaki with a HEX value of #9B8F55. + DarkKhaki = 0x9B8F55, + /// A color described as Orange Yellow with a HEX value of #FFAD01. + OrangeYellow = 0xFFAD01, + /// A color described as Ocre with a HEX value of #C69C04. + Ocre = 0xC69C04, + /// A color described as Maize with a HEX value of #F4D054. + Maize = 0xF4D054, + /// A color described as Faded Pink with a HEX value of #DE9DAC. + FadedPink = 0xDE9DAC, + /// A color described as British Racing Green with a HEX value of #05480D. + BritishRacingGreen = 0x05480D, + /// A color described as Sandstone with a HEX value of #C9AE74. + Sandstone = 0xC9AE74, + /// A color described as Mud Brown with a HEX value of #60460F. + MudBrown = 0x60460F, + /// A color described as Light Sea Green with a HEX value of #98F6B0. + LightSeaGreen = 0x98F6B0, + /// A color described as Robin Egg Blue with a HEX value of #8AF1FE. + RobinEggBlue = 0x8AF1FE, + /// A color described as Aqua Marine with a HEX value of #2EE8BB. + AquaMarine = 0x2EE8BB, + /// A color described as Dark Sea Green with a HEX value of #11875D. + DarkSeaGreen = 0x11875D, + /// A color described as Soft Pink with a HEX value of #FDB0C0. + SoftPink = 0xFDB0C0, + /// A color described as Orangey Brown with a HEX value of #B16002. + OrangeyBrown = 0xB16002, + /// A color described as Cherry Red with a HEX value of #F7022A. + CherryRed = 0xF7022A, + /// A color described as Burnt Yellow with a HEX value of #D5AB09. + BurntYellow = 0xD5AB09, + /// A color described as Brownish Grey with a HEX value of #86775F. + BrownishGrey = 0x86775F, + /// A color described as Camel with a HEX value of #C69F59. + Camel = 0xC69F59, + /// A color described as Purplish Grey with a HEX value of #7A687F. + PurplishGrey = 0x7A687F, + /// A color described as Marine with a HEX value of #042E60. + Marine = 0x042E60, + /// A color described as Greyish Pink with a HEX value of #C88D94. + GreyishPink = 0xC88D94, + /// A color described as Pale Turquoise with a HEX value of #A5FBD5. + PaleTurquoise = 0xA5FBD5, + /// A color described as Pastel Yellow with a HEX value of #FFFE71. + PastelYellow = 0xFFFE71, + /// A color described as Bluey Purple with a HEX value of #6241C7. + BlueyPurple = 0x6241C7, + /// A color described as Canary Yellow with a HEX value of #FFFE40. + CanaryYellow = 0xFFFE40, + /// A color described as Faded Red with a HEX value of #D3494E. + FadedRed = 0xD3494E, + /// A color described as Sepia with a HEX value of #985E2B. + Sepia = 0x985E2B, + /// A color described as Coffee with a HEX value of #A6814C. + Coffee = 0xA6814C, + /// A color described as Bright Magenta with a HEX value of #FF08E8. + BrightMagenta = 0xFF08E8, + /// A color described as Mocha with a HEX value of #9D7651. + Mocha = 0x9D7651, + /// A color described as Ecru with a HEX value of #FEFFCA. + Ecru = 0xFEFFCA, + /// A color described as Purpleish with a HEX value of #98568D. + Purpleish = 0x98568D, + /// A color described as Cranberry with a HEX value of #9E003A. + Cranberry = 0x9E003A, + /// A color described as Darkish Green with a HEX value of #287C37. + DarkishGreen = 0x287C37, + /// A color described as Brown Orange with a HEX value of #B96902. + BrownOrange = 0xB96902, + /// A color described as Dusky Rose with a HEX value of #BA6873. + DuskyRose = 0xBA6873, + /// A color described as Melon with a HEX value of #FF7855. + Melon = 0xFF7855, + /// A color described as Sickly Green with a HEX value of #94B21C. + SicklyGreen = 0x94B21C, + /// A color described as Silver with a HEX value of #C5C9C7. + Silver = 0xC5C9C7, + /// A color described as Purply Blue with a HEX value of #661AEE. + PurplyBlue = 0x661AEE, + /// A color described as Purpleish Blue with a HEX value of #6140EF. + PurpleishBlue = 0x6140EF, + /// A color described as Hospital Green with a HEX value of #9BE5AA. + HospitalGreen = 0x9BE5AA, + /// A color described as Shit Brown with a HEX value of #7B5804. + ShitBrown = 0x7B5804, + /// A color described as Mid Blue with a HEX value of #276AB3. + MidBlue = 0x276AB3, + /// A color described as Amber with a HEX value of #FEB308. + Amber = 0xFEB308, + /// A color described as Easter Green with a HEX value of #8CFD7E. + EasterGreen = 0x8CFD7E, + /// A color described as Soft Blue with a HEX value of #6488EA. + SoftBlue = 0x6488EA, + /// A color described as Cerulean Blue with a HEX value of #056EEE. + CeruleanBlue = 0x056EEE, + /// A color described as Golden Brown with a HEX value of #B27A01. + GoldenBrown = 0xB27A01, + /// A color described as Bright Turquoise with a HEX value of #0FFEF9. + BrightTurquoise = 0x0FFEF9, + /// A color described as Red Pink with a HEX value of #FA2A55. + RedPink = 0xFA2A55, + /// A color described as Red Purple with a HEX value of #820747. + RedPurple = 0x820747, + /// A color described as Greyish Brown with a HEX value of #7A6A4F. + GreyishBrown = 0x7A6A4F, + /// A color described as Vermillion with a HEX value of #F4320C. + Vermillion = 0xF4320C, + /// A color described as Russet with a HEX value of #A13905. + Russet = 0xA13905, + /// A color described as Steel Grey with a HEX value of #6F828A. + SteelGrey = 0x6F828A, + /// A color described as Lighter Purple with a HEX value of #A55AF4. + LighterPurple = 0xA55AF4, + /// A color described as Bright Violet with a HEX value of #AD0AFD. + BrightViolet = 0xAD0AFD, + /// A color described as Prussian Blue with a HEX value of #004577. + PrussianBlue = 0x004577, + /// A color described as Slate Green with a HEX value of #658D6D. + SlateGreen = 0x658D6D, + /// A color described as Dirty Pink with a HEX value of #CA7B80. + DirtyPink = 0xCA7B80, + /// A color described as Dark Blue Green with a HEX value of #005249. + DarkBlueGreen = 0x005249, + /// A color described as Pine with a HEX value of #2B5D34. + Pine = 0x2B5D34, + /// A color described as Yellowy Green with a HEX value of #BFF128. + YellowyGreen = 0xBFF128, + /// A color described as Dark Gold with a HEX value of #B59410. + DarkGold = 0xB59410, + /// A color described as Bluish with a HEX value of #2976BB. + Bluish = 0x2976BB, + /// A color described as Darkish Blue with a HEX value of #014182. + DarkishBlue = 0x014182, + /// A color described as Dull Red with a HEX value of #BB3F3F. + DullRed = 0xBB3F3F, + /// A color described as Pinky Red with a HEX value of #FC2647. + PinkyRed = 0xFC2647, + /// A color described as Bronze with a HEX value of #A87900. + Bronze = 0xA87900, + /// A color described as Pale Teal with a HEX value of #82CBB2. + PaleTeal = 0x82CBB2, + /// A color described as Military Green with a HEX value of #667C3E. + MilitaryGreen = 0x667C3E, + /// A color described as Barbie Pink with a HEX value of #FE46A5. + BarbiePink = 0xFE46A5, + /// A color described as Bubblegum Pink with a HEX value of #FE83CC. + BubblegumPink = 0xFE83CC, + /// A color described as Pea Soup Green with a HEX value of #94A617. + PeaSoupGreen = 0x94A617, + /// A color described as Dark Mustard with a HEX value of #A88905. + DarkMustard = 0xA88905, + /// A color described as Shit with a HEX value of #7F5F00. + Shit = 0x7F5F00, + /// A color described as Medium Purple with a HEX value of #9E43A2. + MediumPurple = 0x9E43A2, + /// A color described as Very Dark Green with a HEX value of #062E03. + VeryDarkGreen = 0x062E03, + /// A color described as Dirt with a HEX value of #8A6E45. + Dirt = 0x8A6E45, + /// A color described as Dusky Pink with a HEX value of #CC7A8B. + DuskyPink = 0xCC7A8B, + /// A color described as Red Violet with a HEX value of #9E0168. + RedViolet = 0x9E0168, + /// A color described as Lemon Yellow with a HEX value of #FDFF38. + LemonYellow = 0xFDFF38, + /// A color described as Pistachio with a HEX value of #C0FA8B. + Pistachio = 0xC0FA8B, + /// A color described as Dull Yellow with a HEX value of #EEDC5B. + DullYellow = 0xEEDC5B, + /// A color described as Dark Lime Green with a HEX value of #7EBD01. + DarkLimeGreen = 0x7EBD01, + /// A color described as Denim Blue with a HEX value of #3B5B92. + DenimBlue = 0x3B5B92, + /// A color described as Teal Blue with a HEX value of #01889F. + TealBlue = 0x01889F, + /// A color described as Lightish Blue with a HEX value of #3D7AFD. + LightishBlue = 0x3D7AFD, + /// A color described as Purpley Blue with a HEX value of #5F34E7. + PurpleyBlue = 0x5F34E7, + /// A color described as Light Indigo with a HEX value of #6D5ACF. + LightIndigo = 0x6D5ACF, + /// A color described as Swamp Green with a HEX value of #748500. + SwampGreen = 0x748500, + /// A color described as Brown Green with a HEX value of #706C11. + BrownGreen = 0x706C11, + /// A color described as Dark Maroon with a HEX value of #3C0008. + DarkMaroon = 0x3C0008, + /// A color described as Hot Purple with a HEX value of #CB00F5. + HotPurple = 0xCB00F5, + /// A color described as Dark Forest Green with a HEX value of #002D04. + DarkForestGreen = 0x002D04, + /// A color described as Faded Blue with a HEX value of #658CBB. + FadedBlue = 0x658CBB, + /// A color described as Drab Green with a HEX value of #749551. + DrabGreen = 0x749551, + /// A color described as Light Lime Green with a HEX value of #B9FF66. + LightLimeGreen = 0xB9FF66, + /// A color described as Snot Green with a HEX value of #9DC100. + SnotGreen = 0x9DC100, + /// A color described as Yellowish with a HEX value of #FAEE66. + Yellowish = 0xFAEE66, + /// A color described as Light Blue Green with a HEX value of #7EFBB3. + LightBlueGreen = 0x7EFBB3, + /// A color described as Bordeaux with a HEX value of #7B002C. + Bordeaux = 0x7B002C, + /// A color described as Light Mauve with a HEX value of #C292A1. + LightMauve = 0xC292A1, + /// A color described as Ocean with a HEX value of #017B92. + Ocean = 0x017B92, + /// A color described as Marigold with a HEX value of #FCC006. + Marigold = 0xFCC006, + /// A color described as Muddy Green with a HEX value of #657432. + MuddyGreen = 0x657432, + /// A color described as Dull Orange with a HEX value of #D8863B. + DullOrange = 0xD8863B, + /// A color described as Steel with a HEX value of #738595. + Steel = 0x738595, + /// A color described as Electric Purple with a HEX value of #AA23FF. + ElectricPurple = 0xAA23FF, + /// A color described as Fluorescent Green with a HEX value of #08FF08. + FluorescentGreen = 0x08FF08, + /// A color described as Yellowish Brown with a HEX value of #9B7A01. + YellowishBrown = 0x9B7A01, + /// A color described as Blush with a HEX value of #F29E8E. + Blush = 0xF29E8E, + /// A color described as Soft Green with a HEX value of #6FC276. + SoftGreen = 0x6FC276, + /// A color described as Bright Orange with a HEX value of #FF5B00. + BrightOrange = 0xFF5B00, + /// A color described as Lemon with a HEX value of #FDFF52. + Lemon = 0xFDFF52, + /// A color described as Purple Grey with a HEX value of #866F85. + PurpleGrey = 0x866F85, + /// A color described as Acid Green with a HEX value of #8FFE09. + AcidGreen = 0x8FFE09, + /// A color described as Pale Lavender with a HEX value of #EECFFE. + PaleLavender = 0xEECFFE, + /// A color described as Violet Blue with a HEX value of #510AC9. + VioletBlue = 0x510AC9, + /// A color described as Light Forest Green with a HEX value of #4F9153. + LightForestGreen = 0x4F9153, + /// A color described as Burnt Red with a HEX value of #9F2305. + BurntRed = 0x9F2305, + /// A color described as Khaki Green with a HEX value of #728639. + KhakiGreen = 0x728639, + /// A color described as Cerise with a HEX value of #DE0C62. + Cerise = 0xDE0C62, + /// A color described as Faded Purple with a HEX value of #916E99. + FadedPurple = 0x916E99, + /// A color described as Apricot with a HEX value of #FFB16D. + Apricot = 0xFFB16D, + /// A color described as Dark Olive Green with a HEX value of #3C4D03. + DarkOliveGreen = 0x3C4D03, + /// A color described as Grey Brown with a HEX value of #7F7053. + GreyBrown = 0x7F7053, + /// A color described as Green Grey with a HEX value of #77926F. + GreenGrey = 0x77926F, + /// A color described as True Blue with a HEX value of #010FCC. + TrueBlue = 0x010FCC, + /// A color described as Pale Violet with a HEX value of #CEAEFA. + PaleViolet = 0xCEAEFA, + /// A color described as Periwinkle Blue with a HEX value of #8F99FB. + PeriwinkleBlue = 0x8F99FB, + /// A color described as Light Sky Blue with a HEX value of #C6FCFF. + LightSkyBlue = 0xC6FCFF, + /// A color described as Blurple with a HEX value of #5539CC. + Blurple = 0x5539CC, + /// A color described as Green Brown with a HEX value of #544E03. + GreenBrown = 0x544E03, + /// A color described as Bluegreen with a HEX value of #017A79. + Bluegreen = 0x017A79, + /// A color described as Bright Teal with a HEX value of #01F9C6. + BrightTeal = 0x01F9C6, + /// A color described as Brownish Yellow with a HEX value of #C9B003. + BrownishYellow = 0xC9B003, + /// A color described as Pea Soup with a HEX value of #929901. + PeaSoup = 0x929901, + /// A color described as Forest with a HEX value of #0B5509. + Forest = 0x0B5509, + /// A color described as Barney Purple with a HEX value of #A00498. + BarneyPurple = 0xA00498, + /// A color described as Ultramarine with a HEX value of #2000B1. + Ultramarine = 0x2000B1, + /// A color described as Purplish with a HEX value of #94568C. + Purplish = 0x94568C, + /// A color described as Puke Yellow with a HEX value of #C2BE0E. + PukeYellow = 0xC2BE0E, + /// A color described as Bluish Grey with a HEX value of #748B97. + BluishGrey = 0x748B97, + /// A color described as Dark Periwinkle with a HEX value of #665FD1. + DarkPeriwinkle = 0x665FD1, + /// A color described as Dark Lilac with a HEX value of #9C6DA5. + DarkLilac = 0x9C6DA5, + /// A color described as Reddish with a HEX value of #C44240. + Reddish = 0xC44240, + /// A color described as Light Maroon with a HEX value of #A24857. + LightMaroon = 0xA24857, + /// A color described as Dusty Purple with a HEX value of #825F87. + DustyPurple = 0x825F87, + /// A color described as Terra Cotta with a HEX value of #C9643B. + TerraCotta = 0xC9643B, + /// A color described as Avocado with a HEX value of #90B134. + Avocado = 0x90B134, + /// A color described as Marine Blue with a HEX value of #01386A. + MarineBlue = 0x01386A, + /// A color described as Teal Green with a HEX value of #25A36F. + TealGreen = 0x25A36F, + /// A color described as Slate Grey with a HEX value of #59656D. + SlateGrey = 0x59656D, + /// A color described as Lighter Green with a HEX value of #75FD63. + LighterGreen = 0x75FD63, + /// A color described as Electric Green with a HEX value of #21FC0D. + ElectricGreen = 0x21FC0D, + /// A color described as Dusty Blue with a HEX value of #5A86AD. + DustyBlue = 0x5A86AD, + /// A color described as Golden Yellow with a HEX value of #FEC615. + GoldenYellow = 0xFEC615, + /// A color described as Bright Yellow with a HEX value of #FFFD01. + BrightYellow = 0xFFFD01, + /// A color described as Light Lavender with a HEX value of #DFC5FE. + LightLavender = 0xDFC5FE, + /// A color described as Umber with a HEX value of #B26400. + Umber = 0xB26400, + /// A color described as Poop with a HEX value of #7F5E00. + Poop = 0x7F5E00, + /// A color described as Dark Peach with a HEX value of #DE7E5D. + DarkPeach = 0xDE7E5D, + /// A color described as Jungle Green with a HEX value of #048243. + JungleGreen = 0x048243, + /// A color described as Eggshell with a HEX value of #FFFFD4. + Eggshell = 0xFFFFD4, + /// A color described as Denim with a HEX value of #3B638C. + Denim = 0x3B638C, + /// A color described as Yellow Brown with a HEX value of #B79400. + YellowBrown = 0xB79400, + /// A color described as Dull Purple with a HEX value of #84597E. + DullPurple = 0x84597E, + /// A color described as Chocolate Brown with a HEX value of #411900. + ChocolateBrown = 0x411900, + /// A color described as Wine Red with a HEX value of #7B0323. + WineRed = 0x7B0323, + /// A color described as Neon Blue with a HEX value of #04D9FF. + NeonBlue = 0x04D9FF, + /// A color described as Dirty Green with a HEX value of #667E2C. + DirtyGreen = 0x667E2C, + /// A color described as Light Tan with a HEX value of #FBEEAC. + LightTan = 0xFBEEAC, + /// A color described as Ice Blue with a HEX value of #D7FFFE. + IceBlue = 0xD7FFFE, + /// A color described as Cadet Blue with a HEX value of #4E7496. + CadetBlue = 0x4E7496, + /// A color described as Dark Mauve with a HEX value of #874C62. + DarkMauve = 0x874C62, + /// A color described as Very Light Blue with a HEX value of #D5FFFF. + VeryLightBlue = 0xD5FFFF, + /// A color described as Grey Purple with a HEX value of #826D8C. + GreyPurple = 0x826D8C, + /// A color described as Pastel Pink with a HEX value of #FFBACD. + PastelPink = 0xFFBACD, + /// A color described as Very Light Green with a HEX value of #D1FFBD. + VeryLightGreen = 0xD1FFBD, + /// A color described as Dark Sky Blue with a HEX value of #448EE4. + DarkSkyBlue = 0x448EE4, + /// A color described as Evergreen with a HEX value of #05472A. + Evergreen = 0x05472A, + /// A color described as Dull Pink with a HEX value of #D5869D. + DullPink = 0xD5869D, + /// A color described as Aubergine with a HEX value of #3D0734. + Aubergine = 0x3D0734, + /// A color described as Mahogany with a HEX value of #4A0100. + Mahogany = 0x4A0100, + /// A color described as Reddish Orange with a HEX value of #F8481C. + ReddishOrange = 0xF8481C, + /// A color described as Deep Green with a HEX value of #02590F. + DeepGreen = 0x02590F, + /// A color described as Vomit Green with a HEX value of #89A203. + VomitGreen = 0x89A203, + /// A color described as Purple Pink with a HEX value of #E03FD8. + PurplePinkAlternate = 0xE03FD8, + /// A color described as Dusty Pink with a HEX value of #D58A94. + DustyPink = 0xD58A94, + /// A color described as Faded Green with a HEX value of #7BB274. + FadedGreen = 0x7BB274, + /// A color described as Camo Green with a HEX value of #526525. + CamoGreen = 0x526525, + /// A color described as Pinky Purple with a HEX value of #C94CBE. + PinkyPurple = 0xC94CBE, + /// A color described as Pink Purple with a HEX value of #DB4BDA. + PinkPurpleAlternate = 0xDB4BDA, + /// A color described as Brownish Red with a HEX value of #9E3623. + BrownishRed = 0x9E3623, + /// A color described as Dark Rose with a HEX value of #B5485D. + DarkRose = 0xB5485D, + /// A color described as Mud with a HEX value of #735C12. + Mud = 0x735C12, + /// A color described as Brownish with a HEX value of #9C6D57. + Brownish = 0x9C6D57, + /// A color described as Emerald Green with a HEX value of #028F1E. + EmeraldGreen = 0x028F1E, + /// A color described as Pale Brown with a HEX value of #B1916E. + PaleBrown = 0xB1916E, + /// A color described as Dull Blue with a HEX value of #49759C. + DullBlue = 0x49759C, + /// A color described as Burnt Umber with a HEX value of #A0450E. + BurntUmber = 0xA0450E, + /// A color described as Medium Green with a HEX value of #39AD48. + MediumGreen = 0x39AD48, + /// A color described as Clay with a HEX value of #B66A50. + Clay = 0xB66A50, + /// A color described as Light Aqua with a HEX value of #8CFFDB. + LightAqua = 0x8CFFDB, + /// A color described as Light Olive Green with a HEX value of #A4BE5C. + LightOliveGreen = 0xA4BE5C, + /// A color described as Brownish Orange with a HEX value of #CB7723. + BrownishOrange = 0xCB7723, + /// A color described as Dark Aqua with a HEX value of #05696B. + DarkAqua = 0x05696B, + /// A color described as Purplish Pink with a HEX value of #CE5DAE. + PurplishPink = 0xCE5DAE, + /// A color described as Dark Salmon with a HEX value of #C85A53. + DarkSalmon = 0xC85A53, + /// A color described as Greenish Grey with a HEX value of #96AE8D. + GreenishGrey = 0x96AE8D, + /// A color described as Jade with a HEX value of #1FA774. + Jade = 0x1FA774, + /// A color described as Ugly Green with a HEX value of #7A9703. + UglyGreen = 0x7A9703, + /// A color described as Dark Beige with a HEX value of #AC9362. + DarkBeige = 0xAC9362, + /// A color described as Emerald with a HEX value of #01A049. + Emerald = 0x01A049, + /// A color described as Pale Red with a HEX value of #D9544D. + PaleRed = 0xD9544D, + /// A color described as Light Magenta with a HEX value of #FA5FF7. + LightMagenta = 0xFA5FF7, + /// A color described as Sky with a HEX value of #82CAFC. + Sky = 0x82CAFC, + /// A color described as Light Cyan with a HEX value of #ACFFFC. + LightCyan = 0xACFFFC, + /// A color described as Yellow Orange with a HEX value of #FCB001. + YellowOrange = 0xFCB001, + /// A color described as Reddish Purple with a HEX value of #910951. + ReddishPurple = 0x910951, + /// A color described as Reddish Pink with a HEX value of #FE2C54. + ReddishPink = 0xFE2C54, + /// A color described as Orchid with a HEX value of #C875C4. + Orchid = 0xC875C4, + /// A color described as Dirty Yellow with a HEX value of #CDC50A. + DirtyYellow = 0xCDC50A, + /// A color described as Orange Red with a HEX value of #FD411E. + OrangeRed = 0xFD411E, + /// A color described as Deep Red with a HEX value of #9A0200. + DeepRed = 0x9A0200, + /// A color described as Orange Brown with a HEX value of #BE6400. + OrangeBrown = 0xBE6400, + /// A color described as Cobalt Blue with a HEX value of #030AA7. + CobaltBlue = 0x030AA7, + /// A color described as Neon Pink with a HEX value of #FE019A. + NeonPink = 0xFE019A, + /// A color described as Rose Pink with a HEX value of #F7879A. + RosePink = 0xF7879A, + /// A color described as Greyish Purple with a HEX value of #887191. + GreyishPurple = 0x887191, + /// A color described as Raspberry with a HEX value of #B00149. + Raspberry = 0xB00149, + /// A color described as Aqua Green with a HEX value of #12E193. + AquaGreen = 0x12E193, + /// A color described as Salmon Pink with a HEX value of #FE7B7C. + SalmonPink = 0xFE7B7C, + /// A color described as Tangerine with a HEX value of #FF9408. + Tangerine = 0xFF9408, + /// A color described as Brownish Green with a HEX value of #6A6E09. + BrownishGreen = 0x6A6E09, + /// A color described as Red Brown with a HEX value of #8B2E16. + RedBrown = 0x8B2E16, + /// A color described as Greenish Brown with a HEX value of #696112. + GreenishBrown = 0x696112, + /// A color described as Pumpkin with a HEX value of #E17701. + Pumpkin = 0xE17701, + /// A color described as Pine Green with a HEX value of #0A481E. + PineGreen = 0x0A481E, + /// A color described as Charcoal with a HEX value of #343837. + Charcoal = 0x343837, + /// A color described as Baby Pink with a HEX value of #FFB7CE. + BabyPink = 0xFFB7CE, + /// A color described as Cornflower with a HEX value of #6A79F7. + Cornflower = 0x6A79F7, + /// A color described as Blue Violet with a HEX value of #5D06E9. + BlueViolet = 0x5D06E9, + /// A color described as Chocolate with a HEX value of #3D1C02. + Chocolate = 0x3D1C02, + /// A color described as Greyish Green with a HEX value of #82A67D. + GreyishGreen = 0x82A67D, + /// A color described as Scarlet with a HEX value of #BE0119. + Scarlet = 0xBE0119, + /// A color described as Green Yellow with a HEX value of #C9FF27. + GreenYellowAlternate = 0xC9FF27, + /// A color described as Dark Olive with a HEX value of #373E02. + DarkOlive = 0x373E02, + /// A color described as Sienna with a HEX value of #A9561E. + Sienna = 0xA9561E, + /// A color described as Pastel Purple with a HEX value of #CAA0FF. + PastelPurple = 0xCAA0FF, + /// A color described as Terracotta with a HEX value of #CA6641. + Terracotta = 0xCA6641, + /// A color described as Aqua Blue with a HEX value of #02D8E9. + AquaBlue = 0x02D8E9, + /// A color described as Sage Green with a HEX value of #88B378. + SageGreen = 0x88B378, + /// A color described as Blood Red with a HEX value of #980002. + BloodRed = 0x980002, + /// A color described as Deep Pink with a HEX value of #CB0162. + DeepPink = 0xCB0162, + /// A color described as Grass with a HEX value of #5CAC2D. + Grass = 0x5CAC2D, + /// A color described as Moss with a HEX value of #769958. + Moss = 0x769958, + /// A color described as Pastel Blue with a HEX value of #A2BFFE. + PastelBlue = 0xA2BFFE, + /// A color described as Bluish Green with a HEX value of #10A674. + BluishGreen = 0x10A674, + /// A color described as Green Blue with a HEX value of #06B48B. + GreenBlueAlternate = 0x06B48B, + /// A color described as Dark Tan with a HEX value of #AF884A. + DarkTan = 0xAF884A, + /// A color described as Greenish Blue with a HEX value of #0B8B87. + GreenishBlue = 0x0B8B87, + /// A color described as Pale Orange with a HEX value of #FFA756. + PaleOrange = 0xFFA756, + /// A color described as Vomit with a HEX value of #A2A415. + Vomit = 0xA2A415, + /// A color described as Forrest Green with a HEX value of #154406. + ForrestGreen = 0x154406, + /// A color described as Dark Lavender with a HEX value of #856798. + DarkLavender = 0x856798, + /// A color described as Dark Violet with a HEX value of #34013F. + DarkViolet = 0x34013F, + /// A color described as Purple Blue with a HEX value of #632DE9. + PurpleBlueAlternate = 0x632DE9, + /// A color described as Dark Cyan with a HEX value of #0A888A. + DarkCyan = 0x0A888A, + /// A color described as Olive Drab with a HEX value of #6F7632. + OliveDrab = 0x6F7632, + /// A color described as Pinkish with a HEX value of #D46A7E. + Pinkish = 0xD46A7E, + /// A color described as Cobalt with a HEX value of #1E488F. + Cobalt = 0x1E488F, + /// A color described as Neon Purple with a HEX value of #BC13FE. + NeonPurple = 0xBC13FE, + /// A color described as Light Turquoise with a HEX value of #7EF4CC. + LightTurquoise = 0x7EF4CC, + /// A color described as Apple Green with a HEX value of #76CD26. + AppleGreen = 0x76CD26, + /// A color described as Dull Green with a HEX value of #74A662. + DullGreen = 0x74A662, + /// A color described as Wine with a HEX value of #80013F. + Wine = 0x80013F, + /// A color described as Powder Blue with a HEX value of #B1D1FC. + PowderBlue = 0xB1D1FC, + /// A color described as Off White with a HEX value of #FFFFE4. + OffWhite = 0xFFFFE4, + /// A color described as Electric Blue with a HEX value of #0652FF. + ElectricBlue = 0x0652FF, + /// A color described as Dark Turquoise with a HEX value of #045C5A. + DarkTurquoise = 0x045C5A, + /// A color described as Blue Purple with a HEX value of #5729CE. + BluePurpleAlternate = 0x5729CE, + /// A color described as Azure with a HEX value of #069AF3. + Azure = 0x069AF3, + /// A color described as Bright Red with a HEX value of #FF000D. + BrightRed = 0xFF000D, + /// A color described as Pinkish Red with a HEX value of #F10C45. + PinkishRed = 0xF10C45, + /// A color described as Cornflower Blue with a HEX value of #5170D7. + CornflowerBlue = 0x5170D7, + /// A color described as Light Olive with a HEX value of #ACBF69. + LightOlive = 0xACBF69, + /// A color described as Grape with a HEX value of #6C3461. + Grape = 0x6C3461, + /// A color described as Greyish Blue with a HEX value of #5E819D. + GreyishBlue = 0x5E819D, + /// A color described as Purplish Blue with a HEX value of #601EF9. + PurplishBlue = 0x601EF9, + /// A color described as Yellowish Green with a HEX value of #B0DD16. + YellowishGreen = 0xB0DD16, + /// A color described as Greenish Yellow with a HEX value of #CDFD02. + GreenishYellow = 0xCDFD02, + /// A color described as Medium Blue with a HEX value of #2C6FBB. + MediumBlue = 0x2C6FBB, + /// A color described as Dusty Rose with a HEX value of #C0737A. + DustyRose = 0xC0737A, + /// A color described as Light Violet with a HEX value of #D6B4FC. + LightViolet = 0xD6B4FC, + /// A color described as Midnight Blue with a HEX value of #020035. + MidnightBlue = 0x020035, + /// A color described as Bluish Purple with a HEX value of #703BE7. + BluishPurple = 0x703BE7, + /// A color described as Red Orange with a HEX value of #FD3C06. + RedOrange = 0xFD3C06, + /// A color described as Dark Magenta with a HEX value of #960056. + DarkMagenta = 0x960056, + /// A color described as Greenish with a HEX value of #40A368. + Greenish = 0x40A368, + /// A color described as Ocean Blue with a HEX value of #03719C. + OceanBlue = 0x03719C, + /// A color described as Coral with a HEX value of #FC5A50. + Coral = 0xFC5A50, + /// A color described as Cream with a HEX value of #FFFFC2. + Cream = 0xFFFFC2, + /// A color described as Reddish Brown with a HEX value of #7F2B0A. + ReddishBrown = 0x7F2B0A, + /// A color described as Burnt Sienna with a HEX value of #B04E0F. + BurntSienna = 0xB04E0F, + /// A color described as Brick with a HEX value of #A03623. + Brick = 0xA03623, + /// A color described as Sage with a HEX value of #87AE73. + Sage = 0x87AE73, + /// A color described as Grey Green with a HEX value of #789B73. + GreyGreenAlternate = 0x789B73, + /// A color described as White with a HEX value of #FFFFFF. + White = 0xFFFFFF, + /// A color described as Robin'S Egg Blue with a HEX value of #98EFF9. + RobinsEggBlue = 0x98EFF9, + /// A color described as Moss Green with a HEX value of #658B38. + MossGreen = 0x658B38, + /// A color described as Steel Blue with a HEX value of #5A7D9A. + SteelBlue = 0x5A7D9A, + /// A color described as Eggplant with a HEX value of #380835. + Eggplant = 0x380835, + /// A color described as Light Yellow with a HEX value of #FFFE7A. + LightYellow = 0xFFFE7A, + /// A color described as Leaf Green with a HEX value of #5CA904. + LeafGreen = 0x5CA904, + /// A color described as Light Grey with a HEX value of #D8DCD6. + LightGrey = 0xD8DCD6, + /// A color described as Puke with a HEX value of #A5A502. + Puke = 0xA5A502, + /// A color described as Pinkish Purple with a HEX value of #D648D7. + PinkishPurple = 0xD648D7, + /// A color described as Sea Blue with a HEX value of #047495. + SeaBlue = 0x047495, + /// A color described as Pale Purple with a HEX value of #B790D4. + PalePurple = 0xB790D4, + /// A color described as Slate Blue with a HEX value of #5B7C99. + SlateBlue = 0x5B7C99, + /// A color described as Blue Grey with a HEX value of #607C8E. + BlueGreyAlternate = 0x607C8E, + /// A color described as Hunter Green with a HEX value of #0B4008. + HunterGreen = 0x0B4008, + /// A color described as Fuchsia with a HEX value of #ED0DD9. + Fuchsia = 0xED0DD9, + /// A color described as Crimson with a HEX value of #8C000F. + Crimson = 0x8C000F, + /// A color described as Pale Yellow with a HEX value of #FFFF84. + PaleYellow = 0xFFFF84, + /// A color described as Ochre with a HEX value of #BF9005. + Ochre = 0xBF9005, + /// A color described as Mustard Yellow with a HEX value of #D2BD0A. + MustardYellow = 0xD2BD0A, + /// A color described as Light Red with a HEX value of #FF474C. + LightRed = 0xFF474C, + /// A color described as Cerulean with a HEX value of #0485D1. + Cerulean = 0x0485D1, + /// A color described as Pale Pink with a HEX value of #FFCFDC. + PalePink = 0xFFCFDC, + /// A color described as Deep Blue with a HEX value of #040273. + DeepBlue = 0x040273, + /// A color described as Rust with a HEX value of #A83C09. + Rust = 0xA83C09, + /// A color described as Light Teal with a HEX value of #90E4C1. + LightTeal = 0x90E4C1, + /// A color described as Slate with a HEX value of #516572. + Slate = 0x516572, + /// A color described as Goldenrod with a HEX value of #FAC205. + Goldenrod = 0xFAC205, + /// A color described as Dark Yellow with a HEX value of #D5B60A. + DarkYellow = 0xD5B60A, + /// A color described as Dark Grey with a HEX value of #363737. + DarkGrey = 0x363737, + /// A color described as Army Green with a HEX value of #4B5D16. + ArmyGreen = 0x4B5D16, + /// A color described as Grey Blue with a HEX value of #6B8BA4. + GreyBlueAlternate = 0x6B8BA4, + /// A color described as Seafoam with a HEX value of #80F9AD. + Seafoam = 0x80F9AD, + /// A color described as Puce with a HEX value of #A57E52. + Puce = 0xA57E52, + /// A color described as Spring Green with a HEX value of #A9F971. + SpringGreen = 0xA9F971, + /// A color described as Dark Orange with a HEX value of #C65102. + DarkOrange = 0xC65102, + /// A color described as Sand with a HEX value of #E2CA76. + Sand = 0xE2CA76, + /// A color described as Pastel Green with a HEX value of #B0FF9D. + PastelGreen = 0xB0FF9D, + /// A color described as Mint with a HEX value of #9FFEB0. + Mint = 0x9FFEB0, + /// A color described as Light Orange with a HEX value of #FDAA48. + LightOrange = 0xFDAA48, + /// A color described as Bright Pink with a HEX value of #FE01B1. + BrightPink = 0xFE01B1, + /// A color described as Chartreuse with a HEX value of #C1F80A. + Chartreuse = 0xC1F80A, + /// A color described as Deep Purple with a HEX value of #36013F. + DeepPurple = 0x36013F, + /// A color described as Dark Brown with a HEX value of #341C02. + DarkBrown = 0x341C02, + /// A color described as Taupe with a HEX value of #B9A281. + Taupe = 0xB9A281, + /// A color described as Pea Green with a HEX value of #8EAB12. + PeaGreen = 0x8EAB12, + /// A color described as Puke Green with a HEX value of #9AAE07. + PukeGreen = 0x9AAE07, + /// A color described as Kelly Green with a HEX value of #02AB2E. + KellyGreen = 0x02AB2E, + /// A color described as Seafoam Green with a HEX value of #7AF9AB. + SeafoamGreen = 0x7AF9AB, + /// A color described as Blue Green with a HEX value of #137E6D. + BlueGreenAlternate = 0x137E6D, + /// A color described as Khaki with a HEX value of #AAA662. + Khaki = 0xAAA662, + /// A color described as Burgundy with a HEX value of #610023. + Burgundy = 0x610023, + /// A color described as Dark Teal with a HEX value of #014D4E. + DarkTeal = 0x014D4E, + /// A color described as Brick Red with a HEX value of #8F1402. + BrickRed = 0x8F1402, + /// A color described as Royal Purple with a HEX value of #4B006E. + RoyalPurple = 0x4B006E, + /// A color described as Plum with a HEX value of #580F41. + Plum = 0x580F41, + /// A color described as Mint Green with a HEX value of #8FFF9F. + MintGreen = 0x8FFF9F, + /// A color described as Gold with a HEX value of #DBB40C. + Gold = 0xDBB40C, + /// A color described as Baby Blue with a HEX value of #A2CFFE. + BabyBlue = 0xA2CFFE, + /// A color described as Yellow Green with a HEX value of #C0FB2D. + YellowGreenAlternate = 0xC0FB2D, + /// A color described as Bright Purple with a HEX value of #BE03FD. + BrightPurple = 0xBE03FD, + /// A color described as Dark Red with a HEX value of #840000. + DarkRed = 0x840000, + /// A color described as Pale Blue with a HEX value of #D0FEFE. + PaleBlue = 0xD0FEFE, + /// A color described as Grass Green with a HEX value of #3F9B0B. + GrassGreen = 0x3F9B0B, + /// A color described as Navy with a HEX value of #01153E. + Navy = 0x01153E, + /// A color described as Aquamarine with a HEX value of #04D8B2. + Aquamarine = 0x04D8B2, + /// A color described as Burnt Orange with a HEX value of #C04E01. + BurntOrange = 0xC04E01, + /// A color described as Neon Green with a HEX value of #0CFF0C. + NeonGreen = 0x0CFF0C, + /// A color described as Bright Blue with a HEX value of #0165FC. + BrightBlue = 0x0165FC, + /// A color described as Rose with a HEX value of #CF6275. + Rose = 0xCF6275, + /// A color described as Light Pink with a HEX value of #FFD1DF. + LightPink = 0xFFD1DF, + /// A color described as Mustard with a HEX value of #CEB301. + Mustard = 0xCEB301, + /// A color described as Indigo with a HEX value of #380282. + Indigo = 0x380282, + /// A color described as Lime with a HEX value of #AAFF32. + Lime = 0xAAFF32, + /// A color described as Sea Green with a HEX value of #53FCA1. + SeaGreen = 0x53FCA1, + /// A color described as Periwinkle with a HEX value of #8E82FE. + Periwinkle = 0x8E82FE, + /// A color described as Dark Pink with a HEX value of #CB416B. + DarkPink = 0xCB416B, + /// A color described as Olive Green with a HEX value of #677A04. + OliveGreen = 0x677A04, + /// A color described as Peach with a HEX value of #FFB07C. + Peach = 0xFFB07C, + /// A color described as Pale Green with a HEX value of #C7FDB5. + PaleGreen = 0xC7FDB5, + /// A color described as Light Brown with a HEX value of #AD8150. + LightBrown = 0xAD8150, + /// A color described as Hot Pink with a HEX value of #FF028D. + HotPink = 0xFF028D, + /// A color described as Black with a HEX value of #000000. + Black = 0x000000, + /// A color described as Lilac with a HEX value of #CEA2FD. + Lilac = 0xCEA2FD, + /// A color described as Navy Blue with a HEX value of #001146. + NavyBlue = 0x001146, + /// A color described as Royal Blue with a HEX value of #0504AA. + RoyalBlue = 0x0504AA, + /// A color described as Beige with a HEX value of #E6DAA6. + Beige = 0xE6DAA6, + /// A color described as Salmon with a HEX value of #FF796C. + Salmon = 0xFF796C, + /// A color described as Olive with a HEX value of #6E750E. + Olive = 0x6E750E, + /// A color described as Maroon with a HEX value of #650021. + Maroon = 0x650021, + /// A color described as Bright Green with a HEX value of #01FF07. + BrightGreen = 0x01FF07, + /// A color described as Dark Purple with a HEX value of #35063E. + DarkPurple = 0x35063E, + /// A color described as Mauve with a HEX value of #AE7181. + Mauve = 0xAE7181, + /// A color described as Forest Green with a HEX value of #06470C. + ForestGreen = 0x06470C, + /// A color described as Aqua with a HEX value of #13EAC9. + Aqua = 0x13EAC9, + /// A color described as Cyan with a HEX value of #00FFFF. + Cyan = 0x00FFFF, + /// A color described as Tan with a HEX value of #D1B26F. + Tan = 0xD1B26F, + /// A color described as Dark Blue with a HEX value of #00035B. + DarkBlue = 0x00035B, + /// A color described as Lavender with a HEX value of #C79FEF. + Lavender = 0xC79FEF, + /// A color described as Turquoise with a HEX value of #06C2AC. + Turquoise = 0x06C2AC, + /// A color described as Dark Green with a HEX value of #033500. + DarkGreen = 0x033500, + /// A color described as Violet with a HEX value of #9A0EEA. + Violet = 0x9A0EEA, + /// A color described as Light Purple with a HEX value of #BF77F6. + LightPurple = 0xBF77F6, + /// A color described as Lime Green with a HEX value of #89FE05. + LimeGreen = 0x89FE05, + /// A color described as Grey with a HEX value of #929591. + Grey = 0x929591, + /// A color described as Sky Blue with a HEX value of #75BBFD. + SkyBlue = 0x75BBFD, + /// A color described as Yellow with a HEX value of #FFFF14. + Yellow = 0xFFFF14, + /// A color described as Magenta with a HEX value of #C20078. + Magenta = 0xC20078, + /// A color described as Light Green with a HEX value of #96F97B. + LightGreen = 0x96F97B, + /// A color described as Orange with a HEX value of #F97306. + Orange = 0xF97306, + /// A color described as Teal with a HEX value of #029386. + Teal = 0x029386, + /// A color described as Light Blue with a HEX value of #95D0FC. + LightBlue = 0x95D0FC, + /// A color described as Red with a HEX value of #E50000. + Red = 0xE50000, + /// A color described as Brown with a HEX value of #653700. + Brown = 0x653700, + /// A color described as Pink with a HEX value of #FF81C0. + Pink = 0xFF81C0, + /// A color described as Blue with a HEX value of #0343DF. + Blue = 0x0343DF, + /// A color described as Green with a HEX value of #15B01A. + Green = 0x15B01A, + /// A color described as Purple with a HEX value of #7E1E9C. + Purple = 0x7E1E9C, + Purple2 = 0x7E1E9C, + + } +} diff --git a/CapyKit/Helpers/SecurityHelper.cs b/CapyKit/Helpers/SecurityHelper.cs new file mode 100644 index 0000000..5e10b97 --- /dev/null +++ b/CapyKit/Helpers/SecurityHelper.cs @@ -0,0 +1,161 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Security.Cryptography; +using System.Text; +using System.Threading.Tasks; + +namespace CapyKit.Helpers +{ + /// A class that contains methods for managing secure data processing and cryptography. + public class SecurityHelper + { + #region Members + + private int keySize = 32; + private int saltSize = 32; + + /// The salt used when creating a hash using the SHA256 algorithm. + private const string SALT = "D4260471-5DBA-4732-B960-6E2E438F8872"; + + /// A string of all the lower case characters. + private const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz"; + + /// A string of all the upper case characters. + private const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"; + + /// A string of all the numeric characters. + private const string NUMBER_CHARACTERS = "0123456789"; + + /// A string of the most common non-alphanumeric characters. + private const string SPECIAL_CHARACTERS = "!@#$%&?+-_"; + + #endregion Members + + #region Methods + + /// + /// Compares an unencrypted with a stored, encrypted + /// . + /// + /// The provided password, unencrypted. + /// The existing, encrypted password. + /// + /// if hash comparison succeeds, if it fails. + /// + public static bool CompareHashedPassword(string providedPassword, string existingPassword) + { + throw new NotImplementedException(); + } + + /// Hashes an unencrypted password. + /// The password. + /// The hashed password. + public static string HashPassword(string password) + { + throw new NotImplementedException(); + } + + /// + /// Produces a SHA256 hash from a given + /// . + /// + /// The value. + /// + /// A byte array equal to the SHA256 hash of or an empty array if it + /// fails. + /// + public static byte[] SHA256Hash(string value) + { + try + { + using (var hash = new SHA256Managed()) + { + var bytes = Encoding.Unicode.GetBytes(value + SALT); + var encrypted = hash.ComputeHash(bytes); + return encrypted; + } + } + catch (Exception ex) + { + CapyEventReporter.EmitEvent(EventLevel.Error, "Could not hash the given value {0}.", args: new[] { value }); + } + + return new byte[0]; + } + + public static string Pbkdf2(string password, out byte[] salt) + { + throw new NotImplementedException(); + } + + /// Gets a cryptographically strong random password. + /// The length of the password to generate. + /// The password. + public static string GetRandomPassword(int length) + { + return GetRandomString(length); + } + + /// Gets a calendar key that is 32 characters long. + /// The calendar key. + public static string GetCalendarKey() + { + return GetRandomString(32); + } + + /// Compares two session identifiers. + /// The first session identifier. + /// The second session identifier. + /// + /// if comparison succeeds, if not. + /// + public static bool CompareSessionID(string first, string second) + { + if (string.IsNullOrEmpty(first) || string.IsNullOrEmpty(second)) + { + return CompareStrings(first, second); + } + return CompareStrings(first.Trim(), second.Trim()); + } + + /// Gets a cryptographically strong random string using the character values found in . + /// The length of the string to create. + /// The random string. + private static string GetRandomString(int length) + { + throw new NotImplementedException(); + //var buffer = new StringBuilder(); + //while (buffer.Length < length) + //{ + // var oneByte = new byte[1]; + // RandomNumberGenerator.GetBytes(oneByte); + // var character = (char)oneByte[0]; + // if (VALID_CHARACTERS.Contains(character)) + // { + // buffer.Append(character); + // } + //} + + //return buffer.ToString(); + } + + /// Compare two strings as case sensative. + /// The first string. + /// The second string. + /// + /// if the comparison succeeds, if not. + /// + /// + /// This method is a proxy for using + /// with the + /// StringComparison set to . + /// + private static bool CompareStrings(string first, string second) + { + return string.Compare(first, second, StringComparison.Ordinal) == 0; + } + + #endregion Methods + } +} diff --git a/CapyKit/Password.cs b/CapyKit/Password.cs new file mode 100644 index 0000000..57f4836 --- /dev/null +++ b/CapyKit/Password.cs @@ -0,0 +1,217 @@ +using System; +using System.Collections.Generic; +using System.Data.SqlTypes; +using System.Linq; +using System.Reflection.Metadata.Ecma335; +using System.Security.Cryptography; +using System.Text; +using System.Threading.Tasks; + +namespace CapyKit +{ + /// + /// Represents a password with its hash, salt and algorithm used for encryption. + /// + public class Password + { + #region Members + + // + + #endregion + + #region Properties + + /// + /// Gets or sets the hash of the password. + /// + public byte[] Hash { get; private set; } + + /// + /// Gets or sets the salt used for encryption. + /// + public byte[] Salt { get; private set; } + + /// + /// Gets or sets the algorithm used for password encryption. + /// + public IPasswordAlgorithm Algorithm { get; private set; } + + #endregion + + /// Constructor. + /// The password to be hashed. + /// The salt used for encryption. + /// The algorithm used for password encryption. + /// A variable-length parameters list containing arguments to include for the . + internal Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args) + { + // We know there will always be a salt, so we can prepend it to h + var augmented = args.Prepend(salt).ToArray(); + + this.Hash = algorithm.Encrypt(password, augmented); + this.Salt = salt; + this.Algorithm = algorithm; + } + + #region Methods + + /// + public override string ToString() + { + return string.Format("Hash: {0}, Salt: {1}, Algorithm: {2}", BitConverter.ToString(this.Hash), BitConverter.ToString(this.Salt), this.Algorithm?.AlgorithmName); + } + + #endregion + } + + /// + /// Defines the contract for password encryption algorithms. + /// + public interface IPasswordAlgorithm + { + #region Properties + + /// + /// Gets the name of the algorithm. + /// + string AlgorithmName { get; } + + #endregion + + #region Methods + + /// Encrypts the given password using a defined algorithm. + /// The plaintext password. + /// + /// Additional arguments for the encryption process, such as salt and length. + /// + /// A byte array with the hashed . + byte[] Encrypt(string password, params object[] args); + + /// + /// Compares the given plaintext password with an encrypted value using PBKDF2 algorithm. + /// + /// The plaintext password to compare. + /// The encrypted value to compare against. + /// + /// Additional arguments for the encryption process, such as salt and length. + /// + /// + /// True if the given matches the , + /// false if they are different. + /// + bool Compare(string password, byte[] encryptedValue, params object[] args) + { + var challengedPassword = Encrypt(password, args); + + return encryptedValue.SequenceEqual(challengedPassword); + } + + #endregion + } + + #region Implementations + + /// + /// Implements the PBKDF2 algorithm for password encryption. + /// + public class Pbkdf2Algorithm : IPasswordAlgorithm + { + #region Members + + /// (Immutable) The default length. + /// This member is immutable. + public const int LENGTH = 32; + + /// The default number of iterations. + /// This member is immutable. + public const int ITERATIONS = 100000; + + #endregion + + #region Properties + + /// + public string AlgorithmName + { + get + { + return "Pbkdf2"; + } + } + + #endregion + + #region Methods + + /// Encrypts the given password using a PBKDF2 algorithm. + /// The plaintext password. + /// + /// Additional arguments for the encryption process, specifically + /// + /// salt + /// length + /// iterations + /// + /// + /// A byte array with the hashed . + public byte[] Encrypt(string password, params object[] args) + { + if (args.Length == 0) + { + CapyEventReporter.EmitEvent(EventLevel.Error, "No arguments passed."); + return new byte[0]; + } + + var salt = args[0] as byte[]; + + if (salt == null) + { + CapyEventReporter.EmitEvent(EventLevel.Error, "The first parameters in the arguments wasn't a valid salt."); + return new byte[0]; + } + + var length = 0; + try + { + length = Convert.ToInt32(args[1]); + } + catch (Exception ex) + { + CapyEventReporter.EmitEvent(EventLevel.Error, "Could not convert the second parameter into an integer."); + length = LENGTH; + } + + var iterations = 0; + try + { + iterations = Convert.ToInt32(args[2]); + } + catch (Exception ex) + { + CapyEventReporter.EmitEvent(EventLevel.Error, "Could not convert the second parameter into an integer."); + iterations = ITERATIONS; + } + + var hash = new byte[0]; + + using (var deriveBytes = new Rfc2898DeriveBytes(password, salt, iterations, HashAlgorithmName.SHA256)) + { + hash = deriveBytes.GetBytes(length); + } + + if (hash.Length == 0) + { + CapyEventReporter.EmitEvent(EventLevel.Error, "Hash could not be generated."); + return new byte[0]; + } + + return hash; + } + + #endregion + } + + #endregion +} diff --git a/Documentation/Content/VersionHistory/VersionHistory.aml b/Documentation/Content/VersionHistory/VersionHistory.aml new file mode 100644 index 0000000..c11cbf3 --- /dev/null +++ b/Documentation/Content/VersionHistory/VersionHistory.aml @@ -0,0 +1,33 @@ + + + + + The topics in this section describe the various changes made to the [TODO: Project Title] over the +life of the project. + + +
+ Version History + + Select a version below to see a description of its changes. + + + + + + + + [TODO: Add links to each specific version page] + + + + + +
+ + + + + + + diff --git a/Documentation/Content/VersionHistory/v1.0.0.0.aml b/Documentation/Content/VersionHistory/v1.0.0.0.aml new file mode 100644 index 0000000..2f49a8c --- /dev/null +++ b/Documentation/Content/VersionHistory/v1.0.0.0.aml @@ -0,0 +1,28 @@ + + + + + Version [TODO: Version] was released on [TODO: Date]. + + + +
+ Changes in This Release + + + + + [TODO: Add change items here] + + + + + +
+ + + + + + + diff --git a/Documentation/Content/Welcome.aml b/Documentation/Content/Welcome.aml new file mode 100644 index 0000000..59bfe8b --- /dev/null +++ b/Documentation/Content/Welcome.aml @@ -0,0 +1,55 @@ + + + + + This is a sample conceptual topic. You can use this as a starting point for adding more conceptual +content to your help project. + + +
+ Getting Started + + To get started, add a documentation source to the project (a Visual Studio solution, project, or +assembly and XML comments file). See the Getting Started topics in the Sandcastle Help +File Builder's help file for more information. The following default items are included in this project: + + + + ContentLayout.content - Use the content layout file to manage the +conceptual content in the project and define its layout in the table of contents. + + + + The .\media folder - Place images in this folder that you will reference +from conceptual content using medialLink or mediaLinkInline +elements. If you will not have any images in the file, you may remove this folder. + + + + The .\icons folder - This contains a default logo for the help file. You +may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update +the Transform Args project properties page by removing or changing the filename in the +logoFile transform argument. Note that unlike images referenced from conceptual topics, +the logo file should have its BuildAction property set to Content. + + + + The .\Content folder - Use this to store your conceptual topics. You may +name the files and organize them however you like. One suggestion is to lay the files out on disk as you have +them in the content layout file as shown in this project but the choice is yours. Files can be added via the +Solution Explorer or from within the content layout file editor. Files must appear in the content layout file +in order to be compiled into the help file. + + + + See the Conceptual Content topics in the Sandcastle Help File Builder's +help file for more information. See the Sandcastle MAML Guide for details on Microsoft +Assistance Markup Language (MAML) which is used to create these topics. + +
+ + + + + + diff --git a/Documentation/ContentLayout.content b/Documentation/ContentLayout.content new file mode 100644 index 0000000..bb476cf --- /dev/null +++ b/Documentation/ContentLayout.content @@ -0,0 +1,18 @@ + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj new file mode 100644 index 0000000..9dafa14 --- /dev/null +++ b/Documentation/Documentation.shfbproj @@ -0,0 +1,103 @@ + + + + + + + v4.7.2 + + Debug + AnyCPU + 2.0 + e23d3844-e594-487e-979b-2d35b1b9aae8 + 2017.9.26.0 + + Documentation + Documentation + Documentation + + .NET Framework 4.7.2 + .\Help\ + Documentation + en-US + + + + + + + + + + Markdown + Standard + Markdown + True + True + False + False + OnlyWarningsAndErrors + 100 + + + + CapyKit + 1.0.0.0 + MemberName + AboveNamespaces + False + False + 2 + False + Blank + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + OnBuildSuccess + + \ No newline at end of file diff --git a/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md b/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md new file mode 100644 index 0000000..c7980ce --- /dev/null +++ b/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md @@ -0,0 +1,17 @@ +# Version History + +The topics in this section describe the various changes made to the [TODO: Project Title] over the life of the project. + + +## Version History + +Select a version below to see a description of its changes. + + + + +## See Also + + +#### Other Resources +Welcome to the [TODO: Add project name] diff --git a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md new file mode 100644 index 0000000..cfe3f69 --- /dev/null +++ b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md @@ -0,0 +1,27 @@ +# Welcome to the [TODO: Add project name] + +This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. + + +## Getting Started + +To get started, add a documentation source to the project (a Visual Studio solution, project, or assembly and XML comments file). See the **Getting Started** topics in the Sandcastle Help File Builder's help file for more information. The following default items are included in this project: +

  • ContentLayout.content - Use the content layout file to manage the conceptual content in the project and define its layout in the table of contents.

  • + +The .\media folder - Place images in this folder that you will reference from conceptual content using medialLink or mediaLinkInline elements. If you will not have any images in the file, you may remove this folder.

  • + +The .\icons folder - This contains a default logo for the help file. You may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update the Transform Args project properties page by removing or changing the filename in the logoFile transform argument. Note that unlike images referenced from conceptual topics, the logo file should have its BuildAction property set to Content.

  • + +The .\Content folder - Use this to store your conceptual topics. You may name the files and organize them however you like. One suggestion is to lay the files out on disk as you have them in the content layout file as shown in this project but the choice is yours. Files can be added via the Solution Explorer or from within the content layout file editor. Files must appear in the content layout file in order to be compiled into the help file.

+ + + + +See the **Conceptual Content** topics in the Sandcastle Help File Builder's help file for more information. See the **Sandcastle MAML Guide** for details on Microsoft Assistance Markup Language (MAML) which is used to create these topics. + + +## See Also + + +#### Other Resources +Version History diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md new file mode 100644 index 0000000..0e51d91 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md @@ -0,0 +1,43 @@ +# ITERATIONS Field + + +The default number of iterations. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public const int ITERATIONS = 100000 +``` +**VB** +``` VB +Public Const ITERATIONS As Integer = 100000 +``` +**C++** +``` C++ +public: +literal int ITERATIONS = 100000 +``` +**F#** +``` F# +static val mutable ITERATIONS: int +``` + + + +#### Field Value +Int32 + +## Remarks +This member is immutable. + +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md new file mode 100644 index 0000000..bcffc59 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md @@ -0,0 +1,43 @@ +# LENGTH Field + + +(Immutable) The default length. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public const int LENGTH = 32 +``` +**VB** +``` VB +Public Const LENGTH As Integer = 32 +``` +**C++** +``` C++ +public: +literal int LENGTH = 32 +``` +**F#** +``` F# +static val mutable LENGTH: int +``` + + + +#### Field Value +Int32 + +## Remarks +This member is immutable. + +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md new file mode 100644 index 0000000..3932c5f --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md @@ -0,0 +1,21 @@ +# Pbkdf2Algorithm Fields + + + + +## Fields + + + + + + + +
ITERATIONSThe default number of iterations.
LENGTH(Immutable) The default length.
+ +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Home.md b/Documentation/Help/Home.md new file mode 100644 index 0000000..cfe3f69 --- /dev/null +++ b/Documentation/Help/Home.md @@ -0,0 +1,27 @@ +# Welcome to the [TODO: Add project name] + +This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. + + +## Getting Started + +To get started, add a documentation source to the project (a Visual Studio solution, project, or assembly and XML comments file). See the **Getting Started** topics in the Sandcastle Help File Builder's help file for more information. The following default items are included in this project: +

  • ContentLayout.content - Use the content layout file to manage the conceptual content in the project and define its layout in the table of contents.

  • + +The .\media folder - Place images in this folder that you will reference from conceptual content using medialLink or mediaLinkInline elements. If you will not have any images in the file, you may remove this folder.

  • + +The .\icons folder - This contains a default logo for the help file. You may replace it or remove it and the folder if not wanted. If removed or if you change the file name, update the Transform Args project properties page by removing or changing the filename in the logoFile transform argument. Note that unlike images referenced from conceptual topics, the logo file should have its BuildAction property set to Content.

  • + +The .\Content folder - Use this to store your conceptual topics. You may name the files and organize them however you like. One suggestion is to lay the files out on disk as you have them in the content layout file as shown in this project but the choice is yours. Files can be added via the Solution Explorer or from within the content layout file editor. Files must appear in the content layout file in order to be compiled into the help file.

+ + + + +See the **Conceptual Content** topics in the Sandcastle Help File Builder's help file for more information. See the **Sandcastle MAML Guide** for details on Microsoft Assistance Markup Language (MAML) which is used to create these topics. + + +## See Also + + +#### Other Resources +Version History diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md new file mode 100644 index 0000000..2e50d70 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md @@ -0,0 +1,47 @@ +# EnumerationAttribute<T> Constructor + + +Gets the value of the enumeration represented by this attribute. + + + +## Definition +**Namespace:** CapyKit.Attributes +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +protected EnumerationAttribute( + T value +) +``` +**VB** +``` VB +Protected Sub New ( + value As T +) +``` +**C++** +``` C++ +protected: +EnumerationAttribute( + T value +) +``` +**F#** +``` F# +new : + value : 'T -> EnumerationAttribute +``` + + + +#### Parameters +
  T
Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
+ +## See Also + + +#### Reference +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md new file mode 100644 index 0000000..7bfd760 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md @@ -0,0 +1,47 @@ +# EnumerationDescriptionAttribute Constructor + + +Initializes a new instance of the EnumerationDescriptionAttribute class with the specified description. + + + +## Definition +**Namespace:** CapyKit.Attributes +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public EnumerationDescriptionAttribute( + string description +) +``` +**VB** +``` VB +Public Sub New ( + description As String +) +``` +**C++** +``` C++ +public: +EnumerationDescriptionAttribute( + String^ description +) +``` +**F#** +``` F# +new : + description : string -> EnumerationDescriptionAttribute +``` + + + +#### Parameters +
  String
The description of the enumeration value.
+ +## See Also + + +#### Reference +EnumerationDescriptionAttribute Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md new file mode 100644 index 0000000..02d4d93 --- /dev/null +++ b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md @@ -0,0 +1,59 @@ +# CapyEventArgs Constructor + + +Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public CapyEventArgs( + EventLevel level, + string message, + string method = null +) +``` +**VB** +``` VB +Public Sub New ( + level As EventLevel, + message As String, + Optional method As String = Nothing +) +``` +**C++** +``` C++ +public: +CapyEventArgs( + EventLevel level, + String^ message, + String^ method = nullptr +) +``` +**F#** +``` F# +new : + level : EventLevel * + message : string * + ?method : string +(* Defaults: + let _method = defaultArg method null +*) +-> CapyEventArgs +``` + + + +#### Parameters +
  EventLevel
The severity level of the event.
  String
A descriptive message explaining the reason for the event.
  String  (Optional)
The name of the method where the event was raised.
+ +## See Also + + +#### Reference +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md new file mode 100644 index 0000000..eba0460 --- /dev/null +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md @@ -0,0 +1,62 @@ +# Subscribe Method + + +Subscribes the specified event handler to the event with the given subscription level and origin. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static void Subscribe( + CapyEventHandler callback, + EventLevel subscriptionLevel, + string origin = null +) +``` +**VB** +``` VB +Public Shared Sub Subscribe ( + callback As CapyEventHandler, + subscriptionLevel As EventLevel, + Optional origin As String = Nothing +) +``` +**C++** +``` C++ +public: +static void Subscribe( + CapyEventHandler^ callback, + EventLevel subscriptionLevel, + String^ origin = nullptr +) +``` +**F#** +``` F# +static member Subscribe : + callback : CapyEventHandler * + subscriptionLevel : EventLevel * + ?origin : string +(* Defaults: + let _origin = defaultArg origin null +*) +-> unit +``` + + + +#### Parameters +
  CapyEventHandler
The event handler to subscribe.
  EventLevel
The severity level of the event to subscribe to.
  String  (Optional)
(Optional) The name of the method or class where the subscription is made.
+ +## Remarks +If there is no existing list for the given subscription level, a new list is created and added to the dictionary. + +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md new file mode 100644 index 0000000..8a9e181 --- /dev/null +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md @@ -0,0 +1,51 @@ +# Unsubscribe Method + + +Unsubscribes the specified event handler from the event with the given origin. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static void Unsubscribe( + CapyEventHandler callback, + string origin +) +``` +**VB** +``` VB +Public Shared Sub Unsubscribe ( + callback As CapyEventHandler, + origin As String +) +``` +**C++** +``` C++ +public: +static void Unsubscribe( + CapyEventHandler^ callback, + String^ origin +) +``` +**F#** +``` F# +static member Unsubscribe : + callback : CapyEventHandler * + origin : string -> unit +``` + + + +#### Parameters +
  CapyEventHandler
The event handler to unsubscribe.
  String
The name of the method or class where the subscription was made.
+ +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md new file mode 100644 index 0000000..8d3759c --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md @@ -0,0 +1,61 @@ +# GetDescription Method + + +An Enum extension method that gets a description. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string GetDescription( + this Enum enumeration +) +``` +**VB** +``` VB + +Public Shared Function GetDescription ( + enumeration As Enum +) As String +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +static String^ GetDescription( + Enum^ enumeration +) +``` +**F#** +``` F# +[] +static member GetDescription : + enumeration : Enum -> string +``` + + + +#### Parameters +
  Enum
The enumeration to act on.
+ +#### Return Value +String +The description if available, otherwise the string representation of the enumeration. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md new file mode 100644 index 0000000..61097de --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md @@ -0,0 +1,61 @@ +# GetName Method + + +An Enum extension method that gets a name. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string GetName( + this Enum enumeration +) +``` +**VB** +``` VB + +Public Shared Function GetName ( + enumeration As Enum +) As String +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +static String^ GetName( + Enum^ enumeration +) +``` +**F#** +``` F# +[] +static member GetName : + enumeration : Enum -> string +``` + + + +#### Parameters +
  Enum
The enumeration to act on.
+ +#### Return Value +String +The name of the enumeration. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md new file mode 100644 index 0000000..bc6008d --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md @@ -0,0 +1,61 @@ +# GetPrettyName Method + + +An Enum extension method that gets a human readable name. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string GetPrettyName( + this Enum enumeration +) +``` +**VB** +``` VB + +Public Shared Function GetPrettyName ( + enumeration As Enum +) As String +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +static String^ GetPrettyName( + Enum^ enumeration +) +``` +**F#** +``` F# +[] +static member GetPrettyName : + enumeration : Enum -> string +``` + + + +#### Parameters +
  Enum
The enumeration to act on.
+ +#### Return Value +String +The human readable name of the enumeration. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md new file mode 100644 index 0000000..b4c1242 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md @@ -0,0 +1,61 @@ +# GetValue Method + + +An Enum extension method that gets an integer value representing the enumation. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static int GetValue( + this Enum enumeration +) +``` +**VB** +``` VB + +Public Shared Function GetValue ( + enumeration As Enum +) As Integer +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +static int GetValue( + Enum^ enumeration +) +``` +**F#** +``` F# +[] +static member GetValue : + enumeration : Enum -> int +``` + + + +#### Parameters +
  Enum
The enumeration to act on.
+ +#### Return Value +Int32 +The integer value of the enumeration. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md new file mode 100644 index 0000000..477b2fb --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md @@ -0,0 +1,73 @@ +# Parse<T>(T, String) Method + + +A *T* extension method that parses a string into an enumeration. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Parse( + this T enumeration, + string value +) +where T : Enum + +``` +**VB** +``` VB + +Public Shared Function Parse(Of T As Enum) ( + enumeration As T, + value As String +) As T +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +where T : Enum +static T Parse( + T enumeration, + String^ value +) +``` +**F#** +``` F# +[] +static member Parse : + enumeration : 'T * + value : string -> 'T when 'T : Enum +``` + + + +#### Parameters +
  T
The enumeration to act on.
  String
The value.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A T. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +EnumerationExtensions Class +Parse Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md new file mode 100644 index 0000000..be67197 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md @@ -0,0 +1,77 @@ +# Parse<T>(T, String, Boolean) Method + + +A *T* extension method that parses a string into an enumeration. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Parse( + this T enumeration, + string value, + bool ignoreCase +) +where T : Enum + +``` +**VB** +``` VB + +Public Shared Function Parse(Of T As Enum) ( + enumeration As T, + value As String, + ignoreCase As Boolean +) As T +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +where T : Enum +static T Parse( + T enumeration, + String^ value, + bool ignoreCase +) +``` +**F#** +``` F# +[] +static member Parse : + enumeration : 'T * + value : string * + ignoreCase : bool -> 'T when 'T : Enum +``` + + + +#### Parameters +
  T
The enumeration to act on.
  String
The string value of the Enum.
  Boolean
True to ignore case.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A T. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +EnumerationExtensions Class +Parse Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md new file mode 100644 index 0000000..481a8c5 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md @@ -0,0 +1,70 @@ +# Distinct<T, U> Method + + +Enumerates distinct items in this collection as defined by the key *property*. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IEnumerable Distinct( + this IEnumerable items, + Func property +) + +``` +**VB** +``` VB + +Public Shared Function Distinct(Of T, U) ( + items As IEnumerable(Of T), + property As Func(Of T, U) +) As IEnumerable(Of T) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IEnumerable^ Distinct( + IEnumerable^ items, + Func^ property +) +``` +**F#** +``` F# +[] +static member Distinct : + items : IEnumerable<'T> * + property : Func<'T, 'U> -> IEnumerable<'T> +``` + + + +#### Parameters +
  IEnumerable(T)
The items to act on.
  Func(T, U)
The property.
+ +#### Type Parameters +
Generic type parameter of the parent object.
Generic type parameter property value.
+ +#### Return Value +IEnumerable(T) +An enumerator that allows foreach to be used to process distinct items in this collection. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md new file mode 100644 index 0000000..d760ff4 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md @@ -0,0 +1,71 @@ +# Filter<T>(IEnumerable<T>, Func<T, Boolean>) Method + + +Filters out items matching a *predicate* from the collection. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IEnumerable Filter( + this IEnumerable source, + Func predicate +) + +``` +**VB** +``` VB + +Public Shared Function Filter(Of T) ( + source As IEnumerable(Of T), + predicate As Func(Of T, Boolean) +) As IEnumerable(Of T) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IEnumerable^ Filter( + IEnumerable^ source, + Func^ predicate +) +``` +**F#** +``` F# +[] +static member Filter : + source : IEnumerable<'T> * + predicate : Func<'T, bool> -> IEnumerable<'T> +``` + + + +#### Parameters +
  IEnumerable(T)
The source to act on.
  Func(T, Boolean)
The predicate.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +IEnumerable(T) +An enumerator that allows foreach to be used to process remove in this collection. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +LINQExtensions Class +Filter Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md new file mode 100644 index 0000000..9332331 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md @@ -0,0 +1,71 @@ +# Filter<T>(IQueryable<T>, Expression<Func<T, Boolean>>) Method + + +Filters out items matching a *predicate* from the collection. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IQueryable Filter( + this IQueryable source, + Expression> predicate +) + +``` +**VB** +``` VB + +Public Shared Function Filter(Of T) ( + source As IQueryable(Of T), + predicate As Expression(Of Func(Of T, Boolean)) +) As IQueryable(Of T) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IQueryable^ Filter( + IQueryable^ source, + Expression^>^ predicate +) +``` +**F#** +``` F# +[] +static member Filter : + source : IQueryable<'T> * + predicate : Expression> -> IQueryable<'T> +``` + + + +#### Parameters +
  IQueryable(T)
The source to act on.
  Expression(Func(T, Boolean))
The predicate.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +IQueryable(T) +An enumerator that allows foreach to be used to process remove in this collection. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +LINQExtensions Class +Filter Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md new file mode 100644 index 0000000..acf2426 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md @@ -0,0 +1,91 @@ +# LeftOuterJoin<T, U, TKey, R>(IEnumerable<T>, IEnumerable<U>, Func<T, TKey>, Func<U, TKey>, Func<T, IEnumerable<U>, R>, Func<T, U>) Method + + +An IEnumable<T> extension method that left outer join. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IEnumerable LeftOuterJoin( + this IEnumerable source, + IEnumerable inner, + Func outerSelector, + Func innerSelector, + Func, R> resultSelector, + Func defaultGenerator = null +) + +``` +**VB** +``` VB + +Public Shared Function LeftOuterJoin(Of T, U, TKey, R) ( + source As IEnumerable(Of T), + inner As IEnumerable(Of U), + outerSelector As Func(Of T, TKey), + innerSelector As Func(Of U, TKey), + resultSelector As Func(Of T, IEnumerable(Of U), R), + Optional defaultGenerator As Func(Of T, U) = Nothing +) As IEnumerable(Of R) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IEnumerable^ LeftOuterJoin( + IEnumerable^ source, + IEnumerable^ inner, + Func^ outerSelector, + Func^ innerSelector, + Func^, R>^ resultSelector, + Func^ defaultGenerator = nullptr +) +``` +**F#** +``` F# +[] +static member LeftOuterJoin : + source : IEnumerable<'T> * + inner : IEnumerable<'U> * + outerSelector : Func<'T, 'TKey> * + innerSelector : Func<'U, 'TKey> * + resultSelector : Func<'T, IEnumerable<'U>, 'R> * + ?defaultGenerator : Func<'T, 'U> +(* Defaults: + let _defaultGenerator = defaultArg defaultGenerator null +*) +-> IEnumerable<'R> +``` + + + +#### Parameters +
  IEnumerable(T)
The source to act on.
  IEnumerable(U)
The inner.
  Func(T, TKey)
The outer selector.
  Func(U, TKey)
The inner selector.
  Func(T, IEnumerable(U), R)
The result selector.
  Func(T, U)  (Optional)
(Optional) The default generator.
+ +#### Type Parameters +
Generic type parameter.
Generic type parameter.
Type of the key.
Type of the r.
+ +#### Return Value +IEnumerable(R) +An enumerator that allows foreach to be used to process left outter join in this collection. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +LINQExtensions Class +LeftOuterJoin Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md new file mode 100644 index 0000000..a1c3613 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md @@ -0,0 +1,91 @@ +# LeftOuterJoin<T, U, TKey, R>(IQueryable<T>, IQueryable<U>, Expression<Func<T, TKey>>, Expression<Func<U, TKey>>, Func<T, IEnumerable<U>, R>, Func<T, U>) Method + + +An IQueryable<T> extension method that left outer join. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IQueryable LeftOuterJoin( + this IQueryable source, + IQueryable inner, + Expression> outerSelector, + Expression> innerSelector, + Func, R> resultSelector, + Func defaultGenerator = null +) + +``` +**VB** +``` VB + +Public Shared Function LeftOuterJoin(Of T, U, TKey, R) ( + source As IQueryable(Of T), + inner As IQueryable(Of U), + outerSelector As Expression(Of Func(Of T, TKey)), + innerSelector As Expression(Of Func(Of U, TKey)), + resultSelector As Func(Of T, IEnumerable(Of U), R), + Optional defaultGenerator As Func(Of T, U) = Nothing +) As IQueryable(Of R) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IQueryable^ LeftOuterJoin( + IQueryable^ source, + IQueryable^ inner, + Expression^>^ outerSelector, + Expression^>^ innerSelector, + Func^, R>^ resultSelector, + Func^ defaultGenerator = nullptr +) +``` +**F#** +``` F# +[] +static member LeftOuterJoin : + source : IQueryable<'T> * + inner : IQueryable<'U> * + outerSelector : Expression> * + innerSelector : Expression> * + resultSelector : Func<'T, IEnumerable<'U>, 'R> * + ?defaultGenerator : Func<'T, 'U> +(* Defaults: + let _defaultGenerator = defaultArg defaultGenerator null +*) +-> IQueryable<'R> +``` + + + +#### Parameters +
  IQueryable(T)
The source to act on.
  IQueryable(U)
The inner.
  Expression(Func(T, TKey))
The outer selector.
  Expression(Func(U, TKey))
The inner selector.
  Func(T, IEnumerable(U), R)
The result selector.
  Func(T, U)  (Optional)
(Optional) The default generator.
+ +#### Type Parameters +
Generic type parameter.
Generic type parameter.
Type of the key.
Type of the r.
+ +#### Return Value +IQueryable(R) +An IQueryable<R> + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +LINQExtensions Class +LeftOuterJoin Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md new file mode 100644 index 0000000..f23ff20 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md @@ -0,0 +1,78 @@ +# PageCount<T>(IEnumerable<T>, Int32) Method + + +The number of pages of *pageSize* size in the given collection. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static int PageCount( + this IEnumerable source, + int pageSize +) + +``` +**VB** +``` VB + +Public Shared Function PageCount(Of T) ( + source As IEnumerable(Of T), + pageSize As Integer +) As Integer +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static int PageCount( + IEnumerable^ source, + int pageSize +) +``` +**F#** +``` F# +[] +static member PageCount : + source : IEnumerable<'T> * + pageSize : int -> int +``` + + + +#### Parameters +
  IEnumerable(T)
The source to act on.
  Int32
Size of the page.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +Int32 +An int. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## Exceptions + + + + +
ArgumentOutOfRangeExceptionThrown when pageSize is less than 1.
+ +## See Also + + +#### Reference +LINQExtensions Class +PageCount Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md new file mode 100644 index 0000000..798fe1e --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md @@ -0,0 +1,78 @@ +# PageCount<T>(IQueryable<T>, Int32) Method + + +The number of pages of *pageSize* size in the given collection. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static int PageCount( + this IQueryable source, + int pageSize +) + +``` +**VB** +``` VB + +Public Shared Function PageCount(Of T) ( + source As IQueryable(Of T), + pageSize As Integer +) As Integer +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static int PageCount( + IQueryable^ source, + int pageSize +) +``` +**F#** +``` F# +[] +static member PageCount : + source : IQueryable<'T> * + pageSize : int -> int +``` + + + +#### Parameters +
  IQueryable(T)
The source to act on.
  Int32
Size of the page.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +Int32 +An int. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## Exceptions + + + + +
ArgumentOutOfRangeExceptionThrown when pageSize is less than 1.
+ +## See Also + + +#### Reference +LINQExtensions Class +PageCount Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md new file mode 100644 index 0000000..c62cb5b --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md @@ -0,0 +1,85 @@ +# Page<T>(IEnumerable<T>, Int32, Int32) Method + + +Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* items per page. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IEnumerable Page( + this IEnumerable source, + int pageNumber, + int pageSize +) + +``` +**VB** +``` VB + +Public Shared Function Page(Of T) ( + source As IEnumerable(Of T), + pageNumber As Integer, + pageSize As Integer +) As IEnumerable(Of T) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IEnumerable^ Page( + IEnumerable^ source, + int pageNumber, + int pageSize +) +``` +**F#** +``` F# +[] +static member Page : + source : IEnumerable<'T> * + pageNumber : int * + pageSize : int -> IEnumerable<'T> +``` + + + +#### Parameters +
  IEnumerable(T)
The source to act on.
  Int32
The page number to retrieve.
  Int32
Number of items per page.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +IEnumerable(T) +An enumerator that allows foreach to be used to process page in this collection. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## Remarks +This method uses natural numbering starting at page 1. + +## Exceptions + + + + +
ArgumentOutOfRangeExceptionThrown when pageNumber is less than 1 or if pageSize is less than 1.
+ +## See Also + + +#### Reference +LINQExtensions Class +Page Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md new file mode 100644 index 0000000..a93ed86 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md @@ -0,0 +1,85 @@ +# Page<T>(IQueryable<T>, Int32, Int32) Method + + +Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* items per page. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static IQueryable Page( + this IQueryable source, + int pageNumber, + int pageSize +) + +``` +**VB** +``` VB + +Public Shared Function Page(Of T) ( + source As IQueryable(Of T), + pageNumber As Integer, + pageSize As Integer +) As IQueryable(Of T) +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +generic +static IQueryable^ Page( + IQueryable^ source, + int pageNumber, + int pageSize +) +``` +**F#** +``` F# +[] +static member Page : + source : IQueryable<'T> * + pageNumber : int * + pageSize : int -> IQueryable<'T> +``` + + + +#### Parameters +
  IQueryable(T)
The source to act on.
  Int32
The page number to retrieve.
  Int32
.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +IQueryable(T) +An enumerator that allows foreach to be used to process page in this collection. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## Remarks +This method uses natural numbering starting at page 1. + +## Exceptions + + + + +
ArgumentOutOfRangeExceptionThrown when pageNumber is less than 1 or if pageSize is less than 1.
+ +## See Also + + +#### Reference +LINQExtensions Class +Page Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md new file mode 100644 index 0000000..66c640c --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md @@ -0,0 +1,66 @@ +# IfNullOrEmpty Method + + +Replaces a null or empty string with a specified replacement string. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string IfNullOrEmpty( + this string value, + string replacement +) +``` +**VB** +``` VB + +Public Shared Function IfNullOrEmpty ( + value As String, + replacement As String +) As String +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +static String^ IfNullOrEmpty( + String^ value, + String^ replacement +) +``` +**F#** +``` F# +[] +static member IfNullOrEmpty : + value : string * + replacement : string -> string +``` + + + +#### Parameters +
  String
The original string.
  String
The replacement string.
+ +#### Return Value +String +The original string if not null or empty, otherwise the replacement string. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +StringExtensions Class +CapyKit.Extensions Namespace +IsNullOrEmpty(String) diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md new file mode 100644 index 0000000..7bd277c --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md @@ -0,0 +1,66 @@ +# IfNullOrWhiteSpace Method + + +Replaces a null or whitespace string with a specified replacement string. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string IfNullOrWhiteSpace( + this string value, + string replacement +) +``` +**VB** +``` VB + +Public Shared Function IfNullOrWhiteSpace ( + value As String, + replacement As String +) As String +``` +**C++** +``` C++ +public: +[ExtensionAttribute] +static String^ IfNullOrWhiteSpace( + String^ value, + String^ replacement +) +``` +**F#** +``` F# +[] +static member IfNullOrWhiteSpace : + value : string * + replacement : string -> string +``` + + + +#### Parameters +
  String
The original string.
  String
The replacement string.
+ +#### Return Value +String +The original string if not null or whitespace, otherwise the replacement string. + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +StringExtensions Class +CapyKit.Extensions Namespace +IsNullOrWhiteSpace(String) diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md new file mode 100644 index 0000000..7a40b45 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md @@ -0,0 +1,51 @@ +# Compress Method + + +Compresses a given object using the `gzip` algorithm. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static byte[] Compress( + Object obj +) +``` +**VB** +``` VB +Public Shared Function Compress ( + obj As Object +) As Byte() +``` +**C++** +``` C++ +public: +static array^ Compress( + Object^ obj +) +``` +**F#** +``` F# +static member Compress : + obj : Object -> byte[] +``` + + + +#### Parameters +
  Object
The object.
+ +#### Return Value +Byte[] +A byte array representing the compressed object in `gzip` format. + +## See Also + + +#### Reference +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md new file mode 100644 index 0000000..fe58803 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md @@ -0,0 +1,51 @@ +# CompressToString Method + + +Compresses a given object to a string using `base64` encoding of `gzip` format. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string CompressToString( + Object obj +) +``` +**VB** +``` VB +Public Shared Function CompressToString ( + obj As Object +) As String +``` +**C++** +``` C++ +public: +static String^ CompressToString( + Object^ obj +) +``` +**F#** +``` F# +static member CompressToString : + obj : Object -> string +``` + + + +#### Parameters +
  Object
The object.
+ +#### Return Value +String +A string in `base64` encoding. + +## See Also + + +#### Reference +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md new file mode 100644 index 0000000..84c1205 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md @@ -0,0 +1,51 @@ +# DecompressToString Method + + +Decompresses the given `base64` string in `gzip` format. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string DecompressToString( + string compressed +) +``` +**VB** +``` VB +Public Shared Function DecompressToString ( + compressed As String +) As String +``` +**C++** +``` C++ +public: +static String^ DecompressToString( + String^ compressed +) +``` +**F#** +``` F# +static member DecompressToString : + compressed : string -> string +``` + + + +#### Parameters +
  String
The compressed string.
+ +#### Return Value +String +A decomressed string. + +## See Also + + +#### Reference +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md new file mode 100644 index 0000000..3efbb5f --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md @@ -0,0 +1,57 @@ +# Decompress<T>(Byte[]) Method + + +Decompresses a given compressed `gzip` byte stream. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Decompress( + byte[] byteStream +) + +``` +**VB** +``` VB +Public Shared Function Decompress(Of T) ( + byteStream As Byte() +) As T +``` +**C++** +``` C++ +public: +generic +static T Decompress( + array^ byteStream +) +``` +**F#** +``` F# +static member Decompress : + byteStream : byte[] -> 'T +``` + + + +#### Parameters +
  Byte[]
The compressed byte stream.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A *T* typed object. + +## See Also + + +#### Reference +CompressionHelper Class +Decompress Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md new file mode 100644 index 0000000..dd3be02 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md @@ -0,0 +1,57 @@ +# Decompress<T>(String) Method + + +Decompresses a given `base64` encoded string of `gzip` format. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Decompress( + string encodedString +) + +``` +**VB** +``` VB +Public Shared Function Decompress(Of T) ( + encodedString As String +) As T +``` +**C++** +``` C++ +public: +generic +static T Decompress( + String^ encodedString +) +``` +**F#** +``` F# +static member Decompress : + encodedString : string -> 'T +``` + + + +#### Parameters +
  String
The base64 encoded gzip string.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A *T* typed object. + +## See Also + + +#### Reference +CompressionHelper Class +Decompress Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md new file mode 100644 index 0000000..3df4c56 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md @@ -0,0 +1,51 @@ +# CamelCaseToHumanReadable Method + + +Converts camel case text to human readable text. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string CamelCaseToHumanReadable( + string value +) +``` +**VB** +``` VB +Public Shared Function CamelCaseToHumanReadable ( + value As String +) As String +``` +**C++** +``` C++ +public: +static String^ CamelCaseToHumanReadable( + String^ value +) +``` +**F#** +``` F# +static member CamelCaseToHumanReadable : + value : string -> string +``` + + + +#### Parameters +
  String
The value.
+ +#### Return Value +String +A string in human readable format. + +## See Also + + +#### Reference +LanguageHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md new file mode 100644 index 0000000..b804f83 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md @@ -0,0 +1,37 @@ +# LanguageHelper Constructor + + +Initializes a new instance of the LanguageHelper class + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public LanguageHelper() +``` +**VB** +``` VB +Public Sub New +``` +**C++** +``` C++ +public: +LanguageHelper() +``` +**F#** +``` F# +new : unit -> LanguageHelper +``` + + + +## See Also + + +#### Reference +LanguageHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md new file mode 100644 index 0000000..36c352b --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md @@ -0,0 +1,55 @@ +# CompareHashedPassword Method + + +Compares an unencrypted *providedPassword* with a stored, encrypted *existingPassword*. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static bool CompareHashedPassword( + string providedPassword, + string existingPassword +) +``` +**VB** +``` VB +Public Shared Function CompareHashedPassword ( + providedPassword As String, + existingPassword As String +) As Boolean +``` +**C++** +``` C++ +public: +static bool CompareHashedPassword( + String^ providedPassword, + String^ existingPassword +) +``` +**F#** +``` F# +static member CompareHashedPassword : + providedPassword : string * + existingPassword : string -> bool +``` + + + +#### Parameters +
  String
The provided password, unencrypted.
  String
The existing, encrypted password.
+ +#### Return Value +Boolean +true if hash comparison succeeds, false if it fails. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md new file mode 100644 index 0000000..480f1eb --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md @@ -0,0 +1,55 @@ +# CompareSessionID Method + + +Compares two session identifiers. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static bool CompareSessionID( + string first, + string second +) +``` +**VB** +``` VB +Public Shared Function CompareSessionID ( + first As String, + second As String +) As Boolean +``` +**C++** +``` C++ +public: +static bool CompareSessionID( + String^ first, + String^ second +) +``` +**F#** +``` F# +static member CompareSessionID : + first : string * + second : string -> bool +``` + + + +#### Parameters +
  String
The first session identifier.
  String
The second session identifier.
+ +#### Return Value +Boolean +true if comparison succeeds, false if not. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md new file mode 100644 index 0000000..a2bc5d5 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetCalendarKey.md @@ -0,0 +1,41 @@ +# GetCalendarKey Method + + +Gets a calendar key that is `32` characters long. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string GetCalendarKey() +``` +**VB** +``` VB +Public Shared Function GetCalendarKey As String +``` +**C++** +``` C++ +public: +static String^ GetCalendarKey() +``` +**F#** +``` F# +static member GetCalendarKey : unit -> string +``` + + + +#### Return Value +String +The calendar key. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md new file mode 100644 index 0000000..f7f1922 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md @@ -0,0 +1,51 @@ +# GetRandomPassword Method + + +Gets a cryptographically strong random password. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string GetRandomPassword( + int length +) +``` +**VB** +``` VB +Public Shared Function GetRandomPassword ( + length As Integer +) As String +``` +**C++** +``` C++ +public: +static String^ GetRandomPassword( + int length +) +``` +**F#** +``` F# +static member GetRandomPassword : + length : int -> string +``` + + + +#### Parameters +
  Int32
The length of the password to generate.
+ +#### Return Value +String +The password. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md new file mode 100644 index 0000000..7f9078e --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md @@ -0,0 +1,51 @@ +# HashPassword Method + + +Hashes an unencrypted password. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string HashPassword( + string password +) +``` +**VB** +``` VB +Public Shared Function HashPassword ( + password As String +) As String +``` +**C++** +``` C++ +public: +static String^ HashPassword( + String^ password +) +``` +**F#** +``` F# +static member HashPassword : + password : string -> string +``` + + + +#### Parameters +
  String
The password.
+ +#### Return Value +String +The hashed password. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md new file mode 100644 index 0000000..450e58d --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -0,0 +1,55 @@ +# Pbkdf2 Method + + +\[Missing <summary> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\] + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string Pbkdf2( + string password, + out byte[] salt +) +``` +**VB** +``` VB +Public Shared Function Pbkdf2 ( + password As String, + ByRef salt As Byte() +) As String +``` +**C++** +``` C++ +public: +static String^ Pbkdf2( + String^ password, + [OutAttribute] array^% salt +) +``` +**F#** +``` F# +static member Pbkdf2 : + password : string * + salt : byte[] byref -> string +``` + + + +#### Parameters +
  String
\[Missing <param name="password"/> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\]
  Byte[]
\[Missing <param name="salt"/> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\]
+ +#### Return Value +String +\[Missing <returns> documentation for "M:CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[]@)"\] + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md new file mode 100644 index 0000000..a870023 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_SHA256Hash.md @@ -0,0 +1,51 @@ +# SHA256Hash Method + + +Produces a SHA256 hash from a given *value*. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static byte[] SHA256Hash( + string value +) +``` +**VB** +``` VB +Public Shared Function SHA256Hash ( + value As String +) As Byte() +``` +**C++** +``` C++ +public: +static array^ SHA256Hash( + String^ value +) +``` +**F#** +``` F# +static member SHA256Hash : + value : string -> byte[] +``` + + + +#### Parameters +
  String
The value.
+ +#### Return Value +Byte[] +A byte array equal to the SHA256 hash of *value* or an empty array if it fails. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md new file mode 100644 index 0000000..81655a4 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md @@ -0,0 +1,37 @@ +# SecurityHelper Constructor + + +Initializes a new instance of the SecurityHelper class + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public SecurityHelper() +``` +**VB** +``` VB +Public Sub New +``` +**C++** +``` C++ +public: +SecurityHelper() +``` +**F#** +``` F# +new : unit -> SecurityHelper +``` + + + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md new file mode 100644 index 0000000..8ad9c70 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md @@ -0,0 +1,64 @@ +# Deserialize<T>(Byte[]) Method + + +Deserializes an object to a given *T* type. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Deserialize( + byte[] bytes +) + +``` +**VB** +``` VB +Public Shared Function Deserialize(Of T) ( + bytes As Byte() +) As T +``` +**C++** +``` C++ +public: +generic +static T Deserialize( + array^ bytes +) +``` +**F#** +``` F# +static member Deserialize : + bytes : byte[] -> 'T +``` + + + +#### Parameters +
  Byte[]
The byte array representing a T object.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A *T* object. + +## Exceptions + + + + +
FormatExceptionThrown when the format of the byte array is incorrect.
+ +## See Also + + +#### Reference +SerializationHelper Class +Deserialize Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md new file mode 100644 index 0000000..0edaa72 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md @@ -0,0 +1,64 @@ +# Deserialize<T>(Stream) Method + + +Deserializes an object to a given *T* type. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Deserialize( + Stream stream +) + +``` +**VB** +``` VB +Public Shared Function Deserialize(Of T) ( + stream As Stream +) As T +``` +**C++** +``` C++ +public: +generic +static T Deserialize( + Stream^ stream +) +``` +**F#** +``` F# +static member Deserialize : + stream : Stream -> 'T +``` + + + +#### Parameters +
  Stream
The steam.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A *T* object. + +## Exceptions + + + + +
FormatExceptionThrown when the format of an input is incorrect.
+ +## See Also + + +#### Reference +SerializationHelper Class +Deserialize Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md new file mode 100644 index 0000000..b680351 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md @@ -0,0 +1,57 @@ +# Deserialize<T>(String) Method + + +Deserializes a `JSON` encoded string to the given *T*. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static T Deserialize( + string str +) + +``` +**VB** +``` VB +Public Shared Function Deserialize(Of T) ( + str As String +) As T +``` +**C++** +``` C++ +public: +generic +static T Deserialize( + String^ str +) +``` +**F#** +``` F# +static member Deserialize : + str : string -> 'T +``` + + + +#### Parameters +
  String
The JSON encoded string representing a T object.
+ +#### Type Parameters +
Generic type parameter.
+ +#### Return Value +T +A *T* object. + +## See Also + + +#### Reference +SerializationHelper Class +Deserialize Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md new file mode 100644 index 0000000..c6d8910 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md @@ -0,0 +1,51 @@ +# SerializeToBytes Method + + +Serializes an object to a byte array. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static byte[] SerializeToBytes( + Object obj +) +``` +**VB** +``` VB +Public Shared Function SerializeToBytes ( + obj As Object +) As Byte() +``` +**C++** +``` C++ +public: +static array^ SerializeToBytes( + Object^ obj +) +``` +**F#** +``` F# +static member SerializeToBytes : + obj : Object -> byte[] +``` + + + +#### Parameters +
  Object
The object.
+ +#### Return Value +Byte[] +A `JSON` encoded string. + +## See Also + + +#### Reference +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md new file mode 100644 index 0000000..8c48be8 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md @@ -0,0 +1,51 @@ +# SerializeToString Method + + +Serializes an object to a `JSON` encoded string. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static string SerializeToString( + Object obj +) +``` +**VB** +``` VB +Public Shared Function SerializeToString ( + obj As Object +) As String +``` +**C++** +``` C++ +public: +static String^ SerializeToString( + Object^ obj +) +``` +**F#** +``` F# +static member SerializeToString : + obj : Object -> string +``` + + + +#### Parameters +
  Object
The object.
+ +#### Return Value +String +A `JSON` encoded string. + +## See Also + + +#### Reference +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md new file mode 100644 index 0000000..68a85fd --- /dev/null +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md @@ -0,0 +1,62 @@ +# Compare Method + + +Compares the given plaintext password with an encrypted value using PBKDF2 algorithm. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +bool Compare( + string password, + byte[] encryptedValue, + params Object[] args +) +``` +**VB** +``` VB +Function Compare ( + password As String, + encryptedValue As Byte(), + ParamArray args As Object() +) As Boolean +``` +**C++** +``` C++ +bool Compare( + String^ password, + array^ encryptedValue, + ... array^ args +) +``` +**F#** +``` F# +abstract Compare : + password : string * + encryptedValue : byte[] * + args : Object[] -> bool +override Compare : + password : string * + encryptedValue : byte[] * + args : Object[] -> bool +``` + + + +#### Parameters +
  String
The plaintext password to compare.
  Byte[]
The encrypted value to compare against.
  Object[]
Additional arguments for the encryption process, such as salt and length.
+ +#### Return Value +Boolean +True if the given *password* matches the *encryptedValue*, false if they are different. + +## See Also + + +#### Reference +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md new file mode 100644 index 0000000..50df59b --- /dev/null +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md @@ -0,0 +1,54 @@ +# Encrypt Method + + +Encrypts the given password using a defined algorithm. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +byte[] Encrypt( + string password, + params Object[] args +) +``` +**VB** +``` VB +Function Encrypt ( + password As String, + ParamArray args As Object() +) As Byte() +``` +**C++** +``` C++ +array^ Encrypt( + String^ password, + ... array^ args +) +``` +**F#** +``` F# +abstract Encrypt : + password : string * + args : Object[] -> byte[] +``` + + + +#### Parameters +
  String
The plaintext password.
  Object[]
Additional arguments for the encryption process, such as salt and length.
+ +#### Return Value +Byte[] +A byte array with the hashed *password*. + +## See Also + + +#### Reference +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Password_ToString.md b/Documentation/Help/M_CapyKit_Password_ToString.md new file mode 100644 index 0000000..4d9727b --- /dev/null +++ b/Documentation/Help/M_CapyKit_Password_ToString.md @@ -0,0 +1,42 @@ +# ToString Method + + +Returns a string that represents the current object. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public override string ToString() +``` +**VB** +``` VB +Public Overrides Function ToString As String +``` +**C++** +``` C++ +public: +virtual String^ ToString() override +``` +**F#** +``` F# +abstract ToString : unit -> string +override ToString : unit -> string +``` + + + +#### Return Value +String +A string that represents the current object. + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md new file mode 100644 index 0000000..2102cf4 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md @@ -0,0 +1,64 @@ +# Encrypt Method + + +Encrypts the given password using a PBKDF2 algorithm. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public byte[] Encrypt( + string password, + params Object[] args +) +``` +**VB** +``` VB +Public Function Encrypt ( + password As String, + ParamArray args As Object() +) As Byte() +``` +**C++** +``` C++ +public: +virtual array^ Encrypt( + String^ password, + ... array^ args +) sealed +``` +**F#** +``` F# +abstract Encrypt : + password : string * + args : Object[] -> byte[] +override Encrypt : + password : string * + args : Object[] -> byte[] +``` + + + +#### Parameters +
  String
The plaintext password.
  Object[]
Additional arguments for the encryption process, specifically
  1. salt
  2. length
  3. iterations
+ +
+ +#### Return Value +Byte[] +A byte array with the hashed *password*. + +#### Implements +IPasswordAlgorithm.Encrypt(String, Object[]) + + +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md new file mode 100644 index 0000000..8b35a39 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md @@ -0,0 +1,37 @@ +# Pbkdf2Algorithm Constructor + + +Initializes a new instance of the Pbkdf2Algorithm class + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public Pbkdf2Algorithm() +``` +**VB** +``` VB +Public Sub New +``` +**C++** +``` C++ +public: +Pbkdf2Algorithm() +``` +**F#** +``` F# +new : unit -> Pbkdf2Algorithm +``` + + + +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md new file mode 100644 index 0000000..61fcee1 --- /dev/null +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md @@ -0,0 +1,40 @@ +# ReleaseLock Method + + +Releases the lock on the item. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public void ReleaseLock() +``` +**VB** +``` VB +Public Sub ReleaseLock +``` +**C++** +``` C++ +public: +void ReleaseLock() +``` +**F#** +``` F# +member ReleaseLock : unit -> unit +``` + + + +## Remarks +If the item is not locked, an error event is emitted. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md new file mode 100644 index 0000000..0d019dc --- /dev/null +++ b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md @@ -0,0 +1,44 @@ +# SetLock Method + + +Sets the lock on the item indicating that it is in use. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public bool SetLock() +``` +**VB** +``` VB +Public Function SetLock As Boolean +``` +**C++** +``` C++ +public: +bool SetLock() +``` +**F#** +``` F# +member SetLock : unit -> bool +``` + + + +#### Return Value +Boolean +true if the item is locked successfully, false if it fails. + +## Remarks +If the item is already locked, an error event is emitted. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md new file mode 100644 index 0000000..37b64f4 --- /dev/null +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md @@ -0,0 +1,42 @@ +# ToString Method + + +Returns a string that represents the current object and its lock state. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public override string ToString() +``` +**VB** +``` VB +Public Overrides Function ToString As String +``` +**C++** +``` C++ +public: +virtual String^ ToString() override +``` +**F#** +``` F# +abstract ToString : unit -> string +override ToString : unit -> string +``` + + + +#### Return Value +String +A string that represents the current object and its lock state. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md new file mode 100644 index 0000000..3546e6a --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md @@ -0,0 +1,41 @@ +# GetAvailableItem Method + + +Gets the first available item from the pool and sets its lock. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public PoolItem GetAvailableItem() +``` +**VB** +``` VB +Public Function GetAvailableItem As PoolItem(Of T) +``` +**C++** +``` C++ +public: +PoolItem^ GetAvailableItem() +``` +**F#** +``` F# +member GetAvailableItem : unit -> PoolItem<'T> +``` + + + +#### Return Value +PoolItem(T) +The first available item from the pool. + +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md new file mode 100644 index 0000000..89a25e6 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md @@ -0,0 +1,50 @@ +# ReleaseItem Method + + +Releases the lock on the specified item and returns it to the pool. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public void ReleaseItem( + PoolItem item +) +``` +**VB** +``` VB +Public Sub ReleaseItem ( + item As PoolItem(Of T) +) +``` +**C++** +``` C++ +public: +void ReleaseItem( + PoolItem^ item +) +``` +**F#** +``` F# +member ReleaseItem : + item : PoolItem<'T> -> unit +``` + + + +#### Parameters +
  PoolItem(T)
The item to release.
+ +## Remarks +This method sets the Locked flag to false so that it can be retrieved by GetAvailableItem(). + +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor.md b/Documentation/Help/M_CapyKit_Pool_1__ctor.md new file mode 100644 index 0000000..45c3cde --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor.md @@ -0,0 +1,48 @@ +# Pool<T>(IEnumerable<T>) Constructor + + +Initializes a new instance of the Pool(T) class with the specified collection of items. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public Pool( + IEnumerable collection +) +``` +**VB** +``` VB +Public Sub New ( + collection As IEnumerable(Of T) +) +``` +**C++** +``` C++ +public: +Pool( + IEnumerable^ collection +) +``` +**F#** +``` F# +new : + collection : IEnumerable<'T> -> Pool +``` + + + +#### Parameters +
  IEnumerable(T)
The collection of T items with which to seed the pool.
+ +## See Also + + +#### Reference +Pool(T) Class +Pool(T) Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md new file mode 100644 index 0000000..554a730 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md @@ -0,0 +1,48 @@ +# Pool<T>(Int32) Constructor + + +Initializes a new instance of the Pool(T) class with the specified pool size. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public Pool( + int poolSize +) +``` +**VB** +``` VB +Public Sub New ( + poolSize As Integer +) +``` +**C++** +``` C++ +public: +Pool( + int poolSize +) +``` +**F#** +``` F# +new : + poolSize : int -> Pool +``` + + + +#### Parameters +
  Int32
The size of the pool.
+ +## See Also + + +#### Reference +Pool(T) Class +Pool(T) Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md new file mode 100644 index 0000000..7577c0a --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md @@ -0,0 +1,52 @@ +# Pool<T>(Int32, Func<T>) Constructor + + +Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public Pool( + int poolSize, + Func constructorSelector +) +``` +**VB** +``` VB +Public Sub New ( + poolSize As Integer, + constructorSelector As Func(Of T) +) +``` +**C++** +``` C++ +public: +Pool( + int poolSize, + Func^ constructorSelector +) +``` +**F#** +``` F# +new : + poolSize : int * + constructorSelector : Func<'T> -> Pool +``` + + + +#### Parameters +
  Int32
The size of the pool.
  Func(T)
The constructor selector used to create new instances of T.
+ +## See Also + + +#### Reference +Pool(T) Class +Pool(T) Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md new file mode 100644 index 0000000..c34af56 --- /dev/null +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md @@ -0,0 +1,63 @@ +# Equals(T, T) Method + + +Determines whether the specified properties are equal. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public bool Equals( + T x, + T y +) +``` +**VB** +``` VB +Public Function Equals ( + x As T, + y As T +) As Boolean +``` +**C++** +``` C++ +public: +virtual bool Equals( + T x, + T y +) sealed +``` +**F#** +``` F# +abstract Equals : + x : 'T * + y : 'T -> bool +override Equals : + x : 'T * + y : 'T -> bool +``` + + + +#### Parameters +
  T
The first object of type T to compare.
  T
The second object of type T to compare.
+ +#### Return Value +Boolean +true if the specified objects are equal; otherwise, false. + +#### Implements +IEqualityComparer(T).Equals(T, T) + + +## See Also + + +#### Reference +PropertyComparer(T, U) Class +Equals Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md new file mode 100644 index 0000000..07f04e2 --- /dev/null +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md @@ -0,0 +1,65 @@ +# GetHashCode(T) Method + + +Returns a hash code for the specified object. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public int GetHashCode( + T obj +) +``` +**VB** +``` VB +Public Function GetHashCode ( + obj As T +) As Integer +``` +**C++** +``` C++ +public: +virtual int GetHashCode( + T obj +) sealed +``` +**F#** +``` F# +abstract GetHashCode : + obj : 'T -> int +override GetHashCode : + obj : 'T -> int +``` + + + +#### Parameters +
  T
The Object for which a hash code is to be returned.
+ +#### Return Value +Int32 +A hash code for the specified object. + +#### Implements +IEqualityComparer(T).GetHashCode(T) + + +## Exceptions + + + + +
ArgumentNullExceptionThe type of obj is a reference type and obj is null.
+ +## See Also + + +#### Reference +PropertyComparer(T, U) Class +GetHashCode Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md new file mode 100644 index 0000000..1d88f1b --- /dev/null +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md @@ -0,0 +1,47 @@ +# PropertyComparer<T, U> Constructor + + +Constructor. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public PropertyComparer( + Func expression +) +``` +**VB** +``` VB +Public Sub New ( + expression As Func(Of T, U) +) +``` +**C++** +``` C++ +public: +PropertyComparer( + Func^ expression +) +``` +**F#** +``` F# +new : + expression : Func<'T, 'U> -> PropertyComparer +``` + + + +#### Parameters +
  Func(T, U)
The expression.
+ +## See Also + + +#### Reference +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md new file mode 100644 index 0000000..d3ad16f --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -0,0 +1,39 @@ +# EnumerationAttribute<T> Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md new file mode 100644 index 0000000..f5f092d --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -0,0 +1,39 @@ +# EnumerationDescriptionAttribute Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +EnumerationDescriptionAttribute Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md b/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md new file mode 100644 index 0000000..89b359e --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md @@ -0,0 +1,33 @@ +# CapyEventArgs Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md b/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md new file mode 100644 index 0000000..217ff53 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md @@ -0,0 +1,21 @@ +# CapyEventReporter Methods + + + + +## Methods + + + + + + + +
SubscribeSubscribes the specified event handler to the event with the given subscription level and origin.
UnsubscribeUnsubscribes the specified event handler from the event with the given origin.
+ +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md new file mode 100644 index 0000000..19be628 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md @@ -0,0 +1,33 @@ +# EnumerationExtensions Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + +
GetDescriptionAn Enum extension method that gets a description.
GetNameAn Enum extension method that gets a name.
GetPrettyNameAn Enum extension method that gets a human readable name.
GetValueAn Enum extension method that gets an integer value representing the enumation.
Parse(T)(T, String)A T extension method that parses a string into an enumeration.
Parse(T)(T, String, Boolean)A T extension method that parses a string into an enumeration.
+ +## See Also + + +#### Reference +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md new file mode 100644 index 0000000..ee0ce7d --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md @@ -0,0 +1,42 @@ +# LINQExtensions Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Distinct(T, U)Enumerates distinct items in this collection as defined by the key property.
Filter(T)(IEnumerable(T), Func(T, Boolean))Filters out items matching a predicate from the collection.
Filter(T)(IQueryable(T), Expression(Func(T, Boolean)))Filters out items matching a predicate from the collection.
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))An IQueryable<T> extension method that left outer join.
Page(T)(IEnumerable(T), Int32, Int32)Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
Page(T)(IQueryable(T), Int32, Int32)Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
PageCount(T)(IEnumerable(T), Int32)The number of pages of pageSize size in the given collection.
PageCount(T)(IQueryable(T), Int32)The number of pages of pageSize size in the given collection.
+ +## See Also + + +#### Reference +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md new file mode 100644 index 0000000..cec75b0 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md @@ -0,0 +1,21 @@ +# StringExtensions Methods + + + + +## Methods + + + + + + + +
IfNullOrEmptyReplaces a null or empty string with a specified replacement string.
IfNullOrWhiteSpaceReplaces a null or whitespace string with a specified replacement string.
+ +## See Also + + +#### Reference +StringExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md new file mode 100644 index 0000000..3f16a3a --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md @@ -0,0 +1,30 @@ +# CompressionHelper Methods + + + + +## Methods + + + + + + + + + + + + + + + + +
CompressCompresses a given object using the gzip algorithm.
CompressToStringCompresses a given object to a string using base64 encoding of gzip format.
Decompress(T)(Byte[])Decompresses a given compressed gzip byte stream.
Decompress(T)(String)Decompresses a given base64 encoded string of gzip format.
DecompressToStringDecompresses the given base64 string in gzip format.
+ +## See Also + + +#### Reference +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md new file mode 100644 index 0000000..ff9a2b6 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md @@ -0,0 +1,36 @@ +# LanguageHelper Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + +
CamelCaseToHumanReadableConverts camel case text to human readable text.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +LanguageHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md new file mode 100644 index 0000000..4d5fd06 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md @@ -0,0 +1,54 @@ +# SecurityHelper Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CompareHashedPasswordCompares an unencrypted providedPassword with a stored, encrypted existingPassword.
CompareSessionIDCompares two session identifiers.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetCalendarKeyGets a calendar key that is 32 characters long.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRandomPasswordGets a cryptographically strong random password.
GetTypeGets the Type of the current instance.
(Inherited from Object)
HashPasswordHashes an unencrypted password.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Pbkdf2 
SHA256HashProduces a SHA256 hash from a given value.
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md new file mode 100644 index 0000000..7f6e4be --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md @@ -0,0 +1,30 @@ +# SerializationHelper Methods + + + + +## Methods + + + + + + + + + + + + + + + + +
Deserialize(T)(Byte[])Deserializes an object to a given T type.
Deserialize(T)(Stream)Deserializes an object to a given T type.
Deserialize(T)(String)Deserializes a JSON encoded string to the given T.
SerializeToBytesSerializes an object to a byte array.
SerializeToStringSerializes an object to a JSON encoded string.
+ +## See Also + + +#### Reference +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md new file mode 100644 index 0000000..54d4a53 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md @@ -0,0 +1,21 @@ +# IPasswordAlgorithm Methods + + + + +## Methods + + + + + + + +
CompareCompares the given plaintext password with an encrypted value using PBKDF2 algorithm.
EncryptEncrypts the given password using a defined algorithm.
+ +## See Also + + +#### Reference +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Password.md b/Documentation/Help/Methods_T_CapyKit_Password.md new file mode 100644 index 0000000..03fd1c7 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Password.md @@ -0,0 +1,33 @@ +# Password Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Overrides Object.ToString())
+ +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md new file mode 100644 index 0000000..00bc45b --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md @@ -0,0 +1,36 @@ +# Pbkdf2Algorithm Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + +
EncryptEncrypts the given password using a PBKDF2 algorithm.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md b/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md new file mode 100644 index 0000000..ca9202f --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md @@ -0,0 +1,33 @@ +# PoolItem<T> Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ReleaseLockReleases the lock on the item.
SetLockSets the lock on the item indicating that it is in use.
ToStringReturns a string that represents the current object and its lock state.
(Overrides Object.ToString())
+ +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Pool_1.md b/Documentation/Help/Methods_T_CapyKit_Pool_1.md new file mode 100644 index 0000000..af16138 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Pool_1.md @@ -0,0 +1,39 @@ +# Pool<T> Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAvailableItemGets the first available item from the pool and sets its lock.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReleaseItemReleases the lock on the specified item and returns it to the pool.
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md b/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md new file mode 100644 index 0000000..c37b1f1 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md @@ -0,0 +1,39 @@ +# PropertyComparer<T, U> Methods + + + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
Equals(Object)Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(T, T)Determines whether the specified properties are equal.
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode()Serves as the default hash function.
(Inherited from Object)
GetHashCode(T)Returns a hash code for the specified object.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/N_CapyKit.md b/Documentation/Help/N_CapyKit.md new file mode 100644 index 0000000..c131ec7 --- /dev/null +++ b/Documentation/Help/N_CapyKit.md @@ -0,0 +1,55 @@ +# CapyKit Namespace + + +\[Missing <summary> documentation for "N:CapyKit"\] + + + +## Classes + + + + + + + + + + + + + + + + + + + + + + +
CapyEventArgsThe CapyEventArgs class represents an event argument instance with event level, message, and method name information.
CapyEventReporterThe CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
PasswordRepresents a password with its hash, salt and algorithm used for encryption.
Pbkdf2AlgorithmImplements the PBKDF2 algorithm for password encryption.
Pool(T)A managed pool of resources. This class provides a thread-safe way to manage a collection of objects of type T.
PoolItem(T)A pool item. This class cannot be inherited.
PropertyComparer(T, U)A object comparer that can accept a lambda expression to compare properties.
+ +## Interfaces + + + + +
IPasswordAlgorithmDefines the contract for password encryption algorithms.
+ +## Delegates + + + + +
CapyEventHandlerA delegate representing an event handler that accepts a CapyEventArgs instance.
+ +## Enumerations + + + + + + + +
ColorEnum representing a set of named colors with their corresponding HEX values. These colors are inspired by the XKCD color palette (Link).
EventLevelEnumeration representing different event level severity values.
\ No newline at end of file diff --git a/Documentation/Help/N_CapyKit_Attributes.md b/Documentation/Help/N_CapyKit_Attributes.md new file mode 100644 index 0000000..076cf8c --- /dev/null +++ b/Documentation/Help/N_CapyKit_Attributes.md @@ -0,0 +1,16 @@ +# CapyKit.Attributes Namespace + + +\[Missing <summary> documentation for "N:CapyKit.Attributes"\] + + + +## Classes + + + + + + + +
EnumerationAttribute(T)Custom attribute class for decorating enumeration fields with additional data.
EnumerationDescriptionAttributeAn attribute class for decorating enumeration fields with a description.
\ No newline at end of file diff --git a/Documentation/Help/N_CapyKit_Extensions.md b/Documentation/Help/N_CapyKit_Extensions.md new file mode 100644 index 0000000..e133279 --- /dev/null +++ b/Documentation/Help/N_CapyKit_Extensions.md @@ -0,0 +1,19 @@ +# CapyKit.Extensions Namespace + + +\[Missing <summary> documentation for "N:CapyKit.Extensions"\] + + + +## Classes + + + + + + + + + + +
EnumerationExtensionsProvides static extentions methods for providing additional functionality for Enum types.
LINQExtensionsProvides static extension methods for performing common LINQ operations on IEnumerable(T) and IQueryable(T) collections.
StringExtensionsProvides static extentions methods for providing additional functionality for String types.
\ No newline at end of file diff --git a/Documentation/Help/N_CapyKit_Helpers.md b/Documentation/Help/N_CapyKit_Helpers.md new file mode 100644 index 0000000..3ea8737 --- /dev/null +++ b/Documentation/Help/N_CapyKit_Helpers.md @@ -0,0 +1,22 @@ +# CapyKit.Helpers Namespace + + +\[Missing <summary> documentation for "N:CapyKit.Helpers"\] + + + +## Classes + + + + + + + + + + + + + +
CompressionHelperA class that contains methods for managing data compression.
LanguageHelper 
SecurityHelperA class that contains methods for managing secure data processing and cryptography.
SerializationHelper 
\ No newline at end of file diff --git a/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md b/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md new file mode 100644 index 0000000..3beed74 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md @@ -0,0 +1,19 @@ +# Parse Method + + +## Overload List + + + + + + + +
Parse(T)(T, String)A T extension method that parses a string into an enumeration.
Parse(T)(T, String, Boolean)A T extension method that parses a string into an enumeration.
+ +## See Also + + +#### Reference +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md new file mode 100644 index 0000000..5bad20b --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md @@ -0,0 +1,19 @@ +# Filter Method + + +## Overload List + + + + + + + +
Filter(T)(IEnumerable(T), Func(T, Boolean))Filters out items matching a predicate from the collection.
Filter(T)(IQueryable(T), Expression(Func(T, Boolean)))Filters out items matching a predicate from the collection.
+ +## See Also + + +#### Reference +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md new file mode 100644 index 0000000..e09ebe6 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md @@ -0,0 +1,19 @@ +# LeftOuterJoin Method + + +## Overload List + + + + + + + +
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))An IQueryable<T> extension method that left outer join.
+ +## See Also + + +#### Reference +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md new file mode 100644 index 0000000..cf7bb26 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md @@ -0,0 +1,19 @@ +# Page Method + + +## Overload List + + + + + + + +
Page(T)(IEnumerable(T), Int32, Int32)Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
Page(T)(IQueryable(T), Int32, Int32)Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
+ +## See Also + + +#### Reference +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md new file mode 100644 index 0000000..985598e --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md @@ -0,0 +1,19 @@ +# PageCount Method + + +## Overload List + + + + + + + +
PageCount(T)(IEnumerable(T), Int32)The number of pages of pageSize size in the given collection.
PageCount(T)(IQueryable(T), Int32)The number of pages of pageSize size in the given collection.
+ +## See Also + + +#### Reference +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md b/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md new file mode 100644 index 0000000..7e2c1fb --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md @@ -0,0 +1,19 @@ +# Decompress Method + + +## Overload List + + + + + + + +
Decompress(T)(Byte[])Decompresses a given compressed gzip byte stream.
Decompress(T)(String)Decompresses a given base64 encoded string of gzip format.
+ +## See Also + + +#### Reference +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md b/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md new file mode 100644 index 0000000..1e11115 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md @@ -0,0 +1,22 @@ +# Deserialize Method + + +## Overload List + + + + + + + + + + +
Deserialize(T)(Byte[])Deserializes an object to a given T type.
Deserialize(T)(Stream)Deserializes an object to a given T type.
Deserialize(T)(String)Deserializes a JSON encoded string to the given T.
+ +## See Also + + +#### Reference +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md b/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md new file mode 100644 index 0000000..162346d --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md @@ -0,0 +1,22 @@ +# Pool<T> Constructor + + +## Overload List + + + + + + + + + + +
Pool(T)(IEnumerable(T))Initializes a new instance of the Pool(T) class with the specified collection of items.
Pool(T)(Int32)Initializes a new instance of the Pool(T) class with the specified pool size.
Pool(T)(Int32, Func(T))Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector.
+ +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md new file mode 100644 index 0000000..48e972f --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md @@ -0,0 +1,19 @@ +# Equals Method + + +## Overload List + + + + + + + +
Equals(Object)Determines whether the specified object is equal to the current object.
Equals(T, T)Determines whether the specified properties are equal.
+ +## See Also + + +#### Reference +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md new file mode 100644 index 0000000..5142338 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md @@ -0,0 +1,19 @@ +# GetHashCode Method + + +## Overload List + + + + + + + +
GetHashCode()Serves as the default hash function.
GetHashCode(T)Returns a hash code for the specified object.
+ +## See Also + + +#### Reference +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md new file mode 100644 index 0000000..cc670ac --- /dev/null +++ b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md @@ -0,0 +1,44 @@ +# Value Property + + +Initializes a new instance of the EnumerationAttribute(T) class with a specified value. + + + +## Definition +**Namespace:** CapyKit.Attributes +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public T Value { get; } +``` +**VB** +``` VB +Public ReadOnly Property Value As T + Get +``` +**C++** +``` C++ +public: +property T Value { + T get (); +} +``` +**F#** +``` F# +member Value : 'T with get +``` + + + +#### Property Value +T +The value. + +## See Also + + +#### Reference +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md new file mode 100644 index 0000000..302fcd0 --- /dev/null +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md @@ -0,0 +1,43 @@ +# Level Property + + +Gets the severity level of the event. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public EventLevel Level { get; } +``` +**VB** +``` VB +Public ReadOnly Property Level As EventLevel + Get +``` +**C++** +``` C++ +public: +property EventLevel Level { + EventLevel get (); +} +``` +**F#** +``` F# +member Level : EventLevel with get +``` + + + +#### Property Value +EventLevel + +## See Also + + +#### Reference +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md new file mode 100644 index 0000000..966d827 --- /dev/null +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md @@ -0,0 +1,43 @@ +# Message Property + + +Gets the message describing the reason for the event. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public string Message { get; } +``` +**VB** +``` VB +Public ReadOnly Property Message As String + Get +``` +**C++** +``` C++ +public: +property String^ Message { + String^ get (); +} +``` +**F#** +``` F# +member Message : string with get +``` + + + +#### Property Value +String + +## See Also + + +#### Reference +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md new file mode 100644 index 0000000..d5d2ab5 --- /dev/null +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md @@ -0,0 +1,43 @@ +# MethodName Property + + +Gets the name of the method where the event was raised. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public string MethodName { get; } +``` +**VB** +``` VB +Public ReadOnly Property MethodName As String + Get +``` +**C++** +``` C++ +public: +property String^ MethodName { + String^ get (); +} +``` +**F#** +``` F# +member MethodName : string with get +``` + + + +#### Property Value +String + +## See Also + + +#### Reference +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md new file mode 100644 index 0000000..6796667 --- /dev/null +++ b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md @@ -0,0 +1,42 @@ +# AlgorithmName Property + + +Gets the name of the algorithm. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +string AlgorithmName { get; } +``` +**VB** +``` VB +ReadOnly Property AlgorithmName As String + Get +``` +**C++** +``` C++ +property String^ AlgorithmName { + String^ get (); +} +``` +**F#** +``` F# +abstract AlgorithmName : string with get +``` + + + +#### Property Value +String + +## See Also + + +#### Reference +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Algorithm.md b/Documentation/Help/P_CapyKit_Password_Algorithm.md new file mode 100644 index 0000000..de1adcf --- /dev/null +++ b/Documentation/Help/P_CapyKit_Password_Algorithm.md @@ -0,0 +1,43 @@ +# Algorithm Property + + +Gets or sets the algorithm used for password encryption. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public IPasswordAlgorithm Algorithm { get; } +``` +**VB** +``` VB +Public ReadOnly Property Algorithm As IPasswordAlgorithm + Get +``` +**C++** +``` C++ +public: +property IPasswordAlgorithm^ Algorithm { + IPasswordAlgorithm^ get (); +} +``` +**F#** +``` F# +member Algorithm : IPasswordAlgorithm with get +``` + + + +#### Property Value +IPasswordAlgorithm + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Hash.md b/Documentation/Help/P_CapyKit_Password_Hash.md new file mode 100644 index 0000000..b797132 --- /dev/null +++ b/Documentation/Help/P_CapyKit_Password_Hash.md @@ -0,0 +1,43 @@ +# Hash Property + + +Gets or sets the hash of the password. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public byte[] Hash { get; } +``` +**VB** +``` VB +Public ReadOnly Property Hash As Byte() + Get +``` +**C++** +``` C++ +public: +property array^ Hash { + array^ get (); +} +``` +**F#** +``` F# +member Hash : byte[] with get +``` + + + +#### Property Value +Byte[] + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Salt.md b/Documentation/Help/P_CapyKit_Password_Salt.md new file mode 100644 index 0000000..2de9918 --- /dev/null +++ b/Documentation/Help/P_CapyKit_Password_Salt.md @@ -0,0 +1,43 @@ +# Salt Property + + +Gets or sets the salt used for encryption. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public byte[] Salt { get; } +``` +**VB** +``` VB +Public ReadOnly Property Salt As Byte() + Get +``` +**C++** +``` C++ +public: +property array^ Salt { + array^ get (); +} +``` +**F#** +``` F# +member Salt : byte[] with get +``` + + + +#### Property Value +Byte[] + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md new file mode 100644 index 0000000..468e00c --- /dev/null +++ b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md @@ -0,0 +1,48 @@ +# AlgorithmName Property + + +Gets the name of the algorithm. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public string AlgorithmName { get; } +``` +**VB** +``` VB +Public ReadOnly Property AlgorithmName As String + Get +``` +**C++** +``` C++ +public: +virtual property String^ AlgorithmName { + String^ get () sealed; +} +``` +**F#** +``` F# +abstract AlgorithmName : string with get +override AlgorithmName : string with get +``` + + + +#### Property Value +String + +#### Implements +IPasswordAlgorithm.AlgorithmName + + +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md new file mode 100644 index 0000000..5296ba4 --- /dev/null +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md @@ -0,0 +1,44 @@ +# Index Property + + +Gets the zero-based index of the pooled item. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public int Index { get; } +``` +**VB** +``` VB +Public ReadOnly Property Index As Integer + Get +``` +**C++** +``` C++ +public: +property int Index { + int get (); +} +``` +**F#** +``` F# +member Index : int with get +``` + + + +#### Property Value +Int32 +The index. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md new file mode 100644 index 0000000..c96d191 --- /dev/null +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md @@ -0,0 +1,44 @@ +# Item Property + + +Gets the pooled resource. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public T Item { get; } +``` +**VB** +``` VB +Public ReadOnly Property Item As T + Get +``` +**C++** +``` C++ +public: +property T Item { + T get (); +} +``` +**F#** +``` F# +member Item : 'T with get +``` + + + +#### Property Value +T +The pooled resource. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md new file mode 100644 index 0000000..977ec0c --- /dev/null +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md @@ -0,0 +1,44 @@ +# Locked Property + + +Gets a value indicating whether this object is locked or not. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public bool Locked { get; } +``` +**VB** +``` VB +Public ReadOnly Property Locked As Boolean + Get +``` +**C++** +``` C++ +public: +property bool Locked { + bool get (); +} +``` +**F#** +``` F# +member Locked : bool with get +``` + + + +#### Property Value +Boolean +A value indicating whether this object is locked or not. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md new file mode 100644 index 0000000..c9afcab --- /dev/null +++ b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md @@ -0,0 +1,44 @@ +# TypeName Property + + +Gets the name of the Type of the pooled item. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public string TypeName { get; } +``` +**VB** +``` VB +Public ReadOnly Property TypeName As String + Get +``` +**C++** +``` C++ +public: +property String^ TypeName { + String^ get (); +} +``` +**F#** +``` F# +member TypeName : string with get +``` + + + +#### Property Value +String +The name of the Type of the pooled item. + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md new file mode 100644 index 0000000..6a90caf --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -0,0 +1,21 @@ +# EnumerationAttribute<T> Properties + + + + +## Properties + + + + + + + +
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)
ValueInitializes a new instance of the EnumerationAttribute(T) class with a specified value.
+ +## See Also + + +#### Reference +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md new file mode 100644 index 0000000..3f2c09c --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -0,0 +1,21 @@ +# EnumerationDescriptionAttribute Properties + + + + +## Properties + + + + + + + +
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)
ValueInitializes a new instance of the EnumerationAttribute(T) class with a specified value.
(Inherited from EnumerationAttribute(T))
+ +## See Also + + +#### Reference +EnumerationDescriptionAttribute Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md b/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md new file mode 100644 index 0000000..bcf4c8c --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md @@ -0,0 +1,24 @@ +# CapyEventArgs Properties + + + + +## Properties + + + + + + + + + + +
LevelGets the severity level of the event.
MessageGets the message describing the reason for the event.
MethodNameGets the name of the method where the event was raised.
+ +## See Also + + +#### Reference +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md new file mode 100644 index 0000000..4f0a54d --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md @@ -0,0 +1,18 @@ +# IPasswordAlgorithm Properties + + + + +## Properties + + + + +
AlgorithmNameGets the name of the algorithm.
+ +## See Also + + +#### Reference +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Password.md b/Documentation/Help/Properties_T_CapyKit_Password.md new file mode 100644 index 0000000..910cdf2 --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_Password.md @@ -0,0 +1,24 @@ +# Password Properties + + + + +## Properties + + + + + + + + + + +
AlgorithmGets or sets the algorithm used for password encryption.
HashGets or sets the hash of the password.
SaltGets or sets the salt used for encryption.
+ +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md new file mode 100644 index 0000000..a1d76a7 --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md @@ -0,0 +1,18 @@ +# Pbkdf2Algorithm Properties + + + + +## Properties + + + + +
AlgorithmNameGets the name of the algorithm.
+ +## See Also + + +#### Reference +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md b/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md new file mode 100644 index 0000000..9b0f4b2 --- /dev/null +++ b/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md @@ -0,0 +1,27 @@ +# PoolItem<T> Properties + + + + +## Properties + + + + + + + + + + + + + +
IndexGets the zero-based index of the pooled item.
ItemGets the pooled resource.
LockedGets a value indicating whether this object is locked or not.
TypeNameGets the name of the Type of the pooled item.
+ +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md new file mode 100644 index 0000000..b8a5d06 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -0,0 +1,94 @@ +# EnumerationAttribute<T> Class + + +Custom attribute class for decorating enumeration fields with additional data. + + + +## Definition +**Namespace:** CapyKit.Attributes +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public abstract class EnumerationAttribute : Attribute + +``` +**VB** +``` VB +Public MustInherit Class EnumerationAttribute(Of T) + Inherits Attribute +``` +**C++** +``` C++ +generic +public ref class EnumerationAttribute abstract : public Attribute +``` +**F#** +``` F# +[] +type EnumerationAttribute<'T> = + class + inherit Attribute + end +``` + + + +
InheritanceObject → Attribute → EnumerationAttribute(T)
DerivedCapyKit.Attributes.EnumerationDescriptionAttribute
+ + + +#### Type Parameters +
Generic type parameter allowing for arbitrary declarations and assignments of meaning.
+ +## Constructors + + + + +
EnumerationAttribute(T)Gets the value of the enumeration represented by this attribute.
+ +## Properties + + + + + + + +
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)
ValueInitializes a new instance of the EnumerationAttribute(T) class with a specified value.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit.Attributes Namespace diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md new file mode 100644 index 0000000..5d0f1c5 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -0,0 +1,88 @@ +# EnumerationDescriptionAttribute Class + + +An attribute class for decorating enumeration fields with a description. + + + +## Definition +**Namespace:** CapyKit.Attributes +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class EnumerationDescriptionAttribute : EnumerationAttribute +``` +**VB** +``` VB +Public Class EnumerationDescriptionAttribute + Inherits EnumerationAttribute(Of String) +``` +**C++** +``` C++ +public ref class EnumerationDescriptionAttribute : public EnumerationAttribute +``` +**F#** +``` F# +type EnumerationDescriptionAttribute = + class + inherit EnumerationAttribute + end +``` + + +
InheritanceObject → Attribute → EnumerationAttribute(String) → EnumerationDescriptionAttribute
+ + + +## Constructors + + + + +
EnumerationDescriptionAttributeInitializes a new instance of the EnumerationDescriptionAttribute class with the specified description.
+ +## Properties + + + + + + + +
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)
ValueInitializes a new instance of the EnumerationAttribute(T) class with a specified value.
(Inherited from EnumerationAttribute(T))
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit.Attributes Namespace +EnumerationAttribute(T) diff --git a/Documentation/Help/T_CapyKit_CapyEventArgs.md b/Documentation/Help/T_CapyKit_CapyEventArgs.md new file mode 100644 index 0000000..352499e --- /dev/null +++ b/Documentation/Help/T_CapyKit_CapyEventArgs.md @@ -0,0 +1,84 @@ +# CapyEventArgs Class + + +The CapyEventArgs class represents an event argument instance with event level, message, and method name information. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class CapyEventArgs : EventArgs +``` +**VB** +``` VB +Public Class CapyEventArgs + Inherits EventArgs +``` +**C++** +``` C++ +public ref class CapyEventArgs : public EventArgs +``` +**F#** +``` F# +type CapyEventArgs = + class + inherit EventArgs + end +``` + + +
InheritanceObject → EventArgs → CapyEventArgs
+ + + +## Constructors + + + + +
CapyEventArgsInitializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
+ +## Properties + + + + + + + + + + +
LevelGets the severity level of the event.
MessageGets the message describing the reason for the event.
MethodNameGets the name of the method where the event was raised.
+ +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_CapyEventHandler.md b/Documentation/Help/T_CapyKit_CapyEventHandler.md new file mode 100644 index 0000000..93434ce --- /dev/null +++ b/Documentation/Help/T_CapyKit_CapyEventHandler.md @@ -0,0 +1,46 @@ +# CapyEventHandler Delegate + + +A delegate representing an event handler that accepts a CapyEventArgs instance. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public delegate void CapyEventHandler( + CapyEventArgs e +) +``` +**VB** +``` VB +Public Delegate Sub CapyEventHandler ( + e As CapyEventArgs +) +``` +**C++** +``` C++ +public delegate void CapyEventHandler( + CapyEventArgs^ e +) +``` +**F#** +``` F# +type CapyEventHandler = + delegate of + e : CapyEventArgs -> unit +``` + + + +#### Parameters +
  CapyEventArgs
The CapyEventArgs instance containing event data.
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_CapyEventReporter.md b/Documentation/Help/T_CapyKit_CapyEventReporter.md new file mode 100644 index 0000000..40d4592 --- /dev/null +++ b/Documentation/Help/T_CapyKit_CapyEventReporter.md @@ -0,0 +1,53 @@ +# CapyEventReporter Class + + +The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static class CapyEventReporter +``` +**VB** +``` VB +Public NotInheritable Class CapyEventReporter +``` +**C++** +``` C++ +public ref class CapyEventReporter abstract sealed +``` +**F#** +``` F# +[] +[] +type CapyEventReporter = class end +``` + + +
InheritanceObject → CapyEventReporter
+ + + +## Remarks +Because consumers of CapyKit may have varied ways of handling logging, the CapyEventReporter provides a way for subscribers to recieve events for various "events" within the library. These can be thought of as a logging solution for CapyKit. Consumers are free to treat these events however they see fit. + +## Methods + + + + + + + +
SubscribeSubscribes the specified event handler to the event with the given subscription level and origin.
UnsubscribeUnsubscribes the specified event handler from the event with the given origin.
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Color.md b/Documentation/Help/T_CapyKit_Color.md new file mode 100644 index 0000000..75ce861 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Color.md @@ -0,0 +1,3839 @@ +# Color Enumeration + + +Enum representing a set of named colors with their corresponding HEX values. These colors are inspired by the XKCD color palette (Link). + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public enum Color +``` +**VB** +``` VB +Public Enumeration Color +``` +**C++** +``` C++ +public enum class Color +``` +**F#** +``` F# +type Color +``` + + + +## Members + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Black0 
VeryDarkBlue307 
DarkNavyBlue558 
DarkBlue859 
DarkNavy1,077 
NavyBlue4,422 
DarkForestGreen11,524 
PrussianBlue17,783 
DarkBlueGreen21,065 
DeepTeal21,850 
Petrol24,426 
KelleyGreen37,687 
GreenishTurquoise64,432 
Cyan65,535 
TrueBlue69,580 
Navy70,974 
MarineBlue79,978 
DarkishBlue82,306 
RacingGreen83,456 
DarkTeal85,326 
DeepSeaBlue87,170 
BrightBlue91,644 
PeacockBlue92,053 
DarkAquamarine95,089 
DeepTurquoise95,092 
Bluegreen96,889 
Ocean97,170 
TealBlue100,511 
IrishGreen103,721 
Emerald106,569 
Shamrock111,692 
GreenBlue114,829 
BrightTeal129,478 
BrightGreen130,823 
MidnightBlue131,125 
PureBlue132,066 
DarkRoyalBlue132,719 
RichBlue138,233 
DeepGreen153,871 
EmeraldGreen167,710 
Teal168,838 
KellyGreen174,894 
ShamrockGreen180,557 
BrightSkyBlue183,550 
AquaBlue186,601 
Midnight196,909 
Darkblue198,500 
CobaltBlue199,335 
DarkGreen210,176 
VibrantBlue211,448 
Blue213,983 
OceanBlue225,692 
DeepBlue262,771 
NightBlue262,984 
Marine274,016 
BottleGreen281,093 
DarkTurquoise285,786 
SeaBlue291,989 
JungleGreen295,491 
Cerulean296,401 
Aquamarine317,618 
NeonBlue317,951 
TurquoiseGreen324,745 
RoyalBlue328,874 
Evergreen345,898 
BritishRacingGreen346,125 
Darkgreen346,375 
DarkAqua354,667 
CeruleanBlue356,078 
BrightSeaGreen393,126 
VeryDarkGreen404,995 
ForestGreen411,404 
ElectricBlue414,463 
Azure432,883 
TurquoiseBlue438,724 
GreenBlueAlternate439,435 
Turquoise443,052 
AlmostBlack462,093 
PrimaryBlue525,561 
DeepAqua555,135 
TrueGreen562,180 
FluorescentGreen589,576 
TwilightBlue672,634 
PineGreen673,822 
Spruce679,736 
DarkCyan690,314 
VibrantGreen711,944 
FluroGreen720,642 
HunterGreen737,288 
Forest742,665 
GreenishBlue756,615 
MintyGreen784,253 
BrightAqua784,874 
StrongBlue788,215 
Royal792,467 
GreenTeal832,887 
TealishGreen842,867 
NeonGreen851,724 
DeepSkyBlue882,168 
WaterBlue952,268 
BlueGreen1,022,862 
BrightTurquoise1,048,313 
NiceBlue1,079,984 
BluishGreen1,091,188 
DarkSeaGreen1,148,765 
AquaGreen1,237,395 
BlueGreenAlternate1,277,549 
Topaz1,293,231 
Aqua1,305,289 
VividBlue1,388,287 
ForrestGreen1,393,670 
LightNavy1,396,868 
Green1,421,338 
UltramarineBlue1,574,363 
Seaweed1,626,491 
Dark1,778,737 
HighlighterGreen1,833,990 
VeryDarkBrown1,901,056 
Azul1,924,588 
Cobalt1,984,655 
Viridian2,003,303 
Spearmint2,029,686 
DarkIndigo2,034,004 
DarkBlueGrey2,046,797 
DarkGreenBlue2,057,047 
Jade2,074,484 
DarkSeafoam2,078,074 
Ultramarine2,097,329 
DarkMintGreen2,146,419 
Wintergreen2,161,030 
Sapphire2,177,195 
DarkSlateBlue2,180,961 
AlgaeGreen2,212,719 
ElectricGreen2,227,213 
BlueBlue2,245,319 
Greenblue2,344,075 
ClearBlue2,390,781 
Tealish2,407,592 
TealGreen2,466,671 
HotGreen2,490,153 
DuskBlue2,511,757 
BrightLightBlue2,553,853 
MidBlue2,583,219 
MidnightPurple2,621,751 
DarkishGreen2,653,239 
DarkGreyBlue2,704,987 
Bluish2,717,371 
VeryDarkPurple2,752,820 
TreeGreen2,784,793 
GreenishCyan2,817,719 
Pine2,841,908 
JadeGreen2,862,954 
BlueyGreen2,863,481 
MediumBlue2,912,187 
RadioactiveGreen2,947,615 
BrightLightGreen3,014,228 
LightNavyBlue3,037,832 
AquaMarine3,074,235 
VividGreen3,141,392 
UglyBlue3,237,514 
GreenishTeal3,325,828 
CoolGreen3,389,540 
DarkViolet3,408,191 
DarkBrown3,415,042 
Charcoal3,422,263 
DarkPurple3,475,006 
NavyGreen3,494,666 
SeaweedGreen3,517,803 
DeepPurple3,539,263 
DarkGrey3,553,079 
DarkOlive3,620,354 
WindowsBlue3,635,391 
Indigo3,670,658 
Eggplant3,672,117 
DarkGrassGreen3,702,788 
MediumGreen3,779,912 
IndigoBlue3,807,409 
LightRoyalBlue3,813,118 
WeirdGreen3,859,839 
DenimBlue3,890,066 
Denim3,892,108 
MutedBlue3,895,711 
DarkMaroon3,932,168 
CharcoalGrey3,948,866 
DarkOliveGreen3,951,875 
FlatBlue3,961,768 
Sea3,971,474 
Aubergine3,999,540 
Chocolate4,004,866 
LightishBlue4,029,181 
OceanGreen4,036,979 
DodgerBlue4,096,764 
DarkSeafoamGreen4,108,150 
DarkPlum4,129,068 
DirtyBlue4,162,205 
GrassGreen4,168,459 
Greenish4,236,136 
PoisonGreen4,259,092 
DeepBrown4,260,352 
ChocolateBrown4,266,240 
GrassyGreen4,299,779 
BrightCyan4,324,862 
GreenyBlue4,371,349 
EggplantPurple4,392,257 
FrenchBlue4,418,477 
DarkSkyBlue4,493,028 
Blueberry4,604,310 
DuskyBlue4,677,524 
DarkMint4,767,858 
DeepViolet4,785,736 
DullBlue4,814,236 
CoolBlue4,818,104 
Mahogany4,849,920 
RoyalPurple4,915,310 
DriedBlood4,915,457 
WarmBlue4,937,691 
ArmyGreen4,939,030 
CamouflageGreen4,940,051 
DustyTeal5,017,733 
LawnGreen5,088,265 
PlumPurple5,113,168 
Twilight5,132,683 
Dusk5,133,441 
CadetBlue5,141,654 
LightNeonGreen5,176,660 
MetallicBlue5,206,926 
LightForestGreen5,214,547 
StormyBlue5,274,524 
MidGreen5,285,703 
VioletBlue5,311,177 
Slate5,334,386 
CornflowerBlue5,337,303 
LeafyGreen5,355,323 
CamoGreen5,399,845 
BlueWithAHintOfPurple5,455,046 
Gunmetal5,464,679 
SeaGreen5,504,161 
LightBrightGreen5,504,604 
GreenBrown5,524,995 
FernGreen5,541,188 
Algae5,549,160 
Blurple5,585,356 
OffBlue5,670,062 
DarkPastelGreen5,680,727 
LightGreenBlue5,700,770 
BluePurpleAlternate5,712,334 
Plum5,771,073 
FrogGreen5,815,304 
SlateGrey5,858,669 
DarkSage5,866,838 
BluePurple5,900,015 
SteelBlue5,930,394 
DustyBlue5,932,717 
SlateBlue5,995,673 
SapGreen6,064,917 
LeafGreen6,072,580 
Grass6,073,389 
KermitGreen6,074,880 
BlueViolet6,096,617 
GrapePurple6,100,049 
PurpleBlue6,103,504 
GreyishBlue6,193,565 
GreyTeal6,200,202 
GreenApple6,216,735 
PurpleyBlue6,239,463 
DullTeal6,266,511 
MutedGreen6,266,962 
PurplishBlue6,299,385 
MudBrown6,309,391 
MudGreen6,317,570 
BlueGreyAlternate6,323,342 
Burgundy6,357,027 
PurpleishBlue6,373,615 
ToxicGreen6,413,866 
LightishGreen6,414,688 
BlueyPurple6,439,367 
Iris6,445,252 
PurpleBlueAlternate6,499,817 
MossyGreen6,523,687 
Fern6,531,408 
BoringGreen6,533,989 
LightGreenishBlue6,551,476 
OliveBrown6,575,107 
GreyBlue6,585,742 
SoftBlue6,588,650 
Maroon6,619,169 
Brown6,633,216 
MuddyGreen6,648,882 
MossGreen6,654,776 
FadedBlue6,655,163 
SlateGreen6,655,341 
Tea6,663,036 
BrightLimeGreen6,684,168 
PurplyBlue6,691,566 
DarkPeriwinkle6,709,201 
MilitaryGreen6,716,478 
DirtyGreen6,716,972 
PurpleBrown6,765,119 
OliveGreen6,781,444 
Claret6,815,768 
Burple6,828,771 
GreenyBrown6,905,862 
GreenishBrown6,906,130 
Swamp6,914,873 
FlatGreen6,921,548 
FreshGreen6,936,655 
BrownishGreen6,974,985 
Cornflower6,978,039 
PurplishBrown7,029,319 
BattleshipGrey7,044,229 
GreyBlueAlternate7,048,100 
OffGreen7,054,163 
Grape7,091,297 
MurkyGreen7,109,134 
LightIndigo7,166,671 
RobinsEgg7,204,349 
ReddyBrown7,213,061 
Olive7,238,926 
Apple7,260,988 
BrownyGreen7,302,154 
OliveDrab7,304,754 
PoopGreen7,306,240 
SteelGrey7,307,914 
SoftGreen7,324,278 
BluishPurple7,355,367 
BrownGreen7,367,697 
NastyGreen7,385,663 
GreyishTeal7,446,417 
Leaf7,449,140 
RichPurple7,471,192 
KhakiGreen7,505,465 
DarkYellowGreen7,507,714 
Merlot7,536,697 
DirtyPurple7,555,685 
Mud7,560,210 
Steel7,570,837 
Chestnut7,612,418 
SwampGreen7,636,224 
BluishGrey7,637,911 
DrabGreen7,640,401 
DullGreen7,644,770 
Velvet7,669,841 
DarkishPurple7,674,227 
ShitGreen7,700,480 
BlueGrey7,703,971 
TurtleGreen7,714,895 
SkyBlue7,715,837 
LighterGreen7,732,579 
BrownishPurple7,750,222 
Moss7,772,504 
DustyGreen7,776,627 
AppleGreen7,785,766 
LightBluishGreen7,798,184 
Lightgreen7,798,651 
Blood7,798,785 
GreenGrey7,836,271 
Greyblue7,840,181 
Asparagus7,842,646 
GreyGreenAlternate7,904,115 
SeafoamBlue7,918,006 
PoopBrown8,018,177 
PurplishGrey8,022,143 
GreyishBrown8,022,607 
UglyGreen8,034,051 
SeafoamGreen8,059,307 
Bordeaux8,060,972 
WineRed8,061,731 
ShitBrown8,083,460 
FadedGreen8,106,612 
Lightblue8,112,374 
TiffanyBlue8,123,098 
LightAquamarine8,125,895 
UglyBrown8,220,931 
MediumGrey8,224,636 
Purple8,265,372 
Purple28,265,372 
Bruise8,274,033 
GreenyGrey8,298,618 
DarkLimeGreen8,305,921 
LightTurquoise8,320,204 
LightBlueGreen8,321,971 
ReddishBrown8,334,090 
MilkChocolate8,343,070 
MediumBrown8,343,826 
Poop8,347,136 
Shit8,347,392 
DarkTaupe8,349,774 
GreyBrown8,351,827 
Camo8,359,758 
Wine8,388,927 
MutedPurple8,412,039 
Seafoam8,452,525 
RedPurple8,521,543 
DustyPurple8,544,135 
GreyPurple8,547,724 
Drab8,553,284 
GreyishGreen8,562,301 
Sky8,571,644 
PaleTeal8,571,826 
DirtBrown8,611,129 
DarkRed8,650,752 
DullPurple8,673,662 
DarkLime8,697,601 
IndianRed8,719,876 
DarkLavender8,742,808 
Bluegrey8,758,194 
PurpleGrey8,810,373 
BrownishGrey8,812,383 
GreyGreen8,823,165 
DarkMauve8,866,914 
Purpley8,869,604 
Cocoa8,871,746 
DullBrown8,875,595 
AvocadoGreen8,890,658 
Sage8,892,019 
BrightLime8,912,133 
PooBrown8,937,217 
MuddyBrown8,939,526 
GreyishPurple8,941,969 
BabyShitGreen8,951,575 
SageGreen8,958,840 
LightEggplant8,996,229 
DuskyPurple9,001,851 
BlueyGrey9,019,568 
VomitGreen9,019,907 
LimeGreen9,043,461 
Dirt9,072,197 
CarolinaBlue9,091,326 
RobinEggBlue9,105,918 
RedBrown9,121,302 
RustBrown9,122,051 
LavenderBlue9,144,568 
Crimson9,175,055 
RedWine9,175,092 
EasterGreen9,239,934 
BabyGreen9,240,478 
LightAqua9,240,539 
DeepLavender9,264,823 
BrownGrey9,274,472 
Hazel9,336,344 
Periwinkle9,339,646 
PeaGreen9,349,906 
KiwiGreen9,364,799 
BrickRed9,376,770 
Poo9,401,091 
Perrywinkle9,407,719 
BabyPoopGreen9,410,565 
PeriwinkleBlue9,411,067 
IckyGreen9,416,226 
Lichen9,418,363 
AcidGreen9,436,681 
MintGreen9,437,087 
Avocado9,482,548 
LightTeal9,495,745 
FoamGreen9,502,121 
ReddishPurple9,505,105 
FadedPurple9,531,033 
Mulberry9,570,894 
BrownRed9,579,269 
Grey9,606,545 
PeaSoup9,607,425 
BabyPoop9,665,536 
Purplish9,721,484 
PukeBrown9,729,798 
PurpleyGrey9,731,732 
PeaSoupGreen9,741,847 
BarfGreen9,743,362 
SicklyGreen9,744,924 
WarmPurple9,776,783 
CoolGrey9,806,758 
LightBlue9,818,364 
DarkMagenta9,830,486 
WarmBrown9,850,370 
DeepLilac9,858,749 
GreenishGrey9,875,085 
BoogerGreen9,876,483 
LightGreen9,894,267 
WarmGrey9,931,396 
BloodRed9,961,474 
Purply9,977,778 
Purpleish9,983,629 
Sepia9,985,579 
RobinsEggBlue10,022,905 
LightSeaGreen10,024,624 
VividPurple10,027,258 
PurpleRed10,027,335 
Berry10,030,923 
ReddishGrey10,057,072 
SlimeGreen10,079,236 
DeepRed10,093,056 
Violet10,096,362 
Auburn10,104,833 
RawSienna10,117,632 
PukeGreen10,137,095 
LightGrassGreen10,155,876 
Amethyst10,182,592 
YellowishBrown10,189,313 
DarkKhaki10,194,773 
Booger10,204,476 
HospitalGreen10,216,874 
Brownish10,251,607 
DarkLilac10,251,685 
BrightOlive10,271,492 
Kiwi10,284,867 
Carmine10,289,686 
DarkFuchsia10,291,033 
LightPlum10,311,555 
Mocha10,319,441 
SickGreen10,336,556 
LightGreyBlue10,337,492 
SnotGreen10,338,560 
BrightYellowGreen10,354,432 
Cranberry10,354,746 
RedViolet10,355,048 
BrownishRed10,368,547 
MediumPurple10,372,002 
BurntRed10,429,189 
Diarrhea10,453,763 
Mint10,485,424 
DeepMagenta10,486,364 
BarneyPurple10,486,936 
Brick10,499,619 
BurntUmber10,503,438 
GrossGreen10,534,678 
LightSeafoam10,550,975 
Russet10,565,893 
LightMaroon10,635,351 
Earth10,642,750 
Vomit10,658,837 
PastelBlue10,665,982 
BabyBlue10,670,078 
UglyPurple10,764,960 
Heather10,781,868 
LightOliveGreen10,796,636 
Pea10,796,832 
VioletRed10,813,525 
LightishPurple10,834,662 
LighterPurple10,836,724 
Puce10,845,778 
Cement10,855,313 
Puke10,855,682 
PaleTurquoise10,877,909 
SoftPurple10,907,573 
Coffee10,912,076 
LightMossGreen10,930,293 
LightMintGreen10,943,410 
RawUmber10,968,585 
LightSeafoamGreen11,009,973 
Rust11,025,417 
LightBurgundy11,026,779 
Bronze11,041,024 
Wisteria11,042,242 
DarkMustard11,045,125 
DarkSand11,046,745 
Greyish11,052,181 
MustardGreen11,056,388 
ElectricLime11,075,332 
DarkishRed11,076,360 
Sienna11,097,630 
TanGreen11,124,336 
SpringGreen11,139,441 
ElectricPurple11,150,335 
RustRed11,151,108 
Khaki11,183,714 
Lime11,206,450 
Rouge11,211,321 
TanBrown11,238,988 
BabyPoo11,243,524 
Barney11,279,800 
Cinnamon11,292,422 
Leather11,301,940 
MustardBrown11,304,452 
DustyLavender11,306,664 
DarkBeige11,309,922 
Snot11,320,077 
LightOlive11,321,193 
CloudyBlue11,322,073 
LightCyan11,337,724 
VibrantPurple11,338,718 
BrightViolet11,340,541 
LightBrown11,370,832 
BabyShitBrown11,374,605 
Stone11,380,103 
LemonGreen11,401,218 
Mauve11,432,321 
YellowyBrown11,438,860 
LightLime11,468,140 
KeyLime11,468,654 
RustyRed11,480,845 
Caramel11,497,225 
DarkTan11,503,690 
Bland11,511,947 
Raspberry11,534,665 
PurplishRed11,535,691 
BurntSienna11,554,319 
YellowishGreen11,590,934 
PastelGreen11,599,773 
OrangeyBrown11,624,450 
PinkishBrown11,629,153 
PaleBrown11,637,102 
PowderBlue11,653,628 
PaleOliveGreen11,653,755 
PaleLightGreen11,664,537 
PaleLimeGreen11,665,253 
OrangishBrown11,689,731 
Umber11,691,008 
ClayBrown11,694,397 
GoldenBrown11,696,641 
BrownYellow11,704,069 
Dust11,704,686 
LightPastelGreen11,729,829 
LightUrple11,759,606 
DarkRose11,880,541 
DarkGold11,899,920 
Bile11,911,942 
GreenYellow11,914,760 
Copper11,952,933 
Clay11,954,768 
BabyPukeGreen11,977,734 
LightMint11,993,019 
BurntSiena12,014,083 
PalePurple12,030,164 
YellowBrown12,030,976 
LightBlueGrey12,044,770 
LightGreyGreen12,050,849 
PaleCyan12,058,618 
PaleAqua12,124,139 
DustyRed12,142,670 
BrownOrange12,151,042 
Taupe12,165,761 
PaleOlive12,176,513 
LightLimeGreen12,189,542 
DuskyRose12,216,435 
Mushroom12,230,280 
DullRed12,271,423 
Yellowgreen12,318,991 
NeonPurple12,325,886 
GreenishTan12,372,858 
LightSage12,381,356 
WashedOutGreen12,383,654 
Adobe12,414,024 
PaleSkyBlue12,449,534 
TeaGreen12,449,955 
Scarlet12,452,121 
RoseRed12,452,156 
BrightPurple12,452,861 
OrangeBrown12,477,440 
Putty12,496,522 
PaleLime12,516,723 
Celadon12,516,791 
LightPurple12,548,086 
Ochre12,554,245 
Ocher12,557,068 
MuddyYellow12,561,413 
YellowyGreen12,579,112 
LemonLime12,582,440 
LipstickRed12,583,471 
BurntOrange12,602,881 
EasterPurple12,612,094 
DustyRose12,612,474 
Pistachio12,647,051 
YellowGreenAlternate12,647,213 
BrickOrange12,667,401 
LightPeriwinkle12,699,388 
Chartreuse12,711,946 
Celery12,713,365 
Magenta12,714,104 
BrownishPink12,746,361 
LightMauve12,751,521 
OliveYellow12,760,841 
PukeYellow12,762,638 
LightYellowishGreen12,779,401 
GreyPink12,816,539 
DuckEggBlue12,844,020 
Reddish12,862,016 
RustOrange12,866,824 
Liliac12,881,661 
SandyBrown12,887,649 
LightPeaGreen12,910,210 
EggshellBlue12,910,583 
Silver12,962,247 
DarkOrange12,996,866 
Ocre13,016,068 
Camel13,016,921 
GreenyYellow13,039,624 
LightSkyBlue13,040,895 
DeepRose13,059,943 
BrightLavender13,066,495 
OldPink13,072,774 
Lavender13,082,607 
Toupe13,085,821 
VomitYellow13,091,084 
PaleGreen13,106,613 
PurpleyPink13,122,745 
DarkSalmon13,130,323 
Orchid13,137,348 
DirtyOrange13,137,414 
OldRose13,139,849 
GreyishPink13,143,444 
PinkishGrey13,151,401 
YellowGreen13,172,029 
LightLightGreen13,172,656 
PinkyPurple13,192,382 
BrightLilac13,197,051 
TerraCotta13,198,395 
Sandstone13,217,396 
BrownishYellow13,217,795 
GreenishBeige13,226,361 
GreenYellowAlternate13,238,055 
Ruby13,238,599 
Terracotta13,264,449 
BrownyOrange13,265,666 
DirtyPink13,269,888 
BabyPurple13,278,199 
PastelPurple13,279,487 
LightLightBlue13,303,803 
HotPurple13,304,053 
DeepPink13,304,162 
DarkPink13,320,555 
Terracota13,330,499 
BrownishOrange13,334,307 
YellowOchre13,344,006 
SandBrown13,346,144 
Pear13,367,391 
DuskyPink13,400,715 
Desert13,413,728 
LightYellowGreen13,434,239 
RustyOrange13,457,673 
UglyPink13,464,964 
DirtyYellow13,485,322 
GreenishYellow13,499,650 
PurplishPink13,524,398 
Lilac13,542,141 
PaleViolet13,545,210 
Mustard13,546,241 
Cherry13,566,516 
DarkCoral13,587,022 
Rose13,591,157 
Fawn13,610,875 
VeryPaleGreen13,630,908 
NeonYellow13,631,236 
UglyYellow13,680,897 
SicklyYellow13,689,897 
LimeYellow13,696,541 
PaleBlue13,696,766 
MutedPink13,727,375 
Tan13,742,703 
VeryLightGreen13,762,493 
MustardYellow13,810,954 
FadedRed13,846,862 
VeryLightBrown13,874,819 
Pinkish13,920,894 
ReallyLightBlue13,959,167 
Lipstick13,965,134 
DullPink13,993,629 
DustyPink13,994,644 
BurntYellow14,002,953 
DarkYellow14,005,770 
VeryLightBlue14,024,703 
PinkishPurple14,043,351 
LightViolet14,071,036 
Ice14,090,234 
VeryPaleBlue14,090,238 
PurplePink14,099,934 
PaleMagenta14,116,781 
IceBlue14,155,774 
DullOrange14,190,139 
LightGrey14,212,310 
DarkHotPink14,221,670 
Heliotrope14,241,781 
PaleRed14,242,893 
PinkishTan14,261,122 
DarkishPink14,304,893 
PinkPurpleAlternate14,371,802 
PastelRed14,374,998 
Gold14,398,476 
DeepOrange14,437,633 
LavenderPink14,517,719 
PissYellow14,538,264 
Cerise14,552,162 
DarkPeach14,581,341 
FadedPink14,589,356 
PurpleishPink14,634,696 
LightLavender14,665,214 
PurplePinkAlternate14,696,408 
Pumpkin14,776,065 
Sand14,862,966 
PaleLilac14,994,431 
Red15,007,744 
Beige15,129,254 
LightKhaki15,135,394 
PigPink15,175,333 
TomatoRed15,478,017 
Fuchsia15,535,577 
LightLilac15,583,487 
PaleLavender15,650,814 
DullYellow15,653,979 
PinkPurple15,670,759 
Tomato15,679,526 
MacaroniAndCheese15,709,237 
LightLavendar15,712,510 
PurplyPink15,758,822 
DustyOrange15,762,234 
FadedOrange15,766,605 
PinkishRed15,797,317 
Sandy15,850,106 
OffYellow15,856,447 
Blush15,900,302 
Squash15,903,509 
MediumPink15,950,230 
Vermillion16,003,596 
OrangishRed16,004,613 
Maize16,044,116 
HotMagenta16,057,545 
PinkRed16,057,679 
Golden16,105,219 
RosyPink16,148,622 
VeryLightPurple16,174,844 
CherryRed16,187,946 
RosePink16,222,106 
LightMustard16,242,016 
ReddishOrange16,271,388 
Orange16,347,910 
GoldenRod16,366,600 
RedPink16,394,837 
OrangeyRed16,400,932 
LightMagenta16,408,567 
Goldenrod16,433,669 
Yellowish16,445,030 
BananaYellow16,449,099 
Strawberry16,460,099 
WarmPink16,471,425 
VioletPink16,474,108 
PumpkinOrange16,481,543 
Wheat16,506,238 
LightTan16,510,636 
PinkyRed16,524,871 
Coral16,538,192 
Orangish16,548,426 
Pinky16,549,546 
YellowOrange16,560,129 
Marigold16,564,230 
SandYellow16,572,774 
Straw16,578,169 
YellowishTan16,579,713 
RedOrange16,595,974 
OrangeRed16,597,278 
Watermelon16,598,617 
Grapefruit16,603,478 
Carnation16,611,727 
Orangeish16,616,777 
LightOrange16,624,200 
SoftPink16,625,856 
Butterscotch16,625,991 
OrangeyYellow16,627,989 
PaleRose16,630,213 
LightGold16,637,020 
PaleGold16,637,548 
SandyYellow16,641,651 
PaleGrey16,645,630 
LemonYellow16,645,944 
Lemon16,645,970 
Canary16,645,987 
FireEngineRed16,646,146 
NeonPink16,646,554 
BrightPink16,646,577 
ShockingPink16,646,818 
ReddishPink16,657,492 
LightishRed16,658,250 
Orangered16,663,055 
BarbiePink16,664,229 
BloodOrange16,665,347 
SalmonPink16,677,756 
BlushPink16,679,564 
BubblegumPink16,679,884 
Rosa16,680,612 
LightSalmon16,689,555 
Saffron16,691,721 
Amber16,691,976 
GoldenYellow16,696,853 
PaleMauve16,699,644 
Dandelion16,703,240 
Buff16,709,278 
Parchment16,710,831 
FadedYellow16,711,551 
Ecru16,711,626 
BrightRed16,711,693 
HotPink16,712,333 
ElectricPink16,712,848 
NeonRed16,713,530 
StrongPink16,713,609 
BrightMagenta16,713,960 
LightRed16,729,932 
BrightOrange16,734,976 
CoralPink16,736,611 
CandyPink16,737,257 
BubbleGumPink16,738,735 
Bubblegum16,739,509 
OrangePink16,740,178 
PinkishOrange16,740,940 
Melon16,742,485 
Salmon16,742,764 
CarnationPink16,744,359 
Pink16,744,896 
Tangerine16,749,576 
PastelOrange16,750,159 
PeachyPink16,751,242 
Mango16,754,219 
PaleOrange16,754,518 
YellowishOrange16,755,471 
OrangeYellow16,755,969 
Peach16,756,860 
Apricot16,757,101 
PaleSalmon16,757,146 
PowderPink16,757,456 
BabyPink16,758,734 
PastelPink16,759,501 
Sunflower16,762,130 
LightRose16,762,315 
PalePink16,764,892 
LightPink16,765,407 
LightPeach16,767,153 
SunflowerYellow16,767,491 
SunYellow16,768,802 
YellowTan16,769,902 
PalePeach16,770,477 
DarkCream16,774,042 
VeryLightPink16,774,386 
SunnyYellow16,775,447 
Pale16,775,632 
Manilla16,775,814 
EggShell16,776,388 
BrightYellow16,776,449 
SunshineYellow16,776,503 
ButterYellow16,776,564 
Custard16,776,568 
CanaryYellow16,776,768 
PastelYellow16,776,817 
LightYellow16,776,826 
LightBeige16,776,886 
Yellow16,776,980 
Banana16,777,086 
Butter16,777,089 
PaleYellow16,777,092 
Creme16,777,142 
Cream16,777,154 
Ivory16,777,163 
Eggshell16,777,172 
OffWhite16,777,188 
White16,777,215 
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_EventLevel.md b/Documentation/Help/T_CapyKit_EventLevel.md new file mode 100644 index 0000000..51b2291 --- /dev/null +++ b/Documentation/Help/T_CapyKit_EventLevel.md @@ -0,0 +1,59 @@ +# EventLevel Enumeration + + +Enumeration representing different event level severity values. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public enum EventLevel +``` +**VB** +``` VB +Public Enumeration EventLevel +``` +**C++** +``` C++ +public enum class EventLevel +``` +**F#** +``` F# +type EventLevel +``` + + + +## Members + + + + + + + + + + + + + + + + + + + + + +
Critical0Represents a critical error that requires immediate attention.
Error1Represents an error that prevents the normal execution of the application.
Warning2Represents a warning indicating a non-critical issue that should be addressed.
Information3Represents informational messages that provide useful context to the consumer.
Debug4Represents detailed messages that are typically used for debugging purposes.
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md new file mode 100644 index 0000000..6814285 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md @@ -0,0 +1,65 @@ +# EnumerationExtensions Class + + +Provides static extentions methods for providing additional functionality for Enum types. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static class EnumerationExtensions +``` +**VB** +``` VB + +Public NotInheritable Class EnumerationExtensions +``` +**C++** +``` C++ +[ExtensionAttribute] +public ref class EnumerationExtensions abstract sealed +``` +**F#** +``` F# +[] +[] +[] +type EnumerationExtensions = class end +``` + + +
InheritanceObject → EnumerationExtensions
+ + + +## Methods + + + + + + + + + + + + + + + + + + + +
GetDescriptionAn Enum extension method that gets a description.
GetNameAn Enum extension method that gets a name.
GetPrettyNameAn Enum extension method that gets a human readable name.
GetValueAn Enum extension method that gets an integer value representing the enumation.
Parse(T)(T, String)A T extension method that parses a string into an enumeration.
Parse(T)(T, String, Boolean)A T extension method that parses a string into an enumeration.
+ +## See Also + + +#### Reference +CapyKit.Extensions Namespace diff --git a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md new file mode 100644 index 0000000..de37fd1 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md @@ -0,0 +1,74 @@ +# LINQExtensions Class + + +Provides static extension methods for performing common LINQ operations on IEnumerable(T) and IQueryable(T) collections. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static class LINQExtensions +``` +**VB** +``` VB + +Public NotInheritable Class LINQExtensions +``` +**C++** +``` C++ +[ExtensionAttribute] +public ref class LINQExtensions abstract sealed +``` +**F#** +``` F# +[] +[] +[] +type LINQExtensions = class end +``` + + +
InheritanceObject → LINQExtensions
+ + + +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Distinct(T, U)Enumerates distinct items in this collection as defined by the key property.
Filter(T)(IEnumerable(T), Func(T, Boolean))Filters out items matching a predicate from the collection.
Filter(T)(IQueryable(T), Expression(Func(T, Boolean)))Filters out items matching a predicate from the collection.
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))An IQueryable<T> extension method that left outer join.
Page(T)(IEnumerable(T), Int32, Int32)Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
Page(T)(IQueryable(T), Int32, Int32)Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
PageCount(T)(IEnumerable(T), Int32)The number of pages of pageSize size in the given collection.
PageCount(T)(IQueryable(T), Int32)The number of pages of pageSize size in the given collection.
+ +## See Also + + +#### Reference +CapyKit.Extensions Namespace diff --git a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md new file mode 100644 index 0000000..96ae019 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md @@ -0,0 +1,53 @@ +# StringExtensions Class + + +Provides static extentions methods for providing additional functionality for String types. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static class StringExtensions +``` +**VB** +``` VB + +Public NotInheritable Class StringExtensions +``` +**C++** +``` C++ +[ExtensionAttribute] +public ref class StringExtensions abstract sealed +``` +**F#** +``` F# +[] +[] +[] +type StringExtensions = class end +``` + + +
InheritanceObject → StringExtensions
+ + + +## Methods + + + + + + + +
IfNullOrEmptyReplaces a null or empty string with a specified replacement string.
IfNullOrWhiteSpaceReplaces a null or whitespace string with a specified replacement string.
+ +## See Also + + +#### Reference +CapyKit.Extensions Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md new file mode 100644 index 0000000..45642cf --- /dev/null +++ b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md @@ -0,0 +1,59 @@ +# CompressionHelper Class + + +A class that contains methods for managing data compression. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static class CompressionHelper +``` +**VB** +``` VB +Public NotInheritable Class CompressionHelper +``` +**C++** +``` C++ +public ref class CompressionHelper abstract sealed +``` +**F#** +``` F# +[] +[] +type CompressionHelper = class end +``` + + +
InheritanceObject → CompressionHelper
+ + + +## Methods + + + + + + + + + + + + + + + + +
CompressCompresses a given object using the gzip algorithm.
CompressToStringCompresses a given object to a string using base64 encoding of gzip format.
Decompress(T)(Byte[])Decompresses a given compressed gzip byte stream.
Decompress(T)(String)Decompresses a given base64 encoded string of gzip format.
DecompressToStringDecompresses the given base64 string in gzip format.
+ +## See Also + + +#### Reference +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md new file mode 100644 index 0000000..3d38a84 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md @@ -0,0 +1,70 @@ +# LanguageHelper Class + + +\[Missing <summary> documentation for "T:CapyKit.Helpers.LanguageHelper"\] + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class LanguageHelper +``` +**VB** +``` VB +Public Class LanguageHelper +``` +**C++** +``` C++ +public ref class LanguageHelper +``` +**F#** +``` F# +type LanguageHelper = class end +``` + + +
InheritanceObject → LanguageHelper
+ + + +## Constructors + + + + +
LanguageHelperInitializes a new instance of the LanguageHelper class
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
CamelCaseToHumanReadableConverts camel case text to human readable text.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md new file mode 100644 index 0000000..7215b6b --- /dev/null +++ b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md @@ -0,0 +1,88 @@ +# SecurityHelper Class + + +A class that contains methods for managing secure data processing and cryptography. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class SecurityHelper +``` +**VB** +``` VB +Public Class SecurityHelper +``` +**C++** +``` C++ +public ref class SecurityHelper +``` +**F#** +``` F# +type SecurityHelper = class end +``` + + +
InheritanceObject → SecurityHelper
+ + + +## Constructors + + + + +
SecurityHelperInitializes a new instance of the SecurityHelper class
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CompareHashedPasswordCompares an unencrypted providedPassword with a stored, encrypted existingPassword.
CompareSessionIDCompares two session identifiers.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetCalendarKeyGets a calendar key that is 32 characters long.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetRandomPasswordGets a cryptographically strong random password.
GetTypeGets the Type of the current instance.
(Inherited from Object)
HashPasswordHashes an unencrypted password.
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Pbkdf2 
SHA256HashProduces a SHA256 hash from a given value.
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md new file mode 100644 index 0000000..5a28a7b --- /dev/null +++ b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md @@ -0,0 +1,59 @@ +# SerializationHelper Class + + +\[Missing <summary> documentation for "T:CapyKit.Helpers.SerializationHelper"\] + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public static class SerializationHelper +``` +**VB** +``` VB +Public NotInheritable Class SerializationHelper +``` +**C++** +``` C++ +public ref class SerializationHelper abstract sealed +``` +**F#** +``` F# +[] +[] +type SerializationHelper = class end +``` + + +
InheritanceObject → SerializationHelper
+ + + +## Methods + + + + + + + + + + + + + + + + +
Deserialize(T)(Byte[])Deserializes an object to a given T type.
Deserialize(T)(Stream)Deserializes an object to a given T type.
Deserialize(T)(String)Deserializes a JSON encoded string to the given T.
SerializeToBytesSerializes an object to a byte array.
SerializeToStringSerializes an object to a JSON encoded string.
+ +## See Also + + +#### Reference +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md new file mode 100644 index 0000000..054e28b --- /dev/null +++ b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md @@ -0,0 +1,52 @@ +# IPasswordAlgorithm Interface + + +Defines the contract for password encryption algorithms. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public interface IPasswordAlgorithm +``` +**VB** +``` VB +Public Interface IPasswordAlgorithm +``` +**C++** +``` C++ +public interface class IPasswordAlgorithm +``` +**F#** +``` F# +type IPasswordAlgorithm = interface end +``` + + + +## Properties + + + + +
AlgorithmNameGets the name of the algorithm.
+ +## Methods + + + + + + + +
CompareCompares the given plaintext password with an encrypted value using PBKDF2 algorithm.
EncryptEncrypts the given password using a defined algorithm.
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Password.md b/Documentation/Help/T_CapyKit_Password.md new file mode 100644 index 0000000..f428f6c --- /dev/null +++ b/Documentation/Help/T_CapyKit_Password.md @@ -0,0 +1,73 @@ +# Password Class + + +Represents a password with its hash, salt and algorithm used for encryption. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class Password +``` +**VB** +``` VB +Public Class Password +``` +**C++** +``` C++ +public ref class Password +``` +**F#** +``` F# +type Password = class end +``` + + +
InheritanceObject → Password
+ + + +## Properties + + + + + + + + + + +
AlgorithmGets or sets the algorithm used for password encryption.
HashGets or sets the hash of the password.
SaltGets or sets the salt used for encryption.
+ +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Overrides Object.ToString())
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md new file mode 100644 index 0000000..d14719d --- /dev/null +++ b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md @@ -0,0 +1,92 @@ +# Pbkdf2Algorithm Class + + +Implements the PBKDF2 algorithm for password encryption. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class Pbkdf2Algorithm : IPasswordAlgorithm +``` +**VB** +``` VB +Public Class Pbkdf2Algorithm + Implements IPasswordAlgorithm +``` +**C++** +``` C++ +public ref class Pbkdf2Algorithm : IPasswordAlgorithm +``` +**F#** +``` F# +type Pbkdf2Algorithm = + class + interface IPasswordAlgorithm + end +``` + + + +
InheritanceObject → Pbkdf2Algorithm
ImplementsIPasswordAlgorithm
+ + + +## Constructors + + + + +
Pbkdf2AlgorithmInitializes a new instance of the Pbkdf2Algorithm class
+ +## Properties + + + + +
AlgorithmNameGets the name of the algorithm.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + +
EncryptEncrypts the given password using a PBKDF2 algorithm.
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## Fields + + + + + + + +
ITERATIONSThe default number of iterations.
LENGTH(Immutable) The default length.
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_PoolItem_1.md b/Documentation/Help/T_CapyKit_PoolItem_1.md new file mode 100644 index 0000000..3abe469 --- /dev/null +++ b/Documentation/Help/T_CapyKit_PoolItem_1.md @@ -0,0 +1,82 @@ +# PoolItem<T> Class + + +A pool item. This class cannot be inherited. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public sealed class PoolItem + +``` +**VB** +``` VB +Public NotInheritable Class PoolItem(Of T) +``` +**C++** +``` C++ +generic +public ref class PoolItem sealed +``` +**F#** +``` F# +[] +type PoolItem<'T> = class end +``` + + +
InheritanceObject → PoolItem(T)
+ + + +#### Type Parameters +
The type of the pooled item.
+ +## Properties + + + + + + + + + + + + + +
IndexGets the zero-based index of the pooled item.
ItemGets the pooled resource.
LockedGets a value indicating whether this object is locked or not.
TypeNameGets the name of the Type of the pooled item.
+ +## Methods + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
ReleaseLockReleases the lock on the item.
SetLockSets the lock on the item indicating that it is in use.
ToStringReturns a string that represents the current object and its lock state.
(Overrides Object.ToString())
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Pool_1.md b/Documentation/Help/T_CapyKit_Pool_1.md new file mode 100644 index 0000000..6ce17a9 --- /dev/null +++ b/Documentation/Help/T_CapyKit_Pool_1.md @@ -0,0 +1,84 @@ +# Pool<T> Class + + +A managed pool of resources. This class provides a thread-safe way to manage a collection of objects of type *T*. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class Pool + +``` +**VB** +``` VB +Public Class Pool(Of T) +``` +**C++** +``` C++ +generic +public ref class Pool +``` +**F#** +``` F# +type Pool<'T> = class end +``` + + +
InheritanceObject → Pool(T)
+ + + +#### Type Parameters +
The type of objects to be managed by the pool.
+ +## Constructors + + + + + + + + + + +
Pool(T)(IEnumerable(T))Initializes a new instance of the Pool(T) class with the specified collection of items.
Pool(T)(Int32)Initializes a new instance of the Pool(T) class with the specified pool size.
Pool(T)(Int32, Func(T))Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetAvailableItemGets the first available item from the pool and sets its lock.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReleaseItemReleases the lock on the specified item and returns it to the pool.
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_PropertyComparer_2.md b/Documentation/Help/T_CapyKit_PropertyComparer_2.md new file mode 100644 index 0000000..2237ebc --- /dev/null +++ b/Documentation/Help/T_CapyKit_PropertyComparer_2.md @@ -0,0 +1,86 @@ +# PropertyComparer<T, U> Class + + +A object comparer that can accept a lambda expression to compare properties. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d + +**C#** +``` C# +public class PropertyComparer : IEqualityComparer + +``` +**VB** +``` VB +Public Class PropertyComparer(Of T, U) + Implements IEqualityComparer(Of T) +``` +**C++** +``` C++ +generic +public ref class PropertyComparer : IEqualityComparer +``` +**F#** +``` F# +type PropertyComparer<'T, 'U> = + class + interface IEqualityComparer<'T> + end +``` + + + +
InheritanceObject → PropertyComparer(T, U)
ImplementsIEqualityComparer(T)
+ + + +#### Type Parameters +
Generic type parameter of the parent object.
Generic type parameter of the property value.
+ +## Example +using System; using System.Collections.Generic; using System.Linq; class Program { static void Main(string[] args) { var people = new List<Person> { new Person { Name = "Alice", Age = 30 }, new Person { Name = "Bob", Age = 30 }, new Person { Name = "Charlie", Age = 35 } }; var comparer = new PropertyComparer<Person, int>(p => p.Age); var distinctPeople = people.Distinct(comparer).ToList(); foreach (var person in distinctPeople) { Console.WriteLine($"{person.Name} - {person.Age}"); } } } class Person { public string Name { get; set; } public int Age { get; set; } } + +## Constructors + + + + +
PropertyComparer(T, U)Constructor.
+ +## Methods + + + + + + + + + + + + + + + + + + + + + + + + + +
Equals(Object)Determines whether the specified object is equal to the current object.
(Inherited from Object)
Equals(T, T)Determines whether the specified properties are equal.
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode()Serves as the default hash function.
(Inherited from Object)
GetHashCode(T)Returns a hash code for the specified object.
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)
+ +## See Also + + +#### Reference +CapyKit Namespace diff --git a/Documentation/Help/_Footer.md b/Documentation/Help/_Footer.md new file mode 100644 index 0000000..f4a205e --- /dev/null +++ b/Documentation/Help/_Footer.md @@ -0,0 +1,6 @@ +CapyKit + + + + +Send comments on this topic to [](mailto:?Subject=CapyKit) diff --git a/Documentation/Help/_Sidebar.md b/Documentation/Help/_Sidebar.md new file mode 100644 index 0000000..c412f32 --- /dev/null +++ b/Documentation/Help/_Sidebar.md @@ -0,0 +1,135 @@ +- [Welcome to the [TODO: Add project name]](849aa079-3d64-4cf1-966f-44af23c73160) +- [Version History](7d36447b-0aab-4ce9-b5ed-e60ec5bee103) + - [Version 1.0.0.0](fa7407d1-9116-4ad7-a9ab-ed094685b070) +- [CapyKit Namespace](N_CapyKit) + - [CapyEventArgs Class](T_CapyKit_CapyEventArgs) + - [CapyEventArgs Constructor](M_CapyKit_CapyEventArgs__ctor) + - [CapyEventArgs Properties](Properties_T_CapyKit_CapyEventArgs) + - [Level Property](P_CapyKit_CapyEventArgs_Level) + - [Message Property](P_CapyKit_CapyEventArgs_Message) + - [MethodName Property](P_CapyKit_CapyEventArgs_MethodName) + - [CapyEventArgs Methods](Methods_T_CapyKit_CapyEventArgs) + - [CapyEventHandler Delegate](T_CapyKit_CapyEventHandler) + - [CapyEventReporter Class](T_CapyKit_CapyEventReporter) + - [CapyEventReporter Methods](Methods_T_CapyKit_CapyEventReporter) + - [Subscribe Method](M_CapyKit_CapyEventReporter_Subscribe) + - [Unsubscribe Method](M_CapyKit_CapyEventReporter_Unsubscribe) + - [Color Enumeration](T_CapyKit_Color) + - [EventLevel Enumeration](T_CapyKit_EventLevel) + - [IPasswordAlgorithm Interface](T_CapyKit_IPasswordAlgorithm) + - [IPasswordAlgorithm Properties](Properties_T_CapyKit_IPasswordAlgorithm) + - [AlgorithmName Property](P_CapyKit_IPasswordAlgorithm_AlgorithmName) + - [IPasswordAlgorithm Methods](Methods_T_CapyKit_IPasswordAlgorithm) + - [Compare Method](M_CapyKit_IPasswordAlgorithm_Compare) + - [Encrypt Method](M_CapyKit_IPasswordAlgorithm_Encrypt) + - [Password Class](T_CapyKit_Password) + - [Password Properties](Properties_T_CapyKit_Password) + - [Algorithm Property](P_CapyKit_Password_Algorithm) + - [Hash Property](P_CapyKit_Password_Hash) + - [Salt Property](P_CapyKit_Password_Salt) + - [Password Methods](Methods_T_CapyKit_Password) + - [ToString Method](M_CapyKit_Password_ToString) + - [Pbkdf2Algorithm Class](T_CapyKit_Pbkdf2Algorithm) + - [Pbkdf2Algorithm Constructor](M_CapyKit_Pbkdf2Algorithm__ctor) + - [Pbkdf2Algorithm Properties](Properties_T_CapyKit_Pbkdf2Algorithm) + - [AlgorithmName Property](P_CapyKit_Pbkdf2Algorithm_AlgorithmName) + - [Pbkdf2Algorithm Methods](Methods_T_CapyKit_Pbkdf2Algorithm) + - [Encrypt Method](M_CapyKit_Pbkdf2Algorithm_Encrypt) + - [Pbkdf2Algorithm Fields](Fields_T_CapyKit_Pbkdf2Algorithm) + - [ITERATIONS Field](F_CapyKit_Pbkdf2Algorithm_ITERATIONS) + - [LENGTH Field](F_CapyKit_Pbkdf2Algorithm_LENGTH) + - [Pool Class](T_CapyKit_Pool_1) + - [Pool Constructor](Overload_CapyKit_Pool_1__ctor) + - [Pool(IEnumerable) Constructor](M_CapyKit_Pool_1__ctor) + - [Pool(Int32) Constructor](M_CapyKit_Pool_1__ctor_1) + - [Pool(Int32, Func) Constructor](M_CapyKit_Pool_1__ctor_2) + - [Pool Methods](Methods_T_CapyKit_Pool_1) + - [GetAvailableItem Method](M_CapyKit_Pool_1_GetAvailableItem) + - [ReleaseItem Method](M_CapyKit_Pool_1_ReleaseItem) + - [PoolItem Class](T_CapyKit_PoolItem_1) + - [PoolItem Properties](Properties_T_CapyKit_PoolItem_1) + - [Index Property](P_CapyKit_PoolItem_1_Index) + - [Item Property](P_CapyKit_PoolItem_1_Item) + - [Locked Property](P_CapyKit_PoolItem_1_Locked) + - [TypeName Property](P_CapyKit_PoolItem_1_TypeName) + - [PoolItem Methods](Methods_T_CapyKit_PoolItem_1) + - [ReleaseLock Method](M_CapyKit_PoolItem_1_ReleaseLock) + - [SetLock Method](M_CapyKit_PoolItem_1_SetLock) + - [ToString Method](M_CapyKit_PoolItem_1_ToString) + - [PropertyComparer Class](T_CapyKit_PropertyComparer_2) + - [PropertyComparer Constructor](M_CapyKit_PropertyComparer_2__ctor) + - [PropertyComparer Methods](Methods_T_CapyKit_PropertyComparer_2) + - [Equals Method](Overload_CapyKit_PropertyComparer_2_Equals) + - [Equals(T, T) Method](M_CapyKit_PropertyComparer_2_Equals) + - [GetHashCode Method](Overload_CapyKit_PropertyComparer_2_GetHashCode) + - [GetHashCode(T) Method](M_CapyKit_PropertyComparer_2_GetHashCode) +- [CapyKit.Attributes Namespace](N_CapyKit_Attributes) + - [EnumerationAttribute Class](T_CapyKit_Attributes_EnumerationAttribute_1) + - [EnumerationAttribute Constructor](M_CapyKit_Attributes_EnumerationAttribute_1__ctor) + - [EnumerationAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationAttribute_1) + - [Value Property](P_CapyKit_Attributes_EnumerationAttribute_1_Value) + - [EnumerationAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationAttribute_1) + - [EnumerationDescriptionAttribute Class](T_CapyKit_Attributes_EnumerationDescriptionAttribute) + - [EnumerationDescriptionAttribute Constructor](M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor) + - [EnumerationDescriptionAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute) + - [EnumerationDescriptionAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute) +- [CapyKit.Extensions Namespace](N_CapyKit_Extensions) + - [EnumerationExtensions Class](T_CapyKit_Extensions_EnumerationExtensions) + - [EnumerationExtensions Methods](Methods_T_CapyKit_Extensions_EnumerationExtensions) + - [GetDescription Method](M_CapyKit_Extensions_EnumerationExtensions_GetDescription) + - [GetName Method](M_CapyKit_Extensions_EnumerationExtensions_GetName) + - [GetPrettyName Method](M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName) + - [GetValue Method](M_CapyKit_Extensions_EnumerationExtensions_GetValue) + - [Parse Method](Overload_CapyKit_Extensions_EnumerationExtensions_Parse) + - [Parse(T, String) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1) + - [Parse(T, String, Boolean) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1) + - [LINQExtensions Class](T_CapyKit_Extensions_LINQExtensions) + - [LINQExtensions Methods](Methods_T_CapyKit_Extensions_LINQExtensions) + - [Distinct Method](M_CapyKit_Extensions_LINQExtensions_Distinct__2) + - [Filter Method](Overload_CapyKit_Extensions_LINQExtensions_Filter) + - [Filter(IEnumerable, Func) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1) + - [Filter(IQueryable, Expression>) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1_1) + - [LeftOuterJoin Method](Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin) + - [LeftOuterJoin(IEnumerable, IEnumerable, Func, Func, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4) + - [LeftOuterJoin(IQueryable, IQueryable, Expression>, Expression>, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1) + - [Page Method](Overload_CapyKit_Extensions_LINQExtensions_Page) + - [Page(IEnumerable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1) + - [Page(IQueryable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1_1) + - [PageCount Method](Overload_CapyKit_Extensions_LINQExtensions_PageCount) + - [PageCount(IEnumerable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1) + - [PageCount(IQueryable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1_1) + - [StringExtensions Class](T_CapyKit_Extensions_StringExtensions) + - [StringExtensions Methods](Methods_T_CapyKit_Extensions_StringExtensions) + - [IfNullOrEmpty Method](M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty) + - [IfNullOrWhiteSpace Method](M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace) +- [CapyKit.Helpers Namespace](N_CapyKit_Helpers) + - [CompressionHelper Class](T_CapyKit_Helpers_CompressionHelper) + - [CompressionHelper Methods](Methods_T_CapyKit_Helpers_CompressionHelper) + - [Compress Method](M_CapyKit_Helpers_CompressionHelper_Compress) + - [CompressToString Method](M_CapyKit_Helpers_CompressionHelper_CompressToString) + - [Decompress Method](Overload_CapyKit_Helpers_CompressionHelper_Decompress) + - [Decompress(Byte[]) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1) + - [Decompress(String) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1_1) + - [DecompressToString Method](M_CapyKit_Helpers_CompressionHelper_DecompressToString) + - [LanguageHelper Class](T_CapyKit_Helpers_LanguageHelper) + - [LanguageHelper Constructor](M_CapyKit_Helpers_LanguageHelper__ctor) + - [LanguageHelper Methods](Methods_T_CapyKit_Helpers_LanguageHelper) + - [CamelCaseToHumanReadable Method](M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable) + - [SecurityHelper Class](T_CapyKit_Helpers_SecurityHelper) + - [SecurityHelper Constructor](M_CapyKit_Helpers_SecurityHelper__ctor) + - [SecurityHelper Methods](Methods_T_CapyKit_Helpers_SecurityHelper) + - [CompareHashedPassword Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword) + - [CompareSessionID Method](M_CapyKit_Helpers_SecurityHelper_CompareSessionID) + - [GetCalendarKey Method](M_CapyKit_Helpers_SecurityHelper_GetCalendarKey) + - [GetRandomPassword Method](M_CapyKit_Helpers_SecurityHelper_GetRandomPassword) + - [HashPassword Method](M_CapyKit_Helpers_SecurityHelper_HashPassword) + - [Pbkdf2 Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2) + - [SHA256Hash Method](M_CapyKit_Helpers_SecurityHelper_SHA256Hash) + - [SerializationHelper Class](T_CapyKit_Helpers_SerializationHelper) + - [SerializationHelper Methods](Methods_T_CapyKit_Helpers_SerializationHelper) + - [Deserialize Method](Overload_CapyKit_Helpers_SerializationHelper_Deserialize) + - [Deserialize(Byte[]) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1) + - [Deserialize(Stream) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1) + - [Deserialize(String) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2) + - [SerializeToBytes Method](M_CapyKit_Helpers_SerializationHelper_SerializeToBytes) + - [SerializeToString Method](M_CapyKit_Helpers_SerializationHelper_SerializeToString) diff --git a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md b/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md new file mode 100644 index 0000000..b4b2855 --- /dev/null +++ b/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md @@ -0,0 +1,15 @@ +# Version 1.0.0.0 + +Version [TODO: Version] was released on [TODO: Date]. + + +## Changes in This Release +

  • [TODO: Add change items here]

+ + + +## See Also + + +#### Other Resources +Version History diff --git a/Documentation/Help/icons/Help.png b/Documentation/Help/icons/Help.png new file mode 100644 index 0000000000000000000000000000000000000000..945e89fb96271c85b901f1e656e9920c788c48e6 GIT binary patch literal 4942 zcmV-U6S3@xP)Un>oiIt;G^8NUH0d90 z(2x}zZQ3xzkeJw%@USE!+xQ{diTsdd>n&YfN%vme$L=|&f9zga z5J*T!&dh3eM`!o`zQ5o1_xpX%S;6}ldpbJS0GomJz#3pR&9nwAAdfD6DG;3RN# zZ)fM3_w(E3A%4{d_H=YK0v`oF<~YvgmX?;>>eZ{`tt(g7E?Kf9QC(f_x~?nB^F7Zq zb8~av#Kc5q@Y1F9g$oz*!^6XszV9Ceo&yf-?d+WVtpnK8(NP6Fpp<&7skzzNv13Qw zh7B89gb-?OZjQ0>NrpyJTprCZmCBGWc({(Bp}vaNmKv^UYM`m9kz_K7F-D&_abmcu zt8036WW?86KMg#)x3e?*TLG}AqvIB()K{8YT2|b5-+jwhu3T9^GczN9)_;-yffOUN z3C6RvOlKn$Jn(&kF$VC!cwpyo$&-xbXltBj`=%A#xb_3o*4FC5!NJtNefx$-hKDa} zt^aOsXXoMHD1bd39iNHCVqdxc{`)I7ZQk5EGczNP96QOtWRje1W+W}SG+H8?^RPyP zH5hBL!XPYQeGEQA`v^RYKTn05C*jO-_bpZIy7Lwq8yn5hBS$Vh_uO;&LZR^YdpkS- zg(Xn>z+E0J>(MNC6TE`B)a*RuJt(==^Z4e1< zHAa{3129H|wqUHn2#2}6OV7y(h6eiBw0?E;_MJPIj*X8uwqJW~;=O=)M*w>|Iy%;^ zTeth+M;_TcH8mw)?iygEcpaw);poq@lstoy1cqA^c-?A@G5Eg5_k4V9Fh*mI#u@|G zV6DYkjkN}CEWQRK6bOe4BSm_8df9M&qx{H+KioV#JY3)2-d^>~K>QqlJsll?(9+WK z=w}~&bmQdYq zK^wz-p@h~x5(~nhwZT}h#-g=FNJXX~dFAyZY+2jLZMWaPw6Cvk*@pG&r@Fek&%PS~ z@iybP#bU8#m9MjmKB>;O*61+v3uYlvKqb;()6l77^4W6ip2-H>|4Uo)0$C)>6r#H^(WIe543y zW~{+z6GQ?@ItQ1}pWvQ5w?``~E9cIiJJ-5>`}P;Qy1V_i1CWcZA82lAS+RM`mX*g( z^f9ehabehJB2`4Gkh?|)ytamX$>aK!aaJyqZ-3`ohP9wI6bc%Q&%GaNXB&wd<|5AAP6y%h3A`N~tg0d+)u=)9JK4 zc1|;#ig5B=hKK_u^t!bs@Rre7U!#5f3ym)iAq0*iQI1PCTjW#swDHKtR+7yZ!lbrg zWWi`b$yXRz$+y0DjM33CardrW4N}TK`_nIcq59n-aCcL4bEK`Ut?p3waZ1ig&Rx!+ z6hUb;I;b+%V02JztTkvIMARC)@Iv4BDV4kha6%9m7y?mF1nqn5+|)=!d01-@Ve=y_ z$J#>4M#!6LzW4nXx$(vumsD3*FPBp8csl?mJb!G*jvaOBbXpz0P(?u)#!`7)S7Njc zn^Isj1m!T`t`AtWF0%jN8TNM#GdU}nFIgNVxpiYBk3X~tfd~x*B?a2ItZc5LuA)dP zuW%(u341FVTWt11Y2KnU2C&Udm+z^|Znz|Es5in%{YEMVU8pm;-*u8uAilcA# z$+XwR`O8ISa~i^OxzLQbS~YxaSW+WttjhBBZ+G#J|8;?ZsRT2{IGMadY7V+jrV#jS zUDtrGEkXo^M<9sC9QMC@hS6z5)RBm=Aqo+6a$x~9g~B}7uZXZ|(@n7>y}ip@TU-CT zudgq&I0BnnT3T{K2zBJ-Wzx=au1pk=!eX_>hF)GMpW!(kF?64t=H;#wJ~3*SwF5yy zVlB$G80+%g{X;zP;cIB9iQ^j(LShg&R$#Sd4`0VT~BeO{cGr55CGDs|J(6F#Jhz5ayR$H*(R@4!}U~O5< z*{gz1`#35>AwSQI@DM_xltVP)kj@u5dtr)Pp%%~6fDVWuZ3qIC@TqVFXD-e#J)Neh zsY#BHk8cJJ0Dd`%*R-~_CPzjm7|T>Kn<;?sAxvCr4AyA0@iErJ`WoX0p4Qd}>tSu_ zsuIa%{R*k)54jVq%iaY=(TkfDo38SEfm2z;!?nbaA09Qh*d7gariJ zDl!Gdz@^JHH8)oZA#PZdyEs7m(xpqQ4;?;5-bfy6|<2zkcCYB?EMZ<#mWo;u62mt~G!eweY zL(7^KN-5O{L_+px2dHvgSB#9N(55}8?KZ6agx+RRK7@5!YfUCsBwzILJU`^Ep-|Fn zzOIso?n+Q!Wyu!}t}F3;4=KU(4S)6YL9|m(g(Je}WRN?8pag}0gb)ZJ5mIsf;vn0% zTrVQgXl)n)RR#b+HaCwiG*)|9DFCy`%>(oe8tQB7zEUkfjN#i(yNwvvp ziazZ5`yX-mY>6d}jR*oe0-7uyVJ6s+cEZCklG#37v+u_ND^ZViMZqgtyKu+5Qzj8q$2L}%rl1=o{rMcPy-mGkVqkrQh^X5^9AM9 zUC4oOcfh4cOd1lEQ3eJE@|jF#aPd?L{B-EbmD%Q|Wh9&wm=f0au||_G6q%mMqkRvH z#*}-4)e8%EYc&E(MNE;bR2XfL5+V`BeBR^G$w_Kz>QGYRI1aAk;yNx$IXKb@&PoM6 zLOCc|J`}DaagDjteF))jwtb=Z8tGEFyQ5KxorQrbNzr<1|au#cJ}+e|Ju=`M~Am;+JKn9fG%b6 z{8FH8j30VESW=diX~1WY4k!h#w4}0v!KpZxrz;suRWO#RCK{_oNr{vSAzXxTkU|mk zp~Z)@a0nDiSd`7vSnads`Zl@`9m-5hPIirtkEa#`DEEOM^z`&>*uH(cx%ak}^50$@ zL)dx*F2)2+Ezm}R)D3Ed#gPIf!I1)sprs+ky0$9nlL5!aXA~#<=djj62^DNrAVY&g z;lH4OM96B35IzcxGCA(vc|D0l!VX-%>|eQZr5Bh7N^b}7(!}`qW3TqYCNQ`kYT4Aj~T7yFlmuWtA|3+$SYHatBBl**3&OD#VWTry^3%d!6 zJIMaY$;op)Jw2Cq|NbY~u}0$PG!6wUr3J|lgcy_vazF_|#8IqnsYFT#$5AN9L8;(e zEO=B`_>??@B{bM7jCL?ap^d^Afz=XWERHB4y-BvLt>pGwxAOgGo|zpP898?R`0*pa z98h>i0DC(-^TwFJ+4qAVc-d?=^VPrjW7=xQh%y`Om;G?_zXt zuynMquh@I!$g{;_F-7pXYJooRw!P7=?(XqhZoYZs{Q2|i@4D-*#?9;7==^me_(d`TdsL`j9CR6rFKTt_1g={e20%X2u=r!uC<&X@S{YZv(DcQ26l z8c`~W(Gp`MT1zY*b~XUM8orSNW|RTu0%k;NEpy##5G_lheF* zbc_Rs#yE0TBV)^P-6+P0kn2IKlGZ1p@j zpM5rS=GK>KLF1bz--XGz9$-2IVtd~n-lRh5>i(|-06=ZovZeOMb?ZJ}Q&aONwRLrs zn>TJu?!4oU`a-cNN+l12qW|0_E)P#IHlC(X(8OaA8tbcRX{uwzHOq*_6p5-zVv&e_ z?Zp=h$B!K=TuG;A&;InMKYF9L_w{TxJ4(R!6z@>;-wyx?dPZd1wrwq|+uC*|5{cif ztgO7Lwx*`Ee%-nytJ>RR_4V~6lS$(7_`*ZQVv%$@&Ghs%6JukXK6EHIJUy+)(&_%o zSFXHq^3TU)AvPc)tJ^zo)E|6=l8rR9!X<=w{r1EgJ;Fikb~4FCWD M07*qoM6N<$f`j^SBme*a literal 0 HcmV?d00001 diff --git a/Documentation/Help/media/AlertCaution.png b/Documentation/Help/media/AlertCaution.png new file mode 100644 index 0000000000000000000000000000000000000000..8c0bc2a185cf24a72b514be287783854b392272f GIT binary patch literal 334 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Ea{HEjtmSN`?>!lvI6-E$sR$z z3=CCj3=9n|3=F@3LJcn%7)lKo7+xhXFj&oCU=S~uvn$XBD8ZKG?e4zedab@D7E0Y45*_s)* zu(n&OJmo9)I5qKU>tUHmMLuWh^NkGu@2#BR>^1F;!H@F?KFpsWHRpjs`xG6!+bfwE zrhVd{sq?OH3earT64!{5l*E!$tK_0oAjM#0U}UIkV5nmdKI;Vst0QN#@rT_o{ literal 0 HcmV?d00001 diff --git a/Documentation/Help/media/AlertLanguage.png b/Documentation/Help/media/AlertLanguage.png new file mode 100644 index 0000000000000000000000000000000000000000..4831dbcfe510c2db5740c3aa4c168eb6f4a73a7f GIT binary patch literal 543 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Ea{HEjtmSN`?>!lvI6-E$sR$z z3=CCj3=9n|3=F@3LJcn%7)lKo7+xhXFj&oCU=S~uvn$XBD8ZKG?e4X*cBw5g&wl%GyF{RfW%8L2mtU**Z2fjh!Z^zN zrui|S#TrFZ?IT<{5 zzE@{(5cRK_bN)HI*GjvF$tJ$~j1Jj%gS_@mPqjR;=}mI-lGM;^x6+^AS+MR=REgEx zw<@07>h^vp|H%2R#lJUUMb36$2&$I2MwFx^mZVxG7o`Fz1|tI_LtO(yT|<))BV#L5 rQ!66_Z36=<0|PO;v)fQK!lvI6-E$sR$z z3=CCj3=9n|3=F@3LJcn%7)lKo7+xhXFj&oCU=S~uvn$XBD8ZKG?e4f!b%6E-E`dJo3??8d5J5hW>!C8<`)MX5lF!N|bKP}jgv*T^8m$k58r*vi0C+rYrez+m=fy{RY~ ca`RI%(<*Umc=c|YCQt)|r>mdKI;Vst0Lz|`sQ>@~ literal 0 HcmV?d00001 diff --git a/Documentation/Help/media/AlertSecurity.png b/Documentation/Help/media/AlertSecurity.png new file mode 100644 index 0000000000000000000000000000000000000000..4f24c9e72ac5101515609f9b865ec053a244eee6 GIT binary patch literal 434 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Ea{HEjtmSN`?>!lvI6-E$sR$z z3=CCj3=9n|3=F@3LJcn%7)lKo7+xhXFj&oCU=S~uvn$XBD8ZKG?e4Jdr$YeefALTk7>1??E+ z88<5KJ88&tA5(=k2En0uyhY z@jFwau&Aq}ulD}@(9+2wo-T4qLC5EOuUoz9`w|ugt><@i)lO~NGwY_7X5*?`GV>O- ziZjfAaB*v{_WgrL{dpC2maXevRN-H0z+KPUmbaO8lW+?6k}0$1D*QX9x736ocHK*U zyH(5eBo3-Ef;^>K;u=wsl30>zm0Xkxq!^40j0|)Q4RnnRLkumf42`W!4YdsntPBhU hdih_WXvob^$xN%nts(Kk_AsCZ22WQ%mvv4FO#pC9lB56t literal 0 HcmV?d00001 diff --git a/Documentation/Help/media/AlertToDo.png b/Documentation/Help/media/AlertToDo.png new file mode 100644 index 0000000000000000000000000000000000000000..bea067f15262d17fd69aac8b208f0c9aeddb2ea8 GIT binary patch literal 341 zcmeAS@N?(olHy`uVBq!ia0vp^0wB!61|;P_|4#%`Ea{HEjtmSN`?>!lvI6-E$sR$z z3=CCj3=9n|3=F@3LJcn%7)lKo7+xhXFj&oCU=S~uvn$XBD8ZKG?e4i_?ns^n&FZ2Z|+Vs>Yc{)Pl$mu-xa3B`)s8@b$L4Q9kTTy6OxF#YnzhW05@ zKDG=D)d3n#SAQ8g0Ig6hag8WRNi0dVN-jzTQVd20Mh3cuhPpI8|$upn^22WQ%mvv4FO#oI?Wo!Td literal 0 HcmV?d00001 diff --git a/Documentation/icons/Help.png b/Documentation/icons/Help.png new file mode 100644 index 0000000000000000000000000000000000000000..945e89fb96271c85b901f1e656e9920c788c48e6 GIT binary patch literal 4942 zcmV-U6S3@xP)Un>oiIt;G^8NUH0d90 z(2x}zZQ3xzkeJw%@USE!+xQ{diTsdd>n&YfN%vme$L=|&f9zga z5J*T!&dh3eM`!o`zQ5o1_xpX%S;6}ldpbJS0GomJz#3pR&9nwAAdfD6DG;3RN# zZ)fM3_w(E3A%4{d_H=YK0v`oF<~YvgmX?;>>eZ{`tt(g7E?Kf9QC(f_x~?nB^F7Zq zb8~av#Kc5q@Y1F9g$oz*!^6XszV9Ceo&yf-?d+WVtpnK8(NP6Fpp<&7skzzNv13Qw zh7B89gb-?OZjQ0>NrpyJTprCZmCBGWc({(Bp}vaNmKv^UYM`m9kz_K7F-D&_abmcu zt8036WW?86KMg#)x3e?*TLG}AqvIB()K{8YT2|b5-+jwhu3T9^GczN9)_;-yffOUN z3C6RvOlKn$Jn(&kF$VC!cwpyo$&-xbXltBj`=%A#xb_3o*4FC5!NJtNefx$-hKDa} zt^aOsXXoMHD1bd39iNHCVqdxc{`)I7ZQk5EGczNP96QOtWRje1W+W}SG+H8?^RPyP zH5hBL!XPYQeGEQA`v^RYKTn05C*jO-_bpZIy7Lwq8yn5hBS$Vh_uO;&LZR^YdpkS- zg(Xn>z+E0J>(MNC6TE`B)a*RuJt(==^Z4e1< zHAa{3129H|wqUHn2#2}6OV7y(h6eiBw0?E;_MJPIj*X8uwqJW~;=O=)M*w>|Iy%;^ zTeth+M;_TcH8mw)?iygEcpaw);poq@lstoy1cqA^c-?A@G5Eg5_k4V9Fh*mI#u@|G zV6DYkjkN}CEWQRK6bOe4BSm_8df9M&qx{H+KioV#JY3)2-d^>~K>QqlJsll?(9+WK z=w}~&bmQdYq zK^wz-p@h~x5(~nhwZT}h#-g=FNJXX~dFAyZY+2jLZMWaPw6Cvk*@pG&r@Fek&%PS~ z@iybP#bU8#m9MjmKB>;O*61+v3uYlvKqb;()6l77^4W6ip2-H>|4Uo)0$C)>6r#H^(WIe543y zW~{+z6GQ?@ItQ1}pWvQ5w?``~E9cIiJJ-5>`}P;Qy1V_i1CWcZA82lAS+RM`mX*g( z^f9ehabehJB2`4Gkh?|)ytamX$>aK!aaJyqZ-3`ohP9wI6bc%Q&%GaNXB&wd<|5AAP6y%h3A`N~tg0d+)u=)9JK4 zc1|;#ig5B=hKK_u^t!bs@Rre7U!#5f3ym)iAq0*iQI1PCTjW#swDHKtR+7yZ!lbrg zWWi`b$yXRz$+y0DjM33CardrW4N}TK`_nIcq59n-aCcL4bEK`Ut?p3waZ1ig&Rx!+ z6hUb;I;b+%V02JztTkvIMARC)@Iv4BDV4kha6%9m7y?mF1nqn5+|)=!d01-@Ve=y_ z$J#>4M#!6LzW4nXx$(vumsD3*FPBp8csl?mJb!G*jvaOBbXpz0P(?u)#!`7)S7Njc zn^Isj1m!T`t`AtWF0%jN8TNM#GdU}nFIgNVxpiYBk3X~tfd~x*B?a2ItZc5LuA)dP zuW%(u341FVTWt11Y2KnU2C&Udm+z^|Znz|Es5in%{YEMVU8pm;-*u8uAilcA# z$+XwR`O8ISa~i^OxzLQbS~YxaSW+WttjhBBZ+G#J|8;?ZsRT2{IGMadY7V+jrV#jS zUDtrGEkXo^M<9sC9QMC@hS6z5)RBm=Aqo+6a$x~9g~B}7uZXZ|(@n7>y}ip@TU-CT zudgq&I0BnnT3T{K2zBJ-Wzx=au1pk=!eX_>hF)GMpW!(kF?64t=H;#wJ~3*SwF5yy zVlB$G80+%g{X;zP;cIB9iQ^j(LShg&R$#Sd4`0VT~BeO{cGr55CGDs|J(6F#Jhz5ayR$H*(R@4!}U~O5< z*{gz1`#35>AwSQI@DM_xltVP)kj@u5dtr)Pp%%~6fDVWuZ3qIC@TqVFXD-e#J)Neh zsY#BHk8cJJ0Dd`%*R-~_CPzjm7|T>Kn<;?sAxvCr4AyA0@iErJ`WoX0p4Qd}>tSu_ zsuIa%{R*k)54jVq%iaY=(TkfDo38SEfm2z;!?nbaA09Qh*d7gariJ zDl!Gdz@^JHH8)oZA#PZdyEs7m(xpqQ4;?;5-bfy6|<2zkcCYB?EMZ<#mWo;u62mt~G!eweY zL(7^KN-5O{L_+px2dHvgSB#9N(55}8?KZ6agx+RRK7@5!YfUCsBwzILJU`^Ep-|Fn zzOIso?n+Q!Wyu!}t}F3;4=KU(4S)6YL9|m(g(Je}WRN?8pag}0gb)ZJ5mIsf;vn0% zTrVQgXl)n)RR#b+HaCwiG*)|9DFCy`%>(oe8tQB7zEUkfjN#i(yNwvvp ziazZ5`yX-mY>6d}jR*oe0-7uyVJ6s+cEZCklG#37v+u_ND^ZViMZqgtyKu+5Qzj8q$2L}%rl1=o{rMcPy-mGkVqkrQh^X5^9AM9 zUC4oOcfh4cOd1lEQ3eJE@|jF#aPd?L{B-EbmD%Q|Wh9&wm=f0au||_G6q%mMqkRvH z#*}-4)e8%EYc&E(MNE;bR2XfL5+V`BeBR^G$w_Kz>QGYRI1aAk;yNx$IXKb@&PoM6 zLOCc|J`}DaagDjteF))jwtb=Z8tGEFyQ5KxorQrbNzr<1|au#cJ}+e|Ju=`M~Am;+JKn9fG%b6 z{8FH8j30VESW=diX~1WY4k!h#w4}0v!KpZxrz;suRWO#RCK{_oNr{vSAzXxTkU|mk zp~Z)@a0nDiSd`7vSnads`Zl@`9m-5hPIirtkEa#`DEEOM^z`&>*uH(cx%ak}^50$@ zL)dx*F2)2+Ezm}R)D3Ed#gPIf!I1)sprs+ky0$9nlL5!aXA~#<=djj62^DNrAVY&g z;lH4OM96B35IzcxGCA(vc|D0l!VX-%>|eQZr5Bh7N^b}7(!}`qW3TqYCNQ`kYT4Aj~T7yFlmuWtA|3+$SYHatBBl**3&OD#VWTry^3%d!6 zJIMaY$;op)Jw2Cq|NbY~u}0$PG!6wUr3J|lgcy_vazF_|#8IqnsYFT#$5AN9L8;(e zEO=B`_>??@B{bM7jCL?ap^d^Afz=XWERHB4y-BvLt>pGwxAOgGo|zpP898?R`0*pa z98h>i0DC(-^TwFJ+4qAVc-d?=^VPrjW7=xQh%y`Om;G?_zXt zuynMquh@I!$g{;_F-7pXYJooRw!P7=?(XqhZoYZs{Q2|i@4D-*#?9;7==^me_(d`TdsL`j9CR6rFKTt_1g={e20%X2u=r!uC<&X@S{YZv(DcQ26l z8c`~W(Gp`MT1zY*b~XUM8orSNW|RTu0%k;NEpy##5G_lheF* zbc_Rs#yE0TBV)^P-6+P0kn2IKlGZ1p@j zpM5rS=GK>KLF1bz--XGz9$-2IVtd~n-lRh5>i(|-06=ZovZeOMb?ZJ}Q&aONwRLrs zn>TJu?!4oU`a-cNN+l12qW|0_E)P#IHlC(X(8OaA8tbcRX{uwzHOq*_6p5-zVv&e_ z?Zp=h$B!K=TuG;A&;InMKYF9L_w{TxJ4(R!6z@>;-wyx?dPZd1wrwq|+uC*|5{cif ztgO7Lwx*`Ee%-nytJ>RR_4V~6lS$(7_`*ZQVv%$@&Ghs%6JukXK6EHIJUy+)(&_%o zSFXHq^3TU)AvPc)tJ^zo)E|6=l8rR9!X<=w{r1EgJ;Fikb~4FCWD M07*qoM6N<$f`j^SBme*a literal 0 HcmV?d00001