Generate API docs as markdown

This commit is contained in:
Jordan Wages 2026-07-07 01:56:58 -05:00
commit 85e90f7bd5
120 changed files with 14227 additions and 76482 deletions

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,108 @@
# <a id="CapyKit_Attributes_EnumerationAttribute_1"></a> Class EnumerationAttribute<T\>
Namespace: [CapyKit.Attributes](CapyKit.Attributes.md)
Assembly: CapyKit.dll
Custom attribute class for decorating enumeration fields with additional data.
```csharp
[AttributeUsage(AttributeTargets.Field)]
public abstract class EnumerationAttribute<T> : Attribute
```
#### Type Parameters
`T`
Generic type parameter allowing for arbitrary declarations and assignments of meaning.
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
[EnumerationAttribute<T\>](CapyKit.Attributes.EnumerationAttribute\-1.md)
#### Inherited Members
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<EnumerationAttribute<T\>\>\(EnumerationAttribute<T\>, EnumerationAttribute<T\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Attributes_EnumerationAttribute_1__ctor__0_"></a> EnumerationAttribute\(T\)
Gets the value of the enumeration represented by this attribute.
```csharp
protected EnumerationAttribute(T value)
```
#### Parameters
`value` T
Initializes a new instance of the <xref href="CapyKit.Attributes.EnumerationAttribute%601" data-throw-if-not-resolved="false"></xref> class with a
specified value.
## Properties
### <a id="CapyKit_Attributes_EnumerationAttribute_1_Value"></a> Value
Initializes a new instance of the <xref href="CapyKit.Attributes.EnumerationAttribute%601" data-throw-if-not-resolved="false"></xref> class with a
specified value.
```csharp
public T Value { get; }
```
#### Property Value
T

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,93 @@
# <a id="CapyKit_Attributes_EnumerationDescriptionAttribute"></a> Class EnumerationDescriptionAttribute
Namespace: [CapyKit.Attributes](CapyKit.Attributes.md)
Assembly: CapyKit.dll
An attribute class for decorating enumeration fields with a description.
```csharp
[AttributeUsage(AttributeTargets.Field)]
public class EnumerationDescriptionAttribute : EnumerationAttribute<string>
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
[EnumerationAttribute<string\>](CapyKit.Attributes.EnumerationAttribute\-1.md) ←
[EnumerationDescriptionAttribute](CapyKit.Attributes.EnumerationDescriptionAttribute.md)
#### Inherited Members
[EnumerationAttribute<string\>.Value](CapyKit.Attributes.EnumerationAttribute\-1.md\#CapyKit\_Attributes\_EnumerationAttribute\_1\_Value),
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<EnumerationDescriptionAttribute\>\(EnumerationDescriptionAttribute, EnumerationDescriptionAttribute\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_System_String_"></a> EnumerationDescriptionAttribute\(string\)
Initializes a new instance of the <xref href="CapyKit.Attributes.EnumerationDescriptionAttribute" data-throw-if-not-resolved="false"></xref> class with
the specified description.
```csharp
public EnumerationDescriptionAttribute(string description)
```
#### Parameters
`description` [string](https://learn.microsoft.com/dotnet/api/system.string)
The description of the enumeration value.
## See Also
[EnumerationAttribute](CapyKit.Attributes.EnumerationAttribute\-1.md)<T\>

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,132 @@
# <a id="CapyKit_Attributes_ValueFormatAttribute"></a> Class ValueFormatAttribute
Namespace: [CapyKit.Attributes](CapyKit.Attributes.md)
Assembly: CapyKit.dll
Custom attribute for formatting values in a specific way.
```csharp
[AttributeUsage(AttributeTargets.Property)]
public class ValueFormatAttribute : Attribute
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
[ValueFormatAttribute](CapyKit.Attributes.ValueFormatAttribute.md)
#### Inherited Members
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<ValueFormatAttribute\>\(ValueFormatAttribute, ValueFormatAttribute\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Attributes_ValueFormatAttribute__ctor"></a> ValueFormatAttribute\(\)
Default constructor. Initializes a new instance of the <xref href="CapyKit.Attributes.ValueFormatAttribute" data-throw-if-not-resolved="false"></xref>
class with an empty format string.
```csharp
public ValueFormatAttribute()
```
### <a id="CapyKit_Attributes_ValueFormatAttribute__ctor_System_String_"></a> ValueFormatAttribute\(string\)
Constructor. Initializes a new instance of the <xref href="CapyKit.Attributes.ValueFormatAttribute" data-throw-if-not-resolved="false"></xref> class with
the specified format string.
```csharp
public ValueFormatAttribute(string format)
```
#### Parameters
`format` [string](https://learn.microsoft.com/dotnet/api/system.string)
The format string used to format the value.
## Properties
### <a id="CapyKit_Attributes_ValueFormatAttribute_Format"></a> Format
Gets or sets the format to use for formatting the value.
```csharp
public string Format { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
## Methods
### <a id="CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString_System_Int32_"></a> GetFormatParameterizedString\(int\)
Gets a parameterized formatted string for the specified index.
```csharp
public string GetFormatParameterizedString(int index = 0)
```
#### Parameters
`index` [int](https://learn.microsoft.com/dotnet/api/system.int32)
(Optional) Zero-based index of the item in the string to format.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A formatted string with the specified index and format.

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,16 @@
# <a id="CapyKit_Attributes"></a> Namespace CapyKit.Attributes
### Classes
[EnumerationAttribute<T\>](CapyKit.Attributes.EnumerationAttribute\-1.md)
Custom attribute class for decorating enumeration fields with additional data.
[EnumerationDescriptionAttribute](CapyKit.Attributes.EnumerationDescriptionAttribute.md)
An attribute class for decorating enumeration fields with a description.
[ValueFormatAttribute](CapyKit.Attributes.ValueFormatAttribute.md)
Custom attribute for formatting values in a specific way.

View file

@ -1,79 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Attributes
commentId: N:CapyKit.Attributes
id: CapyKit.Attributes
children:
- CapyKit.Attributes.EnumerationAttribute`1
- CapyKit.Attributes.EnumerationDescriptionAttribute
- CapyKit.Attributes.ValueFormatAttribute
langs:
- csharp
- vb
name: CapyKit.Attributes
nameWithType: CapyKit.Attributes
fullName: CapyKit.Attributes
type: Namespace
assemblies:
- CapyKit
references:
- uid: CapyKit.Attributes.EnumerationAttribute`1
commentId: T:CapyKit.Attributes.EnumerationAttribute`1
href: CapyKit.Attributes.EnumerationAttribute-1.html
name: EnumerationAttribute<T>
nameWithType: EnumerationAttribute<T>
fullName: CapyKit.Attributes.EnumerationAttribute<T>
nameWithType.vb: EnumerationAttribute(Of T)
fullName.vb: CapyKit.Attributes.EnumerationAttribute(Of T)
name.vb: EnumerationAttribute(Of T)
spec.csharp:
- uid: CapyKit.Attributes.EnumerationAttribute`1
name: EnumerationAttribute
href: CapyKit.Attributes.EnumerationAttribute-1.html
- name: <
- name: T
- name: '>'
spec.vb:
- uid: CapyKit.Attributes.EnumerationAttribute`1
name: EnumerationAttribute
href: CapyKit.Attributes.EnumerationAttribute-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: CapyKit.Attributes.EnumerationDescriptionAttribute
commentId: T:CapyKit.Attributes.EnumerationDescriptionAttribute
parent: CapyKit.Attributes
href: CapyKit.Attributes.EnumerationDescriptionAttribute.html
name: EnumerationDescriptionAttribute
nameWithType: EnumerationDescriptionAttribute
fullName: CapyKit.Attributes.EnumerationDescriptionAttribute
- uid: CapyKit.Attributes.ValueFormatAttribute
commentId: T:CapyKit.Attributes.ValueFormatAttribute
href: CapyKit.Attributes.ValueFormatAttribute.html
name: ValueFormatAttribute
nameWithType: ValueFormatAttribute
fullName: CapyKit.Attributes.ValueFormatAttribute
- uid: CapyKit.Attributes
commentId: N:CapyKit.Attributes
href: CapyKit.html
name: CapyKit.Attributes
nameWithType: CapyKit.Attributes
fullName: CapyKit.Attributes
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Attributes
name: Attributes
href: CapyKit.Attributes.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Attributes
name: Attributes
href: CapyKit.Attributes.html

View file

@ -0,0 +1,96 @@
# <a id="CapyKit_CapyEventArgs"></a> Class CapyEventArgs
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
The CapyEventArgs class represents an event argument instance with event level, message, and
method name information.
```csharp
public class CapyEventArgs : EventArgs
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[EventArgs](https://learn.microsoft.com/dotnet/api/system.eventargs) ←
[CapyEventArgs](CapyKit.CapyEventArgs.md)
#### Inherited Members
[EventArgs.Empty](https://learn.microsoft.com/dotnet/api/system.eventargs.empty),
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<CapyEventArgs\>\(CapyEventArgs, CapyEventArgs\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_"></a> CapyEventArgs\(EventLevel, string, string\)
Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
```csharp
public CapyEventArgs(EventLevel level, string message, string method = null)
```
#### Parameters
`level` [EventLevel](CapyKit.EventLevel.md)
The severity level of the event.
`message` [string](https://learn.microsoft.com/dotnet/api/system.string)
A descriptive message explaining the reason for the event.
`method` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the method where the event was raised.
## Properties
### <a id="CapyKit_CapyEventArgs_Level"></a> Level
Gets the severity level of the event.
```csharp
public EventLevel Level { get; }
```
#### Property Value
[EventLevel](CapyKit.EventLevel.md)
### <a id="CapyKit_CapyEventArgs_Message"></a> Message
Gets the message describing the reason for the event.
```csharp
public string Message { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
### <a id="CapyKit_CapyEventArgs_MethodName"></a> MethodName
Gets the name of the method where the event was raised.
```csharp
public string MethodName { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)

View file

@ -1,693 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.CapyEventArgs
commentId: T:CapyKit.CapyEventArgs
id: CapyEventArgs
parent: CapyKit
children:
- CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)
- CapyKit.CapyEventArgs.Level
- CapyKit.CapyEventArgs.Message
- CapyKit.CapyEventArgs.MethodName
langs:
- csharp
- vb
name: CapyEventArgs
nameWithType: CapyEventArgs
fullName: CapyKit.CapyEventArgs
type: Class
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CapyEventArgs
path: ../CapyKit/CapyEvent.cs
startLine: 163
assemblies:
- CapyKit
namespace: CapyKit
summary: >-
The CapyEventArgs class represents an event argument instance with event level, message, and
method name information.
example: []
syntax:
content: 'public class CapyEventArgs : EventArgs'
content.vb: Public Class CapyEventArgs Inherits EventArgs
inheritance:
- System.Object
- System.EventArgs
inheritedMembers:
- System.EventArgs.Empty
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- CapyKit.CapyEventArgs.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.CapyEventArgs.Level
commentId: P:CapyKit.CapyEventArgs.Level
id: Level
parent: CapyKit.CapyEventArgs
langs:
- csharp
- vb
name: Level
nameWithType: CapyEventArgs.Level
fullName: CapyKit.CapyEventArgs.Level
type: Property
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Level
path: ../CapyKit/CapyEvent.cs
startLine: 170
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the severity level of the event.
example: []
syntax:
content: public EventLevel Level { get; }
parameters: []
return:
type: CapyKit.EventLevel
content.vb: Public Property Level As EventLevel
overload: CapyKit.CapyEventArgs.Level*
- uid: CapyKit.CapyEventArgs.Message
commentId: P:CapyKit.CapyEventArgs.Message
id: Message
parent: CapyKit.CapyEventArgs
langs:
- csharp
- vb
name: Message
nameWithType: CapyEventArgs.Message
fullName: CapyKit.CapyEventArgs.Message
type: Property
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Message
path: ../CapyKit/CapyEvent.cs
startLine: 175
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the message describing the reason for the event.
example: []
syntax:
content: public string Message { get; }
parameters: []
return:
type: System.String
content.vb: Public Property Message As String
overload: CapyKit.CapyEventArgs.Message*
- uid: CapyKit.CapyEventArgs.MethodName
commentId: P:CapyKit.CapyEventArgs.MethodName
id: MethodName
parent: CapyKit.CapyEventArgs
langs:
- csharp
- vb
name: MethodName
nameWithType: CapyEventArgs.MethodName
fullName: CapyKit.CapyEventArgs.MethodName
type: Property
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: MethodName
path: ../CapyKit/CapyEvent.cs
startLine: 180
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the name of the method where the event was raised.
example: []
syntax:
content: public string MethodName { get; }
parameters: []
return:
type: System.String
content.vb: Public Property MethodName As String
overload: CapyKit.CapyEventArgs.MethodName*
- uid: CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)
commentId: M:CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)
id: '#ctor(CapyKit.EventLevel,System.String,System.String)'
parent: CapyKit.CapyEventArgs
langs:
- csharp
- vb
name: CapyEventArgs(EventLevel, string, string)
nameWithType: CapyEventArgs.CapyEventArgs(EventLevel, string, string)
fullName: CapyKit.CapyEventArgs.CapyEventArgs(CapyKit.EventLevel, string, string)
type: Constructor
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: .ctor
path: ../CapyKit/CapyEvent.cs
startLine: 192
assemblies:
- CapyKit
namespace: CapyKit
summary: Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
example: []
syntax:
content: public CapyEventArgs(EventLevel level, string message, string method = null)
parameters:
- id: level
type: CapyKit.EventLevel
description: The severity level of the event.
- id: message
type: System.String
description: A descriptive message explaining the reason for the event.
- id: method
type: System.String
description: The name of the method where the event was raised.
content.vb: Public Sub New(level As EventLevel, message As String, method As String = Nothing)
overload: CapyKit.CapyEventArgs.#ctor*
nameWithType.vb: CapyEventArgs.New(EventLevel, String, String)
fullName.vb: CapyKit.CapyEventArgs.New(CapyKit.EventLevel, String, String)
name.vb: New(EventLevel, String, String)
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.EventArgs
commentId: T:System.EventArgs
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.eventargs
name: EventArgs
nameWithType: EventArgs
fullName: System.EventArgs
- uid: System.EventArgs.Empty
commentId: F:System.EventArgs.Empty
parent: System.EventArgs
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.eventargs.empty
name: Empty
nameWithType: EventArgs.Empty
fullName: System.EventArgs.Empty
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.CapyEventArgs.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)
nameWithType: ObjectExtensions.UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.CapyEventArgs>(CapyKit.CapyEventArgs, CapyKit.CapyEventArgs)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of CapyEventArgs)(CapyEventArgs, CapyEventArgs)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.CapyEventArgs)(CapyKit.CapyEventArgs, CapyKit.CapyEventArgs)
name.vb: UpdateProperties(Of CapyEventArgs)(CapyEventArgs, CapyEventArgs)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs,CapyKit.CapyEventArgs)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
href: CapyKit.CapyEventArgs.html
- name: '>'
- name: (
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
href: CapyKit.CapyEventArgs.html
- name: ','
- name: " "
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
href: CapyKit.CapyEventArgs.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs,CapyKit.CapyEventArgs)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
href: CapyKit.CapyEventArgs.html
- name: )
- name: (
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
href: CapyKit.CapyEventArgs.html
- name: ','
- name: " "
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
href: CapyKit.CapyEventArgs.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.CapyEventArgs.Level*
commentId: Overload:CapyKit.CapyEventArgs.Level
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs_Level
name: Level
nameWithType: CapyEventArgs.Level
fullName: CapyKit.CapyEventArgs.Level
- uid: CapyKit.EventLevel
commentId: T:CapyKit.EventLevel
parent: CapyKit
href: CapyKit.EventLevel.html
name: EventLevel
nameWithType: EventLevel
fullName: CapyKit.EventLevel
- uid: CapyKit.CapyEventArgs.Message*
commentId: Overload:CapyKit.CapyEventArgs.Message
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs_Message
name: Message
nameWithType: CapyEventArgs.Message
fullName: CapyKit.CapyEventArgs.Message
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.CapyEventArgs.MethodName*
commentId: Overload:CapyKit.CapyEventArgs.MethodName
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs_MethodName
name: MethodName
nameWithType: CapyEventArgs.MethodName
fullName: CapyKit.CapyEventArgs.MethodName
- uid: CapyKit.CapyEventArgs.#ctor*
commentId: Overload:CapyKit.CapyEventArgs.#ctor
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_
name: CapyEventArgs
nameWithType: CapyEventArgs.CapyEventArgs
fullName: CapyKit.CapyEventArgs.CapyEventArgs
nameWithType.vb: CapyEventArgs.New
fullName.vb: CapyKit.CapyEventArgs.New
name.vb: New

View file

@ -0,0 +1,22 @@
# <a id="CapyKit_CapyEventHandler"></a> Delegate CapyEventHandler
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
A delegate representing an event handler that accepts a <xref href="CapyKit.CapyEventArgs" data-throw-if-not-resolved="false"></xref> instance.
```csharp
public delegate void CapyEventHandler(CapyEventArgs e)
```
#### Parameters
`e` [CapyEventArgs](CapyKit.CapyEventArgs.md)
The CapyEventArgs instance containing event data.
#### Extension Methods
[ObjectExtensions.UpdateProperties<CapyEventHandler\>\(CapyEventHandler, CapyEventHandler\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)

View file

@ -1,253 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.CapyEventHandler
commentId: T:CapyKit.CapyEventHandler
id: CapyEventHandler
parent: CapyKit
children: []
langs:
- csharp
- vb
name: CapyEventHandler
nameWithType: CapyEventHandler
fullName: CapyKit.CapyEventHandler
type: Delegate
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CapyEventHandler
path: ../CapyKit/CapyEvent.cs
startLine: 157
assemblies:
- CapyKit
namespace: CapyKit
summary: A delegate representing an event handler that accepts a <xref href="CapyKit.CapyEventArgs" data-throw-if-not-resolved="false"></xref> instance.
example: []
syntax:
content: public delegate void CapyEventHandler(CapyEventArgs e)
parameters:
- id: e
type: CapyKit.CapyEventArgs
description: The CapyEventArgs instance containing event data.
content.vb: Public Delegate Sub CapyEventHandler(e As CapyEventArgs)
extensionMethods:
- CapyKit.CapyEventHandler.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
references:
- uid: CapyKit.CapyEventArgs
commentId: T:CapyKit.CapyEventArgs
parent: CapyKit
href: CapyKit.CapyEventArgs.html
name: CapyEventArgs
nameWithType: CapyEventArgs
fullName: CapyKit.CapyEventArgs
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: CapyKit.CapyEventHandler.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<CapyEventHandler>(CapyEventHandler, CapyEventHandler)
nameWithType: ObjectExtensions.UpdateProperties<CapyEventHandler>(CapyEventHandler, CapyEventHandler)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.CapyEventHandler>(CapyKit.CapyEventHandler, CapyKit.CapyEventHandler)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of CapyEventHandler)(CapyEventHandler, CapyEventHandler)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.CapyEventHandler)(CapyKit.CapyEventHandler, CapyKit.CapyEventHandler)
name.vb: UpdateProperties(Of CapyEventHandler)(CapyEventHandler, CapyEventHandler)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler,CapyKit.CapyEventHandler)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
href: CapyKit.CapyEventHandler.html
- name: '>'
- name: (
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
href: CapyKit.CapyEventHandler.html
- name: ','
- name: " "
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
href: CapyKit.CapyEventHandler.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler,CapyKit.CapyEventHandler)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
href: CapyKit.CapyEventHandler.html
- name: )
- name: (
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
href: CapyKit.CapyEventHandler.html
- name: ','
- name: " "
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
href: CapyKit.CapyEventHandler.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html

View file

@ -0,0 +1,167 @@
# <a id="CapyKit_CapyEventReporter"></a> Class CapyEventReporter
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
```csharp
public static class CapyEventReporter
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CapyEventReporter](CapyKit.CapyEventReporter.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Remarks
Because consumers of CapyKit may have varied ways of handling logging, the <xref href="CapyKit.CapyEventReporter" data-throw-if-not-resolved="false"></xref> provides
a way for subscribers to recieve events for various "events" within the library. These can be thought of as
a logging solution for CapyKit. Consumers are free to treat these events however they see fit.
## Methods
### <a id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___"></a> EmitEvent\(EventLevel, string, string, params object\[\]\)
Emits an event with the given severity level, message, and method name.
```csharp
public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
```
#### Parameters
`eventLevel` [EventLevel](CapyKit.EventLevel.md)
The severity level of the event.
`message` [string](https://learn.microsoft.com/dotnet/api/system.string)
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
is accepted.
`method` [string](https://learn.microsoft.com/dotnet/api/system.string)
(Optional) The name of the method where the event was raised.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
A variable-length parameters list containing arguments for formatting the message.
#### Examples
<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>
#### Remarks
In order to allow for efficient calling member access via <xref href="System.Runtime.CompilerServices.CallerMemberNameAttribute" data-throw-if-not-resolved="false"></xref>
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.
#### See Also
[CallerMemberNameAttribute](https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute)
### <a id="CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___"></a> EmitEventOnce\(EventLevel, string, string, string, params object\[\]\)
Emits an event with the given severity level, message, unique identifier, and method name one
time.
```csharp
public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
```
#### Parameters
`eventLevel` [EventLevel](CapyKit.EventLevel.md)
The severity level of the event.
`message` [string](https://learn.microsoft.com/dotnet/api/system.string)
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
is accepted.
`uniqueIdentifier` [string](https://learn.microsoft.com/dotnet/api/system.string)
A unique identifier for the event emission.
`method` [string](https://learn.microsoft.com/dotnet/api/system.string)
(Optional) The name of the method where the event was raised.
`args` [object](https://learn.microsoft.com/dotnet/api/system.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 <xref href="System.Guid" data-throw-if-not-resolved="false"></xref>) to prevent duplicate
emissions.
#### See Also
[CallerMemberNameAttribute](https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute),
[Guid](https://learn.microsoft.com/dotnet/api/system.guid)
### <a id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_"></a> Subscribe\(CapyEventHandler, EventLevel, string\)
Subscribes the specified event handler to the event with the given subscription level and
origin.
```csharp
public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
```
#### Parameters
`callback` [CapyEventHandler](CapyKit.CapyEventHandler.md)
The event handler to subscribe.
`subscriptionLevel` [EventLevel](CapyKit.EventLevel.md)
The severity level of the event to subscribe to.
`origin` [string](https://learn.microsoft.com/dotnet/api/system.string)
(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.
### <a id="CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_"></a> Unsubscribe\(CapyEventHandler, string\)
Unsubscribes the specified event handler from the event with the given origin.
```csharp
public static void Unsubscribe(CapyEventHandler callback, string origin)
```
#### Parameters
`callback` [CapyEventHandler](CapyKit.CapyEventHandler.md)
The event handler to unsubscribe.
`origin` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the method or class where the subscription was made.

View file

@ -1,591 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.CapyEventReporter
commentId: T:CapyKit.CapyEventReporter
id: CapyEventReporter
parent: CapyKit
children:
- CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
- CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
- CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
- CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)
langs:
- csharp
- vb
name: CapyEventReporter
nameWithType: CapyEventReporter
fullName: CapyKit.CapyEventReporter
type: Class
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CapyEventReporter
path: ../CapyKit/CapyEvent.cs
startLine: 19
assemblies:
- CapyKit
namespace: CapyKit
summary: The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
remarks: >-
Because consumers of CapyKit may have varied ways of handling logging, the <xref href="CapyKit.CapyEventReporter" data-throw-if-not-resolved="false"></xref> 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.
example: []
syntax:
content: public static class CapyEventReporter
content.vb: Public Module CapyEventReporter
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
commentId: M:CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
id: Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
parent: CapyKit.CapyEventReporter
langs:
- csharp
- vb
name: Subscribe(CapyEventHandler, EventLevel, string)
nameWithType: CapyEventReporter.Subscribe(CapyEventHandler, EventLevel, string)
fullName: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler, CapyKit.EventLevel, string)
type: Method
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Subscribe
path: ../CapyKit/CapyEvent.cs
startLine: 49
assemblies:
- CapyKit
namespace: CapyKit
summary: >-
Subscribes the specified event handler to the event with the given subscription level and
origin.
remarks: >-
If there is no existing list for the given subscription level, a new list is created and
added to the dictionary.
example: []
syntax:
content: public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
parameters:
- id: callback
type: CapyKit.CapyEventHandler
description: The event handler to subscribe.
- id: subscriptionLevel
type: CapyKit.EventLevel
description: The severity level of the event to subscribe to.
- id: origin
type: System.String
description: (Optional) The name of the method or class where the subscription is made.
content.vb: Public Shared Sub Subscribe(callback As CapyEventHandler, subscriptionLevel As EventLevel, origin As String = Nothing)
overload: CapyKit.CapyEventReporter.Subscribe*
nameWithType.vb: CapyEventReporter.Subscribe(CapyEventHandler, EventLevel, String)
fullName.vb: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler, CapyKit.EventLevel, String)
name.vb: Subscribe(CapyEventHandler, EventLevel, String)
- uid: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)
commentId: M:CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)
id: Unsubscribe(CapyKit.CapyEventHandler,System.String)
parent: CapyKit.CapyEventReporter
langs:
- csharp
- vb
name: Unsubscribe(CapyEventHandler, string)
nameWithType: CapyEventReporter.Unsubscribe(CapyEventHandler, string)
fullName: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler, string)
type: Method
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Unsubscribe
path: ../CapyKit/CapyEvent.cs
startLine: 66
assemblies:
- CapyKit
namespace: CapyKit
summary: Unsubscribes the specified event handler from the event with the given origin.
example: []
syntax:
content: public static void Unsubscribe(CapyEventHandler callback, string origin)
parameters:
- id: callback
type: CapyKit.CapyEventHandler
description: The event handler to unsubscribe.
- id: origin
type: System.String
description: The name of the method or class where the subscription was made.
content.vb: Public Shared Sub Unsubscribe(callback As CapyEventHandler, origin As String)
overload: CapyKit.CapyEventReporter.Unsubscribe*
nameWithType.vb: CapyEventReporter.Unsubscribe(CapyEventHandler, String)
fullName.vb: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler, String)
name.vb: Unsubscribe(CapyEventHandler, String)
- uid: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
commentId: M:CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
id: EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
parent: CapyKit.CapyEventReporter
langs:
- csharp
- vb
name: EmitEvent(EventLevel, string, string, params object[])
nameWithType: CapyEventReporter.EmitEvent(EventLevel, string, string, params object[])
fullName: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel, string, string, params object[])
type: Method
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EmitEvent
path: ../CapyKit/CapyEvent.cs
startLine: 99
assemblies:
- CapyKit
namespace: CapyKit
summary: Emits an event with the given severity level, message, and method name.
remarks: >-
In order to allow for efficient calling member access via <xref href="System.Runtime.CompilerServices.CallerMemberNameAttribute" data-throw-if-not-resolved="false"></xref>
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.
example:
- '<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>'
syntax:
content: public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
parameters:
- id: eventLevel
type: CapyKit.EventLevel
description: The severity level of the event.
- id: message
type: System.String
description: >-
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
is accepted.
- id: method
type: System.String
description: (Optional) The name of the method where the event was raised.
- id: args
type: System.Object[]
description: A variable-length parameters list containing arguments for formatting the message.
content.vb: Public Shared Sub EmitEvent(eventLevel As EventLevel, message As String, method As String = Nothing, ParamArray args As Object())
overload: CapyKit.CapyEventReporter.EmitEvent*
seealso:
- linkId: System.Runtime.CompilerServices.CallerMemberNameAttribute
commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute
nameWithType.vb: CapyEventReporter.EmitEvent(EventLevel, String, String, ParamArray Object())
fullName.vb: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel, String, String, ParamArray Object())
name.vb: EmitEvent(EventLevel, String, String, ParamArray Object())
- uid: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
commentId: M:CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
id: EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
parent: CapyKit.CapyEventReporter
langs:
- csharp
- vb
name: EmitEventOnce(EventLevel, string, string, string, params object[])
nameWithType: CapyEventReporter.EmitEventOnce(EventLevel, string, string, string, params object[])
fullName: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel, string, string, string, params object[])
type: Method
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EmitEventOnce
path: ../CapyKit/CapyEvent.cs
startLine: 139
assemblies:
- CapyKit
namespace: CapyKit
summary: >-
Emits an event with the given severity level, message, unique identifier, and method name one
time.
remarks: >-
This method is similar to EmitEvent(EventLevel, string, string, string, object[])
, but requires a unique identifier (such as a <xref href="System.Guid" data-throw-if-not-resolved="false"></xref>) to prevent duplicate
emissions.
example: []
syntax:
content: public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
parameters:
- id: eventLevel
type: CapyKit.EventLevel
description: The severity level of the event.
- id: message
type: System.String
description: >-
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
is accepted.
- id: uniqueIdentifier
type: System.String
description: A unique identifier for the event emission.
- id: method
type: System.String
description: (Optional) The name of the method where the event was raised.
- id: args
type: System.Object[]
description: A variable-length parameters list containing arguments for formatting the message.
content.vb: Public Shared Sub EmitEventOnce(eventLevel As EventLevel, message As String, uniqueIdentifier As String, method As String = Nothing, ParamArray args As Object())
overload: CapyKit.CapyEventReporter.EmitEventOnce*
seealso:
- linkId: System.Runtime.CompilerServices.CallerMemberNameAttribute
commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute
- linkId: System.Guid
commentId: T:System.Guid
nameWithType.vb: CapyEventReporter.EmitEventOnce(EventLevel, String, String, String, ParamArray Object())
fullName.vb: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel, String, String, String, ParamArray Object())
name.vb: EmitEventOnce(EventLevel, String, String, String, ParamArray Object())
references:
- uid: CapyKit.CapyEventReporter
commentId: T:CapyKit.CapyEventReporter
href: CapyKit.CapyEventReporter.html
name: CapyEventReporter
nameWithType: CapyEventReporter
fullName: CapyKit.CapyEventReporter
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.CapyEventReporter.Subscribe*
commentId: Overload:CapyKit.CapyEventReporter.Subscribe
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_
name: Subscribe
nameWithType: CapyEventReporter.Subscribe
fullName: CapyKit.CapyEventReporter.Subscribe
- uid: CapyKit.CapyEventHandler
commentId: T:CapyKit.CapyEventHandler
parent: CapyKit
href: CapyKit.CapyEventHandler.html
name: CapyEventHandler
nameWithType: CapyEventHandler
fullName: CapyKit.CapyEventHandler
- uid: CapyKit.EventLevel
commentId: T:CapyKit.EventLevel
parent: CapyKit
href: CapyKit.EventLevel.html
name: EventLevel
nameWithType: EventLevel
fullName: CapyKit.EventLevel
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.CapyEventReporter.Unsubscribe*
commentId: Overload:CapyKit.CapyEventReporter.Unsubscribe
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_
name: Unsubscribe
nameWithType: CapyEventReporter.Unsubscribe
fullName: CapyKit.CapyEventReporter.Unsubscribe
- uid: System.Runtime.CompilerServices.CallerMemberNameAttribute
commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute
name: CallerMemberNameAttribute
nameWithType: CallerMemberNameAttribute
fullName: System.Runtime.CompilerServices.CallerMemberNameAttribute
- uid: CapyKit.CapyEventReporter.EmitEvent*
commentId: Overload:CapyKit.CapyEventReporter.EmitEvent
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___
name: EmitEvent
nameWithType: CapyEventReporter.EmitEvent
fullName: CapyKit.CapyEventReporter.EmitEvent
- uid: System.Object[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object[]
nameWithType: object[]
fullName: object[]
nameWithType.vb: Object()
fullName.vb: Object()
name.vb: Object()
spec.csharp:
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '['
- name: ']'
spec.vb:
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: (
- name: )
- uid: System.Guid
commentId: T:System.Guid
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.guid
name: Guid
nameWithType: Guid
fullName: System.Guid
- uid: CapyKit.CapyEventReporter.EmitEventOnce*
commentId: Overload:CapyKit.CapyEventReporter.EmitEventOnce
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___
name: EmitEventOnce
nameWithType: CapyEventReporter.EmitEventOnce
fullName: CapyKit.CapyEventReporter.EmitEventOnce

31
Docs/api/CapyKit.Color.md Normal file
View file

@ -0,0 +1,31 @@
# <a id="CapyKit_Color"></a> Class Color
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
An object representing a color.
```csharp
public class Color
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Color](CapyKit.Color.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<Color\>\(Color, Color\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)

View file

@ -1,489 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Color
commentId: T:CapyKit.Color
id: Color
parent: CapyKit
children: []
langs:
- csharp
- vb
name: Color
nameWithType: Color
fullName: CapyKit.Color
type: Class
source:
remote:
path: CapyKit/Color.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Color
path: ../CapyKit/Color.cs
startLine: 9
assemblies:
- CapyKit
namespace: CapyKit
summary: An object representing a color.
example: []
syntax:
content: public class Color
content.vb: Public Class Color
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- CapyKit.Color.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.Color.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<Color>(Color, Color)
nameWithType: ObjectExtensions.UpdateProperties<Color>(Color, Color)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Color>(CapyKit.Color, CapyKit.Color)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of Color)(Color, Color)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Color)(CapyKit.Color, CapyKit.Color)
name.vb: UpdateProperties(Of Color)(Color, Color)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color,CapyKit.Color)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Color
name: Color
href: CapyKit.Color.html
- name: '>'
- name: (
- uid: CapyKit.Color
name: Color
href: CapyKit.Color.html
- name: ','
- name: " "
- uid: CapyKit.Color
name: Color
href: CapyKit.Color.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color,CapyKit.Color)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Color
name: Color
href: CapyKit.Color.html
- name: )
- name: (
- uid: CapyKit.Color
name: Color
href: CapyKit.Color.html
- name: ','
- name: " "
- uid: CapyKit.Color
name: Color
href: CapyKit.Color.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html

View file

@ -0,0 +1,45 @@
# <a id="CapyKit_EncryptedValue_1"></a> Class EncryptedValue<T\>
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
```csharp
public class EncryptedValue<T>
```
#### Type Parameters
`T`
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[EncryptedValue<T\>](CapyKit.EncryptedValue\-1.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<EncryptedValue<T\>\>\(EncryptedValue<T\>, EncryptedValue<T\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Properties
### <a id="CapyKit_EncryptedValue_1_Value"></a> Value
```csharp
public T Value { get; set; }
```
#### Property Value
T

View file

@ -1,566 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.EncryptedValue`1
commentId: T:CapyKit.EncryptedValue`1
id: EncryptedValue`1
parent: CapyKit
children:
- CapyKit.EncryptedValue`1.Value
langs:
- csharp
- vb
name: EncryptedValue<T>
nameWithType: EncryptedValue<T>
fullName: CapyKit.EncryptedValue<T>
type: Class
source:
remote:
path: CapyKit/EncryptedValue.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EncryptedValue
path: ../CapyKit/EncryptedValue.cs
startLine: 8
assemblies:
- CapyKit
namespace: CapyKit
syntax:
content: public class EncryptedValue<T>
typeParameters:
- id: T
content.vb: Public Class EncryptedValue(Of T)
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- CapyKit.EncryptedValue`1.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{{T}})
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
nameWithType.vb: EncryptedValue(Of T)
fullName.vb: CapyKit.EncryptedValue(Of T)
name.vb: EncryptedValue(Of T)
- uid: CapyKit.EncryptedValue`1.Value
commentId: P:CapyKit.EncryptedValue`1.Value
id: Value
parent: CapyKit.EncryptedValue`1
langs:
- csharp
- vb
name: Value
nameWithType: EncryptedValue<T>.Value
fullName: CapyKit.EncryptedValue<T>.Value
type: Property
source:
remote:
path: CapyKit/EncryptedValue.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Value
path: ../CapyKit/EncryptedValue.cs
startLine: 18
assemblies:
- CapyKit
namespace: CapyKit
syntax:
content: public T Value { get; set; }
parameters: []
return:
type: '{T}'
content.vb: Public Property Value As T
overload: CapyKit.EncryptedValue`1.Value*
nameWithType.vb: EncryptedValue(Of T).Value
fullName.vb: CapyKit.EncryptedValue(Of T).Value
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.EncryptedValue`1.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{{T}})
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<EncryptedValue<T>>(EncryptedValue<T>, EncryptedValue<T>)
nameWithType: ObjectExtensions.UpdateProperties<EncryptedValue<T>>(EncryptedValue<T>, EncryptedValue<T>)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.EncryptedValue<T>>(CapyKit.EncryptedValue<T>, CapyKit.EncryptedValue<T>)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of EncryptedValue(Of T))(EncryptedValue(Of T), EncryptedValue(Of T))
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.EncryptedValue(Of T))(CapyKit.EncryptedValue(Of T), CapyKit.EncryptedValue(Of T))
name.vb: UpdateProperties(Of EncryptedValue(Of T))(EncryptedValue(Of T), EncryptedValue(Of T))
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{`0},CapyKit.EncryptedValue{`0})
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: <
- name: T
- name: '>'
- name: '>'
- name: (
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: <
- name: T
- name: '>'
- name: ','
- name: " "
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: <
- name: T
- name: '>'
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{`0},CapyKit.EncryptedValue{`0})
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: )
- name: (
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: ','
- name: " "
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.EncryptedValue`1.Value*
commentId: Overload:CapyKit.EncryptedValue`1.Value
href: CapyKit.EncryptedValue-1.html#CapyKit_EncryptedValue_1_Value
name: Value
nameWithType: EncryptedValue<T>.Value
fullName: CapyKit.EncryptedValue<T>.Value
nameWithType.vb: EncryptedValue(Of T).Value
fullName.vb: CapyKit.EncryptedValue(Of T).Value
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T

View file

@ -0,0 +1,36 @@
# <a id="CapyKit_Enumerations_MeasurementSystem"></a> Enum MeasurementSystem
Namespace: [CapyKit.Enumerations](CapyKit.Enumerations.md)
Assembly: CapyKit.dll
An enumeration representing different measurement systems.
```csharp
public enum MeasurementSystem
```
#### Extension Methods
[EnumerationExtensions.GetDescription\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetDescription\_System\_Enum\_),
[EnumerationExtensions.GetName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetName\_System\_Enum\_),
[EnumerationExtensions.GetPrettyName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetPrettyName\_System\_Enum\_),
[EnumerationExtensions.GetValue\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetValue\_System\_Enum\_),
[EnumerationExtensions.Parse<MeasurementSystem\>\(MeasurementSystem, string\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_),
[EnumerationExtensions.Parse<MeasurementSystem\>\(MeasurementSystem, string, bool\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_System\_Boolean\_),
[ObjectExtensions.UpdateProperties<MeasurementSystem\>\(MeasurementSystem, MeasurementSystem\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Fields
`Imperial = 0`
The imperial measurement system.
`Metric = 1`
The metric measurement system.

View file

@ -1,774 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Enumerations.MeasurementSystem
commentId: T:CapyKit.Enumerations.MeasurementSystem
id: MeasurementSystem
parent: CapyKit.Enumerations
children:
- CapyKit.Enumerations.MeasurementSystem.Imperial
- CapyKit.Enumerations.MeasurementSystem.Metric
langs:
- csharp
- vb
name: MeasurementSystem
nameWithType: MeasurementSystem
fullName: CapyKit.Enumerations.MeasurementSystem
type: Enum
source:
remote:
path: CapyKit/Enumerations/MeasurementSystem.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: MeasurementSystem
path: ../CapyKit/Enumerations/MeasurementSystem.cs
startLine: 11
assemblies:
- CapyKit
namespace: CapyKit.Enumerations
summary: An enumeration representing different measurement systems.
example: []
syntax:
content: public enum MeasurementSystem
content.vb: Public Enum MeasurementSystem
extensionMethods:
- CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
- CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
- CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem)
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Enumerations.MeasurementSystem.Imperial
commentId: F:CapyKit.Enumerations.MeasurementSystem.Imperial
id: Imperial
parent: CapyKit.Enumerations.MeasurementSystem
langs:
- csharp
- vb
name: Imperial
nameWithType: MeasurementSystem.Imperial
fullName: CapyKit.Enumerations.MeasurementSystem.Imperial
type: Field
source:
remote:
path: CapyKit/Enumerations/MeasurementSystem.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Imperial
path: ../CapyKit/Enumerations/MeasurementSystem.cs
startLine: 14
assemblies:
- CapyKit
namespace: CapyKit.Enumerations
summary: The imperial measurement system.
example: []
syntax:
content: Imperial = 0
return:
type: CapyKit.Enumerations.MeasurementSystem
- uid: CapyKit.Enumerations.MeasurementSystem.Metric
commentId: F:CapyKit.Enumerations.MeasurementSystem.Metric
id: Metric
parent: CapyKit.Enumerations.MeasurementSystem
langs:
- csharp
- vb
name: Metric
nameWithType: MeasurementSystem.Metric
fullName: CapyKit.Enumerations.MeasurementSystem.Metric
type: Field
source:
remote:
path: CapyKit/Enumerations/MeasurementSystem.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Metric
path: ../CapyKit/Enumerations/MeasurementSystem.cs
startLine: 17
assemblies:
- CapyKit
namespace: CapyKit.Enumerations
summary: The metric measurement system.
example: []
syntax:
content: Metric = 1
return:
type: CapyKit.Enumerations.MeasurementSystem
references:
- uid: CapyKit.Enumerations
commentId: N:CapyKit.Enumerations
href: CapyKit.html
name: CapyKit.Enumerations
nameWithType: CapyKit.Enumerations
fullName: CapyKit.Enumerations
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Enumerations
name: Enumerations
href: CapyKit.Enumerations.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Enumerations
name: Enumerations
href: CapyKit.Enumerations.html
- uid: CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse<MeasurementSystem>(MeasurementSystem, string)
nameWithType: EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Enumerations.MeasurementSystem>(CapyKit.Enumerations.MeasurementSystem, string)
nameWithType.vb: EnumerationExtensions.Parse(Of MeasurementSystem)(MeasurementSystem, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Enumerations.MeasurementSystem)(CapyKit.Enumerations.MeasurementSystem, String)
name.vb: Parse(Of MeasurementSystem)(MeasurementSystem, String)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: <
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: '>'
- name: (
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
- name: (
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
name: Parse<MeasurementSystem>(MeasurementSystem, string, bool)
nameWithType: EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Enumerations.MeasurementSystem>(CapyKit.Enumerations.MeasurementSystem, string, bool)
nameWithType.vb: EnumerationExtensions.Parse(Of MeasurementSystem)(MeasurementSystem, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Enumerations.MeasurementSystem)(CapyKit.Enumerations.MeasurementSystem, String, Boolean)
name.vb: Parse(Of MeasurementSystem)(MeasurementSystem, String, Boolean)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: <
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: '>'
- name: (
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
- name: (
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
- uid: CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<MeasurementSystem>(MeasurementSystem, MeasurementSystem)
nameWithType: ObjectExtensions.UpdateProperties<MeasurementSystem>(MeasurementSystem, MeasurementSystem)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Enumerations.MeasurementSystem>(CapyKit.Enumerations.MeasurementSystem, CapyKit.Enumerations.MeasurementSystem)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of MeasurementSystem)(MeasurementSystem, MeasurementSystem)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Enumerations.MeasurementSystem)(CapyKit.Enumerations.MeasurementSystem, CapyKit.Enumerations.MeasurementSystem)
name.vb: UpdateProperties(Of MeasurementSystem)(MeasurementSystem, MeasurementSystem)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem,CapyKit.Enumerations.MeasurementSystem)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: '>'
- name: (
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: ','
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem,CapyKit.Enumerations.MeasurementSystem)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
- name: (
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: ','
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse<T>(T, string)
nameWithType: EnumerationExtensions.Parse<T>(T, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
name.vb: Parse(Of T)(T, String)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions
commentId: T:CapyKit.Extensions.EnumerationExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.EnumerationExtensions.html
name: EnumerationExtensions
nameWithType: EnumerationExtensions
fullName: CapyKit.Extensions.EnumerationExtensions
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
name: Parse<T>(T, string, bool)
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
name.vb: Parse(Of T)(T, String, Boolean)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.Enumerations.MeasurementSystem
commentId: T:CapyKit.Enumerations.MeasurementSystem
parent: CapyKit.Enumerations
href: CapyKit.Enumerations.MeasurementSystem.html
name: MeasurementSystem
nameWithType: MeasurementSystem
fullName: CapyKit.Enumerations.MeasurementSystem

View file

@ -0,0 +1,8 @@
# <a id="CapyKit_Enumerations"></a> Namespace CapyKit.Enumerations
### Enums
[MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)
An enumeration representing different measurement systems.

View file

@ -1,46 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Enumerations
commentId: N:CapyKit.Enumerations
id: CapyKit.Enumerations
children:
- CapyKit.Enumerations.MeasurementSystem
langs:
- csharp
- vb
name: CapyKit.Enumerations
nameWithType: CapyKit.Enumerations
fullName: CapyKit.Enumerations
type: Namespace
assemblies:
- CapyKit
references:
- uid: CapyKit.Enumerations.MeasurementSystem
commentId: T:CapyKit.Enumerations.MeasurementSystem
parent: CapyKit.Enumerations
href: CapyKit.Enumerations.MeasurementSystem.html
name: MeasurementSystem
nameWithType: MeasurementSystem
fullName: CapyKit.Enumerations.MeasurementSystem
- uid: CapyKit.Enumerations
commentId: N:CapyKit.Enumerations
href: CapyKit.html
name: CapyKit.Enumerations
nameWithType: CapyKit.Enumerations
fullName: CapyKit.Enumerations
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Enumerations
name: Enumerations
href: CapyKit.Enumerations.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Enumerations
name: Enumerations
href: CapyKit.Enumerations.html

View file

@ -0,0 +1,54 @@
# <a id="CapyKit_EventLevel"></a> Enum EventLevel
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
Enumeration representing different event level severity values.
```csharp
public enum EventLevel
```
#### Extension Methods
[EnumerationExtensions.GetDescription\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetDescription\_System\_Enum\_),
[EnumerationExtensions.GetName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetName\_System\_Enum\_),
[EnumerationExtensions.GetPrettyName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetPrettyName\_System\_Enum\_),
[EnumerationExtensions.GetValue\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetValue\_System\_Enum\_),
[EnumerationExtensions.Parse<EventLevel\>\(EventLevel, string\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_),
[EnumerationExtensions.Parse<EventLevel\>\(EventLevel, string, bool\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_System\_Boolean\_),
[ObjectExtensions.UpdateProperties<EventLevel\>\(EventLevel, EventLevel\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Fields
`Critical = 0`
Represents a critical error that requires immediate attention.
`Debug = 4`
Represents detailed messages that are typically used for debugging purposes.
`Error = 1`
Represents an error that prevents the normal execution of the application.
`Information = 3`
Represents informational messages that provide useful context to the consumer.
`Warning = 2`
Represents a warning indicating a non-critical issue that should be addressed.

View file

@ -1,910 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.EventLevel
commentId: T:CapyKit.EventLevel
id: EventLevel
parent: CapyKit
children:
- CapyKit.EventLevel.Critical
- CapyKit.EventLevel.Debug
- CapyKit.EventLevel.Error
- CapyKit.EventLevel.Information
- CapyKit.EventLevel.Warning
langs:
- csharp
- vb
name: EventLevel
nameWithType: EventLevel
fullName: CapyKit.EventLevel
type: Enum
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EventLevel
path: ../CapyKit/CapyEvent.cs
startLine: 204
assemblies:
- CapyKit
namespace: CapyKit
summary: Enumeration representing different event level severity values.
example: []
syntax:
content: public enum EventLevel
content.vb: Public Enum EventLevel
extensionMethods:
- CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
- CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
- CapyKit.EventLevel.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel)
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.EventLevel.Critical
commentId: F:CapyKit.EventLevel.Critical
id: Critical
parent: CapyKit.EventLevel
langs:
- csharp
- vb
name: Critical
nameWithType: EventLevel.Critical
fullName: CapyKit.EventLevel.Critical
type: Field
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Critical
path: ../CapyKit/CapyEvent.cs
startLine: 207
assemblies:
- CapyKit
namespace: CapyKit
summary: Represents a critical error that requires immediate attention.
example: []
syntax:
content: >-
[EnumerationDescription("Represents a critical error that requires immediate attention.")]
Critical = 0
return:
type: CapyKit.EventLevel
content.vb: >-
<EnumerationDescription("Represents a critical error that requires immediate attention.")>
Critical = 0
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: Represents a critical error that requires immediate attention.
- uid: CapyKit.EventLevel.Error
commentId: F:CapyKit.EventLevel.Error
id: Error
parent: CapyKit.EventLevel
langs:
- csharp
- vb
name: Error
nameWithType: EventLevel.Error
fullName: CapyKit.EventLevel.Error
type: Field
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Error
path: ../CapyKit/CapyEvent.cs
startLine: 210
assemblies:
- CapyKit
namespace: CapyKit
summary: Represents an error that prevents the normal execution of the application.
example: []
syntax:
content: >-
[EnumerationDescription("Represents an error that prevents the normal execution of the application.")]
Error = 1
return:
type: CapyKit.EventLevel
content.vb: >-
<EnumerationDescription("Represents an error that prevents the normal execution of the application.")>
Error = 1
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: Represents an error that prevents the normal execution of the application.
- uid: CapyKit.EventLevel.Warning
commentId: F:CapyKit.EventLevel.Warning
id: Warning
parent: CapyKit.EventLevel
langs:
- csharp
- vb
name: Warning
nameWithType: EventLevel.Warning
fullName: CapyKit.EventLevel.Warning
type: Field
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Warning
path: ../CapyKit/CapyEvent.cs
startLine: 213
assemblies:
- CapyKit
namespace: CapyKit
summary: Represents a warning indicating a non-critical issue that should be addressed.
example: []
syntax:
content: >-
[EnumerationDescription("Represents a warning indicating a non-critical issue that should be addressed.")]
Warning = 2
return:
type: CapyKit.EventLevel
content.vb: >-
<EnumerationDescription("Represents a warning indicating a non-critical issue that should be addressed.")>
Warning = 2
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: Represents a warning indicating a non-critical issue that should be addressed.
- uid: CapyKit.EventLevel.Information
commentId: F:CapyKit.EventLevel.Information
id: Information
parent: CapyKit.EventLevel
langs:
- csharp
- vb
name: Information
nameWithType: EventLevel.Information
fullName: CapyKit.EventLevel.Information
type: Field
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Information
path: ../CapyKit/CapyEvent.cs
startLine: 216
assemblies:
- CapyKit
namespace: CapyKit
summary: Represents informational messages that provide useful context to the consumer.
example: []
syntax:
content: >-
[EnumerationDescription("Represents informational messages that provide useful context to the consumer.")]
Information = 3
return:
type: CapyKit.EventLevel
content.vb: >-
<EnumerationDescription("Represents informational messages that provide useful context to the consumer.")>
Information = 3
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: Represents informational messages that provide useful context to the consumer.
- uid: CapyKit.EventLevel.Debug
commentId: F:CapyKit.EventLevel.Debug
id: Debug
parent: CapyKit.EventLevel
langs:
- csharp
- vb
name: Debug
nameWithType: EventLevel.Debug
fullName: CapyKit.EventLevel.Debug
type: Field
source:
remote:
path: CapyKit/CapyEvent.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Debug
path: ../CapyKit/CapyEvent.cs
startLine: 219
assemblies:
- CapyKit
namespace: CapyKit
summary: Represents detailed messages that are typically used for debugging purposes.
example: []
syntax:
content: >-
[EnumerationDescription("Represents detailed messages that are typically used for debugging purposes.")]
Debug = 4
return:
type: CapyKit.EventLevel
content.vb: >-
<EnumerationDescription("Represents detailed messages that are typically used for debugging purposes.")>
Debug = 4
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: Represents detailed messages that are typically used for debugging purposes.
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse<EventLevel>(EventLevel, string)
nameWithType: EnumerationExtensions.Parse<EventLevel>(EventLevel, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.EventLevel>(CapyKit.EventLevel, string)
nameWithType.vb: EnumerationExtensions.Parse(Of EventLevel)(EventLevel, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.EventLevel)(CapyKit.EventLevel, String)
name.vb: Parse(Of EventLevel)(EventLevel, String)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: <
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: '>'
- name: (
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: (
- name: Of
- name: " "
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: )
- name: (
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
name: Parse<EventLevel>(EventLevel, string, bool)
nameWithType: EnumerationExtensions.Parse<EventLevel>(EventLevel, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.EventLevel>(CapyKit.EventLevel, string, bool)
nameWithType.vb: EnumerationExtensions.Parse(Of EventLevel)(EventLevel, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.EventLevel)(CapyKit.EventLevel, String, Boolean)
name.vb: Parse(Of EventLevel)(EventLevel, String, Boolean)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: <
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: '>'
- name: (
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: (
- name: Of
- name: " "
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: )
- name: (
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
- uid: CapyKit.EventLevel.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<EventLevel>(EventLevel, EventLevel)
nameWithType: ObjectExtensions.UpdateProperties<EventLevel>(EventLevel, EventLevel)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.EventLevel>(CapyKit.EventLevel, CapyKit.EventLevel)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of EventLevel)(EventLevel, EventLevel)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.EventLevel)(CapyKit.EventLevel, CapyKit.EventLevel)
name.vb: UpdateProperties(Of EventLevel)(EventLevel, EventLevel)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel,CapyKit.EventLevel)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: '>'
- name: (
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: ','
- name: " "
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel,CapyKit.EventLevel)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: )
- name: (
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: ','
- name: " "
- uid: CapyKit.EventLevel
name: EventLevel
href: CapyKit.EventLevel.html
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse<T>(T, string)
nameWithType: EnumerationExtensions.Parse<T>(T, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
name.vb: Parse(Of T)(T, String)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions
commentId: T:CapyKit.Extensions.EnumerationExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.EnumerationExtensions.html
name: EnumerationExtensions
nameWithType: EnumerationExtensions
fullName: CapyKit.Extensions.EnumerationExtensions
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
name: Parse<T>(T, string, bool)
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
name.vb: Parse(Of T)(T, String, Boolean)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.EventLevel
commentId: T:CapyKit.EventLevel
parent: CapyKit
href: CapyKit.EventLevel.html
name: EventLevel
nameWithType: EventLevel
fullName: CapyKit.EventLevel

View file

@ -0,0 +1,176 @@
# <a id="CapyKit_Extensions_EnumerationExtensions"></a> Class EnumerationExtensions
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
Assembly: CapyKit.dll
Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
```csharp
public static class EnumerationExtensions
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[EnumerationExtensions](CapyKit.Extensions.EnumerationExtensions.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_"></a> GetDescription\(Enum\)
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a description.
```csharp
public static string GetDescription(this Enum enumeration)
```
#### Parameters
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
The enumeration to act on.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The description if available, otherwise the string representation of the enumeration.
### <a id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_"></a> GetName\(Enum\)
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a name.
```csharp
public static string GetName(this Enum enumeration)
```
#### Parameters
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
The enumeration to act on.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the enumeration.
### <a id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_"></a> GetPrettyName\(Enum\)
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a human readable name.
```csharp
public static string GetPrettyName(this Enum enumeration)
```
#### Parameters
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
The enumeration to act on.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The human readable name of the enumeration.
### <a id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_"></a> GetValue\(Enum\)
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets an integer value representing the enumation.
```csharp
public static int GetValue(this Enum enumeration)
```
#### Parameters
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
The enumeration to act on.
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
The integer value of the enumeration.
### <a id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_"></a> Parse<T\>\(T, string\)
A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
```csharp
public static T Parse<T>(this T enumeration, string value) where T : Enum
```
#### Parameters
`enumeration` T
The enumeration to act on.
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
The value.
#### Returns
T
A T.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_"></a> Parse<T\>\(T, string, bool\)
A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
```csharp
public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum
```
#### Parameters
`enumeration` T
The enumeration to act on.
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
The string value of the <xref href="System.Enum" data-throw-if-not-resolved="false"></xref>.
`ignoreCase` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
True to ignore case.
#### Returns
T
A T.
#### Type Parameters
`T`
Generic type parameter.

View file

@ -1,624 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Extensions.EnumerationExtensions
commentId: T:CapyKit.Extensions.EnumerationExtensions
id: EnumerationExtensions
parent: CapyKit.Extensions
children:
- CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
- CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
- CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
- CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
- CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
- CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
langs:
- csharp
- vb
name: EnumerationExtensions
nameWithType: EnumerationExtensions
fullName: CapyKit.Extensions.EnumerationExtensions
type: Class
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EnumerationExtensions
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 12
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
example: []
syntax:
content: public static class EnumerationExtensions
content.vb: Public Module EnumerationExtensions
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
id: Parse``1(``0,System.String)
isExtensionMethod: true
parent: CapyKit.Extensions.EnumerationExtensions
langs:
- csharp
- vb
name: Parse<T>(T, string)
nameWithType: EnumerationExtensions.Parse<T>(T, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
type: Method
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Parse
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 23
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
example: []
syntax:
content: 'public static T Parse<T>(this T enumeration, string value) where T : Enum'
parameters:
- id: enumeration
type: '{T}'
description: The enumeration to act on.
- id: value
type: System.String
description: The value.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A T.
content.vb: Public Shared Function Parse(Of T As [Enum])(enumeration As T, value As String) As T
overload: CapyKit.Extensions.EnumerationExtensions.Parse*
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
name.vb: Parse(Of T)(T, String)
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
id: Parse``1(``0,System.String,System.Boolean)
isExtensionMethod: true
parent: CapyKit.Extensions.EnumerationExtensions
langs:
- csharp
- vb
name: Parse<T>(T, string, bool)
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
type: Method
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Parse
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 36
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
example: []
syntax:
content: 'public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum'
parameters:
- id: enumeration
type: '{T}'
description: The enumeration to act on.
- id: value
type: System.String
description: The string value of the <xref href="System.Enum" data-throw-if-not-resolved="false"></xref>.
- id: ignoreCase
type: System.Boolean
description: True to ignore case.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A T.
content.vb: Public Shared Function Parse(Of T As [Enum])(enumeration As T, value As String, ignoreCase As Boolean) As T
overload: CapyKit.Extensions.EnumerationExtensions.Parse*
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
name.vb: Parse(Of T)(T, String, Boolean)
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
id: GetValue(System.Enum)
isExtensionMethod: true
parent: CapyKit.Extensions.EnumerationExtensions
langs:
- csharp
- vb
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
type: Method
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetValue
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 46
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets an integer value representing the enumation.
example: []
syntax:
content: public static int GetValue(this Enum enumeration)
parameters:
- id: enumeration
type: System.Enum
description: The enumeration to act on.
return:
type: System.Int32
description: The integer value of the enumeration.
content.vb: Public Shared Function GetValue(enumeration As [Enum]) As Integer
overload: CapyKit.Extensions.EnumerationExtensions.GetValue*
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
id: GetName(System.Enum)
isExtensionMethod: true
parent: CapyKit.Extensions.EnumerationExtensions
langs:
- csharp
- vb
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
type: Method
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetName
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 54
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a name.
example: []
syntax:
content: public static string GetName(this Enum enumeration)
parameters:
- id: enumeration
type: System.Enum
description: The enumeration to act on.
return:
type: System.String
description: The name of the enumeration.
content.vb: Public Shared Function GetName(enumeration As [Enum]) As String
overload: CapyKit.Extensions.EnumerationExtensions.GetName*
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
id: GetPrettyName(System.Enum)
isExtensionMethod: true
parent: CapyKit.Extensions.EnumerationExtensions
langs:
- csharp
- vb
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
type: Method
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetPrettyName
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 62
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a human readable name.
example: []
syntax:
content: public static string GetPrettyName(this Enum enumeration)
parameters:
- id: enumeration
type: System.Enum
description: The enumeration to act on.
return:
type: System.String
description: The human readable name of the enumeration.
content.vb: Public Shared Function GetPrettyName(enumeration As [Enum]) As String
overload: CapyKit.Extensions.EnumerationExtensions.GetPrettyName*
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
id: GetDescription(System.Enum)
isExtensionMethod: true
parent: CapyKit.Extensions.EnumerationExtensions
langs:
- csharp
- vb
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
type: Method
source:
remote:
path: CapyKit/Extensions/EnumerationExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetDescription
path: ../CapyKit/Extensions/EnumerationExtensions.cs
startLine: 72
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a description.
example: []
syntax:
content: public static string GetDescription(this Enum enumeration)
parameters:
- id: enumeration
type: System.Enum
description: The enumeration to act on.
return:
type: System.String
description: The description if available, otherwise the string representation of the enumeration.
content.vb: Public Shared Function GetDescription(enumeration As [Enum]) As String
overload: CapyKit.Extensions.EnumerationExtensions.GetDescription*
references:
- uid: System.Enum
commentId: T:System.Enum
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
name: Enum
nameWithType: Enum
fullName: System.Enum
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.EnumerationExtensions.Parse*
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse
nameWithType: EnumerationExtensions.Parse
fullName: CapyKit.Extensions.EnumerationExtensions.Parse
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: T
name: T
nameWithType: T
fullName: T
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue*
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue
nameWithType: EnumerationExtensions.GetValue
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.int32
name: int
nameWithType: int
fullName: int
nameWithType.vb: Integer
fullName.vb: Integer
name.vb: Integer
- uid: CapyKit.Extensions.EnumerationExtensions.GetName*
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName
nameWithType: EnumerationExtensions.GetName
fullName: CapyKit.Extensions.EnumerationExtensions.GetName
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName*
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName
nameWithType: EnumerationExtensions.GetPrettyName
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription*
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription
nameWithType: EnumerationExtensions.GetDescription
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription

View file

@ -0,0 +1,408 @@
# <a id="CapyKit_Extensions_LINQExtensions"></a> Class LINQExtensions
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
Assembly: CapyKit.dll
Provides static extension methods for performing common LINQ operations on <xref href="System.Collections.Generic.IEnumerable%601" data-throw-if-not-resolved="false"></xref> and <xref href="System.Linq.IQueryable%601" data-throw-if-not-resolved="false"></xref> collections.
```csharp
public static class LINQExtensions
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[LINQExtensions](CapyKit.Extensions.LINQExtensions.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Extensions_LINQExtensions_Distinct__2_System_Collections_Generic_IEnumerable___0__System_Func___0___1__"></a> Distinct<T, U\>\(IEnumerable<T\>, Func<T, U\>\)
Enumerates distinct items in this collection as defined by the key <code class="paramref">property</code>.
```csharp
public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)
```
#### Parameters
`items` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
The items to act on.
`property` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
The property.
#### Returns
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
An enumerator that allows foreach to be used to process distinct items in this collection.
#### Type Parameters
`T`
Generic type parameter of the parent object.
`U`
Generic type parameter property value.
### <a id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Collections_Generic_IEnumerable___0__System_Func___0_System_Boolean__"></a> Filter<T\>\(IEnumerable<T\>, Func<T, bool\>\)
Filters out items matching a <code class="paramref">predicate</code> from the collection.
```csharp
public static IEnumerable<T> Filter<T>(this IEnumerable<T> source, Func<T, bool> predicate)
```
#### Parameters
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
The source to act on.
`predicate` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, [bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>
The predicate.
#### Returns
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
An enumerator that allows foreach to be used to process remove in this collection.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Linq_IQueryable___0__System_Linq_Expressions_Expression_System_Func___0_System_Boolean___"></a> Filter<T\>\(IQueryable<T\>, Expression<Func<T, bool\>\>\)
Filters out items matching a <code class="paramref">predicate</code> from the collection.
```csharp
public static IQueryable<T> Filter<T>(this IQueryable<T> source, Expression<Func<T, bool>> predicate)
```
#### Parameters
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
The source to act on.
`predicate` [Expression](https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression\-1)<[Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, [bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>\>
The predicate.
#### Returns
[IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
An enumerator that allows foreach to be used to process remove in this collection.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_System_Linq_IQueryable___0__System_Linq_IQueryable___1__System_Linq_Expressions_Expression_System_Func___0___2___System_Linq_Expressions_Expression_System_Func___1___2___System_Func___0_System_Collections_Generic_IEnumerable___1____3__System_Func___0___1__"></a> 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&lt;T&gt; extension method that left outer join.
```csharp
public static IQueryable<R> LeftOuterJoin<T, U, TKey, R>(this IQueryable<T> source, IQueryable<U> inner, Expression<Func<T, TKey>> outerSelector, Expression<Func<U, TKey>> innerSelector, Func<T, IEnumerable<U>, R> resultSelector, Func<T, U> defaultGenerator = null)
```
#### Parameters
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
The source to act on.
`inner` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<U\>
The inner.
`outerSelector` [Expression](https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression\-1)<[Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, TKey\>\>
The outer selector.
`innerSelector` [Expression](https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression\-1)<[Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<U, TKey\>\>
The inner selector.
`resultSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-3)<T, [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<U\>, R\>
The result selector.
`defaultGenerator` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
(Optional) The default generator.
#### Returns
[IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<R\>
An IQueryable&lt;R&gt;
#### Type Parameters
`T`
Generic type parameter.
`U`
Generic type parameter.
`TKey`
Type of the key.
`R`
Type of the r.
### <a id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_System_Collections_Generic_IEnumerable___0__System_Collections_Generic_IEnumerable___1__System_Func___0___2__System_Func___1___2__System_Func___0_System_Collections_Generic_IEnumerable___1____3__System_Func___0___1__"></a> 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&lt;T&gt; extension method that left outer join.
```csharp
public static IEnumerable<R> LeftOuterJoin<T, U, TKey, R>(this IEnumerable<T> source, IEnumerable<U> inner, Func<T, TKey> outerSelector, Func<U, TKey> innerSelector, Func<T, IEnumerable<U>, R> resultSelector, Func<T, U> defaultGenerator = null)
```
#### Parameters
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
The source to act on.
`inner` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<U\>
The inner.
`outerSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, TKey\>
The outer selector.
`innerSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<U, TKey\>
The inner selector.
`resultSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-3)<T, [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<U\>, R\>
The result selector.
`defaultGenerator` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
(Optional) The default generator.
#### Returns
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<R\>
An enumerator that allows foreach to be used to process left outter join in this collection.
#### Type Parameters
`T`
Generic type parameter.
`U`
Generic type parameter.
`TKey`
Type of the key.
`R`
Type of the r.
### <a id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32_"></a> Page<T\>\(IEnumerable<T\>, int, int\)
Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
<code class="paramref">pageSize</code> items per page.
```csharp
public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)
```
#### Parameters
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
The source to act on.
`pageNumber` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The page number to retrieve.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Number of items per page.
#### Returns
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
An enumerator that allows foreach to be used to process page in this collection.
#### Type Parameters
`T`
Generic type parameter.
#### Remarks
This method uses natural numbering starting at page 1.
#### Exceptions
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
<code class="paramref">pageSize</code> is less than
<code>1</code>.
### <a id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32_"></a> Page<T\>\(IQueryable<T\>, int, int\)
Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
<code class="paramref">pageSize</code> items per page.
```csharp
public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)
```
#### Parameters
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
The source to act on.
`pageNumber` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The page number to retrieve.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
.
#### Returns
[IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
An enumerator that allows foreach to be used to process page in this collection.
#### Type Parameters
`T`
Generic type parameter.
#### Remarks
This method uses natural numbering starting at page 1.
#### Exceptions
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
<code class="paramref">pageSize</code> is less than
<code>1</code>.
### <a id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Collections_Generic_IEnumerable___0__System_Int32_"></a> PageCount<T\>\(IEnumerable<T\>, int\)
The number of pages of <code class="paramref">pageSize</code> size in the given collection.
```csharp
public static int PageCount<T>(this IEnumerable<T> source, int pageSize)
```
#### Parameters
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
The source to act on.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Size of the page.
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
An int.
#### Type Parameters
`T`
Generic type parameter.
#### Exceptions
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.
### <a id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Linq_IQueryable___0__System_Int32_"></a> PageCount<T\>\(IQueryable<T\>, int\)
The number of pages of <code class="paramref">pageSize</code> size in the given collection.
```csharp
public static int PageCount<T>(this IQueryable<T> source, int pageSize)
```
#### Parameters
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
The source to act on.
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
Size of the page.
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
An int.
#### Type Parameters
`T`
Generic type parameter.
#### Exceptions
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,76 @@
# <a id="CapyKit_Extensions_ObjectExtensions"></a> Class ObjectExtensions
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
Assembly: CapyKit.dll
An class containing extenstions that apply to any object type.
```csharp
public static class ObjectExtensions
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[ObjectExtensions](CapyKit.Extensions.ObjectExtensions.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_"></a> UpdateProperties<T\>\(T, T\)
An object extension method that updates the properties of a given <code class="paramref">target</code>
object with the values from a given <code class="paramref">source</code> object.
```csharp
public static void UpdateProperties<T>(this T target, T source)
```
#### Parameters
`target` T
The target object to act on.
`source` T
Source for the new property values.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_"></a> UpdateProperties\(object, object\)
An object extension method that updates the properties of a given <code class="paramref">target</code>
object with the values from a given <code class="paramref">source</code> object.
```csharp
public static void UpdateProperties(this object target, object source)
```
#### Parameters
`target` [object](https://learn.microsoft.com/dotnet/api/system.object)
The target object to act on.
`source` [object](https://learn.microsoft.com/dotnet/api/system.object)
Source for the new property values.

View file

@ -1,405 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
id: ObjectExtensions
parent: CapyKit.Extensions
children:
- CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
- CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
langs:
- csharp
- vb
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
type: Class
source:
remote:
path: CapyKit/Extensions/ObjectExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: ObjectExtensions
path: ../CapyKit/Extensions/ObjectExtensions.cs
startLine: 9
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: An class containing extenstions that apply to any object type.
example: []
syntax:
content: public static class ObjectExtensions
content.vb: Public Module ObjectExtensions
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
id: UpdateProperties``1(``0,``0)
isExtensionMethod: true
parent: CapyKit.Extensions.ObjectExtensions
langs:
- csharp
- vb
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
type: Method
source:
remote:
path: CapyKit/Extensions/ObjectExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: UpdateProperties
path: ../CapyKit/Extensions/ObjectExtensions.cs
startLine: 18
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: >-
An object extension method that updates the properties of a given <code class="paramref">target</code>
object with the values from a given <code class="paramref">source</code> object.
example: []
syntax:
content: public static void UpdateProperties<T>(this T target, T source)
parameters:
- id: target
type: '{T}'
description: The target object to act on.
- id: source
type: '{T}'
description: Source for the new property values.
typeParameters:
- id: T
description: Generic type parameter.
content.vb: Public Shared Sub UpdateProperties(Of T)(target As T, source As T)
overload: CapyKit.Extensions.ObjectExtensions.UpdateProperties*
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
id: UpdateProperties(System.Object,System.Object)
isExtensionMethod: true
parent: CapyKit.Extensions.ObjectExtensions
langs:
- csharp
- vb
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
type: Method
source:
remote:
path: CapyKit/Extensions/ObjectExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: UpdateProperties
path: ../CapyKit/Extensions/ObjectExtensions.cs
startLine: 36
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: >-
An object extension method that updates the properties of a given <code class="paramref">target</code>
object with the values from a given <code class="paramref">source</code> object.
example: []
syntax:
content: public static void UpdateProperties(this object target, object source)
parameters:
- id: target
type: System.Object
description: The target object to act on.
- id: source
type: System.Object
description: Source for the new property values.
content.vb: Public Shared Sub UpdateProperties(target As Object, source As Object)
overload: CapyKit.Extensions.ObjectExtensions.UpdateProperties*
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
references:
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties*
commentId: Overload:CapyKit.Extensions.ObjectExtensions.UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties
nameWithType: ObjectExtensions.UpdateProperties
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T

View file

@ -0,0 +1,88 @@
# <a id="CapyKit_Extensions_StringExtensions"></a> Class StringExtensions
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
Assembly: CapyKit.dll
Provides static extentions methods for providing additional functionality for <xref href="System.String" data-throw-if-not-resolved="false"></xref> types.
```csharp
public static class StringExtensions
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[StringExtensions](CapyKit.Extensions.StringExtensions.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_"></a> IfNullOrEmpty\(string, string\)
Replaces a null or empty string with a specified replacement string.
```csharp
public static string IfNullOrEmpty(this string value, string replacement)
```
#### Parameters
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
The original string.
`replacement` [string](https://learn.microsoft.com/dotnet/api/system.string)
The replacement string.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The original string if not null or empty, otherwise the replacement string.
#### See Also
[string](https://learn.microsoft.com/dotnet/api/system.string).[IsNullOrEmpty](https://learn.microsoft.com/dotnet/api/system.string.isnullorempty)\([string](https://learn.microsoft.com/dotnet/api/system.string)?\)
### <a id="CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_"></a> IfNullOrWhiteSpace\(string, string\)
Replaces a null or whitespace string with a specified replacement string.
```csharp
public static string IfNullOrWhiteSpace(this string value, string replacement)
```
#### Parameters
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
The original string.
`replacement` [string](https://learn.microsoft.com/dotnet/api/system.string)
The replacement string.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The original string if not null or whitespace, otherwise the replacement string.
#### See Also
[string](https://learn.microsoft.com/dotnet/api/system.string).[IsNullOrWhiteSpace](https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace)\([string](https://learn.microsoft.com/dotnet/api/system.string)?\)

View file

@ -1,479 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Extensions.StringExtensions
commentId: T:CapyKit.Extensions.StringExtensions
id: StringExtensions
parent: CapyKit.Extensions
children:
- CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)
- CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)
langs:
- csharp
- vb
name: StringExtensions
nameWithType: StringExtensions
fullName: CapyKit.Extensions.StringExtensions
type: Class
source:
remote:
path: CapyKit/Extensions/StringExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: StringExtensions
path: ../CapyKit/Extensions/StringExtensions.cs
startLine: 9
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: Provides static extentions methods for providing additional functionality for <xref href="System.String" data-throw-if-not-resolved="false"></xref> types.
example: []
syntax:
content: public static class StringExtensions
content.vb: Public Module StringExtensions
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)
commentId: M:CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)
id: IfNullOrEmpty(System.String,System.String)
isExtensionMethod: true
parent: CapyKit.Extensions.StringExtensions
langs:
- csharp
- vb
name: IfNullOrEmpty(string, string)
nameWithType: StringExtensions.IfNullOrEmpty(string, string)
fullName: CapyKit.Extensions.StringExtensions.IfNullOrEmpty(string, string)
type: Method
source:
remote:
path: CapyKit/Extensions/StringExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: IfNullOrEmpty
path: ../CapyKit/Extensions/StringExtensions.cs
startLine: 26
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: Replaces a null or empty string with a specified replacement string.
example: []
syntax:
content: public static string IfNullOrEmpty(this string value, string replacement)
parameters:
- id: value
type: System.String
description: The original string.
- id: replacement
type: System.String
description: The replacement string.
return:
type: System.String
description: The original string if not null or empty, otherwise the replacement string.
content.vb: Public Shared Function IfNullOrEmpty(value As String, replacement As String) As String
overload: CapyKit.Extensions.StringExtensions.IfNullOrEmpty*
seealso:
- linkId: System.String.IsNullOrEmpty(System.String)
commentId: M:System.String.IsNullOrEmpty(System.String)
nameWithType.vb: StringExtensions.IfNullOrEmpty(String, String)
fullName.vb: CapyKit.Extensions.StringExtensions.IfNullOrEmpty(String, String)
name.vb: IfNullOrEmpty(String, String)
- uid: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)
commentId: M:CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)
id: IfNullOrWhiteSpace(System.String,System.String)
isExtensionMethod: true
parent: CapyKit.Extensions.StringExtensions
langs:
- csharp
- vb
name: IfNullOrWhiteSpace(string, string)
nameWithType: StringExtensions.IfNullOrWhiteSpace(string, string)
fullName: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(string, string)
type: Method
source:
remote:
path: CapyKit/Extensions/StringExtensions.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: IfNullOrWhiteSpace
path: ../CapyKit/Extensions/StringExtensions.cs
startLine: 43
assemblies:
- CapyKit
namespace: CapyKit.Extensions
summary: Replaces a null or whitespace string with a specified replacement string.
example: []
syntax:
content: public static string IfNullOrWhiteSpace(this string value, string replacement)
parameters:
- id: value
type: System.String
description: The original string.
- id: replacement
type: System.String
description: The replacement string.
return:
type: System.String
description: The original string if not null or whitespace, otherwise the replacement string.
content.vb: Public Shared Function IfNullOrWhiteSpace(value As String, replacement As String) As String
overload: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace*
seealso:
- linkId: System.String.IsNullOrWhiteSpace(System.String)
commentId: M:System.String.IsNullOrWhiteSpace(System.String)
nameWithType.vb: StringExtensions.IfNullOrWhiteSpace(String, String)
fullName.vb: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(String, String)
name.vb: IfNullOrWhiteSpace(String, String)
references:
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: System.String.IsNullOrEmpty(System.String)
commentId: M:System.String.IsNullOrEmpty(System.String)
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorempty
name: IsNullOrEmpty(string)
nameWithType: string.IsNullOrEmpty(string)
fullName: string.IsNullOrEmpty(string)
nameWithType.vb: String.IsNullOrEmpty(String)
fullName.vb: String.IsNullOrEmpty(String)
name.vb: IsNullOrEmpty(String)
spec.csharp:
- uid: System.String.IsNullOrEmpty(System.String)
name: IsNullOrEmpty
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorempty
- name: (
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: System.String.IsNullOrEmpty(System.String)
name: IsNullOrEmpty
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorempty
- name: (
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Extensions.StringExtensions.IfNullOrEmpty*
commentId: Overload:CapyKit.Extensions.StringExtensions.IfNullOrEmpty
href: CapyKit.Extensions.StringExtensions.html#CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_
name: IfNullOrEmpty
nameWithType: StringExtensions.IfNullOrEmpty
fullName: CapyKit.Extensions.StringExtensions.IfNullOrEmpty
- uid: System.String.IsNullOrWhiteSpace(System.String)
commentId: M:System.String.IsNullOrWhiteSpace(System.String)
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace
name: IsNullOrWhiteSpace(string)
nameWithType: string.IsNullOrWhiteSpace(string)
fullName: string.IsNullOrWhiteSpace(string)
nameWithType.vb: String.IsNullOrWhiteSpace(String)
fullName.vb: String.IsNullOrWhiteSpace(String)
name.vb: IsNullOrWhiteSpace(String)
spec.csharp:
- uid: System.String.IsNullOrWhiteSpace(System.String)
name: IsNullOrWhiteSpace
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace
- name: (
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: System.String.IsNullOrWhiteSpace(System.String)
name: IsNullOrWhiteSpace
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace
- name: (
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace*
commentId: Overload:CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace
href: CapyKit.Extensions.StringExtensions.html#CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_
name: IfNullOrWhiteSpace
nameWithType: StringExtensions.IfNullOrWhiteSpace
fullName: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace

View file

@ -0,0 +1,20 @@
# <a id="CapyKit_Extensions"></a> Namespace CapyKit.Extensions
### Classes
[EnumerationExtensions](CapyKit.Extensions.EnumerationExtensions.md)
Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
[LINQExtensions](CapyKit.Extensions.LINQExtensions.md)
Provides static extension methods for performing common LINQ operations on <xref href="System.Collections.Generic.IEnumerable%601" data-throw-if-not-resolved="false"></xref> and <xref href="System.Linq.IQueryable%601" data-throw-if-not-resolved="false"></xref> collections.
[ObjectExtensions](CapyKit.Extensions.ObjectExtensions.md)
An class containing extenstions that apply to any object type.
[StringExtensions](CapyKit.Extensions.StringExtensions.md)
Provides static extentions methods for providing additional functionality for <xref href="System.String" data-throw-if-not-resolved="false"></xref> types.

View file

@ -1,68 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
id: CapyKit.Extensions
children:
- CapyKit.Extensions.EnumerationExtensions
- CapyKit.Extensions.LINQExtensions
- CapyKit.Extensions.ObjectExtensions
- CapyKit.Extensions.StringExtensions
langs:
- csharp
- vb
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
type: Namespace
assemblies:
- CapyKit
references:
- uid: CapyKit.Extensions.EnumerationExtensions
commentId: T:CapyKit.Extensions.EnumerationExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.EnumerationExtensions.html
name: EnumerationExtensions
nameWithType: EnumerationExtensions
fullName: CapyKit.Extensions.EnumerationExtensions
- uid: CapyKit.Extensions.LINQExtensions
commentId: T:CapyKit.Extensions.LINQExtensions
href: CapyKit.Extensions.LINQExtensions.html
name: LINQExtensions
nameWithType: LINQExtensions
fullName: CapyKit.Extensions.LINQExtensions
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.StringExtensions
commentId: T:CapyKit.Extensions.StringExtensions
href: CapyKit.Extensions.StringExtensions.html
name: StringExtensions
nameWithType: StringExtensions
fullName: CapyKit.Extensions.StringExtensions
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html

View file

@ -0,0 +1,269 @@
# <a id="CapyKit_Helpers_CalculationHelper"></a> Class CalculationHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
Static class providing helper methods for various calculations.
```csharp
public static class CalculationHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CalculationHelper](CapyKit.Helpers.CalculationHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Fields
### <a id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS"></a> EARTH\_RADIUS\_KILOMETERS
The earth's radius in kilometers.
```csharp
public const int EARTH_RADIUS_KILOMETERS = 6371
```
#### Field Value
[int](https://learn.microsoft.com/dotnet/api/system.int32)
### <a id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER"></a> MILES\_PER\_KILOMETER
Ratio of miles per kilometer .
```csharp
public const double MILES_PER_KILOMETER = 0.621371
```
#### Field Value
[double](https://learn.microsoft.com/dotnet/api/system.double)
## Methods
### <a id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_"></a> CalculateHash\(string\)
Calculates the hash of a given string using an <xref href="System.Security.Cryptography.MD5" data-throw-if-not-resolved="false"></xref> value as the first 32 bits.
```csharp
public static int CalculateHash(string str)
```
#### Parameters
`str` [string](https://learn.microsoft.com/dotnet/api/system.string)
The string to be hashed.
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
The calculated hash.
#### Remarks
This method is used for a quick and consistent hash function. It should not be considered
cryptographically sound or used in security contexts.
### <a id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_"></a> CalculateHexHash\(string\)
Calculates the hexadecimal hash.
```csharp
public static string CalculateHexHash(string str)
```
#### Parameters
`str` [string](https://learn.microsoft.com/dotnet/api/system.string)
The string to be hashed.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The calculated 16 character hexadecimal hash.
### <a id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_"></a> DegreesToRadians\(double\)
Convers degrees to radians.
```csharp
public static double DegreesToRadians(double degrees)
```
#### Parameters
`degrees` [double](https://learn.microsoft.com/dotnet/api/system.double)
The degree value.
#### Returns
[double](https://learn.microsoft.com/dotnet/api/system.double)
The value as radians.
### <a id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_"></a> GetDistance\(decimal, decimal, decimal, decimal, MeasurementSystem\)
Gets the distance between two points on earth using the <code>haversine</code> formula.
```csharp
public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
```
#### Parameters
`latitudeOrigin` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
The latitude origin.
`longitudeOrigin` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
The longitude origin.
`latitudeDestination` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
The latitude destination.
`longitudeDestination` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
The longitude destination.
`measurementSystem` [MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)
(Optional) The measurement system.
#### Returns
[decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
The distance.
#### Remarks
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
to calculate the "as-the-crow-flies" distance between two points on earth.
#### See Also
[CalculationHelper](CapyKit.Helpers.CalculationHelper.md).[GetDistance](CapyKit.Helpers.CalculationHelper.md\#CapyKit\_Helpers\_CalculationHelper\_GetDistance\_System\_Double\_System\_Double\_System\_Double\_System\_Double\_CapyKit\_Enumerations\_MeasurementSystem\_)\([double](https://learn.microsoft.com/dotnet/api/system.double), [double](https://learn.microsoft.com/dotnet/api/system.double), [double](https://learn.microsoft.com/dotnet/api/system.double), [double](https://learn.microsoft.com/dotnet/api/system.double), [MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)\)
### <a id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_"></a> GetDistance\(double, double, double, double, MeasurementSystem\)
Gets the distance between two points on earth using the <code>haversine</code> formula.
```csharp
public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
```
#### Parameters
`latitudeOrigin` [double](https://learn.microsoft.com/dotnet/api/system.double)
The latitude of the origin.
`longitudeOrigin` [double](https://learn.microsoft.com/dotnet/api/system.double)
The longitude of the origin.
`latitudeDestination` [double](https://learn.microsoft.com/dotnet/api/system.double)
The latitude destination.
`longitudeDestination` [double](https://learn.microsoft.com/dotnet/api/system.double)
The longitude destination.
`measurementSystem` [MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)
(Optional) The measurement system.
#### Returns
[double](https://learn.microsoft.com/dotnet/api/system.double)
The distance.
#### Remarks
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
to calculate the "as-the-crow-flies" distance between two points on earth.
### <a id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_"></a> KilometersToMiles\(double\)
Converts kilometers to miles.
```csharp
public static double KilometersToMiles(double kilometers)
```
#### Parameters
`kilometers` [double](https://learn.microsoft.com/dotnet/api/system.double)
The value in kilometers.
#### Returns
[double](https://learn.microsoft.com/dotnet/api/system.double)
The value in miles.
### <a id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_"></a> MilesToKilometers\(double\)
Converts miles to kilometers.
```csharp
public static double MilesToKilometers(double miles)
```
#### Parameters
`miles` [double](https://learn.microsoft.com/dotnet/api/system.double)
The value in miles.
#### Returns
[double](https://learn.microsoft.com/dotnet/api/system.double)
The value in kilometers.
### <a id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_"></a> RadiansToDegrees\(double\)
Converts radians to degrees.
```csharp
public static double RadiansToDegrees(double radians)
```
#### Parameters
`radians` [double](https://learn.microsoft.com/dotnet/api/system.double)
The radian value.
#### Returns
[double](https://learn.microsoft.com/dotnet/api/system.double)
The value as degrees.

View file

@ -1,909 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.CalculationHelper
commentId: T:CapyKit.Helpers.CalculationHelper
id: CalculationHelper
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)
- CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)
- CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)
- CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
- CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
- CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
- CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)
- CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
- CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)
- CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)
langs:
- csharp
- vb
name: CalculationHelper
nameWithType: CalculationHelper
fullName: CapyKit.Helpers.CalculationHelper
type: Class
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CalculationHelper
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 11
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Static class providing helper methods for various calculations.
example: []
syntax:
content: public static class CalculationHelper
content.vb: Public Module CalculationHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
commentId: F:CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
id: EARTH_RADIUS_KILOMETERS
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: EARTH_RADIUS_KILOMETERS
nameWithType: CalculationHelper.EARTH_RADIUS_KILOMETERS
fullName: CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
type: Field
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EARTH_RADIUS_KILOMETERS
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 16
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: The earth's radius in kilometers.
example: []
syntax:
content: public const int EARTH_RADIUS_KILOMETERS = 6371
return:
type: System.Int32
content.vb: Public Const EARTH_RADIUS_KILOMETERS As Integer = 6371
- uid: CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
commentId: F:CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
id: MILES_PER_KILOMETER
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: MILES_PER_KILOMETER
nameWithType: CalculationHelper.MILES_PER_KILOMETER
fullName: CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
type: Field
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: MILES_PER_KILOMETER
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 19
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Ratio of miles per kilometer .
example: []
syntax:
content: public const double MILES_PER_KILOMETER = 0.621371
return:
type: System.Double
content.vb: Public Const MILES_PER_KILOMETER As Double = 0.621371
- uid: CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)
commentId: M:CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)
id: CalculateHash(System.String)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: CalculateHash(string)
nameWithType: CalculationHelper.CalculateHash(string)
fullName: CapyKit.Helpers.CalculationHelper.CalculateHash(string)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CalculateHash
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 37
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Calculates the hash of a given string using an <xref href="System.Security.Cryptography.MD5" data-throw-if-not-resolved="false"></xref> value as the first 32 bits.
remarks: >-
This method is used for a quick and consistent hash function. It should not be considered
cryptographically sound or used in security contexts.
example: []
syntax:
content: public static int CalculateHash(string str)
parameters:
- id: str
type: System.String
description: The string to be hashed.
return:
type: System.Int32
description: The calculated hash.
content.vb: Public Shared Function CalculateHash(str As String) As Integer
overload: CapyKit.Helpers.CalculationHelper.CalculateHash*
nameWithType.vb: CalculationHelper.CalculateHash(String)
fullName.vb: CapyKit.Helpers.CalculationHelper.CalculateHash(String)
name.vb: CalculateHash(String)
- uid: CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)
commentId: M:CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)
id: CalculateHexHash(System.String)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: CalculateHexHash(string)
nameWithType: CalculationHelper.CalculateHexHash(string)
fullName: CapyKit.Helpers.CalculationHelper.CalculateHexHash(string)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CalculateHexHash
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 49
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Calculates the hexadecimal hash.
example: []
syntax:
content: public static string CalculateHexHash(string str)
parameters:
- id: str
type: System.String
description: The string to be hashed.
return:
type: System.String
description: The calculated 16 character hexadecimal hash.
content.vb: Public Shared Function CalculateHexHash(str As String) As String
overload: CapyKit.Helpers.CalculationHelper.CalculateHexHash*
nameWithType.vb: CalculationHelper.CalculateHexHash(String)
fullName.vb: CapyKit.Helpers.CalculationHelper.CalculateHexHash(String)
name.vb: CalculateHexHash(String)
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
id: GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)
nameWithType: CalculationHelper.GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)
fullName: CapyKit.Helpers.CalculationHelper.GetDistance(decimal, decimal, decimal, decimal, CapyKit.Enumerations.MeasurementSystem)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetDistance
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 82
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Gets the distance between two points on earth using the <code>haversine</code> formula.
remarks: >-
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
to calculate the "as-the-crow-flies" distance between two points on earth.
example: []
syntax:
content: public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
parameters:
- id: latitudeOrigin
type: System.Decimal
description: The latitude origin.
- id: longitudeOrigin
type: System.Decimal
description: The longitude origin.
- id: latitudeDestination
type: System.Decimal
description: The latitude destination.
- id: longitudeDestination
type: System.Decimal
description: The longitude destination.
- id: measurementSystem
type: CapyKit.Enumerations.MeasurementSystem
description: (Optional) The measurement system.
return:
type: System.Decimal
description: The distance.
content.vb: Public Shared Function GetDistance(latitudeOrigin As Decimal, longitudeOrigin As Decimal, latitudeDestination As Decimal, longitudeDestination As Decimal, measurementSystem As MeasurementSystem = MeasurementSystem.Imperial) As Decimal
overload: CapyKit.Helpers.CalculationHelper.GetDistance*
seealso:
- linkId: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
nameWithType.vb: CalculationHelper.GetDistance(Decimal, Decimal, Decimal, Decimal, MeasurementSystem)
fullName.vb: CapyKit.Helpers.CalculationHelper.GetDistance(Decimal, Decimal, Decimal, Decimal, CapyKit.Enumerations.MeasurementSystem)
name.vb: GetDistance(Decimal, Decimal, Decimal, Decimal, MeasurementSystem)
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
id: GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: GetDistance(double, double, double, double, MeasurementSystem)
nameWithType: CalculationHelper.GetDistance(double, double, double, double, MeasurementSystem)
fullName: CapyKit.Helpers.CalculationHelper.GetDistance(double, double, double, double, CapyKit.Enumerations.MeasurementSystem)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetDistance
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 105
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Gets the distance between two points on earth using the <code>haversine</code> formula.
remarks: >-
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
to calculate the "as-the-crow-flies" distance between two points on earth.
example: []
syntax:
content: public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
parameters:
- id: latitudeOrigin
type: System.Double
description: The latitude of the origin.
- id: longitudeOrigin
type: System.Double
description: The longitude of the origin.
- id: latitudeDestination
type: System.Double
description: The latitude destination.
- id: longitudeDestination
type: System.Double
description: The longitude destination.
- id: measurementSystem
type: CapyKit.Enumerations.MeasurementSystem
description: (Optional) The measurement system.
return:
type: System.Double
description: The distance.
content.vb: Public Shared Function GetDistance(latitudeOrigin As Double, longitudeOrigin As Double, latitudeDestination As Double, longitudeDestination As Double, measurementSystem As MeasurementSystem = MeasurementSystem.Imperial) As Double
overload: CapyKit.Helpers.CalculationHelper.GetDistance*
nameWithType.vb: CalculationHelper.GetDistance(Double, Double, Double, Double, MeasurementSystem)
fullName.vb: CapyKit.Helpers.CalculationHelper.GetDistance(Double, Double, Double, Double, CapyKit.Enumerations.MeasurementSystem)
name.vb: GetDistance(Double, Double, Double, Double, MeasurementSystem)
- uid: CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)
commentId: M:CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)
id: KilometersToMiles(System.Double)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: KilometersToMiles(double)
nameWithType: CalculationHelper.KilometersToMiles(double)
fullName: CapyKit.Helpers.CalculationHelper.KilometersToMiles(double)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: KilometersToMiles
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 128
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Converts kilometers to miles.
example: []
syntax:
content: public static double KilometersToMiles(double kilometers)
parameters:
- id: kilometers
type: System.Double
description: The value in kilometers.
return:
type: System.Double
description: The value in miles.
content.vb: Public Shared Function KilometersToMiles(kilometers As Double) As Double
overload: CapyKit.Helpers.CalculationHelper.KilometersToMiles*
nameWithType.vb: CalculationHelper.KilometersToMiles(Double)
fullName.vb: CapyKit.Helpers.CalculationHelper.KilometersToMiles(Double)
name.vb: KilometersToMiles(Double)
- uid: CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)
commentId: M:CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)
id: MilesToKilometers(System.Double)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: MilesToKilometers(double)
nameWithType: CalculationHelper.MilesToKilometers(double)
fullName: CapyKit.Helpers.CalculationHelper.MilesToKilometers(double)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: MilesToKilometers
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 136
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Converts miles to kilometers.
example: []
syntax:
content: public static double MilesToKilometers(double miles)
parameters:
- id: miles
type: System.Double
description: The value in miles.
return:
type: System.Double
description: The value in kilometers.
content.vb: Public Shared Function MilesToKilometers(miles As Double) As Double
overload: CapyKit.Helpers.CalculationHelper.MilesToKilometers*
nameWithType.vb: CalculationHelper.MilesToKilometers(Double)
fullName.vb: CapyKit.Helpers.CalculationHelper.MilesToKilometers(Double)
name.vb: MilesToKilometers(Double)
- uid: CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)
commentId: M:CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)
id: DegreesToRadians(System.Double)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: DegreesToRadians(double)
nameWithType: CalculationHelper.DegreesToRadians(double)
fullName: CapyKit.Helpers.CalculationHelper.DegreesToRadians(double)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: DegreesToRadians
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 144
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Convers degrees to radians.
example: []
syntax:
content: public static double DegreesToRadians(double degrees)
parameters:
- id: degrees
type: System.Double
description: The degree value.
return:
type: System.Double
description: The value as radians.
content.vb: Public Shared Function DegreesToRadians(degrees As Double) As Double
overload: CapyKit.Helpers.CalculationHelper.DegreesToRadians*
nameWithType.vb: CalculationHelper.DegreesToRadians(Double)
fullName.vb: CapyKit.Helpers.CalculationHelper.DegreesToRadians(Double)
name.vb: DegreesToRadians(Double)
- uid: CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)
commentId: M:CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)
id: RadiansToDegrees(System.Double)
parent: CapyKit.Helpers.CalculationHelper
langs:
- csharp
- vb
name: RadiansToDegrees(double)
nameWithType: CalculationHelper.RadiansToDegrees(double)
fullName: CapyKit.Helpers.CalculationHelper.RadiansToDegrees(double)
type: Method
source:
remote:
path: CapyKit/Helpers/CalculationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: RadiansToDegrees
path: ../CapyKit/Helpers/CalculationHelper.cs
startLine: 152
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Converts radians to degrees.
example: []
syntax:
content: public static double RadiansToDegrees(double radians)
parameters:
- id: radians
type: System.Double
description: The radian value.
return:
type: System.Double
description: The value as degrees.
content.vb: Public Shared Function RadiansToDegrees(radians As Double) As Double
overload: CapyKit.Helpers.CalculationHelper.RadiansToDegrees*
nameWithType.vb: CalculationHelper.RadiansToDegrees(Double)
fullName.vb: CapyKit.Helpers.CalculationHelper.RadiansToDegrees(Double)
name.vb: RadiansToDegrees(Double)
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.int32
name: int
nameWithType: int
fullName: int
nameWithType.vb: Integer
fullName.vb: Integer
name.vb: Integer
- uid: System.Double
commentId: T:System.Double
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
name: double
nameWithType: double
fullName: double
nameWithType.vb: Double
fullName.vb: Double
name.vb: Double
- uid: System.Security.Cryptography.MD5
commentId: T:System.Security.Cryptography.MD5
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.security.cryptography.md5
name: MD5
nameWithType: MD5
fullName: System.Security.Cryptography.MD5
- uid: CapyKit.Helpers.CalculationHelper.CalculateHash*
commentId: Overload:CapyKit.Helpers.CalculationHelper.CalculateHash
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_
name: CalculateHash
nameWithType: CalculationHelper.CalculateHash
fullName: CapyKit.Helpers.CalculationHelper.CalculateHash
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.Helpers.CalculationHelper.CalculateHexHash*
commentId: Overload:CapyKit.Helpers.CalculationHelper.CalculateHexHash
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_
name: CalculateHexHash
nameWithType: CalculationHelper.CalculateHexHash
fullName: CapyKit.Helpers.CalculationHelper.CalculateHexHash
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
isExternal: true
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_
name: GetDistance(double, double, double, double, MeasurementSystem)
nameWithType: CalculationHelper.GetDistance(double, double, double, double, MeasurementSystem)
fullName: CapyKit.Helpers.CalculationHelper.GetDistance(double, double, double, double, CapyKit.Enumerations.MeasurementSystem)
nameWithType.vb: CalculationHelper.GetDistance(Double, Double, Double, Double, MeasurementSystem)
fullName.vb: CapyKit.Helpers.CalculationHelper.GetDistance(Double, Double, Double, Double, CapyKit.Enumerations.MeasurementSystem)
name.vb: GetDistance(Double, Double, Double, Double, MeasurementSystem)
spec.csharp:
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
name: GetDistance
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_
- name: (
- uid: System.Double
name: double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: System.Double
name: double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: System.Double
name: double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: System.Double
name: double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
spec.vb:
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
name: GetDistance
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_
- name: (
- uid: System.Double
name: Double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: System.Double
name: Double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: System.Double
name: Double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: System.Double
name: Double
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.double
- name: ','
- name: " "
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.html
- name: )
- uid: CapyKit.Helpers.CalculationHelper.GetDistance*
commentId: Overload:CapyKit.Helpers.CalculationHelper.GetDistance
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_
name: GetDistance
nameWithType: CalculationHelper.GetDistance
fullName: CapyKit.Helpers.CalculationHelper.GetDistance
- uid: System.Decimal
commentId: T:System.Decimal
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.decimal
name: decimal
nameWithType: decimal
fullName: decimal
nameWithType.vb: Decimal
fullName.vb: Decimal
name.vb: Decimal
- uid: CapyKit.Enumerations.MeasurementSystem
commentId: T:CapyKit.Enumerations.MeasurementSystem
parent: CapyKit.Enumerations
href: CapyKit.Enumerations.MeasurementSystem.html
name: MeasurementSystem
nameWithType: MeasurementSystem
fullName: CapyKit.Enumerations.MeasurementSystem
- uid: CapyKit.Enumerations
commentId: N:CapyKit.Enumerations
href: CapyKit.html
name: CapyKit.Enumerations
nameWithType: CapyKit.Enumerations
fullName: CapyKit.Enumerations
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Enumerations
name: Enumerations
href: CapyKit.Enumerations.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Enumerations
name: Enumerations
href: CapyKit.Enumerations.html
- uid: CapyKit.Helpers.CalculationHelper.KilometersToMiles*
commentId: Overload:CapyKit.Helpers.CalculationHelper.KilometersToMiles
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_
name: KilometersToMiles
nameWithType: CalculationHelper.KilometersToMiles
fullName: CapyKit.Helpers.CalculationHelper.KilometersToMiles
- uid: CapyKit.Helpers.CalculationHelper.MilesToKilometers*
commentId: Overload:CapyKit.Helpers.CalculationHelper.MilesToKilometers
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_
name: MilesToKilometers
nameWithType: CalculationHelper.MilesToKilometers
fullName: CapyKit.Helpers.CalculationHelper.MilesToKilometers
- uid: CapyKit.Helpers.CalculationHelper.DegreesToRadians*
commentId: Overload:CapyKit.Helpers.CalculationHelper.DegreesToRadians
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_
name: DegreesToRadians
nameWithType: CalculationHelper.DegreesToRadians
fullName: CapyKit.Helpers.CalculationHelper.DegreesToRadians
- uid: CapyKit.Helpers.CalculationHelper.RadiansToDegrees*
commentId: Overload:CapyKit.Helpers.CalculationHelper.RadiansToDegrees
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_
name: RadiansToDegrees
nameWithType: CalculationHelper.RadiansToDegrees
fullName: CapyKit.Helpers.CalculationHelper.RadiansToDegrees

View file

@ -0,0 +1,144 @@
# <a id="CapyKit_Helpers_CompressionHelper"></a> Class CompressionHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
A class that contains methods for managing data compression.
```csharp
public static class CompressionHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[CompressionHelper](CapyKit.Helpers.CompressionHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Helpers_CompressionHelper_Compress_System_Object_"></a> Compress\(object\)
Compresses a given object using the <code>gzip</code> algorithm.
```csharp
public static byte[] Compress(object obj)
```
#### Parameters
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
The object.
#### Returns
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
A byte array representing the compressed object in <code>gzip</code> format.
### <a id="CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_"></a> CompressToString\(object\)
Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.
```csharp
public static string CompressToString(object obj)
```
#### Parameters
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
The object.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A string in <code>base64</code> encoding.
### <a id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_"></a> Decompress<T\>\(string\)
Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.
```csharp
public static T Decompress<T>(string encodedString)
```
#### Parameters
`encodedString` [string](https://learn.microsoft.com/dotnet/api/system.string)
The <code>base64</code> encoded <code>gzip</code> string.
#### Returns
T
A <code class="typeparamref">T</code> typed object.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_Byte___"></a> Decompress<T\>\(byte\[\]\)
Decompresses a given compressed <code>gzip</code> byte stream.
```csharp
public static T Decompress<T>(byte[] byteStream)
```
#### Parameters
`byteStream` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
The compressed byte stream.
#### Returns
T
A <code class="typeparamref">T</code> typed object.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_"></a> DecompressToString\(string\)
Decompresses the given <code>base64</code> string in <code>gzip</code> format.
```csharp
public static string DecompressToString(string compressed)
```
#### Parameters
`compressed` [string](https://learn.microsoft.com/dotnet/api/system.string)
The compressed string.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A decomressed string.

View file

@ -1,569 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.CompressionHelper
commentId: T:CapyKit.Helpers.CompressionHelper
id: CompressionHelper
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.CompressionHelper.Compress(System.Object)
- CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
- CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
- CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
- CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
langs:
- csharp
- vb
name: CompressionHelper
nameWithType: CompressionHelper
fullName: CapyKit.Helpers.CompressionHelper
type: Class
source:
remote:
path: CapyKit/Helpers/CompressionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CompressionHelper
path: ../CapyKit/Helpers/CompressionHelper.cs
startLine: 10
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: A class that contains methods for managing data compression.
example: []
syntax:
content: public static class CompressionHelper
content.vb: Public Module CompressionHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Helpers.CompressionHelper.Compress(System.Object)
commentId: M:CapyKit.Helpers.CompressionHelper.Compress(System.Object)
id: Compress(System.Object)
parent: CapyKit.Helpers.CompressionHelper
langs:
- csharp
- vb
name: Compress(object)
nameWithType: CompressionHelper.Compress(object)
fullName: CapyKit.Helpers.CompressionHelper.Compress(object)
type: Method
source:
remote:
path: CapyKit/Helpers/CompressionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Compress
path: ../CapyKit/Helpers/CompressionHelper.cs
startLine: 23
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Compresses a given object using the <code>gzip</code> algorithm.
example: []
syntax:
content: public static byte[] Compress(object obj)
parameters:
- id: obj
type: System.Object
description: The object.
return:
type: System.Byte[]
description: A byte array representing the compressed object in <code>gzip</code> format.
content.vb: Public Shared Function Compress(obj As Object) As Byte()
overload: CapyKit.Helpers.CompressionHelper.Compress*
nameWithType.vb: CompressionHelper.Compress(Object)
fullName.vb: CapyKit.Helpers.CompressionHelper.Compress(Object)
name.vb: Compress(Object)
- uid: CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
commentId: M:CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
id: CompressToString(System.Object)
parent: CapyKit.Helpers.CompressionHelper
langs:
- csharp
- vb
name: CompressToString(object)
nameWithType: CompressionHelper.CompressToString(object)
fullName: CapyKit.Helpers.CompressionHelper.CompressToString(object)
type: Method
source:
remote:
path: CapyKit/Helpers/CompressionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CompressToString
path: ../CapyKit/Helpers/CompressionHelper.cs
startLine: 51
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.
example: []
syntax:
content: public static string CompressToString(object obj)
parameters:
- id: obj
type: System.Object
description: The object.
return:
type: System.String
description: A string in <code>base64</code> encoding.
content.vb: Public Shared Function CompressToString(obj As Object) As String
overload: CapyKit.Helpers.CompressionHelper.CompressToString*
nameWithType.vb: CompressionHelper.CompressToString(Object)
fullName.vb: CapyKit.Helpers.CompressionHelper.CompressToString(Object)
name.vb: CompressToString(Object)
- uid: CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
commentId: M:CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
id: Decompress``1(System.String)
parent: CapyKit.Helpers.CompressionHelper
langs:
- csharp
- vb
name: Decompress<T>(string)
nameWithType: CompressionHelper.Decompress<T>(string)
fullName: CapyKit.Helpers.CompressionHelper.Decompress<T>(string)
type: Method
source:
remote:
path: CapyKit/Helpers/CompressionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Decompress
path: ../CapyKit/Helpers/CompressionHelper.cs
startLine: 61
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.
example: []
syntax:
content: public static T Decompress<T>(string encodedString)
parameters:
- id: encodedString
type: System.String
description: The <code>base64</code> encoded <code>gzip</code> string.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A <code class="typeparamref">T</code> typed object.
content.vb: Public Shared Function Decompress(Of T)(encodedString As String) As T
overload: CapyKit.Helpers.CompressionHelper.Decompress*
nameWithType.vb: CompressionHelper.Decompress(Of T)(String)
fullName.vb: CapyKit.Helpers.CompressionHelper.Decompress(Of T)(String)
name.vb: Decompress(Of T)(String)
- uid: CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
commentId: M:CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
id: Decompress``1(System.Byte[])
parent: CapyKit.Helpers.CompressionHelper
langs:
- csharp
- vb
name: Decompress<T>(byte[])
nameWithType: CompressionHelper.Decompress<T>(byte[])
fullName: CapyKit.Helpers.CompressionHelper.Decompress<T>(byte[])
type: Method
source:
remote:
path: CapyKit/Helpers/CompressionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Decompress
path: ../CapyKit/Helpers/CompressionHelper.cs
startLine: 71
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Decompresses a given compressed <code>gzip</code> byte stream.
example: []
syntax:
content: public static T Decompress<T>(byte[] byteStream)
parameters:
- id: byteStream
type: System.Byte[]
description: The compressed byte stream.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A <code class="typeparamref">T</code> typed object.
content.vb: Public Shared Function Decompress(Of T)(byteStream As Byte()) As T
overload: CapyKit.Helpers.CompressionHelper.Decompress*
nameWithType.vb: CompressionHelper.Decompress(Of T)(Byte())
fullName.vb: CapyKit.Helpers.CompressionHelper.Decompress(Of T)(Byte())
name.vb: Decompress(Of T)(Byte())
- uid: CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
commentId: M:CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
id: DecompressToString(System.String)
parent: CapyKit.Helpers.CompressionHelper
langs:
- csharp
- vb
name: DecompressToString(string)
nameWithType: CompressionHelper.DecompressToString(string)
fullName: CapyKit.Helpers.CompressionHelper.DecompressToString(string)
type: Method
source:
remote:
path: CapyKit/Helpers/CompressionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: DecompressToString
path: ../CapyKit/Helpers/CompressionHelper.cs
startLine: 96
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Decompresses the given <code>base64</code> string in <code>gzip</code> format.
example: []
syntax:
content: public static string DecompressToString(string compressed)
parameters:
- id: compressed
type: System.String
description: The compressed string.
return:
type: System.String
description: A decomressed string.
content.vb: Public Shared Function DecompressToString(compressed As String) As String
overload: CapyKit.Helpers.CompressionHelper.DecompressToString*
nameWithType.vb: CompressionHelper.DecompressToString(String)
fullName.vb: CapyKit.Helpers.CompressionHelper.DecompressToString(String)
name.vb: DecompressToString(String)
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Helpers.CompressionHelper.Compress*
commentId: Overload:CapyKit.Helpers.CompressionHelper.Compress
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_Compress_System_Object_
name: Compress
nameWithType: CompressionHelper.Compress
fullName: CapyKit.Helpers.CompressionHelper.Compress
- uid: System.Byte[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
name: byte[]
nameWithType: byte[]
fullName: byte[]
nameWithType.vb: Byte()
fullName.vb: Byte()
name.vb: Byte()
spec.csharp:
- uid: System.Byte
name: byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: '['
- name: ']'
spec.vb:
- uid: System.Byte
name: Byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: (
- name: )
- uid: CapyKit.Helpers.CompressionHelper.CompressToString*
commentId: Overload:CapyKit.Helpers.CompressionHelper.CompressToString
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_
name: CompressToString
nameWithType: CompressionHelper.CompressToString
fullName: CapyKit.Helpers.CompressionHelper.CompressToString
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.Helpers.CompressionHelper.Decompress*
commentId: Overload:CapyKit.Helpers.CompressionHelper.Decompress
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_
name: Decompress
nameWithType: CompressionHelper.Decompress
fullName: CapyKit.Helpers.CompressionHelper.Decompress
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T
- uid: CapyKit.Helpers.CompressionHelper.DecompressToString*
commentId: Overload:CapyKit.Helpers.CompressionHelper.DecompressToString
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_
name: DecompressToString
nameWithType: CompressionHelper.DecompressToString
fullName: CapyKit.Helpers.CompressionHelper.DecompressToString

View file

@ -0,0 +1,41 @@
# <a id="CapyKit_Helpers_EncryptionHelper"></a> Class EncryptionHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
```csharp
public class EncryptionHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[EncryptionHelper](CapyKit.Helpers.EncryptionHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<EncryptionHelper\>\(EncryptionHelper, EncryptionHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Helpers_EncryptionHelper__ctor_System_String_"></a> EncryptionHelper\(string\)
```csharp
public EncryptionHelper(string encryptionKey)
```
#### Parameters
`encryptionKey` [string](https://learn.microsoft.com/dotnet/api/system.string)

View file

@ -1,556 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.EncryptionHelper
commentId: T:CapyKit.Helpers.EncryptionHelper
id: EncryptionHelper
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.EncryptionHelper.#ctor(System.String)
langs:
- csharp
- vb
name: EncryptionHelper
nameWithType: EncryptionHelper
fullName: CapyKit.Helpers.EncryptionHelper
type: Class
source:
remote:
path: CapyKit/Helpers/EncryptionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: EncryptionHelper
path: ../CapyKit/Helpers/EncryptionHelper.cs
startLine: 9
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: public class EncryptionHelper
content.vb: Public Class EncryptionHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- CapyKit.Helpers.EncryptionHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Helpers.EncryptionHelper.#ctor(System.String)
commentId: M:CapyKit.Helpers.EncryptionHelper.#ctor(System.String)
id: '#ctor(System.String)'
parent: CapyKit.Helpers.EncryptionHelper
langs:
- csharp
- vb
name: EncryptionHelper(string)
nameWithType: EncryptionHelper.EncryptionHelper(string)
fullName: CapyKit.Helpers.EncryptionHelper.EncryptionHelper(string)
type: Constructor
source:
remote:
path: CapyKit/Helpers/EncryptionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: .ctor
path: ../CapyKit/Helpers/EncryptionHelper.cs
startLine: 19
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: public EncryptionHelper(string encryptionKey)
parameters:
- id: encryptionKey
type: System.String
content.vb: Public Sub New(encryptionKey As String)
overload: CapyKit.Helpers.EncryptionHelper.#ctor*
nameWithType.vb: EncryptionHelper.New(String)
fullName.vb: CapyKit.Helpers.EncryptionHelper.New(String)
name.vb: New(String)
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.Helpers.EncryptionHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<EncryptionHelper>(EncryptionHelper, EncryptionHelper)
nameWithType: ObjectExtensions.UpdateProperties<EncryptionHelper>(EncryptionHelper, EncryptionHelper)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.EncryptionHelper>(CapyKit.Helpers.EncryptionHelper, CapyKit.Helpers.EncryptionHelper)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of EncryptionHelper)(EncryptionHelper, EncryptionHelper)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.EncryptionHelper)(CapyKit.Helpers.EncryptionHelper, CapyKit.Helpers.EncryptionHelper)
name.vb: UpdateProperties(Of EncryptionHelper)(EncryptionHelper, EncryptionHelper)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper,CapyKit.Helpers.EncryptionHelper)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
- name: '>'
- name: (
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper,CapyKit.Helpers.EncryptionHelper)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
- name: )
- name: (
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.Helpers.EncryptionHelper.#ctor*
commentId: Overload:CapyKit.Helpers.EncryptionHelper.#ctor
href: CapyKit.Helpers.EncryptionHelper.html#CapyKit_Helpers_EncryptionHelper__ctor_System_String_
name: EncryptionHelper
nameWithType: EncryptionHelper.EncryptionHelper
fullName: CapyKit.Helpers.EncryptionHelper.EncryptionHelper
nameWithType.vb: EncryptionHelper.New
fullName.vb: CapyKit.Helpers.EncryptionHelper.New
name.vb: New
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String

View file

@ -0,0 +1,68 @@
# <a id="CapyKit_Helpers_IEncryptionAlgorithm"></a> Interface IEncryptionAlgorithm
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
```csharp
public interface IEncryptionAlgorithm
```
#### Extension Methods
[ObjectExtensions.UpdateProperties<IEncryptionAlgorithm\>\(IEncryptionAlgorithm, IEncryptionAlgorithm\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Properties
### <a id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName"></a> AlgorithmName
```csharp
string AlgorithmName { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
## Methods
### <a id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___"></a> Decrypt<T\>\(EncryptedValue<T\>, params object\[\]\)
```csharp
T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)
```
#### Parameters
`encryptedValue` [EncryptedValue](CapyKit.EncryptedValue\-1.md)<T\>
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
#### Returns
T
#### Type Parameters
`T`
### <a id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___"></a> Encrypt<T\>\(object, params object\[\]\)
```csharp
EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
```
#### Parameters
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
#### Returns
[EncryptedValue](CapyKit.EncryptedValue\-1.md)<T\>
#### Type Parameters
`T`

View file

@ -1,502 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.IEncryptionAlgorithm
commentId: T:CapyKit.Helpers.IEncryptionAlgorithm
id: IEncryptionAlgorithm
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
- CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
- CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])
langs:
- csharp
- vb
name: IEncryptionAlgorithm
nameWithType: IEncryptionAlgorithm
fullName: CapyKit.Helpers.IEncryptionAlgorithm
type: Interface
source:
remote:
path: CapyKit/Helpers/EncryptionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: IEncryptionAlgorithm
path: ../CapyKit/Helpers/EncryptionHelper.cs
startLine: 27
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: public interface IEncryptionAlgorithm
content.vb: Public Interface IEncryptionAlgorithm
extensionMethods:
- CapyKit.Helpers.IEncryptionAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
commentId: P:CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
id: AlgorithmName
parent: CapyKit.Helpers.IEncryptionAlgorithm
langs:
- csharp
- vb
name: AlgorithmName
nameWithType: IEncryptionAlgorithm.AlgorithmName
fullName: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
type: Property
source:
remote:
path: CapyKit/Helpers/EncryptionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: AlgorithmName
path: ../CapyKit/Helpers/EncryptionHelper.cs
startLine: 31
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: string AlgorithmName { get; }
parameters: []
return:
type: System.String
content.vb: ReadOnly Property AlgorithmName As String
overload: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName*
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])
commentId: M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])
id: Encrypt``1(System.Object,System.Object[])
parent: CapyKit.Helpers.IEncryptionAlgorithm
langs:
- csharp
- vb
name: Encrypt<T>(object, params object[])
nameWithType: IEncryptionAlgorithm.Encrypt<T>(object, params object[])
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt<T>(object, params object[])
type: Method
source:
remote:
path: CapyKit/Helpers/EncryptionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Encrypt
path: ../CapyKit/Helpers/EncryptionHelper.cs
startLine: 37
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
parameters:
- id: obj
type: System.Object
- id: args
type: System.Object[]
typeParameters:
- id: T
return:
type: CapyKit.EncryptedValue{{T}}
content.vb: Function Encrypt(Of T)(obj As Object, ParamArray args As Object()) As EncryptedValue(Of T)
overload: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt*
nameWithType.vb: IEncryptionAlgorithm.Encrypt(Of T)(Object, ParamArray Object())
fullName.vb: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt(Of T)(Object, ParamArray Object())
name.vb: Encrypt(Of T)(Object, ParamArray Object())
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
commentId: M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
id: Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
parent: CapyKit.Helpers.IEncryptionAlgorithm
langs:
- csharp
- vb
name: Decrypt<T>(EncryptedValue<T>, params object[])
nameWithType: IEncryptionAlgorithm.Decrypt<T>(EncryptedValue<T>, params object[])
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt<T>(CapyKit.EncryptedValue<T>, params object[])
type: Method
source:
remote:
path: CapyKit/Helpers/EncryptionHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Decrypt
path: ../CapyKit/Helpers/EncryptionHelper.cs
startLine: 39
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)
parameters:
- id: encryptedValue
type: CapyKit.EncryptedValue{{T}}
- id: args
type: System.Object[]
typeParameters:
- id: T
return:
type: '{T}'
content.vb: Function Decrypt(Of T)(encryptedValue As EncryptedValue(Of T), ParamArray args As Object()) As T
overload: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt*
nameWithType.vb: IEncryptionAlgorithm.Decrypt(Of T)(EncryptedValue(Of T), ParamArray Object())
fullName.vb: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt(Of T)(CapyKit.EncryptedValue(Of T), ParamArray Object())
name.vb: Decrypt(Of T)(EncryptedValue(Of T), ParamArray Object())
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: CapyKit.Helpers.IEncryptionAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)
nameWithType: ObjectExtensions.UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.IEncryptionAlgorithm>(CapyKit.Helpers.IEncryptionAlgorithm, CapyKit.Helpers.IEncryptionAlgorithm)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of IEncryptionAlgorithm)(IEncryptionAlgorithm, IEncryptionAlgorithm)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.IEncryptionAlgorithm)(CapyKit.Helpers.IEncryptionAlgorithm, CapyKit.Helpers.IEncryptionAlgorithm)
name.vb: UpdateProperties(Of IEncryptionAlgorithm)(IEncryptionAlgorithm, IEncryptionAlgorithm)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm,CapyKit.Helpers.IEncryptionAlgorithm)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
- name: '>'
- name: (
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm,CapyKit.Helpers.IEncryptionAlgorithm)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
- name: )
- name: (
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName*
commentId: Overload:CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
href: CapyKit.Helpers.IEncryptionAlgorithm.html#CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName
name: AlgorithmName
nameWithType: IEncryptionAlgorithm.AlgorithmName
fullName: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt*
commentId: Overload:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt
href: CapyKit.Helpers.IEncryptionAlgorithm.html#CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___
name: Encrypt
nameWithType: IEncryptionAlgorithm.Encrypt
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object[]
nameWithType: object[]
fullName: object[]
nameWithType.vb: Object()
fullName.vb: Object()
name.vb: Object()
spec.csharp:
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '['
- name: ']'
spec.vb:
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: (
- name: )
- uid: CapyKit.EncryptedValue{{T}}
commentId: T:CapyKit.EncryptedValue{``0}
parent: CapyKit
definition: CapyKit.EncryptedValue`1
href: CapyKit.EncryptedValue-1.html
name: EncryptedValue<T>
nameWithType: EncryptedValue<T>
fullName: CapyKit.EncryptedValue<T>
nameWithType.vb: EncryptedValue(Of T)
fullName.vb: CapyKit.EncryptedValue(Of T)
name.vb: EncryptedValue(Of T)
spec.csharp:
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: <
- name: T
- name: '>'
spec.vb:
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: CapyKit.EncryptedValue`1
commentId: T:CapyKit.EncryptedValue`1
href: CapyKit.EncryptedValue-1.html
name: EncryptedValue<T>
nameWithType: EncryptedValue<T>
fullName: CapyKit.EncryptedValue<T>
nameWithType.vb: EncryptedValue(Of T)
fullName.vb: CapyKit.EncryptedValue(Of T)
name.vb: EncryptedValue(Of T)
spec.csharp:
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: <
- name: T
- name: '>'
spec.vb:
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt*
commentId: Overload:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt
href: CapyKit.Helpers.IEncryptionAlgorithm.html#CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___
name: Decrypt
nameWithType: IEncryptionAlgorithm.Decrypt
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T

View file

@ -0,0 +1,169 @@
# <a id="CapyKit_Helpers_KeyHelper"></a> Class KeyHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
A class that contains methods for managing key creation and validation against a master key.
```csharp
public class KeyHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[KeyHelper](CapyKit.Helpers.KeyHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<KeyHelper\>\(KeyHelper, KeyHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Helpers_KeyHelper_GenerateKey"></a> GenerateKey\(\)
Generates a random key.
```csharp
public string GenerateKey()
```
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The key.
### <a id="CapyKit_Helpers_KeyHelper_GetMasterKey"></a> GetMasterKey\(\)
Gets the master key.
```csharp
public byte[] GetMasterKey()
```
#### Returns
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
An array of byte.
#### Exceptions
[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)
Thrown when the requested operation is invalid.
### <a id="CapyKit_Helpers_KeyHelper_GetNumParts"></a> GetNumParts\(\)
Gets the number parts.
```csharp
public int GetNumParts()
```
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
The number parts.
#### Exceptions
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
Thrown when one or more arguments have unsupported or illegal values.
### <a id="CapyKit_Helpers_KeyHelper_GetSaltSize"></a> GetSaltSize\(\)
Gets the salt size.
```csharp
public int GetSaltSize()
```
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
The salt size.
### <a id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"></a> SetMasterKeyAccessor\(Func<byte\[\]\>\)
Sets the master key.
```csharp
public void SetMasterKeyAccessor(Func<byte[]> accessor)
```
#### Parameters
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]\>
The accessor function.
### <a id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"></a> SetNumPartsAccessor\(Func<int\>\)
Set and get the number of parts for the formatted key. Default is 2.
```csharp
public void SetNumPartsAccessor(Func<int> accessor)
```
#### Parameters
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\>
The accessor function.
### <a id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__"></a> SetSaltSizeAccessor\(Func<int\>\)
Sets the salt size (in bytes). Default is 4.
```csharp
public void SetSaltSizeAccessor(Func<int> accessor)
```
#### Parameters
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\>
The accessor function.
### <a id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_"></a> ValidateKey\(string\)
Validates the provided key.
```csharp
public bool ValidateKey(string providedKey)
```
#### Parameters
`providedKey` [string](https://learn.microsoft.com/dotnet/api/system.string)
The provided key.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
True if it succeeds, false if it fails.
#### See Also
[KeyHelper](CapyKit.Helpers.KeyHelper.md).[GetMasterKey](CapyKit.Helpers.KeyHelper.md\#CapyKit\_Helpers\_KeyHelper\_GetMasterKey)\(\),
[KeyHelper](CapyKit.Helpers.KeyHelper.md).[SetMasterKeyAccessor](CapyKit.Helpers.KeyHelper.md\#CapyKit\_Helpers\_KeyHelper\_SetMasterKeyAccessor\_System\_Func\_System\_Byte\_\_\_\_)\([Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]\>\),
[KeyHelper](CapyKit.Helpers.KeyHelper.md).masterKeyAccessor

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,58 @@
# <a id="CapyKit_Helpers_LanguageHelper"></a> Class LanguageHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
Helper class for handling text transformations.
```csharp
public class LanguageHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[LanguageHelper](CapyKit.Helpers.LanguageHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<LanguageHelper\>\(LanguageHelper, LanguageHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_"></a> CamelCaseToHumanReadable\(string\)
Converts camel case text to human readable text.
```csharp
public static string CamelCaseToHumanReadable(string value)
```
#### Parameters
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
The value.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A string in human readable format.
#### Remarks
Camel case is a naming convention for identifiers in which the first letter of each word is
capitalized.

View file

@ -1,565 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.LanguageHelper
commentId: T:CapyKit.Helpers.LanguageHelper
id: LanguageHelper
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)
langs:
- csharp
- vb
name: LanguageHelper
nameWithType: LanguageHelper
fullName: CapyKit.Helpers.LanguageHelper
type: Class
source:
remote:
path: CapyKit/Helpers/LanguageHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: LanguageHelper
path: ../CapyKit/Helpers/LanguageHelper.cs
startLine: 12
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Helper class for handling text transformations.
example: []
syntax:
content: public class LanguageHelper
content.vb: Public Class LanguageHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- CapyKit.Helpers.LanguageHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)
commentId: M:CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)
id: CamelCaseToHumanReadable(System.String)
parent: CapyKit.Helpers.LanguageHelper
langs:
- csharp
- vb
name: CamelCaseToHumanReadable(string)
nameWithType: LanguageHelper.CamelCaseToHumanReadable(string)
fullName: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(string)
type: Method
source:
remote:
path: CapyKit/Helpers/LanguageHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: CamelCaseToHumanReadable
path: ../CapyKit/Helpers/LanguageHelper.cs
startLine: 23
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Converts camel case text to human readable text.
remarks: >-
Camel case is a naming convention for identifiers in which the first letter of each word is
capitalized.
example: []
syntax:
content: public static string CamelCaseToHumanReadable(string value)
parameters:
- id: value
type: System.String
description: The value.
return:
type: System.String
description: A string in human readable format.
content.vb: Public Shared Function CamelCaseToHumanReadable(value As String) As String
overload: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable*
nameWithType.vb: LanguageHelper.CamelCaseToHumanReadable(String)
fullName.vb: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(String)
name.vb: CamelCaseToHumanReadable(String)
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.Helpers.LanguageHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<LanguageHelper>(LanguageHelper, LanguageHelper)
nameWithType: ObjectExtensions.UpdateProperties<LanguageHelper>(LanguageHelper, LanguageHelper)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.LanguageHelper>(CapyKit.Helpers.LanguageHelper, CapyKit.Helpers.LanguageHelper)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of LanguageHelper)(LanguageHelper, LanguageHelper)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.LanguageHelper)(CapyKit.Helpers.LanguageHelper, CapyKit.Helpers.LanguageHelper)
name.vb: UpdateProperties(Of LanguageHelper)(LanguageHelper, LanguageHelper)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper,CapyKit.Helpers.LanguageHelper)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
- name: '>'
- name: (
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper,CapyKit.Helpers.LanguageHelper)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
- name: )
- name: (
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable*
commentId: Overload:CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable
href: CapyKit.Helpers.LanguageHelper.html#CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_
name: CamelCaseToHumanReadable
nameWithType: LanguageHelper.CamelCaseToHumanReadable
fullName: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String

View file

@ -0,0 +1,371 @@
# <a id="CapyKit_Helpers_SecurityHelper"></a> Class SecurityHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
A class that contains methods for managing secure data processing and cryptography.
```csharp
public class SecurityHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<SecurityHelper\>\(SecurityHelper, SecurityHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1_CapyKit_Password_System_String_System_Byte___System_Object___"></a> CompareHashedPassword<T\>\(Password, string, byte\[\], params object\[\]\)
Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
This method uses the specified password algorithm type <code class="typeparamref">T</code> to retrieve the hashed version
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.
```csharp
public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)
```
#### Parameters
`existingPassword` [Password](CapyKit.Password.md)
The existing, encrypted password.
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The unencrypted password to be compared.
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
The salt value used in password hashing.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Additional arguments required for constructing the password algorithm instance.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if hash comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it fails.
#### Type Parameters
`T`
The type of the password hashing algorithm.
### <a id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_CapyKit_Password_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"></a> CompareHashedPassword\(Password, string, byte\[\], IPasswordAlgorithm, params object\[\]\)
Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
This method uses the specified <code class="paramref">algorithm</code> to retrieve the hashed version
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.
```csharp
public static bool CompareHashedPassword(Password existingPassword, string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
```
#### Parameters
`existingPassword` [Password](CapyKit.Password.md)
The existing, encrypted password.
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The unencrypted password to be compared.
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
The salt value used in password hashing.
`algorithm` [IPasswordAlgorithm](CapyKit.IPasswordAlgorithm.md)
The password hashing algorithm.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Additional arguments required for constructing the password algorithm instance.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if hash comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it fails.
### <a id="CapyKit_Helpers_SecurityHelper_CompareSessionID_System_String_System_String_"></a> CompareSessionID\(string, string\)
Compares two session identifiers.
```csharp
public static bool CompareSessionID(string first, string second)
```
#### Parameters
`first` [string](https://learn.microsoft.com/dotnet/api/system.string)
The first session identifier.
`second` [string](https://learn.microsoft.com/dotnet/api/system.string)
The second session identifier.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if not.
### <a id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Object___"></a> GetPassword<T\>\(string, params object\[\]\)
Retrieves a <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the specified password and generates a random salt value.
Then it uses that salt to call the overloaded <xref href="CapyKit.Helpers.SecurityHelper.GetPassword%60%601(System.String%2cSystem.Byte%5b%5d%2cSystem.Object%5b%5d)" data-throw-if-not-resolved="false"></xref> method with the given password and
the generated salt as arguments.
```csharp
public static Password GetPassword<T>(string password, params object[] args)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The plaintext password to be hashed.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Optional constructor arguments for the <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation
instance.
#### Returns
[Password](CapyKit.Password.md)
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object with the given password and a randomly generated salt, as well as an
instance of <code class="typeparamref">T</code> created using any optional constructor arguments provided.
#### Type Parameters
`T`
The type of <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation to use.
#### See Also
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md).SALT\_SIZE
### <a id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object___"></a> GetPassword<T\>\(string, byte\[\], params object\[\]\)
Retrieves a <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the specified password, salt, and optional
constructor arguments.
```csharp
public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The plaintext password to be hashed.
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
A random value used as an additional input to the one-way function that hashes data, a
password or passphrase. This is used to make each output different for the same input
thus adding security.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Optional constructor arguments for the <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation
instance.
#### Returns
[Password](CapyKit.Password.md)
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object with the given password and salt, as well as an instance
of <code class="typeparamref">T</code> created using the provided constructor arguments.
#### Type Parameters
`T`
The type of <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation to use.
#### Remarks
This method uses reflection to find a constructor for the specified password algorithm type (<code class="typeparamref">T</code>).
It emits an error event if a suitable constructor is not found or if there is an error invoking the constructor.
### <a id="CapyKit_Helpers_SecurityHelper_GetRandomPassword_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"></a> GetRandomPassword\(int, params ValidCharacterCollection\[\]\)
Gets a cryptographically strong random password.
```csharp
public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters)
```
#### Parameters
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The length of the password to generate.
`validCharacters` [ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)\[\]
An array of <xref href="CapyKit.Helpers.ValidCharacterCollection" data-throw-if-not-resolved="false"></xref> enumeration values representing the desired
character sets.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The password.
### <a id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_"></a> GetRandomString\(int\)
A convenience method to generate a random string of the specified length using all character sets.
```csharp
public static string GetRandomString(int length)
```
#### Parameters
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The desired length of the generated random string.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
#### See Also
[ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md),
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md).[GetRandomString](CapyKit.Helpers.SecurityHelper.md\#CapyKit\_Helpers\_SecurityHelper\_GetRandomString\_System\_Int32\_CapyKit\_Helpers\_ValidCharacterCollection\_\_\_)\([int](https://learn.microsoft.com/dotnet/api/system.int32), params [ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)\[\]\)
### <a id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"></a> GetRandomString\(int, params ValidCharacterCollection\[\]\)
Gets a cryptographically strong random string using the character values found in VALID_CHARACTERS.
```csharp
public static string GetRandomString(int length, params ValidCharacterCollection[] validChars)
```
#### Parameters
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The length of the string to create.
`validChars` [ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)\[\]
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
The random string.
### <a id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32_"></a> GetSalt\(int\)
Generates a random byte array that can act as a salt.
```csharp
public static byte[] GetSalt(int length = 32)
```
#### Parameters
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
(Optional) The desired length of the generated byte array.
#### Returns
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
An array of byte.
#### Remarks
A default length of <xref href="CapyKit.Helpers.SecurityHelper.SALT_SIZE" data-throw-if-not-resolved="false"></xref> is provided as a sane default. Larger values can be used for increased
entropy.
### <a id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_System_Byte___"></a> Pbkdf2\(string, byte\[\]\)
Generates a new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>
and <code class="paramref">salt</code>.
```csharp
public static Password Pbkdf2(string password, byte[] salt)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The clear text password to be hashed.
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
A random value used to add an additional layer of security to the generated hash.
#### Returns
[Password](CapyKit.Password.md)
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> 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.
### <a id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_"></a> Pbkdf2\(string\)
Generates a new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>.
This overload of the method generates a random salt value for added security.
```csharp
public static Password Pbkdf2(string password)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The clear text password to be hashed.
#### Returns
[Password](CapyKit.Password.md)
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> 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 <xref href="CapyKit.Helpers.SecurityHelper.GetRandomBytes(System.Int32)" data-throw-if-not-resolved="false"></xref> method.

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,160 @@
# <a id="CapyKit_Helpers_SerializationHelper"></a> Class SerializationHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
```csharp
public static class SerializationHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[SerializationHelper](CapyKit.Helpers.SerializationHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Methods
### <a id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___"></a> Deserialize<T\>\(byte\[\]\)
Deserializes an object to a given <code class="typeparamref">T</code> type.
```csharp
public static T Deserialize<T>(byte[] bytes)
```
#### Parameters
`bytes` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
The byte array representing a <code class="typeparamref">T</code> object.
#### Returns
T
A <code class="typeparamref">T</code> object.
#### Type Parameters
`T`
Generic type parameter.
#### Exceptions
[FormatException](https://learn.microsoft.com/dotnet/api/system.formatexception)
Thrown when the format of the byte array is incorrect.
### <a id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_IO_Stream_"></a> Deserialize<T\>\(Stream\)
Deserializes an object to a given <code class="typeparamref">T</code> type.
```csharp
public static T Deserialize<T>(Stream stream)
```
#### Parameters
`stream` [Stream](https://learn.microsoft.com/dotnet/api/system.io.stream)
The steam.
#### Returns
T
A <code class="typeparamref">T</code> object.
#### Type Parameters
`T`
Generic type parameter.
#### Exceptions
[FormatException](https://learn.microsoft.com/dotnet/api/system.formatexception)
Thrown when the format of an input is incorrect.
### <a id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_String_"></a> Deserialize<T\>\(string\)
Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.
```csharp
public static T Deserialize<T>(string str)
```
#### Parameters
`str` [string](https://learn.microsoft.com/dotnet/api/system.string)
The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.
#### Returns
T
A <code class="typeparamref">T</code> object.
#### Type Parameters
`T`
Generic type parameter.
### <a id="CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_"></a> SerializeToBytes\(object\)
Serializes an object to a byte array.
```csharp
public static byte[] SerializeToBytes(object obj)
```
#### Parameters
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
The object.
#### Returns
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
A <code>JSON</code> encoded string.
### <a id="CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_"></a> SerializeToString\(object\)
Serializes an object to a <code>JSON</code> encoded string.
```csharp
public static string SerializeToString(object obj)
```
#### Parameters
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
The object.
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A <code>JSON</code> encoded string.

View file

@ -1,614 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.SerializationHelper
commentId: T:CapyKit.Helpers.SerializationHelper
id: SerializationHelper
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
- CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
- CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
- CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
- CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
langs:
- csharp
- vb
name: SerializationHelper
nameWithType: SerializationHelper
fullName: CapyKit.Helpers.SerializationHelper
type: Class
source:
remote:
path: CapyKit/Helpers/SerializationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SerializationHelper
path: ../CapyKit/Helpers/SerializationHelper.cs
startLine: 12
assemblies:
- CapyKit
namespace: CapyKit.Helpers
syntax:
content: public static class SerializationHelper
content.vb: Public Module SerializationHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
commentId: M:CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
id: SerializeToBytes(System.Object)
parent: CapyKit.Helpers.SerializationHelper
langs:
- csharp
- vb
name: SerializeToBytes(object)
nameWithType: SerializationHelper.SerializeToBytes(object)
fullName: CapyKit.Helpers.SerializationHelper.SerializeToBytes(object)
type: Method
source:
remote:
path: CapyKit/Helpers/SerializationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SerializeToBytes
path: ../CapyKit/Helpers/SerializationHelper.cs
startLine: 25
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Serializes an object to a byte array.
example: []
syntax:
content: public static byte[] SerializeToBytes(object obj)
parameters:
- id: obj
type: System.Object
description: The object.
return:
type: System.Byte[]
description: A <code>JSON</code> encoded string.
content.vb: Public Shared Function SerializeToBytes(obj As Object) As Byte()
overload: CapyKit.Helpers.SerializationHelper.SerializeToBytes*
nameWithType.vb: SerializationHelper.SerializeToBytes(Object)
fullName.vb: CapyKit.Helpers.SerializationHelper.SerializeToBytes(Object)
name.vb: SerializeToBytes(Object)
- uid: CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
commentId: M:CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
id: SerializeToString(System.Object)
parent: CapyKit.Helpers.SerializationHelper
langs:
- csharp
- vb
name: SerializeToString(object)
nameWithType: SerializationHelper.SerializeToString(object)
fullName: CapyKit.Helpers.SerializationHelper.SerializeToString(object)
type: Method
source:
remote:
path: CapyKit/Helpers/SerializationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SerializeToString
path: ../CapyKit/Helpers/SerializationHelper.cs
startLine: 33
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Serializes an object to a <code>JSON</code> encoded string.
example: []
syntax:
content: public static string SerializeToString(object obj)
parameters:
- id: obj
type: System.Object
description: The object.
return:
type: System.String
description: A <code>JSON</code> encoded string.
content.vb: Public Shared Function SerializeToString(obj As Object) As String
overload: CapyKit.Helpers.SerializationHelper.SerializeToString*
nameWithType.vb: SerializationHelper.SerializeToString(Object)
fullName.vb: CapyKit.Helpers.SerializationHelper.SerializeToString(Object)
name.vb: SerializeToString(Object)
- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
id: Deserialize``1(System.Byte[])
parent: CapyKit.Helpers.SerializationHelper
langs:
- csharp
- vb
name: Deserialize<T>(byte[])
nameWithType: SerializationHelper.Deserialize<T>(byte[])
fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(byte[])
type: Method
source:
remote:
path: CapyKit/Helpers/SerializationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Deserialize
path: ../CapyKit/Helpers/SerializationHelper.cs
startLine: 43
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Deserializes an object to a given <code class="typeparamref">T</code> type.
example: []
syntax:
content: public static T Deserialize<T>(byte[] bytes)
parameters:
- id: bytes
type: System.Byte[]
description: The byte array representing a <code class="typeparamref">T</code> object.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A <code class="typeparamref">T</code> object.
content.vb: Public Shared Function Deserialize(Of T)(bytes As Byte()) As T
overload: CapyKit.Helpers.SerializationHelper.Deserialize*
exceptions:
- type: System.FormatException
commentId: T:System.FormatException
description: Thrown when the format of the byte array is incorrect.
nameWithType.vb: SerializationHelper.Deserialize(Of T)(Byte())
fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(Byte())
name.vb: Deserialize(Of T)(Byte())
- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
id: Deserialize``1(System.IO.Stream)
parent: CapyKit.Helpers.SerializationHelper
langs:
- csharp
- vb
name: Deserialize<T>(Stream)
nameWithType: SerializationHelper.Deserialize<T>(Stream)
fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(System.IO.Stream)
type: Method
source:
remote:
path: CapyKit/Helpers/SerializationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Deserialize
path: ../CapyKit/Helpers/SerializationHelper.cs
startLine: 57
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Deserializes an object to a given <code class="typeparamref">T</code> type.
example: []
syntax:
content: public static T Deserialize<T>(Stream stream)
parameters:
- id: stream
type: System.IO.Stream
description: The steam.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A <code class="typeparamref">T</code> object.
content.vb: Public Shared Function Deserialize(Of T)(stream As Stream) As T
overload: CapyKit.Helpers.SerializationHelper.Deserialize*
exceptions:
- type: System.FormatException
commentId: T:System.FormatException
description: Thrown when the format of an input is incorrect.
nameWithType.vb: SerializationHelper.Deserialize(Of T)(Stream)
fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(System.IO.Stream)
name.vb: Deserialize(Of T)(Stream)
- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
id: Deserialize``1(System.String)
parent: CapyKit.Helpers.SerializationHelper
langs:
- csharp
- vb
name: Deserialize<T>(string)
nameWithType: SerializationHelper.Deserialize<T>(string)
fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(string)
type: Method
source:
remote:
path: CapyKit/Helpers/SerializationHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Deserialize
path: ../CapyKit/Helpers/SerializationHelper.cs
startLine: 87
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.
example: []
syntax:
content: public static T Deserialize<T>(string str)
parameters:
- id: str
type: System.String
description: The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.
typeParameters:
- id: T
description: Generic type parameter.
return:
type: '{T}'
description: A <code class="typeparamref">T</code> object.
content.vb: Public Shared Function Deserialize(Of T)(str As String) As T
overload: CapyKit.Helpers.SerializationHelper.Deserialize*
nameWithType.vb: SerializationHelper.Deserialize(Of T)(String)
fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(String)
name.vb: Deserialize(Of T)(String)
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Helpers.SerializationHelper.SerializeToBytes*
commentId: Overload:CapyKit.Helpers.SerializationHelper.SerializeToBytes
href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_
name: SerializeToBytes
nameWithType: SerializationHelper.SerializeToBytes
fullName: CapyKit.Helpers.SerializationHelper.SerializeToBytes
- uid: System.Byte[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
name: byte[]
nameWithType: byte[]
fullName: byte[]
nameWithType.vb: Byte()
fullName.vb: Byte()
name.vb: Byte()
spec.csharp:
- uid: System.Byte
name: byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: '['
- name: ']'
spec.vb:
- uid: System.Byte
name: Byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: (
- name: )
- uid: CapyKit.Helpers.SerializationHelper.SerializeToString*
commentId: Overload:CapyKit.Helpers.SerializationHelper.SerializeToString
href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_
name: SerializeToString
nameWithType: SerializationHelper.SerializeToString
fullName: CapyKit.Helpers.SerializationHelper.SerializeToString
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: System.FormatException
commentId: T:System.FormatException
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.formatexception
name: FormatException
nameWithType: FormatException
fullName: System.FormatException
- uid: CapyKit.Helpers.SerializationHelper.Deserialize*
commentId: Overload:CapyKit.Helpers.SerializationHelper.Deserialize
href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___
name: Deserialize
nameWithType: SerializationHelper.Deserialize
fullName: CapyKit.Helpers.SerializationHelper.Deserialize
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T
- uid: System.IO.Stream
commentId: T:System.IO.Stream
parent: System.IO
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.io.stream
name: Stream
nameWithType: Stream
fullName: System.IO.Stream
- uid: System.IO
commentId: N:System.IO
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System.IO
nameWithType: System.IO
fullName: System.IO
spec.csharp:
- uid: System
name: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
- name: .
- uid: System.IO
name: IO
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.io
spec.vb:
- uid: System
name: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
- name: .
- uid: System.IO
name: IO
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.io

View file

@ -0,0 +1,137 @@
# <a id="CapyKit_Helpers_SettingsHelper"></a> Class SettingsHelper
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
Static class containing helper methods for retrieving and setting application settings.
```csharp
public static class SettingsHelper
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[SettingsHelper](CapyKit.Helpers.SettingsHelper.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Examples
This example demonstrates how to set up the SettingsHelper class with custom accessor and
detector methods that read from an App.config file. The setup is done at the beginning of the
application execution, before any other usage of the helper methods.
<pre><code class="lang-csharp">public int main(string[] args)
{
// Set up SettingsHelper with custom accessor and detector methods
Func&lt;string, object&gt; accessor = (key) =&gt;
{
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
return config.AppSettings.Settings[key].Value;
};
Func&lt;string, bool&gt; detector = (key) =&gt;
{
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
return config.AppSettings.Settings.AllKeys.Contains(key);
};
SettingsHelper.SetAccessorMethod(accessor);
SettingsHelper.SetDetectorMethod(detector);
// Use the helper to retrieve and set settings
SettingsHelper.SetApplicationSetting&lt;int&gt;("MySettingKey", 42);
int newSetting = SettingsHelper.GetApplicationSetting&lt;int&gt;("MySettingKey");
Console.WriteLine("New setting: {0}", newSetting);
int mySetting = SettingsHelper.GetApplicationSetting&lt;int&gt;("MySettingKey");
Console.WriteLine("Retrieved setting: {0}", mySetting);
}</code></pre>
## Remarks
The specific means of accessing and storing the settings are determined by the consumer,
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
.
## Methods
### <a id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_"></a> GetApplicationSetting<T\>\(string\)
Retrieves a setting with the given <code>key</code>.
```csharp
public static T GetApplicationSetting<T>(string settingName)
```
#### Parameters
`settingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
The name of the setting to retrieve.
#### Returns
T
The value of the setting as an uncast <code class="typeparamref">T</code>.
#### Type Parameters
`T`
The type of the setting to be retrieved.
### <a id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__"></a> SetAccessorMethod\(Func<string, object\>\)
Sets the function used to retrieve application settings.
```csharp
public static void SetAccessorMethod(Func<string, object> accessor)
```
#### Parameters
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [object](https://learn.microsoft.com/dotnet/api/system.object)\>
The new function used to retrieve application settings.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Thrown when one or more required arguments are null.
### <a id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__"></a> SetDetectorMethod\(Func<string, bool\>\)
Sets the function used to detect if an application setting with a given <code>key</code> exists.
```csharp
public static void SetDetectorMethod(Func<string, bool> detector)
```
#### Parameters
`detector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>
The new function used to detect if an application setting exists.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
Thrown when one or more required arguments are null.

View file

@ -1,637 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.SettingsHelper
commentId: T:CapyKit.Helpers.SettingsHelper
id: SettingsHelper
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)
- CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})
- CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})
langs:
- csharp
- vb
name: SettingsHelper
nameWithType: SettingsHelper
fullName: CapyKit.Helpers.SettingsHelper
type: Class
source:
remote:
path: CapyKit/Helpers/SettingsHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SettingsHelper
path: ../CapyKit/Helpers/SettingsHelper.cs
startLine: 49
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Static class containing helper methods for retrieving and setting application settings.
remarks: >-
The specific means of accessing and storing the settings are determined by the consumer,
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
.
example:
- >-
This example demonstrates how to set up the SettingsHelper class with custom accessor and
detector methods that read from an App.config file. The setup is done at the beginning of the
application execution, before any other usage of the helper methods.
<pre><code class="lang-csharp">public int main(string[] args)
{
// Set up SettingsHelper with custom accessor and detector methods
Func&lt;string, object&gt; accessor = (key) =&gt;
{
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
return config.AppSettings.Settings[key].Value;
};
Func&lt;string, bool&gt; detector = (key) =&gt;
{
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
return config.AppSettings.Settings.AllKeys.Contains(key);
};
SettingsHelper.SetAccessorMethod(accessor);
SettingsHelper.SetDetectorMethod(detector);
// Use the helper to retrieve and set settings
SettingsHelper.SetApplicationSetting&lt;int&gt;("MySettingKey", 42);
int newSetting = SettingsHelper.GetApplicationSetting&lt;int&gt;("MySettingKey");
Console.WriteLine("New setting: {0}", newSetting);
int mySetting = SettingsHelper.GetApplicationSetting&lt;int&gt;("MySettingKey");
Console.WriteLine("Retrieved setting: {0}", mySetting);
}</code></pre>
syntax:
content: public static class SettingsHelper
content.vb: Public Module SettingsHelper
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)
commentId: M:CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)
id: GetApplicationSetting``1(System.String)
parent: CapyKit.Helpers.SettingsHelper
langs:
- csharp
- vb
name: GetApplicationSetting<T>(string)
nameWithType: SettingsHelper.GetApplicationSetting<T>(string)
fullName: CapyKit.Helpers.SettingsHelper.GetApplicationSetting<T>(string)
type: Method
source:
remote:
path: CapyKit/Helpers/SettingsHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: GetApplicationSetting
path: ../CapyKit/Helpers/SettingsHelper.cs
startLine: 74
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Retrieves a setting with the given <code>key</code>.
example: []
syntax:
content: public static T GetApplicationSetting<T>(string settingName)
parameters:
- id: settingName
type: System.String
description: The name of the setting to retrieve.
typeParameters:
- id: T
description: The type of the setting to be retrieved.
return:
type: '{T}'
description: The value of the setting as an uncast <code class="typeparamref">T</code>.
content.vb: Public Shared Function GetApplicationSetting(Of T)(settingName As String) As T
overload: CapyKit.Helpers.SettingsHelper.GetApplicationSetting*
nameWithType.vb: SettingsHelper.GetApplicationSetting(Of T)(String)
fullName.vb: CapyKit.Helpers.SettingsHelper.GetApplicationSetting(Of T)(String)
name.vb: GetApplicationSetting(Of T)(String)
- uid: CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})
commentId: M:CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})
id: SetAccessorMethod(System.Func{System.String,System.Object})
parent: CapyKit.Helpers.SettingsHelper
langs:
- csharp
- vb
name: SetAccessorMethod(Func<string, object>)
nameWithType: SettingsHelper.SetAccessorMethod(Func<string, object>)
fullName: CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func<string, object>)
type: Method
source:
remote:
path: CapyKit/Helpers/SettingsHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SetAccessorMethod
path: ../CapyKit/Helpers/SettingsHelper.cs
startLine: 95
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Sets the function used to retrieve application settings.
example: []
syntax:
content: public static void SetAccessorMethod(Func<string, object> accessor)
parameters:
- id: accessor
type: System.Func{System.String,System.Object}
description: The new function used to retrieve application settings.
content.vb: Public Shared Sub SetAccessorMethod(accessor As Func(Of String, Object))
overload: CapyKit.Helpers.SettingsHelper.SetAccessorMethod*
exceptions:
- type: System.ArgumentNullException
commentId: T:System.ArgumentNullException
description: Thrown when one or more required arguments are null.
nameWithType.vb: SettingsHelper.SetAccessorMethod(Func(Of String, Object))
fullName.vb: CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func(Of String, Object))
name.vb: SetAccessorMethod(Func(Of String, Object))
- uid: CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})
commentId: M:CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})
id: SetDetectorMethod(System.Func{System.String,System.Boolean})
parent: CapyKit.Helpers.SettingsHelper
langs:
- csharp
- vb
name: SetDetectorMethod(Func<string, bool>)
nameWithType: SettingsHelper.SetDetectorMethod(Func<string, bool>)
fullName: CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func<string, bool>)
type: Method
source:
remote:
path: CapyKit/Helpers/SettingsHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SetDetectorMethod
path: ../CapyKit/Helpers/SettingsHelper.cs
startLine: 118
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Sets the function used to detect if an application setting with a given <code>key</code> exists.
example: []
syntax:
content: public static void SetDetectorMethod(Func<string, bool> detector)
parameters:
- id: detector
type: System.Func{System.String,System.Boolean}
description: The new function used to detect if an application setting exists.
content.vb: Public Shared Sub SetDetectorMethod(detector As Func(Of String, Boolean))
overload: CapyKit.Helpers.SettingsHelper.SetDetectorMethod*
exceptions:
- type: System.ArgumentNullException
commentId: T:System.ArgumentNullException
description: Thrown when one or more required arguments are null.
nameWithType.vb: SettingsHelper.SetDetectorMethod(Func(Of String, Boolean))
fullName.vb: CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func(Of String, Boolean))
name.vb: SetDetectorMethod(Func(Of String, Boolean))
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Helpers.SettingsHelper.GetApplicationSetting*
commentId: Overload:CapyKit.Helpers.SettingsHelper.GetApplicationSetting
href: CapyKit.Helpers.SettingsHelper.html#CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_
name: GetApplicationSetting
nameWithType: SettingsHelper.GetApplicationSetting
fullName: CapyKit.Helpers.SettingsHelper.GetApplicationSetting
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T
- uid: System.ArgumentNullException
commentId: T:System.ArgumentNullException
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.argumentnullexception
name: ArgumentNullException
nameWithType: ArgumentNullException
fullName: System.ArgumentNullException
- uid: CapyKit.Helpers.SettingsHelper.SetAccessorMethod*
commentId: Overload:CapyKit.Helpers.SettingsHelper.SetAccessorMethod
href: CapyKit.Helpers.SettingsHelper.html#CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__
name: SetAccessorMethod
nameWithType: SettingsHelper.SetAccessorMethod
fullName: CapyKit.Helpers.SettingsHelper.SetAccessorMethod
- uid: System.Func{System.String,System.Object}
commentId: T:System.Func{System.String,System.Object}
parent: System
definition: System.Func`2
href: https://learn.microsoft.com/dotnet/api/system.func-2
name: Func<string, object>
nameWithType: Func<string, object>
fullName: System.Func<string, object>
nameWithType.vb: Func(Of String, Object)
fullName.vb: System.Func(Of String, Object)
name.vb: Func(Of String, Object)
spec.csharp:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: <
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '>'
spec.vb:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: (
- name: Of
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Func`2
commentId: T:System.Func`2
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
name: Func<T, TResult>
nameWithType: Func<T, TResult>
fullName: System.Func<T, TResult>
nameWithType.vb: Func(Of T, TResult)
fullName.vb: System.Func(Of T, TResult)
name.vb: Func(Of T, TResult)
spec.csharp:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: <
- name: T
- name: ','
- name: " "
- name: TResult
- name: '>'
spec.vb:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: (
- name: Of
- name: " "
- name: T
- name: ','
- name: " "
- name: TResult
- name: )
- uid: CapyKit.Helpers.SettingsHelper.SetDetectorMethod*
commentId: Overload:CapyKit.Helpers.SettingsHelper.SetDetectorMethod
href: CapyKit.Helpers.SettingsHelper.html#CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__
name: SetDetectorMethod
nameWithType: SettingsHelper.SetDetectorMethod
fullName: CapyKit.Helpers.SettingsHelper.SetDetectorMethod
- uid: System.Func{System.String,System.Boolean}
commentId: T:System.Func{System.String,System.Boolean}
parent: System
definition: System.Func`2
href: https://learn.microsoft.com/dotnet/api/system.func-2
name: Func<string, bool>
nameWithType: Func<string, bool>
fullName: System.Func<string, bool>
nameWithType.vb: Func(Of String, Boolean)
fullName.vb: System.Func(Of String, Boolean)
name.vb: Func(Of String, Boolean)
spec.csharp:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: <
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: '>'
spec.vb:
- uid: System.Func`2
name: Func
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.func-2
- name: (
- name: Of
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )

View file

@ -0,0 +1,48 @@
# <a id="CapyKit_Helpers_ValidCharacterCollection"></a> Enum ValidCharacterCollection
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
Assembly: CapyKit.dll
An enumeration that defines the types of characters that can be included in a random string.
```csharp
public enum ValidCharacterCollection
```
#### Extension Methods
[EnumerationExtensions.GetDescription\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetDescription\_System\_Enum\_),
[EnumerationExtensions.GetName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetName\_System\_Enum\_),
[EnumerationExtensions.GetPrettyName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetPrettyName\_System\_Enum\_),
[EnumerationExtensions.GetValue\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetValue\_System\_Enum\_),
[EnumerationExtensions.Parse<ValidCharacterCollection\>\(ValidCharacterCollection, string\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_),
[EnumerationExtensions.Parse<ValidCharacterCollection\>\(ValidCharacterCollection, string, bool\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_System\_Boolean\_),
[ObjectExtensions.UpdateProperties<ValidCharacterCollection\>\(ValidCharacterCollection, ValidCharacterCollection\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Fields
`Lowercase = 0`
Indicates that lower case characters should be included in the random string.
`Numbers = 2`
Indicates that numeric characters should be included in the random string.
`Special = 3`
Indicates that special characters should be included in the random string.
`Uppercase = 1`
Indicates that upper case characters should be included in the random string.

View file

@ -1,884 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers.ValidCharacterCollection
commentId: T:CapyKit.Helpers.ValidCharacterCollection
id: ValidCharacterCollection
parent: CapyKit.Helpers
children:
- CapyKit.Helpers.ValidCharacterCollection.Lowercase
- CapyKit.Helpers.ValidCharacterCollection.Numbers
- CapyKit.Helpers.ValidCharacterCollection.Special
- CapyKit.Helpers.ValidCharacterCollection.Uppercase
langs:
- csharp
- vb
name: ValidCharacterCollection
nameWithType: ValidCharacterCollection
fullName: CapyKit.Helpers.ValidCharacterCollection
type: Enum
source:
remote:
path: CapyKit/Helpers/SecurityHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: ValidCharacterCollection
path: ../CapyKit/Helpers/SecurityHelper.cs
startLine: 374
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: An enumeration that defines the types of characters that can be included in a random string.
example: []
syntax:
content: public enum ValidCharacterCollection
content.vb: Public Enum ValidCharacterCollection
extensionMethods:
- CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
- CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
- CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection)
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Helpers.ValidCharacterCollection.Lowercase
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Lowercase
id: Lowercase
parent: CapyKit.Helpers.ValidCharacterCollection
langs:
- csharp
- vb
name: Lowercase
nameWithType: ValidCharacterCollection.Lowercase
fullName: CapyKit.Helpers.ValidCharacterCollection.Lowercase
type: Field
source:
remote:
path: CapyKit/Helpers/SecurityHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Lowercase
path: ../CapyKit/Helpers/SecurityHelper.cs
startLine: 379
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Indicates that lower case characters should be included in the random string.
example: []
syntax:
content: >-
[EnumerationDescription("abcdefghijklmnopqrstuvwxyz")]
Lowercase = 0
return:
type: CapyKit.Helpers.ValidCharacterCollection
content.vb: >-
<EnumerationDescription("abcdefghijklmnopqrstuvwxyz")>
Lowercase = 0
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: abcdefghijklmnopqrstuvwxyz
- uid: CapyKit.Helpers.ValidCharacterCollection.Uppercase
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Uppercase
id: Uppercase
parent: CapyKit.Helpers.ValidCharacterCollection
langs:
- csharp
- vb
name: Uppercase
nameWithType: ValidCharacterCollection.Uppercase
fullName: CapyKit.Helpers.ValidCharacterCollection.Uppercase
type: Field
source:
remote:
path: CapyKit/Helpers/SecurityHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Uppercase
path: ../CapyKit/Helpers/SecurityHelper.cs
startLine: 384
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Indicates that upper case characters should be included in the random string.
example: []
syntax:
content: >-
[EnumerationDescription("ABCDEFGHIJKLMNOPQRSTUVWXYZ")]
Uppercase = 1
return:
type: CapyKit.Helpers.ValidCharacterCollection
content.vb: >-
<EnumerationDescription("ABCDEFGHIJKLMNOPQRSTUVWXYZ")>
Uppercase = 1
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: ABCDEFGHIJKLMNOPQRSTUVWXYZ
- uid: CapyKit.Helpers.ValidCharacterCollection.Numbers
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Numbers
id: Numbers
parent: CapyKit.Helpers.ValidCharacterCollection
langs:
- csharp
- vb
name: Numbers
nameWithType: ValidCharacterCollection.Numbers
fullName: CapyKit.Helpers.ValidCharacterCollection.Numbers
type: Field
source:
remote:
path: CapyKit/Helpers/SecurityHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Numbers
path: ../CapyKit/Helpers/SecurityHelper.cs
startLine: 389
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Indicates that numeric characters should be included in the random string.
example: []
syntax:
content: >-
[EnumerationDescription("0123456789")]
Numbers = 2
return:
type: CapyKit.Helpers.ValidCharacterCollection
content.vb: >-
<EnumerationDescription("0123456789")>
Numbers = 2
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: "0123456789"
- uid: CapyKit.Helpers.ValidCharacterCollection.Special
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Special
id: Special
parent: CapyKit.Helpers.ValidCharacterCollection
langs:
- csharp
- vb
name: Special
nameWithType: ValidCharacterCollection.Special
fullName: CapyKit.Helpers.ValidCharacterCollection.Special
type: Field
source:
remote:
path: CapyKit/Helpers/SecurityHelper.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Special
path: ../CapyKit/Helpers/SecurityHelper.cs
startLine: 394
assemblies:
- CapyKit
namespace: CapyKit.Helpers
summary: Indicates that special characters should be included in the random string.
example: []
syntax:
content: >-
[EnumerationDescription("!@#$%&?+-_")]
Special = 3
return:
type: CapyKit.Helpers.ValidCharacterCollection
content.vb: >-
<EnumerationDescription("!@#$%&?+-_")>
Special = 3
attributes:
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
arguments:
- type: System.String
value: '!@#$%&?+-_'
references:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
- uid: CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse<ValidCharacterCollection>(ValidCharacterCollection, string)
nameWithType: EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Helpers.ValidCharacterCollection>(CapyKit.Helpers.ValidCharacterCollection, string)
nameWithType.vb: EnumerationExtensions.Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Helpers.ValidCharacterCollection)(CapyKit.Helpers.ValidCharacterCollection, String)
name.vb: Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: <
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: '>'
- name: (
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: )
- name: (
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
name: Parse<ValidCharacterCollection>(ValidCharacterCollection, string, bool)
nameWithType: EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Helpers.ValidCharacterCollection>(CapyKit.Helpers.ValidCharacterCollection, string, bool)
nameWithType.vb: EnumerationExtensions.Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Helpers.ValidCharacterCollection)(CapyKit.Helpers.ValidCharacterCollection, String, Boolean)
name.vb: Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String, Boolean)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: <
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: '>'
- name: (
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: )
- name: (
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
- uid: CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<ValidCharacterCollection>(ValidCharacterCollection, ValidCharacterCollection)
nameWithType: ObjectExtensions.UpdateProperties<ValidCharacterCollection>(ValidCharacterCollection, ValidCharacterCollection)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.ValidCharacterCollection>(CapyKit.Helpers.ValidCharacterCollection, CapyKit.Helpers.ValidCharacterCollection)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of ValidCharacterCollection)(ValidCharacterCollection, ValidCharacterCollection)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.ValidCharacterCollection)(CapyKit.Helpers.ValidCharacterCollection, CapyKit.Helpers.ValidCharacterCollection)
name.vb: UpdateProperties(Of ValidCharacterCollection)(ValidCharacterCollection, ValidCharacterCollection)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection,CapyKit.Helpers.ValidCharacterCollection)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: '>'
- name: (
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection,CapyKit.Helpers.ValidCharacterCollection)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: )
- name: (
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: ','
- name: " "
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.html
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
parent: CapyKit.Extensions.EnumerationExtensions
definition: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
name: Parse<T>(T, string)
nameWithType: EnumerationExtensions.Parse<T>(T, string)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
name.vb: Parse(Of T)(T, String)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions
commentId: T:CapyKit.Extensions.EnumerationExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.EnumerationExtensions.html
name: EnumerationExtensions
nameWithType: EnumerationExtensions
fullName: CapyKit.Extensions.EnumerationExtensions
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
name: Parse<T>(T, string, bool)
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
name.vb: Parse(Of T)(T, String, Boolean)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: bool
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
name: Parse
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- uid: System.Boolean
name: Boolean
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
name: GetDescription(Enum)
nameWithType: EnumerationExtensions.GetDescription(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
name: GetDescription
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
name: GetName(Enum)
nameWithType: EnumerationExtensions.GetName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
name: GetName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
name: GetPrettyName(Enum)
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
name: GetPrettyName
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
isExternal: true
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
name: GetValue(Enum)
nameWithType: EnumerationExtensions.GetValue(Enum)
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
spec.csharp:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
spec.vb:
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
name: GetValue
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
- name: (
- uid: System.Enum
name: Enum
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.enum
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.Helpers.ValidCharacterCollection
commentId: T:CapyKit.Helpers.ValidCharacterCollection
parent: CapyKit.Helpers
href: CapyKit.Helpers.ValidCharacterCollection.html
name: ValidCharacterCollection
nameWithType: ValidCharacterCollection
fullName: CapyKit.Helpers.ValidCharacterCollection

View file

@ -0,0 +1,42 @@
# <a id="CapyKit_Helpers"></a> Namespace CapyKit.Helpers
### Classes
[CalculationHelper](CapyKit.Helpers.CalculationHelper.md)
Static class providing helper methods for various calculations.
[CompressionHelper](CapyKit.Helpers.CompressionHelper.md)
A class that contains methods for managing data compression.
[EncryptionHelper](CapyKit.Helpers.EncryptionHelper.md)
[KeyHelper](CapyKit.Helpers.KeyHelper.md)
A class that contains methods for managing key creation and validation against a master key.
[LanguageHelper](CapyKit.Helpers.LanguageHelper.md)
Helper class for handling text transformations.
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md)
A class that contains methods for managing secure data processing and cryptography.
[SerializationHelper](CapyKit.Helpers.SerializationHelper.md)
[SettingsHelper](CapyKit.Helpers.SettingsHelper.md)
Static class containing helper methods for retrieving and setting application settings.
### Interfaces
[IEncryptionAlgorithm](CapyKit.Helpers.IEncryptionAlgorithm.md)
### Enums
[ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)
An enumeration that defines the types of characters that can be included in a random string.

View file

@ -1,109 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
id: CapyKit.Helpers
children:
- CapyKit.Helpers.CalculationHelper
- CapyKit.Helpers.CompressionHelper
- CapyKit.Helpers.EncryptionHelper
- CapyKit.Helpers.IEncryptionAlgorithm
- CapyKit.Helpers.KeyHelper
- CapyKit.Helpers.LanguageHelper
- CapyKit.Helpers.SecurityHelper
- CapyKit.Helpers.SerializationHelper
- CapyKit.Helpers.SettingsHelper
- CapyKit.Helpers.ValidCharacterCollection
langs:
- csharp
- vb
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
type: Namespace
assemblies:
- CapyKit
references:
- uid: CapyKit.Helpers.CalculationHelper
commentId: T:CapyKit.Helpers.CalculationHelper
href: CapyKit.Helpers.CalculationHelper.html
name: CalculationHelper
nameWithType: CalculationHelper
fullName: CapyKit.Helpers.CalculationHelper
- uid: CapyKit.Helpers.CompressionHelper
commentId: T:CapyKit.Helpers.CompressionHelper
href: CapyKit.Helpers.CompressionHelper.html
name: CompressionHelper
nameWithType: CompressionHelper
fullName: CapyKit.Helpers.CompressionHelper
- uid: CapyKit.Helpers.EncryptionHelper
commentId: T:CapyKit.Helpers.EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.html
name: EncryptionHelper
nameWithType: EncryptionHelper
fullName: CapyKit.Helpers.EncryptionHelper
- uid: CapyKit.Helpers.IEncryptionAlgorithm
commentId: T:CapyKit.Helpers.IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.html
name: IEncryptionAlgorithm
nameWithType: IEncryptionAlgorithm
fullName: CapyKit.Helpers.IEncryptionAlgorithm
- uid: CapyKit.Helpers.KeyHelper
commentId: T:CapyKit.Helpers.KeyHelper
href: CapyKit.Helpers.KeyHelper.html
name: KeyHelper
nameWithType: KeyHelper
fullName: CapyKit.Helpers.KeyHelper
- uid: CapyKit.Helpers.LanguageHelper
commentId: T:CapyKit.Helpers.LanguageHelper
href: CapyKit.Helpers.LanguageHelper.html
name: LanguageHelper
nameWithType: LanguageHelper
fullName: CapyKit.Helpers.LanguageHelper
- uid: CapyKit.Helpers.SecurityHelper
commentId: T:CapyKit.Helpers.SecurityHelper
href: CapyKit.Helpers.SecurityHelper.html
name: SecurityHelper
nameWithType: SecurityHelper
fullName: CapyKit.Helpers.SecurityHelper
- uid: CapyKit.Helpers.ValidCharacterCollection
commentId: T:CapyKit.Helpers.ValidCharacterCollection
parent: CapyKit.Helpers
href: CapyKit.Helpers.ValidCharacterCollection.html
name: ValidCharacterCollection
nameWithType: ValidCharacterCollection
fullName: CapyKit.Helpers.ValidCharacterCollection
- uid: CapyKit.Helpers.SerializationHelper
commentId: T:CapyKit.Helpers.SerializationHelper
href: CapyKit.Helpers.SerializationHelper.html
name: SerializationHelper
nameWithType: SerializationHelper
fullName: CapyKit.Helpers.SerializationHelper
- uid: CapyKit.Helpers.SettingsHelper
commentId: T:CapyKit.Helpers.SettingsHelper
href: CapyKit.Helpers.SettingsHelper.html
name: SettingsHelper
nameWithType: SettingsHelper
fullName: CapyKit.Helpers.SettingsHelper
- uid: CapyKit.Helpers
commentId: N:CapyKit.Helpers
href: CapyKit.html
name: CapyKit.Helpers
nameWithType: CapyKit.Helpers
fullName: CapyKit.Helpers
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Helpers
name: Helpers
href: CapyKit.Helpers.html

View file

@ -0,0 +1,85 @@
# <a id="CapyKit_IPasswordAlgorithm"></a> Interface IPasswordAlgorithm
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
Defines the contract for password encryption algorithms.
```csharp
public interface IPasswordAlgorithm
```
#### Extension Methods
[ObjectExtensions.UpdateProperties<IPasswordAlgorithm\>\(IPasswordAlgorithm, IPasswordAlgorithm\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Properties
### <a id="CapyKit_IPasswordAlgorithm_AlgorithmName"></a> AlgorithmName
Gets the name of the algorithm.
```csharp
string AlgorithmName { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
## Methods
### <a id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___"></a> Compare\(string, byte\[\], params object\[\]\)
Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.
```csharp
bool Compare(string password, byte[] encryptedValue, params object[] args)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The plaintext password to compare.
`encryptedValue` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
The encrypted value to compare against.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Additional arguments for the encryption process, such as salt and length.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
false if they are different.
### <a id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___"></a> Encrypt\(string, params object\[\]\)
Encrypts the given password using a defined algorithm.
```csharp
byte[] Encrypt(string password, params object[] args)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The plaintext password.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Additional arguments for the encryption process, such as salt and length.
#### Returns
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
A byte array with the hashed <code class="paramref">password</code>.

View file

@ -1,459 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.IPasswordAlgorithm
commentId: T:CapyKit.IPasswordAlgorithm
id: IPasswordAlgorithm
parent: CapyKit
children:
- CapyKit.IPasswordAlgorithm.AlgorithmName
- CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])
- CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
langs:
- csharp
- vb
name: IPasswordAlgorithm
nameWithType: IPasswordAlgorithm
fullName: CapyKit.IPasswordAlgorithm
type: Interface
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: IPasswordAlgorithm
path: ../CapyKit/Password.cs
startLine: 121
assemblies:
- CapyKit
namespace: CapyKit
summary: Defines the contract for password encryption algorithms.
example: []
syntax:
content: public interface IPasswordAlgorithm
content.vb: Public Interface IPasswordAlgorithm
derivedClasses:
- CapyKit.Pbkdf2Algorithm
extensionMethods:
- CapyKit.IPasswordAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.IPasswordAlgorithm.AlgorithmName
commentId: P:CapyKit.IPasswordAlgorithm.AlgorithmName
id: AlgorithmName
parent: CapyKit.IPasswordAlgorithm
langs:
- csharp
- vb
name: AlgorithmName
nameWithType: IPasswordAlgorithm.AlgorithmName
fullName: CapyKit.IPasswordAlgorithm.AlgorithmName
type: Property
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: AlgorithmName
path: ../CapyKit/Password.cs
startLine: 128
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the name of the algorithm.
example: []
syntax:
content: string AlgorithmName { get; }
parameters: []
return:
type: System.String
content.vb: ReadOnly Property AlgorithmName As String
overload: CapyKit.IPasswordAlgorithm.AlgorithmName*
- uid: CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
commentId: M:CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
id: Encrypt(System.String,System.Object[])
parent: CapyKit.IPasswordAlgorithm
langs:
- csharp
- vb
name: Encrypt(string, params object[])
nameWithType: IPasswordAlgorithm.Encrypt(string, params object[])
fullName: CapyKit.IPasswordAlgorithm.Encrypt(string, params object[])
type: Method
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Encrypt
path: ../CapyKit/Password.cs
startLine: 140
assemblies:
- CapyKit
namespace: CapyKit
summary: Encrypts the given password using a defined algorithm.
example: []
syntax:
content: byte[] Encrypt(string password, params object[] args)
parameters:
- id: password
type: System.String
description: The plaintext password.
- id: args
type: System.Object[]
description: Additional arguments for the encryption process, such as salt and length.
return:
type: System.Byte[]
description: A byte array with the hashed <code class="paramref">password</code>.
content.vb: Function Encrypt(password As String, ParamArray args As Object()) As Byte()
overload: CapyKit.IPasswordAlgorithm.Encrypt*
nameWithType.vb: IPasswordAlgorithm.Encrypt(String, ParamArray Object())
fullName.vb: CapyKit.IPasswordAlgorithm.Encrypt(String, ParamArray Object())
name.vb: Encrypt(String, ParamArray Object())
- uid: CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])
commentId: M:CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])
id: Compare(System.String,System.Byte[],System.Object[])
parent: CapyKit.IPasswordAlgorithm
langs:
- csharp
- vb
name: Compare(string, byte[], params object[])
nameWithType: IPasswordAlgorithm.Compare(string, byte[], params object[])
fullName: CapyKit.IPasswordAlgorithm.Compare(string, byte[], params object[])
type: Method
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Compare
path: ../CapyKit/Password.cs
startLine: 154
assemblies:
- CapyKit
namespace: CapyKit
summary: Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.
example: []
syntax:
content: bool Compare(string password, byte[] encryptedValue, params object[] args)
parameters:
- id: password
type: System.String
description: The plaintext password to compare.
- id: encryptedValue
type: System.Byte[]
description: The encrypted value to compare against.
- id: args
type: System.Object[]
description: Additional arguments for the encryption process, such as salt and length.
return:
type: System.Boolean
description: >-
True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
false if they are different.
content.vb: Function Compare(password As String, encryptedValue As Byte(), ParamArray args As Object()) As Boolean
overload: CapyKit.IPasswordAlgorithm.Compare*
nameWithType.vb: IPasswordAlgorithm.Compare(String, Byte(), ParamArray Object())
fullName.vb: CapyKit.IPasswordAlgorithm.Compare(String, Byte(), ParamArray Object())
name.vb: Compare(String, Byte(), ParamArray Object())
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: CapyKit.IPasswordAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)
nameWithType: ObjectExtensions.UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.IPasswordAlgorithm>(CapyKit.IPasswordAlgorithm, CapyKit.IPasswordAlgorithm)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of IPasswordAlgorithm)(IPasswordAlgorithm, IPasswordAlgorithm)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.IPasswordAlgorithm)(CapyKit.IPasswordAlgorithm, CapyKit.IPasswordAlgorithm)
name.vb: UpdateProperties(Of IPasswordAlgorithm)(IPasswordAlgorithm, IPasswordAlgorithm)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm,CapyKit.IPasswordAlgorithm)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html
- name: '>'
- name: (
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html
- name: ','
- name: " "
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.IPasswordAlgorithm,CapyKit.IPasswordAlgorithm)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html
- name: )
- name: (
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html
- name: ','
- name: " "
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.IPasswordAlgorithm.AlgorithmName*
commentId: Overload:CapyKit.IPasswordAlgorithm.AlgorithmName
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_AlgorithmName
name: AlgorithmName
nameWithType: IPasswordAlgorithm.AlgorithmName
fullName: CapyKit.IPasswordAlgorithm.AlgorithmName
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.IPasswordAlgorithm.Encrypt*
commentId: Overload:CapyKit.IPasswordAlgorithm.Encrypt
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___
name: Encrypt
nameWithType: IPasswordAlgorithm.Encrypt
fullName: CapyKit.IPasswordAlgorithm.Encrypt
- uid: System.Object[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object[]
nameWithType: object[]
fullName: object[]
nameWithType.vb: Object()
fullName.vb: Object()
name.vb: Object()
spec.csharp:
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '['
- name: ']'
spec.vb:
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: (
- name: )
- uid: System.Byte[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
name: byte[]
nameWithType: byte[]
fullName: byte[]
nameWithType.vb: Byte()
fullName.vb: Byte()
name.vb: Byte()
spec.csharp:
- uid: System.Byte
name: byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: '['
- name: ']'
spec.vb:
- uid: System.Byte
name: Byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: (
- name: )
- uid: CapyKit.IPasswordAlgorithm.Compare*
commentId: Overload:CapyKit.IPasswordAlgorithm.Compare
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___
name: Compare
nameWithType: IPasswordAlgorithm.Compare
fullName: CapyKit.IPasswordAlgorithm.Compare
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,179 @@
# <a id="CapyKit_Password"></a> Class Password
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
Represents a password with its hash, salt and algorithm used for encryption.
```csharp
public class Password
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Password](CapyKit.Password.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<Password\>\(Password, Password\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"></a> Password\(string, byte\[\], IPasswordAlgorithm, params object\[\]\)
Constructor.
```csharp
public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The password to be hashed.
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
The salt used for encryption.
`algorithm` [IPasswordAlgorithm](CapyKit.IPasswordAlgorithm.md)
The algorithm used for password encryption.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.
## Properties
### <a id="CapyKit_Password_Algorithm"></a> Algorithm
Gets or sets the algorithm used for password encryption.
```csharp
public IPasswordAlgorithm Algorithm { get; }
```
#### Property Value
[IPasswordAlgorithm](CapyKit.IPasswordAlgorithm.md)
### <a id="CapyKit_Password_Hash"></a> Hash
Gets or sets the hash of the password.
```csharp
public byte[] Hash { get; }
```
#### Property Value
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
### <a id="CapyKit_Password_Pbkdf2Algorithm"></a> Pbkdf2Algorithm
Gets the preconfigured PBKDF2 algorithm.
```csharp
public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
```
#### Property Value
[Pbkdf2Algorithm](CapyKit.Pbkdf2Algorithm.md)
### <a id="CapyKit_Password_Salt"></a> Salt
Gets or sets the salt used for encryption.
```csharp
public byte[] Salt { get; }
```
#### Property Value
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
## Methods
### <a id="CapyKit_Password_Equals_System_Object_"></a> Equals\(object?\)
Determines whether the specified object is equal to the current object.
```csharp
public override bool Equals(object? obj)
```
#### Parameters
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)?
The object to compare with the current object.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.
### <a id="CapyKit_Password_ToString"></a> ToString\(\)
Returns a string that represents the current object.
```csharp
public override string ToString()
```
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A string that represents the current object.
## Operators
### <a id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_"></a> operator ==\(Password, Password\)
```csharp
public static bool operator ==(Password a, Password b)
```
#### Parameters
`a` [Password](CapyKit.Password.md)
`b` [Password](CapyKit.Password.md)
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
### <a id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_"></a> operator \!=\(Password, Password\)
```csharp
public static bool operator !=(Password a, Password b)
```
#### Parameters
`a` [Password](CapyKit.Password.md)
`b` [Password](CapyKit.Password.md)
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

View file

@ -1,974 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Password
commentId: T:CapyKit.Password
id: Password
parent: CapyKit
children:
- CapyKit.Password.#ctor(System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])
- CapyKit.Password.Algorithm
- CapyKit.Password.Equals(System.Object)
- CapyKit.Password.Hash
- CapyKit.Password.Pbkdf2Algorithm
- CapyKit.Password.Salt
- CapyKit.Password.ToString
- CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)
- CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)
langs:
- csharp
- vb
name: Password
nameWithType: Password
fullName: CapyKit.Password
type: Class
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Password
path: ../CapyKit/Password.cs
startLine: 14
assemblies:
- CapyKit
namespace: CapyKit
summary: Represents a password with its hash, salt and algorithm used for encryption.
example: []
syntax:
content: public class Password
content.vb: Public Class Password
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
extensionMethods:
- CapyKit.Password.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Password)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Password.Hash
commentId: P:CapyKit.Password.Hash
id: Hash
parent: CapyKit.Password
langs:
- csharp
- vb
name: Hash
nameWithType: Password.Hash
fullName: CapyKit.Password.Hash
type: Property
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Hash
path: ../CapyKit/Password.cs
startLine: 27
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets or sets the hash of the password.
example: []
syntax:
content: public byte[] Hash { get; }
parameters: []
return:
type: System.Byte[]
content.vb: Public Property Hash As Byte()
overload: CapyKit.Password.Hash*
- uid: CapyKit.Password.Salt
commentId: P:CapyKit.Password.Salt
id: Salt
parent: CapyKit.Password
langs:
- csharp
- vb
name: Salt
nameWithType: Password.Salt
fullName: CapyKit.Password.Salt
type: Property
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Salt
path: ../CapyKit/Password.cs
startLine: 32
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets or sets the salt used for encryption.
example: []
syntax:
content: public byte[] Salt { get; }
parameters: []
return:
type: System.Byte[]
content.vb: Public Property Salt As Byte()
overload: CapyKit.Password.Salt*
- uid: CapyKit.Password.Algorithm
commentId: P:CapyKit.Password.Algorithm
id: Algorithm
parent: CapyKit.Password
langs:
- csharp
- vb
name: Algorithm
nameWithType: Password.Algorithm
fullName: CapyKit.Password.Algorithm
type: Property
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Algorithm
path: ../CapyKit/Password.cs
startLine: 37
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets or sets the algorithm used for password encryption.
example: []
syntax:
content: public IPasswordAlgorithm Algorithm { get; }
parameters: []
return:
type: CapyKit.IPasswordAlgorithm
content.vb: Public Property Algorithm As IPasswordAlgorithm
overload: CapyKit.Password.Algorithm*
- uid: CapyKit.Password.Pbkdf2Algorithm
commentId: P:CapyKit.Password.Pbkdf2Algorithm
id: Pbkdf2Algorithm
parent: CapyKit.Password
langs:
- csharp
- vb
name: Pbkdf2Algorithm
nameWithType: Password.Pbkdf2Algorithm
fullName: CapyKit.Password.Pbkdf2Algorithm
type: Property
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Pbkdf2Algorithm
path: ../CapyKit/Password.cs
startLine: 43
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the preconfigured PBKDF2 algorithm.
example: []
syntax:
content: public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
parameters: []
return:
type: CapyKit.Pbkdf2Algorithm
description: The preconfigured PBKDF2 algorithm.
content.vb: Public Shared ReadOnly Property Pbkdf2Algorithm As Pbkdf2Algorithm
overload: CapyKit.Password.Pbkdf2Algorithm*
- uid: CapyKit.Password.#ctor(System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])
commentId: M:CapyKit.Password.#ctor(System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])
id: '#ctor(System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])'
parent: CapyKit.Password
langs:
- csharp
- vb
name: Password(string, byte[], IPasswordAlgorithm, params object[])
nameWithType: Password.Password(string, byte[], IPasswordAlgorithm, params object[])
fullName: CapyKit.Password.Password(string, byte[], CapyKit.IPasswordAlgorithm, params object[])
type: Constructor
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: .ctor
path: ../CapyKit/Password.cs
startLine: 60
assemblies:
- CapyKit
namespace: CapyKit
summary: Constructor.
example: []
syntax:
content: public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
parameters:
- id: password
type: System.String
description: The password to be hashed.
- id: salt
type: System.Byte[]
description: The salt used for encryption.
- id: algorithm
type: CapyKit.IPasswordAlgorithm
description: The algorithm used for password encryption.
- id: args
type: System.Object[]
description: A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.
content.vb: Public Sub New(password As String, salt As Byte(), algorithm As IPasswordAlgorithm, ParamArray args As Object())
overload: CapyKit.Password.#ctor*
nameWithType.vb: Password.New(String, Byte(), IPasswordAlgorithm, ParamArray Object())
fullName.vb: CapyKit.Password.New(String, Byte(), CapyKit.IPasswordAlgorithm, ParamArray Object())
name.vb: New(String, Byte(), IPasswordAlgorithm, ParamArray Object())
- uid: CapyKit.Password.Equals(System.Object)
commentId: M:CapyKit.Password.Equals(System.Object)
id: Equals(System.Object)
parent: CapyKit.Password
langs:
- csharp
- vb
name: Equals(object?)
nameWithType: Password.Equals(object?)
fullName: CapyKit.Password.Equals(object?)
type: Method
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Equals
path: ../CapyKit/Password.cs
startLine: 73
assemblies:
- CapyKit
namespace: CapyKit
summary: Determines whether the specified object is equal to the current object.
example: []
syntax:
content: public override bool Equals(object? obj)
parameters:
- id: obj
type: System.Object
description: The object to compare with the current object.
return:
type: System.Boolean
description: <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified object is equal to the current object; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.
content.vb: Public Overrides Function Equals(obj As Object) As Boolean
overridden: System.Object.Equals(System.Object)
overload: CapyKit.Password.Equals*
nameWithType.vb: Password.Equals(Object)
fullName.vb: CapyKit.Password.Equals(Object)
name.vb: Equals(Object)
- uid: CapyKit.Password.ToString
commentId: M:CapyKit.Password.ToString
id: ToString
parent: CapyKit.Password
langs:
- csharp
- vb
name: ToString()
nameWithType: Password.ToString()
fullName: CapyKit.Password.ToString()
type: Method
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: ToString
path: ../CapyKit/Password.cs
startLine: 92
assemblies:
- CapyKit
namespace: CapyKit
summary: Returns a string that represents the current object.
example: []
syntax:
content: public override string ToString()
return:
type: System.String
description: A string that represents the current object.
content.vb: Public Overrides Function ToString() As String
overridden: System.Object.ToString
overload: CapyKit.Password.ToString*
- uid: CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)
commentId: M:CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)
id: op_Equality(CapyKit.Password,CapyKit.Password)
parent: CapyKit.Password
langs:
- csharp
- vb
name: operator ==(Password, Password)
nameWithType: Password.operator ==(Password, Password)
fullName: CapyKit.Password.operator ==(CapyKit.Password, CapyKit.Password)
type: Operator
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: op_Equality
path: ../CapyKit/Password.cs
startLine: 102
assemblies:
- CapyKit
namespace: CapyKit
example: []
syntax:
content: public static bool operator ==(Password a, Password b)
parameters:
- id: a
type: CapyKit.Password
- id: b
type: CapyKit.Password
return:
type: System.Boolean
content.vb: Public Shared Operator =(a As Password, b As Password) As Boolean
overload: CapyKit.Password.op_Equality*
nameWithType.vb: Password.=(Password, Password)
fullName.vb: CapyKit.Password.=(CapyKit.Password, CapyKit.Password)
name.vb: =(Password, Password)
- uid: CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)
commentId: M:CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)
id: op_Inequality(CapyKit.Password,CapyKit.Password)
parent: CapyKit.Password
langs:
- csharp
- vb
name: operator !=(Password, Password)
nameWithType: Password.operator !=(Password, Password)
fullName: CapyKit.Password.operator !=(CapyKit.Password, CapyKit.Password)
type: Operator
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: op_Inequality
path: ../CapyKit/Password.cs
startLine: 110
assemblies:
- CapyKit
namespace: CapyKit
example: []
syntax:
content: public static bool operator !=(Password a, Password b)
parameters:
- id: a
type: CapyKit.Password
- id: b
type: CapyKit.Password
return:
type: System.Boolean
content.vb: Public Shared Operator <>(a As Password, b As Password) As Boolean
overload: CapyKit.Password.op_Inequality*
nameWithType.vb: Password.<>(Password, Password)
fullName.vb: CapyKit.Password.<>(CapyKit.Password, CapyKit.Password)
name.vb: <>(Password, Password)
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Password.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Password)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<Password>(Password, Password)
nameWithType: ObjectExtensions.UpdateProperties<Password>(Password, Password)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Password>(CapyKit.Password, CapyKit.Password)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of Password)(Password, Password)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Password)(CapyKit.Password, CapyKit.Password)
name.vb: UpdateProperties(Of Password)(Password, Password)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Password,CapyKit.Password)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Password
name: Password
href: CapyKit.Password.html
- name: '>'
- name: (
- uid: CapyKit.Password
name: Password
href: CapyKit.Password.html
- name: ','
- name: " "
- uid: CapyKit.Password
name: Password
href: CapyKit.Password.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Password,CapyKit.Password)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Password
name: Password
href: CapyKit.Password.html
- name: )
- name: (
- uid: CapyKit.Password
name: Password
href: CapyKit.Password.html
- name: ','
- name: " "
- uid: CapyKit.Password
name: Password
href: CapyKit.Password.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.Password.Hash*
commentId: Overload:CapyKit.Password.Hash
href: CapyKit.Password.html#CapyKit_Password_Hash
name: Hash
nameWithType: Password.Hash
fullName: CapyKit.Password.Hash
- uid: System.Byte[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
name: byte[]
nameWithType: byte[]
fullName: byte[]
nameWithType.vb: Byte()
fullName.vb: Byte()
name.vb: Byte()
spec.csharp:
- uid: System.Byte
name: byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: '['
- name: ']'
spec.vb:
- uid: System.Byte
name: Byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: (
- name: )
- uid: CapyKit.Password.Salt*
commentId: Overload:CapyKit.Password.Salt
href: CapyKit.Password.html#CapyKit_Password_Salt
name: Salt
nameWithType: Password.Salt
fullName: CapyKit.Password.Salt
- uid: CapyKit.Password.Algorithm*
commentId: Overload:CapyKit.Password.Algorithm
href: CapyKit.Password.html#CapyKit_Password_Algorithm
name: Algorithm
nameWithType: Password.Algorithm
fullName: CapyKit.Password.Algorithm
- uid: CapyKit.IPasswordAlgorithm
commentId: T:CapyKit.IPasswordAlgorithm
parent: CapyKit
href: CapyKit.IPasswordAlgorithm.html
name: IPasswordAlgorithm
nameWithType: IPasswordAlgorithm
fullName: CapyKit.IPasswordAlgorithm
- uid: CapyKit.Password.Pbkdf2Algorithm*
commentId: Overload:CapyKit.Password.Pbkdf2Algorithm
href: CapyKit.Password.html#CapyKit_Password_Pbkdf2Algorithm
name: Pbkdf2Algorithm
nameWithType: Password.Pbkdf2Algorithm
fullName: CapyKit.Password.Pbkdf2Algorithm
- uid: CapyKit.Pbkdf2Algorithm
commentId: T:CapyKit.Pbkdf2Algorithm
parent: CapyKit
href: CapyKit.Pbkdf2Algorithm.html
name: Pbkdf2Algorithm
nameWithType: Pbkdf2Algorithm
fullName: CapyKit.Pbkdf2Algorithm
- uid: CapyKit.Password.#ctor*
commentId: Overload:CapyKit.Password.#ctor
href: CapyKit.Password.html#CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___
name: Password
nameWithType: Password.Password
fullName: CapyKit.Password.Password
nameWithType.vb: Password.New
fullName.vb: CapyKit.Password.New
name.vb: New
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: System.Object[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object[]
nameWithType: object[]
fullName: object[]
nameWithType.vb: Object()
fullName.vb: Object()
name.vb: Object()
spec.csharp:
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '['
- name: ']'
spec.vb:
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: (
- name: )
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Password.Equals*
commentId: Overload:CapyKit.Password.Equals
href: CapyKit.Password.html#CapyKit_Password_Equals_System_Object_
name: Equals
nameWithType: Password.Equals
fullName: CapyKit.Password.Equals
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.Password.ToString*
commentId: Overload:CapyKit.Password.ToString
href: CapyKit.Password.html#CapyKit_Password_ToString
name: ToString
nameWithType: Password.ToString
fullName: CapyKit.Password.ToString
- uid: CapyKit.Password.op_Equality*
commentId: Overload:CapyKit.Password.op_Equality
href: CapyKit.Password.html#CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_
name: operator ==
nameWithType: Password.operator ==
fullName: CapyKit.Password.operator ==
nameWithType.vb: Password.=
fullName.vb: CapyKit.Password.=
name.vb: =
spec.csharp:
- name: operator
- name: " "
- uid: CapyKit.Password.op_Equality*
name: ==
href: CapyKit.Password.html#CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_
- uid: CapyKit.Password
commentId: T:CapyKit.Password
parent: CapyKit
href: CapyKit.Password.html
name: Password
nameWithType: Password
fullName: CapyKit.Password
- uid: CapyKit.Password.op_Inequality*
commentId: Overload:CapyKit.Password.op_Inequality
href: CapyKit.Password.html#CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_
name: operator !=
nameWithType: Password.operator !=
fullName: CapyKit.Password.operator !=
nameWithType.vb: Password.<>
fullName.vb: CapyKit.Password.<>
name.vb: <>
spec.csharp:
- name: operator
- name: " "
- uid: CapyKit.Password.op_Inequality*
name: '!='
href: CapyKit.Password.html#CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_

View file

@ -0,0 +1,121 @@
# <a id="CapyKit_Pbkdf2Algorithm"></a> Class Pbkdf2Algorithm
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
Implements the PBKDF2 algorithm for password encryption.
```csharp
public class Pbkdf2Algorithm : IPasswordAlgorithm
```
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Pbkdf2Algorithm](CapyKit.Pbkdf2Algorithm.md)
#### Implements
[IPasswordAlgorithm](CapyKit.IPasswordAlgorithm.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<Pbkdf2Algorithm\>\(Pbkdf2Algorithm, Pbkdf2Algorithm\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Pbkdf2Algorithm__ctor"></a> Pbkdf2Algorithm\(\)
Default constructor.
```csharp
public Pbkdf2Algorithm()
```
## Fields
### <a id="CapyKit_Pbkdf2Algorithm_ITERATIONS"></a> ITERATIONS
The default number of iterations.
```csharp
public const int ITERATIONS = 100000
```
#### Field Value
[int](https://learn.microsoft.com/dotnet/api/system.int32)
#### Remarks
This member is immutable.
### <a id="CapyKit_Pbkdf2Algorithm_LENGTH"></a> LENGTH
(Immutable) The default length.
```csharp
public const int LENGTH = 32
```
#### Field Value
[int](https://learn.microsoft.com/dotnet/api/system.int32)
#### Remarks
This member is immutable.
## Properties
### <a id="CapyKit_Pbkdf2Algorithm_AlgorithmName"></a> AlgorithmName
Gets the name of the algorithm.
```csharp
public string AlgorithmName { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
## Methods
### <a id="CapyKit_Pbkdf2Algorithm_Encrypt_System_String_System_Object___"></a> Encrypt\(string, params object\[\]\)
Encrypts the given password using a PBKDF2 algorithm.
```csharp
public byte[] Encrypt(string password, params object[] args)
```
#### Parameters
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
The plaintext password.
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
Additional arguments for the encryption process, specifically
<ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
#### Returns
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
A byte array with the hashed <code class="paramref">password</code>.

View file

@ -1,821 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.Pbkdf2Algorithm
commentId: T:CapyKit.Pbkdf2Algorithm
id: Pbkdf2Algorithm
parent: CapyKit
children:
- CapyKit.Pbkdf2Algorithm.#ctor
- CapyKit.Pbkdf2Algorithm.AlgorithmName
- CapyKit.Pbkdf2Algorithm.Encrypt(System.String,System.Object[])
- CapyKit.Pbkdf2Algorithm.ITERATIONS
- CapyKit.Pbkdf2Algorithm.LENGTH
langs:
- csharp
- vb
name: Pbkdf2Algorithm
nameWithType: Pbkdf2Algorithm
fullName: CapyKit.Pbkdf2Algorithm
type: Class
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Pbkdf2Algorithm
path: ../CapyKit/Password.cs
startLine: 169
assemblies:
- CapyKit
namespace: CapyKit
summary: Implements the PBKDF2 algorithm for password encryption.
example: []
syntax:
content: 'public class Pbkdf2Algorithm : IPasswordAlgorithm'
content.vb: Public Class Pbkdf2Algorithm Implements IPasswordAlgorithm
inheritance:
- System.Object
implements:
- CapyKit.IPasswordAlgorithm
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
extensionMethods:
- CapyKit.Pbkdf2Algorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Pbkdf2Algorithm)
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
- uid: CapyKit.Pbkdf2Algorithm.LENGTH
commentId: F:CapyKit.Pbkdf2Algorithm.LENGTH
id: LENGTH
parent: CapyKit.Pbkdf2Algorithm
langs:
- csharp
- vb
name: LENGTH
nameWithType: Pbkdf2Algorithm.LENGTH
fullName: CapyKit.Pbkdf2Algorithm.LENGTH
type: Field
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: LENGTH
path: ../CapyKit/Password.cs
startLine: 175
assemblies:
- CapyKit
namespace: CapyKit
summary: (Immutable) The default length.
remarks: This member is immutable.
example: []
syntax:
content: public const int LENGTH = 32
return:
type: System.Int32
content.vb: Public Const LENGTH As Integer = 32
- uid: CapyKit.Pbkdf2Algorithm.ITERATIONS
commentId: F:CapyKit.Pbkdf2Algorithm.ITERATIONS
id: ITERATIONS
parent: CapyKit.Pbkdf2Algorithm
langs:
- csharp
- vb
name: ITERATIONS
nameWithType: Pbkdf2Algorithm.ITERATIONS
fullName: CapyKit.Pbkdf2Algorithm.ITERATIONS
type: Field
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: ITERATIONS
path: ../CapyKit/Password.cs
startLine: 179
assemblies:
- CapyKit
namespace: CapyKit
summary: The default number of iterations.
remarks: This member is immutable.
example: []
syntax:
content: public const int ITERATIONS = 100000
return:
type: System.Int32
content.vb: Public Const ITERATIONS As Integer = 100000
- uid: CapyKit.Pbkdf2Algorithm.AlgorithmName
commentId: P:CapyKit.Pbkdf2Algorithm.AlgorithmName
id: AlgorithmName
parent: CapyKit.Pbkdf2Algorithm
langs:
- csharp
- vb
name: AlgorithmName
nameWithType: Pbkdf2Algorithm.AlgorithmName
fullName: CapyKit.Pbkdf2Algorithm.AlgorithmName
type: Property
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: AlgorithmName
path: ../CapyKit/Password.cs
startLine: 186
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the name of the algorithm.
example: []
syntax:
content: public string AlgorithmName { get; }
parameters: []
return:
type: System.String
content.vb: Public ReadOnly Property AlgorithmName As String
overload: CapyKit.Pbkdf2Algorithm.AlgorithmName*
implements:
- CapyKit.IPasswordAlgorithm.AlgorithmName
- uid: CapyKit.Pbkdf2Algorithm.#ctor
commentId: M:CapyKit.Pbkdf2Algorithm.#ctor
id: '#ctor'
parent: CapyKit.Pbkdf2Algorithm
langs:
- csharp
- vb
name: Pbkdf2Algorithm()
nameWithType: Pbkdf2Algorithm.Pbkdf2Algorithm()
fullName: CapyKit.Pbkdf2Algorithm.Pbkdf2Algorithm()
type: Constructor
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: .ctor
path: ../CapyKit/Password.cs
startLine: 199
assemblies:
- CapyKit
namespace: CapyKit
summary: Default constructor.
example: []
syntax:
content: public Pbkdf2Algorithm()
content.vb: Public Sub New()
overload: CapyKit.Pbkdf2Algorithm.#ctor*
nameWithType.vb: Pbkdf2Algorithm.New()
fullName.vb: CapyKit.Pbkdf2Algorithm.New()
name.vb: New()
- uid: CapyKit.Pbkdf2Algorithm.Encrypt(System.String,System.Object[])
commentId: M:CapyKit.Pbkdf2Algorithm.Encrypt(System.String,System.Object[])
id: Encrypt(System.String,System.Object[])
parent: CapyKit.Pbkdf2Algorithm
langs:
- csharp
- vb
name: Encrypt(string, params object[])
nameWithType: Pbkdf2Algorithm.Encrypt(string, params object[])
fullName: CapyKit.Pbkdf2Algorithm.Encrypt(string, params object[])
type: Method
source:
remote:
path: CapyKit/Password.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Encrypt
path: ../CapyKit/Password.cs
startLine: 219
assemblies:
- CapyKit
namespace: CapyKit
summary: Encrypts the given password using a PBKDF2 algorithm.
example: []
syntax:
content: public byte[] Encrypt(string password, params object[] args)
parameters:
- id: password
type: System.String
description: The plaintext password.
- id: args
type: System.Object[]
description: >-
Additional arguments for the encryption process, specifically
<ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
return:
type: System.Byte[]
description: A byte array with the hashed <code class="paramref">password</code>.
content.vb: Public Function Encrypt(password As String, ParamArray args As Object()) As Byte()
overload: CapyKit.Pbkdf2Algorithm.Encrypt*
implements:
- CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
nameWithType.vb: Pbkdf2Algorithm.Encrypt(String, ParamArray Object())
fullName.vb: CapyKit.Pbkdf2Algorithm.Encrypt(String, ParamArray Object())
name.vb: Encrypt(String, ParamArray Object())
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: CapyKit.IPasswordAlgorithm
commentId: T:CapyKit.IPasswordAlgorithm
parent: CapyKit
href: CapyKit.IPasswordAlgorithm.html
name: IPasswordAlgorithm
nameWithType: IPasswordAlgorithm
fullName: CapyKit.IPasswordAlgorithm
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.Pbkdf2Algorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Pbkdf2Algorithm)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<Pbkdf2Algorithm>(Pbkdf2Algorithm, Pbkdf2Algorithm)
nameWithType: ObjectExtensions.UpdateProperties<Pbkdf2Algorithm>(Pbkdf2Algorithm, Pbkdf2Algorithm)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Pbkdf2Algorithm>(CapyKit.Pbkdf2Algorithm, CapyKit.Pbkdf2Algorithm)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of Pbkdf2Algorithm)(Pbkdf2Algorithm, Pbkdf2Algorithm)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Pbkdf2Algorithm)(CapyKit.Pbkdf2Algorithm, CapyKit.Pbkdf2Algorithm)
name.vb: UpdateProperties(Of Pbkdf2Algorithm)(Pbkdf2Algorithm, Pbkdf2Algorithm)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Pbkdf2Algorithm,CapyKit.Pbkdf2Algorithm)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.html
- name: '>'
- name: (
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.html
- name: ','
- name: " "
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.html
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Pbkdf2Algorithm,CapyKit.Pbkdf2Algorithm)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.html
- name: )
- name: (
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.html
- name: ','
- name: " "
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.html
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.int32
name: int
nameWithType: int
fullName: int
nameWithType.vb: Integer
fullName.vb: Integer
name.vb: Integer
- uid: CapyKit.Pbkdf2Algorithm.AlgorithmName*
commentId: Overload:CapyKit.Pbkdf2Algorithm.AlgorithmName
href: CapyKit.Pbkdf2Algorithm.html#CapyKit_Pbkdf2Algorithm_AlgorithmName
name: AlgorithmName
nameWithType: Pbkdf2Algorithm.AlgorithmName
fullName: CapyKit.Pbkdf2Algorithm.AlgorithmName
- uid: CapyKit.IPasswordAlgorithm.AlgorithmName
commentId: P:CapyKit.IPasswordAlgorithm.AlgorithmName
parent: CapyKit.IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_AlgorithmName
name: AlgorithmName
nameWithType: IPasswordAlgorithm.AlgorithmName
fullName: CapyKit.IPasswordAlgorithm.AlgorithmName
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.Pbkdf2Algorithm.#ctor*
commentId: Overload:CapyKit.Pbkdf2Algorithm.#ctor
href: CapyKit.Pbkdf2Algorithm.html#CapyKit_Pbkdf2Algorithm__ctor
name: Pbkdf2Algorithm
nameWithType: Pbkdf2Algorithm.Pbkdf2Algorithm
fullName: CapyKit.Pbkdf2Algorithm.Pbkdf2Algorithm
nameWithType.vb: Pbkdf2Algorithm.New
fullName.vb: CapyKit.Pbkdf2Algorithm.New
name.vb: New
- uid: CapyKit.Pbkdf2Algorithm.Encrypt*
commentId: Overload:CapyKit.Pbkdf2Algorithm.Encrypt
href: CapyKit.Pbkdf2Algorithm.html#CapyKit_Pbkdf2Algorithm_Encrypt_System_String_System_Object___
name: Encrypt
nameWithType: Pbkdf2Algorithm.Encrypt
fullName: CapyKit.Pbkdf2Algorithm.Encrypt
- uid: CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
commentId: M:CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
parent: CapyKit.IPasswordAlgorithm
isExternal: true
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___
name: Encrypt(string, params object[])
nameWithType: IPasswordAlgorithm.Encrypt(string, params object[])
fullName: CapyKit.IPasswordAlgorithm.Encrypt(string, params object[])
nameWithType.vb: IPasswordAlgorithm.Encrypt(String, ParamArray Object())
fullName.vb: CapyKit.IPasswordAlgorithm.Encrypt(String, ParamArray Object())
name.vb: Encrypt(String, ParamArray Object())
spec.csharp:
- uid: CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
name: Encrypt
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___
- name: (
- uid: System.String
name: string
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- name: params
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '['
- name: ']'
- name: )
spec.vb:
- uid: CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])
name: Encrypt
href: CapyKit.IPasswordAlgorithm.html#CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___
- name: (
- uid: System.String
name: String
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
- name: ','
- name: " "
- name: ParamArray
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: (
- name: )
- name: )
- uid: System.Object[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object[]
nameWithType: object[]
fullName: object[]
nameWithType.vb: Object()
fullName.vb: Object()
name.vb: Object()
spec.csharp:
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: '['
- name: ']'
spec.vb:
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: (
- name: )
- uid: System.Byte[]
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
name: byte[]
nameWithType: byte[]
fullName: byte[]
nameWithType.vb: Byte()
fullName.vb: Byte()
name.vb: Byte()
spec.csharp:
- uid: System.Byte
name: byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: '['
- name: ']'
spec.vb:
- uid: System.Byte
name: Byte
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.byte
- name: (
- name: )

123
Docs/api/CapyKit.Pool-1.md Normal file
View file

@ -0,0 +1,123 @@
# <a id="CapyKit_Pool_1"></a> Class Pool<T\>
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
A managed pool of resources. This class provides a thread-safe way to manage a collection of
objects of type <code class="typeparamref">T</code>.
```csharp
public class Pool<T>
```
#### Type Parameters
`T`
The type of objects to be managed by the pool.
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Pool<T\>](CapyKit.Pool\-1.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<Pool<T\>\>\(Pool<T\>, Pool<T\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Constructors
### <a id="CapyKit_Pool_1__ctor_System_Int32_"></a> Pool\(int\)
Initializes a new instance of the <xref href="CapyKit.Pool%601" data-throw-if-not-resolved="false"></xref> class with the specified pool size.
```csharp
public Pool(int poolSize)
```
#### Parameters
`poolSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The size of the pool.
### <a id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__"></a> Pool\(int, Func<T\>\)
Initializes a new instance of the <xref href="CapyKit.Pool%601" data-throw-if-not-resolved="false"></xref> class with the specified pool size
and constructor selector.
```csharp
public Pool(int poolSize, Func<T> constructorSelector)
```
#### Parameters
`poolSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
The size of the pool.
`constructorSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<T\>
The constructor selector used to create new instances of <code class="typeparamref">T</code>.
### <a id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__"></a> Pool\(IEnumerable<T\>\)
Initializes a new instance of the <xref href="CapyKit.Pool%601" data-throw-if-not-resolved="false"></xref> class with the specified collection
of items.
```csharp
public Pool(IEnumerable<T> collection)
```
#### Parameters
`collection` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
The collection of <code class="typeparamref">T</code> items with which to seed the pool.
## Methods
### <a id="CapyKit_Pool_1_GetAvailableItem"></a> GetAvailableItem\(\)
Gets the first available item from the pool and sets its lock.
```csharp
public PoolItem<T> GetAvailableItem()
```
#### Returns
[PoolItem](CapyKit.PoolItem\-1.md)<T\>
The first available item from the pool.
### <a id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0__"></a> ReleaseItem\(PoolItem<T\>\)
Releases the lock on the specified item and returns it to the pool.
```csharp
public void ReleaseItem(PoolItem<T> item)
```
#### Parameters
`item` [PoolItem](CapyKit.PoolItem\-1.md)<T\>
The item to release.
#### Remarks
This method sets the <xref href="CapyKit.PoolItem%601.Locked" data-throw-if-not-resolved="false"></xref> flag to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> so that
it can be retrieved by <xref href="CapyKit.Pool%601.GetAvailableItem" data-throw-if-not-resolved="false"></xref>.

File diff suppressed because it is too large Load diff

View file

@ -0,0 +1,133 @@
# <a id="CapyKit_PoolItem_1"></a> Class PoolItem<T\>
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
A pool item. This class cannot be inherited.
```csharp
public sealed class PoolItem<T>
```
#### Type Parameters
`T`
The type of the pooled item.
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[PoolItem<T\>](CapyKit.PoolItem\-1.md)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<PoolItem<T\>\>\(PoolItem<T\>, PoolItem<T\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Properties
### <a id="CapyKit_PoolItem_1_Index"></a> Index
Gets the zero-based index of the pooled item.
```csharp
public int Index { get; }
```
#### Property Value
[int](https://learn.microsoft.com/dotnet/api/system.int32)
### <a id="CapyKit_PoolItem_1_Item"></a> Item
Gets the pooled resource.
```csharp
public T Item { get; }
```
#### Property Value
T
### <a id="CapyKit_PoolItem_1_Locked"></a> Locked
Gets a value indicating whether this object is locked or not.
```csharp
public bool Locked { get; }
```
#### Property Value
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
### <a id="CapyKit_PoolItem_1_TypeName"></a> TypeName
Gets the name of the <xref href="System.Type" data-throw-if-not-resolved="false"></xref> of the pooled item.
```csharp
public string TypeName { get; }
```
#### Property Value
[string](https://learn.microsoft.com/dotnet/api/system.string)
## Methods
### <a id="CapyKit_PoolItem_1_ReleaseLock"></a> ReleaseLock\(\)
Releases the lock on the item.
```csharp
public void ReleaseLock()
```
#### Remarks
If the item is not locked, an error event is emitted.
### <a id="CapyKit_PoolItem_1_SetLock"></a> SetLock\(\)
Sets the lock on the item indicating that it is in use.
```csharp
public bool SetLock()
```
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is locked successfully, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it
fails.
#### Remarks
If the item is already locked, an error event is emitted.
### <a id="CapyKit_PoolItem_1_ToString"></a> ToString\(\)
Returns a string that represents the current object and its lock state.
```csharp
public override string ToString()
```
#### Returns
[string](https://learn.microsoft.com/dotnet/api/system.string)
A string that represents the current object and its lock state.

View file

@ -1,844 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit.PoolItem`1
commentId: T:CapyKit.PoolItem`1
id: PoolItem`1
parent: CapyKit
children:
- CapyKit.PoolItem`1.Index
- CapyKit.PoolItem`1.Item
- CapyKit.PoolItem`1.Locked
- CapyKit.PoolItem`1.ReleaseLock
- CapyKit.PoolItem`1.SetLock
- CapyKit.PoolItem`1.ToString
- CapyKit.PoolItem`1.TypeName
langs:
- csharp
- vb
name: PoolItem<T>
nameWithType: PoolItem<T>
fullName: CapyKit.PoolItem<T>
type: Class
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: PoolItem
path: ../CapyKit/Pool.cs
startLine: 144
assemblies:
- CapyKit
namespace: CapyKit
summary: A pool item. This class cannot be inherited.
example: []
syntax:
content: public sealed class PoolItem<T>
typeParameters:
- id: T
description: The type of the pooled item.
content.vb: Public NotInheritable Class PoolItem(Of T)
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.ReferenceEquals(System.Object,System.Object)
extensionMethods:
- CapyKit.PoolItem`1.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.PoolItem{{T}})
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
nameWithType.vb: PoolItem(Of T)
fullName.vb: CapyKit.PoolItem(Of T)
name.vb: PoolItem(Of T)
- uid: CapyKit.PoolItem`1.Item
commentId: P:CapyKit.PoolItem`1.Item
id: Item
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: Item
nameWithType: PoolItem<T>.Item
fullName: CapyKit.PoolItem<T>.Item
type: Property
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Item
path: ../CapyKit/Pool.cs
startLine: 166
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the pooled resource.
example: []
syntax:
content: public T Item { get; }
parameters: []
return:
type: '{T}'
description: The pooled resource.
content.vb: Public ReadOnly Property Item As T
overload: CapyKit.PoolItem`1.Item*
nameWithType.vb: PoolItem(Of T).Item
fullName.vb: CapyKit.PoolItem(Of T).Item
- uid: CapyKit.PoolItem`1.Locked
commentId: P:CapyKit.PoolItem`1.Locked
id: Locked
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: Locked
nameWithType: PoolItem<T>.Locked
fullName: CapyKit.PoolItem<T>.Locked
type: Property
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Locked
path: ../CapyKit/Pool.cs
startLine: 176
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets a value indicating whether this object is locked or not.
example: []
syntax:
content: public bool Locked { get; }
parameters: []
return:
type: System.Boolean
description: A value indicating whether this object is locked or not.
content.vb: Public ReadOnly Property Locked As Boolean
overload: CapyKit.PoolItem`1.Locked*
nameWithType.vb: PoolItem(Of T).Locked
fullName.vb: CapyKit.PoolItem(Of T).Locked
- uid: CapyKit.PoolItem`1.Index
commentId: P:CapyKit.PoolItem`1.Index
id: Index
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: Index
nameWithType: PoolItem<T>.Index
fullName: CapyKit.PoolItem<T>.Index
type: Property
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: Index
path: ../CapyKit/Pool.cs
startLine: 186
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the zero-based index of the pooled item.
example: []
syntax:
content: public int Index { get; }
parameters: []
return:
type: System.Int32
description: The index.
content.vb: Public ReadOnly Property Index As Integer
overload: CapyKit.PoolItem`1.Index*
nameWithType.vb: PoolItem(Of T).Index
fullName.vb: CapyKit.PoolItem(Of T).Index
- uid: CapyKit.PoolItem`1.TypeName
commentId: P:CapyKit.PoolItem`1.TypeName
id: TypeName
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: TypeName
nameWithType: PoolItem<T>.TypeName
fullName: CapyKit.PoolItem<T>.TypeName
type: Property
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: TypeName
path: ../CapyKit/Pool.cs
startLine: 196
assemblies:
- CapyKit
namespace: CapyKit
summary: Gets the name of the <xref href="System.Type" data-throw-if-not-resolved="false"></xref> of the pooled item.
example: []
syntax:
content: public string TypeName { get; }
parameters: []
return:
type: System.String
description: The name of the <xref href="System.Type" data-throw-if-not-resolved="false"></xref> of the pooled item.
content.vb: Public ReadOnly Property TypeName As String
overload: CapyKit.PoolItem`1.TypeName*
nameWithType.vb: PoolItem(Of T).TypeName
fullName.vb: CapyKit.PoolItem(Of T).TypeName
- uid: CapyKit.PoolItem`1.SetLock
commentId: M:CapyKit.PoolItem`1.SetLock
id: SetLock
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: SetLock()
nameWithType: PoolItem<T>.SetLock()
fullName: CapyKit.PoolItem<T>.SetLock()
type: Method
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: SetLock
path: ../CapyKit/Pool.cs
startLine: 232
assemblies:
- CapyKit
namespace: CapyKit
summary: Sets the lock on the item indicating that it is in use.
remarks: If the item is already locked, an error event is emitted.
example: []
syntax:
content: public bool SetLock()
return:
type: System.Boolean
description: >-
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the item is locked successfully, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it
fails.
content.vb: Public Function SetLock() As Boolean
overload: CapyKit.PoolItem`1.SetLock*
nameWithType.vb: PoolItem(Of T).SetLock()
fullName.vb: CapyKit.PoolItem(Of T).SetLock()
- uid: CapyKit.PoolItem`1.ReleaseLock
commentId: M:CapyKit.PoolItem`1.ReleaseLock
id: ReleaseLock
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: ReleaseLock()
nameWithType: PoolItem<T>.ReleaseLock()
fullName: CapyKit.PoolItem<T>.ReleaseLock()
type: Method
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: ReleaseLock
path: ../CapyKit/Pool.cs
startLine: 247
assemblies:
- CapyKit
namespace: CapyKit
summary: Releases the lock on the item.
remarks: If the item is not locked, an error event is emitted.
example: []
syntax:
content: public void ReleaseLock()
content.vb: Public Sub ReleaseLock()
overload: CapyKit.PoolItem`1.ReleaseLock*
nameWithType.vb: PoolItem(Of T).ReleaseLock()
fullName.vb: CapyKit.PoolItem(Of T).ReleaseLock()
- uid: CapyKit.PoolItem`1.ToString
commentId: M:CapyKit.PoolItem`1.ToString
id: ToString
parent: CapyKit.PoolItem`1
langs:
- csharp
- vb
name: ToString()
nameWithType: PoolItem<T>.ToString()
fullName: CapyKit.PoolItem<T>.ToString()
type: Method
source:
remote:
path: CapyKit/Pool.cs
branch: main
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
id: ToString
path: ../CapyKit/Pool.cs
startLine: 263
assemblies:
- CapyKit
namespace: CapyKit
summary: Returns a string that represents the current object and its lock state.
example: []
syntax:
content: public override string ToString()
return:
type: System.String
description: A string that represents the current object and its lock state.
content.vb: Public Overrides Function ToString() As String
overridden: System.Object.ToString
overload: CapyKit.PoolItem`1.ToString*
nameWithType.vb: PoolItem(Of T).ToString()
fullName.vb: CapyKit.PoolItem(Of T).ToString()
references:
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.PoolItem`1.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.PoolItem{{T}})
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<PoolItem<T>>(PoolItem<T>, PoolItem<T>)
nameWithType: ObjectExtensions.UpdateProperties<PoolItem<T>>(PoolItem<T>, PoolItem<T>)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.PoolItem<T>>(CapyKit.PoolItem<T>, CapyKit.PoolItem<T>)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of PoolItem(Of T))(PoolItem(Of T), PoolItem(Of T))
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.PoolItem(Of T))(CapyKit.PoolItem(Of T), CapyKit.PoolItem(Of T))
name.vb: UpdateProperties(Of PoolItem(Of T))(PoolItem(Of T), PoolItem(Of T))
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.PoolItem{`0},CapyKit.PoolItem{`0})
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: <
- name: T
- name: '>'
- name: '>'
- name: (
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: <
- name: T
- name: '>'
- name: ','
- name: " "
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: <
- name: T
- name: '>'
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.PoolItem{`0},CapyKit.PoolItem{`0})
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: )
- name: (
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: ','
- name: " "
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: )
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
parent: CapyKit.Extensions.ObjectExtensions
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
name: UpdateProperties<T>(T, T)
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
name.vb: UpdateProperties(Of T)(T, T)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: <
- name: T
- name: '>'
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
- name: (
- name: Of
- name: " "
- name: T
- name: )
- name: (
- name: T
- name: ','
- name: " "
- name: T
- name: )
- uid: CapyKit.Extensions.ObjectExtensions
commentId: T:CapyKit.Extensions.ObjectExtensions
parent: CapyKit.Extensions
href: CapyKit.Extensions.ObjectExtensions.html
name: ObjectExtensions
nameWithType: ObjectExtensions
fullName: CapyKit.Extensions.ObjectExtensions
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
isExternal: true
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
name: UpdateProperties(object, object)
nameWithType: ObjectExtensions.UpdateProperties(object, object)
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
name.vb: UpdateProperties(Object, Object)
spec.csharp:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
name: UpdateProperties
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: CapyKit.Extensions
commentId: N:CapyKit.Extensions
href: CapyKit.html
name: CapyKit.Extensions
nameWithType: CapyKit.Extensions
fullName: CapyKit.Extensions
spec.csharp:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
spec.vb:
- uid: CapyKit
name: CapyKit
href: CapyKit.html
- name: .
- uid: CapyKit.Extensions
name: Extensions
href: CapyKit.Extensions.html
- uid: CapyKit.PoolItem`1.Item*
commentId: Overload:CapyKit.PoolItem`1.Item
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_Item
name: Item
nameWithType: PoolItem<T>.Item
fullName: CapyKit.PoolItem<T>.Item
nameWithType.vb: PoolItem(Of T).Item
fullName.vb: CapyKit.PoolItem(Of T).Item
- uid: '{T}'
commentId: '!:T'
definition: T
name: T
nameWithType: T
fullName: T
- uid: T
name: T
nameWithType: T
fullName: T
- uid: CapyKit.PoolItem`1.Locked*
commentId: Overload:CapyKit.PoolItem`1.Locked
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_Locked
name: Locked
nameWithType: PoolItem<T>.Locked
fullName: CapyKit.PoolItem<T>.Locked
nameWithType.vb: PoolItem(Of T).Locked
fullName.vb: CapyKit.PoolItem(Of T).Locked
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: CapyKit.PoolItem`1.Index*
commentId: Overload:CapyKit.PoolItem`1.Index
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_Index
name: Index
nameWithType: PoolItem<T>.Index
fullName: CapyKit.PoolItem<T>.Index
nameWithType.vb: PoolItem(Of T).Index
fullName.vb: CapyKit.PoolItem(Of T).Index
- uid: System.Int32
commentId: T:System.Int32
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.int32
name: int
nameWithType: int
fullName: int
nameWithType.vb: Integer
fullName.vb: Integer
name.vb: Integer
- uid: System.Type
commentId: T:System.Type
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.type
name: Type
nameWithType: Type
fullName: System.Type
- uid: CapyKit.PoolItem`1.TypeName*
commentId: Overload:CapyKit.PoolItem`1.TypeName
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_TypeName
name: TypeName
nameWithType: PoolItem<T>.TypeName
fullName: CapyKit.PoolItem<T>.TypeName
nameWithType.vb: PoolItem(Of T).TypeName
fullName.vb: CapyKit.PoolItem(Of T).TypeName
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: CapyKit.PoolItem`1.SetLock*
commentId: Overload:CapyKit.PoolItem`1.SetLock
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_SetLock
name: SetLock
nameWithType: PoolItem<T>.SetLock
fullName: CapyKit.PoolItem<T>.SetLock
nameWithType.vb: PoolItem(Of T).SetLock
fullName.vb: CapyKit.PoolItem(Of T).SetLock
- uid: CapyKit.PoolItem`1.ReleaseLock*
commentId: Overload:CapyKit.PoolItem`1.ReleaseLock
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_ReleaseLock
name: ReleaseLock
nameWithType: PoolItem<T>.ReleaseLock
fullName: CapyKit.PoolItem<T>.ReleaseLock
nameWithType.vb: PoolItem(Of T).ReleaseLock
fullName.vb: CapyKit.PoolItem(Of T).ReleaseLock
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: CapyKit.PoolItem`1.ToString*
commentId: Overload:CapyKit.PoolItem`1.ToString
href: CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_ToString
name: ToString
nameWithType: PoolItem<T>.ToString
fullName: CapyKit.PoolItem<T>.ToString
nameWithType.vb: PoolItem(Of T).ToString
fullName.vb: CapyKit.PoolItem(Of T).ToString

View file

@ -0,0 +1,148 @@
# <a id="CapyKit_PropertyComparer_2"></a> Class PropertyComparer<T, U\>
Namespace: [CapyKit](CapyKit.md)
Assembly: CapyKit.dll
A object comparer that can accept a lambda expression to compare properties.
```csharp
public class PropertyComparer<T, U> : IEqualityComparer<T>
```
#### Type Parameters
`T`
Generic type parameter of the parent object.
`U`
Generic type parameter of the property value.
#### Inheritance
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[PropertyComparer<T, U\>](CapyKit.PropertyComparer\-2.md)
#### Implements
[IEqualityComparer<T\>](https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer\-1)
#### Inherited Members
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
#### Extension Methods
[ObjectExtensions.UpdateProperties<PropertyComparer<T, U\>\>\(PropertyComparer<T, U\>, PropertyComparer<T, U\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
## Examples
using System;
using System.Collections.Generic;
using System.Linq;
class Program
{
static void Main(string[] args)
{
var people = new List&lt;Person&gt;
{
new Person { Name = "Alice", Age = 30 }, new Person { Name = "Bob", Age = 30 }, new
Person { Name = "Charlie", Age = 35 }
};
var comparer = new PropertyComparer<Person, int>(p => p.Age);
var distinctPeople = people.Distinct(comparer).ToList();
foreach (var person in distinctPeople)
{
Console.WriteLine($"{person.Name} - {person.Age}");
}
}
}
class Person
{
public string Name { get; set; }
public int Age { get; set; }
}
## Constructors
### <a id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__"></a> PropertyComparer\(Func<T, U\>\)
Constructor.
```csharp
public PropertyComparer(Func<T, U> expression)
```
#### Parameters
`expression` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
The expression.
## Methods
### <a id="CapyKit_PropertyComparer_2_Equals__0__0_"></a> Equals\(T, T\)
Determines whether the specified properties are equal.
```csharp
public bool Equals(T x, T y)
```
#### Parameters
`x` T
The first object of type <code class="typeparamref">T</code> to compare.
`y` T
The second object of type <code class="typeparamref">T</code> to compare.
#### Returns
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified objects are equal; otherwise,
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.
### <a id="CapyKit_PropertyComparer_2_GetHashCode__0_"></a> GetHashCode\(T\)
Returns a hash code for the specified object.
```csharp
public int GetHashCode(T obj)
```
#### Parameters
`obj` T
The <xref href="System.Object" data-throw-if-not-resolved="false"></xref> for which a hash code is to be returned.
#### Returns
[int](https://learn.microsoft.com/dotnet/api/system.int32)
A hash code for the specified object.
#### Exceptions
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
The type of <code class="paramref">obj</code> is a reference type and
<code class="paramref">obj</code> is
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.

File diff suppressed because it is too large Load diff

73
Docs/api/CapyKit.md Normal file
View file

@ -0,0 +1,73 @@
# <a id="CapyKit"></a> Namespace CapyKit
### Namespaces
[CapyKit.Attributes](CapyKit.Attributes.md)
[CapyKit.Enumerations](CapyKit.Enumerations.md)
[CapyKit.Extensions](CapyKit.Extensions.md)
[CapyKit.Helpers](CapyKit.Helpers.md)
### Classes
[CapyEventArgs](CapyKit.CapyEventArgs.md)
The CapyEventArgs class represents an event argument instance with event level, message, and
method name information.
[CapyEventReporter](CapyKit.CapyEventReporter.md)
The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
[Color](CapyKit.Color.md)
An object representing a color.
[EncryptedValue<T\>](CapyKit.EncryptedValue\-1.md)
[Password](CapyKit.Password.md)
Represents a password with its hash, salt and algorithm used for encryption.
[Pbkdf2Algorithm](CapyKit.Pbkdf2Algorithm.md)
Implements the PBKDF2 algorithm for password encryption.
[Pool<T\>](CapyKit.Pool\-1.md)
A managed pool of resources. This class provides a thread-safe way to manage a collection of
objects of type <code class="typeparamref">T</code>.
[PoolItem<T\>](CapyKit.PoolItem\-1.md)
A pool item. This class cannot be inherited.
[PropertyComparer<T, U\>](CapyKit.PropertyComparer\-2.md)
A object comparer that can accept a lambda expression to compare properties.
### Interfaces
[IPasswordAlgorithm](CapyKit.IPasswordAlgorithm.md)
Defines the contract for password encryption algorithms.
### Enums
[EventLevel](CapyKit.EventLevel.md)
Enumeration representing different event level severity values.
[NamedColor](CapyKit.NamedColor.md)
Enum representing a set of named colors with their corresponding HEX values. These colors are
inspired by the XKCD color palette (<a href="https://xkcd.com/color/rgb/" target="_blank">Link</a>).
### Delegates
[CapyEventHandler](CapyKit.CapyEventHandler.md)
A delegate representing an event handler that accepts a <xref href="CapyKit.CapyEventArgs" data-throw-if-not-resolved="false"></xref> instance.

View file

@ -1,202 +0,0 @@
### YamlMime:ManagedReference
items:
- uid: CapyKit
commentId: N:CapyKit
id: CapyKit
children:
- CapyKit.CapyEventArgs
- CapyKit.CapyEventHandler
- CapyKit.CapyEventReporter
- CapyKit.Color
- CapyKit.EncryptedValue`1
- CapyKit.EventLevel
- CapyKit.IPasswordAlgorithm
- CapyKit.NamedColor
- CapyKit.Password
- CapyKit.Pbkdf2Algorithm
- CapyKit.PoolItem`1
- CapyKit.Pool`1
- CapyKit.PropertyComparer`2
langs:
- csharp
- vb
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit
type: Namespace
assemblies:
- CapyKit
references:
- uid: CapyKit.CapyEventReporter
commentId: T:CapyKit.CapyEventReporter
href: CapyKit.CapyEventReporter.html
name: CapyEventReporter
nameWithType: CapyEventReporter
fullName: CapyKit.CapyEventReporter
- uid: CapyKit.CapyEventHandler
commentId: T:CapyKit.CapyEventHandler
parent: CapyKit
href: CapyKit.CapyEventHandler.html
name: CapyEventHandler
nameWithType: CapyEventHandler
fullName: CapyKit.CapyEventHandler
- uid: CapyKit.CapyEventArgs
commentId: T:CapyKit.CapyEventArgs
parent: CapyKit
href: CapyKit.CapyEventArgs.html
name: CapyEventArgs
nameWithType: CapyEventArgs
fullName: CapyKit.CapyEventArgs
- uid: CapyKit.EventLevel
commentId: T:CapyKit.EventLevel
parent: CapyKit
href: CapyKit.EventLevel.html
name: EventLevel
nameWithType: EventLevel
fullName: CapyKit.EventLevel
- uid: CapyKit.Color
commentId: T:CapyKit.Color
href: CapyKit.Color.html
name: Color
nameWithType: Color
fullName: CapyKit.Color
- uid: CapyKit.EncryptedValue`1
commentId: T:CapyKit.EncryptedValue`1
href: CapyKit.EncryptedValue-1.html
name: EncryptedValue<T>
nameWithType: EncryptedValue<T>
fullName: CapyKit.EncryptedValue<T>
nameWithType.vb: EncryptedValue(Of T)
fullName.vb: CapyKit.EncryptedValue(Of T)
name.vb: EncryptedValue(Of T)
spec.csharp:
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: <
- name: T
- name: '>'
spec.vb:
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue
href: CapyKit.EncryptedValue-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: CapyKit.NamedColor
commentId: T:CapyKit.NamedColor
parent: CapyKit
href: CapyKit.NamedColor.html
name: NamedColor
nameWithType: NamedColor
fullName: CapyKit.NamedColor
- uid: CapyKit.Password
commentId: T:CapyKit.Password
parent: CapyKit
href: CapyKit.Password.html
name: Password
nameWithType: Password
fullName: CapyKit.Password
- uid: CapyKit.IPasswordAlgorithm
commentId: T:CapyKit.IPasswordAlgorithm
parent: CapyKit
href: CapyKit.IPasswordAlgorithm.html
name: IPasswordAlgorithm
nameWithType: IPasswordAlgorithm
fullName: CapyKit.IPasswordAlgorithm
- uid: CapyKit.Pbkdf2Algorithm
commentId: T:CapyKit.Pbkdf2Algorithm
parent: CapyKit
href: CapyKit.Pbkdf2Algorithm.html
name: Pbkdf2Algorithm
nameWithType: Pbkdf2Algorithm
fullName: CapyKit.Pbkdf2Algorithm
- uid: CapyKit.Pool`1
commentId: T:CapyKit.Pool`1
href: CapyKit.Pool-1.html
name: Pool<T>
nameWithType: Pool<T>
fullName: CapyKit.Pool<T>
nameWithType.vb: Pool(Of T)
fullName.vb: CapyKit.Pool(Of T)
name.vb: Pool(Of T)
spec.csharp:
- uid: CapyKit.Pool`1
name: Pool
href: CapyKit.Pool-1.html
- name: <
- name: T
- name: '>'
spec.vb:
- uid: CapyKit.Pool`1
name: Pool
href: CapyKit.Pool-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: CapyKit.PoolItem`1
commentId: T:CapyKit.PoolItem`1
href: CapyKit.PoolItem-1.html
name: PoolItem<T>
nameWithType: PoolItem<T>
fullName: CapyKit.PoolItem<T>
nameWithType.vb: PoolItem(Of T)
fullName.vb: CapyKit.PoolItem(Of T)
name.vb: PoolItem(Of T)
spec.csharp:
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: <
- name: T
- name: '>'
spec.vb:
- uid: CapyKit.PoolItem`1
name: PoolItem
href: CapyKit.PoolItem-1.html
- name: (
- name: Of
- name: " "
- name: T
- name: )
- uid: CapyKit.PropertyComparer`2
commentId: T:CapyKit.PropertyComparer`2
href: CapyKit.PropertyComparer-2.html
name: PropertyComparer<T, U>
nameWithType: PropertyComparer<T, U>
fullName: CapyKit.PropertyComparer<T, U>
nameWithType.vb: PropertyComparer(Of T, U)
fullName.vb: CapyKit.PropertyComparer(Of T, U)
name.vb: PropertyComparer(Of T, U)
spec.csharp:
- uid: CapyKit.PropertyComparer`2
name: PropertyComparer
href: CapyKit.PropertyComparer-2.html
- name: <
- name: T
- name: ','
- name: " "
- name: U
- name: '>'
spec.vb:
- uid: CapyKit.PropertyComparer`2
name: PropertyComparer
href: CapyKit.PropertyComparer-2.html
- name: (
- name: Of
- name: " "
- name: T
- name: ','
- name: " "
- name: U
- name: )
- uid: CapyKit
commentId: N:CapyKit
href: CapyKit.html
name: CapyKit
nameWithType: CapyKit
fullName: CapyKit

View file

@ -1,116 +1,88 @@
### YamlMime:TableOfContent
items:
- uid: CapyKit
name: CapyKit
type: Namespace
- name: CapyKit
href: CapyKit.md
items:
- uid: CapyKit.CapyEventArgs
name: CapyEventArgs
type: Class
- uid: CapyKit.CapyEventHandler
name: CapyEventHandler
type: Delegate
- uid: CapyKit.CapyEventReporter
name: CapyEventReporter
type: Class
- uid: CapyKit.Color
name: Color
type: Class
- uid: CapyKit.EncryptedValue`1
name: EncryptedValue<T>
type: Class
- uid: CapyKit.EventLevel
name: EventLevel
type: Enum
- uid: CapyKit.IPasswordAlgorithm
name: IPasswordAlgorithm
type: Interface
- uid: CapyKit.NamedColor
name: NamedColor
type: Enum
- uid: CapyKit.Password
name: Password
type: Class
- uid: CapyKit.Pbkdf2Algorithm
name: Pbkdf2Algorithm
type: Class
- uid: CapyKit.PoolItem`1
name: PoolItem<T>
type: Class
- uid: CapyKit.Pool`1
name: Pool<T>
type: Class
- uid: CapyKit.PropertyComparer`2
name: PropertyComparer<T, U>
type: Class
- uid: CapyKit.Attributes
name: CapyKit.Attributes
type: Namespace
- name: Classes
- name: CapyEventArgs
href: CapyKit.CapyEventArgs.md
- name: CapyEventReporter
href: CapyKit.CapyEventReporter.md
- name: Color
href: CapyKit.Color.md
- name: EncryptedValue<T>
href: CapyKit.EncryptedValue-1.md
- name: Password
href: CapyKit.Password.md
- name: Pbkdf2Algorithm
href: CapyKit.Pbkdf2Algorithm.md
- name: Pool<T>
href: CapyKit.Pool-1.md
- name: PoolItem<T>
href: CapyKit.PoolItem-1.md
- name: PropertyComparer<T, U>
href: CapyKit.PropertyComparer-2.md
- name: Interfaces
- name: IPasswordAlgorithm
href: CapyKit.IPasswordAlgorithm.md
- name: Enums
- name: EventLevel
href: CapyKit.EventLevel.md
- name: NamedColor
href: CapyKit.NamedColor.md
- name: Delegates
- name: CapyEventHandler
href: CapyKit.CapyEventHandler.md
- name: CapyKit.Attributes
href: CapyKit.Attributes.md
items:
- uid: CapyKit.Attributes.EnumerationAttribute`1
name: EnumerationAttribute<T>
type: Class
- uid: CapyKit.Attributes.EnumerationDescriptionAttribute
name: EnumerationDescriptionAttribute
type: Class
- uid: CapyKit.Attributes.ValueFormatAttribute
name: ValueFormatAttribute
type: Class
- uid: CapyKit.Enumerations
name: CapyKit.Enumerations
type: Namespace
- name: Classes
- name: EnumerationAttribute<T>
href: CapyKit.Attributes.EnumerationAttribute-1.md
- name: EnumerationDescriptionAttribute
href: CapyKit.Attributes.EnumerationDescriptionAttribute.md
- name: ValueFormatAttribute
href: CapyKit.Attributes.ValueFormatAttribute.md
- name: CapyKit.Enumerations
href: CapyKit.Enumerations.md
items:
- uid: CapyKit.Enumerations.MeasurementSystem
name: MeasurementSystem
type: Enum
- uid: CapyKit.Extensions
name: CapyKit.Extensions
type: Namespace
- name: Enums
- name: MeasurementSystem
href: CapyKit.Enumerations.MeasurementSystem.md
- name: CapyKit.Extensions
href: CapyKit.Extensions.md
items:
- uid: CapyKit.Extensions.EnumerationExtensions
name: EnumerationExtensions
type: Class
- uid: CapyKit.Extensions.LINQExtensions
name: LINQExtensions
type: Class
- uid: CapyKit.Extensions.ObjectExtensions
name: ObjectExtensions
type: Class
- uid: CapyKit.Extensions.StringExtensions
name: StringExtensions
type: Class
- uid: CapyKit.Helpers
name: CapyKit.Helpers
type: Namespace
- name: Classes
- name: EnumerationExtensions
href: CapyKit.Extensions.EnumerationExtensions.md
- name: LINQExtensions
href: CapyKit.Extensions.LINQExtensions.md
- name: ObjectExtensions
href: CapyKit.Extensions.ObjectExtensions.md
- name: StringExtensions
href: CapyKit.Extensions.StringExtensions.md
- name: CapyKit.Helpers
href: CapyKit.Helpers.md
items:
- uid: CapyKit.Helpers.CalculationHelper
name: CalculationHelper
type: Class
- uid: CapyKit.Helpers.CompressionHelper
name: CompressionHelper
type: Class
- uid: CapyKit.Helpers.EncryptionHelper
name: EncryptionHelper
type: Class
- uid: CapyKit.Helpers.IEncryptionAlgorithm
name: IEncryptionAlgorithm
type: Interface
- uid: CapyKit.Helpers.KeyHelper
name: KeyHelper
type: Class
- uid: CapyKit.Helpers.LanguageHelper
name: LanguageHelper
type: Class
- uid: CapyKit.Helpers.SecurityHelper
name: SecurityHelper
type: Class
- uid: CapyKit.Helpers.SerializationHelper
name: SerializationHelper
type: Class
- uid: CapyKit.Helpers.SettingsHelper
name: SettingsHelper
type: Class
- uid: CapyKit.Helpers.ValidCharacterCollection
name: ValidCharacterCollection
type: Enum
memberLayout: SamePage
- name: Classes
- name: CalculationHelper
href: CapyKit.Helpers.CalculationHelper.md
- name: CompressionHelper
href: CapyKit.Helpers.CompressionHelper.md
- name: EncryptionHelper
href: CapyKit.Helpers.EncryptionHelper.md
- name: KeyHelper
href: CapyKit.Helpers.KeyHelper.md
- name: LanguageHelper
href: CapyKit.Helpers.LanguageHelper.md
- name: SecurityHelper
href: CapyKit.Helpers.SecurityHelper.md
- name: SerializationHelper
href: CapyKit.Helpers.SerializationHelper.md
- name: SettingsHelper
href: CapyKit.Helpers.SettingsHelper.md
- name: Interfaces
- name: IEncryptionAlgorithm
href: CapyKit.Helpers.IEncryptionAlgorithm.md
- name: Enums
- name: ValidCharacterCollection
href: CapyKit.Helpers.ValidCharacterCollection.md