From 87bd044b31be857d4244b4a224682c66464c5d4f Mon Sep 17 00:00:00 2001 From: Jordan Wages Date: Mon, 22 Apr 2024 18:28:21 -0500 Subject: [PATCH] Settings Helper + Documentation The `SettingsHelper` is an agnostic way to access settings values uniformly through code. The accessor methods are controlled by the consumer. Documentation has been a bit wonky. I changed the max number of version number components allowed, so each new build should not create new changes on every single bit of documentation now. --- CapyKit/CapyEvent.cs | 8 +- CapyKit/Helpers/SettingsHelper.cs | 136 +++++++ Documentation/ContentLayout.content | 10 - Documentation/Documentation.shfbproj | 9 +- .../7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md | 17 - .../849aa079-3d64-4cf1-966f-44af23c73160.md | 2 +- ...Kit_CapyEventReporter_uniqueIdentifiers.md | 2 +- ...rs_SecurityHelper_LOWER_CASE_CHARACTERS.md | 2 +- ...elpers_SecurityHelper_NUMBER_CHARACTERS.md | 2 +- ...lpers_SecurityHelper_SPECIAL_CHARACTERS.md | 2 +- ...rs_SecurityHelper_UPPER_CASE_CHARACTERS.md | 2 +- ...CapyKit_Helpers_SecurityHelper_saltSize.md | 2 +- ...CapyKit_Helpers_SettingsHelper_accessor.md | 31 ++ ...CapyKit_Helpers_SettingsHelper_detector.md | 31 ++ .../Help/F_CapyKit_Password_algorithm.md | 2 +- .../F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md | 2 +- .../Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md | 2 +- .../Help/F_CapyKit_PoolItem_1_index.md | 2 +- .../Help/F_CapyKit_PoolItem_1_item.md | 2 +- .../Help/F_CapyKit_PoolItem_1_locked.md | 2 +- .../Help/F_CapyKit_PoolItem_1_typeName.md | 2 +- .../F_CapyKit_Pool_1_poolItemCollection.md | 2 +- .../Help/F_CapyKit_Pool_1_poolSize.md | 2 +- ...F_CapyKit_PropertyComparer_2_expression.md | 2 +- ...Fields_T_CapyKit_Helpers_SettingsHelper.md | 21 ++ Documentation/Help/Home.md | 2 +- ...Attributes_EnumerationAttribute_1__ctor.md | 2 +- ...s_EnumerationDescriptionAttribute__ctor.md | 2 +- .../Help/M_CapyKit_CapyEventArgs__ctor.md | 2 +- .../M_CapyKit_CapyEventReporter_EmitEvent.md | 8 +- ...CapyKit_CapyEventReporter_EmitEventOnce.md | 2 +- .../M_CapyKit_CapyEventReporter_Subscribe.md | 2 +- ...M_CapyKit_CapyEventReporter_Unsubscribe.md | 2 +- .../M_CapyKit_CapyEventReporter__cctor.md | 2 +- ...ns_EnumerationExtensions_GetDescription.md | 2 +- ...xtensions_EnumerationExtensions_GetName.md | 2 +- ...ons_EnumerationExtensions_GetPrettyName.md | 2 +- ...tensions_EnumerationExtensions_GetValue.md | 2 +- ...tensions_EnumerationExtensions_Parse__1.md | 2 +- ...nsions_EnumerationExtensions_Parse__1_1.md | 2 +- ...t_Extensions_LINQExtensions_Distinct__2.md | 2 +- ...Kit_Extensions_LINQExtensions_Filter__1.md | 2 +- ...t_Extensions_LINQExtensions_Filter__1_1.md | 2 +- ...ensions_LINQExtensions_LeftOuterJoin__4.md | 2 +- ...sions_LINQExtensions_LeftOuterJoin__4_1.md | 2 +- ...sions_LINQExtensions_LeftOuterJoin__4_2.md | 2 +- ..._Extensions_LINQExtensions_PageCount__1.md | 2 +- ...xtensions_LINQExtensions_PageCount__1_1.md | 2 +- ...pyKit_Extensions_LINQExtensions_Page__1.md | 2 +- ...Kit_Extensions_LINQExtensions_Page__1_1.md | 2 +- ...tensions_StringExtensions_IfNullOrEmpty.md | 2 +- ...ons_StringExtensions_IfNullOrWhiteSpace.md | 2 +- ...yKit_Helpers_CompressionHelper_Compress.md | 2 +- ...pers_CompressionHelper_CompressToString.md | 2 +- ...rs_CompressionHelper_DecompressToString.md | 2 +- ...Helpers_CompressionHelper_Decompress__1.md | 2 +- ...lpers_CompressionHelper_Decompress__1_1.md | 2 +- ...LanguageHelper_CamelCaseToHumanReadable.md | 2 +- .../M_CapyKit_Helpers_LanguageHelper__ctor.md | 2 +- ...rs_SecurityHelper_CompareHashedPassword.md | 2 +- ...Helpers_SecurityHelper_CompareSessionID.md | 2 +- ...t_Helpers_SecurityHelper_CompareStrings.md | 2 +- ...t_Helpers_SecurityHelper_GetRandomBytes.md | 2 +- ...elpers_SecurityHelper_GetRandomPassword.md | 2 +- ..._Helpers_SecurityHelper_GetRandomString.md | 2 +- ...elpers_SecurityHelper_GetRandomString_1.md | 2 +- ...rityHelper_GetValidCharacterComposition.md | 2 +- ...Kit_Helpers_SecurityHelper_HashPassword.md | 2 +- ...M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md | 2 +- ...CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md | 2 +- .../M_CapyKit_Helpers_SecurityHelper__ctor.md | 2 +- ...pers_SerializationHelper_Deserialize__1.md | 2 +- ...rs_SerializationHelper_Deserialize__1_1.md | 2 +- ...rs_SerializationHelper_Deserialize__1_2.md | 2 +- ...rs_SerializationHelper_SerializeToBytes.md | 2 +- ...s_SerializationHelper_SerializeToString.md | 2 +- ...SettingsHelper_GetApplicationSetting__1.md | 42 +++ ...elpers_SettingsHelper_SetAccessorMethod.md | 41 ++ ...elpers_SettingsHelper_SetDetectorMethod.md | 41 ++ ...M_CapyKit_Helpers_SettingsHelper__cctor.md | 28 ++ .../M_CapyKit_IPasswordAlgorithm_Compare.md | 2 +- .../M_CapyKit_IPasswordAlgorithm_Encrypt.md | 2 +- .../Help/M_CapyKit_Password_ToString.md | 2 +- .../Help/M_CapyKit_Password__cctor.md | 2 +- .../Help/M_CapyKit_Password__ctor.md | 2 +- .../Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md | 2 +- .../Help/M_CapyKit_Pbkdf2Algorithm__ctor.md | 2 +- .../Help/M_CapyKit_PoolItem_1_ReleaseLock.md | 2 +- .../Help/M_CapyKit_PoolItem_1_SetLock.md | 2 +- .../Help/M_CapyKit_PoolItem_1_ToString.md | 2 +- .../Help/M_CapyKit_PoolItem_1__ctor.md | 2 +- ...M_CapyKit_Pool_1_FillPoolItemCollection.md | 2 +- ...CapyKit_Pool_1_FillPoolItemCollection_1.md | 2 +- ...CapyKit_Pool_1_FillPoolItemCollection_2.md | 2 +- .../Help/M_CapyKit_Pool_1_GetAvailableItem.md | 2 +- .../Help/M_CapyKit_Pool_1_ReleaseItem.md | 2 +- Documentation/Help/M_CapyKit_Pool_1__ctor.md | 2 +- .../Help/M_CapyKit_Pool_1__ctor_1.md | 2 +- .../Help/M_CapyKit_Pool_1__ctor_2.md | 2 +- .../M_CapyKit_PropertyComparer_2_Equals.md | 2 +- ..._CapyKit_PropertyComparer_2_GetHashCode.md | 2 +- .../M_CapyKit_PropertyComparer_2__ctor.md | 2 +- ...ethods_T_CapyKit_Helpers_SettingsHelper.md | 24 ++ Documentation/Help/N_CapyKit_Helpers.md | 3 + ...Attributes_EnumerationAttribute_1_Value.md | 2 +- .../Help/P_CapyKit_CapyEventArgs_Level.md | 2 +- .../Help/P_CapyKit_CapyEventArgs_Message.md | 2 +- .../P_CapyKit_CapyEventArgs_MethodName.md | 2 +- ...apyKit_IPasswordAlgorithm_AlgorithmName.md | 2 +- .../Help/P_CapyKit_Password_Algorithm.md | 2 +- Documentation/Help/P_CapyKit_Password_Hash.md | 2 +- .../P_CapyKit_Password_Pbkdf2Algorithm.md | 2 +- Documentation/Help/P_CapyKit_Password_Salt.md | 2 +- ...P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md | 2 +- .../Help/P_CapyKit_PoolItem_1_Index.md | 2 +- .../Help/P_CapyKit_PoolItem_1_Item.md | 2 +- .../Help/P_CapyKit_PoolItem_1_Locked.md | 2 +- .../Help/P_CapyKit_PoolItem_1_TypeName.md | 2 +- Documentation/Help/R_Project_Documentation.md | 20 + ...pyKit_Attributes_EnumerationAttribute_1.md | 2 +- ...ributes_EnumerationDescriptionAttribute.md | 2 +- Documentation/Help/T_CapyKit_CapyEventArgs.md | 2 +- .../Help/T_CapyKit_CapyEventHandler.md | 2 +- .../Help/T_CapyKit_CapyEventReporter.md | 2 +- Documentation/Help/T_CapyKit_Color.md | 2 +- Documentation/Help/T_CapyKit_EventLevel.md | 2 +- ...apyKit_Extensions_EnumerationExtensions.md | 2 +- .../T_CapyKit_Extensions_LINQExtensions.md | 2 +- .../T_CapyKit_Extensions_StringExtensions.md | 2 +- .../T_CapyKit_Helpers_CompressionHelper.md | 2 +- .../Help/T_CapyKit_Helpers_LanguageHelper.md | 2 +- .../Help/T_CapyKit_Helpers_SecurityHelper.md | 2 +- .../T_CapyKit_Helpers_SerializationHelper.md | 2 +- .../Help/T_CapyKit_Helpers_SettingsHelper.md | 99 +++++ ...apyKit_Helpers_ValidCharacterCollection.md | 2 +- .../Help/T_CapyKit_IPasswordAlgorithm.md | 2 +- Documentation/Help/T_CapyKit_Password.md | 2 +- .../Help/T_CapyKit_Pbkdf2Algorithm.md | 2 +- Documentation/Help/T_CapyKit_PoolItem_1.md | 2 +- Documentation/Help/T_CapyKit_Pool_1.md | 2 +- .../Help/T_CapyKit_PropertyComparer_2.md | 2 +- .../Help/Working/_InheritedDocs_.xml | 13 - Documentation/Help/_Sidebar.md | 354 +++++++++--------- .../fa7407d1-9116-4ad7-a9ab-ed094685b070.md | 15 - 144 files changed, 838 insertions(+), 361 deletions(-) create mode 100644 CapyKit/Helpers/SettingsHelper.cs delete mode 100644 Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md create mode 100644 Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md create mode 100644 Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md create mode 100644 Documentation/Help/Fields_T_CapyKit_Helpers_SettingsHelper.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md create mode 100644 Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md create mode 100644 Documentation/Help/Methods_T_CapyKit_Helpers_SettingsHelper.md create mode 100644 Documentation/Help/R_Project_Documentation.md create mode 100644 Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md delete mode 100644 Documentation/Help/Working/_InheritedDocs_.xml delete mode 100644 Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md diff --git a/CapyKit/CapyEvent.cs b/CapyKit/CapyEvent.cs index f088a9a..607734e 100644 --- a/CapyKit/CapyEvent.cs +++ b/CapyKit/CapyEvent.cs @@ -78,8 +78,7 @@ namespace CapyKit /// Emits an event with the given severity level, message, and method name. /// /// In order to allow for efficient calling member access via - /// , - /// it is suggested that is defined explicitly for formatted messages. + /// , it is suggested that is defined explicitly for formatted messages. /// /// The severity level of the event. /// @@ -93,8 +92,9 @@ namespace CapyKit /// A variable-length parameters list containing arguments for formatting the message. /// /// - /// CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", - /// args: new[] { enumeration }); + /// + /// CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration }); + /// /// /// internal static void EmitEvent(EventLevel eventLevel, string message, [CallerMemberName] string method = null, params object[] args) diff --git a/CapyKit/Helpers/SettingsHelper.cs b/CapyKit/Helpers/SettingsHelper.cs new file mode 100644 index 0000000..77b3f6d --- /dev/null +++ b/CapyKit/Helpers/SettingsHelper.cs @@ -0,0 +1,136 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace CapyKit.Helpers +{ + /// + /// Static class containing helper methods for retrieving and setting application settings. + /// + /// + /// The specific means of accessing and storing the settings are determined by the consumer, + /// allowing for flexibility in various environments such as App.config or Web.config + /// . + /// + /// + /// This example demonstrates how to set up the SettingsHelper class with custom accessor and + /// detector methods that read from an App.config file. The setup is done at the beginning of the + /// application execution, before any other usage of the helper methods. + /// + /// public int main(string[] args) + /// { + /// // Set up SettingsHelper with custom accessor and detector methods + /// Func<string, object> accessor = (key) => + /// { + /// Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); + /// return config.AppSettings.Settings[key].Value; + /// }; + /// + /// Func<string, bool> detector = (key) => + /// { + /// Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); + /// return config.AppSettings.Settings.AllKeys.Contains(key); + /// }; + /// + /// SettingsHelper.SetAccessorMethod(accessor); + /// SettingsHelper.SetDetectorMethod(detector); + /// + /// // Use the helper to retrieve and set settings + /// SettingsHelper.SetApplicationSetting<int>("MySettingKey", 42); + /// int newSetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey"); + /// Console.WriteLine("New setting: {0}", newSetting); + /// + /// int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey"); + /// Console.WriteLine("Retrieved setting: {0}", mySetting); + /// } + /// + /// + public static class SettingsHelper + { + #region Members + + /// + /// Private delegate function that retrieves a setting with the given key. Returns the + /// setting as an uncast . + /// + private static Func accessor = (key) => default(object); + + /// + /// Private delegate function that detects if a setting with a given key exists. Returns + /// if the setting exists, if not. + /// + private static Func detector = (key) => false; + + #endregion Members + + #region Methods + + /// + /// Retrieves a setting with the given key. Returns the setting as an uncast . + /// + /// The type of the setting to be retrieved. + /// The name of the setting to retrieve. + /// The value of the setting as an uncast . + public static T GetApplicationSetting(string settingName) + { + if (SettingsHelper.detector(settingName)) + { + var result = Convert.ChangeType(SettingsHelper.accessor(settingName), typeof(T)); + if (result is T) + { + return (T)result; + } + + return default(T); + } + + return default(T); + } + + /// Sets the function used to retrieve application settings. + /// + /// Thrown when one or more required arguments are null. + /// + /// The new function used to retrieve application settings. + public static void SetAccessorMethod(Func accessor) + { + if (accessor != null) + { + SettingsHelper.accessor = accessor; + } + else + { + var error = "Cannot set the ApplicationSettingsHelper accessor method to a null function."; + CapyEventReporter.EmitEvent(EventLevel.Error, error); + throw new ArgumentNullException(error); + } + } + + /// + /// Sets the function used to detect if an application setting with a given key exists. + /// + /// + /// Thrown when one or more required arguments are null. + /// + /// + /// The new function used to detect if an application setting exists. + /// + public static void SetDetectorMethod(Func detector) + { + if (detector != null) + { + SettingsHelper.detector = detector; + } + else + { + var error = "Cannot set the ApplicationSettingsHelper detector method to a null function."; + CapyEventReporter.EmitEvent(EventLevel.Error, error); + throw new ArgumentNullException(error); + } + } + + #endregion Methods + } +} diff --git a/Documentation/ContentLayout.content b/Documentation/ContentLayout.content index e3d5587..dce8e69 100644 --- a/Documentation/ContentLayout.content +++ b/Documentation/ContentLayout.content @@ -5,14 +5,4 @@ - - - - - - - - - - \ No newline at end of file diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj index 08891b3..d362909 100644 --- a/Documentation/Documentation.shfbproj +++ b/Documentation/Documentation.shfbproj @@ -23,7 +23,7 @@ en-US - + @@ -47,13 +47,14 @@ 1.0.0.0 MemberName AboveNamespaces - False + True False 2 False Blank - Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Internals, Privates, PrivateFields, Protected, SealedProtected, ProtectedInternalAsProtected, NonBrowsable - + Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Internals, Privates, PrivateFields, Protected, SealedProtected, ProtectedInternalAsProtected, NonBrowsable, InternalAndPrivateIfExternal + + False Msdn diff --git a/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md b/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md deleted file mode 100644 index 2f7a7bd..0000000 --- a/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md +++ /dev/null @@ -1,17 +0,0 @@ -# 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 -CapyKit - C# Utilities diff --git a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md index d14b7b7..a9b780c 100644 --- a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md +++ b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md @@ -24,4 +24,4 @@ See the **Conceptual Content** topics in the Sandcastle Help File Builder's help #### Other Resources -Version History +[7d36447b-0aab-4ce9-b5ed-e60ec5bee103] diff --git a/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md b/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md index 32ddab5..da508ae 100644 --- a/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md +++ b/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md @@ -7,7 +7,7 @@ A hash set storing unique identifiers for events intended to only be emitted onc ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md index 38b4003..4129067 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md @@ -7,7 +7,7 @@ A string of all the lower case characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md index cbd26f6..02f1ab6 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md @@ -7,7 +7,7 @@ A string of all the numeric characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md index 1e40114..c65f8b5 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md @@ -7,7 +7,7 @@ A string of the most common non-alphanumeric characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md index 372d274..65e6cb5 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md @@ -7,7 +7,7 @@ A string of all the upper case characters. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md index b1ad37e..b63819b 100644 --- a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md @@ -7,7 +7,7 @@ Default size of the generated salt. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md new file mode 100644 index 0000000..96fa0d9 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_accessor.md @@ -0,0 +1,31 @@ +# accessor Field + + +Private delegate function that retrieves a setting with the given `key`. Returns the setting as an uncast Object. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +private static Func accessor +``` +**F#** +``` F# +static val mutable private accessor: Func +``` + + + +#### Field Value +Func(String, Object) + +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md new file mode 100644 index 0000000..ff1f3fd --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SettingsHelper_detector.md @@ -0,0 +1,31 @@ +# detector Field + + +Private delegate function that detects if a setting with a given `key` exists. Returns true if the setting exists, false if not. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +private static Func detector +``` +**F#** +``` F# +static val mutable private detector: Func +``` + + + +#### Field Value +Func(String, Boolean) + +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Password_algorithm.md b/Documentation/Help/F_CapyKit_Password_algorithm.md index 102d4dc..f617eb4 100644 --- a/Documentation/Help/F_CapyKit_Password_algorithm.md +++ b/Documentation/Help/F_CapyKit_Password_algorithm.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md index 2389b15..326a4a9 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md @@ -7,7 +7,7 @@ The default number of iterations. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md index 4917468..496b597 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_index.md b/Documentation/Help/F_CapyKit_PoolItem_1_index.md index cf47098..fd339f7 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_index.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_index.md @@ -7,7 +7,7 @@ The zero-based index of the pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_item.md b/Documentation/Help/F_CapyKit_PoolItem_1_item.md index 3040a0c..b24426e 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_item.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_item.md @@ -7,7 +7,7 @@ The pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_locked.md b/Documentation/Help/F_CapyKit_PoolItem_1_locked.md index b139620..d61fd4d 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_locked.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_locked.md @@ -7,7 +7,7 @@ A flag indicating whether the item is locked or not. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md b/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md index b94c82d..8c7d2be 100644 --- a/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md +++ b/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md @@ -7,7 +7,7 @@ The name of the pooled item CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md b/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md index 59f52bf..d1adbc4 100644 --- a/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md +++ b/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md @@ -7,7 +7,7 @@ The collection of pooled items. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_Pool_1_poolSize.md b/Documentation/Help/F_CapyKit_Pool_1_poolSize.md index 06e62da..f80dc82 100644 --- a/Documentation/Help/F_CapyKit_Pool_1_poolSize.md +++ b/Documentation/Help/F_CapyKit_Pool_1_poolSize.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md b/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md index a8cba63..f672804 100644 --- a/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md +++ b/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md @@ -7,7 +7,7 @@ The expression to retrieve the property. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/Fields_T_CapyKit_Helpers_SettingsHelper.md b/Documentation/Help/Fields_T_CapyKit_Helpers_SettingsHelper.md new file mode 100644 index 0000000..5373038 --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_Helpers_SettingsHelper.md @@ -0,0 +1,21 @@ +# SettingsHelper Fields + + + + +## Fields + + + + + + + +
accessorPrivate delegate function that retrieves a setting with the given key. Returns the setting as an uncast Object.
detectorPrivate delegate function that detects if a setting with a given key exists. Returns true if the setting exists, false if not.
+ +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Home.md b/Documentation/Help/Home.md index d14b7b7..a9b780c 100644 --- a/Documentation/Help/Home.md +++ b/Documentation/Help/Home.md @@ -24,4 +24,4 @@ See the **Conceptual Content** topics in the Sandcastle Help File Builder's help #### Other Resources -Version History +[7d36447b-0aab-4ce9-b5ed-e60ec5bee103] diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md index f4354e8..f99e237 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md @@ -7,7 +7,7 @@ Gets the value of the enumeration represented by this attribute. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md index 6205850..1ab3c06 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md index 3fe8e54..656358a 100644 --- a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md +++ b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyEventArgs class with the specified event l ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md index 155ad7e..5e1da9b 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md @@ -7,7 +7,7 @@ Emits an event with the given severity level, message, and method name. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# @@ -40,7 +40,13 @@ internal static member EmitEvent : In order to allow for efficient calling member access via CallerMemberNameAttribute , it is suggested that *args* is defined explicitly for formatted messages. ## Example + + +**C#** +``` C# CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration }); +``` + ## See Also diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md index ebc4ed7..3416b8c 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md @@ -7,7 +7,7 @@ Emits an event with the given severity level, message, unique identifier, and me ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md index 4cc9963..6b59e8f 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md @@ -7,7 +7,7 @@ Subscribes the specified event handler to the event with the given subscription ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md index 75127cb..9d187de 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md @@ -7,7 +7,7 @@ Unsubscribes the specified event handler from the event with the given origin. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md b/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md index 0dadc89..a0a3b3b 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md @@ -7,7 +7,7 @@ Initializes the static fields of the Ca ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md index 0d8ec27..211fda4 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md index 32aa2f3..f16b2c8 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md index ee9fcf0..1d4105f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md index 7521b9f..bbe927e 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md @@ -7,7 +7,7 @@ An CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md index fe5e19e..4ae73ae 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md @@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md index ba971a7..4611b77 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md @@ -7,7 +7,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md index 76933c7..da320d0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md @@ -7,7 +7,7 @@ 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+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md index a7a8662..26f3f35 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md @@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md index e0ade2b..abbaccf 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md @@ -7,7 +7,7 @@ Filters out items matching a *predicate* from the collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md index cb8c0f2..ed67780 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md @@ -7,7 +7,7 @@ An IEnumable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md index 3300140..8be52b5 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md @@ -7,7 +7,7 @@ An IQueryable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md index 30cc76f..0fab33a 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md @@ -7,7 +7,7 @@ An IQueryable<T> extension method that left outer join. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md index 96e47a4..d4dad69 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md @@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md index 4bd8187..7cc6bec 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md @@ -7,7 +7,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md index f49f852..74df094 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md @@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md index 3f0b759..7f35261 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md @@ -7,7 +7,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md index 388cf4f..00b6d31 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md @@ -7,7 +7,7 @@ Replaces a null or empty string with a specified replacement string. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md index 72117ec..b9224b0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md @@ -7,7 +7,7 @@ Replaces a null or whitespace string with a specified replacement string. ## Definition **Namespace:** CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md index 9ed2b80..a4e5adf 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md @@ -7,7 +7,7 @@ Compresses a given object using the `gzip` algorithm. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md index a08efd3..88a27fe 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md @@ -7,7 +7,7 @@ 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+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md index 3ccf3ee..69d1481 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md @@ -7,7 +7,7 @@ Decompresses the given `base64` string in `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md index 6c8d0cf..8be696a 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md @@ -7,7 +7,7 @@ Decompresses a given compressed `gzip` byte stream. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md index 4a1a393..70f07f8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md @@ -7,7 +7,7 @@ Decompresses a given `base64` encoded string of `gzip` format. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md index b7c9a1f..cbdaf67 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md @@ -7,7 +7,7 @@ Converts camel case text to human readable text. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md index 9d9e650..f2e125c 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md index bf39d98..090fb84 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md @@ -7,7 +7,7 @@ Compares an unencrypted *providedPassword* with a stored, encrypted *existingPas ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md index 54504d8..1f3d688 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md @@ -7,7 +7,7 @@ Compares two session identifiers. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md index 02f0f60..9b26c4a 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md @@ -7,7 +7,7 @@ Compare two strings as case sensative. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md index e0a7cce..6732430 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md @@ -7,7 +7,7 @@ Generates a new byte array of the specified length with random values. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md index 5bd8c4f..1cacbdc 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md @@ -7,7 +7,7 @@ Gets a cryptographically strong random password. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md index d23ea2c..490598d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md @@ -7,7 +7,7 @@ A convenience method to generate a random string of the specified length using a ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md index 1f4dc07..c815580 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md @@ -7,7 +7,7 @@ Gets a cryptographically strong random string using the character values found i ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md index ba2f720..290a088 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md index 877eaf8..a92afe2 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md @@ -7,7 +7,7 @@ Hashes an unencrypted password. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md index 1975bd9..68ef968 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -7,7 +7,7 @@ Generates a new Password object using the PB ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md index 90316c1..d6e1a6d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md @@ -7,7 +7,7 @@ Generates a new Password object using the PB ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md index 66eaab4..50dd73e 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md index c468854..4166924 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md @@ -7,7 +7,7 @@ Deserializes an object to a given *T* type. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md index acaccb7..39db726 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md @@ -7,7 +7,7 @@ Deserializes an object to a given *T* type. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md index f731d7f..c5dbe5b 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md @@ -7,7 +7,7 @@ Deserializes a `JSON` encoded string to the given *T*. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md index b7636b4..e948224 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md @@ -7,7 +7,7 @@ Serializes an object to a byte array. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md index b31576d..6e122c4 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md @@ -7,7 +7,7 @@ Serializes an object to a `JSON` encoded string. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md new file mode 100644 index 0000000..cd1acdf --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md @@ -0,0 +1,42 @@ +# GetApplicationSetting<T> Method + + +Retrieves a setting with the given `key`. Returns the setting as an uncast *T*. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +public static T GetApplicationSetting( + string settingName +) + +``` +**F#** +``` F# +static member GetApplicationSetting : + settingName : string -> 'T +``` + + + +#### Parameters +
  String
The name of the setting to retrieve.
+ +#### Type Parameters +
The type of the setting to be retrieved.
+ +#### Return Value +T +The value of the setting as an uncast *T*. + +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md new file mode 100644 index 0000000..a8a075a --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md @@ -0,0 +1,41 @@ +# SetAccessorMethod Method + + +Sets the function used to retrieve application settings. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +public static void SetAccessorMethod( + Func accessor +) +``` +**F#** +``` F# +static member SetAccessorMethod : + accessor : Func -> unit +``` + + + +#### Parameters +
  Func(String, Object)
