Generate API docs as markdown
This commit is contained in:
parent
ab7b83abbb
commit
85e90f7bd5
120 changed files with 14227 additions and 76482 deletions
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class EnumerationAttribute<T> | CapyKit Documentation </title>
|
||||
<title> Class EnumerationAttribute<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EnumerationAttribute<T> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class EnumerationAttribute<T> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Custom attribute class for decorating enumeration fields with additional data.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,282 +70,94 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Attributes.EnumerationAttribute`1">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Attributes_EnumerationAttribute_1"> Class EnumerationAttribute<T></h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Attributes_EnumerationAttribute_1" data-uid="CapyKit.Attributes.EnumerationAttribute`1" class="text-break">
|
||||
Class EnumerationAttribute<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Attributes.html">Attributes</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Field)]
|
||||
public abstract class EnumerationAttribute<T> : Attribute</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter allowing for arbitrary declarations and assignments of meaning.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
||||
<div><span class="xref">EnumerationAttribute<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<dl class="typelist derived">
|
||||
<dt>Derived</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_EnumerationAttribute_1__ctor_" data-uid="CapyKit.Attributes.EnumerationAttribute`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_EnumerationAttribute_1__ctor__0_" data-uid="CapyKit.Attributes.EnumerationAttribute`1.#ctor(`0)">
|
||||
EnumerationAttribute(T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the value of the enumeration represented by this attribute.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">protected EnumerationAttribute(T value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>value</code> <span class="xref">T</span></dt>
|
||||
<dd><p>Initializes a new instance of the <a class="xref" href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a> class with a
|
||||
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Field)]
|
||||
public abstract class EnumerationAttribute<T> : Attribute
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter allowing for arbitrary declarations and assignments of meaning.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EnumerationAttribute<T>>(EnumerationAttribute<T>, EnumerationAttribute<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Attributes_EnumerationAttribute_1__ctor__0_"> EnumerationAttribute(T)</h3>
|
||||
<p>Gets the value of the enumeration represented by this attribute.</p>
|
||||
<pre><code class="lang-csharp">protected EnumerationAttribute(T value)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>value</code> T</p>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationAttribute`1</span> class with a
|
||||
specified value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_EnumerationAttribute_1_Value_" data-uid="CapyKit.Attributes.EnumerationAttribute`1.Value*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_EnumerationAttribute_1_Value" data-uid="CapyKit.Attributes.EnumerationAttribute`1.Value">
|
||||
Value
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a> class with a
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Attributes_EnumerationAttribute_1_Value"> Value</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationAttribute`1</span> class with a
|
||||
specified value.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public T Value { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public T Value { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p>T</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class EnumerationDescriptionAttribute | CapyKit Documentation </title>
|
||||
<title> Class EnumerationDescriptionAttribute | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EnumerationDescriptionAttribute | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class EnumerationDescriptionAttribute | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="An attribute class for decorating enumeration fields with a description.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,240 +70,87 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Attributes.EnumerationDescriptionAttribute">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Attributes_EnumerationDescriptionAttribute"> Class EnumerationDescriptionAttribute</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Attributes_EnumerationDescriptionAttribute" data-uid="CapyKit.Attributes.EnumerationDescriptionAttribute" class="text-break">
|
||||
Class EnumerationDescriptionAttribute
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Attributes.html">Attributes</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>An attribute class for decorating enumeration fields with a description.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Field)]
|
||||
public class EnumerationDescriptionAttribute : EnumerationAttribute<string></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
||||
<div><a class="xref" href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></div>
|
||||
<div><span class="xref">EnumerationDescriptionAttribute</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Attributes.EnumerationAttribute-1.html#CapyKit_Attributes_EnumerationAttribute_1_Value">EnumerationAttribute<string>.Value</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_" data-uid="CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_System_String_" data-uid="CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)">
|
||||
EnumerationDescriptionAttribute(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a> class with
|
||||
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An attribute class for decorating enumeration fields with a description.</p>
|
||||
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Field)]
|
||||
public class EnumerationDescriptionAttribute : EnumerationAttribute<string>
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<string></a> ←
|
||||
<a href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html#CapyKit_Attributes_EnumerationAttribute_1_Value">EnumerationAttribute<string>.Value</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EnumerationDescriptionAttribute>(EnumerationDescriptionAttribute, EnumerationDescriptionAttribute)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_System_String_"> EnumerationDescriptionAttribute(string)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationDescriptionAttribute</span> class with
|
||||
the specified description.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EnumerationDescriptionAttribute(string description)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>description</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The description of the enumeration value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="seealso">See Also</h2>
|
||||
<div class="seealso">
|
||||
<div><a class="xref" href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute</a><T></div>
|
||||
</div>
|
||||
<pre><code class="lang-csharp">public EnumerationDescriptionAttribute(string description)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>description</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The description of the enumeration value.</p>
|
||||
<h2 id="see-also">See Also</h2>
|
||||
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute</a><T></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ValueFormatAttribute | CapyKit Documentation </title>
|
||||
<title> Class ValueFormatAttribute | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ValueFormatAttribute | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class ValueFormatAttribute | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Custom attribute for formatting values in a specific way.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,340 +70,106 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Attributes.ValueFormatAttribute">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Attributes_ValueFormatAttribute"> Class ValueFormatAttribute</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Attributes_ValueFormatAttribute" data-uid="CapyKit.Attributes.ValueFormatAttribute" class="text-break">
|
||||
Class ValueFormatAttribute
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Attributes.html">Attributes</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Custom attribute for formatting values in a specific way.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Property)]
|
||||
public class ValueFormatAttribute : Attribute</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
||||
<div><span class="xref">ValueFormatAttribute</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_ValueFormatAttribute__ctor_" data-uid="CapyKit.Attributes.ValueFormatAttribute.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor" data-uid="CapyKit.Attributes.ValueFormatAttribute.#ctor">
|
||||
ValueFormatAttribute()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default constructor. Initializes a new instance of the <a class="xref" href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a>
|
||||
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Custom attribute for formatting values in a specific way.</p>
|
||||
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Property)]
|
||||
public class ValueFormatAttribute : Attribute
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||
<a href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttribute(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttribute(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttribute(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttribute(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type-system-boolean)">Attribute.GetCustomAttributes(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type-system-boolean)">Attribute.GetCustomAttributes(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type-system-boolean)">Attribute.IsDefined(Assembly, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type-system-boolean)">Attribute.IsDefined(MemberInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type-system-boolean)">Attribute.IsDefined(Module, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type-system-boolean)">Attribute.IsDefined(ParameterInfo, Type, bool)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<ValueFormatAttribute>(ValueFormatAttribute, ValueFormatAttribute)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor"> ValueFormatAttribute()</h3>
|
||||
<p>Default constructor. Initializes a new instance of the <span class="xref">CapyKit.Attributes.ValueFormatAttribute</span>
|
||||
class with an empty format string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ValueFormatAttribute()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_ValueFormatAttribute__ctor_" data-uid="CapyKit.Attributes.ValueFormatAttribute.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor_System_String_" data-uid="CapyKit.Attributes.ValueFormatAttribute.#ctor(System.String)">
|
||||
ValueFormatAttribute(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Constructor. Initializes a new instance of the <a class="xref" href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a> class with
|
||||
<pre><code class="lang-csharp">public ValueFormatAttribute()
|
||||
</code></pre>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor_System_String_"> ValueFormatAttribute(string)</h3>
|
||||
<p>Constructor. Initializes a new instance of the <span class="xref">CapyKit.Attributes.ValueFormatAttribute</span> class with
|
||||
the specified format string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public ValueFormatAttribute(string format)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>format</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The format string used to format the value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_ValueFormatAttribute_Format_" data-uid="CapyKit.Attributes.ValueFormatAttribute.Format*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute_Format" data-uid="CapyKit.Attributes.ValueFormatAttribute.Format">
|
||||
Format
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the format to use for formatting the value.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Format { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The format string used to format the value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString_" data-uid="CapyKit.Attributes.ValueFormatAttribute.GetFormatParameterizedString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString_System_Int32_" data-uid="CapyKit.Attributes.ValueFormatAttribute.GetFormatParameterizedString(System.Int32)">
|
||||
GetFormatParameterizedString(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets a parameterized formatted string for the specified index.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GetFormatParameterizedString(int index = 0)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>index</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>(Optional) Zero-based index of the item in the string to format.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A formatted string with the specified index and format.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public ValueFormatAttribute(string format)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>format</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The format string used to format the value.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute_Format"> Format</h3>
|
||||
<p>Gets or sets the format to use for formatting the value.</p>
|
||||
<pre><code class="lang-csharp">public string Format { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString_System_Int32_"> GetFormatParameterizedString(int)</h3>
|
||||
<p>Gets a parameterized formatted string for the specified index.</p>
|
||||
<pre><code class="lang-csharp">public string GetFormatParameterizedString(int index = 0)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>index</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>(Optional) Zero-based index of the item in the string to format.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A formatted string with the specified index and format.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace CapyKit.Attributes | CapyKit Documentation </title>
|
||||
<title> Namespace CapyKit.Attributes | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace CapyKit.Attributes | CapyKit Documentation ">
|
||||
<meta name="title" content=" Namespace CapyKit.Attributes | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,38 +70,23 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Attributes">
|
||||
|
||||
<h1 id="CapyKit_Attributes" data-uid="CapyKit.Attributes" class="text-break">Namespace CapyKit.Attributes</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a></dt>
|
||||
<dd><p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></dt>
|
||||
<dd><p>An attribute class for decorating enumeration fields with a description.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a></dt>
|
||||
<dd><p>Custom attribute for formatting values in a specific way.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Attributes"> Namespace CapyKit.Attributes</h1>
|
||||
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a></p>
|
||||
<p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||
<p><a href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></p>
|
||||
<p>An attribute class for decorating enumeration fields with a description.</p>
|
||||
<p><a href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a></p>
|
||||
<p>Custom attribute for formatting values in a specific way.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CapyEventArgs | CapyKit Documentation </title>
|
||||
<title> Class CapyEventArgs | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CapyEventArgs | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class CapyEventArgs | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="The CapyEventArgs class represents an event argument instance with event level, message, and method name information.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,235 +70,69 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.CapyEventArgs">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_CapyEventArgs"> Class CapyEventArgs</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_CapyEventArgs" data-uid="CapyKit.CapyEventArgs" class="text-break">
|
||||
Class CapyEventArgs
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
method name information.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class CapyEventArgs : EventArgs</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a></div>
|
||||
<div><span class="xref">CapyEventArgs</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs.empty">EventArgs.Empty</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs__ctor_" data-uid="CapyKit.CapyEventArgs.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_" data-uid="CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)">
|
||||
CapyEventArgs(EventLevel, string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public CapyEventArgs(EventLevel level, string message, string method = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>level</code> <a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>The severity level of the event.</p>
|
||||
</dd>
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A descriptive message explaining the reason for the event.</p>
|
||||
</dd>
|
||||
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the method where the event was raised.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs_Level_" data-uid="CapyKit.CapyEventArgs.Level*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs_Level" data-uid="CapyKit.CapyEventArgs.Level">
|
||||
Level
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the severity level of the event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EventLevel Level { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs_Message_" data-uid="CapyKit.CapyEventArgs.Message*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs_Message" data-uid="CapyKit.CapyEventArgs.Message">
|
||||
Message
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the message describing the reason for the event.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string Message { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventArgs_MethodName_" data-uid="CapyKit.CapyEventArgs.MethodName*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventArgs_MethodName" data-uid="CapyKit.CapyEventArgs.MethodName">
|
||||
MethodName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the method where the event was raised.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string MethodName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public class CapyEventArgs : EventArgs
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a> ←
|
||||
<a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.eventargs.empty">EventArgs.Empty</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_"> CapyEventArgs(EventLevel, string, string)</h3>
|
||||
<p>Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.</p>
|
||||
<pre><code class="lang-csharp">public CapyEventArgs(EventLevel level, string message, string method = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>level</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A descriptive message explaining the reason for the event.</p>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the method where the event was raised.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_CapyEventArgs_Level"> Level</h3>
|
||||
<p>Gets the severity level of the event.</p>
|
||||
<pre><code class="lang-csharp">public EventLevel Level { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<h3 id="CapyKit_CapyEventArgs_Message"> Message</h3>
|
||||
<p>Gets the message describing the reason for the event.</p>
|
||||
<pre><code class="lang-csharp">public string Message { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h3 id="CapyKit_CapyEventArgs_MethodName"> MethodName</h3>
|
||||
<p>Gets the name of the method where the event was raised.</p>
|
||||
<pre><code class="lang-csharp">public string MethodName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Delegate CapyEventHandler | CapyKit Documentation </title>
|
||||
<title> Delegate CapyEventHandler | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Delegate CapyEventHandler | CapyKit Documentation ">
|
||||
<meta name="title" content=" Delegate CapyEventHandler | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A delegate representing an event handler that accepts a instance.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,61 +70,27 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.CapyEventHandler">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_CapyEventHandler" data-uid="CapyKit.CapyEventHandler" class="text-break">
|
||||
Delegate CapyEventHandler
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A delegate representing an event handler that accepts a <a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a> instance.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public delegate void CapyEventHandler(CapyEventArgs e)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>e</code> <a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></dt>
|
||||
<dd><p>The CapyEventArgs instance containing event data.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_CapyEventHandler"> Delegate CapyEventHandler</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A delegate representing an event handler that accepts a <span class="xref">CapyKit.CapyEventArgs</span> instance.</p>
|
||||
<pre><code class="lang-csharp">public delegate void CapyEventHandler(CapyEventArgs e)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>e</code> <a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<p>The CapyEventArgs instance containing event data.</p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<CapyEventHandler>(CapyEventHandler, CapyEventHandler)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CapyEventReporter | CapyKit Documentation </title>
|
||||
<title> Class CapyEventReporter | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CapyEventReporter | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class CapyEventReporter | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,281 +70,108 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.CapyEventReporter">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_CapyEventReporter"> Class CapyEventReporter</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_CapyEventReporter" data-uid="CapyKit.CapyEventReporter" class="text-break">
|
||||
Class CapyEventReporter
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class CapyEventReporter</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">CapyEventReporter</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 id="CapyKit_CapyEventReporter_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>Because consumers of CapyKit may have varied ways of handling logging, the <a class="xref" href="CapyKit.CapyEventReporter.html">CapyEventReporter</a> provides
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
<pre><code class="lang-csharp">public static class CapyEventReporter
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="remarks">Remarks</h2>
|
||||
<p>Because consumers of CapyKit may have varied ways of handling logging, the <span class="xref">CapyKit.CapyEventReporter</span> 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.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventReporter_EmitEvent_" data-uid="CapyKit.CapyEventReporter.EmitEvent*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___" data-uid="CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])">
|
||||
EmitEvent(EventLevel, string, string, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Emits an event with the given severity level, message, and method name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>eventLevel</code> <a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>The severity level of the event.</p>
|
||||
</dd>
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___"> EmitEvent(EventLevel, string, string, params object[])</h3>
|
||||
<p>Emits an event with the given severity level, message, and method name.</p>
|
||||
<pre><code class="lang-csharp">public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>eventLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||
is accepted.</p>
|
||||
</dd>
|
||||
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>(Optional) The name of the method where the event was raised.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object____examples">Examples</h4>
|
||||
<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object____remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>In order to allow for efficient calling member access via <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>(Optional) The name of the method where the event was raised.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||
<h4 id="examples">Examples</h4>
|
||||
<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>In order to allow for efficient calling member access via <span class="xref">System.Runtime.CompilerServices.CallerMemberNameAttribute</span>
|
||||
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventReporter_EmitEventOnce_" data-uid="CapyKit.CapyEventReporter.EmitEventOnce*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___" data-uid="CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])">
|
||||
EmitEventOnce(EventLevel, string, string, string, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Emits an event with the given severity level, message, unique identifier, and method name one
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a></p>
|
||||
<h3 id="CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___"> EmitEventOnce(EventLevel, string, string, string, params object[])</h3>
|
||||
<p>Emits an event with the given severity level, message, unique identifier, and method name one
|
||||
time.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>eventLevel</code> <a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>The severity level of the event.</p>
|
||||
</dd>
|
||||
<dt><code>message</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||
<pre><code class="lang-csharp">public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>eventLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event.</p>
|
||||
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||
is accepted.</p>
|
||||
</dd>
|
||||
<dt><code>uniqueIdentifier</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A unique identifier for the event emission.</p>
|
||||
</dd>
|
||||
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>(Optional) The name of the method where the event was raised.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object____remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method is similar to EmitEvent(EventLevel, string, string, string, object[])
|
||||
, but requires a unique identifier (such as a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a>) to prevent duplicate
|
||||
<p><code>uniqueIdentifier</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A unique identifier for the event emission.</p>
|
||||
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>(Optional) The name of the method where the event was raised.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>This method is similar to EmitEvent(EventLevel, string, string, string, object[])
|
||||
, but requires a unique identifier (such as a <span class="xref">System.Guid</span>) to prevent duplicate
|
||||
emissions.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a></div>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventReporter_Subscribe_" data-uid="CapyKit.CapyEventReporter.Subscribe*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_" data-uid="CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)">
|
||||
Subscribe(CapyEventHandler, EventLevel, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Subscribes the specified event handler to the event with the given subscription level and
|
||||
<h4 id="see-also-1">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute">CallerMemberNameAttribute</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.guid">Guid</a></p>
|
||||
<h3 id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_"> Subscribe(CapyEventHandler, EventLevel, string)</h3>
|
||||
<p>Subscribes the specified event handler to the event with the given subscription level and
|
||||
origin.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>callback</code> <a class="xref" href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></dt>
|
||||
<dd><p>The event handler to subscribe.</p>
|
||||
</dd>
|
||||
<dt><code>subscriptionLevel</code> <a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>The severity level of the event to subscribe to.</p>
|
||||
</dd>
|
||||
<dt><code>origin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>(Optional) The name of the method or class where the subscription is made.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If there is no existing list for the given subscription level, a new list is created and
|
||||
<pre><code class="lang-csharp">public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>callback</code> <a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>The event handler to subscribe.</p>
|
||||
<p><code>subscriptionLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>The severity level of the event to subscribe to.</p>
|
||||
<p><code>origin</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>(Optional) The name of the method or class where the subscription is made.</p>
|
||||
<h4 id="remarks-3">Remarks</h4>
|
||||
<p>If there is no existing list for the given subscription level, a new list is created and
|
||||
added to the dictionary.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_CapyEventReporter_Unsubscribe_" data-uid="CapyKit.CapyEventReporter.Unsubscribe*"></a>
|
||||
|
||||
<h3 id="CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_" data-uid="CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)">
|
||||
Unsubscribe(CapyEventHandler, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Unsubscribes the specified event handler from the event with the given origin.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void Unsubscribe(CapyEventHandler callback, string origin)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>callback</code> <a class="xref" href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></dt>
|
||||
<dd><p>The event handler to unsubscribe.</p>
|
||||
</dd>
|
||||
<dt><code>origin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the method or class where the subscription was made.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_"> Unsubscribe(CapyEventHandler, string)</h3>
|
||||
<p>Unsubscribes the specified event handler from the event with the given origin.</p>
|
||||
<pre><code class="lang-csharp">public static void Unsubscribe(CapyEventHandler callback, string origin)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>callback</code> <a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>The event handler to unsubscribe.</p>
|
||||
<p><code>origin</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the method or class where the subscription was made.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Color | CapyKit Documentation </title>
|
||||
<title> Class Color | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Color | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class Color | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="An object representing a color.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,87 +70,35 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Color">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Color" data-uid="CapyKit.Color" class="text-break">
|
||||
Class Color
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>An object representing a color.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Color</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">Color</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Color"> Class Color</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An object representing a color.</p>
|
||||
<pre><code class="lang-csharp">public class Color
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Color.html">Color</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Color>(Color, Color)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class EncryptedValue<T> | CapyKit Documentation </title>
|
||||
<title> Class EncryptedValue<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EncryptedValue<T> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class EncryptedValue<T> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,126 +70,42 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.EncryptedValue`1">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_EncryptedValue_1" data-uid="CapyKit.EncryptedValue`1" class="text-break">
|
||||
Class EncryptedValue<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class EncryptedValue<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">EncryptedValue<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_EncryptedValue_1_Value_" data-uid="CapyKit.EncryptedValue`1.Value*"></a>
|
||||
|
||||
<h3 id="CapyKit_EncryptedValue_1_Value" data-uid="CapyKit.EncryptedValue`1.Value">
|
||||
Value
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public T Value { get; set; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_EncryptedValue_1"> Class EncryptedValue<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public class EncryptedValue<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EncryptedValue<T>>(EncryptedValue<T>, EncryptedValue<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_EncryptedValue_1_Value"> Value</h3>
|
||||
<pre><code class="lang-csharp">public T Value { get; set; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p>T</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Enum MeasurementSystem | CapyKit Documentation </title>
|
||||
<title> Enum MeasurementSystem | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Enum MeasurementSystem | CapyKit Documentation ">
|
||||
<meta name="title" content=" Enum MeasurementSystem | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="An enumeration representing different measurement systems.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,84 +70,35 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Enumerations.MeasurementSystem">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Enumerations_MeasurementSystem" data-uid="CapyKit.Enumerations.MeasurementSystem" class="text-break">
|
||||
Enum MeasurementSystem
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Enumerations.html">Enumerations</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>An enumeration representing different measurement systems.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum MeasurementSystem</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<T>(T, string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<T>(T, string, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="CapyKit_Enumerations_MeasurementSystem_Imperial"><code>Imperial = 0</code></dt>
|
||||
|
||||
<dd><p>The imperial measurement system.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_Enumerations_MeasurementSystem_Metric"><code>Metric = 1</code></dt>
|
||||
|
||||
<dd><p>The metric measurement system.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Enumerations_MeasurementSystem"> Enum MeasurementSystem</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Enumerations.html">CapyKit.Enumerations</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An enumeration representing different measurement systems.</p>
|
||||
<pre><code class="lang-csharp">public enum MeasurementSystem
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string, bool)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<MeasurementSystem>(MeasurementSystem, MeasurementSystem)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<p><code>Imperial = 0</code></p>
|
||||
<p>The imperial measurement system.</p>
|
||||
<p><code>Metric = 1</code></p>
|
||||
<p>The metric measurement system.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace CapyKit.Enumerations | CapyKit Documentation </title>
|
||||
<title> Namespace CapyKit.Enumerations | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace CapyKit.Enumerations | CapyKit Documentation ">
|
||||
<meta name="title" content=" Namespace CapyKit.Enumerations | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,28 +70,19 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Enumerations">
|
||||
|
||||
<h1 id="CapyKit_Enumerations" data-uid="CapyKit.Enumerations" class="text-break">Namespace CapyKit.Enumerations</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></dt>
|
||||
<dd><p>An enumeration representing different measurement systems.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Enumerations"> Namespace CapyKit.Enumerations</h1>
|
||||
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>An enumeration representing different measurement systems.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Enum EventLevel | CapyKit Documentation </title>
|
||||
<title> Enum EventLevel | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Enum EventLevel | CapyKit Documentation ">
|
||||
<meta name="title" content=" Enum EventLevel | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Enumeration representing different event level severity values.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,101 +70,41 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.EventLevel">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_EventLevel" data-uid="CapyKit.EventLevel" class="text-break">
|
||||
Enum EventLevel
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Enumeration representing different event level severity values.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum EventLevel</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<T>(T, string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<T>(T, string, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="CapyKit_EventLevel_Critical"><code>[EnumerationDescription("Represents a critical error that requires immediate attention.")]
|
||||
Critical = 0</code></dt>
|
||||
|
||||
<dd><p>Represents a critical error that requires immediate attention.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_EventLevel_Debug"><code>[EnumerationDescription("Represents detailed messages that are typically used for debugging purposes.")]
|
||||
Debug = 4</code></dt>
|
||||
|
||||
<dd><p>Represents detailed messages that are typically used for debugging purposes.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_EventLevel_Error"><code>[EnumerationDescription("Represents an error that prevents the normal execution of the application.")]
|
||||
Error = 1</code></dt>
|
||||
|
||||
<dd><p>Represents an error that prevents the normal execution of the application.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_EventLevel_Information"><code>[EnumerationDescription("Represents informational messages that provide useful context to the consumer.")]
|
||||
Information = 3</code></dt>
|
||||
|
||||
<dd><p>Represents informational messages that provide useful context to the consumer.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_EventLevel_Warning"><code>[EnumerationDescription("Represents a warning indicating a non-critical issue that should be addressed.")]
|
||||
Warning = 2</code></dt>
|
||||
|
||||
<dd><p>Represents a warning indicating a non-critical issue that should be addressed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_EventLevel"> Enum EventLevel</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Enumeration representing different event level severity values.</p>
|
||||
<pre><code class="lang-csharp">public enum EventLevel
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<EventLevel>(EventLevel, string)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<EventLevel>(EventLevel, string, bool)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EventLevel>(EventLevel, EventLevel)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<p><code>Critical = 0</code></p>
|
||||
<p>Represents a critical error that requires immediate attention.</p>
|
||||
<p><code>Debug = 4</code></p>
|
||||
<p>Represents detailed messages that are typically used for debugging purposes.</p>
|
||||
<p><code>Error = 1</code></p>
|
||||
<p>Represents an error that prevents the normal execution of the application.</p>
|
||||
<p><code>Information = 3</code></p>
|
||||
<p>Represents informational messages that provide useful context to the consumer.</p>
|
||||
<p><code>Warning = 2</code></p>
|
||||
<p>Represents a warning indicating a non-critical issue that should be addressed.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class EnumerationExtensions | CapyKit Documentation </title>
|
||||
<title> Class EnumerationExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EnumerationExtensions | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class EnumerationExtensions | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Provides static extentions methods for providing additional functionality for types.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,336 +70,107 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Extensions.EnumerationExtensions">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Extensions_EnumerationExtensions" data-uid="CapyKit.Extensions.EnumerationExtensions" class="text-break">
|
||||
Class EnumerationExtensions
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Provides static extentions methods for providing additional functionality for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> types.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class EnumerationExtensions</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">EnumerationExtensions</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetDescription_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetDescription*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)">
|
||||
GetDescription(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets a description.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetDescription(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The description if available, otherwise the string representation of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetName_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetName*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)">
|
||||
GetName(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets a name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetName(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetPrettyName*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)">
|
||||
GetPrettyName(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets a human readable name.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetPrettyName(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The human readable name of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetValue_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetValue*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)">
|
||||
GetValue(Enum)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> extension method that gets an integer value representing the enumation.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static int GetValue(this Enum enumeration)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The integer value of the enumeration.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_Parse_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)">
|
||||
Parse<T>(T, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Parse<T>(this T enumeration, string value) where T : Enum</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A T.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_EnumerationExtensions_Parse_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_" data-uid="CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)">
|
||||
Parse<T>(T, string, bool)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>enumeration</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The enumeration to act on.</p>
|
||||
</dd>
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The string value of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a>.</p>
|
||||
</dd>
|
||||
<dt><code>ignoreCase</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True to ignore case.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A T.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Extensions_EnumerationExtensions"> Class EnumerationExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.Enum</span> types.</p>
|
||||
<pre><code class="lang-csharp">public static class EnumerationExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_"> GetDescription(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a description.</p>
|
||||
<pre><code class="lang-csharp">public static string GetDescription(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The description if available, otherwise the string representation of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_"> GetName(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a name.</p>
|
||||
<pre><code class="lang-csharp">public static string GetName(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_"> GetPrettyName(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets a human readable name.</p>
|
||||
<pre><code class="lang-csharp">public static string GetPrettyName(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The human readable name of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_"> GetValue(Enum)</h3>
|
||||
<p>An <span class="xref">System.Enum</span> extension method that gets an integer value representing the enumation.</p>
|
||||
<pre><code class="lang-csharp">public static int GetValue(this Enum enumeration)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The integer value of the enumeration.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_"> Parse<T>(T, string)</h3>
|
||||
<p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
<pre><code class="lang-csharp">public static T Parse<T>(this T enumeration, string value) where T : Enum
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>enumeration</code> T</p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The value.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A T.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_"> Parse<T>(T, string, bool)</h3>
|
||||
<p>A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.</p>
|
||||
<pre><code class="lang-csharp">public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>enumeration</code> T</p>
|
||||
<p>The enumeration to act on.</p>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string value of the <span class="xref">System.Enum</span>.</p>
|
||||
<p><code>ignoreCase</code> <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True to ignore case.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A T.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class LINQExtensions | CapyKit Documentation </title>
|
||||
<title> Class LINQExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class LINQExtensions | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class LINQExtensions | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Provides static extension methods for performing common LINQ operations on and collections.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,600 +70,226 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Extensions.LINQExtensions">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Extensions_LINQExtensions" data-uid="CapyKit.Extensions.LINQExtensions" class="text-break">
|
||||
Class LINQExtensions
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Provides static extension methods for performing common LINQ operations on <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable<T></a> and <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable<T></a> collections.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class LINQExtensions</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">LINQExtensions</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_Distinct_" data-uid="CapyKit.Extensions.LINQExtensions.Distinct*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Distinct__2_System_Collections_Generic_IEnumerable___0__System_Func___0___1__" data-uid="CapyKit.Extensions.LINQExtensions.Distinct``2(System.Collections.Generic.IEnumerable{``0},System.Func{``0,``1})">
|
||||
Distinct<T, U>(IEnumerable<T>, Func<T, U>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Enumerates distinct items in this collection as defined by the key <code class="paramref">property</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>items</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The items to act on.</p>
|
||||
</dd>
|
||||
<dt><code>property</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></dt>
|
||||
<dd><p>The property.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>An enumerator that allows foreach to be used to process distinct items in this collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter of the parent object.</p>
|
||||
</dd>
|
||||
<dt><code>U</code></dt>
|
||||
<dd><p>Generic type parameter property value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_Filter_" data-uid="CapyKit.Extensions.LINQExtensions.Filter*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Collections_Generic_IEnumerable___0__System_Func___0_System_Boolean__" data-uid="CapyKit.Extensions.LINQExtensions.Filter``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Boolean})">
|
||||
Filter<T>(IEnumerable<T>, Func<T, bool>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IEnumerable<T> Filter<T>(this IEnumerable<T> source, Func<T, bool> predicate)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>predicate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></dt>
|
||||
<dd><p>The predicate.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_Filter_" data-uid="CapyKit.Extensions.LINQExtensions.Filter*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Linq_IQueryable___0__System_Linq_Expressions_Expression_System_Func___0_System_Boolean___" data-uid="CapyKit.Extensions.LINQExtensions.Filter``1(System.Linq.IQueryable{``0},System.Linq.Expressions.Expression{System.Func{``0,System.Boolean}})">
|
||||
Filter<T>(IQueryable<T>, Expression<Func<T, bool>>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IQueryable<T> Filter<T>(this IQueryable<T> source, Expression<Func<T, bool>> predicate)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>predicate</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>>></dt>
|
||||
<dd><p>The predicate.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
||||
<dd><p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin_" data-uid="CapyKit.Extensions.LINQExtensions.LeftOuterJoin*"></a>
|
||||
|
||||
<h3 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__" data-uid="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})">
|
||||
LeftOuterJoin<T, U, TKey, R>(IEnumerable<T>, IEnumerable<U>, Func<T, TKey>, Func<U, TKey>, Func<T, IEnumerable<U>, R>, Func<T, U>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An IEnumable<T> extension method that left outer join.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">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)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>inner</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U></dt>
|
||||
<dd><p>The inner.</p>
|
||||
</dd>
|
||||
<dt><code>outerSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey></dt>
|
||||
<dd><p>The outer selector.</p>
|
||||
</dd>
|
||||
<dt><code>innerSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><U, TKey></dt>
|
||||
<dd><p>The inner selector.</p>
|
||||
</dd>
|
||||
<dt><code>resultSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><T, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U>, R></dt>
|
||||
<dd><p>The result selector.</p>
|
||||
</dd>
|
||||
<dt><code>defaultGenerator</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></dt>
|
||||
<dd><p>(Optional) The default generator.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><R></dt>
|
||||
<dd><p>An enumerator that allows foreach to be used to process left outter join in this collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
<dt><code>U</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
<dt><code>TKey</code></dt>
|
||||
<dd><p>Type of the key.</p>
|
||||
</dd>
|
||||
<dt><code>R</code></dt>
|
||||
<dd><p>Type of the r.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin_" data-uid="CapyKit.Extensions.LINQExtensions.LeftOuterJoin*"></a>
|
||||
|
||||
<h3 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__" data-uid="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})">
|
||||
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>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An IQueryable<T> extension method that left outer join.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">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)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>inner</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><U></dt>
|
||||
<dd><p>The inner.</p>
|
||||
</dd>
|
||||
<dt><code>outerSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey>></dt>
|
||||
<dd><p>The outer selector.</p>
|
||||
</dd>
|
||||
<dt><code>innerSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><U, TKey>></dt>
|
||||
<dd><p>The inner selector.</p>
|
||||
</dd>
|
||||
<dt><code>resultSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><T, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U>, R></dt>
|
||||
<dd><p>The result selector.</p>
|
||||
</dd>
|
||||
<dt><code>defaultGenerator</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></dt>
|
||||
<dd><p>(Optional) The default generator.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><R></dt>
|
||||
<dd><p>An IQueryable<R></p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
<dt><code>U</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
<dt><code>TKey</code></dt>
|
||||
<dd><p>Type of the key.</p>
|
||||
</dd>
|
||||
<dt><code>R</code></dt>
|
||||
<dd><p>Type of the r.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_PageCount_" data-uid="CapyKit.Extensions.LINQExtensions.PageCount*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Collections_Generic_IEnumerable___0__System_Int32_" data-uid="CapyKit.Extensions.LINQExtensions.PageCount``1(System.Collections.Generic.IEnumerable{``0},System.Int32)">
|
||||
PageCount<T>(IEnumerable<T>, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The number of pages of <code class="paramref">pageSize</code> size in the given collection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static int PageCount<T>(this IEnumerable<T> source, int pageSize)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>pageSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Size of the page.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>An int.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
|
||||
<dd><p>Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_PageCount_" data-uid="CapyKit.Extensions.LINQExtensions.PageCount*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Linq_IQueryable___0__System_Int32_" data-uid="CapyKit.Extensions.LINQExtensions.PageCount``1(System.Linq.IQueryable{``0},System.Int32)">
|
||||
PageCount<T>(IQueryable<T>, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The number of pages of <code class="paramref">pageSize</code> size in the given collection.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static int PageCount<T>(this IQueryable<T> source, int pageSize)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>pageSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Size of the page.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>An int.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
|
||||
<dd><p>Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_Page_" data-uid="CapyKit.Extensions.LINQExtensions.Page*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32_" data-uid="CapyKit.Extensions.LINQExtensions.Page``1(System.Collections.Generic.IEnumerable{``0},System.Int32,System.Int32)">
|
||||
Page<T>(IEnumerable<T>, int, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Extensions_LINQExtensions"> Class LINQExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extension methods for performing common LINQ operations on <span class="xref">System.Collections.Generic.IEnumerable`1</span> and <span class="xref">System.Linq.IQueryable`1</span> collections.</p>
|
||||
<pre><code class="lang-csharp">public static class LINQExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.LINQExtensions.html">LINQExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Distinct__2_System_Collections_Generic_IEnumerable___0__System_Func___0___1__"> Distinct<T, U>(IEnumerable<T>, Func<T, U>)</h3>
|
||||
<p>Enumerates distinct items in this collection as defined by the key <code class="paramref">property</code>.</p>
|
||||
<pre><code class="lang-csharp">public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>items</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The items to act on.</p>
|
||||
<p><code>property</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>The property.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process distinct items in this collection.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter of the parent object.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter property value.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Collections_Generic_IEnumerable___0__System_Func___0_System_Boolean__"> Filter<T>(IEnumerable<T>, Func<T, bool>)</h3>
|
||||
<p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||
<pre><code class="lang-csharp">public static IEnumerable<T> Filter<T>(this IEnumerable<T> source, Func<T, bool> predicate)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>predicate</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></p>
|
||||
<p>The predicate.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Linq_IQueryable___0__System_Linq_Expressions_Expression_System_Func___0_System_Boolean___"> Filter<T>(IQueryable<T>, Expression<Func<T, bool>>)</h3>
|
||||
<p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||
<pre><code class="lang-csharp">public static IQueryable<T> Filter<T>(this IQueryable<T> source, Expression<Func<T, bool>> predicate)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>predicate</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>>></p>
|
||||
<p>The predicate.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 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__"> 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>)</h3>
|
||||
<p>An IQueryable<T> extension method that left outer join.</p>
|
||||
<pre><code class="lang-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)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>inner</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><U></p>
|
||||
<p>The inner.</p>
|
||||
<p><code>outerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey>></p>
|
||||
<p>The outer selector.</p>
|
||||
<p><code>innerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1">Expression</a><<a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><U, TKey>></p>
|
||||
<p>The inner selector.</p>
|
||||
<p><code>resultSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U>, R></p>
|
||||
<p>The result selector.</p>
|
||||
<p><code>defaultGenerator</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>(Optional) The default generator.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><R></p>
|
||||
<p>An IQueryable<R></p>
|
||||
<h4 id="type-parameters-3">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>TKey</code></p>
|
||||
<p>Type of the key.</p>
|
||||
<p><code>R</code></p>
|
||||
<p>Type of the r.</p>
|
||||
<h3 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__"> LeftOuterJoin<T, U, TKey, R>(IEnumerable<T>, IEnumerable<U>, Func<T, TKey>, Func<U, TKey>, Func<T, IEnumerable<U>, R>, Func<T, U>)</h3>
|
||||
<p>An IEnumable<T> extension method that left outer join.</p>
|
||||
<pre><code class="lang-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)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>inner</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U></p>
|
||||
<p>The inner.</p>
|
||||
<p><code>outerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey></p>
|
||||
<p>The outer selector.</p>
|
||||
<p><code>innerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><U, TKey></p>
|
||||
<p>The inner selector.</p>
|
||||
<p><code>resultSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-3">Func</a><T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U>, R></p>
|
||||
<p>The result selector.</p>
|
||||
<p><code>defaultGenerator</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>(Optional) The default generator.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><R></p>
|
||||
<p>An enumerator that allows foreach to be used to process left outter join in this collection.</p>
|
||||
<h4 id="type-parameters-4">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<p><code>TKey</code></p>
|
||||
<p>Type of the key.</p>
|
||||
<p><code>R</code></p>
|
||||
<p>Type of the r.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32_"> Page<T>(IEnumerable<T>, int, int)</h3>
|
||||
<p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||
<code class="paramref">pageSize</code> items per page.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>pageNumber</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The page number to retrieve.</p>
|
||||
</dd>
|
||||
<dt><code>pageSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>Number of items per page.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method uses natural numbering starting at page 1.</p>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
|
||||
<dd><p>Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
|
||||
<pre><code class="lang-csharp">public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageNumber</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The page number to retrieve.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>Number of items per page.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||
<h4 id="type-parameters-5">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method uses natural numbering starting at page 1.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>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>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_LINQExtensions_Page_" data-uid="CapyKit.Extensions.LINQExtensions.Page*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32_" data-uid="CapyKit.Extensions.LINQExtensions.Page``1(System.Linq.IQueryable{``0},System.Int32,System.Int32)">
|
||||
Page<T>(IQueryable<T>, int, int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32_"> Page<T>(IQueryable<T>, int, int)</h3>
|
||||
<p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||
<code class="paramref">pageSize</code> items per page.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
||||
<dd><p>The source to act on.</p>
|
||||
</dd>
|
||||
<dt><code>pageNumber</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The page number to retrieve.</p>
|
||||
</dd>
|
||||
<dt><code>pageSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
||||
<dd><p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method uses natural numbering starting at page 1.</p>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></dt>
|
||||
<dd><p>Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
|
||||
<pre><code class="lang-csharp">public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageNumber</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The page number to retrieve.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||
<h4 id="type-parameters-6">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>This method uses natural numbering starting at page 1.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>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>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Collections_Generic_IEnumerable___0__System_Int32_"> PageCount<T>(IEnumerable<T>, int)</h3>
|
||||
<p>The number of pages of <code class="paramref">pageSize</code> size in the given collection.</p>
|
||||
<pre><code class="lang-csharp">public static int PageCount<T>(this IEnumerable<T> source, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>Size of the page.</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>An int.</p>
|
||||
<h4 id="type-parameters-7">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions-2">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.</p>
|
||||
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Linq_IQueryable___0__System_Int32_"> PageCount<T>(IQueryable<T>, int)</h3>
|
||||
<p>The number of pages of <code class="paramref">pageSize</code> size in the given collection.</p>
|
||||
<pre><code class="lang-csharp">public static int PageCount<T>(this IQueryable<T> source, int pageSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters-8">Parameters</h4>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||
<p>The source to act on.</p>
|
||||
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>Size of the page.</p>
|
||||
<h4 id="returns-8">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>An int.</p>
|
||||
<h4 id="type-parameters-8">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions-3">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception">ArgumentOutOfRangeException</a></p>
|
||||
<p>Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class ObjectExtensions | CapyKit Documentation </title>
|
||||
<title> Class ObjectExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class ObjectExtensions | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class ObjectExtensions | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="An class containing extenstions that apply to any object type.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,161 +70,58 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Extensions.ObjectExtensions">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Extensions_ObjectExtensions"> Class ObjectExtensions</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Extensions_ObjectExtensions" data-uid="CapyKit.Extensions.ObjectExtensions" class="text-break">
|
||||
Class ObjectExtensions
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>An class containing extenstions that apply to any object type.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class ObjectExtensions</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">ObjectExtensions</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_" data-uid="CapyKit.Extensions.ObjectExtensions.UpdateProperties*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_" data-uid="CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)">
|
||||
UpdateProperties(object, object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An class containing extenstions that apply to any object type.</p>
|
||||
<pre><code class="lang-csharp">public static class ObjectExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html">ObjectExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_"> UpdateProperties<T>(T, T)</h3>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void UpdateProperties(this object target, object source)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>target</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The target object to act on.</p>
|
||||
</dd>
|
||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>Source for the new property values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_" data-uid="CapyKit.Extensions.ObjectExtensions.UpdateProperties*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_" data-uid="CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)">
|
||||
UpdateProperties<T>(T, T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||
<pre><code class="lang-csharp">public static void UpdateProperties<T>(this T target, T source)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>target</code> T</p>
|
||||
<p>The target object to act on.</p>
|
||||
<p><code>source</code> T</p>
|
||||
<p>Source for the new property values.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_"> UpdateProperties(object, object)</h3>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void UpdateProperties<T>(this T target, T source)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>target</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The target object to act on.</p>
|
||||
</dd>
|
||||
<dt><code>source</code> <span class="xref">T</span></dt>
|
||||
<dd><p>Source for the new property values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public static void UpdateProperties(this object target, object source)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>target</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The target object to act on.</p>
|
||||
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>Source for the new property values.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class StringExtensions | CapyKit Documentation </title>
|
||||
<title> Class StringExtensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class StringExtensions | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class StringExtensions | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Provides static extentions methods for providing additional functionality for types.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,177 +70,63 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Extensions.StringExtensions">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Extensions_StringExtensions" data-uid="CapyKit.Extensions.StringExtensions" class="text-break">
|
||||
Class StringExtensions
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Provides static extentions methods for providing additional functionality for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> types.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class StringExtensions</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">StringExtensions</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_StringExtensions_IfNullOrEmpty_" data-uid="CapyKit.Extensions.StringExtensions.IfNullOrEmpty*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_" data-uid="CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)">
|
||||
IfNullOrEmpty(string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Replaces a null or empty string with a specified replacement string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string IfNullOrEmpty(this string value, string replacement)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The original string.</p>
|
||||
</dd>
|
||||
<dt><code>replacement</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The replacement string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The original string if not null or empty, otherwise the replacement string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.isnullorempty">IsNullOrEmpty</a>(<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>)</div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_" data-uid="CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace*"></a>
|
||||
|
||||
<h3 id="CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_" data-uid="CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)">
|
||||
IfNullOrWhiteSpace(string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Replaces a null or whitespace string with a specified replacement string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string IfNullOrWhiteSpace(this string value, string replacement)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The original string.</p>
|
||||
</dd>
|
||||
<dt><code>replacement</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The replacement string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The original string if not null or whitespace, otherwise the replacement string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace">IsNullOrWhiteSpace</a>(<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>)</div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Extensions_StringExtensions"> Class StringExtensions</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.String</span> types.</p>
|
||||
<pre><code class="lang-csharp">public static class StringExtensions
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Extensions.StringExtensions.html">StringExtensions</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_"> IfNullOrEmpty(string, string)</h3>
|
||||
<p>Replaces a null or empty string with a specified replacement string.</p>
|
||||
<pre><code class="lang-csharp">public static string IfNullOrEmpty(this string value, string replacement)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string.</p>
|
||||
<p><code>replacement</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The replacement string.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string if not null or empty, otherwise the replacement string.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorempty">IsNullOrEmpty</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>?)</p>
|
||||
<h3 id="CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_"> IfNullOrWhiteSpace(string, string)</h3>
|
||||
<p>Replaces a null or whitespace string with a specified replacement string.</p>
|
||||
<pre><code class="lang-csharp">public static string IfNullOrWhiteSpace(this string value, string replacement)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string.</p>
|
||||
<p><code>replacement</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The replacement string.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The original string if not null or whitespace, otherwise the replacement string.</p>
|
||||
<h4 id="see-also-1">See Also</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace">IsNullOrWhiteSpace</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>?)</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace CapyKit.Extensions | CapyKit Documentation </title>
|
||||
<title> Namespace CapyKit.Extensions | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace CapyKit.Extensions | CapyKit Documentation ">
|
||||
<meta name="title" content=" Namespace CapyKit.Extensions | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,43 +70,25 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Extensions">
|
||||
|
||||
<h1 id="CapyKit_Extensions" data-uid="CapyKit.Extensions" class="text-break">Namespace CapyKit.Extensions</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</a></dt>
|
||||
<dd><p>Provides static extentions methods for providing additional functionality for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a> types.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Extensions.LINQExtensions.html">LINQExtensions</a></dt>
|
||||
<dd><p>Provides static extension methods for performing common LINQ operations on <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable<T></a> and <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable<T></a> collections.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Extensions.ObjectExtensions.html">ObjectExtensions</a></dt>
|
||||
<dd><p>An class containing extenstions that apply to any object type.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Extensions.StringExtensions.html">StringExtensions</a></dt>
|
||||
<dd><p>Provides static extentions methods for providing additional functionality for <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a> types.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Extensions"> Namespace CapyKit.Extensions</h1>
|
||||
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</a></p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.Enum</span> types.</p>
|
||||
<p><a href="CapyKit.Extensions.LINQExtensions.html">LINQExtensions</a></p>
|
||||
<p>Provides static extension methods for performing common LINQ operations on <span class="xref">System.Collections.Generic.IEnumerable`1</span> and <span class="xref">System.Linq.IQueryable`1</span> collections.</p>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html">ObjectExtensions</a></p>
|
||||
<p>An class containing extenstions that apply to any object type.</p>
|
||||
<p><a href="CapyKit.Extensions.StringExtensions.html">StringExtensions</a></p>
|
||||
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.String</span> types.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CalculationHelper | CapyKit Documentation </title>
|
||||
<title> Class CalculationHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CalculationHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class CalculationHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Static class providing helper methods for various calculations.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,501 +70,155 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.CalculationHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_CalculationHelper" data-uid="CapyKit.Helpers.CalculationHelper" class="text-break">
|
||||
Class CalculationHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Static class providing helper methods for various calculations.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class CalculationHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">CalculationHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS" data-uid="CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS">
|
||||
EARTH_RADIUS_KILOMETERS
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The earth's radius in kilometers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int EARTH_RADIUS_KILOMETERS = 6371</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER" data-uid="CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER">
|
||||
MILES_PER_KILOMETER
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Ratio of miles per kilometer .</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const double MILES_PER_KILOMETER = 0.621371</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_CalculateHash_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHash*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)">
|
||||
CalculateHash(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Calculates the hash of a given string using an <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.security.cryptography.md5">MD5</a> value as the first 32 bits.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static int CalculateHash(string str)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>str</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The string to be hashed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The calculated hash.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method is used for a quick and consistent hash function. It should not be considered
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_CalculationHelper"> Class CalculationHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Static class providing helper methods for various calculations.</p>
|
||||
<pre><code class="lang-csharp">public static class CalculationHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS"> EARTH_RADIUS_KILOMETERS</h3>
|
||||
<p>The earth's radius in kilometers.</p>
|
||||
<pre><code class="lang-csharp">public const int EARTH_RADIUS_KILOMETERS = 6371
|
||||
</code></pre>
|
||||
<h4 id="field-value">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER"> MILES_PER_KILOMETER</h3>
|
||||
<p>Ratio of miles per kilometer .</p>
|
||||
<pre><code class="lang-csharp">public const double MILES_PER_KILOMETER = 0.621371
|
||||
</code></pre>
|
||||
<h4 id="field-value-1">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_"> CalculateHash(string)</h3>
|
||||
<p>Calculates the hash of a given string using an <span class="xref">System.Security.Cryptography.MD5</span> value as the first 32 bits.</p>
|
||||
<pre><code class="lang-csharp">public static int CalculateHash(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string to be hashed.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The calculated hash.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method is used for a quick and consistent hash function. It should not be considered
|
||||
cryptographically sound or used in security contexts.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHexHash*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)">
|
||||
CalculateHexHash(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Calculates the hexadecimal hash.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string CalculateHexHash(string str)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>str</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The string to be hashed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The calculated 16 character hexadecimal hash.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_" data-uid="CapyKit.Helpers.CalculationHelper.DegreesToRadians*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)">
|
||||
DegreesToRadians(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Convers degrees to radians.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double DegreesToRadians(double degrees)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>degrees</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The degree value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value as radians.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_GetDistance_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)">
|
||||
GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>latitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The latitude origin.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The longitude origin.</p>
|
||||
</dd>
|
||||
<dt><code>latitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The latitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The longitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>measurementSystem</code> <a class="xref" href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></dt>
|
||||
<dd><p>(Optional) The measurement system.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></dt>
|
||||
<dd><p>The distance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_"> CalculateHexHash(string)</h3>
|
||||
<p>Calculates the hexadecimal hash.</p>
|
||||
<pre><code class="lang-csharp">public static string CalculateHexHash(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The string to be hashed.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The calculated 16 character hexadecimal hash.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_"> DegreesToRadians(double)</h3>
|
||||
<p>Convers degrees to radians.</p>
|
||||
<pre><code class="lang-csharp">public static double DegreesToRadians(double degrees)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>degrees</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The degree value.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value as radians.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)</h3>
|
||||
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
<pre><code class="lang-csharp">public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The latitude origin.</p>
|
||||
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The longitude origin.</p>
|
||||
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The latitude destination.</p>
|
||||
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The longitude destination.</p>
|
||||
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>(Optional) The measurement system.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||
<p>The distance.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_">GetDistance(double, double, double, double, MeasurementSystem)</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_GetDistance_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)">
|
||||
GetDistance(double, double, double, double, MeasurementSystem)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>latitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The latitude of the origin.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeOrigin</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The longitude of the origin.</p>
|
||||
</dd>
|
||||
<dt><code>latitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The latitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>longitudeDestination</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The longitude destination.</p>
|
||||
</dd>
|
||||
<dt><code>measurementSystem</code> <a class="xref" href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></dt>
|
||||
<dd><p>(Optional) The measurement system.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The distance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a>.<a href="CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_">GetDistance</a>(<a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a>, <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a>)</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(double, double, double, double, MeasurementSystem)</h3>
|
||||
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||
<pre><code class="lang-csharp">public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The latitude of the origin.</p>
|
||||
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The longitude of the origin.</p>
|
||||
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The latitude destination.</p>
|
||||
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The longitude destination.</p>
|
||||
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||
<p>(Optional) The measurement system.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The distance.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_" data-uid="CapyKit.Helpers.CalculationHelper.KilometersToMiles*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)">
|
||||
KilometersToMiles(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts kilometers to miles.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double KilometersToMiles(double kilometers)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>kilometers</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value in kilometers.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value in miles.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_" data-uid="CapyKit.Helpers.CalculationHelper.MilesToKilometers*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)">
|
||||
MilesToKilometers(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts miles to kilometers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double MilesToKilometers(double miles)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>miles</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value in miles.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value in kilometers.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_" data-uid="CapyKit.Helpers.CalculationHelper.RadiansToDegrees*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)">
|
||||
RadiansToDegrees(double)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts radians to degrees.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static double RadiansToDegrees(double radians)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>radians</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The radian value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
||||
<dd><p>The value as degrees.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_"> KilometersToMiles(double)</h3>
|
||||
<p>Converts kilometers to miles.</p>
|
||||
<pre><code class="lang-csharp">public static double KilometersToMiles(double kilometers)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>kilometers</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in kilometers.</p>
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in miles.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_"> MilesToKilometers(double)</h3>
|
||||
<p>Converts miles to kilometers.</p>
|
||||
<pre><code class="lang-csharp">public static double MilesToKilometers(double miles)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>miles</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in miles.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value in kilometers.</p>
|
||||
<h3 id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_"> RadiansToDegrees(double)</h3>
|
||||
<p>Converts radians to degrees.</p>
|
||||
<pre><code class="lang-csharp">public static double RadiansToDegrees(double radians)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>radians</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The radian value.</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||
<p>The value as degrees.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class CompressionHelper | CapyKit Documentation </title>
|
||||
<title> Class CompressionHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class CompressionHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class CompressionHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A class that contains methods for managing data compression.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,288 +70,91 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.CompressionHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_CompressionHelper" data-uid="CapyKit.Helpers.CompressionHelper" class="text-break">
|
||||
Class CompressionHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A class that contains methods for managing data compression.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class CompressionHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">CompressionHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CompressionHelper_Compress_" data-uid="CapyKit.Helpers.CompressionHelper.Compress*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Compress_System_Object_" data-uid="CapyKit.Helpers.CompressionHelper.Compress(System.Object)">
|
||||
Compress(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compresses a given object using the <code>gzip</code> algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static byte[] Compress(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A byte array representing the compressed object in <code>gzip</code> format.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CompressionHelper_CompressToString_" data-uid="CapyKit.Helpers.CompressionHelper.CompressToString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_" data-uid="CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)">
|
||||
CompressToString(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string CompressToString(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string in <code>base64</code> encoding.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CompressionHelper_DecompressToString_" data-uid="CapyKit.Helpers.CompressionHelper.DecompressToString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_" data-uid="CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)">
|
||||
DecompressToString(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Decompresses the given <code>base64</code> string in <code>gzip</code> format.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string DecompressToString(string compressed)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>compressed</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The compressed string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A decomressed string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CompressionHelper_Decompress_" data-uid="CapyKit.Helpers.CompressionHelper.Decompress*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_Byte___" data-uid="CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])">
|
||||
Decompress<T>(byte[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Decompresses a given compressed <code>gzip</code> byte stream.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Decompress<T>(byte[] byteStream)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>byteStream</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The compressed byte stream.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A <code class="typeparamref">T</code> typed object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_CompressionHelper_Decompress_" data-uid="CapyKit.Helpers.CompressionHelper.Decompress*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_" data-uid="CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)">
|
||||
Decompress<T>(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Decompress<T>(string encodedString)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>encodedString</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The <code>base64</code> encoded <code>gzip</code> string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A <code class="typeparamref">T</code> typed object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_CompressionHelper"> Class CompressionHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing data compression.</p>
|
||||
<pre><code class="lang-csharp">public static class CompressionHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.CompressionHelper.html">CompressionHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Compress_System_Object_"> Compress(object)</h3>
|
||||
<p>Compresses a given object using the <code>gzip</code> algorithm.</p>
|
||||
<pre><code class="lang-csharp">public static byte[] Compress(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array representing the compressed object in <code>gzip</code> format.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_"> CompressToString(object)</h3>
|
||||
<p>Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.</p>
|
||||
<pre><code class="lang-csharp">public static string CompressToString(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string in <code>base64</code> encoding.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_"> Decompress<T>(string)</h3>
|
||||
<p>Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.</p>
|
||||
<pre><code class="lang-csharp">public static T Decompress<T>(string encodedString)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>encodedString</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The <code>base64</code> encoded <code>gzip</code> string.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> typed object.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_Byte___"> Decompress<T>(byte[])</h3>
|
||||
<p>Decompresses a given compressed <code>gzip</code> byte stream.</p>
|
||||
<pre><code class="lang-csharp">public static T Decompress<T>(byte[] byteStream)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>byteStream</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The compressed byte stream.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> typed object.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_"> DecompressToString(string)</h3>
|
||||
<p>Decompresses the given <code>base64</code> string in <code>gzip</code> format.</p>
|
||||
<pre><code class="lang-csharp">public static string DecompressToString(string compressed)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>compressed</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The compressed string.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A decomressed string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class EncryptionHelper | CapyKit Documentation </title>
|
||||
<title> Class EncryptionHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class EncryptionHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class EncryptionHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,121 +70,40 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.EncryptionHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_EncryptionHelper" data-uid="CapyKit.Helpers.EncryptionHelper" class="text-break">
|
||||
Class EncryptionHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class EncryptionHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">EncryptionHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_EncryptionHelper__ctor_" data-uid="CapyKit.Helpers.EncryptionHelper.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_EncryptionHelper__ctor_System_String_" data-uid="CapyKit.Helpers.EncryptionHelper.#ctor(System.String)">
|
||||
EncryptionHelper(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public EncryptionHelper(string encryptionKey)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>encryptionKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_EncryptionHelper"> Class EncryptionHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public class EncryptionHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.EncryptionHelper.html">EncryptionHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EncryptionHelper>(EncryptionHelper, EncryptionHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Helpers_EncryptionHelper__ctor_System_String_"> EncryptionHelper(string)</h3>
|
||||
<pre><code class="lang-csharp">public EncryptionHelper(string encryptionKey)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>encryptionKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface IEncryptionAlgorithm | CapyKit Documentation </title>
|
||||
<title> Interface IEncryptionAlgorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IEncryptionAlgorithm | CapyKit Documentation ">
|
||||
<meta name="title" content=" Interface IEncryptionAlgorithm | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,179 +70,50 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.IEncryptionAlgorithm">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_IEncryptionAlgorithm" data-uid="CapyKit.Helpers.IEncryptionAlgorithm" class="text-break">
|
||||
Interface IEncryptionAlgorithm
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IEncryptionAlgorithm</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName_" data-uid="CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName" data-uid="CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName">
|
||||
AlgorithmName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">string AlgorithmName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt_" data-uid="CapyKit.Helpers.IEncryptionAlgorithm.Decrypt*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___" data-uid="CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])">
|
||||
Decrypt<T>(EncryptedValue<T>, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>encryptedValue</code> <a class="xref" href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></dt>
|
||||
<dd></dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt_" data-uid="CapyKit.Helpers.IEncryptionAlgorithm.Encrypt*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___" data-uid="CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])">
|
||||
Encrypt<T>(object, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">EncryptedValue<T> Encrypt<T>(object obj, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_IEncryptionAlgorithm"> Interface IEncryptionAlgorithm</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public interface IEncryptionAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___"> Decrypt<T>(EncryptedValue<T>, params object[])</h3>
|
||||
<pre><code class="lang-csharp">T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>encryptedValue</code> <a href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p>T</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___"> Encrypt<T>(object, params object[])</h3>
|
||||
<pre><code class="lang-csharp">EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class KeyHelper | CapyKit Documentation </title>
|
||||
<title> Class KeyHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class KeyHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class KeyHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A class that contains methods for managing key creation and validation against a master key.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,381 +70,105 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.KeyHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_KeyHelper" data-uid="CapyKit.Helpers.KeyHelper" class="text-break">
|
||||
Class KeyHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class KeyHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">KeyHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GenerateKey_" data-uid="CapyKit.Helpers.KeyHelper.GenerateKey*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey" data-uid="CapyKit.Helpers.KeyHelper.GenerateKey">
|
||||
GenerateKey()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates a random key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string GenerateKey()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GetMasterKey_" data-uid="CapyKit.Helpers.KeyHelper.GetMasterKey*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey" data-uid="CapyKit.Helpers.KeyHelper.GetMasterKey">
|
||||
GetMasterKey()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the master key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public byte[] GetMasterKey()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>An array of byte.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt>
|
||||
<dd><p>Thrown when the requested operation is invalid.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GetNumParts_" data-uid="CapyKit.Helpers.KeyHelper.GetNumParts*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts" data-uid="CapyKit.Helpers.KeyHelper.GetNumParts">
|
||||
GetNumParts()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the number parts.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetNumParts()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The number parts.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></dt>
|
||||
<dd><p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_GetSaltSize_" data-uid="CapyKit.Helpers.KeyHelper.GetSaltSize*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize" data-uid="CapyKit.Helpers.KeyHelper.GetSaltSize">
|
||||
GetSaltSize()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the salt size.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetSaltSize()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The salt size.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_" data-uid="CapyKit.Helpers.KeyHelper.SetMasterKeyAccessor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____" data-uid="CapyKit.Helpers.KeyHelper.SetMasterKeyAccessor(System.Func{System.Byte[]})">
|
||||
SetMasterKeyAccessor(Func<byte[]>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the master key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetMasterKeyAccessor(Func<byte[]> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]></dt>
|
||||
<dd><p>The accessor function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_" data-uid="CapyKit.Helpers.KeyHelper.SetNumPartsAccessor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__" data-uid="CapyKit.Helpers.KeyHelper.SetNumPartsAccessor(System.Func{System.Int32})">
|
||||
SetNumPartsAccessor(Func<int>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetNumPartsAccessor(Func<int> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
||||
<dd><p>The accessor function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_" data-uid="CapyKit.Helpers.KeyHelper.SetSaltSizeAccessor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__" data-uid="CapyKit.Helpers.KeyHelper.SetSaltSizeAccessor(System.Func{System.Int32})">
|
||||
SetSaltSizeAccessor(Func<int>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the salt size (in bytes). Default is 4.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void SetSaltSizeAccessor(Func<int> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></dt>
|
||||
<dd><p>The accessor function.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_KeyHelper_ValidateKey_" data-uid="CapyKit.Helpers.KeyHelper.ValidateKey*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_" data-uid="CapyKit.Helpers.KeyHelper.ValidateKey(System.String)">
|
||||
ValidateKey(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Validates the provided key.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool ValidateKey(string providedKey)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>providedKey</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The provided key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True if it succeeds, false if it fails.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_GetMasterKey">GetMasterKey()</a></div>
|
||||
<div><a class="xref" href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____">SetMasterKeyAccessor(Func<byte[]>)</a></div>
|
||||
<div><span class="xref">masterKeyAccessor</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_KeyHelper"> Class KeyHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
<pre><code class="lang-csharp">public class KeyHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<KeyHelper>(KeyHelper, KeyHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey"> GenerateKey()</h3>
|
||||
<p>Generates a random key.</p>
|
||||
<pre><code class="lang-csharp">public string GenerateKey()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The key.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey"> GetMasterKey()</h3>
|
||||
<p>Gets the master key.</p>
|
||||
<pre><code class="lang-csharp">public byte[] GetMasterKey()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>An array of byte.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></p>
|
||||
<p>Thrown when the requested operation is invalid.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts"> GetNumParts()</h3>
|
||||
<p>Gets the number parts.</p>
|
||||
<pre><code class="lang-csharp">public int GetNumParts()
|
||||
</code></pre>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The number parts.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></p>
|
||||
<p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize"> GetSaltSize()</h3>
|
||||
<p>Gets the salt size.</p>
|
||||
<pre><code class="lang-csharp">public int GetSaltSize()
|
||||
</code></pre>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The salt size.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"> SetMasterKeyAccessor(Func<byte[]>)</h3>
|
||||
<p>Sets the master key.</p>
|
||||
<pre><code class="lang-csharp">public void SetMasterKeyAccessor(Func<byte[]> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"> SetNumPartsAccessor(Func<int>)</h3>
|
||||
<p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
||||
<pre><code class="lang-csharp">public void SetNumPartsAccessor(Func<int> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__"> SetSaltSizeAccessor(Func<int>)</h3>
|
||||
<p>Sets the salt size (in bytes). Default is 4.</p>
|
||||
<pre><code class="lang-csharp">public void SetSaltSizeAccessor(Func<int> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>></p>
|
||||
<p>The accessor function.</p>
|
||||
<h3 id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_"> ValidateKey(string)</h3>
|
||||
<p>Validates the provided key.</p>
|
||||
<pre><code class="lang-csharp">public bool ValidateKey(string providedKey)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>providedKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The provided key.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True if it succeeds, false if it fails.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_GetMasterKey">GetMasterKey</a>(),
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.<a href="CapyKit.Helpers.KeyHelper.html#CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____">SetMasterKeyAccessor</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]>),
|
||||
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.masterKeyAccessor</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class LanguageHelper | CapyKit Documentation </title>
|
||||
<title> Class LanguageHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class LanguageHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class LanguageHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Helper class for handling text transformations.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,134 +70,49 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.LanguageHelper">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_LanguageHelper"> Class LanguageHelper</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_LanguageHelper" data-uid="CapyKit.Helpers.LanguageHelper" class="text-break">
|
||||
Class LanguageHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Helper class for handling text transformations.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class LanguageHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">LanguageHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_" data-uid="CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_" data-uid="CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)">
|
||||
CamelCaseToHumanReadable(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Converts camel case text to human readable text.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string CamelCaseToHumanReadable(string value)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>value</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string in human readable format.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>Camel case is a naming convention for identifiers in which the first letter of each word is
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Helper class for handling text transformations.</p>
|
||||
<pre><code class="lang-csharp">public class LanguageHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.LanguageHelper.html">LanguageHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<LanguageHelper>(LanguageHelper, LanguageHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_"> CamelCaseToHumanReadable(string)</h3>
|
||||
<p>Converts camel case text to human readable text.</p>
|
||||
<pre><code class="lang-csharp">public static string CamelCaseToHumanReadable(string value)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The value.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string in human readable format.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>Camel case is a naming convention for identifiers in which the first letter of each word is
|
||||
capitalized.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SecurityHelper | CapyKit Documentation </title>
|
||||
<title> Class SecurityHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SecurityHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class SecurityHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A class that contains methods for managing secure data processing and cryptography.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,626 +70,217 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.SecurityHelper">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_SecurityHelper"> Class SecurityHelper</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_SecurityHelper" data-uid="CapyKit.Helpers.SecurityHelper" class="text-break">
|
||||
Class SecurityHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class SecurityHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">SecurityHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_" data-uid="CapyKit.Helpers.SecurityHelper.CompareHashedPassword*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_CapyKit_Password_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___" data-uid="CapyKit.Helpers.SecurityHelper.CompareHashedPassword(CapyKit.Password,System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])">
|
||||
CompareHashedPassword(Password, string, byte[], IPasswordAlgorithm, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>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>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool CompareHashedPassword(Password existingPassword, string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>existingPassword</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>The existing, encrypted password.</p>
|
||||
</dd>
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The unencrypted password to be compared.</p>
|
||||
</dd>
|
||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The salt value used in password hashing.</p>
|
||||
</dd>
|
||||
<dt><code>algorithm</code> <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
|
||||
<dd><p>The password hashing algorithm.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><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.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_" data-uid="CapyKit.Helpers.SecurityHelper.CompareHashedPassword*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1_CapyKit_Password_System_String_System_Byte___System_Object___" data-uid="CapyKit.Helpers.SecurityHelper.CompareHashedPassword``1(CapyKit.Password,System.String,System.Byte[],System.Object[])">
|
||||
CompareHashedPassword<T>(Password, string, byte[], params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||
<pre><code class="lang-csharp">public class SecurityHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<SecurityHelper>(SecurityHelper, SecurityHelper)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1_CapyKit_Password_System_String_System_Byte___System_Object___"> CompareHashedPassword<T>(Password, string, byte[], params object[])</h3>
|
||||
<p>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>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>existingPassword</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>The existing, encrypted password.</p>
|
||||
</dd>
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The unencrypted password to be compared.</p>
|
||||
</dd>
|
||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The salt value used in password hashing.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><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.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of the password hashing algorithm.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_CompareSessionID_" data-uid="CapyKit.Helpers.SecurityHelper.CompareSessionID*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareSessionID_System_String_System_String_" data-uid="CapyKit.Helpers.SecurityHelper.CompareSessionID(System.String,System.String)">
|
||||
CompareSessionID(string, string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compares two session identifiers.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool CompareSessionID(string first, string second)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>first</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The first session identifier.</p>
|
||||
</dd>
|
||||
<dt><code>second</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The second session identifier.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><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.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_GetPassword_" data-uid="CapyKit.Helpers.SecurityHelper.GetPassword*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object___" data-uid="CapyKit.Helpers.SecurityHelper.GetPassword``1(System.String,System.Byte[],System.Object[])">
|
||||
GetPassword<T>(string, byte[], params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Retrieves a <a class="xref" href="CapyKit.Password.html">Password</a> object using the specified password, salt, and optional
|
||||
<pre><code class="lang-csharp">public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>existingPassword</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>The existing, encrypted password.</p>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The unencrypted password to be compared.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The salt value used in password hashing.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><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.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the password hashing algorithm.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_CapyKit_Password_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"> CompareHashedPassword(Password, string, byte[], IPasswordAlgorithm, params object[])</h3>
|
||||
<p>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>.</p>
|
||||
<pre><code class="lang-csharp">public static bool CompareHashedPassword(Password existingPassword, string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>existingPassword</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>The existing, encrypted password.</p>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The unencrypted password to be compared.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The salt value used in password hashing.</p>
|
||||
<p><code>algorithm</code> <a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>The password hashing algorithm.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><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.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareSessionID_System_String_System_String_"> CompareSessionID(string, string)</h3>
|
||||
<p>Compares two session identifiers.</p>
|
||||
<pre><code class="lang-csharp">public static bool CompareSessionID(string first, string second)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>first</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The first session identifier.</p>
|
||||
<p><code>second</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The second session identifier.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><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.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Object___"> GetPassword<T>(string, params object[])</h3>
|
||||
<p>Retrieves a <span class="xref">CapyKit.Password</span> object using the specified password and generates a random salt value.
|
||||
Then it uses that salt to call the overloaded <span class="xref">CapyKit.Helpers.SecurityHelper.GetPassword``1(System.String,System.Byte[],System.Object[])</span> method with the given password and
|
||||
the generated salt as arguments.</p>
|
||||
<pre><code class="lang-csharp">public static Password GetPassword<T>(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to be hashed.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Optional constructor arguments for the <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation
|
||||
instance.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> 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.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation to use.</p>
|
||||
<h4 id="see-also">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a>.SALT_SIZE</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object___"> GetPassword<T>(string, byte[], params object[])</h3>
|
||||
<p>Retrieves a <span class="xref">CapyKit.Password</span> object using the specified password, salt, and optional
|
||||
constructor arguments.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password to be hashed.</p>
|
||||
</dd>
|
||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A random value used as an additional input to the one-way function that hashes data, a
|
||||
<pre><code class="lang-csharp">public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to be hashed.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>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.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Optional constructor arguments for the <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a> implementation
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Optional constructor arguments for the <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation
|
||||
instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>A new <a class="xref" href="CapyKit.Password.html">Password</a> object with the given password and salt, as well as an instance
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object with the given password and salt, as well as an instance
|
||||
of <code class="typeparamref">T</code> created using the provided constructor arguments.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a> implementation to use.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object____remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method uses reflection to find a constructor for the specified password algorithm type (<code class="typeparamref">T</code>).
|
||||
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation to use.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_GetPassword_" data-uid="CapyKit.Helpers.SecurityHelper.GetPassword*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Object___" data-uid="CapyKit.Helpers.SecurityHelper.GetPassword``1(System.String,System.Object[])">
|
||||
GetPassword<T>(string, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Retrieves a <a class="xref" href="CapyKit.Password.html">Password</a> object using the specified password and generates a random salt value.
|
||||
Then it uses that salt to call the overloaded <a class="xref" href="CapyKit.Helpers.SecurityHelper.html#CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object___">GetPassword<T>(string, byte[], params object[])</a> method with the given password and
|
||||
the generated salt as arguments.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Password GetPassword<T>(string password, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password to be hashed.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Optional constructor arguments for the <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a> implementation
|
||||
instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>A new <a class="xref" href="CapyKit.Password.html">Password</a> 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.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a> implementation to use.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><span class="xref">SALT_SIZE</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_GetRandomPassword_" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomPassword*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomPassword_System_Int32_CapyKit_Helpers_ValidCharacterCollection___" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomPassword(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])">
|
||||
GetRandomPassword(int, params ValidCharacterCollection[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets a cryptographically strong random password.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The length of the password to generate.</p>
|
||||
</dd>
|
||||
<dt><code>validCharacters</code> <a class="xref" href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</dt>
|
||||
<dd><p>An array of <a class="xref" href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a> enumeration values representing the desired
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomPassword_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"> GetRandomPassword(int, params ValidCharacterCollection[])</h3>
|
||||
<p>Gets a cryptographically strong random password.</p>
|
||||
<pre><code class="lang-csharp">public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters)
|
||||
</code></pre>
|
||||
<h4 id="parameters-5">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The length of the password to generate.</p>
|
||||
<p><code>validCharacters</code> <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</p>
|
||||
<p>An array of <span class="xref">CapyKit.Helpers.ValidCharacterCollection</span> enumeration values representing the desired
|
||||
character sets.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The password.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_GetRandomString_" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32)">
|
||||
GetRandomString(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>A convenience method to generate a random string of the specified length using all character sets.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetRandomString(int length)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The desired length of the generated random string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist seealso">
|
||||
<dt>See Also</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a></div>
|
||||
<div><a class="xref" href="CapyKit.Helpers.SecurityHelper.html#CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___">GetRandomString(int, params ValidCharacterCollection[])</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_GetRandomString_" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32,CapyKit.Helpers.ValidCharacterCollection[])">
|
||||
GetRandomString(int, params ValidCharacterCollection[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets a cryptographically strong random string using the character values found in VALID_CHARACTERS.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string GetRandomString(int length, params ValidCharacterCollection[] validChars)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The length of the string to create.</p>
|
||||
</dd>
|
||||
<dt><code>validChars</code> <a class="xref" href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The random string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_GetSalt_" data-uid="CapyKit.Helpers.SecurityHelper.GetSalt*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32_" data-uid="CapyKit.Helpers.SecurityHelper.GetSalt(System.Int32)">
|
||||
GetSalt(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates a random byte array that can act as a salt.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static byte[] GetSalt(int length = 32)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>(Optional) The desired length of the generated byte array.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>An array of byte.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>A default length of <span class="xref">CapyKit.Helpers.SecurityHelper.SALT_SIZE</span> is provided as a sane default. Larger values can be used for increased
|
||||
<h4 id="returns-5">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The password.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_"> GetRandomString(int)</h3>
|
||||
<p>A convenience method to generate a random string of the specified length using all character sets.</p>
|
||||
<pre><code class="lang-csharp">public static string GetRandomString(int length)
|
||||
</code></pre>
|
||||
<h4 id="parameters-6">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The desired length of the generated random string.</p>
|
||||
<h4 id="returns-6">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h4 id="see-also-1">See Also</h4>
|
||||
<p><a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>,
|
||||
<a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a>.<a href="CapyKit.Helpers.SecurityHelper.html#CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___">GetRandomString</a>(<a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a>, params <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[])</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"> GetRandomString(int, params ValidCharacterCollection[])</h3>
|
||||
<p>Gets a cryptographically strong random string using the character values found in VALID_CHARACTERS.</p>
|
||||
<pre><code class="lang-csharp">public static string GetRandomString(int length, params ValidCharacterCollection[] validChars)
|
||||
</code></pre>
|
||||
<h4 id="parameters-7">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The length of the string to create.</p>
|
||||
<p><code>validChars</code> <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</p>
|
||||
<h4 id="returns-7">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The random string.</p>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32_"> GetSalt(int)</h3>
|
||||
<p>Generates a random byte array that can act as a salt.</p>
|
||||
<pre><code class="lang-csharp">public static byte[] GetSalt(int length = 32)
|
||||
</code></pre>
|
||||
<h4 id="parameters-8">Parameters</h4>
|
||||
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>(Optional) The desired length of the generated byte array.</p>
|
||||
<h4 id="returns-8">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>An array of byte.</p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>A default length of <span class="xref">CapyKit.Helpers.SecurityHelper.SALT_SIZE</span> is provided as a sane default. Larger values can be used for increased
|
||||
entropy.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_Pbkdf2_" data-uid="CapyKit.Helpers.SecurityHelper.Pbkdf2*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_" data-uid="CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String)">
|
||||
Pbkdf2(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates a new <a class="xref" href="CapyKit.Password.html">Password</a> 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.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Password Pbkdf2(string password)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The clear text password to be hashed.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>A new <a class="xref" href="CapyKit.Password.html">Password</a> object containing the hashed password and a randomly generated salt.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String__remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>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 <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">GetRandomBytes(int)</a> method.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SecurityHelper_Pbkdf2_" data-uid="CapyKit.Helpers.SecurityHelper.Pbkdf2*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_System_Byte___" data-uid="CapyKit.Helpers.SecurityHelper.Pbkdf2(System.String,System.Byte[])">
|
||||
Pbkdf2(string, byte[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Generates a new <a class="xref" href="CapyKit.Password.html">Password</a> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_System_Byte___"> Pbkdf2(string, byte[])</h3>
|
||||
<p>Generates a new <span class="xref">CapyKit.Password</span> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>
|
||||
and <code class="paramref">salt</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Password Pbkdf2(string password, byte[] salt)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The clear text password to be hashed.</p>
|
||||
</dd>
|
||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A random value used to add an additional layer of security to the generated hash.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>A new <a class="xref" href="CapyKit.Password.html">Password</a> object containing the hashed password and salt.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_System_Byte____remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate
|
||||
<pre><code class="lang-csharp">public static Password Pbkdf2(string password, byte[] salt)
|
||||
</code></pre>
|
||||
<h4 id="parameters-9">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The clear text password to be hashed.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A random value used to add an additional layer of security to the generated hash.</p>
|
||||
<h4 id="returns-9">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object containing the hashed password and salt.</p>
|
||||
<h4 id="remarks-2">Remarks</h4>
|
||||
<p>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.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_"> Pbkdf2(string)</h3>
|
||||
<p>Generates a new <span class="xref">CapyKit.Password</span> 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.</p>
|
||||
<pre><code class="lang-csharp">public static Password Pbkdf2(string password)
|
||||
</code></pre>
|
||||
<h4 id="parameters-10">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The clear text password to be hashed.</p>
|
||||
<h4 id="returns-10">Returns</h4>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>A new <span class="xref">CapyKit.Password</span> object containing the hashed password and a randomly generated salt.</p>
|
||||
<h4 id="remarks-3">Remarks</h4>
|
||||
<p>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 <span class="xref">CapyKit.Helpers.SecurityHelper.GetRandomBytes(System.Int32)</span> method.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SerializationHelper | CapyKit Documentation </title>
|
||||
<title> Class SerializationHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SerializationHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class SerializationHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,305 +70,99 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.SerializationHelper">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_SerializationHelper" data-uid="CapyKit.Helpers.SerializationHelper" class="text-break">
|
||||
Class SerializationHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"></div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class SerializationHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">SerializationHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SerializationHelper_Deserialize_" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])">
|
||||
Deserialize<T>(byte[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Deserialize<T>(byte[] bytes)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>bytes</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The byte array representing a <code class="typeparamref">T</code> object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A <code class="typeparamref">T</code> object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></dt>
|
||||
<dd><p>Thrown when the format of the byte array is incorrect.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SerializationHelper_Deserialize_" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_IO_Stream_" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)">
|
||||
Deserialize<T>(Stream)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Deserialize<T>(Stream stream)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>stream</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></dt>
|
||||
<dd><p>The steam.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A <code class="typeparamref">T</code> object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></dt>
|
||||
<dd><p>Thrown when the format of an input is incorrect.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SerializationHelper_Deserialize_" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_String_" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)">
|
||||
Deserialize<T>(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T Deserialize<T>(string str)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>str</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>A <code class="typeparamref">T</code> object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SerializationHelper_SerializeToBytes_" data-uid="CapyKit.Helpers.SerializationHelper.SerializeToBytes*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_" data-uid="CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)">
|
||||
SerializeToBytes(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Serializes an object to a byte array.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static byte[] SerializeToBytes(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A <code>JSON</code> encoded string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SerializationHelper_SerializeToString_" data-uid="CapyKit.Helpers.SerializationHelper.SerializeToString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_" data-uid="CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)">
|
||||
SerializeToString(object)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Serializes an object to a <code>JSON</code> encoded string.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static string SerializeToString(object obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A <code>JSON</code> encoded string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_SerializationHelper"> Class SerializationHelper</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<pre><code class="lang-csharp">public static class SerializationHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.SerializationHelper.html">SerializationHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___"> Deserialize<T>(byte[])</h3>
|
||||
<p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||
<pre><code class="lang-csharp">public static T Deserialize<T>(byte[] bytes)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>bytes</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The byte array representing a <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></p>
|
||||
<p>Thrown when the format of the byte array is incorrect.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_IO_Stream_"> Deserialize<T>(Stream)</h3>
|
||||
<p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||
<pre><code class="lang-csharp">public static T Deserialize<T>(Stream stream)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>stream</code> <a href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></p>
|
||||
<p>The steam.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></p>
|
||||
<p>Thrown when the format of an input is incorrect.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_String_"> Deserialize<T>(string)</h3>
|
||||
<p>Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.</p>
|
||||
<pre><code class="lang-csharp">public static T Deserialize<T>(string str)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>A <code class="typeparamref">T</code> object.</p>
|
||||
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_"> SerializeToBytes(object)</h3>
|
||||
<p>Serializes an object to a byte array.</p>
|
||||
<pre><code class="lang-csharp">public static byte[] SerializeToBytes(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A <code>JSON</code> encoded string.</p>
|
||||
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_"> SerializeToString(object)</h3>
|
||||
<p>Serializes an object to a <code>JSON</code> encoded string.</p>
|
||||
<pre><code class="lang-csharp">public static string SerializeToString(object obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-4">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||
<p>The object.</p>
|
||||
<h4 id="returns-4">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A <code>JSON</code> encoded string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class SettingsHelper | CapyKit Documentation </title>
|
||||
<title> Class SettingsHelper | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class SettingsHelper | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class SettingsHelper | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Static class containing helper methods for retrieving and setting application settings.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,70 +70,29 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.SettingsHelper">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_SettingsHelper"> Class SettingsHelper</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_SettingsHelper" data-uid="CapyKit.Helpers.SettingsHelper" class="text-break">
|
||||
Class SettingsHelper
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static class SettingsHelper</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">SettingsHelper</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
<h2 id="CapyKit_Helpers_SettingsHelper_examples">Examples</h2>
|
||||
<p>This example demonstrates how to set up the SettingsHelper class with custom accessor and
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||
<pre><code class="lang-csharp">public static class SettingsHelper
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Helpers.SettingsHelper.html">SettingsHelper</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="examples">Examples</h2>
|
||||
<p>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.</p>
|
||||
<pre><code class="lang-csharp">public int main(string[] args)
|
||||
|
|
@ -162,148 +121,51 @@ application execution, before any other usage of the helper methods.</p>
|
|||
int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
||||
Console.WriteLine("Retrieved setting: {0}", mySetting);
|
||||
}</code></pre>
|
||||
|
||||
|
||||
<h2 id="CapyKit_Helpers_SettingsHelper_remarks">Remarks</h2>
|
||||
<div class="markdown level0 remarks"><p>The specific means of accessing and storing the settings are determined by the consumer,
|
||||
<h2 id="remarks">Remarks</h2>
|
||||
<p>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>
|
||||
.</p>
|
||||
</div>
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting_" data-uid="CapyKit.Helpers.SettingsHelper.GetApplicationSetting*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_" data-uid="CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)">
|
||||
GetApplicationSetting<T>(string)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Retrieves a setting with the given <code>key</code>.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static T GetApplicationSetting<T>(string settingName)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>settingName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the setting to retrieve.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The value of the setting as an uncast <code class="typeparamref">T</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of the setting to be retrieved.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_" data-uid="CapyKit.Helpers.SettingsHelper.SetAccessorMethod*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__" data-uid="CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})">
|
||||
SetAccessorMethod(Func<string, object>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the function used to retrieve application settings.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void SetAccessorMethod(Func<string, object> accessor)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>accessor</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></dt>
|
||||
<dd><p>The new function used to retrieve application settings.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
|
||||
<dd><p>Thrown when one or more required arguments are null.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_" data-uid="CapyKit.Helpers.SettingsHelper.SetDetectorMethod*"></a>
|
||||
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__" data-uid="CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})">
|
||||
SetDetectorMethod(Func<string, bool>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the function used to detect if an application setting with a given <code>key</code> exists.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static void SetDetectorMethod(Func<string, bool> detector)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>detector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></dt>
|
||||
<dd><p>The new function used to detect if an application setting exists.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
|
||||
<dd><p>Thrown when one or more required arguments are null.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_"> GetApplicationSetting<T>(string)</h3>
|
||||
<p>Retrieves a setting with the given <code>key</code>.</p>
|
||||
<pre><code class="lang-csharp">public static T GetApplicationSetting<T>(string settingName)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>settingName</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The name of the setting to retrieve.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p>T</p>
|
||||
<p>The value of the setting as an uncast <code class="typeparamref">T</code>.</p>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the setting to be retrieved.</p>
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__"> SetAccessorMethod(Func<string, object>)</h3>
|
||||
<p>Sets the function used to retrieve application settings.</p>
|
||||
<pre><code class="lang-csharp">public static void SetAccessorMethod(Func<string, object> accessor)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>accessor</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>></p>
|
||||
<p>The new function used to retrieve application settings.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>Thrown when one or more required arguments are null.</p>
|
||||
<h3 id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__"> SetDetectorMethod(Func<string, bool>)</h3>
|
||||
<p>Sets the function used to detect if an application setting with a given <code>key</code> exists.</p>
|
||||
<pre><code class="lang-csharp">public static void SetDetectorMethod(Func<string, bool> detector)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>detector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><<a href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>></p>
|
||||
<p>The new function used to detect if an application setting exists.</p>
|
||||
<h4 id="exceptions-1">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>Thrown when one or more required arguments are null.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Enum ValidCharacterCollection | CapyKit Documentation </title>
|
||||
<title> Enum ValidCharacterCollection | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Enum ValidCharacterCollection | CapyKit Documentation ">
|
||||
<meta name="title" content=" Enum ValidCharacterCollection | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="An enumeration that defines the types of characters that can be included in a random string.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,96 +70,39 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers.ValidCharacterCollection">
|
||||
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Helpers_ValidCharacterCollection" data-uid="CapyKit.Helpers.ValidCharacterCollection" class="text-break">
|
||||
Enum ValidCharacterCollection
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>An enumeration that defines the types of characters that can be included in a random string.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public enum ValidCharacterCollection</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<T>(T, string)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<T>(T, string, bool)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<h2 id="fields">Fields
|
||||
</h2>
|
||||
<dl class="parameters">
|
||||
<dt id="CapyKit_Helpers_ValidCharacterCollection_Lowercase"><code>[EnumerationDescription("abcdefghijklmnopqrstuvwxyz")]
|
||||
Lowercase = 0</code></dt>
|
||||
|
||||
<dd><p>Indicates that lower case characters should be included in the random string.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_Helpers_ValidCharacterCollection_Numbers"><code>[EnumerationDescription("0123456789")]
|
||||
Numbers = 2</code></dt>
|
||||
|
||||
<dd><p>Indicates that numeric characters should be included in the random string.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_Helpers_ValidCharacterCollection_Special"><code>[EnumerationDescription("!@#$%&?+-_")]
|
||||
Special = 3</code></dt>
|
||||
|
||||
<dd><p>Indicates that special characters should be included in the random string.</p>
|
||||
</dd>
|
||||
<dt id="CapyKit_Helpers_ValidCharacterCollection_Uppercase"><code>[EnumerationDescription("ABCDEFGHIJKLMNOPQRSTUVWXYZ")]
|
||||
Uppercase = 1</code></dt>
|
||||
|
||||
<dd><p>Indicates that upper case characters should be included in the random string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers_ValidCharacterCollection"> Enum ValidCharacterCollection</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>An enumeration that defines the types of characters that can be included in a random string.</p>
|
||||
<pre><code class="lang-csharp">public enum ValidCharacterCollection
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_">EnumerationExtensions.GetDescription(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_">EnumerationExtensions.GetName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_">EnumerationExtensions.GetPrettyName(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_">EnumerationExtensions.GetValue(Enum)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_">EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string)</a>,
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_">EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string, bool)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<ValidCharacterCollection>(ValidCharacterCollection, ValidCharacterCollection)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<p><code>Lowercase = 0</code></p>
|
||||
<p>Indicates that lower case characters should be included in the random string.</p>
|
||||
<p><code>Numbers = 2</code></p>
|
||||
<p>Indicates that numeric characters should be included in the random string.</p>
|
||||
<p><code>Special = 3</code></p>
|
||||
<p>Indicates that special characters should be included in the random string.</p>
|
||||
<p><code>Uppercase = 1</code></p>
|
||||
<p>Indicates that upper case characters should be included in the random string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace CapyKit.Helpers | CapyKit Documentation </title>
|
||||
<title> Namespace CapyKit.Helpers | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace CapyKit.Helpers | CapyKit Documentation ">
|
||||
<meta name="title" content=" Namespace CapyKit.Helpers | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,76 +70,36 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Helpers">
|
||||
|
||||
<h1 id="CapyKit_Helpers" data-uid="CapyKit.Helpers" class="text-break">Namespace CapyKit.Helpers</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></dt>
|
||||
<dd><p>Static class providing helper methods for various calculations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.CompressionHelper.html">CompressionHelper</a></dt>
|
||||
<dd><p>A class that contains methods for managing data compression.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.EncryptionHelper.html">EncryptionHelper</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></dt>
|
||||
<dd><p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.LanguageHelper.html">LanguageHelper</a></dt>
|
||||
<dd><p>Helper class for handling text transformations.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a></dt>
|
||||
<dd><p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.SerializationHelper.html">SerializationHelper</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.SettingsHelper.html">SettingsHelper</a></dt>
|
||||
<dd><p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="interfaces">
|
||||
Interfaces
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.IEncryptionAlgorithm.html">IEncryptionAlgorithm</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a></dt>
|
||||
<dd><p>An enumeration that defines the types of characters that can be included in a random string.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Helpers"> Namespace CapyKit.Helpers</h1>
|
||||
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></p>
|
||||
<p>Static class providing helper methods for various calculations.</p>
|
||||
<p><a href="CapyKit.Helpers.CompressionHelper.html">CompressionHelper</a></p>
|
||||
<p>A class that contains methods for managing data compression.</p>
|
||||
<p><a href="CapyKit.Helpers.EncryptionHelper.html">EncryptionHelper</a></p>
|
||||
<p><a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
||||
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||
<p><a href="CapyKit.Helpers.LanguageHelper.html">LanguageHelper</a></p>
|
||||
<p>Helper class for handling text transformations.</p>
|
||||
<p><a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a></p>
|
||||
<p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||
<p><a href="CapyKit.Helpers.SerializationHelper.html">SerializationHelper</a></p>
|
||||
<p><a href="CapyKit.Helpers.SettingsHelper.html">SettingsHelper</a></p>
|
||||
<p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||
<h3 id="interfaces">Interfaces</h3>
|
||||
<p><a href="CapyKit.Helpers.IEncryptionAlgorithm.html">IEncryptionAlgorithm</a></p>
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a></p>
|
||||
<p>An enumeration that defines the types of characters that can be included in a random string.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Interface IPasswordAlgorithm | CapyKit Documentation </title>
|
||||
<title> Interface IPasswordAlgorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Interface IPasswordAlgorithm | CapyKit Documentation ">
|
||||
<meta name="title" content=" Interface IPasswordAlgorithm | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Defines the contract for password encryption algorithms.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,183 +70,59 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.IPasswordAlgorithm">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_IPasswordAlgorithm"> Interface IPasswordAlgorithm</h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_IPasswordAlgorithm" data-uid="CapyKit.IPasswordAlgorithm" class="text-break">
|
||||
Interface IPasswordAlgorithm
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Defines the contract for password encryption algorithms.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public interface IPasswordAlgorithm</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_IPasswordAlgorithm_AlgorithmName_" data-uid="CapyKit.IPasswordAlgorithm.AlgorithmName*"></a>
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_AlgorithmName" data-uid="CapyKit.IPasswordAlgorithm.AlgorithmName">
|
||||
AlgorithmName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">string AlgorithmName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_IPasswordAlgorithm_Compare_" data-uid="CapyKit.IPasswordAlgorithm.Compare*"></a>
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___" data-uid="CapyKit.IPasswordAlgorithm.Compare(System.String,System.Byte[],System.Object[])">
|
||||
Compare(string, byte[], params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">bool Compare(string password, byte[] encryptedValue, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password to compare.</p>
|
||||
</dd>
|
||||
<dt><code>encryptedValue</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The encrypted value to compare against.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Defines the contract for password encryption algorithms.</p>
|
||||
<pre><code class="lang-csharp">public interface IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<p>Gets the name of the algorithm.</p>
|
||||
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___"> Compare(string, byte[], params object[])</h3>
|
||||
<p>Compares the given plaintext password with an encrypted value using PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">bool Compare(string password, byte[] encryptedValue, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password to compare.</p>
|
||||
<p><code>encryptedValue</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The encrypted value to compare against.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p>True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
|
||||
false if they are different.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_IPasswordAlgorithm_Encrypt_" data-uid="CapyKit.IPasswordAlgorithm.Encrypt*"></a>
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___" data-uid="CapyKit.IPasswordAlgorithm.Encrypt(System.String,System.Object[])">
|
||||
Encrypt(string, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Encrypts the given password using a defined algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">byte[] Encrypt(string password, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||
<p>Encrypts the given password using a defined algorithm.</p>
|
||||
<pre><code class="lang-csharp">byte[] Encrypt(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
File diff suppressed because it is too large
Load diff
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Password | CapyKit Documentation </title>
|
||||
<title> Class Password | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Password | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class Password | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Represents a password with its hash, salt and algorithm used for encryption.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,416 +70,109 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Password">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Password" data-uid="CapyKit.Password" class="text-break">
|
||||
Class Password
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Password</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">Password</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Password__ctor_" data-uid="CapyKit.Password.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___" data-uid="CapyKit.Password.#ctor(System.String,System.Byte[],CapyKit.IPasswordAlgorithm,System.Object[])">
|
||||
Password(string, byte[], IPasswordAlgorithm, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Constructor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The password to be hashed.</p>
|
||||
</dd>
|
||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>The salt used for encryption.</p>
|
||||
</dd>
|
||||
<dt><code>algorithm</code> <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
|
||||
<dd><p>The algorithm used for password encryption.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Password_Algorithm_" data-uid="CapyKit.Password.Algorithm*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_Algorithm" data-uid="CapyKit.Password.Algorithm">
|
||||
Algorithm
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the algorithm used for password encryption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public IPasswordAlgorithm Algorithm { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Password_Hash_" data-uid="CapyKit.Password.Hash*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_Hash" data-uid="CapyKit.Password.Hash">
|
||||
Hash
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the hash of the password.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public byte[] Hash { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Password_Pbkdf2Algorithm_" data-uid="CapyKit.Password.Pbkdf2Algorithm*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_Pbkdf2Algorithm" data-uid="CapyKit.Password.Pbkdf2Algorithm">
|
||||
Pbkdf2Algorithm
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the preconfigured PBKDF2 algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></dt>
|
||||
<dd><p>The preconfigured PBKDF2 algorithm.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Password_Salt_" data-uid="CapyKit.Password.Salt*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_Salt" data-uid="CapyKit.Password.Salt">
|
||||
Salt
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets or sets the salt used for encryption.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public byte[] Salt { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Password_Equals_" data-uid="CapyKit.Password.Equals*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_Equals_System_Object_" data-uid="CapyKit.Password.Equals(System.Object)">
|
||||
Equals(object?)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Determines whether the specified object is equal to the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override bool Equals(object? obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
||||
<dd><p>The object to compare with the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><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>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Password_ToString_" data-uid="CapyKit.Password.ToString*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_ToString" data-uid="CapyKit.Password.ToString">
|
||||
ToString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a string that represents the current object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string that represents the current object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="operators">Operators
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Password_op_Equality_" data-uid="CapyKit.Password.op_Equality*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_" data-uid="CapyKit.Password.op_Equality(CapyKit.Password,CapyKit.Password)">
|
||||
operator ==(Password, Password)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator ==(Password a, Password b)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>a</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>b</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Password_op_Inequality_" data-uid="CapyKit.Password.op_Inequality*"></a>
|
||||
|
||||
<h3 id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_" data-uid="CapyKit.Password.op_Inequality(CapyKit.Password,CapyKit.Password)">
|
||||
operator !=(Password, Password)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"></div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public static bool operator !=(Password a, Password b)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>a</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd></dd>
|
||||
<dt><code>b</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Password"> Class Password</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
<pre><code class="lang-csharp">public class Password
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Password.html">Password</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Password>(Password, Password)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Password__ctor_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"> Password(string, byte[], IPasswordAlgorithm, params object[])</h3>
|
||||
<p>Constructor.</p>
|
||||
<pre><code class="lang-csharp">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The password to be hashed.</p>
|
||||
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>The salt used for encryption.</p>
|
||||
<p><code>algorithm</code> <a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>The algorithm used for password encryption.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Password_Algorithm"> Algorithm</h3>
|
||||
<p>Gets or sets the algorithm used for password encryption.</p>
|
||||
<pre><code class="lang-csharp">public IPasswordAlgorithm Algorithm { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<h3 id="CapyKit_Password_Hash"> Hash</h3>
|
||||
<p>Gets or sets the hash of the password.</p>
|
||||
<pre><code class="lang-csharp">public byte[] Hash { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<h3 id="CapyKit_Password_Pbkdf2Algorithm"> Pbkdf2Algorithm</h3>
|
||||
<p>Gets the preconfigured PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<h3 id="CapyKit_Password_Salt"> Salt</h3>
|
||||
<p>Gets or sets the salt used for encryption.</p>
|
||||
<pre><code class="lang-csharp">public byte[] Salt { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-3">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Password_Equals_System_Object_"> Equals(object?)</h3>
|
||||
<p>Determines whether the specified object is equal to the current object.</p>
|
||||
<pre><code class="lang-csharp">public override bool Equals(object? obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>?</p>
|
||||
<p>The object to compare with the current object.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><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>.</p>
|
||||
<h3 id="CapyKit_Password_ToString"> ToString()</h3>
|
||||
<p>Returns a string that represents the current object.</p>
|
||||
<pre><code class="lang-csharp">public override string ToString()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string that represents the current object.</p>
|
||||
<h2 id="operators">Operators</h2>
|
||||
<h3 id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_"> operator ==(Password, Password)</h3>
|
||||
<pre><code class="lang-csharp">public static bool operator ==(Password a, Password b)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<h4 id="returns-2">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<h3 id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_"> operator !=(Password, Password)</h3>
|
||||
<pre><code class="lang-csharp">public static bool operator !=(Password a, Password b)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||
<h4 id="returns-3">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Pbkdf2Algorithm | CapyKit Documentation </title>
|
||||
<title> Class Pbkdf2Algorithm | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Pbkdf2Algorithm | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class Pbkdf2Algorithm | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="Implements the PBKDF2 algorithm for password encryption.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,279 +70,80 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Pbkdf2Algorithm">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Pbkdf2Algorithm" data-uid="CapyKit.Pbkdf2Algorithm" class="text-break">
|
||||
Class Pbkdf2Algorithm
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Pbkdf2Algorithm : IPasswordAlgorithm</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">Pbkdf2Algorithm</span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pbkdf2Algorithm__ctor_" data-uid="CapyKit.Pbkdf2Algorithm.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm__ctor" data-uid="CapyKit.Pbkdf2Algorithm.#ctor">
|
||||
Pbkdf2Algorithm()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Default constructor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pbkdf2Algorithm()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="fields">Fields
|
||||
</h2>
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_ITERATIONS" data-uid="CapyKit.Pbkdf2Algorithm.ITERATIONS">
|
||||
ITERATIONS
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>The default number of iterations.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int ITERATIONS = 100000</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Pbkdf2Algorithm_ITERATIONS_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This member is immutable.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_LENGTH" data-uid="CapyKit.Pbkdf2Algorithm.LENGTH">
|
||||
LENGTH
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>(Immutable) The default length.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public const int LENGTH = 32</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Field Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Pbkdf2Algorithm_LENGTH_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This member is immutable.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pbkdf2Algorithm_AlgorithmName_" data-uid="CapyKit.Pbkdf2Algorithm.AlgorithmName*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_AlgorithmName" data-uid="CapyKit.Pbkdf2Algorithm.AlgorithmName">
|
||||
AlgorithmName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string AlgorithmName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pbkdf2Algorithm_Encrypt_" data-uid="CapyKit.Pbkdf2Algorithm.Encrypt*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_Encrypt_System_String_System_Object___" data-uid="CapyKit.Pbkdf2Algorithm.Encrypt(System.String,System.Object[])">
|
||||
Encrypt(string, params object[])
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Encrypts the given password using a PBKDF2 algorithm.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public byte[] Encrypt(string password, params object[] args)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The plaintext password.</p>
|
||||
</dd>
|
||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
||||
<dd><p>Additional arguments for the encryption process, specifically</p>
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Pbkdf2Algorithm"> Class Pbkdf2Algorithm</h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
<pre><code class="lang-csharp">public class Pbkdf2Algorithm : IPasswordAlgorithm
|
||||
</code></pre>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<h4 id="implements">Implements</h4>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Pbkdf2Algorithm>(Pbkdf2Algorithm, Pbkdf2Algorithm)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm__ctor"> Pbkdf2Algorithm()</h3>
|
||||
<p>Default constructor.</p>
|
||||
<pre><code class="lang-csharp">public Pbkdf2Algorithm()
|
||||
</code></pre>
|
||||
<h2 id="fields">Fields</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_ITERATIONS"> ITERATIONS</h3>
|
||||
<p>The default number of iterations.</p>
|
||||
<pre><code class="lang-csharp">public const int ITERATIONS = 100000
|
||||
</code></pre>
|
||||
<h4 id="field-value">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This member is immutable.</p>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_LENGTH"> LENGTH</h3>
|
||||
<p>(Immutable) The default length.</p>
|
||||
<pre><code class="lang-csharp">public const int LENGTH = 32
|
||||
</code></pre>
|
||||
<h4 id="field-value-1">Field Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>This member is immutable.</p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_AlgorithmName"> AlgorithmName</h3>
|
||||
<p>Gets the name of the algorithm.</p>
|
||||
<pre><code class="lang-csharp">public string AlgorithmName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Pbkdf2Algorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||
<p>Encrypts the given password using a PBKDF2 algorithm.</p>
|
||||
<pre><code class="lang-csharp">public byte[] Encrypt(string password, params object[] args)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>The plaintext password.</p>
|
||||
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||
<p>Additional arguments for the encryption process, specifically</p>
|
||||
<ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
||||
<dd><p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||
<p>A byte array with the hashed <code class="paramref">password</code>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class Pool<T> | CapyKit Documentation </title>
|
||||
<title> Class Pool<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class Pool<T> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class Pool<T> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A managed pool of resources. This class provides a thread-safe way to manage a collection of objects of type T.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,276 +70,83 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.Pool`1">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_Pool_1"> Class Pool<T></h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_Pool_1" data-uid="CapyKit.Pool`1" class="text-break">
|
||||
Class Pool<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>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>.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class Pool<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of objects to be managed by the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">Pool<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1__ctor_" data-uid="CapyKit.Pool`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__" data-uid="CapyKit.Pool`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
|
||||
Pool(IEnumerable<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Pool-1.html">Pool<T></a> class with the specified collection
|
||||
of items.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pool(IEnumerable<T> collection)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>collection</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
||||
<dd><p>The collection of <code class="typeparamref">T</code> items with which to seed the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1__ctor_" data-uid="CapyKit.Pool`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_" data-uid="CapyKit.Pool`1.#ctor(System.Int32)">
|
||||
Pool(int)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Pool-1.html">Pool<T></a> class with the specified pool size.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pool(int poolSize)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>poolSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The size of the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1__ctor_" data-uid="CapyKit.Pool`1.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__" data-uid="CapyKit.Pool`1.#ctor(System.Int32,System.Func{`0})">
|
||||
Pool(int, Func<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="CapyKit.Pool-1.html">Pool<T></a> class with the specified pool size
|
||||
<pre><code class="lang-csharp">public class Pool<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of objects to be managed by the pool.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Pool<T>>(Pool<T>, Pool<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_"> Pool(int)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size.</p>
|
||||
<pre><code class="lang-csharp">public Pool(int poolSize)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The size of the pool.</p>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__"> Pool(int, Func<T>)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size
|
||||
and constructor selector.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public Pool(int poolSize, Func<T> constructorSelector)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>poolSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The size of the pool.</p>
|
||||
</dd>
|
||||
<dt><code>constructorSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></dt>
|
||||
<dd><p>The constructor selector used to create new instances of <code class="typeparamref">T</code>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1_GetAvailableItem_" data-uid="CapyKit.Pool`1.GetAvailableItem*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1_GetAvailableItem" data-uid="CapyKit.Pool`1.GetAvailableItem">
|
||||
GetAvailableItem()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the first available item from the pool and sets its lock.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PoolItem<T> GetAvailableItem()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="CapyKit.PoolItem-1.html">PoolItem</a><T></dt>
|
||||
<dd><p>The first available item from the pool.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_Pool_1_ReleaseItem_" data-uid="CapyKit.Pool`1.ReleaseItem*"></a>
|
||||
|
||||
<h3 id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0__" data-uid="CapyKit.Pool`1.ReleaseItem(CapyKit.PoolItem{`0})">
|
||||
ReleaseItem(PoolItem<T>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Releases the lock on the specified item and returns it to the pool.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void ReleaseItem(PoolItem<T> item)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>item</code> <a class="xref" href="CapyKit.PoolItem-1.html">PoolItem</a><T></dt>
|
||||
<dd><p>The item to release.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0___remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>This method sets the <a class="xref" href="CapyKit.PoolItem-1.html#CapyKit_PoolItem_1_Locked">Locked</a> flag to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> so that
|
||||
it can be retrieved by <a class="xref" href="CapyKit.Pool-1.html#CapyKit_Pool_1_GetAvailableItem">GetAvailableItem()</a>.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<pre><code class="lang-csharp">public Pool(int poolSize, Func<T> constructorSelector)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>The size of the pool.</p>
|
||||
<p><code>constructorSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></p>
|
||||
<p>The constructor selector used to create new instances of <code class="typeparamref">T</code>.</p>
|
||||
<h3 id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__"> Pool(IEnumerable<T>)</h3>
|
||||
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified collection
|
||||
of items.</p>
|
||||
<pre><code class="lang-csharp">public Pool(IEnumerable<T> collection)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>collection</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||
<p>The collection of <code class="typeparamref">T</code> items with which to seed the pool.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_Pool_1_GetAvailableItem"> GetAvailableItem()</h3>
|
||||
<p>Gets the first available item from the pool and sets its lock.</p>
|
||||
<pre><code class="lang-csharp">public PoolItem<T> GetAvailableItem()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||
<p>The first available item from the pool.</p>
|
||||
<h3 id="CapyKit_Pool_1_ReleaseItem_CapyKit_PoolItem__0__"> ReleaseItem(PoolItem<T>)</h3>
|
||||
<p>Releases the lock on the specified item and returns it to the pool.</p>
|
||||
<pre><code class="lang-csharp">public void ReleaseItem(PoolItem<T> item)
|
||||
</code></pre>
|
||||
<h4 id="parameters-3">Parameters</h4>
|
||||
<p><code>item</code> <a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||
<p>The item to release.</p>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>This method sets the <span class="xref">CapyKit.PoolItem`1.Locked</span> flag to <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> so that
|
||||
it can be retrieved by <span class="xref">CapyKit.Pool`1.GetAvailableItem</span>.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class PoolItem<T> | CapyKit Documentation </title>
|
||||
<title> Class PoolItem<T> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class PoolItem<T> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class PoolItem<T> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A pool item. This class cannot be inherited.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,327 +70,86 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.PoolItem`1">
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_PoolItem_1" data-uid="CapyKit.PoolItem`1" class="text-break">
|
||||
Class PoolItem<T>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A pool item. This class cannot be inherited.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public sealed class PoolItem<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>The type of the pooled item.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">PoolItem<T></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="properties">Properties
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_Index_" data-uid="CapyKit.PoolItem`1.Index*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_Index" data-uid="CapyKit.PoolItem`1.Index">
|
||||
Index
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the zero-based index of the pooled item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int Index { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>The index.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_Item_" data-uid="CapyKit.PoolItem`1.Item*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_Item" data-uid="CapyKit.PoolItem`1.Item">
|
||||
Item
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the pooled resource.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public T Item { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><span class="xref">T</span></dt>
|
||||
<dd><p>The pooled resource.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_Locked_" data-uid="CapyKit.PoolItem`1.Locked*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_Locked" data-uid="CapyKit.PoolItem`1.Locked">
|
||||
Locked
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets a value indicating whether this object is locked or not.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Locked { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p>A value indicating whether this object is locked or not.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_TypeName_" data-uid="CapyKit.PoolItem`1.TypeName*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_TypeName" data-uid="CapyKit.PoolItem`1.TypeName">
|
||||
TypeName
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Gets the name of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a> of the pooled item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public string TypeName { get; }</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Property Value</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>The name of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a> of the pooled item.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_ReleaseLock_" data-uid="CapyKit.PoolItem`1.ReleaseLock*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_ReleaseLock" data-uid="CapyKit.PoolItem`1.ReleaseLock">
|
||||
ReleaseLock()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Releases the lock on the item.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void ReleaseLock()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_PoolItem_1_ReleaseLock_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If the item is not locked, an error event is emitted.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_SetLock_" data-uid="CapyKit.PoolItem`1.SetLock*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_SetLock" data-uid="CapyKit.PoolItem`1.SetLock">
|
||||
SetLock()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Sets the lock on the item indicating that it is in use.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool SetLock()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><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
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_PoolItem_1"> Class PoolItem<T></h1>
|
||||
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A pool item. This class cannot be inherited.</p>
|
||||
<pre><code class="lang-csharp">public sealed class PoolItem<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>The type of the pooled item.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<PoolItem<T>>(PoolItem<T>, PoolItem<T>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="properties">Properties</h2>
|
||||
<h3 id="CapyKit_PoolItem_1_Index"> Index</h3>
|
||||
<p>Gets the zero-based index of the pooled item.</p>
|
||||
<pre><code class="lang-csharp">public int Index { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<h3 id="CapyKit_PoolItem_1_Item"> Item</h3>
|
||||
<p>Gets the pooled resource.</p>
|
||||
<pre><code class="lang-csharp">public T Item { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-1">Property Value</h4>
|
||||
<p>T</p>
|
||||
<h3 id="CapyKit_PoolItem_1_Locked"> Locked</h3>
|
||||
<p>Gets a value indicating whether this object is locked or not.</p>
|
||||
<pre><code class="lang-csharp">public bool Locked { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-2">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<h3 id="CapyKit_PoolItem_1_TypeName"> TypeName</h3>
|
||||
<p>Gets the name of the <span class="xref">System.Type</span> of the pooled item.</p>
|
||||
<pre><code class="lang-csharp">public string TypeName { get; }
|
||||
</code></pre>
|
||||
<h4 id="property-value-3">Property Value</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_PoolItem_1_ReleaseLock"> ReleaseLock()</h3>
|
||||
<p>Releases the lock on the item.</p>
|
||||
<pre><code class="lang-csharp">public void ReleaseLock()
|
||||
</code></pre>
|
||||
<h4 id="remarks">Remarks</h4>
|
||||
<p>If the item is not locked, an error event is emitted.</p>
|
||||
<h3 id="CapyKit_PoolItem_1_SetLock"> SetLock()</h3>
|
||||
<p>Sets the lock on the item indicating that it is in use.</p>
|
||||
<pre><code class="lang-csharp">public bool SetLock()
|
||||
</code></pre>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><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.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section" id="CapyKit_PoolItem_1_SetLock_remarks">Remarks</h4>
|
||||
<div class="markdown level1 remarks"><p>If the item is already locked, an error event is emitted.</p>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PoolItem_1_ToString_" data-uid="CapyKit.PoolItem`1.ToString*"></a>
|
||||
|
||||
<h3 id="CapyKit_PoolItem_1_ToString" data-uid="CapyKit.PoolItem`1.ToString">
|
||||
ToString()
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a string that represents the current object and its lock state.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
||||
<dd><p>A string that represents the current object and its lock state.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 id="remarks-1">Remarks</h4>
|
||||
<p>If the item is already locked, an error event is emitted.</p>
|
||||
<h3 id="CapyKit_PoolItem_1_ToString"> ToString()</h3>
|
||||
<p>Returns a string that represents the current object and its lock state.</p>
|
||||
<pre><code class="lang-csharp">public override string ToString()
|
||||
</code></pre>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||
<p>A string that represents the current object and its lock state.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,11 +2,11 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Class PropertyComparer<T, U> | CapyKit Documentation </title>
|
||||
<title> Class PropertyComparer<T, U> | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Class PropertyComparer<T, U> | CapyKit Documentation ">
|
||||
<meta name="title" content=" Class PropertyComparer<T, U> | CapyKit Documentation ">
|
||||
|
||||
|
||||
<meta name="description" content="A object comparer that can accept a lambda expression to compare properties.">
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||
<link rel="stylesheet" href="../public/main.css">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,95 +70,37 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit.PropertyComparer`2">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit_PropertyComparer_2"> Class PropertyComparer<T, U></h1>
|
||||
|
||||
|
||||
|
||||
<h1 id="CapyKit_PropertyComparer_2" data-uid="CapyKit.PropertyComparer`2" class="text-break">
|
||||
Class PropertyComparer<T, U>
|
||||
</h1>
|
||||
|
||||
<div class="facts text-secondary">
|
||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
||||
</div>
|
||||
|
||||
<div class="markdown summary"><p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
</div>
|
||||
<div class="markdown conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public class PropertyComparer<T, U> : IEqualityComparer<T></code></pre>
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Type Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>T</code></dt>
|
||||
<dd><p>Generic type parameter of the parent object.</p>
|
||||
</dd>
|
||||
<dt><code>U</code></dt>
|
||||
<dd><p>Generic type parameter of the property value.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist inheritance">
|
||||
<dt>Inheritance</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
||||
<div><span class="xref">PropertyComparer<T, U></span></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<dl class="typelist implements">
|
||||
<dt>Implements</dt>
|
||||
<dd>
|
||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer-1">IEqualityComparer</a><T></div>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<dl class="typelist inheritedMembers">
|
||||
<dt>Inherited Members</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="typelist extensionMethods">
|
||||
<dt>Extension Methods</dt>
|
||||
<dd>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
||||
</div>
|
||||
<div>
|
||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
||||
</div>
|
||||
</dd></dl>
|
||||
|
||||
|
||||
<h2 id="CapyKit_PropertyComparer_2_examples">Examples</h2>
|
||||
<p>using System;
|
||||
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||
Assembly: CapyKit.dll</p>
|
||||
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
<pre><code class="lang-csharp">public class PropertyComparer<T, U> : IEqualityComparer<T>
|
||||
</code></pre>
|
||||
<h4 id="type-parameters">Type Parameters</h4>
|
||||
<p><code>T</code></p>
|
||||
<p>Generic type parameter of the parent object.</p>
|
||||
<p><code>U</code></p>
|
||||
<p>Generic type parameter of the property value.</p>
|
||||
<h4 id="inheritance">Inheritance</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||
<a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||
<h4 id="implements">Implements</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer-1">IEqualityComparer<T></a></p>
|
||||
<h4 id="inherited-members">Inherited Members</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||
<h4 id="extension-methods">Extension Methods</h4>
|
||||
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<PropertyComparer<T, U>>(PropertyComparer<T, U>, PropertyComparer<T, U>)</a>,
|
||||
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||
<h2 id="examples">Examples</h2>
|
||||
<p>using System;
|
||||
using System.Collections.Generic;
|
||||
using System.Linq;</p>
|
||||
<p>class Program
|
||||
|
|
@ -185,147 +127,50 @@ Person { Name = "Charlie", Age = 35 }
|
|||
public string Name { get; set; }
|
||||
public int Age { get; set; }
|
||||
}</p>
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="constructors">Constructors
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PropertyComparer_2__ctor_" data-uid="CapyKit.PropertyComparer`2.#ctor*"></a>
|
||||
|
||||
<h3 id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__" data-uid="CapyKit.PropertyComparer`2.#ctor(System.Func{`0,`1})">
|
||||
PropertyComparer(Func<T, U>)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Constructor.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public PropertyComparer(Func<T, U> expression)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>expression</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></dt>
|
||||
<dd><p>The expression.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h2 class="section" id="methods">Methods
|
||||
</h2>
|
||||
|
||||
|
||||
<a id="CapyKit_PropertyComparer_2_Equals_" data-uid="CapyKit.PropertyComparer`2.Equals*"></a>
|
||||
|
||||
<h3 id="CapyKit_PropertyComparer_2_Equals__0__0_" data-uid="CapyKit.PropertyComparer`2.Equals(`0,`0)">
|
||||
Equals(T, T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Determines whether the specified properties are equal.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public bool Equals(T x, T y)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>x</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The first object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
</dd>
|
||||
<dt><code>y</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The second object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
||||
<dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified objects are equal; otherwise,
|
||||
<h2 id="constructors">Constructors</h2>
|
||||
<h3 id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__"> PropertyComparer(Func<T, U>)</h3>
|
||||
<p>Constructor.</p>
|
||||
<pre><code class="lang-csharp">public PropertyComparer(Func<T, U> expression)
|
||||
</code></pre>
|
||||
<h4 id="parameters">Parameters</h4>
|
||||
<p><code>expression</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||
<p>The expression.</p>
|
||||
<h2 id="methods">Methods</h2>
|
||||
<h3 id="CapyKit_PropertyComparer_2_Equals__0__0_"> Equals(T, T)</h3>
|
||||
<p>Determines whether the specified properties are equal.</p>
|
||||
<pre><code class="lang-csharp">public bool Equals(T x, T y)
|
||||
</code></pre>
|
||||
<h4 id="parameters-1">Parameters</h4>
|
||||
<p><code>x</code> T</p>
|
||||
<p>The first object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
<p><code>y</code> T</p>
|
||||
<p>The second object of type <code class="typeparamref">T</code> to compare.</p>
|
||||
<h4 id="returns">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||
<p><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>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<a id="CapyKit_PropertyComparer_2_GetHashCode_" data-uid="CapyKit.PropertyComparer`2.GetHashCode*"></a>
|
||||
|
||||
<h3 id="CapyKit_PropertyComparer_2_GetHashCode__0_" data-uid="CapyKit.PropertyComparer`2.GetHashCode(`0)">
|
||||
GetHashCode(T)
|
||||
|
||||
</h3>
|
||||
|
||||
<div class="markdown level1 summary"><p>Returns a hash code for the specified object.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public int GetHashCode(T obj)</code></pre>
|
||||
</div>
|
||||
|
||||
<h4 class="section">Parameters</h4>
|
||||
<dl class="parameters">
|
||||
<dt><code>obj</code> <span class="xref">T</span></dt>
|
||||
<dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a> for which a hash code is to be returned.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h4 class="section">Returns</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
||||
<dd><p>A hash code for the specified object.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h4 class="section">Exceptions</h4>
|
||||
<dl class="parameters">
|
||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></dt>
|
||||
<dd><p>The type of <code class="paramref">obj</code> is a reference type and
|
||||
<h3 id="CapyKit_PropertyComparer_2_GetHashCode__0_"> GetHashCode(T)</h3>
|
||||
<p>Returns a hash code for the specified object.</p>
|
||||
<pre><code class="lang-csharp">public int GetHashCode(T obj)
|
||||
</code></pre>
|
||||
<h4 id="parameters-2">Parameters</h4>
|
||||
<p><code>obj</code> T</p>
|
||||
<p>The <span class="xref">System.Object</span> for which a hash code is to be returned.</p>
|
||||
<h4 id="returns-1">Returns</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||
<p>A hash code for the specified object.</p>
|
||||
<h4 id="exceptions">Exceptions</h4>
|
||||
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||
<p>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>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -2,9 +2,9 @@
|
|||
<html>
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<title>Namespace CapyKit | CapyKit Documentation </title>
|
||||
<title> Namespace CapyKit | CapyKit Documentation </title>
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<meta name="title" content="Namespace CapyKit | CapyKit Documentation ">
|
||||
<meta name="title" content=" Namespace CapyKit | CapyKit Documentation ">
|
||||
|
||||
|
||||
<link rel="icon" href="../favicon.ico">
|
||||
|
|
@ -39,7 +39,7 @@
|
|||
|
||||
</head>
|
||||
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
|
||||
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="">
|
||||
<header class="bg-body border-bottom">
|
||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||
<div class="container-xxl flex-nowrap">
|
||||
|
|
@ -70,99 +70,53 @@
|
|||
<nav id="breadcrumb"></nav>
|
||||
</div>
|
||||
|
||||
<article data-uid="CapyKit">
|
||||
<article data-uid="">
|
||||
<h1 id="CapyKit"> Namespace CapyKit</h1>
|
||||
|
||||
<h1 id="CapyKit" data-uid="CapyKit" class="text-break">Namespace CapyKit</h1>
|
||||
<div class="markdown level0 summary"></div>
|
||||
<div class="markdown level0 conceptual"></div>
|
||||
<div class="markdown level0 remarks"></div>
|
||||
|
||||
<h3 id="classes">
|
||||
Classes
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></dt>
|
||||
<dd><p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
<h3 id="namespaces">Namespaces</h3>
|
||||
<p><a href="CapyKit.Attributes.html">CapyKit.Attributes</a></p>
|
||||
<p><a href="CapyKit.Enumerations.html">CapyKit.Enumerations</a></p>
|
||||
<p><a href="CapyKit.Extensions.html">CapyKit.Extensions</a></p>
|
||||
<p><a href="CapyKit.Helpers.html">CapyKit.Helpers</a></p>
|
||||
<h3 id="classes">Classes</h3>
|
||||
<p><a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||
method name information.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></dt>
|
||||
<dd><p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Color.html">Color</a></dt>
|
||||
<dd><p>An object representing a color.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></dt>
|
||||
<dd></dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
||||
<dd><p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></dt>
|
||||
<dd><p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.PoolItem-1.html">PoolItem<T></a></dt>
|
||||
<dd><p>A pool item. This class cannot be inherited.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.Pool-1.html">Pool<T></a></dt>
|
||||
<dd><p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||
<p><a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||
<p><a href="CapyKit.Color.html">Color</a></p>
|
||||
<p>An object representing a color.</p>
|
||||
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></p>
|
||||
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||
<p><a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||
<p>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>.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></dt>
|
||||
<dd><p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="interfaces">
|
||||
Interfaces
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
|
||||
<dd><p>Defines the contract for password encryption algorithms.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="enums">
|
||||
Enums
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.EventLevel.html">EventLevel</a></dt>
|
||||
<dd><p>Enumeration representing different event level severity values.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.NamedColor.html">NamedColor</a></dt>
|
||||
<dd><p>Enum representing a set of named colors with their corresponding HEX values. These colors are
|
||||
<p><a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||
<p>A pool item. This class cannot be inherited.</p>
|
||||
<p><a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||
<h3 id="interfaces">Interfaces</h3>
|
||||
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||
<p>Defines the contract for password encryption algorithms.</p>
|
||||
<h3 id="enums">Enums</h3>
|
||||
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||
<p>Enumeration representing different event level severity values.</p>
|
||||
<p><a href="CapyKit.NamedColor.html">NamedColor</a></p>
|
||||
<p>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>).</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<h3 id="delegates">
|
||||
Delegates
|
||||
</h3>
|
||||
<dl class="jumplist">
|
||||
<dt><a class="xref" href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></dt>
|
||||
<dd><p>A delegate representing an event handler that accepts a <a class="xref" href="CapyKit.CapyEventArgs.html">CapyEventArgs</a> instance.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
<h3 id="delegates">Delegates</h3>
|
||||
<p><a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||
<p>A delegate representing an event handler that accepts a <span class="xref">CapyKit.CapyEventArgs</span> instance.</p>
|
||||
|
||||
</article>
|
||||
|
||||
<div class="contribution d-print-none">
|
||||
</div>
|
||||
|
||||
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||
|
||||
</div>
|
||||
|
||||
|
|
|
|||
|
|
@ -18,10 +18,10 @@
|
|||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
||||
<a href="CapyKit.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventHandler.html" name="" title="CapyEventHandler">CapyEventHandler</a>
|
||||
<a href="CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
||||
|
|
@ -32,30 +32,42 @@
|
|||
<li>
|
||||
<a href="CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.EventLevel.html" name="" title="EventLevel">EventLevel</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.IPasswordAlgorithm.html" name="" title="IPasswordAlgorithm">IPasswordAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.NamedColor.html" name="" title="NamedColor">NamedColor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Password.html" name="" title="Password">Password</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Interfaces">Interfaces</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.IPasswordAlgorithm.html" name="" title="IPasswordAlgorithm">IPasswordAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.EventLevel.html" name="" title="EventLevel">EventLevel</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.NamedColor.html" name="" title="NamedColor">NamedColor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.html" name="" title="Delegates">Delegates</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.CapyEventHandler.html" name="" title="CapyEventHandler">CapyEventHandler</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -63,6 +75,9 @@
|
|||
<a href="CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Attributes.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
||||
</li>
|
||||
|
|
@ -79,6 +94,9 @@
|
|||
<a href="CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Enumerations.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
||||
</li>
|
||||
|
|
@ -89,6 +107,9 @@
|
|||
<a href="CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
||||
</li>
|
||||
|
|
@ -108,6 +129,9 @@
|
|||
<a href="CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
||||
|
||||
<ul class="nav level2">
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
||||
</li>
|
||||
|
|
@ -117,9 +141,6 @@
|
|||
<li>
|
||||
<a href="CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
||||
</li>
|
||||
|
|
@ -135,6 +156,15 @@
|
|||
<li>
|
||||
<a href="CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.html" name="" title="Interfaces">Interfaces</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
||||
</li>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -79,7 +79,7 @@
|
|||
<ul>
|
||||
<li><a href="introduction.html">Introduction</a> explains what CapyKit includes and how the namespaces are organized.</li>
|
||||
<li><a href="getting-started.html">Getting Started</a> shows installation, imports, and common usage examples.</li>
|
||||
<li><a href="api/toc.html">API Reference</a> contains the generated DocFX reference for every public type and member.</li>
|
||||
<li><a href="api/CapyKit.html">API Reference</a> contains the generated DocFX reference for every public type and member.</li>
|
||||
</ul>
|
||||
<h2 id="common-tasks">Common Tasks</h2>
|
||||
<h3 id="work-with-strings-and-collections">Work with strings and collections</h3>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
|
|
@ -11,508 +11,364 @@
|
|||
}
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Attributes.EnumerationAttribute<T>",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Attributes.EnumerationAttribute-1.yml\" sourcestartlinenumber=\"1\">Custom attribute class for decorating enumeration fields with additional data.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Attributes.EnumerationDescriptionAttribute",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Attributes.EnumerationDescriptionAttribute.yml\" sourcestartlinenumber=\"1\">An attribute class for decorating enumeration fields with a description.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Attributes.ValueFormatAttribute",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Attributes.ValueFormatAttribute.yml\" sourcestartlinenumber=\"1\">Custom attribute for formatting values in a specific way.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Attributes.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Attributes.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Attributes.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Attributes",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.CapyEventArgs.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.CapyEventArgs.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.CapyEventArgs.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.CapyEventArgs",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.CapyEventArgs.yml\" sourcestartlinenumber=\"1\">The CapyEventArgs class represents an event argument instance with event level, message, and\nmethod name information.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.CapyEventHandler.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.CapyEventHandler.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.CapyEventHandler.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.CapyEventHandler",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.CapyEventHandler.yml\" sourcestartlinenumber=\"1\">A delegate representing an event handler that accepts a <xref href=\"CapyKit.CapyEventArgs\" data-throw-if-not-resolved=\"false\"></xref> instance.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.CapyEventReporter.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.CapyEventReporter.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.CapyEventReporter.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.CapyEventReporter",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.CapyEventReporter.yml\" sourcestartlinenumber=\"1\">The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Color.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Color.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Color.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Color",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Color.yml\" sourcestartlinenumber=\"1\">An object representing a color.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.EncryptedValue-1.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.EncryptedValue-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.EncryptedValue-1.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.EncryptedValue<T>",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Enumerations.MeasurementSystem.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Enumerations.MeasurementSystem.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Enumerations.MeasurementSystem.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Enumerations.MeasurementSystem",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Enumerations.MeasurementSystem.yml\" sourcestartlinenumber=\"1\">An enumeration representing different measurement systems.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Enumerations.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Enumerations.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Enumerations.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Enumerations",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.EventLevel.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.EventLevel.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.EventLevel.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.EventLevel",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.EventLevel.yml\" sourcestartlinenumber=\"1\">Enumeration representing different event level severity values.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Extensions.EnumerationExtensions.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.EnumerationExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.EnumerationExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Extensions.EnumerationExtensions",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.EnumerationExtensions.yml\" sourcestartlinenumber=\"1\">Provides static extentions methods for providing additional functionality for <xref href=\"System.Enum\" data-throw-if-not-resolved=\"false\"></xref> types.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Extensions.LINQExtensions.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.LINQExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.LINQExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Extensions.LINQExtensions",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.LINQExtensions.yml\" sourcestartlinenumber=\"1\">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.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Extensions.ObjectExtensions.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.ObjectExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.ObjectExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Extensions.ObjectExtensions",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.ObjectExtensions.yml\" sourcestartlinenumber=\"1\">An class containing extenstions that apply to any object type.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Extensions.StringExtensions.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.StringExtensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.StringExtensions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Extensions.StringExtensions",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Extensions.StringExtensions.yml\" sourcestartlinenumber=\"1\">Provides static extentions methods for providing additional functionality for <xref href=\"System.String\" data-throw-if-not-resolved=\"false\"></xref> types.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Extensions.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Extensions.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Extensions.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Extensions",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.CalculationHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.CalculationHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.CalculationHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.CalculationHelper",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.CalculationHelper.yml\" sourcestartlinenumber=\"1\">Static class providing helper methods for various calculations.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.CompressionHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.CompressionHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.CompressionHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.CompressionHelper",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.CompressionHelper.yml\" sourcestartlinenumber=\"1\">A class that contains methods for managing data compression.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.EncryptionHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.EncryptionHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.EncryptionHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.EncryptionHelper",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.IEncryptionAlgorithm",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.KeyHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.KeyHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.KeyHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.KeyHelper",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.KeyHelper.yml\" sourcestartlinenumber=\"1\">A class that contains methods for managing key creation and validation against a master key.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.LanguageHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.LanguageHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.LanguageHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.LanguageHelper",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.LanguageHelper.yml\" sourcestartlinenumber=\"1\">Helper class for handling text transformations.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SecurityHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SecurityHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.SecurityHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.SecurityHelper",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.SecurityHelper.yml\" sourcestartlinenumber=\"1\">A class that contains methods for managing secure data processing and cryptography.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SerializationHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SerializationHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.SerializationHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.SerializationHelper",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SettingsHelper.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.SettingsHelper.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.SettingsHelper.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.SettingsHelper",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.SettingsHelper.yml\" sourcestartlinenumber=\"1\">Static class containing helper methods for retrieving and setting application settings.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers.ValidCharacterCollection",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Helpers.ValidCharacterCollection.yml\" sourcestartlinenumber=\"1\">An enumeration that defines the types of characters that can be included in a random string.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Helpers.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Helpers.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Helpers.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Helpers",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.IPasswordAlgorithm.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.IPasswordAlgorithm.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.IPasswordAlgorithm.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.IPasswordAlgorithm",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.IPasswordAlgorithm.yml\" sourcestartlinenumber=\"1\">Defines the contract for password encryption algorithms.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.NamedColor.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.NamedColor.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.NamedColor.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.NamedColor",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.NamedColor.yml\" sourcestartlinenumber=\"1\">Enum representing a set of named colors with their corresponding HEX values. These colors are\ninspired by the XKCD color palette (<a href=\"https://xkcd.com/color/rgb/\" target=\"_blank\">Link</a>).</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Password.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Password.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Password.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Password",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Password.yml\" sourcestartlinenumber=\"1\">Represents a password with its hash, salt and algorithm used for encryption.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Pbkdf2Algorithm.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Pbkdf2Algorithm.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Pbkdf2Algorithm.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Pbkdf2Algorithm",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Pbkdf2Algorithm.yml\" sourcestartlinenumber=\"1\">Implements the PBKDF2 algorithm for password encryption.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.Pool-1.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.Pool-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.Pool-1.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.Pool<T>",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.Pool-1.yml\" sourcestartlinenumber=\"1\">A managed pool of resources. This class provides a thread-safe way to manage a collection of\nobjects of type <code class=\"typeparamref\">T</code>.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.PoolItem-1.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.PoolItem-1.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.PoolItem-1.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.PoolItem<T>",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.PoolItem-1.yml\" sourcestartlinenumber=\"1\">A pool item. This class cannot be inherited.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.PropertyComparer-2.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.PropertyComparer-2.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.PropertyComparer-2.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit.PropertyComparer<T, U>",
|
||||
"Summary": "<p sourcefile=\"api/CapyKit.PropertyComparer-2.yml\" sourcestartlinenumber=\"1\">A object comparer that can accept a lambda expression to compare properties.</p>\n"
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "ManagedReference",
|
||||
"source_relative_path": "api/CapyKit.yml",
|
||||
"type": "Conceptual",
|
||||
"source_relative_path": "api/CapyKit.md",
|
||||
"output": {
|
||||
".html": {
|
||||
"relative_path": "api/CapyKit.html"
|
||||
}
|
||||
},
|
||||
"version": "",
|
||||
"Uid": null,
|
||||
"IsMRef": true,
|
||||
"Title": "CapyKit",
|
||||
"Summary": null
|
||||
"version": ""
|
||||
},
|
||||
{
|
||||
"type": "Toc",
|
||||
|
|
|
|||
|
|
@ -29,10 +29,10 @@
|
|||
|
||||
<ul class="nav level3">
|
||||
<li>
|
||||
<a href="api/CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
||||
<a href="api/CapyKit.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.CapyEventHandler.html" name="" title="CapyEventHandler">CapyEventHandler</a>
|
||||
<a href="api/CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
||||
|
|
@ -43,30 +43,42 @@
|
|||
<li>
|
||||
<a href="api/CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.EventLevel.html" name="" title="EventLevel">EventLevel</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.IPasswordAlgorithm.html" name="" title="IPasswordAlgorithm">IPasswordAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.NamedColor.html" name="" title="NamedColor">NamedColor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Password.html" name="" title="Password">Password</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.html" name="" title="Interfaces">Interfaces</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.IPasswordAlgorithm.html" name="" title="IPasswordAlgorithm">IPasswordAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.EventLevel.html" name="" title="EventLevel">EventLevel</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.NamedColor.html" name="" title="NamedColor">NamedColor</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.html" name="" title="Delegates">Delegates</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.CapyEventHandler.html" name="" title="CapyEventHandler">CapyEventHandler</a>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li>
|
||||
|
|
@ -74,6 +86,9 @@
|
|||
<a href="api/CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
||||
|
||||
<ul class="nav level3">
|
||||
<li>
|
||||
<a href="api/CapyKit.Attributes.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
||||
</li>
|
||||
|
|
@ -90,6 +105,9 @@
|
|||
<a href="api/CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
||||
|
||||
<ul class="nav level3">
|
||||
<li>
|
||||
<a href="api/CapyKit.Enumerations.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
||||
</li>
|
||||
|
|
@ -100,6 +118,9 @@
|
|||
<a href="api/CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
||||
|
||||
<ul class="nav level3">
|
||||
<li>
|
||||
<a href="api/CapyKit.Extensions.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
||||
</li>
|
||||
|
|
@ -119,6 +140,9 @@
|
|||
<a href="api/CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
||||
|
||||
<ul class="nav level3">
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.html" name="" title="Classes">Classes</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
||||
</li>
|
||||
|
|
@ -128,9 +152,6 @@
|
|||
<li>
|
||||
<a href="api/CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
||||
</li>
|
||||
|
|
@ -146,6 +167,15 @@
|
|||
<li>
|
||||
<a href="api/CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.html" name="" title="Interfaces">Interfaces</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.html" name="" title="Enums">Enums</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="api/CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
||||
</li>
|
||||
|
|
|
|||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue