diff --git a/Documentation/ContentLayout.content b/Documentation/ContentLayout.content index bb476cf..e3d5587 100644 --- a/Documentation/ContentLayout.content +++ b/Documentation/ContentLayout.content @@ -1,11 +1,11 @@  - + - + diff --git a/Documentation/Documentation.shfbproj b/Documentation/Documentation.shfbproj index eb9fe05..08891b3 100644 --- a/Documentation/Documentation.shfbproj +++ b/Documentation/Documentation.shfbproj @@ -18,17 +18,18 @@ Documentation .NET Framework 4.7.2 - .\Help\ + Help\ Documentation en-US - - - - - - - + + + + + + + + Markdown C#, F# @@ -51,6 +52,15 @@ 2 False Blank + Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Internals, Privates, PrivateFields, Protected, SealedProtected, ProtectedInternalAsProtected, NonBrowsable + + + False + Msdn + True + False + Msdn + True diff --git a/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md b/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md index c7980ce..2f7a7bd 100644 --- a/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md +++ b/Documentation/Help/7d36447b-0aab-4ce9-b5ed-e60ec5bee103.md @@ -6,7 +6,7 @@ The topics in this section describe the various changes made to the [TODO: Proje ## Version History Select a version below to see a description of its changes. - + @@ -14,4 +14,4 @@ Select a version below to see a description of its changes. #### Other Resources -Welcome to the [TODO: Add project name] +CapyKit - C# Utilities diff --git a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md index cfe3f69..d14b7b7 100644 --- a/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md +++ b/Documentation/Help/849aa079-3d64-4cf1-966f-44af23c73160.md @@ -1,4 +1,4 @@ -# Welcome to the [TODO: Add project name] +# CapyKit - C# Utilities This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. @@ -24,4 +24,4 @@ See the **Conceptual Content** topics in the Sandcastle Help File Builder's help #### Other Resources -Version History +Version History diff --git a/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md b/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md new file mode 100644 index 0000000..32ddab5 --- /dev/null +++ b/Documentation/Help/F_CapyKit_CapyEventReporter_uniqueIdentifiers.md @@ -0,0 +1,32 @@ +# uniqueIdentifiers Field + + +A hash set storing unique identifiers for events intended to only be emitted once. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private static HashSet uniqueIdentifiers +``` +**F#** +``` F# +static val mutable private uniqueIdentifiers: HashSet +``` + + + +#### Field Value +HashSet(String) + +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace +EmitEventOnce(EventLevel, String, String, String, Object[]) diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md new file mode 100644 index 0000000..38b4003 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md @@ -0,0 +1,31 @@ +# LOWER_CASE_CHARACTERS Field + + +A string of all the lower case characters. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz" +``` +**F#** +``` F# +static val mutable internal LOWER_CASE_CHARACTERS: string +``` + + + +#### Field Value +String + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md new file mode 100644 index 0000000..cbd26f6 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md @@ -0,0 +1,31 @@ +# NUMBER_CHARACTERS Field + + +A string of all the numeric characters. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal const string NUMBER_CHARACTERS = "0123456789" +``` +**F#** +``` F# +static val mutable internal NUMBER_CHARACTERS: string +``` + + + +#### Field Value +String + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md new file mode 100644 index 0000000..1e40114 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md @@ -0,0 +1,31 @@ +# SPECIAL_CHARACTERS Field + + +A string of the most common non-alphanumeric characters. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal const string SPECIAL_CHARACTERS = "!@#$%&?+-_" +``` +**F#** +``` F# +static val mutable internal SPECIAL_CHARACTERS: string +``` + + + +#### Field Value +String + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md new file mode 100644 index 0000000..372d274 --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md @@ -0,0 +1,31 @@ +# UPPER_CASE_CHARACTERS Field + + +A string of all the upper case characters. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" +``` +**F#** +``` F# +static val mutable internal UPPER_CASE_CHARACTERS: string +``` + + + +#### Field Value +String + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md new file mode 100644 index 0000000..b1ad37e --- /dev/null +++ b/Documentation/Help/F_CapyKit_Helpers_SecurityHelper_saltSize.md @@ -0,0 +1,31 @@ +# saltSize Field + + +Default size of the generated salt. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private const int saltSize = 32 +``` +**F#** +``` F# +static val mutable private saltSize: int +``` + + + +#### Field Value +Int32 + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/F_CapyKit_Password_algorithm.md b/Documentation/Help/F_CapyKit_Password_algorithm.md new file mode 100644 index 0000000..102d4dc --- /dev/null +++ b/Documentation/Help/F_CapyKit_Password_algorithm.md @@ -0,0 +1,31 @@ +# algorithm Field + + +\[Missing <summary> documentation for "F:CapyKit.Password.algorithm"\] + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private static Lazy algorithm +``` +**F#** +``` F# +static val mutable private algorithm: Lazy +``` + + + +#### Field Value +Lazy(Pbkdf2Algorithm) + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md index 7b3e04b..2389b15 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md @@ -6,7 +6,7 @@ The default number of iterations. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -30,5 +30,5 @@ This member is immutable. #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md index f9736a9..4917468 100644 --- a/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md +++ b/Documentation/Help/F_CapyKit_Pbkdf2Algorithm_LENGTH.md @@ -6,7 +6,7 @@ ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -30,5 +30,5 @@ This member is immutable. #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_index.md b/Documentation/Help/F_CapyKit_PoolItem_1_index.md new file mode 100644 index 0000000..cf47098 --- /dev/null +++ b/Documentation/Help/F_CapyKit_PoolItem_1_index.md @@ -0,0 +1,31 @@ +# index Field + + +The zero-based index of the pooled item. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private readonly int index +``` +**F#** +``` F# +val private index: int +``` + + + +#### Field Value +Int32 + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_item.md b/Documentation/Help/F_CapyKit_PoolItem_1_item.md new file mode 100644 index 0000000..3040a0c --- /dev/null +++ b/Documentation/Help/F_CapyKit_PoolItem_1_item.md @@ -0,0 +1,31 @@ +# item Field + + +The pooled item. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private readonly T item +``` +**F#** +``` F# +val private item: 'T +``` + + + +#### Field Value +T + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_locked.md b/Documentation/Help/F_CapyKit_PoolItem_1_locked.md new file mode 100644 index 0000000..b139620 --- /dev/null +++ b/Documentation/Help/F_CapyKit_PoolItem_1_locked.md @@ -0,0 +1,31 @@ +# locked Field + + +A flag indicating whether the item is locked or not. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private bool locked +``` +**F#** +``` F# +val mutable private locked: bool +``` + + + +#### Field Value +Boolean + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md b/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md new file mode 100644 index 0000000..b94c82d --- /dev/null +++ b/Documentation/Help/F_CapyKit_PoolItem_1_typeName.md @@ -0,0 +1,31 @@ +# typeName Field + + +The name of the pooled item Type. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private readonly string typeName +``` +**F#** +``` F# +val private typeName: string +``` + + + +#### Field Value +String + +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md b/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md new file mode 100644 index 0000000..59f52bf --- /dev/null +++ b/Documentation/Help/F_CapyKit_Pool_1_poolItemCollection.md @@ -0,0 +1,31 @@ +# poolItemCollection Field + + +The collection of pooled items. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private readonly ConcurrentBag> poolItemCollection +``` +**F#** +``` F# +val private poolItemCollection: ConcurrentBag> +``` + + + +#### Field Value +ConcurrentBag(PoolItem(T)) + +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_Pool_1_poolSize.md b/Documentation/Help/F_CapyKit_Pool_1_poolSize.md new file mode 100644 index 0000000..06e62da --- /dev/null +++ b/Documentation/Help/F_CapyKit_Pool_1_poolSize.md @@ -0,0 +1,31 @@ +# poolSize Field + + +(Immutable) The number of items in the pool. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private readonly int poolSize +``` +**F#** +``` F# +val private poolSize: int +``` + + + +#### Field Value +Int32 + +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md b/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md new file mode 100644 index 0000000..a8cba63 --- /dev/null +++ b/Documentation/Help/F_CapyKit_PropertyComparer_2_expression.md @@ -0,0 +1,31 @@ +# expression Field + + +The expression to retrieve the property. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private Func expression +``` +**F#** +``` F# +val mutable private expression: Func<'T, 'U> +``` + + + +#### Field Value +Func(T, U) + +## See Also + + +#### Reference +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_CapyEventReporter.md b/Documentation/Help/Fields_T_CapyKit_CapyEventReporter.md new file mode 100644 index 0000000..2947ed4 --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_CapyEventReporter.md @@ -0,0 +1,18 @@ +# CapyEventReporter Fields + + + + +## Fields + + + + +
uniqueIdentifiersA hash set storing unique identifiers for events intended to only be emitted once.
+ +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/Fields_T_CapyKit_Helpers_SecurityHelper.md new file mode 100644 index 0000000..193d79f --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_Helpers_SecurityHelper.md @@ -0,0 +1,30 @@ +# SecurityHelper Fields + + + + +## Fields + + + + + + + + + + + + + + + + +
LOWER_CASE_CHARACTERSA string of all the lower case characters.
NUMBER_CHARACTERSA string of all the numeric characters.
saltSizeDefault size of the generated salt.
SPECIAL_CHARACTERSA string of the most common non-alphanumeric characters.
UPPER_CASE_CHARACTERSA string of all the upper case characters.
+ +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_Password.md b/Documentation/Help/Fields_T_CapyKit_Password.md new file mode 100644 index 0000000..9688eea --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_Password.md @@ -0,0 +1,18 @@ +# Password Fields + + + + +## Fields + + + + +
algorithm 
+ +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md index 3932c5f..371a68c 100644 --- a/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/Fields_T_CapyKit_Pbkdf2Algorithm.md @@ -6,10 +6,10 @@ ## Fields - + - +
ITERATIONSITERATIONS The default number of iterations.
LENGTHLENGTH (Immutable) The default length.
@@ -17,5 +17,5 @@ #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_PoolItem_1.md b/Documentation/Help/Fields_T_CapyKit_PoolItem_1.md new file mode 100644 index 0000000..d15db35 --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_PoolItem_1.md @@ -0,0 +1,27 @@ +# PoolItem<T> Fields + + + + +## Fields + + + + + + + + + + + + + +
indexThe zero-based index of the pooled item.
itemThe pooled item.
lockedA flag indicating whether the item is locked or not.
typeNameThe name of the pooled item Type.
+ +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_Pool_1.md b/Documentation/Help/Fields_T_CapyKit_Pool_1.md new file mode 100644 index 0000000..6aaf2a0 --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_Pool_1.md @@ -0,0 +1,21 @@ +# Pool<T> Fields + + + + +## Fields + + + + + + + +
poolItemCollectionThe collection of pooled items.
poolSize(Immutable) The number of items in the pool.
+ +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Fields_T_CapyKit_PropertyComparer_2.md b/Documentation/Help/Fields_T_CapyKit_PropertyComparer_2.md new file mode 100644 index 0000000..418bba6 --- /dev/null +++ b/Documentation/Help/Fields_T_CapyKit_PropertyComparer_2.md @@ -0,0 +1,18 @@ +# PropertyComparer<T, U> Fields + + + + +## Fields + + + + +
expressionThe expression to retrieve the property.
+ +## See Also + + +#### Reference +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/Home.md b/Documentation/Help/Home.md index cfe3f69..d14b7b7 100644 --- a/Documentation/Help/Home.md +++ b/Documentation/Help/Home.md @@ -1,4 +1,4 @@ -# Welcome to the [TODO: Add project name] +# CapyKit - C# Utilities This is a sample conceptual topic. You can use this as a starting point for adding more conceptual content to your help project. @@ -24,4 +24,4 @@ See the **Conceptual Content** topics in the Sandcastle Help File Builder's help #### Other Resources -Version History +Version History diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md index a3877b7..f4354e8 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationAttribute_1__ctor.md @@ -6,7 +6,7 @@ Gets the value of the enumeration represented by this attribute. ## Definition -**Namespace:** CapyKit.Attributes +**Namespace:** CapyKit.Attributes **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,11 +24,11 @@ new : #### Parameters -
  T
Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
+
  T
Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
## See Also #### Reference -EnumerationAttribute(T) Class -CapyKit.Attributes Namespace +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md index a6a4cf1..6205850 100644 --- a/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md +++ b/Documentation/Help/M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor.md @@ -1,12 +1,12 @@ # EnumerationDescriptionAttribute Constructor -Initializes a new instance of the EnumerationDescriptionAttribute class with the specified description. +Initializes a new instance of the EnumerationDescriptionAttribute class with the specified description. ## Definition -**Namespace:** CapyKit.Attributes +**Namespace:** CapyKit.Attributes **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -30,5 +30,5 @@ new : #### Reference -EnumerationDescriptionAttribute Class -CapyKit.Attributes Namespace +EnumerationDescriptionAttribute Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md index e959dce..3fe8e54 100644 --- a/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md +++ b/Documentation/Help/M_CapyKit_CapyEventArgs__ctor.md @@ -6,7 +6,7 @@ Initializes a new instance of the CapyEventArgs class with the specified event l ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -32,11 +32,11 @@ new : #### Parameters -
  EventLevel
The severity level of the event.
  String
A descriptive message explaining the reason for the event.
  String  (Optional)
The name of the method where the event was raised.
+
  EventLevel
The severity level of the event.
  String
A descriptive message explaining the reason for the event.
  String  (Optional)
The name of the method where the event was raised.
## See Also #### Reference -CapyEventArgs Class -CapyKit Namespace +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md new file mode 100644 index 0000000..155ad7e --- /dev/null +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEvent.md @@ -0,0 +1,51 @@ +# EmitEvent Method + + +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 + +**C#** +``` C# +internal static void EmitEvent( + EventLevel eventLevel, + string message, + string method = null, + params Object[] args +) +``` +**F#** +``` F# +internal static member EmitEvent : + eventLevel : EventLevel * + message : string * + ?method : string * + args : Object[] +(* Defaults: + let _method = defaultArg method null +*) +-> unit +``` + + + +#### Parameters +
  EventLevel