The new function used to retrieve application settings.
+ +## Exceptions + + + + +
ArgumentNullExceptionThrown when one or more required arguments are null.
+ +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md new file mode 100644 index 0000000..b20ea0a --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md @@ -0,0 +1,41 @@ +# SetDetectorMethod Method + + +Sets the function used to detect if an application setting with a given `key` exists. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +public static void SetDetectorMethod( + Func detector +) +``` +**F#** +``` F# +static member SetDetectorMethod : + detector : Func -> unit +``` + + + +#### Parameters +
  Func(String, Boolean)
The new function used to detect if an application setting exists.
+ +## Exceptions + + + + +
ArgumentNullExceptionThrown when one or more required arguments are null.
+ +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md new file mode 100644 index 0000000..be3366c --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SettingsHelper__cctor.md @@ -0,0 +1,28 @@ +# SettingsHelper Constructor + + +Initializes the static fields of the SettingsHelper class + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +static SettingsHelper() +``` +**F#** +``` F# +new : unit -> SettingsHelper +``` + + + +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md index 96b694b..e41d3a4 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md @@ -7,7 +7,7 @@ Compares the given plaintext password with an encrypted value using PBKDF2 algor ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md index b4a4569..f131f35 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md @@ -7,7 +7,7 @@ Encrypts the given password using a defined algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password_ToString.md b/Documentation/Help/M_CapyKit_Password_ToString.md index 78c0bee..f5f96ae 100644 --- a/Documentation/Help/M_CapyKit_Password_ToString.md +++ b/Documentation/Help/M_CapyKit_Password_ToString.md @@ -7,7 +7,7 @@ Returns a string that represents the current object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password__cctor.md b/Documentation/Help/M_CapyKit_Password__cctor.md index 4d8cb79..9a69166 100644 --- a/Documentation/Help/M_CapyKit_Password__cctor.md +++ b/Documentation/Help/M_CapyKit_Password__cctor.md @@ -7,7 +7,7 @@ Initializes the static fields of the PasswordCapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Password__ctor.md b/Documentation/Help/M_CapyKit_Password__ctor.md index 09dbaab..051937c 100644 --- a/Documentation/Help/M_CapyKit_Password__ctor.md +++ b/Documentation/Help/M_CapyKit_Password__ctor.md @@ -7,7 +7,7 @@ Constructor. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md index b3d0fed..51f2469 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md @@ -7,7 +7,7 @@ Encrypts the given password using a PBKDF2 algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md index f3831de..2e28fef 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pbkdf2A ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md index 931e8d8..bdb9d54 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md @@ -7,7 +7,7 @@ Releases the lock on the item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md index 7541064..b93cb85 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md @@ -7,7 +7,7 @@ Sets the lock on the item indicating that it is in use. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md index 2fb94e0..6737239 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md @@ -7,7 +7,7 @@ Returns a string that represents the current object and its lock state. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md b/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md index 6e5080d..841e7f3 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the PoolItem(T)< ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md index ba06670..cf2d166 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md @@ -7,7 +7,7 @@ Fill the pool item collection from an existing *T* collection. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md index 2acb8e4..1ef506f 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md @@ -7,7 +7,7 @@ Initializes the pool with the specified number of items using the default constr ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md index 96befb7..21a7d62 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md @@ -7,7 +7,7 @@ Initializes the pool with the specified number of items using the specified cons ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md index 971b794..2fc7a2e 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md @@ -7,7 +7,7 @@ Gets the first available item from the pool and sets its lock. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md index 74460d4..cea70f3 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md @@ -7,7 +7,7 @@ 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+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor.md b/Documentation/Help/M_CapyKit_Pool_1__ctor.md index 187d8bc..24d6908 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) clas ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md index 6cd64ed..133e3d0 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) clas ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md index 6f3ea87..2c1956d 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md @@ -7,7 +7,7 @@ Initializes a new instance of the Pool(T) clas ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md index 2e51537..0fbf47f 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md @@ -7,7 +7,7 @@ Determines whether the specified properties are equal. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md index d12c16d..bd016c3 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md @@ -7,7 +7,7 @@ Returns a hash code for the specified object. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md index 60e19b7..c638f6f 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md @@ -7,7 +7,7 @@ Constructor. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SettingsHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SettingsHelper.md new file mode 100644 index 0000000..96a80b3 --- /dev/null +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SettingsHelper.md @@ -0,0 +1,24 @@ +# SettingsHelper Methods + + + + +## Methods + + + + + + + + + + +
GetApplicationSetting(T)Retrieves a setting with the given key. Returns the setting as an uncast T.
SetAccessorMethodSets the function used to retrieve application settings.
SetDetectorMethodSets the function used to detect if an application setting with a given key exists.
+ +## See Also + + +#### Reference +SettingsHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/N_CapyKit_Helpers.md b/Documentation/Help/N_CapyKit_Helpers.md index cb5018c..5755b4a 100644 --- a/Documentation/Help/N_CapyKit_Helpers.md +++ b/Documentation/Help/N_CapyKit_Helpers.md @@ -19,6 +19,9 @@ SerializationHelper   + +SettingsHelper +Static class containing helper methods for retrieving and setting application settings. ## Enumerations diff --git a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md index 208681e..a8fb0ae 100644 --- a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md +++ b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md @@ -7,7 +7,7 @@ Initializes a new instance of the CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md index 2066512..339aac4 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md @@ -7,7 +7,7 @@ Gets the severity level of the event. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md index 8b500da..76d8334 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md @@ -7,7 +7,7 @@ Gets the message describing the reason for the event. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md index 5fbdfd1..3efa094 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md @@ -7,7 +7,7 @@ Gets the name of the method where the event was raised. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md index 38472d1..b1a295f 100644 --- a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md @@ -7,7 +7,7 @@ Gets the name of the algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Algorithm.md b/Documentation/Help/P_CapyKit_Password_Algorithm.md index b28c2db..a6b361a 100644 --- a/Documentation/Help/P_CapyKit_Password_Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Algorithm.md @@ -7,7 +7,7 @@ Gets or sets the algorithm used for password encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Hash.md b/Documentation/Help/P_CapyKit_Password_Hash.md index 7d82a6a..22b2eac 100644 --- a/Documentation/Help/P_CapyKit_Password_Hash.md +++ b/Documentation/Help/P_CapyKit_Password_Hash.md @@ -7,7 +7,7 @@ Gets or sets the hash of the password. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md index 470b7cc..35893f5 100644 --- a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Password_Salt.md b/Documentation/Help/P_CapyKit_Password_Salt.md index d26a42e..7bb4d48 100644 --- a/Documentation/Help/P_CapyKit_Password_Salt.md +++ b/Documentation/Help/P_CapyKit_Password_Salt.md @@ -7,7 +7,7 @@ Gets or sets the salt used for encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md index e84ddc5..8c39c37 100644 --- a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md @@ -7,7 +7,7 @@ Gets the name of the algorithm. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md index 10e78b7..6e68944 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md @@ -7,7 +7,7 @@ Gets the zero-based index of the pooled item. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md index 596d1bb..4c1d0e7 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md @@ -7,7 +7,7 @@ Gets the pooled resource. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md index c57e84c..9721ac7 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md @@ -7,7 +7,7 @@ Gets a value indicating whether this object is locked or not. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md index 89443c5..660cdd9 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md @@ -7,7 +7,7 @@ Gets the name of the CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/R_Project_Documentation.md b/Documentation/Help/R_Project_Documentation.md new file mode 100644 index 0000000..8252610 --- /dev/null +++ b/Documentation/Help/R_Project_Documentation.md @@ -0,0 +1,20 @@ +# Namespaces + + + + +## Namespaces + + + + + + + + + + + + + +
CapyKit
CapyKit.Attributes
CapyKit.Extensions
CapyKit.Helpers
\ No newline at end of file diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md index bbdc7bb..793ef41 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -7,7 +7,7 @@ Custom attribute class for decorating enumeration fields with additional data. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md index 71428db..800d379 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -7,7 +7,7 @@ An attribute class for decorating enumeration fields with a description. ## Definition **Namespace:** CapyKit.Attributes -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_CapyEventArgs.md b/Documentation/Help/T_CapyKit_CapyEventArgs.md index 67db77c..6d9d272 100644 --- a/Documentation/Help/T_CapyKit_CapyEventArgs.md +++ b/Documentation/Help/T_CapyKit_CapyEventArgs.md @@ -7,7 +7,7 @@ The CapyEventArgs class represents an event argument instance with event level, ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_CapyEventHandler.md b/Documentation/Help/T_CapyKit_CapyEventHandler.md index 45fc3b3..4c30bc5 100644 --- a/Documentation/Help/T_CapyKit_CapyEventHandler.md +++ b/Documentation/Help/T_CapyKit_CapyEventHandler.md @@ -7,7 +7,7 @@ A delegate representing an event handler that accepts a CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_CapyEventReporter.md b/Documentation/Help/T_CapyKit_CapyEventReporter.md index da59ce9..7ae5f49 100644 --- a/Documentation/Help/T_CapyKit_CapyEventReporter.md +++ b/Documentation/Help/T_CapyKit_CapyEventReporter.md @@ -7,7 +7,7 @@ The CapyEventReporter class is responsible for managing event subscriptions and ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Color.md b/Documentation/Help/T_CapyKit_Color.md index 4a0330e..d4ff252 100644 --- a/Documentation/Help/T_CapyKit_Color.md +++ b/Documentation/Help/T_CapyKit_Color.md @@ -7,7 +7,7 @@ Enum representing a set of named colors with their corresponding HEX values. The ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_EventLevel.md b/Documentation/Help/T_CapyKit_EventLevel.md index 1b92991..23eddda 100644 --- a/Documentation/Help/T_CapyKit_EventLevel.md +++ b/Documentation/Help/T_CapyKit_EventLevel.md @@ -7,7 +7,7 @@ Enumeration representing different event level severity values. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md index 5886c94..0a2240d 100644 --- a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md @@ -7,7 +7,7 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md index 19ec264..cdee283 100644 --- a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md @@ -7,7 +7,7 @@ Provides static extension methods for performing common LINQ operations on CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md index ab55c91..523c236 100644 --- a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md @@ -7,7 +7,7 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md index cdabeae..be310cf 100644 --- a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md @@ -7,7 +7,7 @@ A class that contains methods for managing data compression. ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md index 383a509..c406195 100644 --- a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md index 70dba74..e31d0de 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md @@ -7,7 +7,7 @@ A class that contains methods for managing secure data processing and cryptograp ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md index cd32244..2dc5330 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md @@ -7,7 +7,7 @@ ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md b/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md new file mode 100644 index 0000000..97677fb --- /dev/null +++ b/Documentation/Help/T_CapyKit_Helpers_SettingsHelper.md @@ -0,0 +1,99 @@ +# SettingsHelper Class + + +Static class containing helper methods for retrieving and setting application settings. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 + +**C#** +``` C# +public static class SettingsHelper +``` +**F#** +``` F# +[] +[] +type SettingsHelper = class end +``` + + +
InheritanceObject → SettingsHelper
+ + + +## Remarks +The specific means of accessing and storing the settings are determined by the consumer, allowing for flexibility in various environments such as `App.config` or `Web.config` . + +## Example +This example demonstrates how to set up the SettingsHelper class with custom accessor and detector methods that read from an App.config file. The setup is done at the beginning of the application execution, before any other usage of the helper methods. + +**C#** +``` C# +public int main(string[] args) +{ + // Set up SettingsHelper with custom accessor and detector methods + Func accessor = (key) => + { + Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); + return config.AppSettings.Settings[key].Value; + }; + + Func detector = (key) => + { + Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None); + return config.AppSettings.Settings.AllKeys.Contains(key); + }; + + SettingsHelper.SetAccessorMethod(accessor); + SettingsHelper.SetDetectorMethod(detector); + + // Use the helper to retrieve and set settings + SettingsHelper.SetApplicationSetting("MySettingKey", 42); + int newSetting = SettingsHelper.GetApplicationSetting("MySettingKey"); + Console.WriteLine("New setting: {0}", newSetting); + + int mySetting = SettingsHelper.GetApplicationSetting("MySettingKey"); + Console.WriteLine("Retrieved setting: {0}", mySetting); +} +``` + + +## Constructors + + + + +
SettingsHelper 
+ +## Methods + + + + + + + + + + +
GetApplicationSetting(T)Retrieves a setting with the given key. Returns the setting as an uncast T.
SetAccessorMethodSets the function used to retrieve application settings.
SetDetectorMethodSets the function used to detect if an application setting with a given key exists.
+ +## Fields + + + + + + + +
accessorPrivate delegate function that retrieves a setting with the given key. Returns the setting as an uncast Object.
detectorPrivate delegate function that detects if a setting with a given key exists. Returns true if the setting exists, false if not.
+ +## See Also + + +#### Reference +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md index 093814e..91aa1bd 100644 --- a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md +++ b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md @@ -7,7 +7,7 @@ An enumeration that defines the types of characters that can be included in a ra ## Definition **Namespace:** CapyKit.Helpers -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md index 7977060..ae817ef 100644 --- a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md +++ b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md @@ -7,7 +7,7 @@ Defines the contract for password encryption algorithms. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Password.md b/Documentation/Help/T_CapyKit_Password.md index 454abb5..2b095d7 100644 --- a/Documentation/Help/T_CapyKit_Password.md +++ b/Documentation/Help/T_CapyKit_Password.md @@ -7,7 +7,7 @@ Represents a password with its hash, salt and algorithm used for encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md index 1b70fce..b85e841 100644 --- a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md @@ -7,7 +7,7 @@ Implements the PBKDF2 algorithm for password encryption. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_PoolItem_1.md b/Documentation/Help/T_CapyKit_PoolItem_1.md index eb733ac..02d6c9a 100644 --- a/Documentation/Help/T_CapyKit_PoolItem_1.md +++ b/Documentation/Help/T_CapyKit_PoolItem_1.md @@ -7,7 +7,7 @@ A pool item. This class cannot be inherited. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_Pool_1.md b/Documentation/Help/T_CapyKit_Pool_1.md index 31a3b1a..f3e7df8 100644 --- a/Documentation/Help/T_CapyKit_Pool_1.md +++ b/Documentation/Help/T_CapyKit_Pool_1.md @@ -7,7 +7,7 @@ A managed pool of resources. This class provides a thread-safe way to manage a c ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/T_CapyKit_PropertyComparer_2.md b/Documentation/Help/T_CapyKit_PropertyComparer_2.md index 97e317c..0edce08 100644 --- a/Documentation/Help/T_CapyKit_PropertyComparer_2.md +++ b/Documentation/Help/T_CapyKit_PropertyComparer_2.md @@ -7,7 +7,7 @@ A object comparer that can accept a lambda expression to compare properties. ## Definition **Namespace:** CapyKit -**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0 **C#** ``` C# diff --git a/Documentation/Help/Working/_InheritedDocs_.xml b/Documentation/Help/Working/_InheritedDocs_.xml deleted file mode 100644 index 0bbb14e..0000000 --- a/Documentation/Help/Working/_InheritedDocs_.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - _InheritedDocs_ - - - - -Returns a string that represents the current object.A string that represents the current object. - - - Gets the name of the algorithm. - - \ No newline at end of file diff --git a/Documentation/Help/_Sidebar.md b/Documentation/Help/_Sidebar.md index 4f2f2eb..efa14f5 100644 --- a/Documentation/Help/_Sidebar.md +++ b/Documentation/Help/_Sidebar.md @@ -1,174 +1,182 @@ - [CapyKit - C# Utilities](849aa079-3d64-4cf1-966f-44af23c73160.md) -- [Version History](7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md) - - [Version 1.0.0.0](fa7407d1-9116-4ad7-a9ab-ed094685b070.md) -- [CapyKit Namespace](N_CapyKit.md) - - [CapyEventArgs Class](T_CapyKit_CapyEventArgs.md) - - [CapyEventArgs Constructor](M_CapyKit_CapyEventArgs__ctor.md) - - [CapyEventArgs Properties](Properties_T_CapyKit_CapyEventArgs.md) - - [Level Property](P_CapyKit_CapyEventArgs_Level.md) - - [Message Property](P_CapyKit_CapyEventArgs_Message.md) - - [MethodName Property](P_CapyKit_CapyEventArgs_MethodName.md) - - [CapyEventArgs Methods](Methods_T_CapyKit_CapyEventArgs.md) - - [CapyEventHandler Delegate](T_CapyKit_CapyEventHandler.md) - - [CapyEventReporter Class](T_CapyKit_CapyEventReporter.md) - - [CapyEventReporter Constructor](M_CapyKit_CapyEventReporter__cctor.md) - - [CapyEventReporter Methods](Methods_T_CapyKit_CapyEventReporter.md) - - [EmitEvent Method](M_CapyKit_CapyEventReporter_EmitEvent.md) - - [EmitEventOnce Method](M_CapyKit_CapyEventReporter_EmitEventOnce.md) - - [Subscribe Method](M_CapyKit_CapyEventReporter_Subscribe.md) - - [Unsubscribe Method](M_CapyKit_CapyEventReporter_Unsubscribe.md) - - [CapyEventReporter Fields](Fields_T_CapyKit_CapyEventReporter.md) - - [uniqueIdentifiers Field](F_CapyKit_CapyEventReporter_uniqueIdentifiers.md) - - [Color Enumeration](T_CapyKit_Color.md) - - [EventLevel Enumeration](T_CapyKit_EventLevel.md) - - [IPasswordAlgorithm Interface](T_CapyKit_IPasswordAlgorithm.md) - - [IPasswordAlgorithm Properties](Properties_T_CapyKit_IPasswordAlgorithm.md) - - [AlgorithmName Property](P_CapyKit_IPasswordAlgorithm_AlgorithmName.md) - - [IPasswordAlgorithm Methods](Methods_T_CapyKit_IPasswordAlgorithm.md) - - [Compare Method](M_CapyKit_IPasswordAlgorithm_Compare.md) - - [Encrypt Method](M_CapyKit_IPasswordAlgorithm_Encrypt.md) - - [Password Class](T_CapyKit_Password.md) - - [Password Constructor](M_CapyKit_Password__cctor.md) - - [Password Constructor](M_CapyKit_Password__ctor.md) - - [Password Properties](Properties_T_CapyKit_Password.md) - - [Algorithm Property](P_CapyKit_Password_Algorithm.md) - - [Hash Property](P_CapyKit_Password_Hash.md) - - [Pbkdf2Algorithm Property](P_CapyKit_Password_Pbkdf2Algorithm.md) - - [Salt Property](P_CapyKit_Password_Salt.md) - - [Password Methods](Methods_T_CapyKit_Password.md) - - [ToString Method](M_CapyKit_Password_ToString.md) - - [Password Fields](Fields_T_CapyKit_Password.md) - - [algorithm Field](F_CapyKit_Password_algorithm.md) - - [Pbkdf2Algorithm Class](T_CapyKit_Pbkdf2Algorithm.md) - - [Pbkdf2Algorithm Constructor](M_CapyKit_Pbkdf2Algorithm__ctor.md) - - [Pbkdf2Algorithm Properties](Properties_T_CapyKit_Pbkdf2Algorithm.md) - - [AlgorithmName Property](P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md) - - [Pbkdf2Algorithm Methods](Methods_T_CapyKit_Pbkdf2Algorithm.md) - - [Encrypt Method](M_CapyKit_Pbkdf2Algorithm_Encrypt.md) - - [Pbkdf2Algorithm Fields](Fields_T_CapyKit_Pbkdf2Algorithm.md) - - [ITERATIONS Field](F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md) - - [LENGTH Field](F_CapyKit_Pbkdf2Algorithm_LENGTH.md) - - [Pool Class](T_CapyKit_Pool_1.md) - - [Pool Constructor](Overload_CapyKit_Pool_1__ctor.md) - - [Pool(IEnumerable) Constructor](M_CapyKit_Pool_1__ctor.md) - - [Pool(Int32) Constructor](M_CapyKit_Pool_1__ctor_1.md) - - [Pool(Int32, Func) Constructor](M_CapyKit_Pool_1__ctor_2.md) - - [Pool Methods](Methods_T_CapyKit_Pool_1.md) - - [FillPoolItemCollection Method](Overload_CapyKit_Pool_1_FillPoolItemCollection.md) - - [FillPoolItemCollection(IEnumerable) Method](M_CapyKit_Pool_1_FillPoolItemCollection.md) - - [FillPoolItemCollection(Int32) Method](M_CapyKit_Pool_1_FillPoolItemCollection_1.md) - - [FillPoolItemCollection(Int32, Func) Method](M_CapyKit_Pool_1_FillPoolItemCollection_2.md) - - [GetAvailableItem Method](M_CapyKit_Pool_1_GetAvailableItem.md) - - [ReleaseItem Method](M_CapyKit_Pool_1_ReleaseItem.md) - - [Pool Fields](Fields_T_CapyKit_Pool_1.md) - - [poolItemCollection Field](F_CapyKit_Pool_1_poolItemCollection.md) - - [poolSize Field](F_CapyKit_Pool_1_poolSize.md) - - [PoolItem Class](T_CapyKit_PoolItem_1.md) - - [PoolItem Constructor](M_CapyKit_PoolItem_1__ctor.md) - - [PoolItem Properties](Properties_T_CapyKit_PoolItem_1.md) - - [Index Property](P_CapyKit_PoolItem_1_Index.md) - - [Item Property](P_CapyKit_PoolItem_1_Item.md) - - [Locked Property](P_CapyKit_PoolItem_1_Locked.md) - - [TypeName Property](P_CapyKit_PoolItem_1_TypeName.md) - - [PoolItem Methods](Methods_T_CapyKit_PoolItem_1.md) - - [ReleaseLock Method](M_CapyKit_PoolItem_1_ReleaseLock.md) - - [SetLock Method](M_CapyKit_PoolItem_1_SetLock.md) - - [ToString Method](M_CapyKit_PoolItem_1_ToString.md) - - [PoolItem Fields](Fields_T_CapyKit_PoolItem_1.md) - - [index Field](F_CapyKit_PoolItem_1_index.md) - - [item Field](F_CapyKit_PoolItem_1_item.md) - - [locked Field](F_CapyKit_PoolItem_1_locked.md) - - [typeName Field](F_CapyKit_PoolItem_1_typeName.md) - - [PropertyComparer Class](T_CapyKit_PropertyComparer_2.md) - - [PropertyComparer Constructor](M_CapyKit_PropertyComparer_2__ctor.md) - - [PropertyComparer Methods](Methods_T_CapyKit_PropertyComparer_2.md) - - [Equals Method](Overload_CapyKit_PropertyComparer_2_Equals.md) - - [Equals(T, T) Method](M_CapyKit_PropertyComparer_2_Equals.md) - - [GetHashCode Method](Overload_CapyKit_PropertyComparer_2_GetHashCode.md) - - [GetHashCode(T) Method](M_CapyKit_PropertyComparer_2_GetHashCode.md) - - [PropertyComparer Fields](Fields_T_CapyKit_PropertyComparer_2.md) - - [expression Field](F_CapyKit_PropertyComparer_2_expression.md) -- [CapyKit.Attributes Namespace](N_CapyKit_Attributes.md) - - [EnumerationAttribute Class](T_CapyKit_Attributes_EnumerationAttribute_1.md) - - [EnumerationAttribute Constructor](M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md) - - [EnumerationAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md) - - [Value Property](P_CapyKit_Attributes_EnumerationAttribute_1_Value.md) - - [EnumerationAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md) - - [EnumerationDescriptionAttribute Class](T_CapyKit_Attributes_EnumerationDescriptionAttribute.md) - - [EnumerationDescriptionAttribute Constructor](M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md) - - [EnumerationDescriptionAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md) - - [EnumerationDescriptionAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md) -- [CapyKit.Extensions Namespace](N_CapyKit_Extensions.md) - - [EnumerationExtensions Class](T_CapyKit_Extensions_EnumerationExtensions.md) - - [EnumerationExtensions Methods](Methods_T_CapyKit_Extensions_EnumerationExtensions.md) - - [GetDescription Method](M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md) - - [GetName Method](M_CapyKit_Extensions_EnumerationExtensions_GetName.md) - - [GetPrettyName Method](M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md) - - [GetValue Method](M_CapyKit_Extensions_EnumerationExtensions_GetValue.md) - - [Parse Method](Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md) - - [Parse(T, String) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md) - - [Parse(T, String, Boolean) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md) - - [LINQExtensions Class](T_CapyKit_Extensions_LINQExtensions.md) - - [LINQExtensions Methods](Methods_T_CapyKit_Extensions_LINQExtensions.md) - - [Distinct Method](M_CapyKit_Extensions_LINQExtensions_Distinct__2.md) - - [Filter Method](Overload_CapyKit_Extensions_LINQExtensions_Filter.md) - - [Filter(IEnumerable, Func) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1.md) - - [Filter(IQueryable, Expression>) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md) - - [LeftOuterJoin Method](Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md) - - [LeftOuterJoin(IQueryable, IQueryable, Expression>, Expression>, Expression, R>>) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md) - - [LeftOuterJoin(IEnumerable, IEnumerable, Func, Func, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md) - - [LeftOuterJoin(IQueryable, IQueryable, Expression>, Expression>, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md) - - [Page Method](Overload_CapyKit_Extensions_LINQExtensions_Page.md) - - [Page(IEnumerable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1.md) - - [Page(IQueryable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1_1.md) - - [PageCount Method](Overload_CapyKit_Extensions_LINQExtensions_PageCount.md) - - [PageCount(IEnumerable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1.md) - - [PageCount(IQueryable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md) - - [StringExtensions Class](T_CapyKit_Extensions_StringExtensions.md) - - [StringExtensions Methods](Methods_T_CapyKit_Extensions_StringExtensions.md) - - [IfNullOrEmpty Method](M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md) - - [IfNullOrWhiteSpace Method](M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md) -- [CapyKit.Helpers Namespace](N_CapyKit_Helpers.md) - - [CompressionHelper Class](T_CapyKit_Helpers_CompressionHelper.md) - - [CompressionHelper Methods](Methods_T_CapyKit_Helpers_CompressionHelper.md) - - [Compress Method](M_CapyKit_Helpers_CompressionHelper_Compress.md) - - [CompressToString Method](M_CapyKit_Helpers_CompressionHelper_CompressToString.md) - - [Decompress Method](Overload_CapyKit_Helpers_CompressionHelper_Decompress.md) - - [Decompress(Byte[]) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1.md) - - [Decompress(String) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md) - - [DecompressToString Method](M_CapyKit_Helpers_CompressionHelper_DecompressToString.md) - - [LanguageHelper Class](T_CapyKit_Helpers_LanguageHelper.md) - - [LanguageHelper Constructor](M_CapyKit_Helpers_LanguageHelper__ctor.md) - - [LanguageHelper Methods](Methods_T_CapyKit_Helpers_LanguageHelper.md) - - [CamelCaseToHumanReadable Method](M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md) - - [SecurityHelper Class](T_CapyKit_Helpers_SecurityHelper.md) - - [SecurityHelper Constructor](M_CapyKit_Helpers_SecurityHelper__ctor.md) - - [SecurityHelper Methods](Methods_T_CapyKit_Helpers_SecurityHelper.md) - - [CompareHashedPassword Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md) - - [CompareSessionID Method](M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md) - - [CompareStrings Method](M_CapyKit_Helpers_SecurityHelper_CompareStrings.md) - - [GetRandomBytes Method](M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md) - - [GetRandomPassword Method](M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md) - - [GetRandomString Method](Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md) - - [GetRandomString(Int32) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString.md) - - [GetRandomString(Int32, ValidCharacterCollection[]) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md) - - [GetValidCharacterComposition Method](M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md) - - [HashPassword Method](M_CapyKit_Helpers_SecurityHelper_HashPassword.md) - - [Pbkdf2 Method](Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md) - - [Pbkdf2(String) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md) - - [Pbkdf2(String, Byte[]) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md) - - [SecurityHelper Fields](Fields_T_CapyKit_Helpers_SecurityHelper.md) - - [LOWER_CASE_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md) - - [NUMBER_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md) - - [saltSize Field](F_CapyKit_Helpers_SecurityHelper_saltSize.md) - - [SPECIAL_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md) - - [UPPER_CASE_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md) - - [SerializationHelper Class](T_CapyKit_Helpers_SerializationHelper.md) - - [SerializationHelper Methods](Methods_T_CapyKit_Helpers_SerializationHelper.md) - - [Deserialize Method](Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md) - - [Deserialize(Byte[]) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md) - - [Deserialize(Stream) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md) - - [Deserialize(String) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md) - - [SerializeToBytes Method](M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md) - - [SerializeToString Method](M_CapyKit_Helpers_SerializationHelper_SerializeToString.md) - - [ValidCharacterCollection Enumeration](T_CapyKit_Helpers_ValidCharacterCollection.md) +- [Namespaces](R_Project_Documentation.md) + - [CapyKit Namespace](N_CapyKit.md) + - [CapyEventArgs Class](T_CapyKit_CapyEventArgs.md) + - [CapyEventArgs Constructor](M_CapyKit_CapyEventArgs__ctor.md) + - [CapyEventArgs Properties](Properties_T_CapyKit_CapyEventArgs.md) + - [Level Property](P_CapyKit_CapyEventArgs_Level.md) + - [Message Property](P_CapyKit_CapyEventArgs_Message.md) + - [MethodName Property](P_CapyKit_CapyEventArgs_MethodName.md) + - [CapyEventArgs Methods](Methods_T_CapyKit_CapyEventArgs.md) + - [CapyEventHandler Delegate](T_CapyKit_CapyEventHandler.md) + - [CapyEventReporter Class](T_CapyKit_CapyEventReporter.md) + - [CapyEventReporter Constructor](M_CapyKit_CapyEventReporter__cctor.md) + - [CapyEventReporter Methods](Methods_T_CapyKit_CapyEventReporter.md) + - [EmitEvent Method](M_CapyKit_CapyEventReporter_EmitEvent.md) + - [EmitEventOnce Method](M_CapyKit_CapyEventReporter_EmitEventOnce.md) + - [Subscribe Method](M_CapyKit_CapyEventReporter_Subscribe.md) + - [Unsubscribe Method](M_CapyKit_CapyEventReporter_Unsubscribe.md) + - [CapyEventReporter Fields](Fields_T_CapyKit_CapyEventReporter.md) + - [uniqueIdentifiers Field](F_CapyKit_CapyEventReporter_uniqueIdentifiers.md) + - [Color Enumeration](T_CapyKit_Color.md) + - [EventLevel Enumeration](T_CapyKit_EventLevel.md) + - [IPasswordAlgorithm Interface](T_CapyKit_IPasswordAlgorithm.md) + - [IPasswordAlgorithm Properties](Properties_T_CapyKit_IPasswordAlgorithm.md) + - [AlgorithmName Property](P_CapyKit_IPasswordAlgorithm_AlgorithmName.md) + - [IPasswordAlgorithm Methods](Methods_T_CapyKit_IPasswordAlgorithm.md) + - [Compare Method](M_CapyKit_IPasswordAlgorithm_Compare.md) + - [Encrypt Method](M_CapyKit_IPasswordAlgorithm_Encrypt.md) + - [Password Class](T_CapyKit_Password.md) + - [Password Constructor](M_CapyKit_Password__cctor.md) + - [Password Constructor](M_CapyKit_Password__ctor.md) + - [Password Properties](Properties_T_CapyKit_Password.md) + - [Algorithm Property](P_CapyKit_Password_Algorithm.md) + - [Hash Property](P_CapyKit_Password_Hash.md) + - [Pbkdf2Algorithm Property](P_CapyKit_Password_Pbkdf2Algorithm.md) + - [Salt Property](P_CapyKit_Password_Salt.md) + - [Password Methods](Methods_T_CapyKit_Password.md) + - [ToString Method](M_CapyKit_Password_ToString.md) + - [Password Fields](Fields_T_CapyKit_Password.md) + - [algorithm Field](F_CapyKit_Password_algorithm.md) + - [Pbkdf2Algorithm Class](T_CapyKit_Pbkdf2Algorithm.md) + - [Pbkdf2Algorithm Constructor](M_CapyKit_Pbkdf2Algorithm__ctor.md) + - [Pbkdf2Algorithm Properties](Properties_T_CapyKit_Pbkdf2Algorithm.md) + - [AlgorithmName Property](P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md) + - [Pbkdf2Algorithm Methods](Methods_T_CapyKit_Pbkdf2Algorithm.md) + - [Encrypt Method](M_CapyKit_Pbkdf2Algorithm_Encrypt.md) + - [Pbkdf2Algorithm Fields](Fields_T_CapyKit_Pbkdf2Algorithm.md) + - [ITERATIONS Field](F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md) + - [LENGTH Field](F_CapyKit_Pbkdf2Algorithm_LENGTH.md) + - [Pool Class](T_CapyKit_Pool_1.md) + - [Pool Constructor](Overload_CapyKit_Pool_1__ctor.md) + - [Pool(IEnumerable) Constructor](M_CapyKit_Pool_1__ctor.md) + - [Pool(Int32) Constructor](M_CapyKit_Pool_1__ctor_1.md) + - [Pool(Int32, Func) Constructor](M_CapyKit_Pool_1__ctor_2.md) + - [Pool Methods](Methods_T_CapyKit_Pool_1.md) + - [FillPoolItemCollection Method](Overload_CapyKit_Pool_1_FillPoolItemCollection.md) + - [FillPoolItemCollection(IEnumerable) Method](M_CapyKit_Pool_1_FillPoolItemCollection.md) + - [FillPoolItemCollection(Int32) Method](M_CapyKit_Pool_1_FillPoolItemCollection_1.md) + - [FillPoolItemCollection(Int32, Func) Method](M_CapyKit_Pool_1_FillPoolItemCollection_2.md) + - [GetAvailableItem Method](M_CapyKit_Pool_1_GetAvailableItem.md) + - [ReleaseItem Method](M_CapyKit_Pool_1_ReleaseItem.md) + - [Pool Fields](Fields_T_CapyKit_Pool_1.md) + - [poolItemCollection Field](F_CapyKit_Pool_1_poolItemCollection.md) + - [poolSize Field](F_CapyKit_Pool_1_poolSize.md) + - [PoolItem Class](T_CapyKit_PoolItem_1.md) + - [PoolItem Constructor](M_CapyKit_PoolItem_1__ctor.md) + - [PoolItem Properties](Properties_T_CapyKit_PoolItem_1.md) + - [Index Property](P_CapyKit_PoolItem_1_Index.md) + - [Item Property](P_CapyKit_PoolItem_1_Item.md) + - [Locked Property](P_CapyKit_PoolItem_1_Locked.md) + - [TypeName Property](P_CapyKit_PoolItem_1_TypeName.md) + - [PoolItem Methods](Methods_T_CapyKit_PoolItem_1.md) + - [ReleaseLock Method](M_CapyKit_PoolItem_1_ReleaseLock.md) + - [SetLock Method](M_CapyKit_PoolItem_1_SetLock.md) + - [ToString Method](M_CapyKit_PoolItem_1_ToString.md) + - [PoolItem Fields](Fields_T_CapyKit_PoolItem_1.md) + - [index Field](F_CapyKit_PoolItem_1_index.md) + - [item Field](F_CapyKit_PoolItem_1_item.md) + - [locked Field](F_CapyKit_PoolItem_1_locked.md) + - [typeName Field](F_CapyKit_PoolItem_1_typeName.md) + - [PropertyComparer Class](T_CapyKit_PropertyComparer_2.md) + - [PropertyComparer Constructor](M_CapyKit_PropertyComparer_2__ctor.md) + - [PropertyComparer Methods](Methods_T_CapyKit_PropertyComparer_2.md) + - [Equals Method](Overload_CapyKit_PropertyComparer_2_Equals.md) + - [Equals(T, T) Method](M_CapyKit_PropertyComparer_2_Equals.md) + - [GetHashCode Method](Overload_CapyKit_PropertyComparer_2_GetHashCode.md) + - [GetHashCode(T) Method](M_CapyKit_PropertyComparer_2_GetHashCode.md) + - [PropertyComparer Fields](Fields_T_CapyKit_PropertyComparer_2.md) + - [expression Field](F_CapyKit_PropertyComparer_2_expression.md) + - [CapyKit.Attributes Namespace](N_CapyKit_Attributes.md) + - [EnumerationAttribute Class](T_CapyKit_Attributes_EnumerationAttribute_1.md) + - [EnumerationAttribute Constructor](M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md) + - [EnumerationAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md) + - [Value Property](P_CapyKit_Attributes_EnumerationAttribute_1_Value.md) + - [EnumerationAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md) + - [EnumerationDescriptionAttribute Class](T_CapyKit_Attributes_EnumerationDescriptionAttribute.md) + - [EnumerationDescriptionAttribute Constructor](M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md) + - [EnumerationDescriptionAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md) + - [EnumerationDescriptionAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md) + - [CapyKit.Extensions Namespace](N_CapyKit_Extensions.md) + - [EnumerationExtensions Class](T_CapyKit_Extensions_EnumerationExtensions.md) + - [EnumerationExtensions Methods](Methods_T_CapyKit_Extensions_EnumerationExtensions.md) + - [GetDescription Method](M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md) + - [GetName Method](M_CapyKit_Extensions_EnumerationExtensions_GetName.md) + - [GetPrettyName Method](M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md) + - [GetValue Method](M_CapyKit_Extensions_EnumerationExtensions_GetValue.md) + - [Parse Method](Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md) + - [Parse(T, String) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md) + - [Parse(T, String, Boolean) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md) + - [LINQExtensions Class](T_CapyKit_Extensions_LINQExtensions.md) + - [LINQExtensions Methods](Methods_T_CapyKit_Extensions_LINQExtensions.md) + - [Distinct Method](M_CapyKit_Extensions_LINQExtensions_Distinct__2.md) + - [Filter Method](Overload_CapyKit_Extensions_LINQExtensions_Filter.md) + - [Filter(IEnumerable, Func) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1.md) + - [Filter(IQueryable, Expression>) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md) + - [LeftOuterJoin Method](Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md) + - [LeftOuterJoin(IQueryable, IQueryable, Expression>, Expression>, Expression, R>>) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md) + - [LeftOuterJoin(IEnumerable, IEnumerable, Func, Func, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md) + - [LeftOuterJoin(IQueryable, IQueryable, Expression>, Expression>, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md) + - [Page Method](Overload_CapyKit_Extensions_LINQExtensions_Page.md) + - [Page(IEnumerable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1.md) + - [Page(IQueryable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1_1.md) + - [PageCount Method](Overload_CapyKit_Extensions_LINQExtensions_PageCount.md) + - [PageCount(IEnumerable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1.md) + - [PageCount(IQueryable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md) + - [StringExtensions Class](T_CapyKit_Extensions_StringExtensions.md) + - [StringExtensions Methods](Methods_T_CapyKit_Extensions_StringExtensions.md) + - [IfNullOrEmpty Method](M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md) + - [IfNullOrWhiteSpace Method](M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md) + - [CapyKit.Helpers Namespace](N_CapyKit_Helpers.md) + - [CompressionHelper Class](T_CapyKit_Helpers_CompressionHelper.md) + - [CompressionHelper Methods](Methods_T_CapyKit_Helpers_CompressionHelper.md) + - [Compress Method](M_CapyKit_Helpers_CompressionHelper_Compress.md) + - [CompressToString Method](M_CapyKit_Helpers_CompressionHelper_CompressToString.md) + - [Decompress Method](Overload_CapyKit_Helpers_CompressionHelper_Decompress.md) + - [Decompress(Byte[]) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1.md) + - [Decompress(String) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md) + - [DecompressToString Method](M_CapyKit_Helpers_CompressionHelper_DecompressToString.md) + - [LanguageHelper Class](T_CapyKit_Helpers_LanguageHelper.md) + - [LanguageHelper Constructor](M_CapyKit_Helpers_LanguageHelper__ctor.md) + - [LanguageHelper Methods](Methods_T_CapyKit_Helpers_LanguageHelper.md) + - [CamelCaseToHumanReadable Method](M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md) + - [SecurityHelper Class](T_CapyKit_Helpers_SecurityHelper.md) + - [SecurityHelper Constructor](M_CapyKit_Helpers_SecurityHelper__ctor.md) + - [SecurityHelper Methods](Methods_T_CapyKit_Helpers_SecurityHelper.md) + - [CompareHashedPassword Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md) + - [CompareSessionID Method](M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md) + - [CompareStrings Method](M_CapyKit_Helpers_SecurityHelper_CompareStrings.md) + - [GetRandomBytes Method](M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md) + - [GetRandomPassword Method](M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md) + - [GetRandomString Method](Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md) + - [GetRandomString(Int32) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString.md) + - [GetRandomString(Int32, ValidCharacterCollection[]) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md) + - [GetValidCharacterComposition Method](M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md) + - [HashPassword Method](M_CapyKit_Helpers_SecurityHelper_HashPassword.md) + - [Pbkdf2 Method](Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md) + - [Pbkdf2(String) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md) + - [Pbkdf2(String, Byte[]) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md) + - [SecurityHelper Fields](Fields_T_CapyKit_Helpers_SecurityHelper.md) + - [LOWER_CASE_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md) + - [NUMBER_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md) + - [saltSize Field](F_CapyKit_Helpers_SecurityHelper_saltSize.md) + - [SPECIAL_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md) + - [UPPER_CASE_CHARACTERS Field](F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md) + - [SerializationHelper Class](T_CapyKit_Helpers_SerializationHelper.md) + - [SerializationHelper Methods](Methods_T_CapyKit_Helpers_SerializationHelper.md) + - [Deserialize Method](Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md) + - [Deserialize(Byte[]) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md) + - [Deserialize(Stream) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md) + - [Deserialize(String) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md) + - [SerializeToBytes Method](M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md) + - [SerializeToString Method](M_CapyKit_Helpers_SerializationHelper_SerializeToString.md) + - [SettingsHelper Class](T_CapyKit_Helpers_SettingsHelper.md) + - [SettingsHelper Constructor](M_CapyKit_Helpers_SettingsHelper__cctor.md) + - [SettingsHelper Methods](Methods_T_CapyKit_Helpers_SettingsHelper.md) + - [GetApplicationSetting Method](M_CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1.md) + - [SetAccessorMethod Method](M_CapyKit_Helpers_SettingsHelper_SetAccessorMethod.md) + - [SetDetectorMethod Method](M_CapyKit_Helpers_SettingsHelper_SetDetectorMethod.md) + - [SettingsHelper Fields](Fields_T_CapyKit_Helpers_SettingsHelper.md) + - [accessor Field](F_CapyKit_Helpers_SettingsHelper_accessor.md) + - [detector Field](F_CapyKit_Helpers_SettingsHelper_detector.md) + - [ValidCharacterCollection Enumeration](T_CapyKit_Helpers_ValidCharacterCollection.md) diff --git a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md b/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md deleted file mode 100644 index d07661f..0000000 --- a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md +++ /dev/null @@ -1,15 +0,0 @@ -# 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