The severity level of the event.
  String
The message describing the reason for the event. String formatting for args is accepted.
  String  (Optional)
(Optional) The name of the method where the event was raised.
  Object[]
A variable-length parameters list containing arguments for formatting the message.
+ +## Remarks +In order to allow for efficient calling member access via CallerMemberNameAttribute , it is suggested that *args* is defined explicitly for formatted messages. + +## Example +CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration }); + +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace +CallerMemberNameAttribute diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md new file mode 100644 index 0000000..ebc4ed7 --- /dev/null +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_EmitEventOnce.md @@ -0,0 +1,51 @@ +# EmitEventOnce Method + + +Emits an event with the given severity level, message, unique identifier, and method name one time. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal static void EmitEventOnce( + EventLevel eventLevel, + string message, + string uniqueIdentifier, + string method = null, + params Object[] args +) +``` +**F#** +``` F# +internal static member EmitEventOnce : + eventLevel : EventLevel * + message : string * + uniqueIdentifier : string * + ?method : string * + args : Object[] +(* Defaults: + let _method = defaultArg method null +*) +-> unit +``` + + + +#### Parameters +
  EventLevel
The severity level of the event.
  String
The message describing the reason for the event. String formatting for args is accepted.
  String
A unique identifier for the event emission.
  String  (Optional)
(Optional) The name of the method where the event was raised.
  Object[]
A variable-length parameters list containing arguments for formatting the message.
+ +## Remarks +This method is similar to [!:EmitEvent(EventLevel, string, string, string, object[])] , but requires a unique identifier (such as a Guid) to prevent duplicate emissions. + +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace +CallerMemberNameAttribute +Guid diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md index 55706d4..4cc9963 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Subscribe.md @@ -6,7 +6,7 @@ Subscribes the specified event handler to the event with the given subscription ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -32,7 +32,7 @@ static member Subscribe : #### Parameters -
  CapyEventHandler
The event handler to subscribe.
  EventLevel
The severity level of the event to subscribe to.
  String  (Optional)
(Optional) The name of the method or class where the subscription is made.
+
  CapyEventHandler
The event handler to subscribe.
  EventLevel
The severity level of the event to subscribe to.
  String  (Optional)
(Optional) The name of the method or class where the subscription is made.
## Remarks If there is no existing list for the given subscription level, a new list is created and added to the dictionary. @@ -41,5 +41,5 @@ If there is no existing list for the given subscription level, a new list is cre #### Reference -CapyEventReporter Class -CapyKit Namespace +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md index 2075189..75127cb 100644 --- a/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md +++ b/Documentation/Help/M_CapyKit_CapyEventReporter_Unsubscribe.md @@ -6,7 +6,7 @@ Unsubscribes the specified event handler from the event with the given origin. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,11 +26,11 @@ static member Unsubscribe : #### Parameters -
  CapyEventHandler
The event handler to unsubscribe.
  String
The name of the method or class where the subscription was made.
+
  CapyEventHandler
The event handler to unsubscribe.
  String
The name of the method or class where the subscription was made.
## See Also #### Reference -CapyEventReporter Class -CapyKit Namespace +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md b/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md new file mode 100644 index 0000000..0dadc89 --- /dev/null +++ b/Documentation/Help/M_CapyKit_CapyEventReporter__cctor.md @@ -0,0 +1,28 @@ +# CapyEventReporter Constructor + + +Initializes the static fields of the CapyEventReporter class + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +static CapyEventReporter() +``` +**F#** +``` F# +new : unit -> CapyEventReporter +``` + + + +## See Also + + +#### Reference +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md index 15bd6e1..0d8ec27 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md @@ -6,7 +6,7 @@ An CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide). #### Reference -EnumerationExtensions Class -CapyKit.Extensions Namespace +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md index f481d4e..32aa2f3 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetName.md @@ -6,7 +6,7 @@ An CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide). #### Reference -EnumerationExtensions Class -CapyKit.Extensions Namespace +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md index 8b94193..ee9fcf0 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName.md @@ -6,7 +6,7 @@ An CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide). #### Reference -EnumerationExtensions Class -CapyKit.Extensions Namespace +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md index c2e088f..7521b9f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetValue.md @@ -6,7 +6,7 @@ An CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -42,5 +42,5 @@ Extension Methods (C# Programming Guide). #### Reference -EnumerationExtensions Class -CapyKit.Extensions Namespace +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md index 6a85563..fe5e19e 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1.md @@ -6,7 +6,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -49,6 +49,6 @@ Extension Methods (C# Programming Guide). #### Reference -EnumerationExtensions Class -Parse Overload -CapyKit.Extensions Namespace +EnumerationExtensions Class +Parse Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md index 8c63acc..ba971a7 100644 --- a/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1.md @@ -6,7 +6,7 @@ A *T* extension method that parses a string into an enumeration. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -51,6 +51,6 @@ Extension Methods (C# Programming Guide). #### Reference -EnumerationExtensions Class -Parse Overload -CapyKit.Extensions Namespace +EnumerationExtensions Class +Parse Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md index c8b1de0..76933c7 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Distinct__2.md @@ -6,7 +6,7 @@ Enumerates distinct items in this collection as defined by the key *property*. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -48,5 +48,5 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -CapyKit.Extensions Namespace +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md index c88adad..a7a8662 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1.md @@ -6,7 +6,7 @@ Filters out items matching a *predicate* from the collection. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -48,6 +48,6 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -Filter Overload -CapyKit.Extensions Namespace +LINQExtensions Class +Filter Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md index 58b053f..e0ade2b 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Filter__1_1.md @@ -6,7 +6,7 @@ Filters out items matching a *predicate* from the collection. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -48,6 +48,6 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -Filter Overload -CapyKit.Extensions Namespace +LINQExtensions Class +Filter Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md index 11d2cc9..cb8c0f2 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4.md @@ -6,7 +6,7 @@ An IEnumable<T> extension method that left outer join. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -60,6 +60,6 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -LeftOuterJoin Overload -CapyKit.Extensions Namespace +LINQExtensions Class +LeftOuterJoin Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md index 49443e8..3300140 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1.md @@ -6,7 +6,7 @@ An IQueryable<T> extension method that left outer join. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -60,6 +60,6 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -LeftOuterJoin Overload -CapyKit.Extensions Namespace +LINQExtensions Class +LeftOuterJoin Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md new file mode 100644 index 0000000..30cc76f --- /dev/null +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_2.md @@ -0,0 +1,59 @@ +# LeftOuterJoin<T, U, TKey, R>(IQueryable<T>, IQueryable<U>, Expression<Func<T, TKey>>, Expression<Func<U, TKey>>, Expression<Func<T, IEnumerable<U>, R>>) Method + + +An IQueryable<T> extension method that left outer join. + + + +## Definition +**Namespace:** CapyKit.Extensions +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private static IQueryable LeftOuterJoin( + this IQueryable source, + IQueryable inner, + Expression> outerSelector, + Expression> innerSelector, + Expression, R>> resultSelector +) + +``` +**F#** +``` F# +[] +private static member LeftOuterJoin : + source : IQueryable<'T> * + inner : IQueryable<'U> * + outerSelector : Expression> * + innerSelector : Expression> * + resultSelector : Expression, 'R>> -> IQueryable<'R> +``` + + + +#### Parameters +
  IQueryable(T)
The source to act on.
  IQueryable(U)
The inner.
  Expression(Func(T, TKey))
The outer selector.
  Expression(Func(U, TKey))
The inner selector.
  Expression(Func(T, IEnumerable(U), R))
The result selector.
+ +#### Type Parameters +
Generic type parameter.
Generic type parameter.
Type of the key.
Type of the r.
+ +#### Return Value +IQueryable(R) +An IQueryable<R> + +#### Usage Note +In Visual Basic and C#, you can call this method as an instance method on any object of type IQueryable(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see + +Extension Methods (Visual Basic) or + +Extension Methods (C# Programming Guide). + +## See Also + + +#### Reference +LINQExtensions Class +LeftOuterJoin Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md index 1f2c65f..96e47a4 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1.md @@ -6,7 +6,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -55,6 +55,6 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -PageCount Overload -CapyKit.Extensions Namespace +LINQExtensions Class +PageCount Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md index 0c196b9..4bd8187 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_PageCount__1_1.md @@ -6,7 +6,7 @@ The number of pages of *pageSize* size in the given collection. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -55,6 +55,6 @@ Extension Methods (C# Programming Guide). #### Reference -LINQExtensions Class -PageCount Overload -CapyKit.Extensions Namespace +LINQExtensions Class +PageCount Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md index 82d3dc6..f49f852 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1.md @@ -6,7 +6,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -60,6 +60,6 @@ This method uses natural numbering starting at page 1. #### Reference -LINQExtensions Class -Page Overload -CapyKit.Extensions Namespace +LINQExtensions Class +Page Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md index 76affe0..3f0b759 100644 --- a/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md +++ b/Documentation/Help/M_CapyKit_Extensions_LINQExtensions_Page__1_1.md @@ -6,7 +6,7 @@ Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -60,6 +60,6 @@ This method uses natural numbering starting at page 1. #### Reference -LINQExtensions Class -Page Overload -CapyKit.Extensions Namespace +LINQExtensions Class +Page Overload +CapyKit.Extensions Namespace diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md index c1c4e60..388cf4f 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty.md @@ -6,7 +6,7 @@ Replaces a null or empty string with a specified replacement string. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -44,6 +44,6 @@ Extension Methods (C# Programming Guide). #### Reference -StringExtensions Class -CapyKit.Extensions Namespace +StringExtensions Class +CapyKit.Extensions Namespace IsNullOrEmpty(String) diff --git a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md index f0db1c0..72117ec 100644 --- a/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md +++ b/Documentation/Help/M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace.md @@ -6,7 +6,7 @@ Replaces a null or whitespace string with a specified replacement string. ## Definition -**Namespace:** CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -44,6 +44,6 @@ Extension Methods (C# Programming Guide). #### Reference -StringExtensions Class -CapyKit.Extensions Namespace +StringExtensions Class +CapyKit.Extensions Namespace IsNullOrWhiteSpace(String) diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md index 7817e0f..9ed2b80 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Compress.md @@ -6,7 +6,7 @@ Compresses a given object using the `gzip` algorithm. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ A byte array representing the compressed object in `gzip` format. #### Reference -CompressionHelper Class -CapyKit.Helpers Namespace +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md index 0db3a8f..a08efd3 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_CompressToString.md @@ -6,7 +6,7 @@ Compresses a given object to a string using `base64` encoding of `gzip` format. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ A string in `base64` encoding. #### Reference -CompressionHelper Class -CapyKit.Helpers Namespace +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md index 4ff8102..3ccf3ee 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_DecompressToString.md @@ -6,7 +6,7 @@ Decompresses the given `base64` string in `gzip` format. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ A decomressed string. #### Reference -CompressionHelper Class -CapyKit.Helpers Namespace +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md index b0121cb..6c8d0cf 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1.md @@ -6,7 +6,7 @@ Decompresses a given compressed `gzip` byte stream. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -38,6 +38,6 @@ A *T* typed object. #### Reference -CompressionHelper Class -Decompress Overload -CapyKit.Helpers Namespace +CompressionHelper Class +Decompress Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md index 024109b..4a1a393 100644 --- a/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_CompressionHelper_Decompress__1_1.md @@ -6,7 +6,7 @@ Decompresses a given `base64` encoded string of `gzip` format. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -38,6 +38,6 @@ A *T* typed object. #### Reference -CompressionHelper Class -Decompress Overload -CapyKit.Helpers Namespace +CompressionHelper Class +Decompress Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md index 82381a0..b7c9a1f 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable.md @@ -6,7 +6,7 @@ Converts camel case text to human readable text. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ A string in human readable format. #### Reference -LanguageHelper Class -CapyKit.Helpers Namespace +LanguageHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md index 11daf0c..9d9e650 100644 --- a/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_LanguageHelper__ctor.md @@ -1,12 +1,12 @@ # LanguageHelper Constructor -Initializes a new instance of the LanguageHelper class +Initializes a new instance of the LanguageHelper class ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,5 +24,5 @@ new : unit -> LanguageHelper #### Reference -LanguageHelper Class -CapyKit.Helpers Namespace +LanguageHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md index 1b3f8a3..bf39d98 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword.md @@ -6,7 +6,7 @@ Compares an unencrypted *providedPassword* with a stored, encrypted *existingPas ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -36,5 +36,5 @@ true if hash comparison succeeds, false if it fails. #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md index 80bc1a9..54504d8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareSessionID.md @@ -6,7 +6,7 @@ Compares two session identifiers. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -36,5 +36,5 @@ true if comparison succeeds, false if not. #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md new file mode 100644 index 0000000..02f0f60 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_CompareStrings.md @@ -0,0 +1,43 @@ +# CompareStrings Method + + +Compare two strings as case sensative. + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private static bool CompareStrings( + string first, + string second +) +``` +**F#** +``` F# +private static member CompareStrings : + first : string * + second : string -> bool +``` + + + +#### Parameters +
  String
The first string.
  String
The second string.
+ +#### Return Value +Boolean +true if the comparison succeeds, false if not. + +## Remarks +This method is a proxy for using Compare(String, Int32, String, Int32, Int32, StringComparison) with the `StringComparison` set to Ordinal. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md new file mode 100644 index 0000000..e0a7cce --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomBytes.md @@ -0,0 +1,38 @@ +# GetRandomBytes Method + + +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 + +**C#** +``` C# +private static byte[] GetRandomBytes( + int length +) +``` +**F#** +``` F# +private static member GetRandomBytes : + length : int -> byte[] +``` + + + +#### Parameters +
  Int32
The desired length of the generated byte array.
+ +#### Return Value +Byte[] +A new byte array of the specified length filled with random values. + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md index 897a013..5bd8c4f 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomPassword.md @@ -6,7 +6,7 @@ Gets a cryptographically strong random password. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,7 +26,7 @@ static member GetRandomPassword : #### Parameters -
  Int32
The length of the password to generate.
  ValidCharacterCollection[]
\[Missing <param name="validCharacters"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomPassword(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]
+
  Int32
The length of the password to generate.
  ValidCharacterCollection[]
\[Missing <param name="validCharacters"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomPassword(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]
#### Return Value String @@ -36,5 +36,5 @@ The password. #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md index 3ce2f29..d23ea2c 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString.md @@ -6,7 +6,7 @@ A convenience method to generate a random string of the specified length using a ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,8 +34,8 @@ static member GetRandomString : #### Reference -SecurityHelper Class -GetRandomString Overload -CapyKit.Helpers Namespace -ValidCharacterCollection -GetRandomString(Int32, ValidCharacterCollection[]) +SecurityHelper Class +GetRandomString Overload +CapyKit.Helpers Namespace +ValidCharacterCollection +GetRandomString(Int32, ValidCharacterCollection[]) diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md index 3f55610..1f4dc07 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetRandomString_1.md @@ -6,7 +6,7 @@ Gets a cryptographically strong random string using the character values found i ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,7 +26,7 @@ static member GetRandomString : #### Parameters -
  Int32
The length of the string to create.
  ValidCharacterCollection[]
\[Missing <param name="validChars"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]
+
  Int32
The length of the string to create.
  ValidCharacterCollection[]
\[Missing <param name="validChars"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])"\]
#### Return Value String @@ -36,6 +36,6 @@ The random string. #### Reference -SecurityHelper Class -GetRandomString Overload -CapyKit.Helpers Namespace +SecurityHelper Class +GetRandomString Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md new file mode 100644 index 0000000..ba2f720 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_GetValidCharacterComposition.md @@ -0,0 +1,38 @@ +# GetValidCharacterComposition Method + + +\[Missing <summary> documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\] + + + +## Definition +**Namespace:** CapyKit.Helpers +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private static string GetValidCharacterComposition( + params ValidCharacterCollection[] validCharacters +) +``` +**F#** +``` F# +private static member GetValidCharacterComposition : + validCharacters : ValidCharacterCollection[] -> string +``` + + + +#### Parameters +
  ValidCharacterCollection[]
\[Missing <param name="validCharacters"/> documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\]
+ +#### Return Value +String +\[Missing <returns> documentation for "M:CapyKit.Helpers.SecurityHelper.GetValidCharacterComposition(CapyKit.Helpers.ValidCharacterCollection[])"\] + +## See Also + + +#### Reference +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md index 446c88b..877eaf8 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_HashPassword.md @@ -6,7 +6,7 @@ Hashes an unencrypted password. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ The hashed password. #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md index 6872fd7..1975bd9 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -1,12 +1,12 @@ # Pbkdf2(String) Method -Generates a new Password object using the PBKDF2 algorithm with the provided *password*. This overload of the method generates a random salt value for added security. +Generates a new Password object using the PBKDF2 algorithm with the provided *password*. This overload of the method generates a random salt value for added security. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -27,16 +27,16 @@ static member Pbkdf2 :
  String
The clear text password to be hashed.
#### Return Value -Password -A new Password object containing the hashed password and a randomly generated salt. +Password +A new Password object containing the hashed password and a randomly generated salt. ## Remarks -This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. In this overload, a random salt value is generated using GetRandomBytes(Int32) method. +This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. In this overload, a random salt value is generated using GetRandomBytes(Int32) method. ## See Also #### Reference -SecurityHelper Class -Pbkdf2 Overload -CapyKit.Helpers Namespace +SecurityHelper Class +Pbkdf2 Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md index 067fb28..90316c1 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1.md @@ -1,12 +1,12 @@ # Pbkdf2(String, Byte[]) Method -Generates a new Password object using the PBKDF2 algorithm with the provided *password* and *salt*. +Generates a new Password object using the PBKDF2 algorithm with the provided *password* and *salt*. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,8 +29,8 @@ static member Pbkdf2 :
  String
The clear text password to be hashed.
  Byte[]
A random value used to add an additional layer of security to the generated hash.
#### Return Value -Password -A new Password object containing the hashed password and salt. +Password +A new Password object containing the hashed password and salt. ## Remarks This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate a new password hash. The algorithm iteratively applies a pseudorandom function to the password and salt, which increases the security of the resulting hash. @@ -39,6 +39,6 @@ This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm #### Reference -SecurityHelper Class -Pbkdf2 Overload -CapyKit.Helpers Namespace +SecurityHelper Class +Pbkdf2 Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md index bf5976e..66eaab4 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md +++ b/Documentation/Help/M_CapyKit_Helpers_SecurityHelper__ctor.md @@ -1,12 +1,12 @@ # SecurityHelper Constructor -Initializes a new instance of the SecurityHelper class +Initializes a new instance of the SecurityHelper class ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,5 +24,5 @@ new : unit -> SecurityHelper #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md index 42059e2..c468854 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1.md @@ -6,7 +6,7 @@ Deserializes an object to a given *T* type. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -45,6 +45,6 @@ A *T* object. #### Reference -SerializationHelper Class -Deserialize Overload -CapyKit.Helpers Namespace +SerializationHelper Class +Deserialize Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md index a712fb8..acaccb7 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1.md @@ -6,7 +6,7 @@ Deserializes an object to a given *T* type. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -45,6 +45,6 @@ A *T* object. #### Reference -SerializationHelper Class -Deserialize Overload -CapyKit.Helpers Namespace +SerializationHelper Class +Deserialize Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md index 3b98ade..f731d7f 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2.md @@ -6,7 +6,7 @@ Deserializes a `JSON` encoded string to the given *T*. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -38,6 +38,6 @@ A *T* object. #### Reference -SerializationHelper Class -Deserialize Overload -CapyKit.Helpers Namespace +SerializationHelper Class +Deserialize Overload +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md index 7895081..b7636b4 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToBytes.md @@ -6,7 +6,7 @@ Serializes an object to a byte array. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ A `JSON` encoded string. #### Reference -SerializationHelper Class -CapyKit.Helpers Namespace +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md index 6d607c7..b31576d 100644 --- a/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md +++ b/Documentation/Help/M_CapyKit_Helpers_SerializationHelper_SerializeToString.md @@ -6,7 +6,7 @@ Serializes an object to a `JSON` encoded string. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -34,5 +34,5 @@ A `JSON` encoded string. #### Reference -SerializationHelper Class -CapyKit.Helpers Namespace +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md index c057997..96b694b 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Compare.md @@ -6,7 +6,7 @@ Compares the given plaintext password with an encrypted value using PBKDF2 algor ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -42,5 +42,5 @@ True if the given *password* matches the *encryptedValue*, false if they are dif #### Reference -IPasswordAlgorithm Interface -CapyKit Namespace +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md index 7d76d11..b4a4569 100644 --- a/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_IPasswordAlgorithm_Encrypt.md @@ -6,7 +6,7 @@ Encrypts the given password using a defined algorithm. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -36,5 +36,5 @@ A byte array with the hashed *password*. #### Reference -IPasswordAlgorithm Interface -CapyKit Namespace +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Password_ToString.md b/Documentation/Help/M_CapyKit_Password_ToString.md index 83d72b7..78c0bee 100644 --- a/Documentation/Help/M_CapyKit_Password_ToString.md +++ b/Documentation/Help/M_CapyKit_Password_ToString.md @@ -6,7 +6,7 @@ Returns a string that represents the current object. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,5 +29,5 @@ A string that represents the current object. #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Password__cctor.md b/Documentation/Help/M_CapyKit_Password__cctor.md new file mode 100644 index 0000000..4d8cb79 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Password__cctor.md @@ -0,0 +1,28 @@ +# Password Constructor + + +Initializes the static fields of the Password class + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +static Password() +``` +**F#** +``` F# +new : unit -> Password +``` + + + +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Password__ctor.md b/Documentation/Help/M_CapyKit_Password__ctor.md new file mode 100644 index 0000000..09dbaab --- /dev/null +++ b/Documentation/Help/M_CapyKit_Password__ctor.md @@ -0,0 +1,40 @@ +# Password Constructor + + +Constructor. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal Password( + string password, + byte[] salt, + IPasswordAlgorithm algorithm, + params Object[] args +) +``` +**F#** +``` F# +new : + password : string * + salt : byte[] * + algorithm : IPasswordAlgorithm * + args : Object[] -> Password +``` + + + +#### Parameters +
  String
The password to be hashed.
  Byte[]
The salt used for encryption.
  IPasswordAlgorithm
The algorithm used for password encryption.
  Object[]
A variable-length parameters list containing arguments to include for the algorithm.
+ +## See Also + + +#### Reference +Password Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md index d6b2451..b3d0fed 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm_Encrypt.md @@ -6,7 +6,7 @@ Encrypts the given password using a PBKDF2 algorithm. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -38,12 +38,12 @@ override Encrypt : A byte array with the hashed *password*. #### Implements -IPasswordAlgorithm.Encrypt(String, Object[]) +IPasswordAlgorithm.Encrypt(String, Object[]) ## See Also #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md index a577a5a..f3831de 100644 --- a/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md +++ b/Documentation/Help/M_CapyKit_Pbkdf2Algorithm__ctor.md @@ -1,12 +1,12 @@ # Pbkdf2Algorithm Constructor -Initializes a new instance of the Pbkdf2Algorithm class +Initializes a new instance of the Pbkdf2Algorithm class ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,5 +24,5 @@ new : unit -> Pbkdf2Algorithm #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md index a7739bb..931e8d8 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ReleaseLock.md @@ -6,7 +6,7 @@ Releases the lock on the item. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -27,5 +27,5 @@ If the item is not locked, an error event is emitted. #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md index b7d3ca9..7541064 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_SetLock.md @@ -6,7 +6,7 @@ Sets the lock on the item indicating that it is in use. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -31,5 +31,5 @@ If the item is already locked, an error event is emitted. #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md index cbe5251..2fb94e0 100644 --- a/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md +++ b/Documentation/Help/M_CapyKit_PoolItem_1_ToString.md @@ -6,7 +6,7 @@ Returns a string that represents the current object and its lock state. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,5 +29,5 @@ A string that represents the current object and its lock state. #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md b/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md new file mode 100644 index 0000000..6e5080d --- /dev/null +++ b/Documentation/Help/M_CapyKit_PoolItem_1__ctor.md @@ -0,0 +1,36 @@ +# PoolItem<T> Constructor + + +Initializes a new instance of the PoolItem(T) class with the specified item and index. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +internal PoolItem( + T item, + int index +) +``` +**F#** +``` F# +new : + item : 'T * + index : int -> PoolItem +``` + + + +#### Parameters +
  T
The pooled item.
  Int32
The zero-based index of the pooled item.
+ +## See Also + + +#### Reference +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md new file mode 100644 index 0000000..ba06670 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection.md @@ -0,0 +1,35 @@ +# FillPoolItemCollection(IEnumerable<T>) Method + + +Fill the pool item collection from an existing *T* collection. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private void FillPoolItemCollection( + IEnumerable collection +) +``` +**F#** +``` F# +private member FillPoolItemCollection : + collection : IEnumerable<'T> -> unit +``` + + + +#### Parameters +
  IEnumerable(T)
The T collection.
+ +## See Also + + +#### Reference +Pool(T) Class +FillPoolItemCollection Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md new file mode 100644 index 0000000..2acb8e4 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_1.md @@ -0,0 +1,35 @@ +# FillPoolItemCollection(Int32) Method + + +Initializes the pool with the specified number of items using the default constructor. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private void FillPoolItemCollection( + int poolSize +) +``` +**F#** +``` F# +private member FillPoolItemCollection : + poolSize : int -> unit +``` + + + +#### Parameters +
  Int32
The size of the pool.
+ +## See Also + + +#### Reference +Pool(T) Class +FillPoolItemCollection Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md new file mode 100644 index 0000000..96befb7 --- /dev/null +++ b/Documentation/Help/M_CapyKit_Pool_1_FillPoolItemCollection_2.md @@ -0,0 +1,37 @@ +# FillPoolItemCollection(Int32, Func<T>) Method + + +Initializes the pool with the specified number of items using the specified constructor selector. + + + +## Definition +**Namespace:** CapyKit +**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d + +**C#** +``` C# +private void FillPoolItemCollection( + int poolSize, + Func constructorSelector +) +``` +**F#** +``` F# +private member FillPoolItemCollection : + poolSize : int * + constructorSelector : Func<'T> -> unit +``` + + + +#### Parameters +
  Int32
The size of the pool.
  Func(T)
The constructor selector.
+ +## See Also + + +#### Reference +Pool(T) Class +FillPoolItemCollection Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md index 21c8486..971b794 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_GetAvailableItem.md @@ -6,7 +6,7 @@ Gets the first available item from the pool and sets its lock. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -21,12 +21,12 @@ member GetAvailableItem : unit -> PoolItem<'T> #### Return Value -PoolItem(T) +PoolItem(T) The first available item from the pool. ## See Also #### Reference -Pool(T) Class -CapyKit Namespace +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md index 5fd7d39..74460d4 100644 --- a/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md +++ b/Documentation/Help/M_CapyKit_Pool_1_ReleaseItem.md @@ -6,7 +6,7 @@ Releases the lock on the specified item and returns it to the pool. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,14 +24,14 @@ member ReleaseItem : #### Parameters -
  PoolItem(T)
The item to release.
+
  PoolItem(T)
The item to release.
## Remarks -This method sets the Locked flag to false so that it can be retrieved by GetAvailableItem(). +This method sets the Locked flag to false so that it can be retrieved by GetAvailableItem(). ## See Also #### Reference -Pool(T) Class -CapyKit Namespace +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor.md b/Documentation/Help/M_CapyKit_Pool_1__ctor.md index 4fa6cdd..187d8bc 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor.md @@ -1,12 +1,12 @@ # Pool<T>(IEnumerable<T>) Constructor -Initializes a new instance of the Pool(T) class with the specified collection of items. +Initializes a new instance of the Pool(T) class with the specified collection of items. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,12 +24,12 @@ new : #### Parameters -
  IEnumerable(T)
The collection of T items with which to seed the pool.
+
  IEnumerable(T)
The collection of T items with which to seed the pool.
## See Also #### Reference -Pool(T) Class -Pool(T) Overload -CapyKit Namespace +Pool(T) Class +Pool(T) Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md index 3dcb795..6cd64ed 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_1.md @@ -1,12 +1,12 @@ # Pool<T>(Int32) Constructor -Initializes a new instance of the Pool(T) class with the specified pool size. +Initializes a new instance of the Pool(T) class with the specified pool size. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -30,6 +30,6 @@ new : #### Reference -Pool(T) Class -Pool(T) Overload -CapyKit Namespace +Pool(T) Class +Pool(T) Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md index f46696e..6f3ea87 100644 --- a/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md +++ b/Documentation/Help/M_CapyKit_Pool_1__ctor_2.md @@ -1,12 +1,12 @@ # Pool<T>(Int32, Func<T>) Constructor -Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector. +Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,12 +26,12 @@ new : #### Parameters -
  Int32
The size of the pool.
  Func(T)
The constructor selector used to create new instances of T.
+
  Int32
The size of the pool.
  Func(T)
The constructor selector used to create new instances of T.
## See Also #### Reference -Pool(T) Class -Pool(T) Overload -CapyKit Namespace +Pool(T) Class +Pool(T) Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md index dbb2861..2e51537 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_Equals.md @@ -6,7 +6,7 @@ Determines whether the specified properties are equal. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,7 +29,7 @@ override Equals : #### Parameters -
  T
The first object of type T to compare.
  T
The second object of type T to compare.
+
  T
The first object of type T to compare.
  T
The second object of type T to compare.
#### Return Value Boolean @@ -43,6 +43,6 @@ true if the specified objects are equal; otherwise, false. #### Reference -PropertyComparer(T, U) Class -Equals Overload -CapyKit Namespace +PropertyComparer(T, U) Class +Equals Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md index 4004177..d12c16d 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2_GetHashCode.md @@ -6,7 +6,7 @@ Returns a hash code for the specified object. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,7 +26,7 @@ override GetHashCode : #### Parameters -
  T
The Object for which a hash code is to be returned.
+
  T
The Object for which a hash code is to be returned.
#### Return Value Int32 @@ -47,6 +47,6 @@ A hash code for the specified object. #### Reference -PropertyComparer(T, U) Class -GetHashCode Overload -CapyKit Namespace +PropertyComparer(T, U) Class +GetHashCode Overload +CapyKit Namespace diff --git a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md index 4c16315..60e19b7 100644 --- a/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md +++ b/Documentation/Help/M_CapyKit_PropertyComparer_2__ctor.md @@ -6,7 +6,7 @@ Constructor. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -24,11 +24,11 @@ new : #### Parameters -
  Func(T, U)
The expression.
+
  Func(T, U)
The expression.
## See Also #### Reference -PropertyComparer(T, U) Class -CapyKit Namespace +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md index d3ad16f..ac16050 100644 --- a/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md +++ b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -35,5 +35,5 @@ #### Reference -EnumerationAttribute(T) Class -CapyKit.Attributes Namespace +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md index f5f092d..c5cc0df 100644 --- a/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md +++ b/Documentation/Help/Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -35,5 +35,5 @@ #### Reference -EnumerationDescriptionAttribute Class -CapyKit.Attributes Namespace +EnumerationDescriptionAttribute Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md b/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md index 89b359e..ddd30dc 100644 --- a/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md +++ b/Documentation/Help/Methods_T_CapyKit_CapyEventArgs.md @@ -29,5 +29,5 @@ #### Reference -CapyEventArgs Class -CapyKit Namespace +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md b/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md index 217ff53..016b212 100644 --- a/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md +++ b/Documentation/Help/Methods_T_CapyKit_CapyEventReporter.md @@ -6,10 +6,16 @@ ## Methods - + + + + + + + - +
SubscribeEmitEventEmits an event with the given severity level, message, and method name.
EmitEventOnceEmits an event with the given severity level, message, unique identifier, and method name one time.
Subscribe Subscribes the specified event handler to the event with the given subscription level and origin.
UnsubscribeUnsubscribe Unsubscribes the specified event handler from the event with the given origin.
@@ -17,5 +23,5 @@ #### Reference -CapyEventReporter Class -CapyKit Namespace +CapyEventReporter Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md index 19be628..e524f4a 100644 --- a/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md +++ b/Documentation/Help/Methods_T_CapyKit_Extensions_EnumerationExtensions.md @@ -6,22 +6,22 @@ ## Methods - + - + - + - + - + - +
GetDescriptionGetDescription An Enum extension method that gets a description.
GetNameGetName An Enum extension method that gets a name.
GetPrettyNameGetPrettyName An Enum extension method that gets a human readable name.
GetValueGetValue An Enum extension method that gets an integer value representing the enumation.
Parse(T)(T, String)Parse(T)(T, String) A T extension method that parses a string into an enumeration.
Parse(T)(T, String, Boolean)Parse(T)(T, String, Boolean) A T extension method that parses a string into an enumeration.
@@ -29,5 +29,5 @@ #### Reference -EnumerationExtensions Class -CapyKit.Extensions Namespace +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md index ee0ce7d..3f33349 100644 --- a/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md +++ b/Documentation/Help/Methods_T_CapyKit_Extensions_LINQExtensions.md @@ -6,31 +6,34 @@ ## Methods - + - + - + - - - - + - + + + + + + + - + - + - +
Distinct(T, U)Distinct(T, U) Enumerates distinct items in this collection as defined by the key property.
Filter(T)(IEnumerable(T), Func(T, Boolean))Filter(T)(IEnumerable(T), Func(T, Boolean)) Filters out items matching a predicate from the collection.
Filter(T)(IQueryable(T), Expression(Func(T, Boolean)))Filter(T)(IQueryable(T), Expression(Func(T, Boolean))) Filters out items matching a predicate from the collection.
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Expression(Func(T, IEnumerable(U), R))) An IQueryable<T> extension method that left outer join.
Page(T)(IEnumerable(T), Int32, Int32)LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))An IQueryable<T> extension method that left outer join.
Page(T)(IEnumerable(T), Int32, Int32) Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
Page(T)(IQueryable(T), Int32, Int32)Page(T)(IQueryable(T), Int32, Int32) Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
PageCount(T)(IEnumerable(T), Int32)PageCount(T)(IEnumerable(T), Int32) The number of pages of pageSize size in the given collection.
PageCount(T)(IQueryable(T), Int32)PageCount(T)(IQueryable(T), Int32) The number of pages of pageSize size in the given collection.
@@ -38,5 +41,5 @@ #### Reference -LINQExtensions Class -CapyKit.Extensions Namespace +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md index cec75b0..98bc8da 100644 --- a/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md +++ b/Documentation/Help/Methods_T_CapyKit_Extensions_StringExtensions.md @@ -6,10 +6,10 @@ ## Methods - + - +
IfNullOrEmptyIfNullOrEmpty Replaces a null or empty string with a specified replacement string.
IfNullOrWhiteSpaceIfNullOrWhiteSpace Replaces a null or whitespace string with a specified replacement string.
@@ -17,5 +17,5 @@ #### Reference -StringExtensions Class -CapyKit.Extensions Namespace +StringExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md index 3f16a3a..37ec012 100644 --- a/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_CompressionHelper.md @@ -6,19 +6,19 @@ ## Methods - + - + - + - + - +
CompressCompress Compresses a given object using the gzip algorithm.
CompressToStringCompressToString Compresses a given object to a string using base64 encoding of gzip format.
Decompress(T)(Byte[])Decompress(T)(Byte[]) Decompresses a given compressed gzip byte stream.
Decompress(T)(String)Decompress(T)(String) Decompresses a given base64 encoded string of gzip format.
DecompressToStringDecompressToString Decompresses the given base64 string in gzip format.
@@ -26,5 +26,5 @@ #### Reference -CompressionHelper Class -CapyKit.Helpers Namespace +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md index ff9a2b6..76223c9 100644 --- a/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_LanguageHelper.md @@ -6,7 +6,7 @@ ## Methods - + @@ -32,5 +32,5 @@ #### Reference -LanguageHelper Class -CapyKit.Helpers Namespace +LanguageHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md index febe6c3..c59bcc4 100644 --- a/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SecurityHelper.md @@ -6,12 +6,15 @@ ## Methods
CamelCaseToHumanReadableCamelCaseToHumanReadable Converts camel case text to human readable text.
Equals
- + - + + + + @@ -21,29 +24,35 @@ - + + + + - + - + - + + + + - - + + - - + + @@ -53,5 +62,5 @@ #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md index 7f6e4be..b603ba0 100644 --- a/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md +++ b/Documentation/Help/Methods_T_CapyKit_Helpers_SerializationHelper.md @@ -6,19 +6,19 @@ ## Methods
CompareHashedPasswordCompareHashedPassword Compares an unencrypted providedPassword with a stored, encrypted existingPassword.
CompareSessionIDCompareSessionID Compares two session identifiers.
CompareStringsCompare two strings as case sensative.
Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetRandomPasswordGetRandomBytesGenerates a new byte array of the specified length with random values.
GetRandomPassword Gets a cryptographically strong random password.
GetRandomString(Int32)GetRandomString(Int32) A convenience method to generate a random string of the specified length using all character sets.
GetRandomString(Int32, ValidCharacterCollection[])GetRandomString(Int32, ValidCharacterCollection[]) Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].
GetType Gets the Type of the current instance.
(Inherited from Object)
HashPasswordGetValidCharacterComposition 
HashPassword Hashes an unencrypted password.
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
ToString Returns a string that represents the current object.
(Inherited from Object)
- + - + - + - + - +
Deserialize(T)(Byte[])Deserialize(T)(Byte[]) Deserializes an object to a given T type.
Deserialize(T)(Stream)Deserialize(T)(Stream) Deserializes an object to a given T type.
Deserialize(T)(String)Deserialize(T)(String) Deserializes a JSON encoded string to the given T.
SerializeToBytesSerializeToBytes Serializes an object to a byte array.
SerializeToStringSerializeToString Serializes an object to a JSON encoded string.
@@ -26,5 +26,5 @@ #### Reference -SerializationHelper Class -CapyKit.Helpers Namespace +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md index 54d4a53..01afcdd 100644 --- a/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md +++ b/Documentation/Help/Methods_T_CapyKit_IPasswordAlgorithm.md @@ -6,10 +6,10 @@ ## Methods - + - +
CompareCompare Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.
EncryptEncrypt Encrypts the given password using a defined algorithm.
@@ -17,5 +17,5 @@ #### Reference -IPasswordAlgorithm Interface -CapyKit Namespace +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Password.md b/Documentation/Help/Methods_T_CapyKit_Password.md index 03fd1c7..d3a4e91 100644 --- a/Documentation/Help/Methods_T_CapyKit_Password.md +++ b/Documentation/Help/Methods_T_CapyKit_Password.md @@ -21,7 +21,7 @@ MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -ToString +ToString Returns a string that represents the current object.
(Overrides Object.ToString()) @@ -29,5 +29,5 @@ #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md index 00bc45b..df2ad57 100644 --- a/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/Methods_T_CapyKit_Pbkdf2Algorithm.md @@ -6,7 +6,7 @@ ## Methods - + @@ -32,5 +32,5 @@ #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md b/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md index ca9202f..48d5b59 100644 --- a/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md +++ b/Documentation/Help/Methods_T_CapyKit_PoolItem_1.md @@ -9,19 +9,25 @@ + + + - + + + + - + - +
EncryptEncrypt Encrypts the given password using a PBKDF2 algorithm.
EqualsEquals Determines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the Type of the current instance.
(Inherited from Object)
ReleaseLockMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReleaseLock Releases the lock on the item.
SetLockSetLock Sets the lock on the item indicating that it is in use.
ToStringToString Returns a string that represents the current object and its lock state.
(Overrides Object.ToString())
@@ -29,5 +35,5 @@ #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_Pool_1.md b/Documentation/Help/Methods_T_CapyKit_Pool_1.md index af16138..e772820 100644 --- a/Documentation/Help/Methods_T_CapyKit_Pool_1.md +++ b/Documentation/Help/Methods_T_CapyKit_Pool_1.md @@ -9,10 +9,19 @@ Equals Determines whether the specified object is equal to the current object.
(Inherited from Object) +FillPoolItemCollection(IEnumerable(T)) +Fill the pool item collection from an existing T collection. + +FillPoolItemCollection(Int32) +Initializes the pool with the specified number of items using the default constructor. + +FillPoolItemCollection(Int32, Func(T)) +Initializes the pool with the specified number of items using the specified constructor selector. + Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) -GetAvailableItem +GetAvailableItem Gets the first available item from the pool and sets its lock. GetHashCode @@ -24,7 +33,7 @@ MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -ReleaseItem +ReleaseItem Releases the lock on the specified item and returns it to the pool. ToString @@ -35,5 +44,5 @@ #### Reference -Pool(T) Class -CapyKit Namespace +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md b/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md index c37b1f1..182b8ba 100644 --- a/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md +++ b/Documentation/Help/Methods_T_CapyKit_PropertyComparer_2.md @@ -9,7 +9,7 @@ Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object) -Equals(T, T) +Equals(T, T) Determines whether the specified properties are equal. Finalize @@ -18,7 +18,7 @@ GetHashCode() Serves as the default hash function.
(Inherited from Object) -GetHashCode(T) +GetHashCode(T) Returns a hash code for the specified object. GetType @@ -35,5 +35,5 @@ #### Reference -PropertyComparer(T, U) Class -CapyKit Namespace +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/N_CapyKit.md b/Documentation/Help/N_CapyKit.md index c131ec7..c54c08e 100644 --- a/Documentation/Help/N_CapyKit.md +++ b/Documentation/Help/N_CapyKit.md @@ -8,48 +8,48 @@ ## Classes - + - + - + - + - + - + - +
CapyEventArgsCapyEventArgs The CapyEventArgs class represents an event argument instance with event level, message, and method name information.
CapyEventReporterCapyEventReporter The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
PasswordPassword Represents a password with its hash, salt and algorithm used for encryption.
Pbkdf2AlgorithmPbkdf2Algorithm Implements the PBKDF2 algorithm for password encryption.
Pool(T)Pool(T) A managed pool of resources. This class provides a thread-safe way to manage a collection of objects of type T.
PoolItem(T)PoolItem(T) A pool item. This class cannot be inherited.
PropertyComparer(T, U)PropertyComparer(T, U) A object comparer that can accept a lambda expression to compare properties.
## Interfaces - +
IPasswordAlgorithmIPasswordAlgorithm Defines the contract for password encryption algorithms.
## Delegates - - + +
CapyEventHandlerA delegate representing an event handler that accepts a CapyEventArgs instance.
CapyEventHandlerA delegate representing an event handler that accepts a CapyEventArgs instance.
## Enumerations - + - +
ColorColor Enum representing a set of named colors with their corresponding HEX values. These colors are inspired by the XKCD color palette (Link).
EventLevelEventLevel Enumeration representing different event level severity values.
\ No newline at end of file diff --git a/Documentation/Help/N_CapyKit_Attributes.md b/Documentation/Help/N_CapyKit_Attributes.md index 076cf8c..5688f5f 100644 --- a/Documentation/Help/N_CapyKit_Attributes.md +++ b/Documentation/Help/N_CapyKit_Attributes.md @@ -8,9 +8,9 @@ ## Classes - + - +
EnumerationAttribute(T)EnumerationAttribute(T) Custom attribute class for decorating enumeration fields with additional data.
EnumerationDescriptionAttributeEnumerationDescriptionAttribute An attribute class for decorating enumeration fields with a description.
\ No newline at end of file diff --git a/Documentation/Help/N_CapyKit_Extensions.md b/Documentation/Help/N_CapyKit_Extensions.md index e133279..d90033f 100644 --- a/Documentation/Help/N_CapyKit_Extensions.md +++ b/Documentation/Help/N_CapyKit_Extensions.md @@ -8,12 +8,12 @@ ## Classes - + - + - +
EnumerationExtensionsEnumerationExtensions Provides static extentions methods for providing additional functionality for Enum types.
LINQExtensionsLINQExtensions Provides static extension methods for performing common LINQ operations on IEnumerable(T) and IQueryable(T) collections.
StringExtensionsStringExtensions Provides static extentions methods for providing additional functionality for String types.
\ No newline at end of file diff --git a/Documentation/Help/N_CapyKit_Helpers.md b/Documentation/Help/N_CapyKit_Helpers.md index f4802a7..cb5018c 100644 --- a/Documentation/Help/N_CapyKit_Helpers.md +++ b/Documentation/Help/N_CapyKit_Helpers.md @@ -8,22 +8,22 @@ ## Classes - + - + - + - +
CompressionHelperCompressionHelper A class that contains methods for managing data compression.
LanguageHelperLanguageHelper  
SecurityHelperSecurityHelper A class that contains methods for managing secure data processing and cryptography.
SerializationHelperSerializationHelper  
## Enumerations - +
ValidCharacterCollectionValidCharacterCollection An enumeration that defines the types of characters that can be included in a random string.
\ No newline at end of file diff --git a/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md b/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md index 3beed74..359e8f4 100644 --- a/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md +++ b/Documentation/Help/Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md @@ -4,10 +4,10 @@ ## Overload List - + - +
Parse(T)(T, String)Parse(T)(T, String) A T extension method that parses a string into an enumeration.
Parse(T)(T, String, Boolean)Parse(T)(T, String, Boolean) A T extension method that parses a string into an enumeration.
@@ -15,5 +15,5 @@ #### Reference -EnumerationExtensions Class -CapyKit.Extensions Namespace +EnumerationExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md index 5bad20b..a96b744 100644 --- a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Filter.md @@ -4,10 +4,10 @@ ## Overload List - + - +
Filter(T)(IEnumerable(T), Func(T, Boolean))Filter(T)(IEnumerable(T), Func(T, Boolean)) Filters out items matching a predicate from the collection.
Filter(T)(IQueryable(T), Expression(Func(T, Boolean)))Filter(T)(IQueryable(T), Expression(Func(T, Boolean))) Filters out items matching a predicate from the collection.
@@ -15,5 +15,5 @@ #### Reference -LINQExtensions Class -CapyKit.Extensions Namespace +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md index e09ebe6..61b0dfa 100644 --- a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md @@ -4,10 +4,13 @@ ## Overload List - + + + + - +
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Expression(Func(T, IEnumerable(U), R)))An IQueryable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U)) An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U)) An IQueryable<T> extension method that left outer join.
@@ -15,5 +18,5 @@ #### Reference -LINQExtensions Class -CapyKit.Extensions Namespace +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md index cf7bb26..5d73293 100644 --- a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_Page.md @@ -4,10 +4,10 @@ ## Overload List - + - +
Page(T)(IEnumerable(T), Int32, Int32)Page(T)(IEnumerable(T), Int32, Int32) Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
Page(T)(IQueryable(T), Int32, Int32)Page(T)(IQueryable(T), Int32, Int32) Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
@@ -15,5 +15,5 @@ #### Reference -LINQExtensions Class -CapyKit.Extensions Namespace +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md index 985598e..b66c5b7 100644 --- a/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md +++ b/Documentation/Help/Overload_CapyKit_Extensions_LINQExtensions_PageCount.md @@ -4,10 +4,10 @@ ## Overload List - + - +
PageCount(T)(IEnumerable(T), Int32)PageCount(T)(IEnumerable(T), Int32) The number of pages of pageSize size in the given collection.
PageCount(T)(IQueryable(T), Int32)PageCount(T)(IQueryable(T), Int32) The number of pages of pageSize size in the given collection.
@@ -15,5 +15,5 @@ #### Reference -LINQExtensions Class -CapyKit.Extensions Namespace +LINQExtensions Class +CapyKit.Extensions Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md b/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md index 7e2c1fb..4c5e5cf 100644 --- a/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md +++ b/Documentation/Help/Overload_CapyKit_Helpers_CompressionHelper_Decompress.md @@ -4,10 +4,10 @@ ## Overload List - + - +
Decompress(T)(Byte[])Decompress(T)(Byte[]) Decompresses a given compressed gzip byte stream.
Decompress(T)(String)Decompress(T)(String) Decompresses a given base64 encoded string of gzip format.
@@ -15,5 +15,5 @@ #### Reference -CompressionHelper Class -CapyKit.Helpers Namespace +CompressionHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md index 204a3e8..25902bf 100644 --- a/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md +++ b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_GetRandomString.md @@ -4,10 +4,10 @@ ## Overload List - + - +
GetRandomString(Int32)GetRandomString(Int32) A convenience method to generate a random string of the specified length using all character sets.
GetRandomString(Int32, ValidCharacterCollection[])GetRandomString(Int32, ValidCharacterCollection[]) Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].
@@ -15,5 +15,5 @@ #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md index 817d7d6..3419d4b 100644 --- a/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md +++ b/Documentation/Help/Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2.md @@ -4,16 +4,16 @@ ## Overload List - - + + - - + +
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
## See Also #### Reference -SecurityHelper Class -CapyKit.Helpers Namespace +SecurityHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md b/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md index 1e11115..5c1fa59 100644 --- a/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md +++ b/Documentation/Help/Overload_CapyKit_Helpers_SerializationHelper_Deserialize.md @@ -4,13 +4,13 @@ ## Overload List - + - + - +
Deserialize(T)(Byte[])Deserialize(T)(Byte[]) Deserializes an object to a given T type.
Deserialize(T)(Stream)Deserialize(T)(Stream) Deserializes an object to a given T type.
Deserialize(T)(String)Deserialize(T)(String) Deserializes a JSON encoded string to the given T.
@@ -18,5 +18,5 @@ #### Reference -SerializationHelper Class -CapyKit.Helpers Namespace +SerializationHelper Class +CapyKit.Helpers Namespace diff --git a/Documentation/Help/Overload_CapyKit_Pool_1_FillPoolItemCollection.md b/Documentation/Help/Overload_CapyKit_Pool_1_FillPoolItemCollection.md new file mode 100644 index 0000000..301fa67 --- /dev/null +++ b/Documentation/Help/Overload_CapyKit_Pool_1_FillPoolItemCollection.md @@ -0,0 +1,22 @@ +# FillPoolItemCollection Method + + +## Overload List + + + + + + + + + + +
FillPoolItemCollection(IEnumerable(T))Fill the pool item collection from an existing T collection.
FillPoolItemCollection(Int32)Initializes the pool with the specified number of items using the default constructor.
FillPoolItemCollection(Int32, Func(T))Initializes the pool with the specified number of items using the specified constructor selector.
+ +## See Also + + +#### Reference +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md b/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md index 162346d..7fa45bc 100644 --- a/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md +++ b/Documentation/Help/Overload_CapyKit_Pool_1__ctor.md @@ -4,19 +4,19 @@ ## Overload List - - + + - - + + - - + +
Pool(T)(IEnumerable(T))Initializes a new instance of the Pool(T) class with the specified collection of items.
Pool(T)(IEnumerable(T))Initializes a new instance of the Pool(T) class with the specified collection of items.
Pool(T)(Int32)Initializes a new instance of the Pool(T) class with the specified pool size.
Pool(T)(Int32)Initializes a new instance of the Pool(T) class with the specified pool size.
Pool(T)(Int32, Func(T))Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector.
Pool(T)(Int32, Func(T))Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector.
## See Also #### Reference -Pool(T) Class -CapyKit Namespace +Pool(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md index 48e972f..fa465b5 100644 --- a/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md +++ b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_Equals.md @@ -7,7 +7,7 @@ Equals(Object) Determines whether the specified object is equal to the current object. -Equals(T, T) +Equals(T, T) Determines whether the specified properties are equal. @@ -15,5 +15,5 @@ #### Reference -PropertyComparer(T, U) Class -CapyKit Namespace +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md index 5142338..3e2cd6a 100644 --- a/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md +++ b/Documentation/Help/Overload_CapyKit_PropertyComparer_2_GetHashCode.md @@ -7,7 +7,7 @@ GetHashCode() Serves as the default hash function. -GetHashCode(T) +GetHashCode(T) Returns a hash code for the specified object. @@ -15,5 +15,5 @@ #### Reference -PropertyComparer(T, U) Class -CapyKit Namespace +PropertyComparer(T, U) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md index 451d1d2..208681e 100644 --- a/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md +++ b/Documentation/Help/P_CapyKit_Attributes_EnumerationAttribute_1_Value.md @@ -1,32 +1,32 @@ # Value Property -Initializes a new instance of the EnumerationAttribute(T) class with a specified value. +Initializes a new instance of the EnumerationAttribute(T) class with a specified value. ## Definition -**Namespace:** CapyKit.Attributes +**Namespace:** CapyKit.Attributes **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public T Value { get; } +public T Value { get; private set; } ``` **F#** ``` F# -member Value : 'T with get +member Value : 'T with get, private set ``` #### Property Value -T +T The value. ## See Also #### Reference -EnumerationAttribute(T) Class -CapyKit.Attributes Namespace +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md index 0811085..2066512 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Level.md @@ -6,26 +6,26 @@ Gets the severity level of the event. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public EventLevel Level { get; } +public EventLevel Level { get; private set; } ``` **F#** ``` F# -member Level : EventLevel with get +member Level : EventLevel with get, private set ``` #### Property Value -EventLevel +EventLevel ## See Also #### Reference -CapyEventArgs Class -CapyKit Namespace +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md index 20d7336..8b500da 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_Message.md @@ -6,16 +6,16 @@ Gets the message describing the reason for the event. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public string Message { get; } +public string Message { get; private set; } ``` **F#** ``` F# -member Message : string with get +member Message : string with get, private set ``` @@ -27,5 +27,5 @@ member Message : string with get #### Reference -CapyEventArgs Class -CapyKit Namespace +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md index 44fff9d..5fbdfd1 100644 --- a/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md +++ b/Documentation/Help/P_CapyKit_CapyEventArgs_MethodName.md @@ -6,16 +6,16 @@ Gets the name of the method where the event was raised. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public string MethodName { get; } +public string MethodName { get; private set; } ``` **F#** ``` F# -member MethodName : string with get +member MethodName : string with get, private set ``` @@ -27,5 +27,5 @@ member MethodName : string with get #### Reference -CapyEventArgs Class -CapyKit Namespace +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md index 8ebee49..38472d1 100644 --- a/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_IPasswordAlgorithm_AlgorithmName.md @@ -6,7 +6,7 @@ Gets the name of the algorithm. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -27,5 +27,5 @@ abstract AlgorithmName : string with get #### Reference -IPasswordAlgorithm Interface -CapyKit Namespace +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Algorithm.md b/Documentation/Help/P_CapyKit_Password_Algorithm.md index 559711e..b28c2db 100644 --- a/Documentation/Help/P_CapyKit_Password_Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Algorithm.md @@ -6,26 +6,26 @@ Gets or sets the algorithm used for password encryption. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public IPasswordAlgorithm Algorithm { get; } +public IPasswordAlgorithm Algorithm { get; private set; } ``` **F#** ``` F# -member Algorithm : IPasswordAlgorithm with get +member Algorithm : IPasswordAlgorithm with get, private set ``` #### Property Value -IPasswordAlgorithm +IPasswordAlgorithm ## See Also #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Hash.md b/Documentation/Help/P_CapyKit_Password_Hash.md index 67d83dc..7d82a6a 100644 --- a/Documentation/Help/P_CapyKit_Password_Hash.md +++ b/Documentation/Help/P_CapyKit_Password_Hash.md @@ -6,16 +6,16 @@ Gets or sets the hash of the password. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public byte[] Hash { get; } +public byte[] Hash { get; private set; } ``` **F#** ``` F# -member Hash : byte[] with get +member Hash : byte[] with get, private set ``` @@ -27,5 +27,5 @@ member Hash : byte[] with get #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md index ca9a7de..470b7cc 100644 --- a/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md +++ b/Documentation/Help/P_CapyKit_Password_Pbkdf2Algorithm.md @@ -6,7 +6,7 @@ ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -21,11 +21,11 @@ static member Pbkdf2Algorithm : Pbkdf2Algorithm with get #### Property Value -Pbkdf2Algorithm +Pbkdf2Algorithm ## See Also #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Password_Salt.md b/Documentation/Help/P_CapyKit_Password_Salt.md index c6db9c0..d26a42e 100644 --- a/Documentation/Help/P_CapyKit_Password_Salt.md +++ b/Documentation/Help/P_CapyKit_Password_Salt.md @@ -6,16 +6,16 @@ Gets or sets the salt used for encryption. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# -public byte[] Salt { get; } +public byte[] Salt { get; private set; } ``` **F#** ``` F# -member Salt : byte[] with get +member Salt : byte[] with get, private set ``` @@ -27,5 +27,5 @@ member Salt : byte[] with get #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md index 30b04bc..e84ddc5 100644 --- a/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md +++ b/Documentation/Help/P_CapyKit_Pbkdf2Algorithm_AlgorithmName.md @@ -6,7 +6,7 @@ Gets the name of the algorithm. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -25,12 +25,12 @@ override AlgorithmName : string with get String #### Implements -IPasswordAlgorithm.AlgorithmName +IPasswordAlgorithm.AlgorithmName ## See Also #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md index 1dff0e4..10e78b7 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Index.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Index.md @@ -6,7 +6,7 @@ Gets the zero-based index of the pooled item. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,5 +28,5 @@ The index. #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md index 505a23c..596d1bb 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Item.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Item.md @@ -6,7 +6,7 @@ Gets the pooled resource. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -21,12 +21,12 @@ member Item : 'T with get #### Property Value -T +T The pooled resource. ## See Also #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md index 6517154..c57e84c 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_Locked.md @@ -6,7 +6,7 @@ Gets a value indicating whether this object is locked or not. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,5 +28,5 @@ A value indicating whether this object is locked or not. #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md index 999fba5..89443c5 100644 --- a/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md +++ b/Documentation/Help/P_CapyKit_PoolItem_1_TypeName.md @@ -6,7 +6,7 @@ Gets the name of the CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,5 +28,5 @@ The name of the PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md index 6a90caf..fb26aa4 100644 --- a/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md +++ b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -9,13 +9,13 @@ TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute) -Value -Initializes a new instance of the EnumerationAttribute(T) class with a specified value. +Value +Initializes a new instance of the EnumerationAttribute(T) class with a specified value. ## See Also #### Reference -EnumerationAttribute(T) Class -CapyKit.Attributes Namespace +EnumerationAttribute(T) Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md index 3f2c09c..dd1b9e0 100644 --- a/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md +++ b/Documentation/Help/Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -9,13 +9,13 @@ TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute) -Value -Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
(Inherited from EnumerationAttribute(T)) +Value +Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
(Inherited from EnumerationAttribute(T)) ## See Also #### Reference -EnumerationDescriptionAttribute Class -CapyKit.Attributes Namespace +EnumerationDescriptionAttribute Class +CapyKit.Attributes Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md b/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md index bcf4c8c..33a18b7 100644 --- a/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md +++ b/Documentation/Help/Properties_T_CapyKit_CapyEventArgs.md @@ -6,13 +6,13 @@ ## Properties - + - + - +
LevelLevel Gets the severity level of the event.
MessageMessage Gets the message describing the reason for the event.
MethodNameMethodName Gets the name of the method where the event was raised.
@@ -20,5 +20,5 @@ #### Reference -CapyEventArgs Class -CapyKit Namespace +CapyEventArgs Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md index 4f0a54d..bd3a77b 100644 --- a/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md +++ b/Documentation/Help/Properties_T_CapyKit_IPasswordAlgorithm.md @@ -6,7 +6,7 @@ ## Properties - +
AlgorithmNameAlgorithmName Gets the name of the algorithm.
@@ -14,5 +14,5 @@ #### Reference -IPasswordAlgorithm Interface -CapyKit Namespace +IPasswordAlgorithm Interface +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Password.md b/Documentation/Help/Properties_T_CapyKit_Password.md index 8029d51..7467b71 100644 --- a/Documentation/Help/Properties_T_CapyKit_Password.md +++ b/Documentation/Help/Properties_T_CapyKit_Password.md @@ -6,16 +6,16 @@ ## Properties - + - + - + - +
AlgorithmAlgorithm Gets or sets the algorithm used for password encryption.
HashHash Gets or sets the hash of the password.
Pbkdf2AlgorithmPbkdf2Algorithm  
SaltSalt Gets or sets the salt used for encryption.
@@ -23,5 +23,5 @@ #### Reference -Password Class -CapyKit Namespace +Password Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md index a1d76a7..02386e4 100644 --- a/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/Properties_T_CapyKit_Pbkdf2Algorithm.md @@ -6,7 +6,7 @@ ## Properties - +
AlgorithmNameAlgorithmName Gets the name of the algorithm.
@@ -14,5 +14,5 @@ #### Reference -Pbkdf2Algorithm Class -CapyKit Namespace +Pbkdf2Algorithm Class +CapyKit Namespace diff --git a/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md b/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md index 9b0f4b2..febf165 100644 --- a/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md +++ b/Documentation/Help/Properties_T_CapyKit_PoolItem_1.md @@ -6,16 +6,16 @@ ## Properties - + - + - + - +
IndexIndex Gets the zero-based index of the pooled item.
ItemItem Gets the pooled resource.
LockedLocked Gets a value indicating whether this object is locked or not.
TypeNameTypeName Gets the name of the Type of the pooled item.
@@ -23,5 +23,5 @@ #### Reference -PoolItem(T) Class -CapyKit Namespace +PoolItem(T) Class +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md index 8712924..bbdc7bb 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationAttribute_1.md @@ -6,17 +6,19 @@ Custom attribute class for decorating enumeration fields with additional data. ## Definition -**Namespace:** CapyKit.Attributes +**Namespace:** CapyKit.Attributes **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# +[AttributeUsageAttribute(AttributeTargets.Field)] public abstract class EnumerationAttribute : Attribute ``` **F#** ``` F# [] +[] type EnumerationAttribute<'T> = class inherit Attribute @@ -24,7 +26,7 @@ type EnumerationAttribute<'T> = ``` - +
InheritanceObject → Attribute → EnumerationAttribute(T)
DerivedCapyKit.Attributes.EnumerationDescriptionAttribute
DerivedCapyKit.Attributes.EnumerationDescriptionAttribute
@@ -35,7 +37,7 @@ type EnumerationAttribute<'T> = ## Constructors - +
EnumerationAttribute(T)EnumerationAttribute(T) Gets the value of the enumeration represented by this attribute.
@@ -45,7 +47,7 @@ type EnumerationAttribute<'T> = TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute) -Value +Value Initializes a new instance of the EnumerationAttribute(T) class with a specified value. @@ -81,4 +83,4 @@ type EnumerationAttribute<'T> = #### Reference -CapyKit.Attributes Namespace +CapyKit.Attributes Namespace diff --git a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md index a2e6750..71428db 100644 --- a/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md +++ b/Documentation/Help/T_CapyKit_Attributes_EnumerationDescriptionAttribute.md @@ -6,22 +6,24 @@ An attribute class for decorating enumeration fields with a description. ## Definition -**Namespace:** CapyKit.Attributes +**Namespace:** CapyKit.Attributes **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** ``` C# +[AttributeUsageAttribute(AttributeTargets.Field)] public class EnumerationDescriptionAttribute : EnumerationAttribute ``` **F#** ``` F# +[] type EnumerationDescriptionAttribute = class inherit EnumerationAttribute end ``` - +
InheritanceObject → Attribute → EnumerationAttribute(String) → EnumerationDescriptionAttribute
InheritanceObject → Attribute → EnumerationAttribute(String) → EnumerationDescriptionAttribute
@@ -29,7 +31,7 @@ type EnumerationDescriptionAttribute = ## Constructors - +
EnumerationDescriptionAttributeEnumerationDescriptionAttribute Initializes a new instance of the EnumerationDescriptionAttribute class with the specified description.
@@ -39,8 +41,8 @@ type EnumerationDescriptionAttribute = TypeId When implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute) -Value -Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
(Inherited from EnumerationAttribute(T)) +Value +Initializes a new instance of the EnumerationAttribute(T) class with a specified value.
(Inherited from EnumerationAttribute(T)) ## Methods @@ -75,5 +77,5 @@ type EnumerationDescriptionAttribute = #### Reference -CapyKit.Attributes Namespace -EnumerationAttribute(T) +CapyKit.Attributes Namespace +EnumerationAttribute(T) diff --git a/Documentation/Help/T_CapyKit_CapyEventArgs.md b/Documentation/Help/T_CapyKit_CapyEventArgs.md index b94fc08..67db77c 100644 --- a/Documentation/Help/T_CapyKit_CapyEventArgs.md +++ b/Documentation/Help/T_CapyKit_CapyEventArgs.md @@ -6,7 +6,7 @@ The CapyEventArgs class represents an event argument instance with event level, ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,20 +29,20 @@ type CapyEventArgs = ## Constructors - +
CapyEventArgsCapyEventArgs Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
## Properties - + - + - +
LevelLevel Gets the severity level of the event.
MessageMessage Gets the message describing the reason for the event.
MethodNameMethodName Gets the name of the method where the event was raised.
@@ -72,4 +72,4 @@ type CapyEventArgs = #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_CapyEventHandler.md b/Documentation/Help/T_CapyKit_CapyEventHandler.md index 0b9f564..45fc3b3 100644 --- a/Documentation/Help/T_CapyKit_CapyEventHandler.md +++ b/Documentation/Help/T_CapyKit_CapyEventHandler.md @@ -1,12 +1,12 @@ # CapyEventHandler Delegate -A delegate representing an event handler that accepts a CapyEventArgs instance. +A delegate representing an event handler that accepts a CapyEventArgs instance. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -25,10 +25,10 @@ type CapyEventHandler = #### Parameters -
  CapyEventArgs
The CapyEventArgs instance containing event data.
+
  CapyEventArgs
The CapyEventArgs instance containing event data.
## See Also #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_CapyEventReporter.md b/Documentation/Help/T_CapyKit_CapyEventReporter.md index a3dc2ca..da59ce9 100644 --- a/Documentation/Help/T_CapyKit_CapyEventReporter.md +++ b/Documentation/Help/T_CapyKit_CapyEventReporter.md @@ -6,7 +6,7 @@ The CapyEventReporter class is responsible for managing event subscriptions and ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,18 +28,38 @@ type CapyEventReporter = class end ## Remarks Because consumers of CapyKit may have varied ways of handling logging, the CapyEventReporter provides a way for subscribers to recieve events for various "events" within the library. These can be thought of as a logging solution for CapyKit. Consumers are free to treat these events however they see fit. +## Constructors + + + + +
CapyEventReporter 
+ ## Methods - + + + + + + + - +
SubscribeEmitEventEmits an event with the given severity level, message, and method name.
EmitEventOnceEmits an event with the given severity level, message, unique identifier, and method name one time.
Subscribe Subscribes the specified event handler to the event with the given subscription level and origin.
UnsubscribeUnsubscribe Unsubscribes the specified event handler from the event with the given origin.
+## Fields + + + + +
uniqueIdentifiersA hash set storing unique identifiers for events intended to only be emitted once.
+ ## See Also #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Color.md b/Documentation/Help/T_CapyKit_Color.md index 98d83d2..4a0330e 100644 --- a/Documentation/Help/T_CapyKit_Color.md +++ b/Documentation/Help/T_CapyKit_Color.md @@ -6,7 +6,7 @@ Enum representing a set of named colors with their corresponding HEX values. The ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -3828,4 +3828,4 @@ type Color #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_EventLevel.md b/Documentation/Help/T_CapyKit_EventLevel.md index 38e51d5..1b92991 100644 --- a/Documentation/Help/T_CapyKit_EventLevel.md +++ b/Documentation/Help/T_CapyKit_EventLevel.md @@ -6,7 +6,7 @@ Enumeration representing different event level severity values. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -48,4 +48,4 @@ type EventLevel #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md index a09f255..5886c94 100644 --- a/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md @@ -6,7 +6,7 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,22 +29,22 @@ type EnumerationExtensions = class end ## Methods - + - + - + - + - + - +
GetDescriptionGetDescription An Enum extension method that gets a description.
GetNameGetName An Enum extension method that gets a name.
GetPrettyNameGetPrettyName An Enum extension method that gets a human readable name.
GetValueGetValue An Enum extension method that gets an integer value representing the enumation.
Parse(T)(T, String)Parse(T)(T, String) A T extension method that parses a string into an enumeration.
Parse(T)(T, String, Boolean)Parse(T)(T, String, Boolean) A T extension method that parses a string into an enumeration.
@@ -52,4 +52,4 @@ type EnumerationExtensions = class end #### Reference -CapyKit.Extensions Namespace +CapyKit.Extensions Namespace diff --git a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md index 8b4e8dd..19ec264 100644 --- a/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_LINQExtensions.md @@ -6,7 +6,7 @@ Provides static extension methods for performing common LINQ operations on CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,31 +29,34 @@ type LINQExtensions = class end ## Methods - + - + - + - - - - + - + + + + + + + - + - + - +
Distinct(T, U)Distinct(T, U) Enumerates distinct items in this collection as defined by the key property.
Filter(T)(IEnumerable(T), Func(T, Boolean))Filter(T)(IEnumerable(T), Func(T, Boolean)) Filters out items matching a predicate from the collection.
Filter(T)(IQueryable(T), Expression(Func(T, Boolean)))Filter(T)(IQueryable(T), Expression(Func(T, Boolean))) Filters out items matching a predicate from the collection.
LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Expression(Func(T, IEnumerable(U), R))) An IQueryable<T> extension method that left outer join.
Page(T)(IEnumerable(T), Int32, Int32)LeftOuterJoin(T, U, TKey, R)(IEnumerable(T), IEnumerable(U), Func(T, TKey), Func(U, TKey), Func(T, IEnumerable(U), R), Func(T, U))An IEnumable<T> extension method that left outer join.
LeftOuterJoin(T, U, TKey, R)(IQueryable(T), IQueryable(U), Expression(Func(T, TKey)), Expression(Func(U, TKey)), Func(T, IEnumerable(U), R), Func(T, U))An IQueryable<T> extension method that left outer join.
Page(T)(IEnumerable(T), Int32, Int32) Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
Page(T)(IQueryable(T), Int32, Int32)Page(T)(IQueryable(T), Int32, Int32) Get a page of items from a collection, skipping pageNumber pages of pageSize items per page.
PageCount(T)(IEnumerable(T), Int32)PageCount(T)(IEnumerable(T), Int32) The number of pages of pageSize size in the given collection.
PageCount(T)(IQueryable(T), Int32)PageCount(T)(IQueryable(T), Int32) The number of pages of pageSize size in the given collection.
@@ -61,4 +64,4 @@ type LINQExtensions = class end #### Reference -CapyKit.Extensions Namespace +CapyKit.Extensions Namespace diff --git a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md index f38347d..ab55c91 100644 --- a/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md +++ b/Documentation/Help/T_CapyKit_Extensions_StringExtensions.md @@ -6,7 +6,7 @@ Provides static extentions methods for providing additional functionality for CapyKit.Extensions +**Namespace:** CapyKit.Extensions **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -29,10 +29,10 @@ type StringExtensions = class end ## Methods - + - +
IfNullOrEmptyIfNullOrEmpty Replaces a null or empty string with a specified replacement string.
IfNullOrWhiteSpaceIfNullOrWhiteSpace Replaces a null or whitespace string with a specified replacement string.
@@ -40,4 +40,4 @@ type StringExtensions = class end #### Reference -CapyKit.Extensions Namespace +CapyKit.Extensions Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md index a91c960..cdabeae 100644 --- a/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_CompressionHelper.md @@ -6,7 +6,7 @@ A class that contains methods for managing data compression. ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,19 +28,19 @@ type CompressionHelper = class end ## Methods - + - + - + - + - +
CompressCompress Compresses a given object using the gzip algorithm.
CompressToStringCompressToString Compresses a given object to a string using base64 encoding of gzip format.
Decompress(T)(Byte[])Decompress(T)(Byte[]) Decompresses a given compressed gzip byte stream.
Decompress(T)(String)Decompress(T)(String) Decompresses a given base64 encoded string of gzip format.
DecompressToStringDecompressToString Decompresses the given base64 string in gzip format.
@@ -48,4 +48,4 @@ type CompressionHelper = class end #### Reference -CapyKit.Helpers Namespace +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md index 69e1666..383a509 100644 --- a/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_LanguageHelper.md @@ -6,7 +6,7 @@ ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,14 +26,14 @@ type LanguageHelper = class end ## Constructors - +
LanguageHelperLanguageHelper Initializes a new instance of the LanguageHelper class
## Methods - + @@ -59,4 +59,4 @@ type LanguageHelper = class end #### Reference -CapyKit.Helpers Namespace +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md index e58494a..70dba74 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SecurityHelper.md @@ -6,7 +6,7 @@ A class that contains methods for managing secure data processing and cryptograp ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -26,19 +26,22 @@ type SecurityHelper = class end ## Constructors
CamelCaseToHumanReadableCamelCaseToHumanReadable Converts camel case text to human readable text.
Equals
- +
SecurityHelperSecurityHelper Initializes a new instance of the SecurityHelper class
## Methods - + - + + + + @@ -48,36 +51,61 @@ type SecurityHelper = class end - + + + + - + - + - + + + + - - + + - - + +
CompareHashedPasswordCompareHashedPassword Compares an unencrypted providedPassword with a stored, encrypted existingPassword.
CompareSessionIDCompareSessionID Compares two session identifiers.
CompareStringsCompare two strings as case sensative.
Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetRandomPasswordGetRandomBytesGenerates a new byte array of the specified length with random values.
GetRandomPassword Gets a cryptographically strong random password.
GetRandomString(Int32)GetRandomString(Int32) A convenience method to generate a random string of the specified length using all character sets.
GetRandomString(Int32, ValidCharacterCollection[])GetRandomString(Int32, ValidCharacterCollection[]) Gets a cryptographically strong random string using the character values found in [!:VALID_CHARACTERS].
GetType Gets the Type of the current instance.
(Inherited from Object)
HashPasswordGetValidCharacterComposition 
HashPassword Hashes an unencrypted password.
MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object)
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String)Generates a new Password object using the PBKDF2 algorithm with the provided password. This overload of the method generates a random salt value for added security.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
Pbkdf2(String, Byte[])Generates a new Password object using the PBKDF2 algorithm with the provided password and salt.
ToString Returns a string that represents the current object.
(Inherited from Object)
+## Fields + + + + + + + + + + + + + + + + +
LOWER_CASE_CHARACTERSA string of all the lower case characters.
NUMBER_CHARACTERSA string of all the numeric characters.
saltSizeDefault size of the generated salt.
SPECIAL_CHARACTERSA string of the most common non-alphanumeric characters.
UPPER_CASE_CHARACTERSA string of all the upper case characters.
+ ## See Also #### Reference -CapyKit.Helpers Namespace +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md index cc8d576..cd32244 100644 --- a/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md +++ b/Documentation/Help/T_CapyKit_Helpers_SerializationHelper.md @@ -6,7 +6,7 @@ ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,19 +28,19 @@ type SerializationHelper = class end ## Methods - + - + - + - + - +
Deserialize(T)(Byte[])Deserialize(T)(Byte[]) Deserializes an object to a given T type.
Deserialize(T)(Stream)Deserialize(T)(Stream) Deserializes an object to a given T type.
Deserialize(T)(String)Deserialize(T)(String) Deserializes a JSON encoded string to the given T.
SerializeToBytesSerializeToBytes Serializes an object to a byte array.
SerializeToStringSerializeToString Serializes an object to a JSON encoded string.
@@ -48,4 +48,4 @@ type SerializationHelper = class end #### Reference -CapyKit.Helpers Namespace +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md index b82ca83..093814e 100644 --- a/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md +++ b/Documentation/Help/T_CapyKit_Helpers_ValidCharacterCollection.md @@ -6,7 +6,7 @@ An enumeration that defines the types of characters that can be included in a ra ## Definition -**Namespace:** CapyKit.Helpers +**Namespace:** CapyKit.Helpers **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -44,4 +44,4 @@ type ValidCharacterCollection #### Reference -CapyKit.Helpers Namespace +CapyKit.Helpers Namespace diff --git a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md index bf756b3..7977060 100644 --- a/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md +++ b/Documentation/Help/T_CapyKit_IPasswordAlgorithm.md @@ -6,7 +6,7 @@ Defines the contract for password encryption algorithms. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -23,17 +23,17 @@ type IPasswordAlgorithm = interface end ## Properties - +
AlgorithmNameAlgorithmName Gets the name of the algorithm.
## Methods - + - +
CompareCompare Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.
EncryptEncrypt Encrypts the given password using a defined algorithm.
@@ -41,4 +41,4 @@ type IPasswordAlgorithm = interface end #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Password.md b/Documentation/Help/T_CapyKit_Password.md index 38b2063..454abb5 100644 --- a/Documentation/Help/T_CapyKit_Password.md +++ b/Documentation/Help/T_CapyKit_Password.md @@ -6,7 +6,7 @@ Represents a password with its hash, salt and algorithm used for encryption. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -23,19 +23,29 @@ type Password = class end +## Constructors + + + + + + + +
Password 
PasswordConstructor.
+ ## Properties - + - + - + - +
AlgorithmAlgorithm Gets or sets the algorithm used for password encryption.
HashHash Gets or sets the hash of the password.
Pbkdf2AlgorithmPbkdf2Algorithm  
SaltSalt Gets or sets the salt used for encryption.
@@ -57,12 +67,19 @@ type Password = class end MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -ToString +ToString Returns a string that represents the current object.
(Overrides Object.ToString()) +## Fields + + + + +
algorithm 
+ ## See Also #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md index e4275a6..1b70fce 100644 --- a/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md +++ b/Documentation/Help/T_CapyKit_Pbkdf2Algorithm.md @@ -6,7 +6,7 @@ Implements the PBKDF2 algorithm for password encryption. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -22,7 +22,7 @@ type Pbkdf2Algorithm = ``` - +
InheritanceObject → Pbkdf2Algorithm
ImplementsIPasswordAlgorithm
ImplementsIPasswordAlgorithm
@@ -30,21 +30,21 @@ type Pbkdf2Algorithm = ## Constructors - +
Pbkdf2AlgorithmPbkdf2Algorithm Initializes a new instance of the Pbkdf2Algorithm class
## Properties - +
AlgorithmNameAlgorithmName Gets the name of the algorithm.
## Methods - + @@ -69,10 +69,10 @@ type Pbkdf2Algorithm = ## Fields
EncryptEncrypt Encrypts the given password using a PBKDF2 algorithm.
Equals
- + - +
ITERATIONSITERATIONS The default number of iterations.
LENGTHLENGTH (Immutable) The default length.
@@ -80,4 +80,4 @@ type Pbkdf2Algorithm = #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_PoolItem_1.md b/Documentation/Help/T_CapyKit_PoolItem_1.md index dcf7f1e..eb733ac 100644 --- a/Documentation/Help/T_CapyKit_PoolItem_1.md +++ b/Documentation/Help/T_CapyKit_PoolItem_1.md @@ -6,7 +6,7 @@ A pool item. This class cannot be inherited. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -28,19 +28,26 @@ type PoolItem<'T> = class end #### Type Parameters
The type of the pooled item.
+## Constructors + + + + +
PoolItem(T)Initializes a new instance of the PoolItem(T) class with the specified item and index.
+ ## Properties - + - + - + - +
IndexIndex Gets the zero-based index of the pooled item.
ItemItem Gets the pooled resource.
LockedLocked Gets a value indicating whether this object is locked or not.
TypeNameTypeName Gets the name of the Type of the pooled item.
@@ -50,24 +57,46 @@ type PoolItem<'T> = class end Equals Determines whether the specified object is equal to the current object.
(Inherited from Object) +Finalize +Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) + GetHashCode Serves as the default hash function.
(Inherited from Object) GetType Gets the Type of the current instance.
(Inherited from Object) -ReleaseLock +MemberwiseClone +Creates a shallow copy of the current Object.
(Inherited from Object) + +ReleaseLock Releases the lock on the item. -SetLock +SetLock Sets the lock on the item indicating that it is in use. -ToString +ToString Returns a string that represents the current object and its lock state.
(Overrides Object.ToString()) +## Fields + + + + + + + + + + + + + +
indexThe zero-based index of the pooled item.
itemThe pooled item.
lockedA flag indicating whether the item is locked or not.
typeNameThe name of the pooled item Type.
+ ## See Also #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_Pool_1.md b/Documentation/Help/T_CapyKit_Pool_1.md index 5231cc8..31a3b1a 100644 --- a/Documentation/Help/T_CapyKit_Pool_1.md +++ b/Documentation/Help/T_CapyKit_Pool_1.md @@ -6,7 +6,7 @@ A managed pool of resources. This class provides a thread-safe way to manage a c ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -30,13 +30,13 @@ type Pool<'T> = class end ## Constructors - + - + - +
Pool(T)(IEnumerable(T))Pool(T)(IEnumerable(T)) Initializes a new instance of the Pool(T) class with the specified collection of items.
Pool(T)(Int32)Pool(T)(Int32) Initializes a new instance of the Pool(T) class with the specified pool size.
Pool(T)(Int32, Func(T))Pool(T)(Int32, Func(T)) Initializes a new instance of the Pool(T) class with the specified pool size and constructor selector.
@@ -46,10 +46,19 @@ type Pool<'T> = class end Equals Determines whether the specified object is equal to the current object.
(Inherited from Object) +FillPoolItemCollection(IEnumerable(T)) +Fill the pool item collection from an existing T collection. + +FillPoolItemCollection(Int32) +Initializes the pool with the specified number of items using the default constructor. + +FillPoolItemCollection(Int32, Func(T)) +Initializes the pool with the specified number of items using the specified constructor selector. + Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object) -GetAvailableItem +GetAvailableItem Gets the first available item from the pool and sets its lock. GetHashCode @@ -61,15 +70,25 @@ type Pool<'T> = class end MemberwiseClone Creates a shallow copy of the current Object.
(Inherited from Object) -ReleaseItem +ReleaseItem Releases the lock on the specified item and returns it to the pool. ToString Returns a string that represents the current object.
(Inherited from Object) +## Fields + + + + + + + +
poolItemCollectionThe collection of pooled items.
poolSize(Immutable) The number of items in the pool.
+ ## See Also #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/T_CapyKit_PropertyComparer_2.md b/Documentation/Help/T_CapyKit_PropertyComparer_2.md index e1f1524..97e317c 100644 --- a/Documentation/Help/T_CapyKit_PropertyComparer_2.md +++ b/Documentation/Help/T_CapyKit_PropertyComparer_2.md @@ -6,7 +6,7 @@ A object comparer that can accept a lambda expression to compare properties. ## Definition -**Namespace:** CapyKit +**Namespace:** CapyKit **Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d **C#** @@ -37,7 +37,7 @@ using System; using System.Collections.Generic; using System.Linq; class Program ## Constructors - +
PropertyComparer(T, U)PropertyComparer(T, U) Constructor.
@@ -47,7 +47,7 @@ using System; using System.Collections.Generic; using System.Linq; class Program Equals(Object) Determines whether the specified object is equal to the current object.
(Inherited from Object) -Equals(T, T) +Equals(T, T) Determines whether the specified properties are equal. Finalize @@ -56,7 +56,7 @@ using System; using System.Collections.Generic; using System.Linq; class Program GetHashCode() Serves as the default hash function.
(Inherited from Object) -GetHashCode(T) +GetHashCode(T) Returns a hash code for the specified object. GetType @@ -69,8 +69,15 @@ using System; using System.Collections.Generic; using System.Linq; class Program Returns a string that represents the current object.
(Inherited from Object) +## Fields + + + + +
expressionThe expression to retrieve the property.
+ ## See Also #### Reference -CapyKit Namespace +CapyKit Namespace diff --git a/Documentation/Help/_Sidebar.md b/Documentation/Help/_Sidebar.md index 26ec29d..4f2f2eb 100644 --- a/Documentation/Help/_Sidebar.md +++ b/Documentation/Help/_Sidebar.md @@ -1,140 +1,174 @@ -- [Welcome to the [TODO: Add project name]](849aa079-3d64-4cf1-966f-44af23c73160) -- [Version History](7d36447b-0aab-4ce9-b5ed-e60ec5bee103) - - [Version 1.0.0.0](fa7407d1-9116-4ad7-a9ab-ed094685b070) -- [CapyKit Namespace](N_CapyKit) - - [CapyEventArgs Class](T_CapyKit_CapyEventArgs) - - [CapyEventArgs Constructor](M_CapyKit_CapyEventArgs__ctor) - - [CapyEventArgs Properties](Properties_T_CapyKit_CapyEventArgs) - - [Level Property](P_CapyKit_CapyEventArgs_Level) - - [Message Property](P_CapyKit_CapyEventArgs_Message) - - [MethodName Property](P_CapyKit_CapyEventArgs_MethodName) - - [CapyEventArgs Methods](Methods_T_CapyKit_CapyEventArgs) - - [CapyEventHandler Delegate](T_CapyKit_CapyEventHandler) - - [CapyEventReporter Class](T_CapyKit_CapyEventReporter) - - [CapyEventReporter Methods](Methods_T_CapyKit_CapyEventReporter) - - [Subscribe Method](M_CapyKit_CapyEventReporter_Subscribe) - - [Unsubscribe Method](M_CapyKit_CapyEventReporter_Unsubscribe) - - [Color Enumeration](T_CapyKit_Color) - - [EventLevel Enumeration](T_CapyKit_EventLevel) - - [IPasswordAlgorithm Interface](T_CapyKit_IPasswordAlgorithm) - - [IPasswordAlgorithm Properties](Properties_T_CapyKit_IPasswordAlgorithm) - - [AlgorithmName Property](P_CapyKit_IPasswordAlgorithm_AlgorithmName) - - [IPasswordAlgorithm Methods](Methods_T_CapyKit_IPasswordAlgorithm) - - [Compare Method](M_CapyKit_IPasswordAlgorithm_Compare) - - [Encrypt Method](M_CapyKit_IPasswordAlgorithm_Encrypt) - - [Password Class](T_CapyKit_Password) - - [Password Properties](Properties_T_CapyKit_Password) - - [Algorithm Property](P_CapyKit_Password_Algorithm) - - [Hash Property](P_CapyKit_Password_Hash) - - [Pbkdf2Algorithm Property](P_CapyKit_Password_Pbkdf2Algorithm) - - [Salt Property](P_CapyKit_Password_Salt) - - [Password Methods](Methods_T_CapyKit_Password) - - [ToString Method](M_CapyKit_Password_ToString) - - [Pbkdf2Algorithm Class](T_CapyKit_Pbkdf2Algorithm) - - [Pbkdf2Algorithm Constructor](M_CapyKit_Pbkdf2Algorithm__ctor) - - [Pbkdf2Algorithm Properties](Properties_T_CapyKit_Pbkdf2Algorithm) - - [AlgorithmName Property](P_CapyKit_Pbkdf2Algorithm_AlgorithmName) - - [Pbkdf2Algorithm Methods](Methods_T_CapyKit_Pbkdf2Algorithm) - - [Encrypt Method](M_CapyKit_Pbkdf2Algorithm_Encrypt) - - [Pbkdf2Algorithm Fields](Fields_T_CapyKit_Pbkdf2Algorithm) - - [ITERATIONS Field](F_CapyKit_Pbkdf2Algorithm_ITERATIONS) - - [LENGTH Field](F_CapyKit_Pbkdf2Algorithm_LENGTH) - - [Pool Class](T_CapyKit_Pool_1) - - [Pool Constructor](Overload_CapyKit_Pool_1__ctor) - - [Pool(IEnumerable) Constructor](M_CapyKit_Pool_1__ctor) - - [Pool(Int32) Constructor](M_CapyKit_Pool_1__ctor_1) - - [Pool(Int32, Func) Constructor](M_CapyKit_Pool_1__ctor_2) - - [Pool Methods](Methods_T_CapyKit_Pool_1) - - [GetAvailableItem Method](M_CapyKit_Pool_1_GetAvailableItem) - - [ReleaseItem Method](M_CapyKit_Pool_1_ReleaseItem) - - [PoolItem Class](T_CapyKit_PoolItem_1) - - [PoolItem Properties](Properties_T_CapyKit_PoolItem_1) - - [Index Property](P_CapyKit_PoolItem_1_Index) - - [Item Property](P_CapyKit_PoolItem_1_Item) - - [Locked Property](P_CapyKit_PoolItem_1_Locked) - - [TypeName Property](P_CapyKit_PoolItem_1_TypeName) - - [PoolItem Methods](Methods_T_CapyKit_PoolItem_1) - - [ReleaseLock Method](M_CapyKit_PoolItem_1_ReleaseLock) - - [SetLock Method](M_CapyKit_PoolItem_1_SetLock) - - [ToString Method](M_CapyKit_PoolItem_1_ToString) - - [PropertyComparer Class](T_CapyKit_PropertyComparer_2) - - [PropertyComparer Constructor](M_CapyKit_PropertyComparer_2__ctor) - - [PropertyComparer Methods](Methods_T_CapyKit_PropertyComparer_2) - - [Equals Method](Overload_CapyKit_PropertyComparer_2_Equals) - - [Equals(T, T) Method](M_CapyKit_PropertyComparer_2_Equals) - - [GetHashCode Method](Overload_CapyKit_PropertyComparer_2_GetHashCode) - - [GetHashCode(T) Method](M_CapyKit_PropertyComparer_2_GetHashCode) -- [CapyKit.Attributes Namespace](N_CapyKit_Attributes) - - [EnumerationAttribute Class](T_CapyKit_Attributes_EnumerationAttribute_1) - - [EnumerationAttribute Constructor](M_CapyKit_Attributes_EnumerationAttribute_1__ctor) - - [EnumerationAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationAttribute_1) - - [Value Property](P_CapyKit_Attributes_EnumerationAttribute_1_Value) - - [EnumerationAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationAttribute_1) - - [EnumerationDescriptionAttribute Class](T_CapyKit_Attributes_EnumerationDescriptionAttribute) - - [EnumerationDescriptionAttribute Constructor](M_CapyKit_Attributes_EnumerationDescriptionAttribute__ctor) - - [EnumerationDescriptionAttribute Properties](Properties_T_CapyKit_Attributes_EnumerationDescriptionAttribute) - - [EnumerationDescriptionAttribute Methods](Methods_T_CapyKit_Attributes_EnumerationDescriptionAttribute) -- [CapyKit.Extensions Namespace](N_CapyKit_Extensions) - - [EnumerationExtensions Class](T_CapyKit_Extensions_EnumerationExtensions) - - [EnumerationExtensions Methods](Methods_T_CapyKit_Extensions_EnumerationExtensions) - - [GetDescription Method](M_CapyKit_Extensions_EnumerationExtensions_GetDescription) - - [GetName Method](M_CapyKit_Extensions_EnumerationExtensions_GetName) - - [GetPrettyName Method](M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName) - - [GetValue Method](M_CapyKit_Extensions_EnumerationExtensions_GetValue) - - [Parse Method](Overload_CapyKit_Extensions_EnumerationExtensions_Parse) - - [Parse(T, String) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1) - - [Parse(T, String, Boolean) Method](M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1) - - [LINQExtensions Class](T_CapyKit_Extensions_LINQExtensions) - - [LINQExtensions Methods](Methods_T_CapyKit_Extensions_LINQExtensions) - - [Distinct Method](M_CapyKit_Extensions_LINQExtensions_Distinct__2) - - [Filter Method](Overload_CapyKit_Extensions_LINQExtensions_Filter) - - [Filter(IEnumerable, Func) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1) - - [Filter(IQueryable, Expression>) Method](M_CapyKit_Extensions_LINQExtensions_Filter__1_1) - - [LeftOuterJoin Method](Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin) - - [LeftOuterJoin(IEnumerable, IEnumerable, Func, Func, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4) - - [LeftOuterJoin(IQueryable, IQueryable, Expression>, Expression>, Func, R>, Func) Method](M_CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_1) - - [Page Method](Overload_CapyKit_Extensions_LINQExtensions_Page) - - [Page(IEnumerable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1) - - [Page(IQueryable, Int32, Int32) Method](M_CapyKit_Extensions_LINQExtensions_Page__1_1) - - [PageCount Method](Overload_CapyKit_Extensions_LINQExtensions_PageCount) - - [PageCount(IEnumerable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1) - - [PageCount(IQueryable, Int32) Method](M_CapyKit_Extensions_LINQExtensions_PageCount__1_1) - - [StringExtensions Class](T_CapyKit_Extensions_StringExtensions) - - [StringExtensions Methods](Methods_T_CapyKit_Extensions_StringExtensions) - - [IfNullOrEmpty Method](M_CapyKit_Extensions_StringExtensions_IfNullOrEmpty) - - [IfNullOrWhiteSpace Method](M_CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace) -- [CapyKit.Helpers Namespace](N_CapyKit_Helpers) - - [CompressionHelper Class](T_CapyKit_Helpers_CompressionHelper) - - [CompressionHelper Methods](Methods_T_CapyKit_Helpers_CompressionHelper) - - [Compress Method](M_CapyKit_Helpers_CompressionHelper_Compress) - - [CompressToString Method](M_CapyKit_Helpers_CompressionHelper_CompressToString) - - [Decompress Method](Overload_CapyKit_Helpers_CompressionHelper_Decompress) - - [Decompress(Byte[]) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1) - - [Decompress(String) Method](M_CapyKit_Helpers_CompressionHelper_Decompress__1_1) - - [DecompressToString Method](M_CapyKit_Helpers_CompressionHelper_DecompressToString) - - [LanguageHelper Class](T_CapyKit_Helpers_LanguageHelper) - - [LanguageHelper Constructor](M_CapyKit_Helpers_LanguageHelper__ctor) - - [LanguageHelper Methods](Methods_T_CapyKit_Helpers_LanguageHelper) - - [CamelCaseToHumanReadable Method](M_CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable) - - [SecurityHelper Class](T_CapyKit_Helpers_SecurityHelper) - - [SecurityHelper Constructor](M_CapyKit_Helpers_SecurityHelper__ctor) - - [SecurityHelper Methods](Methods_T_CapyKit_Helpers_SecurityHelper) - - [CompareHashedPassword Method](M_CapyKit_Helpers_SecurityHelper_CompareHashedPassword) - - [CompareSessionID Method](M_CapyKit_Helpers_SecurityHelper_CompareSessionID) - - [GetRandomPassword Method](M_CapyKit_Helpers_SecurityHelper_GetRandomPassword) - - [GetRandomString Method](Overload_CapyKit_Helpers_SecurityHelper_GetRandomString) - - [GetRandomString(Int32) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString) - - [GetRandomString(Int32, ValidCharacterCollection[]) Method](M_CapyKit_Helpers_SecurityHelper_GetRandomString_1) - - [HashPassword Method](M_CapyKit_Helpers_SecurityHelper_HashPassword) - - [Pbkdf2 Method](Overload_CapyKit_Helpers_SecurityHelper_Pbkdf2) - - [Pbkdf2(String) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2) - - [Pbkdf2(String, Byte[]) Method](M_CapyKit_Helpers_SecurityHelper_Pbkdf2_1) - - [SerializationHelper Class](T_CapyKit_Helpers_SerializationHelper) - - [SerializationHelper Methods](Methods_T_CapyKit_Helpers_SerializationHelper) - - [Deserialize Method](Overload_CapyKit_Helpers_SerializationHelper_Deserialize) - - [Deserialize(Byte[]) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1) - - [Deserialize(Stream) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_1) - - [Deserialize(String) Method](M_CapyKit_Helpers_SerializationHelper_Deserialize__1_2) - - [SerializeToBytes Method](M_CapyKit_Helpers_SerializationHelper_SerializeToBytes) - - [SerializeToString Method](M_CapyKit_Helpers_SerializationHelper_SerializeToString) - - [ValidCharacterCollection Enumeration](T_CapyKit_Helpers_ValidCharacterCollection) +- [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) diff --git a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md b/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md index b4b2855..d07661f 100644 --- a/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md +++ b/Documentation/Help/fa7407d1-9116-4ad7-a9ab-ed094685b070.md @@ -12,4 +12,4 @@ Version [TODO: Version] was released on [TODO: Date]. #### Other Resources -Version History +Version History