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>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,282 +70,94 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Attributes.EnumerationAttribute`1">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Attributes_EnumerationAttribute_1"> Class EnumerationAttribute<T></h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Attributes_EnumerationAttribute_1" data-uid="CapyKit.Attributes.EnumerationAttribute`1" class="text-break">
|
<p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
||||||
Class EnumerationAttribute<T>
|
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Field)]
|
||||||
</h1>
|
public abstract class EnumerationAttribute<T> : Attribute
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Attributes.html">Attributes</a></dd></dl>
|
<p><code>T</code></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<p>Generic type parameter allowing for arbitrary declarations and assignments of meaning.</p>
|
||||||
</div>
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<div class="markdown summary"><p>Custom attribute class for decorating enumeration fields with additional data.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||||
</div>
|
<a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<T></a></p>
|
||||||
<div class="markdown conceptual"></div>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||||
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Field)]
|
<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>,
|
||||||
public abstract class EnumerationAttribute<T> : Attribute</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||||
</div>
|
<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>,
|
||||||
<h4 class="section">Type Parameters</h4>
|
<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>,
|
||||||
<dl class="parameters">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly)">Attribute.GetCustomAttributes(Assembly)</a>,
|
||||||
<dt><code>T</code></dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||||
<dd><p>Generic type parameter allowing for arbitrary declarations and assignments of meaning.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||||
</dd>
|
<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>,
|
||||||
</dl>
|
<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>,
|
||||||
<dl class="typelist inheritance">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||||
<dt>Inheritance</dt>
|
<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>,
|
||||||
<dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-type)">Attribute.GetCustomAttributes(Module, Type)</a>,
|
||||||
<div><span class="xref">EnumerationAttribute<T></span></div>
|
<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>,
|
||||||
</dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo)">Attribute.GetCustomAttributes(ParameterInfo)</a>,
|
||||||
</dl>
|
<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>,
|
||||||
<dl class="typelist derived">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||||
<dt>Derived</dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||||
<dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||||
<div><a class="xref" href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></div>
|
<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>,
|
||||||
</dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-memberinfo-system-type)">Attribute.IsDefined(MemberInfo, Type)</a>,
|
||||||
</dl>
|
<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>,
|
||||||
<dl class="typelist inheritedMembers">
|
<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>,
|
||||||
<dt>Inherited Members</dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||||
<dd>
|
<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>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object)</a>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<div>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
<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>
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EnumerationAttribute<T>>(EnumerationAttribute<T>, EnumerationAttribute<T>)</a>,
|
||||||
</div>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<div>
|
<h2 id="constructors">Constructors</h2>
|
||||||
<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>
|
<h3 id="CapyKit_Attributes_EnumerationAttribute_1__ctor__0_"> EnumerationAttribute(T)</h3>
|
||||||
</div>
|
<p>Gets the value of the enumeration represented by this attribute.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">protected EnumerationAttribute(T value)
|
||||||
<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>
|
</code></pre>
|
||||||
</div>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div>
|
<p><code>value</code> T</p>
|
||||||
<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>
|
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationAttribute`1</span> class with 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
|
|
||||||
specified value.</p>
|
specified value.</p>
|
||||||
</dd>
|
<h2 id="properties">Properties</h2>
|
||||||
</dl>
|
<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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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
|
|
||||||
specified value.</p>
|
specified value.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public T Value { get; }
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="property-value">Property Value</h4>
|
||||||
<div class="codewrapper">
|
<p>T</p>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,240 +70,87 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Attributes.EnumerationDescriptionAttribute">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Attributes_EnumerationDescriptionAttribute"> Class EnumerationDescriptionAttribute</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Attributes_EnumerationDescriptionAttribute" data-uid="CapyKit.Attributes.EnumerationDescriptionAttribute" class="text-break">
|
<p>An attribute class for decorating enumeration fields with a description.</p>
|
||||||
Class EnumerationDescriptionAttribute
|
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Field)]
|
||||||
</h1>
|
public class EnumerationDescriptionAttribute : EnumerationAttribute<string>
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Attributes.html">Attributes</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||||
</div>
|
<a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute<string></a> ←
|
||||||
|
<a href="CapyKit.Attributes.EnumerationDescriptionAttribute.html">EnumerationDescriptionAttribute</a></p>
|
||||||
<div class="markdown summary"><p>An attribute class for decorating enumeration fields with a description.</p>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html#CapyKit_Attributes_EnumerationAttribute_1_Value">EnumerationAttribute<string>.Value</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<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>,
|
||||||
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Field)]
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttribute(MemberInfo, Type)</a>,
|
||||||
public class EnumerationDescriptionAttribute : EnumerationAttribute<string></code></pre>
|
<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>,
|
||||||
</div>
|
<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>,
|
||||||
<dl class="typelist inheritance">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-boolean)">Attribute.GetCustomAttributes(Assembly, bool)</a>,
|
||||||
<dt>Inheritance</dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-assembly-system-type)">Attribute.GetCustomAttributes(Assembly, Type)</a>,
|
||||||
<dd>
|
<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>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||||
<div><span class="xref">EnumerationDescriptionAttribute</span></div>
|
<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>,
|
||||||
</dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||||
</dl>
|
<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>,
|
||||||
<dl class="typelist inheritedMembers">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-boolean)">Attribute.GetCustomAttributes(ParameterInfo, bool)</a>,
|
||||||
<dt>Inherited Members</dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||||
<dd>
|
<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>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||||
<a class="xref" 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.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-assembly-system-type)">Attribute.IsDefined(Assembly, Type)</a>,
|
||||||
<div>
|
<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 class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object)</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>,
|
||||||
</div>
|
<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>,
|
||||||
<div>
|
<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 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>
|
<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>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||||
<div>
|
<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 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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<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>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</div>
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<EnumerationDescriptionAttribute>(EnumerationDescriptionAttribute, EnumerationDescriptionAttribute)</a>,
|
||||||
<div>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<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>
|
<h2 id="constructors">Constructors</h2>
|
||||||
</div>
|
<h3 id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_System_String_"> EnumerationDescriptionAttribute(string)</h3>
|
||||||
<div>
|
<p>Initializes a new instance of the <span class="xref">CapyKit.Attributes.EnumerationDescriptionAttribute</span> class with
|
||||||
<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
|
|
||||||
the specified description.</p>
|
the specified description.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public EnumerationDescriptionAttribute(string description)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>description</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public EnumerationDescriptionAttribute(string description)</code></pre>
|
<p>The description of the enumeration value.</p>
|
||||||
</div>
|
<h2 id="see-also">See Also</h2>
|
||||||
|
<p><a href="CapyKit.Attributes.EnumerationAttribute-1.html">EnumerationAttribute</a><T></p>
|
||||||
<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>
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,340 +70,106 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Attributes.ValueFormatAttribute">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Attributes_ValueFormatAttribute"> Class ValueFormatAttribute</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Attributes.html">CapyKit.Attributes</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Attributes_ValueFormatAttribute" data-uid="CapyKit.Attributes.ValueFormatAttribute" class="text-break">
|
<p>Custom attribute for formatting values in a specific way.</p>
|
||||||
Class ValueFormatAttribute
|
<pre><code class="lang-csharp">[AttributeUsage(AttributeTargets.Property)]
|
||||||
</h1>
|
public class ValueFormatAttribute : Attribute
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Attributes.html">Attributes</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a> ←
|
||||||
</div>
|
<a href="CapyKit.Attributes.ValueFormatAttribute.html">ValueFormatAttribute</a></p>
|
||||||
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
<div class="markdown summary"><p>Custom attribute for formatting values in a specific way.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-assembly-system-type)">Attribute.GetCustomAttribute(Assembly, Type)</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<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>,
|
||||||
<pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Property)]
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute#system-attribute-getcustomattribute(system-reflection-module-system-type)">Attribute.GetCustomAttribute(Module, Type)</a>,
|
||||||
public class ValueFormatAttribute : Attribute</code></pre>
|
<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>,
|
||||||
</div>
|
<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>,
|
||||||
<dl class="typelist inheritance">
|
<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>,
|
||||||
<dt>Inheritance</dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo)">Attribute.GetCustomAttributes(MemberInfo)</a>,
|
||||||
<dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-boolean)">Attribute.GetCustomAttributes(MemberInfo, bool)</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-memberinfo-system-type)">Attribute.GetCustomAttributes(MemberInfo, Type)</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute">Attribute</a></div>
|
<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>,
|
||||||
<div><span class="xref">ValueFormatAttribute</span></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module)">Attribute.GetCustomAttributes(Module)</a>,
|
||||||
</dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-module-system-boolean)">Attribute.GetCustomAttributes(Module, bool)</a>,
|
||||||
</dl>
|
<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>,
|
||||||
<dl class="typelist inheritedMembers">
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes#system-attribute-getcustomattributes(system-reflection-parameterinfo-system-type)">Attribute.GetCustomAttributes(ParameterInfo, Type)</a>,
|
||||||
<dt>Inherited Members</dt>
|
<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>,
|
||||||
<dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode">Attribute.GetHashCode()</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute">Attribute.IsDefaultAttribute()</a>,
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.attribute.equals">Attribute.Equals(object)</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>,
|
||||||
</div>
|
<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>,
|
||||||
<div>
|
<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 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>
|
<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>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-module-system-type)">Attribute.IsDefined(Module, Type)</a>,
|
||||||
<div>
|
<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 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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.isdefined#system-attribute-isdefined(system-reflection-parameterinfo-system-type)">Attribute.IsDefined(ParameterInfo, Type)</a>,
|
||||||
</div>
|
<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>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.match">Attribute.Match(object?)</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.attribute.typeid">Attribute.TypeId</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<div>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
<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>
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<ValueFormatAttribute>(ValueFormatAttribute, ValueFormatAttribute)</a>,
|
||||||
</div>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<div>
|
<h2 id="constructors">Constructors</h2>
|
||||||
<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>
|
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor"> ValueFormatAttribute()</h3>
|
||||||
</div>
|
<p>Default constructor. Initializes a new instance of the <span class="xref">CapyKit.Attributes.ValueFormatAttribute</span>
|
||||||
<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>
|
|
||||||
class with an empty format string.</p>
|
class with an empty format string.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public ValueFormatAttribute()
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h3 id="CapyKit_Attributes_ValueFormatAttribute__ctor_System_String_"> ValueFormatAttribute(string)</h3>
|
||||||
<div class="codewrapper">
|
<p>Constructor. Initializes a new instance of the <span class="xref">CapyKit.Attributes.ValueFormatAttribute</span> class with
|
||||||
<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
|
|
||||||
the specified format string.</p>
|
the specified format string.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public ValueFormatAttribute(string format)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>format</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public ValueFormatAttribute(string format)</code></pre>
|
<p>The format string used to format the value.</p>
|
||||||
</div>
|
<h2 id="properties">Properties</h2>
|
||||||
|
<h3 id="CapyKit_Attributes_ValueFormatAttribute_Format"> Format</h3>
|
||||||
<h4 class="section">Parameters</h4>
|
<p>Gets or sets the format to use for formatting the value.</p>
|
||||||
<dl class="parameters">
|
<pre><code class="lang-csharp">public string Format { get; }
|
||||||
<dt><code>format</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
</code></pre>
|
||||||
<dd><p>The format string used to format the value.</p>
|
<h4 id="property-value">Property Value</h4>
|
||||||
</dd>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</dl>
|
<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>
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,38 +70,23 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Attributes">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Attributes"> Namespace CapyKit.Attributes</h1>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,235 +70,69 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.CapyEventArgs">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_CapyEventArgs"> Class CapyEventArgs</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_CapyEventArgs" data-uid="CapyKit.CapyEventArgs" class="text-break">
|
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||||
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
|
|
||||||
method name information.</p>
|
method name information.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public class CapyEventArgs : EventArgs
|
||||||
<div class="markdown conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="codewrapper">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<pre><code class="lang-csharp hljs">public class CapyEventArgs : EventArgs</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a> ←
|
||||||
</div>
|
<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>,
|
||||||
<dl class="typelist inheritance">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<dt>Inheritance</dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs">EventArgs</a></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<div><span class="xref">CapyEventArgs</span></div>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</dd>
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)</a>,
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<pre><code class="lang-csharp">public CapyEventArgs(EventLevel level, string message, string method = null)
|
||||||
<dt>Inherited Members</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div>
|
<p><code>level</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.eventargs.empty">EventArgs.Empty</a>
|
<p>The severity level of the event.</p>
|
||||||
</div>
|
<p><code>message</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<div>
|
<p>A descriptive message explaining the reason for the event.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</div>
|
<p>The name of the method where the event was raised.</p>
|
||||||
<div>
|
<h2 id="properties">Properties</h2>
|
||||||
<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>
|
<h3 id="CapyKit_CapyEventArgs_Level"> Level</h3>
|
||||||
</div>
|
<p>Gets the severity level of the event.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public EventLevel Level { get; }
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="property-value">Property Value</h4>
|
||||||
<div>
|
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<h3 id="CapyKit_CapyEventArgs_Message"> Message</h3>
|
||||||
</div>
|
<p>Gets the message describing the reason for the event.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public string Message { get; }
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="property-value-1">Property Value</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<h3 id="CapyKit_CapyEventArgs_MethodName"> MethodName</h3>
|
||||||
</div>
|
<p>Gets the name of the method where the event was raised.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public string MethodName { get; }
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="property-value-2">Property Value</h4>
|
||||||
</dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,61 +70,27 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.CapyEventHandler">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_CapyEventHandler"> Delegate CapyEventHandler</h1>
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,281 +70,108 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.CapyEventReporter">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_CapyEventReporter"> Class CapyEventReporter</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_CapyEventReporter" data-uid="CapyKit.CapyEventReporter" class="text-break">
|
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||||
Class CapyEventReporter
|
<pre><code class="lang-csharp">public static class CapyEventReporter
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
<a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static class CapyEventReporter</code></pre>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</div>
|
<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
|
||||||
|
|
||||||
|
|
||||||
<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
|
|
||||||
a way for subscribers to recieve events for various "events" within the library. These can be thought of as
|
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>
|
a logging solution for CapyKit. Consumers are free to treat these events however they see fit.</p>
|
||||||
</div>
|
<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>
|
||||||
<h2 class="section" id="methods">Methods
|
<pre><code class="lang-csharp">public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
|
||||||
</h2>
|
</code></pre>
|
||||||
|
<h4 id="parameters">Parameters</h4>
|
||||||
|
<p><code>eventLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||||
<a id="CapyKit_CapyEventReporter_EmitEvent_" data-uid="CapyKit.CapyEventReporter.EmitEvent*"></a>
|
<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>
|
||||||
<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[])">
|
<p>The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||||
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>
|
|
||||||
is accepted.</p>
|
is accepted.</p>
|
||||||
</dd>
|
<p><code>method</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p>(Optional) The name of the method where the event was raised.</p>
|
||||||
<dd><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>
|
||||||
</dd>
|
<p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
<h4 id="examples">Examples</h4>
|
||||||
<dd><p>A variable-length parameters list containing arguments for formatting the message.</p>
|
<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>
|
||||||
</dd>
|
<h4 id="remarks-1">Remarks</h4>
|
||||||
</dl>
|
<p>In order to allow for efficient calling member access via <span class="xref">System.Runtime.CompilerServices.CallerMemberNameAttribute</span>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.</p>
|
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.</p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist seealso">
|
<p>Emits an event with the given severity level, message, unique identifier, and method name one
|
||||||
<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
|
|
||||||
time.</p>
|
time.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>eventLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)</code></pre>
|
<p>The severity level of the event.</p>
|
||||||
</div>
|
<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>
|
||||||
<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>
|
|
||||||
is accepted.</p>
|
is accepted.</p>
|
||||||
</dd>
|
<p><code>uniqueIdentifier</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<dt><code>uniqueIdentifier</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p>A unique identifier for the event emission.</p>
|
||||||
<dd><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>
|
||||||
</dd>
|
<p>(Optional) The name of the method where the event was raised.</p>
|
||||||
<dt><code>method</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<dd><p>(Optional) The name of the method where the event was raised.</p>
|
<p>A variable-length parameters list containing arguments for formatting the message.</p>
|
||||||
</dd>
|
<h4 id="remarks-2">Remarks</h4>
|
||||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
<p>This method is similar to EmitEvent(EventLevel, string, string, string, object[])
|
||||||
<dd><p>A variable-length parameters list containing arguments for formatting the message.</p>
|
, but requires a unique identifier (such as a <span class="xref">System.Guid</span>) to prevent duplicate
|
||||||
</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
|
|
||||||
emissions.</p>
|
emissions.</p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist seealso">
|
<h3 id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_"> Subscribe(CapyEventHandler, EventLevel, string)</h3>
|
||||||
<dt>See Also</dt>
|
<p>Subscribes the specified event handler to the event with the given subscription level and
|
||||||
<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
|
|
||||||
origin.</p>
|
origin.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>callback</code> <a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)</code></pre>
|
<p>The event handler to subscribe.</p>
|
||||||
</div>
|
<p><code>subscriptionLevel</code> <a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||||
|
<p>The severity level of the event to subscribe to.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><code>origin</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<dl class="parameters">
|
<p>(Optional) The name of the method or class where the subscription is made.</p>
|
||||||
<dt><code>callback</code> <a class="xref" href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></dt>
|
<h4 id="remarks-3">Remarks</h4>
|
||||||
<dd><p>The event handler to subscribe.</p>
|
<p>If there is no existing list for the given subscription level, a new list is created and
|
||||||
</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
|
|
||||||
added to the dictionary.</p>
|
added to the dictionary.</p>
|
||||||
</div>
|
<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>
|
||||||
<a id="CapyKit_CapyEventReporter_Unsubscribe_" data-uid="CapyKit.CapyEventReporter.Unsubscribe*"></a>
|
<p><code>callback</code> <a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||||
|
<p>The event handler to unsubscribe.</p>
|
||||||
<h3 id="CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_" data-uid="CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)">
|
<p><code>origin</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
Unsubscribe(CapyEventHandler, string)
|
<p>The name of the method or class where the subscription was made.</p>
|
||||||
|
|
||||||
</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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,87 +70,35 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Color">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Color"> Class Color</h1>
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,126 +70,42 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.EncryptedValue`1">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_EncryptedValue_1"> Class EncryptedValue<T></h1>
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,84 +70,35 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Enumerations.MeasurementSystem">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Enumerations_MeasurementSystem"> Enum MeasurementSystem</h1>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,28 +70,19 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Enumerations">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Enumerations"> Namespace CapyKit.Enumerations</h1>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
<h3 id="enums">Enums</h3>
|
||||||
|
<p><a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||||
|
<p>An enumeration representing different measurement systems.</p>
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,101 +70,41 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.EventLevel">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_EventLevel"> Enum EventLevel</h1>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,336 +70,107 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Extensions.EnumerationExtensions">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Extensions_EnumerationExtensions"> Class EnumerationExtensions</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||||
<h1 id="CapyKit_Extensions_EnumerationExtensions" data-uid="CapyKit.Extensions.EnumerationExtensions" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class EnumerationExtensions
|
<p>Provides static extentions methods for providing additional functionality for <span class="xref">System.Enum</span> types.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public static class EnumerationExtensions
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Extensions.EnumerationExtensions.html">EnumerationExtensions</a></p>
|
||||||
</div>
|
<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>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public static class EnumerationExtensions</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<pre><code class="lang-csharp">public static string GetDescription(this Enum enumeration)
|
||||||
<dt>Inheritance</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||||
<div><span class="xref">EnumerationExtensions</span></div>
|
<p>The enumeration to act on.</p>
|
||||||
</dd>
|
<h4 id="returns">Returns</h4>
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<pre><code class="lang-csharp">public static string GetName(this Enum enumeration)
|
||||||
<dt>Inherited Members</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<div>
|
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<p>The enumeration to act on.</p>
|
||||||
</div>
|
<h4 id="returns-1">Returns</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<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>
|
<p>The name of the enumeration.</p>
|
||||||
</div>
|
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_"> GetPrettyName(Enum)</h3>
|
||||||
<div>
|
<p>An <span class="xref">System.Enum</span> extension method that gets a human readable name.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<pre><code class="lang-csharp">public static string GetPrettyName(this Enum enumeration)
|
||||||
</div>
|
</code></pre>
|
||||||
<div>
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||||
</div>
|
<p>The enumeration to act on.</p>
|
||||||
<div>
|
<h4 id="returns-2">Returns</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</div>
|
<p>The human readable name of the enumeration.</p>
|
||||||
<div>
|
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_"> GetValue(Enum)</h3>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<p>An <span class="xref">System.Enum</span> extension method that gets an integer value representing the enumation.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static int GetValue(this Enum enumeration)
|
||||||
<div>
|
</code></pre>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
</div>
|
<p><code>enumeration</code> <a href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></p>
|
||||||
</dd></dl>
|
<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
|
||||||
<h2 class="section" id="methods">Methods
|
</code></pre>
|
||||||
</h2>
|
<h4 id="parameters-4">Parameters</h4>
|
||||||
|
<p><code>enumeration</code> T</p>
|
||||||
|
<p>The enumeration to act on.</p>
|
||||||
<a id="CapyKit_Extensions_EnumerationExtensions_GetDescription_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetDescription*"></a>
|
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
|
<p>The value.</p>
|
||||||
<h3 id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_" data-uid="CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)">
|
<h4 id="returns-4">Returns</h4>
|
||||||
GetDescription(Enum)
|
<p>T</p>
|
||||||
|
<p>A T.</p>
|
||||||
</h3>
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<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>
|
<p>Generic type parameter.</p>
|
||||||
</div>
|
<h3 id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_"> Parse<T>(T, string, bool)</h3>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<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
|
||||||
<div class="codewrapper">
|
</code></pre>
|
||||||
<pre><code class="lang-csharp hljs">public static string GetDescription(this Enum enumeration)</code></pre>
|
<h4 id="parameters-5">Parameters</h4>
|
||||||
</div>
|
<p><code>enumeration</code> T</p>
|
||||||
|
<p>The enumeration to act on.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<dl class="parameters">
|
<p>The string value of the <span class="xref">System.Enum</span>.</p>
|
||||||
<dt><code>enumeration</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.enum">Enum</a></dt>
|
<p><code>ignoreCase</code> <a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<dd><p>The enumeration to act on.</p>
|
<p>True to ignore case.</p>
|
||||||
</dd>
|
<h4 id="returns-5">Returns</h4>
|
||||||
</dl>
|
<p>T</p>
|
||||||
|
<p>A T.</p>
|
||||||
<h4 class="section">Returns</h4>
|
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||||
<dl class="parameters">
|
<p><code>T</code></p>
|
||||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p>Generic type parameter.</p>
|
||||||
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,600 +70,226 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Extensions.LINQExtensions">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Extensions_LINQExtensions"> Class LINQExtensions</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||||
<h1 id="CapyKit_Extensions_LINQExtensions" data-uid="CapyKit.Extensions.LINQExtensions" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class LINQExtensions
|
<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>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public static class LINQExtensions
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Extensions.LINQExtensions.html">LINQExtensions</a></p>
|
||||||
</div>
|
<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>,
|
||||||
<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>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public static class LINQExtensions</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<pre><code class="lang-csharp">public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)
|
||||||
<dt>Inheritance</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<p><code>items</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
<div><span class="xref">LINQExtensions</span></div>
|
<p>The items to act on.</p>
|
||||||
</dd>
|
<p><code>property</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<dt>Inherited Members</dt>
|
<p><code>T</code></p>
|
||||||
<dd>
|
<p>Generic type parameter of the parent object.</p>
|
||||||
<div>
|
<p><code>U</code></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<p>Generic type parameter property value.</p>
|
||||||
</div>
|
<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>
|
||||||
<div>
|
<p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||||
<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>
|
<pre><code class="lang-csharp">public static IEnumerable<T> Filter<T>(this IEnumerable<T> source, Func<T, bool> predicate)
|
||||||
</div>
|
</code></pre>
|
||||||
<div>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
</div>
|
<p>The source to act on.</p>
|
||||||
<div>
|
<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>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<p>The predicate.</p>
|
||||||
</div>
|
<h4 id="returns-1">Returns</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||||
</div>
|
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||||
<div>
|
<p><code>T</code></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<p>Generic type parameter.</p>
|
||||||
</div>
|
<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>
|
||||||
<div>
|
<p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
<pre><code class="lang-csharp">public static IQueryable<T> Filter<T>(this IQueryable<T> source, Expression<Func<T, bool>> predicate)
|
||||||
</div>
|
</code></pre>
|
||||||
</dd></dl>
|
<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>
|
||||||
<h2 class="section" id="methods">Methods
|
<p>An enumerator that allows foreach to be used to process remove in this collection.</p>
|
||||||
</h2>
|
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
|
<p>Generic type parameter.</p>
|
||||||
<a id="CapyKit_Extensions_LINQExtensions_Distinct_" data-uid="CapyKit.Extensions.LINQExtensions.Distinct*"></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__"> 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>
|
||||||
<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})">
|
<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)
|
||||||
Distinct<T, U>(IEnumerable<T>, Func<T, U>)
|
</code></pre>
|
||||||
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
</h3>
|
<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>
|
||||||
<div class="markdown level1 summary"><p>Enumerates distinct items in this collection as defined by the key <code class="paramref">property</code>.</p>
|
<p><code>inner</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><U></p>
|
||||||
</div>
|
<p>The inner.</p>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<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>
|
||||||
<div class="codewrapper">
|
<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>
|
||||||
<pre><code class="lang-csharp hljs">public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)</code></pre>
|
<p>The inner selector.</p>
|
||||||
</div>
|
<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>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><code>defaultGenerator</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></p>
|
||||||
<dl class="parameters">
|
<p>(Optional) The default generator.</p>
|
||||||
<dt><code>items</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
<h4 id="returns-3">Returns</h4>
|
||||||
<dd><p>The items to act on.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><R></p>
|
||||||
</dd>
|
<p>An IQueryable<R></p>
|
||||||
<dt><code>property</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, U></dt>
|
<h4 id="type-parameters-3">Type Parameters</h4>
|
||||||
<dd><p>The property.</p>
|
<p><code>T</code></p>
|
||||||
</dd>
|
<p>Generic type parameter.</p>
|
||||||
</dl>
|
<p><code>U</code></p>
|
||||||
|
<p>Generic type parameter.</p>
|
||||||
<h4 class="section">Returns</h4>
|
<p><code>TKey</code></p>
|
||||||
<dl class="parameters">
|
<p>Type of the key.</p>
|
||||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
<p><code>R</code></p>
|
||||||
<dd><p>An enumerator that allows foreach to be used to process distinct items in this collection.</p>
|
<p>Type of the r.</p>
|
||||||
</dd>
|
<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>
|
||||||
</dl>
|
<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)
|
||||||
<h4 class="section">Type Parameters</h4>
|
</code></pre>
|
||||||
<dl class="parameters">
|
<h4 id="parameters-4">Parameters</h4>
|
||||||
<dt><code>T</code></dt>
|
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
<dd><p>Generic type parameter of the parent object.</p>
|
<p>The source to act on.</p>
|
||||||
</dd>
|
<p><code>inner</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><U></p>
|
||||||
<dt><code>U</code></dt>
|
<p>The inner.</p>
|
||||||
<dd><p>Generic type parameter property value.</p>
|
<p><code>outerSelector</code> <a href="https://learn.microsoft.com/dotnet/api/system.func-2">Func</a><T, TKey></p>
|
||||||
</dd>
|
<p>The outer selector.</p>
|
||||||
</dl>
|
<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>
|
||||||
<a id="CapyKit_Extensions_LINQExtensions_Filter_" data-uid="CapyKit.Extensions.LINQExtensions.Filter*"></a>
|
<p>Generic type parameter.</p>
|
||||||
|
<p><code>U</code></p>
|
||||||
<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})">
|
<p>Generic type parameter.</p>
|
||||||
Filter<T>(IEnumerable<T>, Func<T, bool>)
|
<p><code>TKey</code></p>
|
||||||
|
<p>Type of the key.</p>
|
||||||
</h3>
|
<p><code>R</code></p>
|
||||||
|
<p>Type of the r.</p>
|
||||||
<div class="markdown level1 summary"><p>Filters out items matching a <code class="paramref">predicate</code> from the collection.</p>
|
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32_"> Page<T>(IEnumerable<T>, int, int)</h3>
|
||||||
</div>
|
<p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||||
<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
|
|
||||||
<code class="paramref">pageSize</code> items per page.</p>
|
<code class="paramref">pageSize</code> items per page.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-5">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
<pre><code class="lang-csharp hljs">public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)</code></pre>
|
<p>The source to act on.</p>
|
||||||
</div>
|
<p><code>pageNumber</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
|
<p>The page number to retrieve.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<dl class="parameters">
|
<p>Number of items per page.</p>
|
||||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></dt>
|
<h4 id="returns-5">Returns</h4>
|
||||||
<dd><p>The source to act on.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
</dd>
|
<p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||||
<dt><code>pageNumber</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
<h4 id="type-parameters-5">Type Parameters</h4>
|
||||||
<dd><p>The page number to retrieve.</p>
|
<p><code>T</code></p>
|
||||||
</dd>
|
<p>Generic type parameter.</p>
|
||||||
<dt><code>pageSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
<h4 id="remarks">Remarks</h4>
|
||||||
<dd><p>Number of items per page.</p>
|
<p>This method uses natural numbering starting at page 1.</p>
|
||||||
</dd>
|
<h4 id="exceptions">Exceptions</h4>
|
||||||
</dl>
|
<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
|
||||||
<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
|
|
||||||
<code class="paramref">pageSize</code> is less than
|
<code class="paramref">pageSize</code> is less than
|
||||||
<code>1</code>.</p>
|
<code>1</code>.</p>
|
||||||
</dd>
|
<h3 id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32_"> Page<T>(IQueryable<T>, int, int)</h3>
|
||||||
</dl>
|
<p>Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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
|
|
||||||
<code class="paramref">pageSize</code> items per page.</p>
|
<code class="paramref">pageSize</code> items per page.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-6">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>source</code> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||||
<pre><code class="lang-csharp hljs">public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)</code></pre>
|
<p>The source to act on.</p>
|
||||||
</div>
|
<p><code>pageNumber</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
|
<p>The page number to retrieve.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><code>pageSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<dl class="parameters">
|
<p>.</p>
|
||||||
<dt><code>source</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></dt>
|
<h4 id="returns-6">Returns</h4>
|
||||||
<dd><p>The source to act on.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1">IQueryable</a><T></p>
|
||||||
</dd>
|
<p>An enumerator that allows foreach to be used to process page in this collection.</p>
|
||||||
<dt><code>pageNumber</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
<h4 id="type-parameters-6">Type Parameters</h4>
|
||||||
<dd><p>The page number to retrieve.</p>
|
<p><code>T</code></p>
|
||||||
</dd>
|
<p>Generic type parameter.</p>
|
||||||
<dt><code>pageSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
<h4 id="remarks-1">Remarks</h4>
|
||||||
<dd><p>.</p>
|
<p>This method uses natural numbering starting at page 1.</p>
|
||||||
</dd>
|
<h4 id="exceptions-1">Exceptions</h4>
|
||||||
</dl>
|
<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
|
||||||
<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
|
|
||||||
<code class="paramref">pageSize</code> is less than
|
<code class="paramref">pageSize</code> is less than
|
||||||
<code>1</code>.</p>
|
<code>1</code>.</p>
|
||||||
</dd>
|
<h3 id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Collections_Generic_IEnumerable___0__System_Int32_"> PageCount<T>(IEnumerable<T>, int)</h3>
|
||||||
</dl>
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,161 +70,58 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Extensions.ObjectExtensions">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Extensions_ObjectExtensions"> Class ObjectExtensions</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Extensions.html">CapyKit.Extensions</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Extensions_ObjectExtensions" data-uid="CapyKit.Extensions.ObjectExtensions" class="text-break">
|
<p>An class containing extenstions that apply to any object type.</p>
|
||||||
Class ObjectExtensions
|
<pre><code class="lang-csharp">public static class ObjectExtensions
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Extensions.html">Extensions</a></dd></dl>
|
<a href="CapyKit.Extensions.ObjectExtensions.html">ObjectExtensions</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>An class containing extenstions that apply to any object type.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static class ObjectExtensions</code></pre>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</div>
|
<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>
|
||||||
|
|
||||||
<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>
|
|
||||||
object with the values from a given <code class="paramref">source</code> object.</p>
|
object with the values from a given <code class="paramref">source</code> object.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static void UpdateProperties<T>(this T target, T source)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>target</code> T</p>
|
||||||
<pre><code class="lang-csharp hljs">public static void UpdateProperties(this object target, object source)</code></pre>
|
<p>The target object to act on.</p>
|
||||||
</div>
|
<p><code>source</code> T</p>
|
||||||
|
<p>Source for the new property values.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<dl class="parameters">
|
<p><code>T</code></p>
|
||||||
<dt><code>target</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt>
|
<p>Generic type parameter.</p>
|
||||||
<dd><p>The target object to act on.</p>
|
<h3 id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_"> UpdateProperties(object, object)</h3>
|
||||||
</dd>
|
<p>An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||||
<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>
|
|
||||||
object with the values from a given <code class="paramref">source</code> object.</p>
|
object with the values from a given <code class="paramref">source</code> object.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static void UpdateProperties(this object target, object source)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>target</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static void UpdateProperties<T>(this T target, T source)</code></pre>
|
<p>The target object to act on.</p>
|
||||||
</div>
|
<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>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,177 +70,63 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Extensions.StringExtensions">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Extensions_StringExtensions"> Class StringExtensions</h1>
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,43 +70,25 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Extensions">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Extensions"> Namespace CapyKit.Extensions</h1>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,501 +70,155 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.CalculationHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_CalculationHelper"> Class CalculationHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
<h1 id="CapyKit_Helpers_CalculationHelper" data-uid="CapyKit.Helpers.CalculationHelper" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class CalculationHelper
|
<p>Static class providing helper methods for various calculations.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public static class CalculationHelper
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Helpers.CalculationHelper.html">CalculationHelper</a></p>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>Static class providing helper methods for various calculations.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public static class CalculationHelper</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<pre><code class="lang-csharp">public const int EARTH_RADIUS_KILOMETERS = 6371
|
||||||
<dt>Inheritance</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="field-value">Field Value</h4>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<div><span class="xref">CalculationHelper</span></div>
|
<h3 id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER"> MILES_PER_KILOMETER</h3>
|
||||||
</dd>
|
<p>Ratio of miles per kilometer .</p>
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<h2 id="methods">Methods</h2>
|
||||||
<dt>Inherited Members</dt>
|
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_"> CalculateHash(string)</h3>
|
||||||
<dd>
|
<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>
|
||||||
<div>
|
<pre><code class="lang-csharp">public static int CalculateHash(string str)
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div>
|
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<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>
|
<p>The string to be hashed.</p>
|
||||||
</div>
|
<h4 id="returns">Returns</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<p>The calculated hash.</p>
|
||||||
</div>
|
<h4 id="remarks">Remarks</h4>
|
||||||
<div>
|
<p>This method is used for a quick and consistent hash function. It should not be considered
|
||||||
<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
|
|
||||||
cryptographically sound or used in security contexts.</p>
|
cryptographically sound or used in security contexts.</p>
|
||||||
</div>
|
<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>
|
||||||
<a id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHexHash*"></a>
|
<p><code>str</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
|
<p>The string to be hashed.</p>
|
||||||
<h3 id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_" data-uid="CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)">
|
<h4 id="returns-1">Returns</h4>
|
||||||
CalculateHexHash(string)
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
|
<p>The calculated 16 character hexadecimal hash.</p>
|
||||||
</h3>
|
<h3 id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_"> DegreesToRadians(double)</h3>
|
||||||
|
<p>Convers degrees to radians.</p>
|
||||||
<div class="markdown level1 summary"><p>Calculates the hexadecimal hash.</p>
|
<pre><code class="lang-csharp">public static double DegreesToRadians(double degrees)
|
||||||
</div>
|
</code></pre>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
|
<p><code>degrees</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
<div class="codewrapper">
|
<p>The degree value.</p>
|
||||||
<pre><code class="lang-csharp hljs">public static string CalculateHexHash(string str)</code></pre>
|
<h4 id="returns-2">Returns</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
|
<p>The value as radians.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<h3 id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_"> GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)</h3>
|
||||||
<dl class="parameters">
|
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||||
<dt><code>str</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<pre><code class="lang-csharp">public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||||
<dd><p>The string to be hashed.</p>
|
</code></pre>
|
||||||
</dd>
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
</dl>
|
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||||
|
<p>The latitude origin.</p>
|
||||||
<h4 class="section">Returns</h4>
|
<p><code>longitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||||
<dl class="parameters">
|
<p>The longitude origin.</p>
|
||||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||||
<dd><p>The calculated 16 character hexadecimal hash.</p>
|
<p>The latitude destination.</p>
|
||||||
</dd>
|
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a></p>
|
||||||
</dl>
|
<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
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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
|
|
||||||
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist seealso">
|
<p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
||||||
<dt>See Also</dt>
|
<pre><code class="lang-csharp">public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||||
<dd>
|
</code></pre>
|
||||||
<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>
|
<h4 id="parameters-4">Parameters</h4>
|
||||||
</dd>
|
<p><code>latitudeOrigin</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
</dl>
|
<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>
|
||||||
<a id="CapyKit_Helpers_CalculationHelper_GetDistance_" data-uid="CapyKit.Helpers.CalculationHelper.GetDistance*"></a>
|
<p><code>latitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
|
<p>The latitude destination.</p>
|
||||||
<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)">
|
<p><code>longitudeDestination</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
GetDistance(double, double, double, double, MeasurementSystem)
|
<p>The longitude destination.</p>
|
||||||
|
<p><code>measurementSystem</code> <a href="CapyKit.Enumerations.MeasurementSystem.html">MeasurementSystem</a></p>
|
||||||
</h3>
|
<p>(Optional) The measurement system.</p>
|
||||||
|
<h4 id="returns-4">Returns</h4>
|
||||||
<div class="markdown level1 summary"><p>Gets the distance between two points on earth using the <code>haversine</code> formula.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
</div>
|
<p>The distance.</p>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<h4 id="remarks-2">Remarks</h4>
|
||||||
|
<p>Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||||
<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
|
|
||||||
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
to calculate the "as-the-crow-flies" distance between two points on earth.</p>
|
||||||
</div>
|
<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>
|
||||||
<a id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_" data-uid="CapyKit.Helpers.CalculationHelper.KilometersToMiles*"></a>
|
<p><code>kilometers</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
|
<p>The value in kilometers.</p>
|
||||||
<h3 id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_" data-uid="CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)">
|
<h4 id="returns-5">Returns</h4>
|
||||||
KilometersToMiles(double)
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
|
<p>The value in miles.</p>
|
||||||
</h3>
|
<h3 id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_"> MilesToKilometers(double)</h3>
|
||||||
|
<p>Converts miles to kilometers.</p>
|
||||||
<div class="markdown level1 summary"><p>Converts kilometers to miles.</p>
|
<pre><code class="lang-csharp">public static double MilesToKilometers(double miles)
|
||||||
</div>
|
</code></pre>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<h4 id="parameters-6">Parameters</h4>
|
||||||
|
<p><code>miles</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
<div class="codewrapper">
|
<p>The value in miles.</p>
|
||||||
<pre><code class="lang-csharp hljs">public static double KilometersToMiles(double kilometers)</code></pre>
|
<h4 id="returns-6">Returns</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
|
<p>The value in kilometers.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<h3 id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_"> RadiansToDegrees(double)</h3>
|
||||||
<dl class="parameters">
|
<p>Converts radians to degrees.</p>
|
||||||
<dt><code>kilometers</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
<pre><code class="lang-csharp">public static double RadiansToDegrees(double radians)
|
||||||
<dd><p>The value in kilometers.</p>
|
</code></pre>
|
||||||
</dd>
|
<h4 id="parameters-7">Parameters</h4>
|
||||||
</dl>
|
<p><code>radians</code> <a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
|
<p>The radian value.</p>
|
||||||
<h4 class="section">Returns</h4>
|
<h4 id="returns-7">Returns</h4>
|
||||||
<dl class="parameters">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.double">double</a></p>
|
||||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.double">double</a></dt>
|
<p>The value as degrees.</p>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,288 +70,91 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.CompressionHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_CompressionHelper"> Class CompressionHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
<h1 id="CapyKit_Helpers_CompressionHelper" data-uid="CapyKit.Helpers.CompressionHelper" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class CompressionHelper
|
<p>A class that contains methods for managing data compression.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public static class CompressionHelper
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Helpers.CompressionHelper.html">CompressionHelper</a></p>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>A class that contains methods for managing data compression.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public static class CompressionHelper</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<pre><code class="lang-csharp">public static byte[] Compress(object obj)
|
||||||
<dt>Inheritance</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||||
<div><span class="xref">CompressionHelper</span></div>
|
<p>The object.</p>
|
||||||
</dd>
|
<h4 id="returns">Returns</h4>
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<pre><code class="lang-csharp">public static string CompressToString(object obj)
|
||||||
<dt>Inherited Members</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<div>
|
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<p>The object.</p>
|
||||||
</div>
|
<h4 id="returns-1">Returns</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<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>
|
<p>A string in <code>base64</code> encoding.</p>
|
||||||
</div>
|
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_"> Decompress<T>(string)</h3>
|
||||||
<div>
|
<p>Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<pre><code class="lang-csharp">public static T Decompress<T>(string encodedString)
|
||||||
</div>
|
</code></pre>
|
||||||
<div>
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<p><code>encodedString</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</div>
|
<p>The <code>base64</code> encoded <code>gzip</code> string.</p>
|
||||||
<div>
|
<h4 id="returns-2">Returns</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<p>T</p>
|
||||||
</div>
|
<p>A <code class="typeparamref">T</code> typed object.</p>
|
||||||
<div>
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<p><code>T</code></p>
|
||||||
</div>
|
<p>Generic type parameter.</p>
|
||||||
<div>
|
<h3 id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_Byte___"> Decompress<T>(byte[])</h3>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
<p>Decompresses a given compressed <code>gzip</code> byte stream.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static T Decompress<T>(byte[] byteStream)
|
||||||
</dd></dl>
|
</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>
|
||||||
<h2 class="section" id="methods">Methods
|
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||||
</h2>
|
<p><code>T</code></p>
|
||||||
|
<p>Generic type parameter.</p>
|
||||||
|
<h3 id="CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_"> DecompressToString(string)</h3>
|
||||||
<a id="CapyKit_Helpers_CompressionHelper_Compress_" data-uid="CapyKit.Helpers.CompressionHelper.Compress*"></a>
|
<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)
|
||||||
<h3 id="CapyKit_Helpers_CompressionHelper_Compress_System_Object_" data-uid="CapyKit.Helpers.CompressionHelper.Compress(System.Object)">
|
</code></pre>
|
||||||
Compress(object)
|
<h4 id="parameters-4">Parameters</h4>
|
||||||
|
<p><code>compressed</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</h3>
|
<p>The compressed string.</p>
|
||||||
|
<h4 id="returns-4">Returns</h4>
|
||||||
<div class="markdown level1 summary"><p>Compresses a given object using the <code>gzip</code> algorithm.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</div>
|
<p>A decomressed string.</p>
|
||||||
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,121 +70,40 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.EncryptionHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_EncryptionHelper"> Class EncryptionHelper</h1>
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,179 +70,50 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.IEncryptionAlgorithm">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_IEncryptionAlgorithm"> Interface IEncryptionAlgorithm</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
<h1 id="CapyKit_Helpers_IEncryptionAlgorithm" data-uid="CapyKit.Helpers.IEncryptionAlgorithm" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Interface IEncryptionAlgorithm
|
<pre><code class="lang-csharp">public interface IEncryptionAlgorithm
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)</a>,
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h2 id="properties">Properties</h2>
|
||||||
</div>
|
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||||
|
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||||
<div class="markdown summary"></div>
|
</code></pre>
|
||||||
<div class="markdown conceptual"></div>
|
<h4 id="property-value">Property Value</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<div class="codewrapper">
|
<h2 id="methods">Methods</h2>
|
||||||
<pre><code class="lang-csharp hljs">public interface IEncryptionAlgorithm</code></pre>
|
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___"> Decrypt<T>(EncryptedValue<T>, params object[])</h3>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist extensionMethods">
|
<h3 id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___"> Encrypt<T>(object, params object[])</h3>
|
||||||
<dt>Extension Methods</dt>
|
<pre><code class="lang-csharp">EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
|
||||||
<dd>
|
</code></pre>
|
||||||
<div>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||||
</div>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<div>
|
<h4 id="returns-1">Returns</h4>
|
||||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue</a><T></p>
|
||||||
</div>
|
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||||
</dd></dl>
|
<p><code>T</code></p>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,381 +70,105 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.KeyHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_KeyHelper"> Class KeyHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
<h1 id="CapyKit_Helpers_KeyHelper" data-uid="CapyKit.Helpers.KeyHelper" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class KeyHelper
|
<p>A class that contains methods for managing key creation and validation against a master key.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public class KeyHelper
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a></p>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>A class that contains methods for managing key creation and validation against a master key.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public class KeyHelper</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<p>Generates a random key.</p>
|
||||||
<dt>Inheritance</dt>
|
<pre><code class="lang-csharp">public string GenerateKey()
|
||||||
<dd>
|
</code></pre>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<h4 id="returns">Returns</h4>
|
||||||
<div><span class="xref">KeyHelper</span></div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</dd>
|
<p>The key.</p>
|
||||||
</dl>
|
<h3 id="CapyKit_Helpers_KeyHelper_GetMasterKey"> GetMasterKey()</h3>
|
||||||
|
<p>Gets the master key.</p>
|
||||||
|
<pre><code class="lang-csharp">public byte[] GetMasterKey()
|
||||||
|
</code></pre>
|
||||||
<dl class="typelist inheritedMembers">
|
<h4 id="returns-1">Returns</h4>
|
||||||
<dt>Inherited Members</dt>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<dd>
|
<p>An array of byte.</p>
|
||||||
<div>
|
<h4 id="exceptions">Exceptions</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></p>
|
||||||
</div>
|
<p>Thrown when the requested operation is invalid.</p>
|
||||||
<div>
|
<h3 id="CapyKit_Helpers_KeyHelper_GetNumParts"> GetNumParts()</h3>
|
||||||
<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>
|
<p>Gets the number parts.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public int GetNumParts()
|
||||||
<div>
|
</code></pre>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<h4 id="returns-2">Returns</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<div>
|
<p>The number parts.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<h4 id="exceptions-1">Exceptions</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></p>
|
||||||
<div>
|
<p>Thrown when one or more arguments have unsupported or illegal values.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<h3 id="CapyKit_Helpers_KeyHelper_GetSaltSize"> GetSaltSize()</h3>
|
||||||
</div>
|
<p>Gets the salt size.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public int GetSaltSize()
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="returns-3">Returns</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
<p>The salt size.</p>
|
||||||
</div>
|
<h3 id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"> SetMasterKeyAccessor(Func<byte[]>)</h3>
|
||||||
</dd></dl>
|
<p>Sets the master key.</p>
|
||||||
|
<pre><code class="lang-csharp">public void SetMasterKeyAccessor(Func<byte[]> accessor)
|
||||||
<dl class="typelist extensionMethods">
|
</code></pre>
|
||||||
<dt>Extension Methods</dt>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<dd>
|
<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>
|
||||||
<div>
|
<p>The accessor function.</p>
|
||||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
<h3 id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"> SetNumPartsAccessor(Func<int>)</h3>
|
||||||
</div>
|
<p>Set and get the number of parts for the formatted key. Default is 2.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public void SetNumPartsAccessor(Func<int> accessor)
|
||||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
</dd></dl>
|
<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>
|
||||||
<h2 class="section" id="methods">Methods
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
</h2>
|
<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>
|
||||||
<a id="CapyKit_Helpers_KeyHelper_GenerateKey_" data-uid="CapyKit.Helpers.KeyHelper.GenerateKey*"></a>
|
<p>Validates the provided key.</p>
|
||||||
|
<pre><code class="lang-csharp">public bool ValidateKey(string providedKey)
|
||||||
<h3 id="CapyKit_Helpers_KeyHelper_GenerateKey" data-uid="CapyKit.Helpers.KeyHelper.GenerateKey">
|
</code></pre>
|
||||||
GenerateKey()
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
|
<p><code>providedKey</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</h3>
|
<p>The provided key.</p>
|
||||||
|
<h4 id="returns-4">Returns</h4>
|
||||||
<div class="markdown level1 summary"><p>Generates a random key.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
</div>
|
<p>True if it succeeds, false if it fails.</p>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<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>(),
|
||||||
<div class="codewrapper">
|
<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>[]>),
|
||||||
<pre><code class="lang-csharp hljs">public string GenerateKey()</code></pre>
|
<a href="CapyKit.Helpers.KeyHelper.html">KeyHelper</a>.masterKeyAccessor</p>
|
||||||
</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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,134 +70,49 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.LanguageHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_LanguageHelper"> Class LanguageHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Helpers_LanguageHelper" data-uid="CapyKit.Helpers.LanguageHelper" class="text-break">
|
<p>Helper class for handling text transformations.</p>
|
||||||
Class LanguageHelper
|
<pre><code class="lang-csharp">public class LanguageHelper
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<a href="CapyKit.Helpers.LanguageHelper.html">LanguageHelper</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>Helper class for handling text transformations.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public class LanguageHelper</code></pre>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<pre><code class="lang-csharp">public static string CamelCaseToHumanReadable(string value)
|
||||||
<dt>Inheritance</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<p><code>value</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<div><span class="xref">LanguageHelper</span></div>
|
<p>The value.</p>
|
||||||
</dd>
|
<h4 id="returns">Returns</h4>
|
||||||
</dl>
|
<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
|
||||||
<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
|
|
||||||
capitalized.</p>
|
capitalized.</p>
|
||||||
</div>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,626 +70,217 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.SecurityHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_SecurityHelper"> Class SecurityHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Helpers_SecurityHelper" data-uid="CapyKit.Helpers.SecurityHelper" class="text-break">
|
<p>A class that contains methods for managing secure data processing and cryptography.</p>
|
||||||
Class SecurityHelper
|
<pre><code class="lang-csharp">public class SecurityHelper
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<a href="CapyKit.Helpers.SecurityHelper.html">SecurityHelper</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>A class that contains methods for managing secure data processing and cryptography.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public class SecurityHelper</code></pre>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</div>
|
<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>.
|
||||||
<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>.
|
|
||||||
This method uses the specified password algorithm type <code class="typeparamref">T</code> to retrieve the hashed version
|
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>
|
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>existingPassword</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)</code></pre>
|
<p>The existing, encrypted password.</p>
|
||||||
</div>
|
<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>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><code>salt</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<dl class="parameters">
|
<p>The salt value used in password hashing.</p>
|
||||||
<dt><code>existingPassword</code> <a class="xref" href="CapyKit.Password.html">Password</a></dt>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<dd><p>The existing, encrypted password.</p>
|
<p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||||
</dd>
|
<h4 id="returns">Returns</h4>
|
||||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<dd><p>The unencrypted password to be compared.</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>
|
||||||
</dd>
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
<p><code>T</code></p>
|
||||||
<dd><p>The salt value used in password hashing.</p>
|
<p>The type of the password hashing algorithm.</p>
|
||||||
</dd>
|
<h3 id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_CapyKit_Password_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"> CompareHashedPassword(Password, string, byte[], IPasswordAlgorithm, params object[])</h3>
|
||||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
<p>Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
|
||||||
<dd><p>Additional arguments required for constructing the password algorithm instance.</p>
|
This method uses the specified <code class="paramref">algorithm</code> to retrieve the hashed version
|
||||||
</dd>
|
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.</p>
|
||||||
</dl>
|
<pre><code class="lang-csharp">public static bool CompareHashedPassword(Password existingPassword, string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||||
|
</code></pre>
|
||||||
<h4 class="section">Returns</h4>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<dl class="parameters">
|
<p><code>existingPassword</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
|
<p>The existing, encrypted password.</p>
|
||||||
<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>
|
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</dd>
|
<p>The unencrypted password to be compared.</p>
|
||||||
</dl>
|
<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>
|
||||||
<h4 class="section">Type Parameters</h4>
|
<p><code>algorithm</code> <a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||||
<dl class="parameters">
|
<p>The password hashing algorithm.</p>
|
||||||
<dt><code>T</code></dt>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<dd><p>The type of the password hashing algorithm.</p>
|
<p>Additional arguments required for constructing the password algorithm instance.</p>
|
||||||
</dd>
|
<h4 id="returns-1">Returns</h4>
|
||||||
</dl>
|
<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>
|
||||||
<a id="CapyKit_Helpers_SecurityHelper_CompareSessionID_" data-uid="CapyKit.Helpers.SecurityHelper.CompareSessionID*"></a>
|
<h4 id="returns-2">Returns</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<h3 id="CapyKit_Helpers_SecurityHelper_CompareSessionID_System_String_System_String_" data-uid="CapyKit.Helpers.SecurityHelper.CompareSessionID(System.String,System.String)">
|
<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>
|
||||||
CompareSessionID(string, string)
|
<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.
|
||||||
</h3>
|
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>
|
||||||
<div class="markdown level1 summary"><p>Compares two session identifiers.</p>
|
<pre><code class="lang-csharp">public static Password GetPassword<T>(string password, params object[] args)
|
||||||
</div>
|
</code></pre>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
|
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<div class="codewrapper">
|
<p>The plaintext password to be hashed.</p>
|
||||||
<pre><code class="lang-csharp hljs">public static bool CompareSessionID(string first, string second)</code></pre>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
</div>
|
<p>Optional constructor arguments for the <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation
|
||||||
|
instance.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<h4 id="returns-3">Returns</h4>
|
||||||
<dl class="parameters">
|
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||||
<dt><code>first</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p>A new <span class="xref">CapyKit.Password</span> object with the given password and a randomly generated salt, as well as an
|
||||||
<dd><p>The first session identifier.</p>
|
instance of <code class="typeparamref">T</code> created using any optional constructor arguments provided.</p>
|
||||||
</dd>
|
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||||
<dt><code>second</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p><code>T</code></p>
|
||||||
<dd><p>The second session identifier.</p>
|
<p>The type of <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation to use.</p>
|
||||||
</dd>
|
<h4 id="see-also">See Also</h4>
|
||||||
</dl>
|
<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>
|
||||||
<h4 class="section">Returns</h4>
|
<p>Retrieves a <span class="xref">CapyKit.Password</span> object using the specified password, salt, and optional
|
||||||
<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
|
|
||||||
constructor arguments.</p>
|
constructor arguments.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-4">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm</code></pre>
|
<p>The plaintext password to be hashed.</p>
|
||||||
</div>
|
<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
|
||||||
<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
|
|
||||||
password or passphrase. This is used to make each output different for the same input
|
password or passphrase. This is used to make each output different for the same input
|
||||||
thus adding security.</p>
|
thus adding security.</p>
|
||||||
</dd>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<dt><code>args</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt>
|
<p>Optional constructor arguments for the <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation
|
||||||
<dd><p>Optional constructor arguments for the <a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a> implementation
|
|
||||||
instance.</p>
|
instance.</p>
|
||||||
</dd>
|
<h4 id="returns-4">Returns</h4>
|
||||||
</dl>
|
<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
|
||||||
<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
|
|
||||||
of <code class="typeparamref">T</code> created using the provided constructor arguments.</p>
|
of <code class="typeparamref">T</code> created using the provided constructor arguments.</p>
|
||||||
</dd>
|
<h4 id="type-parameters-2">Type Parameters</h4>
|
||||||
</dl>
|
<p><code>T</code></p>
|
||||||
|
<p>The type of <span class="xref">CapyKit.IPasswordAlgorithm</span> implementation to use.</p>
|
||||||
<h4 class="section">Type Parameters</h4>
|
<h4 id="remarks">Remarks</h4>
|
||||||
<dl class="parameters">
|
<p>This method uses reflection to find a constructor for the specified password algorithm type (<code class="typeparamref">T</code>).
|
||||||
<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>).
|
|
||||||
It emits an error event if a suitable constructor is not found or if there is an error invoking the constructor.</p>
|
It emits an error event if a suitable constructor is not found or if there is an error invoking the constructor.</p>
|
||||||
</div>
|
<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>
|
||||||
<a id="CapyKit_Helpers_SecurityHelper_GetPassword_" data-uid="CapyKit.Helpers.SecurityHelper.GetPassword*"></a>
|
<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>
|
||||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Object___" data-uid="CapyKit.Helpers.SecurityHelper.GetPassword``1(System.String,System.Object[])">
|
<p><code>validCharacters</code> <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</p>
|
||||||
GetPassword<T>(string, params object[])
|
<p>An array of <span class="xref">CapyKit.Helpers.ValidCharacterCollection</span> enumeration values representing the desired
|
||||||
|
|
||||||
</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
|
|
||||||
character sets.</p>
|
character sets.</p>
|
||||||
</dd>
|
<h4 id="returns-5">Returns</h4>
|
||||||
</dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
|
<p>The password.</p>
|
||||||
<h4 class="section">Returns</h4>
|
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_"> GetRandomString(int)</h3>
|
||||||
<dl class="parameters">
|
<p>A convenience method to generate a random string of the specified length using all character sets.</p>
|
||||||
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<pre><code class="lang-csharp">public static string GetRandomString(int length)
|
||||||
<dd><p>The password.</p>
|
</code></pre>
|
||||||
</dd>
|
<h4 id="parameters-6">Parameters</h4>
|
||||||
</dl>
|
<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>
|
||||||
<a id="CapyKit_Helpers_SecurityHelper_GetRandomString_" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomString*"></a>
|
<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>
|
||||||
<h3 id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_" data-uid="CapyKit.Helpers.SecurityHelper.GetRandomString(System.Int32)">
|
<p><code>validChars</code> <a href="CapyKit.Helpers.ValidCharacterCollection.html">ValidCharacterCollection</a>[]</p>
|
||||||
GetRandomString(int)
|
<h4 id="returns-7">Returns</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</h3>
|
<p>The random string.</p>
|
||||||
|
<h3 id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32_"> GetSalt(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>
|
<p>Generates a random byte array that can act as a salt.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static byte[] GetSalt(int length = 32)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-8">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>length</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static string GetRandomString(int length)</code></pre>
|
<p>(Optional) The desired length of the generated byte array.</p>
|
||||||
</div>
|
<h4 id="returns-8">Returns</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<p>An array of byte.</p>
|
||||||
<dl class="parameters">
|
<h4 id="remarks-1">Remarks</h4>
|
||||||
<dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
<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
|
||||||
<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
|
|
||||||
entropy.</p>
|
entropy.</p>
|
||||||
</div>
|
<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>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
and <code class="paramref">salt</code>.</p>
|
and <code class="paramref">salt</code>.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static Password Pbkdf2(string password, byte[] salt)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-9">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static Password Pbkdf2(string password, byte[] salt)</code></pre>
|
<p>The clear text password to be hashed.</p>
|
||||||
</div>
|
<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 class="section">Parameters</h4>
|
<h4 id="returns-9">Returns</h4>
|
||||||
<dl class="parameters">
|
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<p>A new <span class="xref">CapyKit.Password</span> object containing the hashed password and salt.</p>
|
||||||
<dd><p>The clear text password to be hashed.</p>
|
<h4 id="remarks-2">Remarks</h4>
|
||||||
</dd>
|
<p>This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate
|
||||||
<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
|
|
||||||
a new password hash. The algorithm iteratively applies a pseudorandom function to the
|
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>
|
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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,305 +70,99 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.SerializationHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_SerializationHelper"> Class SerializationHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
<h1 id="CapyKit_Helpers_SerializationHelper" data-uid="CapyKit.Helpers.SerializationHelper" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class SerializationHelper
|
<pre><code class="lang-csharp">public static class SerializationHelper
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<a href="CapyKit.Helpers.SerializationHelper.html">SerializationHelper</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"></div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public static class SerializationHelper</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<pre><code class="lang-csharp">public static T Deserialize<T>(byte[] bytes)
|
||||||
<dt>Inheritance</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<p><code>bytes</code> <a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<div><span class="xref">SerializationHelper</span></div>
|
<p>The byte array representing a <code class="typeparamref">T</code> object.</p>
|
||||||
</dd>
|
<h4 id="returns">Returns</h4>
|
||||||
</dl>
|
<p>T</p>
|
||||||
|
<p>A <code class="typeparamref">T</code> object.</p>
|
||||||
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
|
<p><code>T</code></p>
|
||||||
<dl class="typelist inheritedMembers">
|
<p>Generic type parameter.</p>
|
||||||
<dt>Inherited Members</dt>
|
<h4 id="exceptions">Exceptions</h4>
|
||||||
<dd>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></p>
|
||||||
<div>
|
<p>Thrown when the format of the byte array is incorrect.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_IO_Stream_"> Deserialize<T>(Stream)</h3>
|
||||||
</div>
|
<p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public static T Deserialize<T>(Stream stream)
|
||||||
<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>
|
</code></pre>
|
||||||
</div>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<div>
|
<p><code>stream</code> <a href="https://learn.microsoft.com/dotnet/api/system.io.stream">Stream</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<p>The steam.</p>
|
||||||
</div>
|
<h4 id="returns-1">Returns</h4>
|
||||||
<div>
|
<p>T</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<p>A <code class="typeparamref">T</code> object.</p>
|
||||||
</div>
|
<h4 id="type-parameters-1">Type Parameters</h4>
|
||||||
<div>
|
<p><code>T</code></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<p>Generic type parameter.</p>
|
||||||
</div>
|
<h4 id="exceptions-1">Exceptions</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.formatexception">FormatException</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<p>Thrown when the format of an input is incorrect.</p>
|
||||||
</div>
|
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_String_"> Deserialize<T>(string)</h3>
|
||||||
<div>
|
<p>Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
<pre><code class="lang-csharp">public static T Deserialize<T>(string str)
|
||||||
</div>
|
</code></pre>
|
||||||
</dd></dl>
|
<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>
|
||||||
<h2 class="section" id="methods">Methods
|
<p><code>T</code></p>
|
||||||
</h2>
|
<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>
|
||||||
<a id="CapyKit_Helpers_SerializationHelper_Deserialize_" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize*"></a>
|
<pre><code class="lang-csharp">public static byte[] SerializeToBytes(object obj)
|
||||||
|
</code></pre>
|
||||||
<h3 id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___" data-uid="CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])">
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
Deserialize<T>(byte[])
|
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||||
|
<p>The object.</p>
|
||||||
</h3>
|
<h4 id="returns-3">Returns</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<div class="markdown level1 summary"><p>Deserializes an object to a given <code class="typeparamref">T</code> type.</p>
|
<p>A <code>JSON</code> encoded string.</p>
|
||||||
</div>
|
<h3 id="CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_"> SerializeToString(object)</h3>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<p>Serializes an object to a <code>JSON</code> encoded string.</p>
|
||||||
|
<pre><code class="lang-csharp">public static string SerializeToString(object obj)
|
||||||
<div class="codewrapper">
|
</code></pre>
|
||||||
<pre><code class="lang-csharp hljs">public static T Deserialize<T>(byte[] bytes)</code></pre>
|
<h4 id="parameters-4">Parameters</h4>
|
||||||
</div>
|
<p><code>obj</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a></p>
|
||||||
|
<p>The object.</p>
|
||||||
<h4 class="section">Parameters</h4>
|
<h4 id="returns-4">Returns</h4>
|
||||||
<dl class="parameters">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<dt><code>bytes</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
<p>A <code>JSON</code> encoded string.</p>
|
||||||
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,70 +70,29 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.SettingsHelper">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_SettingsHelper"> Class SettingsHelper</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.Helpers.html">CapyKit.Helpers</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Helpers_SettingsHelper" data-uid="CapyKit.Helpers.SettingsHelper" class="text-break">
|
<p>Static class containing helper methods for retrieving and setting application settings.</p>
|
||||||
Class SettingsHelper
|
<pre><code class="lang-csharp">public static class SettingsHelper
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a>.<a class="xref" href="CapyKit.Helpers.html">Helpers</a></dd></dl>
|
<a href="CapyKit.Helpers.SettingsHelper.html">SettingsHelper</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>Static class containing helper methods for retrieving and setting application settings.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public static class SettingsHelper</code></pre>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
</div>
|
<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
|
||||||
|
|
||||||
|
|
||||||
<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
|
|
||||||
detector methods that read from an App.config file. The setup is done at the beginning of the
|
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>
|
application execution, before any other usage of the helper methods.</p>
|
||||||
<pre><code class="lang-csharp">public int main(string[] args)
|
<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");
|
int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
||||||
Console.WriteLine("Retrieved setting: {0}", mySetting);
|
Console.WriteLine("Retrieved setting: {0}", mySetting);
|
||||||
}</code></pre>
|
}</code></pre>
|
||||||
|
<h2 id="remarks">Remarks</h2>
|
||||||
|
<p>The specific means of accessing and storing the settings are determined by the consumer,
|
||||||
<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,
|
|
||||||
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
|
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
|
||||||
.</p>
|
.</p>
|
||||||
</div>
|
<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>
|
||||||
<h2 class="section" id="methods">Methods
|
<pre><code class="lang-csharp">public static T GetApplicationSetting<T>(string settingName)
|
||||||
</h2>
|
</code></pre>
|
||||||
|
<h4 id="parameters">Parameters</h4>
|
||||||
|
<p><code>settingName</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<a id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting_" data-uid="CapyKit.Helpers.SettingsHelper.GetApplicationSetting*"></a>
|
<p>The name of the setting to retrieve.</p>
|
||||||
|
<h4 id="returns">Returns</h4>
|
||||||
<h3 id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_" data-uid="CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)">
|
<p>T</p>
|
||||||
GetApplicationSetting<T>(string)
|
<p>The value of the setting as an uncast <code class="typeparamref">T</code>.</p>
|
||||||
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
</h3>
|
<p><code>T</code></p>
|
||||||
|
<p>The type of the setting to be retrieved.</p>
|
||||||
<div class="markdown level1 summary"><p>Retrieves a setting with the given <code>key</code>.</p>
|
<h3 id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__"> SetAccessorMethod(Func<string, object>)</h3>
|
||||||
</div>
|
<p>Sets the function used to retrieve application settings.</p>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<pre><code class="lang-csharp">public static void SetAccessorMethod(Func<string, object> accessor)
|
||||||
|
</code></pre>
|
||||||
<div class="codewrapper">
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<pre><code class="lang-csharp hljs">public static T GetApplicationSetting<T>(string settingName)</code></pre>
|
<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>
|
||||||
</div>
|
<p>The new function used to retrieve application settings.</p>
|
||||||
|
<h4 id="exceptions">Exceptions</h4>
|
||||||
<h4 class="section">Parameters</h4>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||||
<dl class="parameters">
|
<p>Thrown when one or more required arguments are null.</p>
|
||||||
<dt><code>settingName</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
<h3 id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__"> SetDetectorMethod(Func<string, bool>)</h3>
|
||||||
<dd><p>The name of the setting to retrieve.</p>
|
<p>Sets the function used to detect if an application setting with a given <code>key</code> exists.</p>
|
||||||
</dd>
|
<pre><code class="lang-csharp">public static void SetDetectorMethod(Func<string, bool> detector)
|
||||||
</dl>
|
</code></pre>
|
||||||
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
<h4 class="section">Returns</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>
|
||||||
<dl class="parameters">
|
<p>The new function used to detect if an application setting exists.</p>
|
||||||
<dt><span class="xref">T</span></dt>
|
<h4 id="exceptions-1">Exceptions</h4>
|
||||||
<dd><p>The value of the setting as an uncast <code class="typeparamref">T</code>.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></p>
|
||||||
</dd>
|
<p>Thrown when one or more required arguments are null.</p>
|
||||||
</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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,96 +70,39 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers.ValidCharacterCollection">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers_ValidCharacterCollection"> Enum ValidCharacterCollection</h1>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,76 +70,36 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Helpers">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Helpers"> Namespace CapyKit.Helpers</h1>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,183 +70,59 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.IPasswordAlgorithm">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_IPasswordAlgorithm"> Interface IPasswordAlgorithm</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_IPasswordAlgorithm" data-uid="CapyKit.IPasswordAlgorithm" class="text-break">
|
<p>Defines the contract for password encryption algorithms.</p>
|
||||||
Interface IPasswordAlgorithm
|
<pre><code class="lang-csharp">public interface IPasswordAlgorithm
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
<div class="facts text-secondary">
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<IPasswordAlgorithm>(IPasswordAlgorithm, IPasswordAlgorithm)</a>,
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<h2 id="properties">Properties</h2>
|
||||||
</div>
|
<h3 id="CapyKit_IPasswordAlgorithm_AlgorithmName"> AlgorithmName</h3>
|
||||||
|
<p>Gets the name of the algorithm.</p>
|
||||||
<div class="markdown summary"><p>Defines the contract for password encryption algorithms.</p>
|
<pre><code class="lang-csharp">string AlgorithmName { get; }
|
||||||
</div>
|
</code></pre>
|
||||||
<div class="markdown conceptual"></div>
|
<h4 id="property-value">Property Value</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<div class="codewrapper">
|
<h2 id="methods">Methods</h2>
|
||||||
<pre><code class="lang-csharp hljs">public interface IPasswordAlgorithm</code></pre>
|
<h3 id="CapyKit_IPasswordAlgorithm_Compare_System_String_System_Byte___System_Object___"> Compare(string, byte[], params object[])</h3>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist extensionMethods">
|
<p>Additional arguments for the encryption process, such as salt and length.</p>
|
||||||
<dt>Extension Methods</dt>
|
<h4 id="returns">Returns</h4>
|
||||||
<dd>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<div>
|
<p>True if the given <code class="paramref">password</code> matches the <code class="paramref">encryptedValue</code>,
|
||||||
<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>,
|
|
||||||
false if they are different.</p>
|
false if they are different.</p>
|
||||||
</dd>
|
<h3 id="CapyKit_IPasswordAlgorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||||
</dl>
|
<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>
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,416 +70,109 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Password">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Password"> Class Password</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
<h1 id="CapyKit_Password" data-uid="CapyKit.Password" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class Password
|
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public class Password
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Password.html">Password</a></p>
|
||||||
</div>
|
<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>,
|
||||||
<div class="markdown summary"><p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
</div>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<pre><code class="lang-csharp hljs">public class Password</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<p>Constructor.</p>
|
||||||
<dt>Inheritance</dt>
|
<pre><code class="lang-csharp">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||||
<dd>
|
</code></pre>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<div><span class="xref">Password</span></div>
|
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</dd>
|
<p>The password to be hashed.</p>
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<dt>Inherited Members</dt>
|
<p>A variable-length parameters list containing arguments to include for the <code class="paramref">algorithm</code>.</p>
|
||||||
<dd>
|
<h2 id="properties">Properties</h2>
|
||||||
<div>
|
<h3 id="CapyKit_Password_Algorithm"> Algorithm</h3>
|
||||||
<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>
|
<p>Gets or sets the algorithm used for password encryption.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public IPasswordAlgorithm Algorithm { get; }
|
||||||
<div>
|
</code></pre>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<h4 id="property-value">Property Value</h4>
|
||||||
</div>
|
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||||
<div>
|
<h3 id="CapyKit_Password_Hash"> Hash</h3>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<p>Gets or sets the hash of the password.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public byte[] Hash { get; }
|
||||||
<div>
|
</code></pre>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<h4 id="property-value-1">Property Value</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<div>
|
<h3 id="CapyKit_Password_Pbkdf2Algorithm"> Pbkdf2Algorithm</h3>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<p>Gets the preconfigured PBKDF2 algorithm.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static Pbkdf2Algorithm Pbkdf2Algorithm { get; }
|
||||||
</dd></dl>
|
</code></pre>
|
||||||
|
<h4 id="property-value-2">Property Value</h4>
|
||||||
<dl class="typelist extensionMethods">
|
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||||
<dt>Extension Methods</dt>
|
<h3 id="CapyKit_Password_Salt"> Salt</h3>
|
||||||
<dd>
|
<p>Gets or sets the salt used for encryption.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public byte[] Salt { get; }
|
||||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<T>(T, T)</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="property-value-3">Property Value</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</p>
|
||||||
<a class="xref" href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a>
|
<h2 id="methods">Methods</h2>
|
||||||
</div>
|
<h3 id="CapyKit_Password_Equals_System_Object_"> Equals(object?)</h3>
|
||||||
</dd></dl>
|
<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>
|
||||||
<h2 class="section" id="constructors">Constructors
|
<h4 id="returns">Returns</h4>
|
||||||
</h2>
|
<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>
|
||||||
<a id="CapyKit_Password__ctor_" data-uid="CapyKit.Password.#ctor*"></a>
|
<p>Returns a string that represents the current object.</p>
|
||||||
|
<pre><code class="lang-csharp">public override string ToString()
|
||||||
<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[])">
|
</code></pre>
|
||||||
Password(string, byte[], IPasswordAlgorithm, params object[])
|
<h4 id="returns-1">Returns</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</h3>
|
<p>A string that represents the current object.</p>
|
||||||
|
<h2 id="operators">Operators</h2>
|
||||||
<div class="markdown level1 summary"><p>Constructor.</p>
|
<h3 id="CapyKit_Password_op_Equality_CapyKit_Password_CapyKit_Password_"> operator ==(Password, Password)</h3>
|
||||||
</div>
|
<pre><code class="lang-csharp">public static bool operator ==(Password a, Password b)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public Password(string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)</code></pre>
|
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||||
</div>
|
<h4 id="returns-2">Returns</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<h4 class="section">Parameters</h4>
|
<h3 id="CapyKit_Password_op_Inequality_CapyKit_Password_CapyKit_Password_"> operator !=(Password, Password)</h3>
|
||||||
<dl class="parameters">
|
<pre><code class="lang-csharp">public static bool operator !=(Password a, Password b)
|
||||||
<dt><code>password</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
|
</code></pre>
|
||||||
<dd><p>The password to be hashed.</p>
|
<h4 id="parameters-3">Parameters</h4>
|
||||||
</dd>
|
<p><code>a</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||||
<dt><code>salt</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt>
|
<p><code>b</code> <a href="CapyKit.Password.html">Password</a></p>
|
||||||
<dd><p>The salt used for encryption.</p>
|
<h4 id="returns-3">Returns</h4>
|
||||||
</dd>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<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>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,279 +70,80 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Pbkdf2Algorithm">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Pbkdf2Algorithm"> Class Pbkdf2Algorithm</h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
<h1 id="CapyKit_Pbkdf2Algorithm" data-uid="CapyKit.Pbkdf2Algorithm" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class Pbkdf2Algorithm
|
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public class Pbkdf2Algorithm : IPasswordAlgorithm
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||||
</div>
|
<h4 id="implements">Implements</h4>
|
||||||
|
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||||
<div class="markdown summary"><p>Implements the PBKDF2 algorithm for password encryption.</p>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
<pre><code class="lang-csharp hljs">public class Pbkdf2Algorithm : IPasswordAlgorithm</code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||||
</div>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<h2 id="constructors">Constructors</h2>
|
||||||
<dt>Inheritance</dt>
|
<h3 id="CapyKit_Pbkdf2Algorithm__ctor"> Pbkdf2Algorithm()</h3>
|
||||||
<dd>
|
<p>Default constructor.</p>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<pre><code class="lang-csharp">public Pbkdf2Algorithm()
|
||||||
<div><span class="xref">Pbkdf2Algorithm</span></div>
|
</code></pre>
|
||||||
</dd>
|
<h2 id="fields">Fields</h2>
|
||||||
</dl>
|
<h3 id="CapyKit_Pbkdf2Algorithm_ITERATIONS"> ITERATIONS</h3>
|
||||||
|
<p>The default number of iterations.</p>
|
||||||
<dl class="typelist implements">
|
<pre><code class="lang-csharp">public const int ITERATIONS = 100000
|
||||||
<dt>Implements</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="field-value">Field Value</h4>
|
||||||
<div><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
</dd>
|
<h4 id="remarks">Remarks</h4>
|
||||||
</dl>
|
<p>This member is immutable.</p>
|
||||||
|
<h3 id="CapyKit_Pbkdf2Algorithm_LENGTH"> LENGTH</h3>
|
||||||
|
<p>(Immutable) The default length.</p>
|
||||||
<dl class="typelist inheritedMembers">
|
<pre><code class="lang-csharp">public const int LENGTH = 32
|
||||||
<dt>Inherited Members</dt>
|
</code></pre>
|
||||||
<dd>
|
<h4 id="field-value-1">Field Value</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<h4 id="remarks-1">Remarks</h4>
|
||||||
</div>
|
<p>This member is immutable.</p>
|
||||||
<div>
|
<h2 id="properties">Properties</h2>
|
||||||
<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>
|
<h3 id="CapyKit_Pbkdf2Algorithm_AlgorithmName"> AlgorithmName</h3>
|
||||||
</div>
|
<p>Gets the name of the algorithm.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public string AlgorithmName { get; }
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="property-value">Property Value</h4>
|
||||||
<div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
<h2 id="methods">Methods</h2>
|
||||||
</div>
|
<h3 id="CapyKit_Pbkdf2Algorithm_Encrypt_System_String_System_Object___"> Encrypt(string, params object[])</h3>
|
||||||
<div>
|
<p>Encrypts the given password using a PBKDF2 algorithm.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
|
<pre><code class="lang-csharp">public byte[] Encrypt(string password, params object[] args)
|
||||||
</div>
|
</code></pre>
|
||||||
<div>
|
<h4 id="parameters">Parameters</h4>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<p><code>password</code> <a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
</div>
|
<p>The plaintext password.</p>
|
||||||
<div>
|
<p><code>args</code> <a href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
|
<p>Additional arguments for the encryption process, specifically</p>
|
||||||
</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>
|
|
||||||
<ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
|
<ol><li><code>salt</code></li><li><code>length</code></li><li><code>iterations</code></li></ol>
|
||||||
</dd>
|
<h4 id="returns">Returns</h4>
|
||||||
</dl>
|
<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>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,276 +70,83 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.Pool`1">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_Pool_1"> Class Pool<T></h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_Pool_1" data-uid="CapyKit.Pool`1" class="text-break">
|
<p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||||
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
|
|
||||||
objects of type <code class="typeparamref">T</code>.</p>
|
objects of type <code class="typeparamref">T</code>.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public class Pool<T>
|
||||||
<div class="markdown conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>T</code></p>
|
||||||
<pre><code class="lang-csharp hljs">public class Pool<T></code></pre>
|
<p>The type of objects to be managed by the pool.</p>
|
||||||
</div>
|
<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>
|
||||||
<h4 class="section">Type Parameters</h4>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||||
<dl class="parameters">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object?, object?)</a>,
|
||||||
<dt><code>T</code></dt>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<dd><p>The type of objects to be managed by the pool.</p>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
</dd>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>,
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritance">
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
<dt>Inheritance</dt>
|
<p><a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_">ObjectExtensions.UpdateProperties<Pool<T>>(Pool<T>, Pool<T>)</a>,
|
||||||
<dd>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<h2 id="constructors">Constructors</h2>
|
||||||
<div><span class="xref">Pool<T></span></div>
|
<h3 id="CapyKit_Pool_1__ctor_System_Int32_"> Pool(int)</h3>
|
||||||
</dd>
|
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size.</p>
|
||||||
</dl>
|
<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>
|
||||||
<dl class="typelist inheritedMembers">
|
<p>The size of the pool.</p>
|
||||||
<dt>Inherited Members</dt>
|
<h3 id="CapyKit_Pool_1__ctor_System_Int32_System_Func__0__"> Pool(int, Func<T>)</h3>
|
||||||
<dd>
|
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified pool size
|
||||||
<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
|
|
||||||
and constructor selector.</p>
|
and constructor selector.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public Pool(int poolSize, Func<T> constructorSelector)
|
||||||
<div class="markdown level1 conceptual"></div>
|
</code></pre>
|
||||||
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
<div class="codewrapper">
|
<p><code>poolSize</code> <a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public Pool(int poolSize, Func<T> constructorSelector)</code></pre>
|
<p>The size of the pool.</p>
|
||||||
</div>
|
<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>
|
||||||
<h4 class="section">Parameters</h4>
|
<h3 id="CapyKit_Pool_1__ctor_System_Collections_Generic_IEnumerable__0__"> Pool(IEnumerable<T>)</h3>
|
||||||
<dl class="parameters">
|
<p>Initializes a new instance of the <span class="xref">CapyKit.Pool`1</span> class with the specified collection
|
||||||
<dt><code>poolSize</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
|
of items.</p>
|
||||||
<dd><p>The size of the pool.</p>
|
<pre><code class="lang-csharp">public Pool(IEnumerable<T> collection)
|
||||||
</dd>
|
</code></pre>
|
||||||
<dt><code>constructorSelector</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a><T></dt>
|
<h4 id="parameters-2">Parameters</h4>
|
||||||
<dd><p>The constructor selector used to create new instances of <code class="typeparamref">T</code>.</p>
|
<p><code>collection</code> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1">IEnumerable</a><T></p>
|
||||||
</dd>
|
<p>The collection of <code class="typeparamref">T</code> items with which to seed the pool.</p>
|
||||||
</dl>
|
<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>
|
||||||
<h2 class="section" id="methods">Methods
|
<p><code>item</code> <a href="CapyKit.PoolItem-1.html">PoolItem</a><T></p>
|
||||||
</h2>
|
<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
|
||||||
<a id="CapyKit_Pool_1_GetAvailableItem_" data-uid="CapyKit.Pool`1.GetAvailableItem*"></a>
|
it can be retrieved by <span class="xref">CapyKit.Pool`1.GetAvailableItem</span>.</p>
|
||||||
|
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,327 +70,86 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.PoolItem`1">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_PoolItem_1"> Class PoolItem<T></h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
<h1 id="CapyKit_PoolItem_1" data-uid="CapyKit.PoolItem`1" class="text-break">
|
Assembly: CapyKit.dll</p>
|
||||||
Class PoolItem<T>
|
<p>A pool item. This class cannot be inherited.</p>
|
||||||
</h1>
|
<pre><code class="lang-csharp">public sealed class PoolItem<T>
|
||||||
|
</code></pre>
|
||||||
<div class="facts text-secondary">
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
<p><code>T</code></p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<p>The type of the pooled item.</p>
|
||||||
</div>
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
<div class="markdown summary"><p>A pool item. This class cannot be inherited.</p>
|
<a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||||
</div>
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
<div class="markdown conceptual"></div>
|
<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>,
|
||||||
<div class="codewrapper">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>,
|
||||||
<pre><code class="lang-csharp hljs">public sealed class PoolItem<T></code></pre>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>,
|
||||||
</div>
|
<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>,
|
||||||
<h4 class="section">Type Parameters</h4>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<dl class="parameters">
|
<h2 id="properties">Properties</h2>
|
||||||
<dt><code>T</code></dt>
|
<h3 id="CapyKit_PoolItem_1_Index"> Index</h3>
|
||||||
<dd><p>The type of the pooled item.</p>
|
<p>Gets the zero-based index of the pooled item.</p>
|
||||||
</dd>
|
<pre><code class="lang-csharp">public int Index { get; }
|
||||||
</dl>
|
</code></pre>
|
||||||
|
<h4 id="property-value">Property Value</h4>
|
||||||
<dl class="typelist inheritance">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></p>
|
||||||
<dt>Inheritance</dt>
|
<h3 id="CapyKit_PoolItem_1_Item"> Item</h3>
|
||||||
<dd>
|
<p>Gets the pooled resource.</p>
|
||||||
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
|
<pre><code class="lang-csharp">public T Item { get; }
|
||||||
<div><span class="xref">PoolItem<T></span></div>
|
</code></pre>
|
||||||
</dd>
|
<h4 id="property-value-1">Property Value</h4>
|
||||||
</dl>
|
<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; }
|
||||||
<dl class="typelist inheritedMembers">
|
</code></pre>
|
||||||
<dt>Inherited Members</dt>
|
<h4 id="property-value-2">Property Value</h4>
|
||||||
<dd>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<div>
|
<h3 id="CapyKit_PoolItem_1_TypeName"> TypeName</h3>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
|
<p>Gets the name of the <span class="xref">System.Type</span> of the pooled item.</p>
|
||||||
</div>
|
<pre><code class="lang-csharp">public string TypeName { get; }
|
||||||
<div>
|
</code></pre>
|
||||||
<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>
|
<h4 id="property-value-3">Property Value</h4>
|
||||||
</div>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.string">string</a></p>
|
||||||
<div>
|
<h2 id="methods">Methods</h2>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
|
<h3 id="CapyKit_PoolItem_1_ReleaseLock"> ReleaseLock()</h3>
|
||||||
</div>
|
<p>Releases the lock on the item.</p>
|
||||||
<div>
|
<pre><code class="lang-csharp">public void ReleaseLock()
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
|
</code></pre>
|
||||||
</div>
|
<h4 id="remarks">Remarks</h4>
|
||||||
<div>
|
<p>If the item is not locked, an error event is emitted.</p>
|
||||||
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
|
<h3 id="CapyKit_PoolItem_1_SetLock"> SetLock()</h3>
|
||||||
</div>
|
<p>Sets the lock on the item indicating that it is in use.</p>
|
||||||
</dd></dl>
|
<pre><code class="lang-csharp">public bool SetLock()
|
||||||
|
</code></pre>
|
||||||
<dl class="typelist extensionMethods">
|
<h4 id="returns">Returns</h4>
|
||||||
<dt>Extension Methods</dt>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<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
|
||||||
<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
|
|
||||||
fails.</p>
|
fails.</p>
|
||||||
</dd>
|
<h4 id="remarks-1">Remarks</h4>
|
||||||
</dl>
|
<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>
|
||||||
<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>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,11 +2,11 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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="icon" href="../favicon.ico">
|
||||||
<link rel="stylesheet" href="../public/docfx.min.css">
|
<link rel="stylesheet" href="../public/docfx.min.css">
|
||||||
<link rel="stylesheet" href="../public/main.css">
|
<link rel="stylesheet" href="../public/main.css">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,95 +70,37 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<article data-uid="CapyKit.PropertyComparer`2">
|
<article data-uid="">
|
||||||
|
<h1 id="CapyKit_PropertyComparer_2"> Class PropertyComparer<T, U></h1>
|
||||||
|
|
||||||
|
<p>Namespace: <a href="CapyKit.html">CapyKit</a><br>
|
||||||
|
Assembly: CapyKit.dll</p>
|
||||||
<h1 id="CapyKit_PropertyComparer_2" data-uid="CapyKit.PropertyComparer`2" class="text-break">
|
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||||
Class PropertyComparer<T, U>
|
<pre><code class="lang-csharp">public class PropertyComparer<T, U> : IEqualityComparer<T>
|
||||||
</h1>
|
</code></pre>
|
||||||
|
<h4 id="type-parameters">Type Parameters</h4>
|
||||||
<div class="facts text-secondary">
|
<p><code>T</code></p>
|
||||||
<dl><dt>Namespace</dt><dd><a class="xref" href="CapyKit.html">CapyKit</a></dd></dl>
|
<p>Generic type parameter of the parent object.</p>
|
||||||
<dl><dt>Assembly</dt><dd>CapyKit.dll</dd></dl>
|
<p><code>U</code></p>
|
||||||
</div>
|
<p>Generic type parameter of the property value.</p>
|
||||||
|
<h4 id="inheritance">Inheritance</h4>
|
||||||
<div class="markdown summary"><p>A object comparer that can accept a lambda expression to compare properties.</p>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object">object</a> ←
|
||||||
</div>
|
<a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||||
<div class="markdown conceptual"></div>
|
<h4 id="implements">Implements</h4>
|
||||||
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.iequalitycomparer-1">IEqualityComparer<T></a></p>
|
||||||
<div class="codewrapper">
|
<h4 id="inherited-members">Inherited Members</h4>
|
||||||
<pre><code class="lang-csharp hljs">public class PropertyComparer<T, U> : IEqualityComparer<T></code></pre>
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object?)</a>,
|
||||||
</div>
|
<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>,
|
||||||
<h4 class="section">Type Parameters</h4>
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object?, object?)</a>,
|
||||||
<dl class="parameters">
|
<a href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></p>
|
||||||
<dt><code>T</code></dt>
|
<h4 id="extension-methods">Extension Methods</h4>
|
||||||
<dd><p>Generic type parameter of the parent object.</p>
|
<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>,
|
||||||
</dd>
|
<a href="CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_">ObjectExtensions.UpdateProperties(object, object)</a></p>
|
||||||
<dt><code>U</code></dt>
|
<h2 id="examples">Examples</h2>
|
||||||
<dd><p>Generic type parameter of the property value.</p>
|
<p>using System;
|
||||||
</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;
|
|
||||||
using System.Collections.Generic;
|
using System.Collections.Generic;
|
||||||
using System.Linq;</p>
|
using System.Linq;</p>
|
||||||
<p>class Program
|
<p>class Program
|
||||||
|
|
@ -185,147 +127,50 @@ Person { Name = "Charlie", Age = 35 }
|
||||||
public string Name { get; set; }
|
public string Name { get; set; }
|
||||||
public int Age { get; set; }
|
public int Age { get; set; }
|
||||||
}</p>
|
}</p>
|
||||||
|
<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)
|
||||||
<h2 class="section" id="constructors">Constructors
|
</code></pre>
|
||||||
</h2>
|
<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>
|
||||||
<a id="CapyKit_PropertyComparer_2__ctor_" data-uid="CapyKit.PropertyComparer`2.#ctor*"></a>
|
<h2 id="methods">Methods</h2>
|
||||||
|
<h3 id="CapyKit_PropertyComparer_2_Equals__0__0_"> Equals(T, T)</h3>
|
||||||
<h3 id="CapyKit_PropertyComparer_2__ctor_System_Func__0__1__" data-uid="CapyKit.PropertyComparer`2.#ctor(System.Func{`0,`1})">
|
<p>Determines whether the specified properties are equal.</p>
|
||||||
PropertyComparer(Func<T, U>)
|
<pre><code class="lang-csharp">public bool Equals(T x, T y)
|
||||||
|
</code></pre>
|
||||||
</h3>
|
<h4 id="parameters-1">Parameters</h4>
|
||||||
|
<p><code>x</code> T</p>
|
||||||
<div class="markdown level1 summary"><p>Constructor.</p>
|
<p>The first object of type <code class="typeparamref">T</code> to compare.</p>
|
||||||
</div>
|
<p><code>y</code> T</p>
|
||||||
<div class="markdown level1 conceptual"></div>
|
<p>The second object of type <code class="typeparamref">T</code> to compare.</p>
|
||||||
|
<h4 id="returns">Returns</h4>
|
||||||
<div class="codewrapper">
|
<p><a href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></p>
|
||||||
<pre><code class="lang-csharp hljs">public PropertyComparer(Func<T, U> expression)</code></pre>
|
<p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified objects are equal; otherwise,
|
||||||
</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,
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p>
|
||||||
</dd>
|
<h3 id="CapyKit_PropertyComparer_2_GetHashCode__0_"> GetHashCode(T)</h3>
|
||||||
</dl>
|
<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
|
||||||
<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
|
|
||||||
<code class="paramref">obj</code> is
|
<code class="paramref">obj</code> is
|
||||||
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
|
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a>.</p>
|
||||||
</dd>
|
|
||||||
</dl>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,9 +2,9 @@
|
||||||
<html>
|
<html>
|
||||||
<head>
|
<head>
|
||||||
<meta charset="utf-8">
|
<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="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">
|
<link rel="icon" href="../favicon.ico">
|
||||||
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
</head>
|
</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">
|
<header class="bg-body border-bottom">
|
||||||
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
|
||||||
<div class="container-xxl flex-nowrap">
|
<div class="container-xxl flex-nowrap">
|
||||||
|
|
@ -70,99 +70,53 @@
|
||||||
<nav id="breadcrumb"></nav>
|
<nav id="breadcrumb"></nav>
|
||||||
</div>
|
</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>
|
<h3 id="namespaces">Namespaces</h3>
|
||||||
<div class="markdown level0 summary"></div>
|
<p><a href="CapyKit.Attributes.html">CapyKit.Attributes</a></p>
|
||||||
<div class="markdown level0 conceptual"></div>
|
<p><a href="CapyKit.Enumerations.html">CapyKit.Enumerations</a></p>
|
||||||
<div class="markdown level0 remarks"></div>
|
<p><a href="CapyKit.Extensions.html">CapyKit.Extensions</a></p>
|
||||||
|
<p><a href="CapyKit.Helpers.html">CapyKit.Helpers</a></p>
|
||||||
<h3 id="classes">
|
<h3 id="classes">Classes</h3>
|
||||||
Classes
|
<p><a href="CapyKit.CapyEventArgs.html">CapyEventArgs</a></p>
|
||||||
</h3>
|
<p>The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||||
<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
|
|
||||||
method name information.</p>
|
method name information.</p>
|
||||||
</dd>
|
<p><a href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></p>
|
||||||
</dl>
|
<p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
||||||
<dl class="jumplist">
|
<p><a href="CapyKit.Color.html">Color</a></p>
|
||||||
<dt><a class="xref" href="CapyKit.CapyEventReporter.html">CapyEventReporter</a></dt>
|
<p>An object representing a color.</p>
|
||||||
<dd><p>The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.</p>
|
<p><a href="CapyKit.EncryptedValue-1.html">EncryptedValue<T></a></p>
|
||||||
</dd>
|
<p><a href="CapyKit.Password.html">Password</a></p>
|
||||||
</dl>
|
<p>Represents a password with its hash, salt and algorithm used for encryption.</p>
|
||||||
<dl class="jumplist">
|
<p><a href="CapyKit.Pbkdf2Algorithm.html">Pbkdf2Algorithm</a></p>
|
||||||
<dt><a class="xref" href="CapyKit.Color.html">Color</a></dt>
|
<p>Implements the PBKDF2 algorithm for password encryption.</p>
|
||||||
<dd><p>An object representing a color.</p>
|
<p><a href="CapyKit.Pool-1.html">Pool<T></a></p>
|
||||||
</dd>
|
<p>A managed pool of resources. This class provides a thread-safe way to manage a collection of
|
||||||
</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
|
|
||||||
objects of type <code class="typeparamref">T</code>.</p>
|
objects of type <code class="typeparamref">T</code>.</p>
|
||||||
</dd>
|
<p><a href="CapyKit.PoolItem-1.html">PoolItem<T></a></p>
|
||||||
</dl>
|
<p>A pool item. This class cannot be inherited.</p>
|
||||||
<dl class="jumplist">
|
<p><a href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></p>
|
||||||
<dt><a class="xref" href="CapyKit.PropertyComparer-2.html">PropertyComparer<T, U></a></dt>
|
<p>A object comparer that can accept a lambda expression to compare properties.</p>
|
||||||
<dd><p>A object comparer that can accept a lambda expression to compare properties.</p>
|
<h3 id="interfaces">Interfaces</h3>
|
||||||
</dd>
|
<p><a href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></p>
|
||||||
</dl>
|
<p>Defines the contract for password encryption algorithms.</p>
|
||||||
<h3 id="interfaces">
|
<h3 id="enums">Enums</h3>
|
||||||
Interfaces
|
<p><a href="CapyKit.EventLevel.html">EventLevel</a></p>
|
||||||
</h3>
|
<p>Enumeration representing different event level severity values.</p>
|
||||||
<dl class="jumplist">
|
<p><a href="CapyKit.NamedColor.html">NamedColor</a></p>
|
||||||
<dt><a class="xref" href="CapyKit.IPasswordAlgorithm.html">IPasswordAlgorithm</a></dt>
|
<p>Enum representing a set of named colors with their corresponding HEX values. These colors are
|
||||||
<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
|
|
||||||
inspired by the XKCD color palette (<a href="https://xkcd.com/color/rgb/" target="_blank">Link</a>).</p>
|
inspired by the XKCD color palette (<a href="https://xkcd.com/color/rgb/" target="_blank">Link</a>).</p>
|
||||||
</dd>
|
<h3 id="delegates">Delegates</h3>
|
||||||
</dl>
|
<p><a href="CapyKit.CapyEventHandler.html">CapyEventHandler</a></p>
|
||||||
<h3 id="delegates">
|
<p>A delegate representing an event handler that accepts a <span class="xref">CapyKit.CapyEventArgs</span> instance.</p>
|
||||||
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>
|
|
||||||
|
|
||||||
|
|
||||||
</article>
|
</article>
|
||||||
|
|
||||||
<div class="contribution d-print-none">
|
<div class="contribution d-print-none">
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<div class="next-article d-print-none border-top" id="nextArticle"></div>
|
||||||
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -18,10 +18,10 @@
|
||||||
|
|
||||||
<ul class="nav level2">
|
<ul class="nav level2">
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
<a href="CapyKit.html" name="" title="Classes">Classes</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.CapyEventHandler.html" name="" title="CapyEventHandler">CapyEventHandler</a>
|
<a href="CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
<a href="CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
||||||
|
|
@ -32,30 +32,42 @@
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
<a href="CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
||||||
</li>
|
</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>
|
<li>
|
||||||
<a href="CapyKit.Password.html" name="" title="Password">Password</a>
|
<a href="CapyKit.Password.html" name="" title="Password">Password</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
<a href="CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
<a href="CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
<a href="CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
<a href="CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
|
|
@ -63,6 +75,9 @@
|
||||||
<a href="CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
<a href="CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
||||||
|
|
||||||
<ul class="nav level2">
|
<ul class="nav level2">
|
||||||
|
<li>
|
||||||
|
<a href="CapyKit.Attributes.html" name="" title="Classes">Classes</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
<a href="CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -79,6 +94,9 @@
|
||||||
<a href="CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
<a href="CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
||||||
|
|
||||||
<ul class="nav level2">
|
<ul class="nav level2">
|
||||||
|
<li>
|
||||||
|
<a href="CapyKit.Enumerations.html" name="" title="Enums">Enums</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
<a href="CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -89,6 +107,9 @@
|
||||||
<a href="CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
<a href="CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
||||||
|
|
||||||
<ul class="nav level2">
|
<ul class="nav level2">
|
||||||
|
<li>
|
||||||
|
<a href="CapyKit.Extensions.html" name="" title="Classes">Classes</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
<a href="CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -108,6 +129,9 @@
|
||||||
<a href="CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
<a href="CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
||||||
|
|
||||||
<ul class="nav level2">
|
<ul class="nav level2">
|
||||||
|
<li>
|
||||||
|
<a href="CapyKit.Helpers.html" name="" title="Classes">Classes</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
<a href="CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -117,9 +141,6 @@
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
<a href="CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
<a href="CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
<a href="CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -135,6 +156,15 @@
|
||||||
<li>
|
<li>
|
||||||
<a href="CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
<a href="CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
||||||
</li>
|
</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>
|
<li>
|
||||||
<a href="CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
<a href="CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
|
|
@ -79,7 +79,7 @@
|
||||||
<ul>
|
<ul>
|
||||||
<li><a href="introduction.html">Introduction</a> explains what CapyKit includes and how the namespaces are organized.</li>
|
<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="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>
|
</ul>
|
||||||
<h2 id="common-tasks">Common Tasks</h2>
|
<h2 id="common-tasks">Common Tasks</h2>
|
||||||
<h3 id="work-with-strings-and-collections">Work with strings and collections</h3>
|
<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",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.yml",
|
"source_relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.html"
|
"relative_path": "api/CapyKit.Attributes.EnumerationAttribute-1.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.yml",
|
"source_relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.html"
|
"relative_path": "api/CapyKit.Attributes.EnumerationDescriptionAttribute.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.yml",
|
"source_relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.html"
|
"relative_path": "api/CapyKit.Attributes.ValueFormatAttribute.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Attributes.yml",
|
"source_relative_path": "api/CapyKit.Attributes.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Attributes.html"
|
"relative_path": "api/CapyKit.Attributes.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Attributes",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.CapyEventArgs.yml",
|
"source_relative_path": "api/CapyKit.CapyEventArgs.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.CapyEventArgs.html"
|
"relative_path": "api/CapyKit.CapyEventArgs.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.CapyEventHandler.yml",
|
"source_relative_path": "api/CapyKit.CapyEventHandler.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.CapyEventHandler.html"
|
"relative_path": "api/CapyKit.CapyEventHandler.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.CapyEventReporter.yml",
|
"source_relative_path": "api/CapyKit.CapyEventReporter.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.CapyEventReporter.html"
|
"relative_path": "api/CapyKit.CapyEventReporter.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Color.yml",
|
"source_relative_path": "api/CapyKit.Color.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Color.html"
|
"relative_path": "api/CapyKit.Color.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Color",
|
|
||||||
"Summary": "<p sourcefile=\"api/CapyKit.Color.yml\" sourcestartlinenumber=\"1\">An object representing a color.</p>\n"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.EncryptedValue-1.yml",
|
"source_relative_path": "api/CapyKit.EncryptedValue-1.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.EncryptedValue-1.html"
|
"relative_path": "api/CapyKit.EncryptedValue-1.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.EncryptedValue<T>",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Enumerations.MeasurementSystem.yml",
|
"source_relative_path": "api/CapyKit.Enumerations.MeasurementSystem.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Enumerations.MeasurementSystem.html"
|
"relative_path": "api/CapyKit.Enumerations.MeasurementSystem.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Enumerations.yml",
|
"source_relative_path": "api/CapyKit.Enumerations.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Enumerations.html"
|
"relative_path": "api/CapyKit.Enumerations.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Enumerations",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.EventLevel.yml",
|
"source_relative_path": "api/CapyKit.EventLevel.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.EventLevel.html"
|
"relative_path": "api/CapyKit.EventLevel.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Extensions.EnumerationExtensions.yml",
|
"source_relative_path": "api/CapyKit.Extensions.EnumerationExtensions.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Extensions.EnumerationExtensions.html"
|
"relative_path": "api/CapyKit.Extensions.EnumerationExtensions.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Extensions.LINQExtensions.yml",
|
"source_relative_path": "api/CapyKit.Extensions.LINQExtensions.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Extensions.LINQExtensions.html"
|
"relative_path": "api/CapyKit.Extensions.LINQExtensions.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Extensions.ObjectExtensions.yml",
|
"source_relative_path": "api/CapyKit.Extensions.ObjectExtensions.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Extensions.ObjectExtensions.html"
|
"relative_path": "api/CapyKit.Extensions.ObjectExtensions.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Extensions.StringExtensions.yml",
|
"source_relative_path": "api/CapyKit.Extensions.StringExtensions.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Extensions.StringExtensions.html"
|
"relative_path": "api/CapyKit.Extensions.StringExtensions.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Extensions.yml",
|
"source_relative_path": "api/CapyKit.Extensions.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Extensions.html"
|
"relative_path": "api/CapyKit.Extensions.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Extensions",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.CalculationHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.CalculationHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.CalculationHelper.html"
|
"relative_path": "api/CapyKit.Helpers.CalculationHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.CompressionHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.CompressionHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.CompressionHelper.html"
|
"relative_path": "api/CapyKit.Helpers.CompressionHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.EncryptionHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.EncryptionHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.EncryptionHelper.html"
|
"relative_path": "api/CapyKit.Helpers.EncryptionHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Helpers.EncryptionHelper",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.yml",
|
"source_relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.html"
|
"relative_path": "api/CapyKit.Helpers.IEncryptionAlgorithm.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Helpers.IEncryptionAlgorithm",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.KeyHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.KeyHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.KeyHelper.html"
|
"relative_path": "api/CapyKit.Helpers.KeyHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.LanguageHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.LanguageHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.LanguageHelper.html"
|
"relative_path": "api/CapyKit.Helpers.LanguageHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.SecurityHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.SecurityHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.SecurityHelper.html"
|
"relative_path": "api/CapyKit.Helpers.SecurityHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.SerializationHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.SerializationHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.SerializationHelper.html"
|
"relative_path": "api/CapyKit.Helpers.SerializationHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Helpers.SerializationHelper",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.SettingsHelper.yml",
|
"source_relative_path": "api/CapyKit.Helpers.SettingsHelper.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.SettingsHelper.html"
|
"relative_path": "api/CapyKit.Helpers.SettingsHelper.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.yml",
|
"source_relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.html"
|
"relative_path": "api/CapyKit.Helpers.ValidCharacterCollection.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Helpers.yml",
|
"source_relative_path": "api/CapyKit.Helpers.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Helpers.html"
|
"relative_path": "api/CapyKit.Helpers.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit.Helpers",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.IPasswordAlgorithm.yml",
|
"source_relative_path": "api/CapyKit.IPasswordAlgorithm.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.IPasswordAlgorithm.html"
|
"relative_path": "api/CapyKit.IPasswordAlgorithm.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.NamedColor.yml",
|
"source_relative_path": "api/CapyKit.NamedColor.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.NamedColor.html"
|
"relative_path": "api/CapyKit.NamedColor.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Password.yml",
|
"source_relative_path": "api/CapyKit.Password.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Password.html"
|
"relative_path": "api/CapyKit.Password.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Pbkdf2Algorithm.yml",
|
"source_relative_path": "api/CapyKit.Pbkdf2Algorithm.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Pbkdf2Algorithm.html"
|
"relative_path": "api/CapyKit.Pbkdf2Algorithm.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.Pool-1.yml",
|
"source_relative_path": "api/CapyKit.Pool-1.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.Pool-1.html"
|
"relative_path": "api/CapyKit.Pool-1.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.PoolItem-1.yml",
|
"source_relative_path": "api/CapyKit.PoolItem-1.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.PoolItem-1.html"
|
"relative_path": "api/CapyKit.PoolItem-1.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.PropertyComparer-2.yml",
|
"source_relative_path": "api/CapyKit.PropertyComparer-2.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.PropertyComparer-2.html"
|
"relative_path": "api/CapyKit.PropertyComparer-2.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"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"
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "ManagedReference",
|
"type": "Conceptual",
|
||||||
"source_relative_path": "api/CapyKit.yml",
|
"source_relative_path": "api/CapyKit.md",
|
||||||
"output": {
|
"output": {
|
||||||
".html": {
|
".html": {
|
||||||
"relative_path": "api/CapyKit.html"
|
"relative_path": "api/CapyKit.html"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"version": "",
|
"version": ""
|
||||||
"Uid": null,
|
|
||||||
"IsMRef": true,
|
|
||||||
"Title": "CapyKit",
|
|
||||||
"Summary": null
|
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"type": "Toc",
|
"type": "Toc",
|
||||||
|
|
|
||||||
|
|
@ -29,10 +29,10 @@
|
||||||
|
|
||||||
<ul class="nav level3">
|
<ul class="nav level3">
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.CapyEventArgs.html" name="" title="CapyEventArgs">CapyEventArgs</a>
|
<a href="api/CapyKit.html" name="" title="Classes">Classes</a>
|
||||||
</li>
|
</li>
|
||||||
<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>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
<a href="api/CapyKit.CapyEventReporter.html" name="" title="CapyEventReporter">CapyEventReporter</a>
|
||||||
|
|
@ -43,30 +43,42 @@
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
<a href="api/CapyKit.EncryptedValue-1.html" name="" title="EncryptedValue<T>">EncryptedValue<T></a>
|
||||||
</li>
|
</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>
|
<li>
|
||||||
<a href="api/CapyKit.Password.html" name="" title="Password">Password</a>
|
<a href="api/CapyKit.Password.html" name="" title="Password">Password</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
<a href="api/CapyKit.Pbkdf2Algorithm.html" name="" title="Pbkdf2Algorithm">Pbkdf2Algorithm</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
<a href="api/CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
<a href="api/CapyKit.Pool-1.html" name="" title="Pool<T>">Pool<T></a>
|
||||||
</li>
|
</li>
|
||||||
|
<li>
|
||||||
|
<a href="api/CapyKit.PoolItem-1.html" name="" title="PoolItem<T>">PoolItem<T></a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
<a href="api/CapyKit.PropertyComparer-2.html" name="" title="PropertyComparer<T, U>">PropertyComparer<T, U></a>
|
||||||
</li>
|
</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>
|
</ul>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
<li>
|
||||||
|
|
@ -74,6 +86,9 @@
|
||||||
<a href="api/CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
<a href="api/CapyKit.Attributes.html" name="" title="CapyKit.Attributes">CapyKit.Attributes</a>
|
||||||
|
|
||||||
<ul class="nav level3">
|
<ul class="nav level3">
|
||||||
|
<li>
|
||||||
|
<a href="api/CapyKit.Attributes.html" name="" title="Classes">Classes</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
<a href="api/CapyKit.Attributes.EnumerationAttribute-1.html" name="" title="EnumerationAttribute<T>">EnumerationAttribute<T></a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -90,6 +105,9 @@
|
||||||
<a href="api/CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
<a href="api/CapyKit.Enumerations.html" name="" title="CapyKit.Enumerations">CapyKit.Enumerations</a>
|
||||||
|
|
||||||
<ul class="nav level3">
|
<ul class="nav level3">
|
||||||
|
<li>
|
||||||
|
<a href="api/CapyKit.Enumerations.html" name="" title="Enums">Enums</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
<a href="api/CapyKit.Enumerations.MeasurementSystem.html" name="" title="MeasurementSystem">MeasurementSystem</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -100,6 +118,9 @@
|
||||||
<a href="api/CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
<a href="api/CapyKit.Extensions.html" name="" title="CapyKit.Extensions">CapyKit.Extensions</a>
|
||||||
|
|
||||||
<ul class="nav level3">
|
<ul class="nav level3">
|
||||||
|
<li>
|
||||||
|
<a href="api/CapyKit.Extensions.html" name="" title="Classes">Classes</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
<a href="api/CapyKit.Extensions.EnumerationExtensions.html" name="" title="EnumerationExtensions">EnumerationExtensions</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -119,6 +140,9 @@
|
||||||
<a href="api/CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
<a href="api/CapyKit.Helpers.html" name="" title="CapyKit.Helpers">CapyKit.Helpers</a>
|
||||||
|
|
||||||
<ul class="nav level3">
|
<ul class="nav level3">
|
||||||
|
<li>
|
||||||
|
<a href="api/CapyKit.Helpers.html" name="" title="Classes">Classes</a>
|
||||||
|
</li>
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
<a href="api/CapyKit.Helpers.CalculationHelper.html" name="" title="CalculationHelper">CalculationHelper</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -128,9 +152,6 @@
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
<a href="api/CapyKit.Helpers.EncryptionHelper.html" name="" title="EncryptionHelper">EncryptionHelper</a>
|
||||||
</li>
|
</li>
|
||||||
<li>
|
|
||||||
<a href="api/CapyKit.Helpers.IEncryptionAlgorithm.html" name="" title="IEncryptionAlgorithm">IEncryptionAlgorithm</a>
|
|
||||||
</li>
|
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
<a href="api/CapyKit.Helpers.KeyHelper.html" name="" title="KeyHelper">KeyHelper</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
@ -146,6 +167,15 @@
|
||||||
<li>
|
<li>
|
||||||
<a href="api/CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
<a href="api/CapyKit.Helpers.SettingsHelper.html" name="" title="SettingsHelper">SettingsHelper</a>
|
||||||
</li>
|
</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>
|
<li>
|
||||||
<a href="api/CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
<a href="api/CapyKit.Helpers.ValidCharacterCollection.html" name="" title="ValidCharacterCollection">ValidCharacterCollection</a>
|
||||||
</li>
|
</li>
|
||||||
|
|
|
||||||
File diff suppressed because one or more lines are too long
File diff suppressed because it is too large
Load diff
1113
Docs/api/.manifest
1113
Docs/api/.manifest
File diff suppressed because it is too large
Load diff
108
Docs/api/CapyKit.Attributes.EnumerationAttribute-1.md
Normal file
108
Docs/api/CapyKit.Attributes.EnumerationAttribute-1.md
Normal file
|
|
@ -0,0 +1,108 @@
|
||||||
|
# <a id="CapyKit_Attributes_EnumerationAttribute_1"></a> Class EnumerationAttribute<T\>
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Attributes](CapyKit.Attributes.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Custom attribute class for decorating enumeration fields with additional data.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
[AttributeUsage(AttributeTargets.Field)]
|
||||||
|
public abstract class EnumerationAttribute<T> : Attribute
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter allowing for arbitrary declarations and assignments of meaning.
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
|
||||||
|
[EnumerationAttribute<T\>](CapyKit.Attributes.EnumerationAttribute\-1.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
|
||||||
|
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
|
||||||
|
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
|
||||||
|
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
|
||||||
|
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<EnumerationAttribute<T\>\>\(EnumerationAttribute<T\>, EnumerationAttribute<T\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_EnumerationAttribute_1__ctor__0_"></a> EnumerationAttribute\(T\)
|
||||||
|
|
||||||
|
Gets the value of the enumeration represented by this attribute.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
protected EnumerationAttribute(T value)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`value` T
|
||||||
|
|
||||||
|
Initializes a new instance of the <xref href="CapyKit.Attributes.EnumerationAttribute%601" data-throw-if-not-resolved="false"></xref> class with a
|
||||||
|
specified value.
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_EnumerationAttribute_1_Value"></a> Value
|
||||||
|
|
||||||
|
Initializes a new instance of the <xref href="CapyKit.Attributes.EnumerationAttribute%601" data-throw-if-not-resolved="false"></xref> class with a
|
||||||
|
specified value.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public T Value { get; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
|
|
@ -0,0 +1,93 @@
|
||||||
|
# <a id="CapyKit_Attributes_EnumerationDescriptionAttribute"></a> Class EnumerationDescriptionAttribute
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Attributes](CapyKit.Attributes.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
An attribute class for decorating enumeration fields with a description.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
[AttributeUsage(AttributeTargets.Field)]
|
||||||
|
public class EnumerationDescriptionAttribute : EnumerationAttribute<string>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
|
||||||
|
[EnumerationAttribute<string\>](CapyKit.Attributes.EnumerationAttribute\-1.md) ←
|
||||||
|
[EnumerationDescriptionAttribute](CapyKit.Attributes.EnumerationDescriptionAttribute.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[EnumerationAttribute<string\>.Value](CapyKit.Attributes.EnumerationAttribute\-1.md\#CapyKit\_Attributes\_EnumerationAttribute\_1\_Value),
|
||||||
|
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
|
||||||
|
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
|
||||||
|
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
|
||||||
|
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
|
||||||
|
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<EnumerationDescriptionAttribute\>\(EnumerationDescriptionAttribute, EnumerationDescriptionAttribute\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_EnumerationDescriptionAttribute__ctor_System_String_"></a> EnumerationDescriptionAttribute\(string\)
|
||||||
|
|
||||||
|
Initializes a new instance of the <xref href="CapyKit.Attributes.EnumerationDescriptionAttribute" data-throw-if-not-resolved="false"></xref> class with
|
||||||
|
the specified description.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public EnumerationDescriptionAttribute(string description)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`description` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The description of the enumeration value.
|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
[EnumerationAttribute](CapyKit.Attributes.EnumerationAttribute\-1.md)<T\>
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
132
Docs/api/CapyKit.Attributes.ValueFormatAttribute.md
Normal file
132
Docs/api/CapyKit.Attributes.ValueFormatAttribute.md
Normal file
|
|
@ -0,0 +1,132 @@
|
||||||
|
# <a id="CapyKit_Attributes_ValueFormatAttribute"></a> Class ValueFormatAttribute
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Attributes](CapyKit.Attributes.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Custom attribute for formatting values in a specific way.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
[AttributeUsage(AttributeTargets.Property)]
|
||||||
|
public class ValueFormatAttribute : Attribute
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[Attribute](https://learn.microsoft.com/dotnet/api/system.attribute) ←
|
||||||
|
[ValueFormatAttribute](CapyKit.Attributes.ValueFormatAttribute.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[Attribute.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.equals),
|
||||||
|
[Attribute.GetCustomAttribute\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttribute\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttribute\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattribute\#system\-attribute\-getcustomattribute\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-boolean\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.GetCustomAttributes\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.getcustomattributes\#system\-attribute\-getcustomattributes\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.gethashcode),
|
||||||
|
[Attribute.IsDefaultAttribute\(\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefaultattribute),
|
||||||
|
[Attribute.IsDefined\(Assembly, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(Assembly, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-assembly\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(MemberInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(MemberInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-memberinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(Module, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(Module, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-module\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.IsDefined\(ParameterInfo, Type\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\)),
|
||||||
|
[Attribute.IsDefined\(ParameterInfo, Type, bool\)](https://learn.microsoft.com/dotnet/api/system.attribute.isdefined\#system\-attribute\-isdefined\(system\-reflection\-parameterinfo\-system\-type\-system\-boolean\)),
|
||||||
|
[Attribute.Match\(object?\)](https://learn.microsoft.com/dotnet/api/system.attribute.match),
|
||||||
|
[Attribute.TypeId](https://learn.microsoft.com/dotnet/api/system.attribute.typeid),
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<ValueFormatAttribute\>\(ValueFormatAttribute, ValueFormatAttribute\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_ValueFormatAttribute__ctor"></a> ValueFormatAttribute\(\)
|
||||||
|
|
||||||
|
Default constructor. Initializes a new instance of the <xref href="CapyKit.Attributes.ValueFormatAttribute" data-throw-if-not-resolved="false"></xref>
|
||||||
|
class with an empty format string.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public ValueFormatAttribute()
|
||||||
|
```
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_ValueFormatAttribute__ctor_System_String_"></a> ValueFormatAttribute\(string\)
|
||||||
|
|
||||||
|
Constructor. Initializes a new instance of the <xref href="CapyKit.Attributes.ValueFormatAttribute" data-throw-if-not-resolved="false"></xref> class with
|
||||||
|
the specified format string.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public ValueFormatAttribute(string format)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`format` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The format string used to format the value.
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_ValueFormatAttribute_Format"></a> Format
|
||||||
|
|
||||||
|
Gets or sets the format to use for formatting the value.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string Format { get; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Attributes_ValueFormatAttribute_GetFormatParameterizedString_System_Int32_"></a> GetFormatParameterizedString\(int\)
|
||||||
|
|
||||||
|
Gets a parameterized formatted string for the specified index.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string GetFormatParameterizedString(int index = 0)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`index` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
(Optional) Zero-based index of the item in the string to format.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A formatted string with the specified index and format.
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
16
Docs/api/CapyKit.Attributes.md
Normal file
16
Docs/api/CapyKit.Attributes.md
Normal file
|
|
@ -0,0 +1,16 @@
|
||||||
|
# <a id="CapyKit_Attributes"></a> Namespace CapyKit.Attributes
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
|
||||||
|
[EnumerationAttribute<T\>](CapyKit.Attributes.EnumerationAttribute\-1.md)
|
||||||
|
|
||||||
|
Custom attribute class for decorating enumeration fields with additional data.
|
||||||
|
|
||||||
|
[EnumerationDescriptionAttribute](CapyKit.Attributes.EnumerationDescriptionAttribute.md)
|
||||||
|
|
||||||
|
An attribute class for decorating enumeration fields with a description.
|
||||||
|
|
||||||
|
[ValueFormatAttribute](CapyKit.Attributes.ValueFormatAttribute.md)
|
||||||
|
|
||||||
|
Custom attribute for formatting values in a specific way.
|
||||||
|
|
||||||
|
|
@ -1,79 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Attributes
|
|
||||||
commentId: N:CapyKit.Attributes
|
|
||||||
id: CapyKit.Attributes
|
|
||||||
children:
|
|
||||||
- CapyKit.Attributes.EnumerationAttribute`1
|
|
||||||
- CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
- CapyKit.Attributes.ValueFormatAttribute
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyKit.Attributes
|
|
||||||
nameWithType: CapyKit.Attributes
|
|
||||||
fullName: CapyKit.Attributes
|
|
||||||
type: Namespace
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Attributes.EnumerationAttribute`1
|
|
||||||
commentId: T:CapyKit.Attributes.EnumerationAttribute`1
|
|
||||||
href: CapyKit.Attributes.EnumerationAttribute-1.html
|
|
||||||
name: EnumerationAttribute<T>
|
|
||||||
nameWithType: EnumerationAttribute<T>
|
|
||||||
fullName: CapyKit.Attributes.EnumerationAttribute<T>
|
|
||||||
nameWithType.vb: EnumerationAttribute(Of T)
|
|
||||||
fullName.vb: CapyKit.Attributes.EnumerationAttribute(Of T)
|
|
||||||
name.vb: EnumerationAttribute(Of T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Attributes.EnumerationAttribute`1
|
|
||||||
name: EnumerationAttribute
|
|
||||||
href: CapyKit.Attributes.EnumerationAttribute-1.html
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Attributes.EnumerationAttribute`1
|
|
||||||
name: EnumerationAttribute
|
|
||||||
href: CapyKit.Attributes.EnumerationAttribute-1.html
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
commentId: T:CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
parent: CapyKit.Attributes
|
|
||||||
href: CapyKit.Attributes.EnumerationDescriptionAttribute.html
|
|
||||||
name: EnumerationDescriptionAttribute
|
|
||||||
nameWithType: EnumerationDescriptionAttribute
|
|
||||||
fullName: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
- uid: CapyKit.Attributes.ValueFormatAttribute
|
|
||||||
commentId: T:CapyKit.Attributes.ValueFormatAttribute
|
|
||||||
href: CapyKit.Attributes.ValueFormatAttribute.html
|
|
||||||
name: ValueFormatAttribute
|
|
||||||
nameWithType: ValueFormatAttribute
|
|
||||||
fullName: CapyKit.Attributes.ValueFormatAttribute
|
|
||||||
- uid: CapyKit.Attributes
|
|
||||||
commentId: N:CapyKit.Attributes
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Attributes
|
|
||||||
nameWithType: CapyKit.Attributes
|
|
||||||
fullName: CapyKit.Attributes
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Attributes
|
|
||||||
name: Attributes
|
|
||||||
href: CapyKit.Attributes.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Attributes
|
|
||||||
name: Attributes
|
|
||||||
href: CapyKit.Attributes.html
|
|
||||||
96
Docs/api/CapyKit.CapyEventArgs.md
Normal file
96
Docs/api/CapyKit.CapyEventArgs.md
Normal file
|
|
@ -0,0 +1,96 @@
|
||||||
|
# <a id="CapyKit_CapyEventArgs"></a> Class CapyEventArgs
|
||||||
|
|
||||||
|
Namespace: [CapyKit](CapyKit.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
The CapyEventArgs class represents an event argument instance with event level, message, and
|
||||||
|
method name information.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class CapyEventArgs : EventArgs
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[EventArgs](https://learn.microsoft.com/dotnet/api/system.eventargs) ←
|
||||||
|
[CapyEventArgs](CapyKit.CapyEventArgs.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[EventArgs.Empty](https://learn.microsoft.com/dotnet/api/system.eventargs.empty),
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<CapyEventArgs\>\(CapyEventArgs, CapyEventArgs\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_"></a> CapyEventArgs\(EventLevel, string, string\)
|
||||||
|
|
||||||
|
Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public CapyEventArgs(EventLevel level, string message, string method = null)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`level` [EventLevel](CapyKit.EventLevel.md)
|
||||||
|
|
||||||
|
The severity level of the event.
|
||||||
|
|
||||||
|
`message` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A descriptive message explaining the reason for the event.
|
||||||
|
|
||||||
|
`method` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The name of the method where the event was raised.
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventArgs_Level"></a> Level
|
||||||
|
|
||||||
|
Gets the severity level of the event.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public EventLevel Level { get; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
[EventLevel](CapyKit.EventLevel.md)
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventArgs_Message"></a> Message
|
||||||
|
|
||||||
|
Gets the message describing the reason for the event.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string Message { get; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventArgs_MethodName"></a> MethodName
|
||||||
|
|
||||||
|
Gets the name of the method where the event was raised.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string MethodName { get; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
|
@ -1,693 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
commentId: T:CapyKit.CapyEventArgs
|
|
||||||
id: CapyEventArgs
|
|
||||||
parent: CapyKit
|
|
||||||
children:
|
|
||||||
- CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)
|
|
||||||
- CapyKit.CapyEventArgs.Level
|
|
||||||
- CapyKit.CapyEventArgs.Message
|
|
||||||
- CapyKit.CapyEventArgs.MethodName
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyEventArgs
|
|
||||||
nameWithType: CapyEventArgs
|
|
||||||
fullName: CapyKit.CapyEventArgs
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CapyEventArgs
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 163
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: >-
|
|
||||||
The CapyEventArgs class represents an event argument instance with event level, message, and
|
|
||||||
|
|
||||||
method name information.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: 'public class CapyEventArgs : EventArgs'
|
|
||||||
content.vb: Public Class CapyEventArgs Inherits EventArgs
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
- System.EventArgs
|
|
||||||
inheritedMembers:
|
|
||||||
- System.EventArgs.Empty
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.CapyEventArgs.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs)
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.CapyEventArgs.Level
|
|
||||||
commentId: P:CapyKit.CapyEventArgs.Level
|
|
||||||
id: Level
|
|
||||||
parent: CapyKit.CapyEventArgs
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Level
|
|
||||||
nameWithType: CapyEventArgs.Level
|
|
||||||
fullName: CapyKit.CapyEventArgs.Level
|
|
||||||
type: Property
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Level
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 170
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Gets the severity level of the event.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public EventLevel Level { get; }
|
|
||||||
parameters: []
|
|
||||||
return:
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
content.vb: Public Property Level As EventLevel
|
|
||||||
overload: CapyKit.CapyEventArgs.Level*
|
|
||||||
- uid: CapyKit.CapyEventArgs.Message
|
|
||||||
commentId: P:CapyKit.CapyEventArgs.Message
|
|
||||||
id: Message
|
|
||||||
parent: CapyKit.CapyEventArgs
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Message
|
|
||||||
nameWithType: CapyEventArgs.Message
|
|
||||||
fullName: CapyKit.CapyEventArgs.Message
|
|
||||||
type: Property
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Message
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 175
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Gets the message describing the reason for the event.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public string Message { get; }
|
|
||||||
parameters: []
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
content.vb: Public Property Message As String
|
|
||||||
overload: CapyKit.CapyEventArgs.Message*
|
|
||||||
- uid: CapyKit.CapyEventArgs.MethodName
|
|
||||||
commentId: P:CapyKit.CapyEventArgs.MethodName
|
|
||||||
id: MethodName
|
|
||||||
parent: CapyKit.CapyEventArgs
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: MethodName
|
|
||||||
nameWithType: CapyEventArgs.MethodName
|
|
||||||
fullName: CapyKit.CapyEventArgs.MethodName
|
|
||||||
type: Property
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: MethodName
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 180
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Gets the name of the method where the event was raised.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public string MethodName { get; }
|
|
||||||
parameters: []
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
content.vb: Public Property MethodName As String
|
|
||||||
overload: CapyKit.CapyEventArgs.MethodName*
|
|
||||||
- uid: CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)
|
|
||||||
commentId: M:CapyKit.CapyEventArgs.#ctor(CapyKit.EventLevel,System.String,System.String)
|
|
||||||
id: '#ctor(CapyKit.EventLevel,System.String,System.String)'
|
|
||||||
parent: CapyKit.CapyEventArgs
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyEventArgs(EventLevel, string, string)
|
|
||||||
nameWithType: CapyEventArgs.CapyEventArgs(EventLevel, string, string)
|
|
||||||
fullName: CapyKit.CapyEventArgs.CapyEventArgs(CapyKit.EventLevel, string, string)
|
|
||||||
type: Constructor
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: .ctor
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 192
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public CapyEventArgs(EventLevel level, string message, string method = null)
|
|
||||||
parameters:
|
|
||||||
- id: level
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
description: The severity level of the event.
|
|
||||||
- id: message
|
|
||||||
type: System.String
|
|
||||||
description: A descriptive message explaining the reason for the event.
|
|
||||||
- id: method
|
|
||||||
type: System.String
|
|
||||||
description: The name of the method where the event was raised.
|
|
||||||
content.vb: Public Sub New(level As EventLevel, message As String, method As String = Nothing)
|
|
||||||
overload: CapyKit.CapyEventArgs.#ctor*
|
|
||||||
nameWithType.vb: CapyEventArgs.New(EventLevel, String, String)
|
|
||||||
fullName.vb: CapyKit.CapyEventArgs.New(CapyKit.EventLevel, String, String)
|
|
||||||
name.vb: New(EventLevel, String, String)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.EventArgs
|
|
||||||
commentId: T:System.EventArgs
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.eventargs
|
|
||||||
name: EventArgs
|
|
||||||
nameWithType: EventArgs
|
|
||||||
fullName: System.EventArgs
|
|
||||||
- uid: System.EventArgs.Empty
|
|
||||||
commentId: F:System.EventArgs.Empty
|
|
||||||
parent: System.EventArgs
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.eventargs.empty
|
|
||||||
name: Empty
|
|
||||||
nameWithType: EventArgs.Empty
|
|
||||||
fullName: System.EventArgs.Empty
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.CapyEventArgs.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<CapyEventArgs>(CapyEventArgs, CapyEventArgs)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.CapyEventArgs>(CapyKit.CapyEventArgs, CapyKit.CapyEventArgs)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of CapyEventArgs)(CapyEventArgs, CapyEventArgs)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.CapyEventArgs)(CapyKit.CapyEventArgs, CapyKit.CapyEventArgs)
|
|
||||||
name.vb: UpdateProperties(Of CapyEventArgs)(CapyEventArgs, CapyEventArgs)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs,CapyKit.CapyEventArgs)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
name: CapyEventArgs
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
name: CapyEventArgs
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
name: CapyEventArgs
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventArgs,CapyKit.CapyEventArgs)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
name: CapyEventArgs
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
name: CapyEventArgs
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
name: CapyEventArgs
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.CapyEventArgs.Level*
|
|
||||||
commentId: Overload:CapyKit.CapyEventArgs.Level
|
|
||||||
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs_Level
|
|
||||||
name: Level
|
|
||||||
nameWithType: CapyEventArgs.Level
|
|
||||||
fullName: CapyKit.CapyEventArgs.Level
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
commentId: T:CapyKit.EventLevel
|
|
||||||
parent: CapyKit
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
name: EventLevel
|
|
||||||
nameWithType: EventLevel
|
|
||||||
fullName: CapyKit.EventLevel
|
|
||||||
- uid: CapyKit.CapyEventArgs.Message*
|
|
||||||
commentId: Overload:CapyKit.CapyEventArgs.Message
|
|
||||||
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs_Message
|
|
||||||
name: Message
|
|
||||||
nameWithType: CapyEventArgs.Message
|
|
||||||
fullName: CapyKit.CapyEventArgs.Message
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: CapyKit.CapyEventArgs.MethodName*
|
|
||||||
commentId: Overload:CapyKit.CapyEventArgs.MethodName
|
|
||||||
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs_MethodName
|
|
||||||
name: MethodName
|
|
||||||
nameWithType: CapyEventArgs.MethodName
|
|
||||||
fullName: CapyKit.CapyEventArgs.MethodName
|
|
||||||
- uid: CapyKit.CapyEventArgs.#ctor*
|
|
||||||
commentId: Overload:CapyKit.CapyEventArgs.#ctor
|
|
||||||
href: CapyKit.CapyEventArgs.html#CapyKit_CapyEventArgs__ctor_CapyKit_EventLevel_System_String_System_String_
|
|
||||||
name: CapyEventArgs
|
|
||||||
nameWithType: CapyEventArgs.CapyEventArgs
|
|
||||||
fullName: CapyKit.CapyEventArgs.CapyEventArgs
|
|
||||||
nameWithType.vb: CapyEventArgs.New
|
|
||||||
fullName.vb: CapyKit.CapyEventArgs.New
|
|
||||||
name.vb: New
|
|
||||||
22
Docs/api/CapyKit.CapyEventHandler.md
Normal file
22
Docs/api/CapyKit.CapyEventHandler.md
Normal file
|
|
@ -0,0 +1,22 @@
|
||||||
|
# <a id="CapyKit_CapyEventHandler"></a> Delegate CapyEventHandler
|
||||||
|
|
||||||
|
Namespace: [CapyKit](CapyKit.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
A delegate representing an event handler that accepts a <xref href="CapyKit.CapyEventArgs" data-throw-if-not-resolved="false"></xref> instance.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public delegate void CapyEventHandler(CapyEventArgs e)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`e` [CapyEventArgs](CapyKit.CapyEventArgs.md)
|
||||||
|
|
||||||
|
The CapyEventArgs instance containing event data.
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<CapyEventHandler\>\(CapyEventHandler, CapyEventHandler\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
|
@ -1,253 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
commentId: T:CapyKit.CapyEventHandler
|
|
||||||
id: CapyEventHandler
|
|
||||||
parent: CapyKit
|
|
||||||
children: []
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyEventHandler
|
|
||||||
nameWithType: CapyEventHandler
|
|
||||||
fullName: CapyKit.CapyEventHandler
|
|
||||||
type: Delegate
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CapyEventHandler
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 157
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: A delegate representing an event handler that accepts a <xref href="CapyKit.CapyEventArgs" data-throw-if-not-resolved="false"></xref> instance.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public delegate void CapyEventHandler(CapyEventArgs e)
|
|
||||||
parameters:
|
|
||||||
- id: e
|
|
||||||
type: CapyKit.CapyEventArgs
|
|
||||||
description: The CapyEventArgs instance containing event data.
|
|
||||||
content.vb: Public Delegate Sub CapyEventHandler(e As CapyEventArgs)
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.CapyEventHandler.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler)
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.CapyEventArgs
|
|
||||||
commentId: T:CapyKit.CapyEventArgs
|
|
||||||
parent: CapyKit
|
|
||||||
href: CapyKit.CapyEventArgs.html
|
|
||||||
name: CapyEventArgs
|
|
||||||
nameWithType: CapyEventArgs
|
|
||||||
fullName: CapyKit.CapyEventArgs
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: CapyKit.CapyEventHandler.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<CapyEventHandler>(CapyEventHandler, CapyEventHandler)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<CapyEventHandler>(CapyEventHandler, CapyEventHandler)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.CapyEventHandler>(CapyKit.CapyEventHandler, CapyKit.CapyEventHandler)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of CapyEventHandler)(CapyEventHandler, CapyEventHandler)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.CapyEventHandler)(CapyKit.CapyEventHandler, CapyKit.CapyEventHandler)
|
|
||||||
name.vb: UpdateProperties(Of CapyEventHandler)(CapyEventHandler, CapyEventHandler)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler,CapyKit.CapyEventHandler)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
name: CapyEventHandler
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
name: CapyEventHandler
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
name: CapyEventHandler
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.CapyEventHandler,CapyKit.CapyEventHandler)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
name: CapyEventHandler
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
name: CapyEventHandler
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
name: CapyEventHandler
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
167
Docs/api/CapyKit.CapyEventReporter.md
Normal file
167
Docs/api/CapyKit.CapyEventReporter.md
Normal file
|
|
@ -0,0 +1,167 @@
|
||||||
|
# <a id="CapyKit_CapyEventReporter"></a> Class CapyEventReporter
|
||||||
|
|
||||||
|
Namespace: [CapyKit](CapyKit.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class CapyEventReporter
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[CapyEventReporter](CapyKit.CapyEventReporter.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
Because consumers of CapyKit may have varied ways of handling logging, the <xref href="CapyKit.CapyEventReporter" data-throw-if-not-resolved="false"></xref> provides
|
||||||
|
a way for subscribers to recieve events for various "events" within the library. These can be thought of as
|
||||||
|
a logging solution for CapyKit. Consumers are free to treat these events however they see fit.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___"></a> EmitEvent\(EventLevel, string, string, params object\[\]\)
|
||||||
|
|
||||||
|
Emits an event with the given severity level, message, and method name.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`eventLevel` [EventLevel](CapyKit.EventLevel.md)
|
||||||
|
|
||||||
|
The severity level of the event.
|
||||||
|
|
||||||
|
`message` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||||
|
is accepted.
|
||||||
|
|
||||||
|
`method` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
(Optional) The name of the method where the event was raised.
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
A variable-length parameters list containing arguments for formatting the message.
|
||||||
|
|
||||||
|
#### Examples
|
||||||
|
|
||||||
|
<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
In order to allow for efficient calling member access via <xref href="System.Runtime.CompilerServices.CallerMemberNameAttribute" data-throw-if-not-resolved="false"></xref>
|
||||||
|
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[CallerMemberNameAttribute](https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute)
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___"></a> EmitEventOnce\(EventLevel, string, string, string, params object\[\]\)
|
||||||
|
|
||||||
|
Emits an event with the given severity level, message, unique identifier, and method name one
|
||||||
|
time.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`eventLevel` [EventLevel](CapyKit.EventLevel.md)
|
||||||
|
|
||||||
|
The severity level of the event.
|
||||||
|
|
||||||
|
`message` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
||||||
|
is accepted.
|
||||||
|
|
||||||
|
`uniqueIdentifier` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A unique identifier for the event emission.
|
||||||
|
|
||||||
|
`method` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
(Optional) The name of the method where the event was raised.
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
A variable-length parameters list containing arguments for formatting the message.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method is similar to EmitEvent(EventLevel, string, string, string, object[])
|
||||||
|
, but requires a unique identifier (such as a <xref href="System.Guid" data-throw-if-not-resolved="false"></xref>) to prevent duplicate
|
||||||
|
emissions.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[CallerMemberNameAttribute](https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute),
|
||||||
|
[Guid](https://learn.microsoft.com/dotnet/api/system.guid)
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_"></a> Subscribe\(CapyEventHandler, EventLevel, string\)
|
||||||
|
|
||||||
|
Subscribes the specified event handler to the event with the given subscription level and
|
||||||
|
origin.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`callback` [CapyEventHandler](CapyKit.CapyEventHandler.md)
|
||||||
|
|
||||||
|
The event handler to subscribe.
|
||||||
|
|
||||||
|
`subscriptionLevel` [EventLevel](CapyKit.EventLevel.md)
|
||||||
|
|
||||||
|
The severity level of the event to subscribe to.
|
||||||
|
|
||||||
|
`origin` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
(Optional) The name of the method or class where the subscription is made.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
If there is no existing list for the given subscription level, a new list is created and
|
||||||
|
added to the dictionary.
|
||||||
|
|
||||||
|
### <a id="CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_"></a> Unsubscribe\(CapyEventHandler, string\)
|
||||||
|
|
||||||
|
Unsubscribes the specified event handler from the event with the given origin.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void Unsubscribe(CapyEventHandler callback, string origin)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`callback` [CapyEventHandler](CapyKit.CapyEventHandler.md)
|
||||||
|
|
||||||
|
The event handler to unsubscribe.
|
||||||
|
|
||||||
|
`origin` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The name of the method or class where the subscription was made.
|
||||||
|
|
||||||
|
|
@ -1,591 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.CapyEventReporter
|
|
||||||
commentId: T:CapyKit.CapyEventReporter
|
|
||||||
id: CapyEventReporter
|
|
||||||
parent: CapyKit
|
|
||||||
children:
|
|
||||||
- CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
|
|
||||||
- CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
|
|
||||||
- CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
|
|
||||||
- CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyEventReporter
|
|
||||||
nameWithType: CapyEventReporter
|
|
||||||
fullName: CapyKit.CapyEventReporter
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CapyEventReporter
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 19
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: The CapyEventReporter class is responsible for managing event subscriptions and emissions within CapyKit.
|
|
||||||
remarks: >-
|
|
||||||
Because consumers of CapyKit may have varied ways of handling logging, the <xref href="CapyKit.CapyEventReporter" data-throw-if-not-resolved="false"></xref> provides
|
|
||||||
|
|
||||||
a way for subscribers to recieve events for various "events" within the library. These can be thought of as
|
|
||||||
|
|
||||||
a logging solution for CapyKit. Consumers are free to treat these events however they see fit.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static class CapyEventReporter
|
|
||||||
content.vb: Public Module CapyEventReporter
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
|
|
||||||
commentId: M:CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
|
|
||||||
id: Subscribe(CapyKit.CapyEventHandler,CapyKit.EventLevel,System.String)
|
|
||||||
parent: CapyKit.CapyEventReporter
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Subscribe(CapyEventHandler, EventLevel, string)
|
|
||||||
nameWithType: CapyEventReporter.Subscribe(CapyEventHandler, EventLevel, string)
|
|
||||||
fullName: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler, CapyKit.EventLevel, string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Subscribe
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 49
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: >-
|
|
||||||
Subscribes the specified event handler to the event with the given subscription level and
|
|
||||||
|
|
||||||
origin.
|
|
||||||
remarks: >-
|
|
||||||
If there is no existing list for the given subscription level, a new list is created and
|
|
||||||
|
|
||||||
added to the dictionary.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void Subscribe(CapyEventHandler callback, EventLevel subscriptionLevel, string origin = null)
|
|
||||||
parameters:
|
|
||||||
- id: callback
|
|
||||||
type: CapyKit.CapyEventHandler
|
|
||||||
description: The event handler to subscribe.
|
|
||||||
- id: subscriptionLevel
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
description: The severity level of the event to subscribe to.
|
|
||||||
- id: origin
|
|
||||||
type: System.String
|
|
||||||
description: (Optional) The name of the method or class where the subscription is made.
|
|
||||||
content.vb: Public Shared Sub Subscribe(callback As CapyEventHandler, subscriptionLevel As EventLevel, origin As String = Nothing)
|
|
||||||
overload: CapyKit.CapyEventReporter.Subscribe*
|
|
||||||
nameWithType.vb: CapyEventReporter.Subscribe(CapyEventHandler, EventLevel, String)
|
|
||||||
fullName.vb: CapyKit.CapyEventReporter.Subscribe(CapyKit.CapyEventHandler, CapyKit.EventLevel, String)
|
|
||||||
name.vb: Subscribe(CapyEventHandler, EventLevel, String)
|
|
||||||
- uid: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)
|
|
||||||
commentId: M:CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler,System.String)
|
|
||||||
id: Unsubscribe(CapyKit.CapyEventHandler,System.String)
|
|
||||||
parent: CapyKit.CapyEventReporter
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Unsubscribe(CapyEventHandler, string)
|
|
||||||
nameWithType: CapyEventReporter.Unsubscribe(CapyEventHandler, string)
|
|
||||||
fullName: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler, string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Unsubscribe
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 66
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Unsubscribes the specified event handler from the event with the given origin.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void Unsubscribe(CapyEventHandler callback, string origin)
|
|
||||||
parameters:
|
|
||||||
- id: callback
|
|
||||||
type: CapyKit.CapyEventHandler
|
|
||||||
description: The event handler to unsubscribe.
|
|
||||||
- id: origin
|
|
||||||
type: System.String
|
|
||||||
description: The name of the method or class where the subscription was made.
|
|
||||||
content.vb: Public Shared Sub Unsubscribe(callback As CapyEventHandler, origin As String)
|
|
||||||
overload: CapyKit.CapyEventReporter.Unsubscribe*
|
|
||||||
nameWithType.vb: CapyEventReporter.Unsubscribe(CapyEventHandler, String)
|
|
||||||
fullName.vb: CapyKit.CapyEventReporter.Unsubscribe(CapyKit.CapyEventHandler, String)
|
|
||||||
name.vb: Unsubscribe(CapyEventHandler, String)
|
|
||||||
- uid: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
|
|
||||||
commentId: M:CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
|
|
||||||
id: EmitEvent(CapyKit.EventLevel,System.String,System.String,System.Object[])
|
|
||||||
parent: CapyKit.CapyEventReporter
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EmitEvent(EventLevel, string, string, params object[])
|
|
||||||
nameWithType: CapyEventReporter.EmitEvent(EventLevel, string, string, params object[])
|
|
||||||
fullName: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel, string, string, params object[])
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EmitEvent
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 99
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Emits an event with the given severity level, message, and method name.
|
|
||||||
remarks: >-
|
|
||||||
In order to allow for efficient calling member access via <xref href="System.Runtime.CompilerServices.CallerMemberNameAttribute" data-throw-if-not-resolved="false"></xref>
|
|
||||||
|
|
||||||
, it is suggested that <code class="paramref">args</code> is defined explicitly for formatted messages.
|
|
||||||
example:
|
|
||||||
- '<pre><code class="lang-csharp">CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });</code></pre>'
|
|
||||||
syntax:
|
|
||||||
content: public static void EmitEvent(EventLevel eventLevel, string message, string method = null, params object[] args)
|
|
||||||
parameters:
|
|
||||||
- id: eventLevel
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
description: The severity level of the event.
|
|
||||||
- id: message
|
|
||||||
type: System.String
|
|
||||||
description: >-
|
|
||||||
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
|
||||||
|
|
||||||
is accepted.
|
|
||||||
- id: method
|
|
||||||
type: System.String
|
|
||||||
description: (Optional) The name of the method where the event was raised.
|
|
||||||
- id: args
|
|
||||||
type: System.Object[]
|
|
||||||
description: A variable-length parameters list containing arguments for formatting the message.
|
|
||||||
content.vb: Public Shared Sub EmitEvent(eventLevel As EventLevel, message As String, method As String = Nothing, ParamArray args As Object())
|
|
||||||
overload: CapyKit.CapyEventReporter.EmitEvent*
|
|
||||||
seealso:
|
|
||||||
- linkId: System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
nameWithType.vb: CapyEventReporter.EmitEvent(EventLevel, String, String, ParamArray Object())
|
|
||||||
fullName.vb: CapyKit.CapyEventReporter.EmitEvent(CapyKit.EventLevel, String, String, ParamArray Object())
|
|
||||||
name.vb: EmitEvent(EventLevel, String, String, ParamArray Object())
|
|
||||||
- uid: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
|
|
||||||
commentId: M:CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
|
|
||||||
id: EmitEventOnce(CapyKit.EventLevel,System.String,System.String,System.String,System.Object[])
|
|
||||||
parent: CapyKit.CapyEventReporter
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EmitEventOnce(EventLevel, string, string, string, params object[])
|
|
||||||
nameWithType: CapyEventReporter.EmitEventOnce(EventLevel, string, string, string, params object[])
|
|
||||||
fullName: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel, string, string, string, params object[])
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EmitEventOnce
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 139
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: >-
|
|
||||||
Emits an event with the given severity level, message, unique identifier, and method name one
|
|
||||||
|
|
||||||
time.
|
|
||||||
remarks: >-
|
|
||||||
This method is similar to EmitEvent(EventLevel, string, string, string, object[])
|
|
||||||
|
|
||||||
, but requires a unique identifier (such as a <xref href="System.Guid" data-throw-if-not-resolved="false"></xref>) to prevent duplicate
|
|
||||||
|
|
||||||
emissions.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void EmitEventOnce(EventLevel eventLevel, string message, string uniqueIdentifier, string method = null, params object[] args)
|
|
||||||
parameters:
|
|
||||||
- id: eventLevel
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
description: The severity level of the event.
|
|
||||||
- id: message
|
|
||||||
type: System.String
|
|
||||||
description: >-
|
|
||||||
The message describing the reason for the event. String formatting for <code class="paramref">args</code>
|
|
||||||
|
|
||||||
is accepted.
|
|
||||||
- id: uniqueIdentifier
|
|
||||||
type: System.String
|
|
||||||
description: A unique identifier for the event emission.
|
|
||||||
- id: method
|
|
||||||
type: System.String
|
|
||||||
description: (Optional) The name of the method where the event was raised.
|
|
||||||
- id: args
|
|
||||||
type: System.Object[]
|
|
||||||
description: A variable-length parameters list containing arguments for formatting the message.
|
|
||||||
content.vb: Public Shared Sub EmitEventOnce(eventLevel As EventLevel, message As String, uniqueIdentifier As String, method As String = Nothing, ParamArray args As Object())
|
|
||||||
overload: CapyKit.CapyEventReporter.EmitEventOnce*
|
|
||||||
seealso:
|
|
||||||
- linkId: System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
- linkId: System.Guid
|
|
||||||
commentId: T:System.Guid
|
|
||||||
nameWithType.vb: CapyEventReporter.EmitEventOnce(EventLevel, String, String, String, ParamArray Object())
|
|
||||||
fullName.vb: CapyKit.CapyEventReporter.EmitEventOnce(CapyKit.EventLevel, String, String, String, ParamArray Object())
|
|
||||||
name.vb: EmitEventOnce(EventLevel, String, String, String, ParamArray Object())
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.CapyEventReporter
|
|
||||||
commentId: T:CapyKit.CapyEventReporter
|
|
||||||
href: CapyKit.CapyEventReporter.html
|
|
||||||
name: CapyEventReporter
|
|
||||||
nameWithType: CapyEventReporter
|
|
||||||
fullName: CapyKit.CapyEventReporter
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.CapyEventReporter.Subscribe*
|
|
||||||
commentId: Overload:CapyKit.CapyEventReporter.Subscribe
|
|
||||||
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_Subscribe_CapyKit_CapyEventHandler_CapyKit_EventLevel_System_String_
|
|
||||||
name: Subscribe
|
|
||||||
nameWithType: CapyEventReporter.Subscribe
|
|
||||||
fullName: CapyKit.CapyEventReporter.Subscribe
|
|
||||||
- uid: CapyKit.CapyEventHandler
|
|
||||||
commentId: T:CapyKit.CapyEventHandler
|
|
||||||
parent: CapyKit
|
|
||||||
href: CapyKit.CapyEventHandler.html
|
|
||||||
name: CapyEventHandler
|
|
||||||
nameWithType: CapyEventHandler
|
|
||||||
fullName: CapyKit.CapyEventHandler
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
commentId: T:CapyKit.EventLevel
|
|
||||||
parent: CapyKit
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
name: EventLevel
|
|
||||||
nameWithType: EventLevel
|
|
||||||
fullName: CapyKit.EventLevel
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: CapyKit.CapyEventReporter.Unsubscribe*
|
|
||||||
commentId: Overload:CapyKit.CapyEventReporter.Unsubscribe
|
|
||||||
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_Unsubscribe_CapyKit_CapyEventHandler_System_String_
|
|
||||||
name: Unsubscribe
|
|
||||||
nameWithType: CapyEventReporter.Unsubscribe
|
|
||||||
fullName: CapyKit.CapyEventReporter.Unsubscribe
|
|
||||||
- uid: System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
commentId: T:System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute
|
|
||||||
name: CallerMemberNameAttribute
|
|
||||||
nameWithType: CallerMemberNameAttribute
|
|
||||||
fullName: System.Runtime.CompilerServices.CallerMemberNameAttribute
|
|
||||||
- uid: CapyKit.CapyEventReporter.EmitEvent*
|
|
||||||
commentId: Overload:CapyKit.CapyEventReporter.EmitEvent
|
|
||||||
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_EmitEvent_CapyKit_EventLevel_System_String_System_String_System_Object___
|
|
||||||
name: EmitEvent
|
|
||||||
nameWithType: CapyEventReporter.EmitEvent
|
|
||||||
fullName: CapyKit.CapyEventReporter.EmitEvent
|
|
||||||
- uid: System.Object[]
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object[]
|
|
||||||
nameWithType: object[]
|
|
||||||
fullName: object[]
|
|
||||||
nameWithType.vb: Object()
|
|
||||||
fullName.vb: Object()
|
|
||||||
name.vb: Object()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: '['
|
|
||||||
- name: ']'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Guid
|
|
||||||
commentId: T:System.Guid
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.guid
|
|
||||||
name: Guid
|
|
||||||
nameWithType: Guid
|
|
||||||
fullName: System.Guid
|
|
||||||
- uid: CapyKit.CapyEventReporter.EmitEventOnce*
|
|
||||||
commentId: Overload:CapyKit.CapyEventReporter.EmitEventOnce
|
|
||||||
href: CapyKit.CapyEventReporter.html#CapyKit_CapyEventReporter_EmitEventOnce_CapyKit_EventLevel_System_String_System_String_System_String_System_Object___
|
|
||||||
name: EmitEventOnce
|
|
||||||
nameWithType: CapyEventReporter.EmitEventOnce
|
|
||||||
fullName: CapyKit.CapyEventReporter.EmitEventOnce
|
|
||||||
31
Docs/api/CapyKit.Color.md
Normal file
31
Docs/api/CapyKit.Color.md
Normal file
|
|
@ -0,0 +1,31 @@
|
||||||
|
# <a id="CapyKit_Color"></a> Class Color
|
||||||
|
|
||||||
|
Namespace: [CapyKit](CapyKit.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
An object representing a color.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class Color
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[Color](CapyKit.Color.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<Color\>\(Color, Color\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
|
@ -1,489 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
commentId: T:CapyKit.Color
|
|
||||||
id: Color
|
|
||||||
parent: CapyKit
|
|
||||||
children: []
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Color
|
|
||||||
nameWithType: Color
|
|
||||||
fullName: CapyKit.Color
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Color.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Color
|
|
||||||
path: ../CapyKit/Color.cs
|
|
||||||
startLine: 9
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: An object representing a color.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public class Color
|
|
||||||
content.vb: Public Class Color
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.Color.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color)
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Color.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<Color>(Color, Color)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<Color>(Color, Color)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Color>(CapyKit.Color, CapyKit.Color)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of Color)(Color, Color)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Color)(CapyKit.Color, CapyKit.Color)
|
|
||||||
name.vb: UpdateProperties(Of Color)(Color, Color)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color,CapyKit.Color)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
name: Color
|
|
||||||
href: CapyKit.Color.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
name: Color
|
|
||||||
href: CapyKit.Color.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
name: Color
|
|
||||||
href: CapyKit.Color.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Color,CapyKit.Color)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
name: Color
|
|
||||||
href: CapyKit.Color.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
name: Color
|
|
||||||
href: CapyKit.Color.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Color
|
|
||||||
name: Color
|
|
||||||
href: CapyKit.Color.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
45
Docs/api/CapyKit.EncryptedValue-1.md
Normal file
45
Docs/api/CapyKit.EncryptedValue-1.md
Normal file
|
|
@ -0,0 +1,45 @@
|
||||||
|
# <a id="CapyKit_EncryptedValue_1"></a> Class EncryptedValue<T\>
|
||||||
|
|
||||||
|
Namespace: [CapyKit](CapyKit.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class EncryptedValue<T>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[EncryptedValue<T\>](CapyKit.EncryptedValue\-1.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<EncryptedValue<T\>\>\(EncryptedValue<T\>, EncryptedValue<T\>\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### <a id="CapyKit_EncryptedValue_1_Value"></a> Value
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public T Value { get; set; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
|
@ -1,566 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
commentId: T:CapyKit.EncryptedValue`1
|
|
||||||
id: EncryptedValue`1
|
|
||||||
parent: CapyKit
|
|
||||||
children:
|
|
||||||
- CapyKit.EncryptedValue`1.Value
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EncryptedValue<T>
|
|
||||||
nameWithType: EncryptedValue<T>
|
|
||||||
fullName: CapyKit.EncryptedValue<T>
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/EncryptedValue.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EncryptedValue
|
|
||||||
path: ../CapyKit/EncryptedValue.cs
|
|
||||||
startLine: 8
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
syntax:
|
|
||||||
content: public class EncryptedValue<T>
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
content.vb: Public Class EncryptedValue(Of T)
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.EncryptedValue`1.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{{T}})
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
nameWithType.vb: EncryptedValue(Of T)
|
|
||||||
fullName.vb: CapyKit.EncryptedValue(Of T)
|
|
||||||
name.vb: EncryptedValue(Of T)
|
|
||||||
- uid: CapyKit.EncryptedValue`1.Value
|
|
||||||
commentId: P:CapyKit.EncryptedValue`1.Value
|
|
||||||
id: Value
|
|
||||||
parent: CapyKit.EncryptedValue`1
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Value
|
|
||||||
nameWithType: EncryptedValue<T>.Value
|
|
||||||
fullName: CapyKit.EncryptedValue<T>.Value
|
|
||||||
type: Property
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/EncryptedValue.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Value
|
|
||||||
path: ../CapyKit/EncryptedValue.cs
|
|
||||||
startLine: 18
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
syntax:
|
|
||||||
content: public T Value { get; set; }
|
|
||||||
parameters: []
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
content.vb: Public Property Value As T
|
|
||||||
overload: CapyKit.EncryptedValue`1.Value*
|
|
||||||
nameWithType.vb: EncryptedValue(Of T).Value
|
|
||||||
fullName.vb: CapyKit.EncryptedValue(Of T).Value
|
|
||||||
references:
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.EncryptedValue`1.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{{T}})
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<EncryptedValue<T>>(EncryptedValue<T>, EncryptedValue<T>)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<EncryptedValue<T>>(EncryptedValue<T>, EncryptedValue<T>)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.EncryptedValue<T>>(CapyKit.EncryptedValue<T>, CapyKit.EncryptedValue<T>)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of EncryptedValue(Of T))(EncryptedValue(Of T), EncryptedValue(Of T))
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.EncryptedValue(Of T))(CapyKit.EncryptedValue(Of T), CapyKit.EncryptedValue(Of T))
|
|
||||||
name.vb: UpdateProperties(Of EncryptedValue(Of T))(EncryptedValue(Of T), EncryptedValue(Of T))
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{`0},CapyKit.EncryptedValue{`0})
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EncryptedValue{`0},CapyKit.EncryptedValue{`0})
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.EncryptedValue`1.Value*
|
|
||||||
commentId: Overload:CapyKit.EncryptedValue`1.Value
|
|
||||||
href: CapyKit.EncryptedValue-1.html#CapyKit_EncryptedValue_1_Value
|
|
||||||
name: Value
|
|
||||||
nameWithType: EncryptedValue<T>.Value
|
|
||||||
fullName: CapyKit.EncryptedValue<T>.Value
|
|
||||||
nameWithType.vb: EncryptedValue(Of T).Value
|
|
||||||
fullName.vb: CapyKit.EncryptedValue(Of T).Value
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
36
Docs/api/CapyKit.Enumerations.MeasurementSystem.md
Normal file
36
Docs/api/CapyKit.Enumerations.MeasurementSystem.md
Normal file
|
|
@ -0,0 +1,36 @@
|
||||||
|
# <a id="CapyKit_Enumerations_MeasurementSystem"></a> Enum MeasurementSystem
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Enumerations](CapyKit.Enumerations.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
An enumeration representing different measurement systems.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public enum MeasurementSystem
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[EnumerationExtensions.GetDescription\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetDescription\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetName\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetPrettyName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetPrettyName\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetValue\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetValue\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.Parse<MeasurementSystem\>\(MeasurementSystem, string\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_),
|
||||||
|
[EnumerationExtensions.Parse<MeasurementSystem\>\(MeasurementSystem, string, bool\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_System\_Boolean\_),
|
||||||
|
[ObjectExtensions.UpdateProperties<MeasurementSystem\>\(MeasurementSystem, MeasurementSystem\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
`Imperial = 0`
|
||||||
|
|
||||||
|
The imperial measurement system.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Metric = 1`
|
||||||
|
|
||||||
|
The metric measurement system.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,774 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
commentId: T:CapyKit.Enumerations.MeasurementSystem
|
|
||||||
id: MeasurementSystem
|
|
||||||
parent: CapyKit.Enumerations
|
|
||||||
children:
|
|
||||||
- CapyKit.Enumerations.MeasurementSystem.Imperial
|
|
||||||
- CapyKit.Enumerations.MeasurementSystem.Metric
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: MeasurementSystem
|
|
||||||
nameWithType: MeasurementSystem
|
|
||||||
fullName: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
type: Enum
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Enumerations/MeasurementSystem.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: MeasurementSystem
|
|
||||||
path: ../CapyKit/Enumerations/MeasurementSystem.cs
|
|
||||||
startLine: 11
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Enumerations
|
|
||||||
summary: An enumeration representing different measurement systems.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public enum MeasurementSystem
|
|
||||||
content.vb: Public Enum MeasurementSystem
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
|
|
||||||
- CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
|
|
||||||
- CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem.Imperial
|
|
||||||
commentId: F:CapyKit.Enumerations.MeasurementSystem.Imperial
|
|
||||||
id: Imperial
|
|
||||||
parent: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Imperial
|
|
||||||
nameWithType: MeasurementSystem.Imperial
|
|
||||||
fullName: CapyKit.Enumerations.MeasurementSystem.Imperial
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Enumerations/MeasurementSystem.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Imperial
|
|
||||||
path: ../CapyKit/Enumerations/MeasurementSystem.cs
|
|
||||||
startLine: 14
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Enumerations
|
|
||||||
summary: The imperial measurement system.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: Imperial = 0
|
|
||||||
return:
|
|
||||||
type: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem.Metric
|
|
||||||
commentId: F:CapyKit.Enumerations.MeasurementSystem.Metric
|
|
||||||
id: Metric
|
|
||||||
parent: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Metric
|
|
||||||
nameWithType: MeasurementSystem.Metric
|
|
||||||
fullName: CapyKit.Enumerations.MeasurementSystem.Metric
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Enumerations/MeasurementSystem.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Metric
|
|
||||||
path: ../CapyKit/Enumerations/MeasurementSystem.cs
|
|
||||||
startLine: 17
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Enumerations
|
|
||||||
summary: The metric measurement system.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: Metric = 1
|
|
||||||
return:
|
|
||||||
type: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
commentId: N:CapyKit.Enumerations
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Enumerations
|
|
||||||
nameWithType: CapyKit.Enumerations
|
|
||||||
fullName: CapyKit.Enumerations
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
name: Enumerations
|
|
||||||
href: CapyKit.Enumerations.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
name: Enumerations
|
|
||||||
href: CapyKit.Enumerations.html
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse<MeasurementSystem>(MeasurementSystem, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Enumerations.MeasurementSystem>(CapyKit.Enumerations.MeasurementSystem, string)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of MeasurementSystem)(MeasurementSystem, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Enumerations.MeasurementSystem)(CapyKit.Enumerations.MeasurementSystem, String)
|
|
||||||
name.vb: Parse(Of MeasurementSystem)(MeasurementSystem, String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
name: Parse<MeasurementSystem>(MeasurementSystem, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<MeasurementSystem>(MeasurementSystem, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Enumerations.MeasurementSystem>(CapyKit.Enumerations.MeasurementSystem, string, bool)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of MeasurementSystem)(MeasurementSystem, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Enumerations.MeasurementSystem)(CapyKit.Enumerations.MeasurementSystem, String, Boolean)
|
|
||||||
name.vb: Parse(Of MeasurementSystem)(MeasurementSystem, String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Enumerations.MeasurementSystem,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<MeasurementSystem>(MeasurementSystem, MeasurementSystem)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<MeasurementSystem>(MeasurementSystem, MeasurementSystem)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Enumerations.MeasurementSystem>(CapyKit.Enumerations.MeasurementSystem, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of MeasurementSystem)(MeasurementSystem, MeasurementSystem)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Enumerations.MeasurementSystem)(CapyKit.Enumerations.MeasurementSystem, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name.vb: UpdateProperties(Of MeasurementSystem)(MeasurementSystem, MeasurementSystem)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Enumerations.MeasurementSystem,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse<T>(T, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
name.vb: Parse(Of T)(T, String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.EnumerationExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html
|
|
||||||
name: EnumerationExtensions
|
|
||||||
nameWithType: EnumerationExtensions
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
name: Parse<T>(T, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
name.vb: Parse(Of T)(T, String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
commentId: T:CapyKit.Enumerations.MeasurementSystem
|
|
||||||
parent: CapyKit.Enumerations
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
name: MeasurementSystem
|
|
||||||
nameWithType: MeasurementSystem
|
|
||||||
fullName: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
8
Docs/api/CapyKit.Enumerations.md
Normal file
8
Docs/api/CapyKit.Enumerations.md
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
# <a id="CapyKit_Enumerations"></a> Namespace CapyKit.Enumerations
|
||||||
|
|
||||||
|
### Enums
|
||||||
|
|
||||||
|
[MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)
|
||||||
|
|
||||||
|
An enumeration representing different measurement systems.
|
||||||
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
commentId: N:CapyKit.Enumerations
|
|
||||||
id: CapyKit.Enumerations
|
|
||||||
children:
|
|
||||||
- CapyKit.Enumerations.MeasurementSystem
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyKit.Enumerations
|
|
||||||
nameWithType: CapyKit.Enumerations
|
|
||||||
fullName: CapyKit.Enumerations
|
|
||||||
type: Namespace
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
commentId: T:CapyKit.Enumerations.MeasurementSystem
|
|
||||||
parent: CapyKit.Enumerations
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
name: MeasurementSystem
|
|
||||||
nameWithType: MeasurementSystem
|
|
||||||
fullName: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
commentId: N:CapyKit.Enumerations
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Enumerations
|
|
||||||
nameWithType: CapyKit.Enumerations
|
|
||||||
fullName: CapyKit.Enumerations
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
name: Enumerations
|
|
||||||
href: CapyKit.Enumerations.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
name: Enumerations
|
|
||||||
href: CapyKit.Enumerations.html
|
|
||||||
54
Docs/api/CapyKit.EventLevel.md
Normal file
54
Docs/api/CapyKit.EventLevel.md
Normal file
|
|
@ -0,0 +1,54 @@
|
||||||
|
# <a id="CapyKit_EventLevel"></a> Enum EventLevel
|
||||||
|
|
||||||
|
Namespace: [CapyKit](CapyKit.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Enumeration representing different event level severity values.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public enum EventLevel
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[EnumerationExtensions.GetDescription\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetDescription\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetName\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetPrettyName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetPrettyName\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetValue\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetValue\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.Parse<EventLevel\>\(EventLevel, string\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_),
|
||||||
|
[EnumerationExtensions.Parse<EventLevel\>\(EventLevel, string, bool\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_System\_Boolean\_),
|
||||||
|
[ObjectExtensions.UpdateProperties<EventLevel\>\(EventLevel, EventLevel\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
`Critical = 0`
|
||||||
|
|
||||||
|
Represents a critical error that requires immediate attention.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Debug = 4`
|
||||||
|
|
||||||
|
Represents detailed messages that are typically used for debugging purposes.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Error = 1`
|
||||||
|
|
||||||
|
Represents an error that prevents the normal execution of the application.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Information = 3`
|
||||||
|
|
||||||
|
Represents informational messages that provide useful context to the consumer.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Warning = 2`
|
||||||
|
|
||||||
|
Represents a warning indicating a non-critical issue that should be addressed.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,910 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
commentId: T:CapyKit.EventLevel
|
|
||||||
id: EventLevel
|
|
||||||
parent: CapyKit
|
|
||||||
children:
|
|
||||||
- CapyKit.EventLevel.Critical
|
|
||||||
- CapyKit.EventLevel.Debug
|
|
||||||
- CapyKit.EventLevel.Error
|
|
||||||
- CapyKit.EventLevel.Information
|
|
||||||
- CapyKit.EventLevel.Warning
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EventLevel
|
|
||||||
nameWithType: EventLevel
|
|
||||||
fullName: CapyKit.EventLevel
|
|
||||||
type: Enum
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EventLevel
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 204
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Enumeration representing different event level severity values.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public enum EventLevel
|
|
||||||
content.vb: Public Enum EventLevel
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
|
|
||||||
- CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
|
|
||||||
- CapyKit.EventLevel.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel)
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.EventLevel.Critical
|
|
||||||
commentId: F:CapyKit.EventLevel.Critical
|
|
||||||
id: Critical
|
|
||||||
parent: CapyKit.EventLevel
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Critical
|
|
||||||
nameWithType: EventLevel.Critical
|
|
||||||
fullName: CapyKit.EventLevel.Critical
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Critical
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 207
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Represents a critical error that requires immediate attention.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("Represents a critical error that requires immediate attention.")]
|
|
||||||
|
|
||||||
Critical = 0
|
|
||||||
return:
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("Represents a critical error that requires immediate attention.")>
|
|
||||||
|
|
||||||
Critical = 0
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: Represents a critical error that requires immediate attention.
|
|
||||||
- uid: CapyKit.EventLevel.Error
|
|
||||||
commentId: F:CapyKit.EventLevel.Error
|
|
||||||
id: Error
|
|
||||||
parent: CapyKit.EventLevel
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Error
|
|
||||||
nameWithType: EventLevel.Error
|
|
||||||
fullName: CapyKit.EventLevel.Error
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Error
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 210
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Represents an error that prevents the normal execution of the application.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("Represents an error that prevents the normal execution of the application.")]
|
|
||||||
|
|
||||||
Error = 1
|
|
||||||
return:
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("Represents an error that prevents the normal execution of the application.")>
|
|
||||||
|
|
||||||
Error = 1
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: Represents an error that prevents the normal execution of the application.
|
|
||||||
- uid: CapyKit.EventLevel.Warning
|
|
||||||
commentId: F:CapyKit.EventLevel.Warning
|
|
||||||
id: Warning
|
|
||||||
parent: CapyKit.EventLevel
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Warning
|
|
||||||
nameWithType: EventLevel.Warning
|
|
||||||
fullName: CapyKit.EventLevel.Warning
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Warning
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 213
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Represents a warning indicating a non-critical issue that should be addressed.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("Represents a warning indicating a non-critical issue that should be addressed.")]
|
|
||||||
|
|
||||||
Warning = 2
|
|
||||||
return:
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("Represents a warning indicating a non-critical issue that should be addressed.")>
|
|
||||||
|
|
||||||
Warning = 2
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: Represents a warning indicating a non-critical issue that should be addressed.
|
|
||||||
- uid: CapyKit.EventLevel.Information
|
|
||||||
commentId: F:CapyKit.EventLevel.Information
|
|
||||||
id: Information
|
|
||||||
parent: CapyKit.EventLevel
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Information
|
|
||||||
nameWithType: EventLevel.Information
|
|
||||||
fullName: CapyKit.EventLevel.Information
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Information
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 216
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Represents informational messages that provide useful context to the consumer.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("Represents informational messages that provide useful context to the consumer.")]
|
|
||||||
|
|
||||||
Information = 3
|
|
||||||
return:
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("Represents informational messages that provide useful context to the consumer.")>
|
|
||||||
|
|
||||||
Information = 3
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: Represents informational messages that provide useful context to the consumer.
|
|
||||||
- uid: CapyKit.EventLevel.Debug
|
|
||||||
commentId: F:CapyKit.EventLevel.Debug
|
|
||||||
id: Debug
|
|
||||||
parent: CapyKit.EventLevel
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Debug
|
|
||||||
nameWithType: EventLevel.Debug
|
|
||||||
fullName: CapyKit.EventLevel.Debug
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/CapyEvent.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Debug
|
|
||||||
path: ../CapyKit/CapyEvent.cs
|
|
||||||
startLine: 219
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit
|
|
||||||
summary: Represents detailed messages that are typically used for debugging purposes.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("Represents detailed messages that are typically used for debugging purposes.")]
|
|
||||||
|
|
||||||
Debug = 4
|
|
||||||
return:
|
|
||||||
type: CapyKit.EventLevel
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("Represents detailed messages that are typically used for debugging purposes.")>
|
|
||||||
|
|
||||||
Debug = 4
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: Represents detailed messages that are typically used for debugging purposes.
|
|
||||||
references:
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse<EventLevel>(EventLevel, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<EventLevel>(EventLevel, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.EventLevel>(CapyKit.EventLevel, string)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of EventLevel)(EventLevel, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.EventLevel)(CapyKit.EventLevel, String)
|
|
||||||
name.vb: Parse(Of EventLevel)(EventLevel, String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.EventLevel.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
name: Parse<EventLevel>(EventLevel, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<EventLevel>(EventLevel, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.EventLevel>(CapyKit.EventLevel, string, bool)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of EventLevel)(EventLevel, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.EventLevel)(CapyKit.EventLevel, String, Boolean)
|
|
||||||
name.vb: Parse(Of EventLevel)(EventLevel, String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.EventLevel,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.EventLevel.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<EventLevel>(EventLevel, EventLevel)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<EventLevel>(EventLevel, EventLevel)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.EventLevel>(CapyKit.EventLevel, CapyKit.EventLevel)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of EventLevel)(EventLevel, EventLevel)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.EventLevel)(CapyKit.EventLevel, CapyKit.EventLevel)
|
|
||||||
name.vb: UpdateProperties(Of EventLevel)(EventLevel, EventLevel)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel,CapyKit.EventLevel)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.EventLevel,CapyKit.EventLevel)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
name: EventLevel
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse<T>(T, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
name.vb: Parse(Of T)(T, String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.EnumerationExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html
|
|
||||||
name: EnumerationExtensions
|
|
||||||
nameWithType: EnumerationExtensions
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
name: Parse<T>(T, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
name.vb: Parse(Of T)(T, String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.EventLevel
|
|
||||||
commentId: T:CapyKit.EventLevel
|
|
||||||
parent: CapyKit
|
|
||||||
href: CapyKit.EventLevel.html
|
|
||||||
name: EventLevel
|
|
||||||
nameWithType: EventLevel
|
|
||||||
fullName: CapyKit.EventLevel
|
|
||||||
176
Docs/api/CapyKit.Extensions.EnumerationExtensions.md
Normal file
176
Docs/api/CapyKit.Extensions.EnumerationExtensions.md
Normal file
|
|
@ -0,0 +1,176 @@
|
||||||
|
# <a id="CapyKit_Extensions_EnumerationExtensions"></a> Class EnumerationExtensions
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class EnumerationExtensions
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[EnumerationExtensions](CapyKit.Extensions.EnumerationExtensions.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_"></a> GetDescription\(Enum\)
|
||||||
|
|
||||||
|
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a description.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string GetDescription(this Enum enumeration)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
|
||||||
|
|
||||||
|
The enumeration to act on.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The description if available, otherwise the string representation of the enumeration.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_"></a> GetName\(Enum\)
|
||||||
|
|
||||||
|
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a name.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string GetName(this Enum enumeration)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
|
||||||
|
|
||||||
|
The enumeration to act on.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The name of the enumeration.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_"></a> GetPrettyName\(Enum\)
|
||||||
|
|
||||||
|
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a human readable name.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string GetPrettyName(this Enum enumeration)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
|
||||||
|
|
||||||
|
The enumeration to act on.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The human readable name of the enumeration.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_"></a> GetValue\(Enum\)
|
||||||
|
|
||||||
|
An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets an integer value representing the enumation.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static int GetValue(this Enum enumeration)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`enumeration` [Enum](https://learn.microsoft.com/dotnet/api/system.enum)
|
||||||
|
|
||||||
|
The enumeration to act on.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The integer value of the enumeration.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_"></a> Parse<T\>\(T, string\)
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Parse<T>(this T enumeration, string value) where T : Enum
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`enumeration` T
|
||||||
|
|
||||||
|
The enumeration to act on.
|
||||||
|
|
||||||
|
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The value.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A T.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_"></a> Parse<T\>\(T, string, bool\)
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`enumeration` T
|
||||||
|
|
||||||
|
The enumeration to act on.
|
||||||
|
|
||||||
|
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The string value of the <xref href="System.Enum" data-throw-if-not-resolved="false"></xref>.
|
||||||
|
|
||||||
|
`ignoreCase` [bool](https://learn.microsoft.com/dotnet/api/system.boolean)
|
||||||
|
|
||||||
|
True to ignore case.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A T.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
|
@ -1,624 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.EnumerationExtensions
|
|
||||||
id: EnumerationExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
children:
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EnumerationExtensions
|
|
||||||
nameWithType: EnumerationExtensions
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EnumerationExtensions
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 12
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static class EnumerationExtensions
|
|
||||||
content.vb: Public Module EnumerationExtensions
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
id: Parse``1(``0,System.String)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Parse<T>(T, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Parse
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 23
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: 'public static T Parse<T>(this T enumeration, string value) where T : Enum'
|
|
||||||
parameters:
|
|
||||||
- id: enumeration
|
|
||||||
type: '{T}'
|
|
||||||
description: The enumeration to act on.
|
|
||||||
- id: value
|
|
||||||
type: System.String
|
|
||||||
description: The value.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A T.
|
|
||||||
content.vb: Public Shared Function Parse(Of T As [Enum])(enumeration As T, value As String) As T
|
|
||||||
overload: CapyKit.Extensions.EnumerationExtensions.Parse*
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
name.vb: Parse(Of T)(T, String)
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
id: Parse``1(``0,System.String,System.Boolean)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Parse<T>(T, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Parse
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 36
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: 'public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum'
|
|
||||||
parameters:
|
|
||||||
- id: enumeration
|
|
||||||
type: '{T}'
|
|
||||||
description: The enumeration to act on.
|
|
||||||
- id: value
|
|
||||||
type: System.String
|
|
||||||
description: The string value of the <xref href="System.Enum" data-throw-if-not-resolved="false"></xref>.
|
|
||||||
- id: ignoreCase
|
|
||||||
type: System.Boolean
|
|
||||||
description: True to ignore case.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A T.
|
|
||||||
content.vb: Public Shared Function Parse(Of T As [Enum])(enumeration As T, value As String, ignoreCase As Boolean) As T
|
|
||||||
overload: CapyKit.Extensions.EnumerationExtensions.Parse*
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
name.vb: Parse(Of T)(T, String, Boolean)
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
id: GetValue(System.Enum)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetValue
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 46
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets an integer value representing the enumation.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static int GetValue(this Enum enumeration)
|
|
||||||
parameters:
|
|
||||||
- id: enumeration
|
|
||||||
type: System.Enum
|
|
||||||
description: The enumeration to act on.
|
|
||||||
return:
|
|
||||||
type: System.Int32
|
|
||||||
description: The integer value of the enumeration.
|
|
||||||
content.vb: Public Shared Function GetValue(enumeration As [Enum]) As Integer
|
|
||||||
overload: CapyKit.Extensions.EnumerationExtensions.GetValue*
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
id: GetName(System.Enum)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetName
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 54
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a name.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string GetName(this Enum enumeration)
|
|
||||||
parameters:
|
|
||||||
- id: enumeration
|
|
||||||
type: System.Enum
|
|
||||||
description: The enumeration to act on.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: The name of the enumeration.
|
|
||||||
content.vb: Public Shared Function GetName(enumeration As [Enum]) As String
|
|
||||||
overload: CapyKit.Extensions.EnumerationExtensions.GetName*
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
id: GetPrettyName(System.Enum)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetPrettyName
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 62
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a human readable name.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string GetPrettyName(this Enum enumeration)
|
|
||||||
parameters:
|
|
||||||
- id: enumeration
|
|
||||||
type: System.Enum
|
|
||||||
description: The enumeration to act on.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: The human readable name of the enumeration.
|
|
||||||
content.vb: Public Shared Function GetPrettyName(enumeration As [Enum]) As String
|
|
||||||
overload: CapyKit.Extensions.EnumerationExtensions.GetPrettyName*
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
id: GetDescription(System.Enum)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetDescription
|
|
||||||
path: ../CapyKit/Extensions/EnumerationExtensions.cs
|
|
||||||
startLine: 72
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a description.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string GetDescription(this Enum enumeration)
|
|
||||||
parameters:
|
|
||||||
- id: enumeration
|
|
||||||
type: System.Enum
|
|
||||||
description: The enumeration to act on.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: The description if available, otherwise the string representation of the enumeration.
|
|
||||||
content.vb: Public Shared Function GetDescription(enumeration As [Enum]) As String
|
|
||||||
overload: CapyKit.Extensions.EnumerationExtensions.GetDescription*
|
|
||||||
references:
|
|
||||||
- uid: System.Enum
|
|
||||||
commentId: T:System.Enum
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
name: Enum
|
|
||||||
nameWithType: Enum
|
|
||||||
fullName: System.Enum
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse*
|
|
||||||
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse
|
|
||||||
nameWithType: EnumerationExtensions.Parse
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: System.Boolean
|
|
||||||
commentId: T:System.Boolean
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
name: bool
|
|
||||||
nameWithType: bool
|
|
||||||
fullName: bool
|
|
||||||
nameWithType.vb: Boolean
|
|
||||||
fullName.vb: Boolean
|
|
||||||
name.vb: Boolean
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue*
|
|
||||||
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue
|
|
||||||
nameWithType: EnumerationExtensions.GetValue
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
- uid: System.Int32
|
|
||||||
commentId: T:System.Int32
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.int32
|
|
||||||
name: int
|
|
||||||
nameWithType: int
|
|
||||||
fullName: int
|
|
||||||
nameWithType.vb: Integer
|
|
||||||
fullName.vb: Integer
|
|
||||||
name.vb: Integer
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName*
|
|
||||||
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName
|
|
||||||
nameWithType: EnumerationExtensions.GetName
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName*
|
|
||||||
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription*
|
|
||||||
commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
408
Docs/api/CapyKit.Extensions.LINQExtensions.md
Normal file
408
Docs/api/CapyKit.Extensions.LINQExtensions.md
Normal file
|
|
@ -0,0 +1,408 @@
|
||||||
|
# <a id="CapyKit_Extensions_LINQExtensions"></a> Class LINQExtensions
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Provides static extension methods for performing common LINQ operations on <xref href="System.Collections.Generic.IEnumerable%601" data-throw-if-not-resolved="false"></xref> and <xref href="System.Linq.IQueryable%601" data-throw-if-not-resolved="false"></xref> collections.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class LINQExtensions
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[LINQExtensions](CapyKit.Extensions.LINQExtensions.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_Distinct__2_System_Collections_Generic_IEnumerable___0__System_Func___0___1__"></a> Distinct<T, U\>\(IEnumerable<T\>, Func<T, U\>\)
|
||||||
|
|
||||||
|
Enumerates distinct items in this collection as defined by the key <code class="paramref">property</code>.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IEnumerable<T> Distinct<T, U>(this IEnumerable<T> items, Func<T, U> property)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`items` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
The items to act on.
|
||||||
|
|
||||||
|
`property` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
|
||||||
|
|
||||||
|
The property.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
An enumerator that allows foreach to be used to process distinct items in this collection.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter of the parent object.
|
||||||
|
|
||||||
|
`U`
|
||||||
|
|
||||||
|
Generic type parameter property value.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Collections_Generic_IEnumerable___0__System_Func___0_System_Boolean__"></a> Filter<T\>\(IEnumerable<T\>, Func<T, bool\>\)
|
||||||
|
|
||||||
|
Filters out items matching a <code class="paramref">predicate</code> from the collection.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IEnumerable<T> Filter<T>(this IEnumerable<T> source, Func<T, bool> predicate)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`predicate` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, [bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>
|
||||||
|
|
||||||
|
The predicate.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
An enumerator that allows foreach to be used to process remove in this collection.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_Filter__1_System_Linq_IQueryable___0__System_Linq_Expressions_Expression_System_Func___0_System_Boolean___"></a> Filter<T\>\(IQueryable<T\>, Expression<Func<T, bool\>\>\)
|
||||||
|
|
||||||
|
Filters out items matching a <code class="paramref">predicate</code> from the collection.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IQueryable<T> Filter<T>(this IQueryable<T> source, Expression<Func<T, bool>> predicate)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`predicate` [Expression](https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression\-1)<[Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, [bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>\>
|
||||||
|
|
||||||
|
The predicate.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
|
||||||
|
|
||||||
|
An enumerator that allows foreach to be used to process remove in this collection.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_System_Linq_IQueryable___0__System_Linq_IQueryable___1__System_Linq_Expressions_Expression_System_Func___0___2___System_Linq_Expressions_Expression_System_Func___1___2___System_Func___0_System_Collections_Generic_IEnumerable___1____3__System_Func___0___1__"></a> LeftOuterJoin<T, U, TKey, R\>\(IQueryable<T\>, IQueryable<U\>, Expression<Func<T, TKey\>\>, Expression<Func<U, TKey\>\>, Func<T, IEnumerable<U\>, R\>, Func<T, U\>\)
|
||||||
|
|
||||||
|
An IQueryable<T> extension method that left outer join.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IQueryable<R> LeftOuterJoin<T, U, TKey, R>(this IQueryable<T> source, IQueryable<U> inner, Expression<Func<T, TKey>> outerSelector, Expression<Func<U, TKey>> innerSelector, Func<T, IEnumerable<U>, R> resultSelector, Func<T, U> defaultGenerator = null)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`inner` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<U\>
|
||||||
|
|
||||||
|
The inner.
|
||||||
|
|
||||||
|
`outerSelector` [Expression](https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression\-1)<[Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, TKey\>\>
|
||||||
|
|
||||||
|
The outer selector.
|
||||||
|
|
||||||
|
`innerSelector` [Expression](https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression\-1)<[Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<U, TKey\>\>
|
||||||
|
|
||||||
|
The inner selector.
|
||||||
|
|
||||||
|
`resultSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-3)<T, [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<U\>, R\>
|
||||||
|
|
||||||
|
The result selector.
|
||||||
|
|
||||||
|
`defaultGenerator` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
|
||||||
|
|
||||||
|
(Optional) The default generator.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<R\>
|
||||||
|
|
||||||
|
An IQueryable<R>
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
`U`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
`TKey`
|
||||||
|
|
||||||
|
Type of the key.
|
||||||
|
|
||||||
|
`R`
|
||||||
|
|
||||||
|
Type of the r.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_LeftOuterJoin__4_System_Collections_Generic_IEnumerable___0__System_Collections_Generic_IEnumerable___1__System_Func___0___2__System_Func___1___2__System_Func___0_System_Collections_Generic_IEnumerable___1____3__System_Func___0___1__"></a> LeftOuterJoin<T, U, TKey, R\>\(IEnumerable<T\>, IEnumerable<U\>, Func<T, TKey\>, Func<U, TKey\>, Func<T, IEnumerable<U\>, R\>, Func<T, U\>\)
|
||||||
|
|
||||||
|
An IEnumable<T> extension method that left outer join.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IEnumerable<R> LeftOuterJoin<T, U, TKey, R>(this IEnumerable<T> source, IEnumerable<U> inner, Func<T, TKey> outerSelector, Func<U, TKey> innerSelector, Func<T, IEnumerable<U>, R> resultSelector, Func<T, U> defaultGenerator = null)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`inner` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<U\>
|
||||||
|
|
||||||
|
The inner.
|
||||||
|
|
||||||
|
`outerSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, TKey\>
|
||||||
|
|
||||||
|
The outer selector.
|
||||||
|
|
||||||
|
`innerSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<U, TKey\>
|
||||||
|
|
||||||
|
The inner selector.
|
||||||
|
|
||||||
|
`resultSelector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-3)<T, [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<U\>, R\>
|
||||||
|
|
||||||
|
The result selector.
|
||||||
|
|
||||||
|
`defaultGenerator` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<T, U\>
|
||||||
|
|
||||||
|
(Optional) The default generator.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<R\>
|
||||||
|
|
||||||
|
An enumerator that allows foreach to be used to process left outter join in this collection.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
`U`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
`TKey`
|
||||||
|
|
||||||
|
Type of the key.
|
||||||
|
|
||||||
|
`R`
|
||||||
|
|
||||||
|
Type of the r.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_Page__1_System_Collections_Generic_IEnumerable___0__System_Int32_System_Int32_"></a> Page<T\>\(IEnumerable<T\>, int, int\)
|
||||||
|
|
||||||
|
Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||||
|
<code class="paramref">pageSize</code> items per page.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IEnumerable<T> Page<T>(this IEnumerable<T> source, int pageNumber, int pageSize)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`pageNumber` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The page number to retrieve.
|
||||||
|
|
||||||
|
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
Number of items per page.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
An enumerator that allows foreach to be used to process page in this collection.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method uses natural numbering starting at page 1.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
|
||||||
|
|
||||||
|
Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
|
||||||
|
<code class="paramref">pageSize</code> is less than
|
||||||
|
<code>1</code>.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_Page__1_System_Linq_IQueryable___0__System_Int32_System_Int32_"></a> Page<T\>\(IQueryable<T\>, int, int\)
|
||||||
|
|
||||||
|
Get a page of items from a collection, skipping <code class="paramref">pageNumber</code> pages of
|
||||||
|
<code class="paramref">pageSize</code> items per page.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static IQueryable<T> Page<T>(this IQueryable<T> source, int pageNumber, int pageSize)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`pageNumber` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The page number to retrieve.
|
||||||
|
|
||||||
|
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
|
||||||
|
|
||||||
|
An enumerator that allows foreach to be used to process page in this collection.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method uses natural numbering starting at page 1.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
|
||||||
|
|
||||||
|
Thrown when <code class="paramref">pageNumber</code> is less than <code>1</code> or if
|
||||||
|
<code class="paramref">pageSize</code> is less than
|
||||||
|
<code>1</code>.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Collections_Generic_IEnumerable___0__System_Int32_"></a> PageCount<T\>\(IEnumerable<T\>, int\)
|
||||||
|
|
||||||
|
The number of pages of <code class="paramref">pageSize</code> size in the given collection.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static int PageCount<T>(this IEnumerable<T> source, int pageSize)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IEnumerable](https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
Size of the page.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
An int.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
|
||||||
|
|
||||||
|
Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_LINQExtensions_PageCount__1_System_Linq_IQueryable___0__System_Int32_"></a> PageCount<T\>\(IQueryable<T\>, int\)
|
||||||
|
|
||||||
|
The number of pages of <code class="paramref">pageSize</code> size in the given collection.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static int PageCount<T>(this IQueryable<T> source, int pageSize)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`source` [IQueryable](https://learn.microsoft.com/dotnet/api/system.linq.iqueryable\-1)<T\>
|
||||||
|
|
||||||
|
The source to act on.
|
||||||
|
|
||||||
|
`pageSize` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
Size of the page.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
An int.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentOutOfRangeException](https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception)
|
||||||
|
|
||||||
|
Thrown when <code class="paramref">pageSize</code> is less than <code>1</code>.
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
76
Docs/api/CapyKit.Extensions.ObjectExtensions.md
Normal file
76
Docs/api/CapyKit.Extensions.ObjectExtensions.md
Normal file
|
|
@ -0,0 +1,76 @@
|
||||||
|
# <a id="CapyKit_Extensions_ObjectExtensions"></a> Class ObjectExtensions
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
An class containing extenstions that apply to any object type.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class ObjectExtensions
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[ObjectExtensions](CapyKit.Extensions.ObjectExtensions.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_"></a> UpdateProperties<T\>\(T, T\)
|
||||||
|
|
||||||
|
An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||||
|
object with the values from a given <code class="paramref">source</code> object.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void UpdateProperties<T>(this T target, T source)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`target` T
|
||||||
|
|
||||||
|
The target object to act on.
|
||||||
|
|
||||||
|
`source` T
|
||||||
|
|
||||||
|
Source for the new property values.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_"></a> UpdateProperties\(object, object\)
|
||||||
|
|
||||||
|
An object extension method that updates the properties of a given <code class="paramref">target</code>
|
||||||
|
object with the values from a given <code class="paramref">source</code> object.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void UpdateProperties(this object target, object source)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`target` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
The target object to act on.
|
||||||
|
|
||||||
|
`source` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
Source for the new property values.
|
||||||
|
|
||||||
|
|
@ -1,405 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
id: ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
children:
|
|
||||||
- CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
- CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/ObjectExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: ObjectExtensions
|
|
||||||
path: ../CapyKit/Extensions/ObjectExtensions.cs
|
|
||||||
startLine: 9
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: An class containing extenstions that apply to any object type.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static class ObjectExtensions
|
|
||||||
content.vb: Public Module ObjectExtensions
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
id: UpdateProperties``1(``0,``0)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/ObjectExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: UpdateProperties
|
|
||||||
path: ../CapyKit/Extensions/ObjectExtensions.cs
|
|
||||||
startLine: 18
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: >-
|
|
||||||
An object extension method that updates the properties of a given <code class="paramref">target</code>
|
|
||||||
|
|
||||||
object with the values from a given <code class="paramref">source</code> object.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void UpdateProperties<T>(this T target, T source)
|
|
||||||
parameters:
|
|
||||||
- id: target
|
|
||||||
type: '{T}'
|
|
||||||
description: The target object to act on.
|
|
||||||
- id: source
|
|
||||||
type: '{T}'
|
|
||||||
description: Source for the new property values.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
content.vb: Public Shared Sub UpdateProperties(Of T)(target As T, source As T)
|
|
||||||
overload: CapyKit.Extensions.ObjectExtensions.UpdateProperties*
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
id: UpdateProperties(System.Object,System.Object)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/ObjectExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: UpdateProperties
|
|
||||||
path: ../CapyKit/Extensions/ObjectExtensions.cs
|
|
||||||
startLine: 36
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: >-
|
|
||||||
An object extension method that updates the properties of a given <code class="paramref">target</code>
|
|
||||||
|
|
||||||
object with the values from a given <code class="paramref">source</code> object.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void UpdateProperties(this object target, object source)
|
|
||||||
parameters:
|
|
||||||
- id: target
|
|
||||||
type: System.Object
|
|
||||||
description: The target object to act on.
|
|
||||||
- id: source
|
|
||||||
type: System.Object
|
|
||||||
description: Source for the new property values.
|
|
||||||
content.vb: Public Shared Sub UpdateProperties(target As Object, source As Object)
|
|
||||||
overload: CapyKit.Extensions.ObjectExtensions.UpdateProperties*
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties*
|
|
||||||
commentId: Overload:CapyKit.Extensions.ObjectExtensions.UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
88
Docs/api/CapyKit.Extensions.StringExtensions.md
Normal file
88
Docs/api/CapyKit.Extensions.StringExtensions.md
Normal file
|
|
@ -0,0 +1,88 @@
|
||||||
|
# <a id="CapyKit_Extensions_StringExtensions"></a> Class StringExtensions
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Extensions](CapyKit.Extensions.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Provides static extentions methods for providing additional functionality for <xref href="System.String" data-throw-if-not-resolved="false"></xref> types.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class StringExtensions
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[StringExtensions](CapyKit.Extensions.StringExtensions.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_"></a> IfNullOrEmpty\(string, string\)
|
||||||
|
|
||||||
|
Replaces a null or empty string with a specified replacement string.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string IfNullOrEmpty(this string value, string replacement)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The original string.
|
||||||
|
|
||||||
|
`replacement` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The replacement string.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The original string if not null or empty, otherwise the replacement string.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string).[IsNullOrEmpty](https://learn.microsoft.com/dotnet/api/system.string.isnullorempty)\([string](https://learn.microsoft.com/dotnet/api/system.string)?\)
|
||||||
|
|
||||||
|
### <a id="CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_"></a> IfNullOrWhiteSpace\(string, string\)
|
||||||
|
|
||||||
|
Replaces a null or whitespace string with a specified replacement string.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string IfNullOrWhiteSpace(this string value, string replacement)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The original string.
|
||||||
|
|
||||||
|
`replacement` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The replacement string.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The original string if not null or whitespace, otherwise the replacement string.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string).[IsNullOrWhiteSpace](https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace)\([string](https://learn.microsoft.com/dotnet/api/system.string)?\)
|
||||||
|
|
||||||
|
|
@ -1,479 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Extensions.StringExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.StringExtensions
|
|
||||||
id: StringExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
children:
|
|
||||||
- CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)
|
|
||||||
- CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: StringExtensions
|
|
||||||
nameWithType: StringExtensions
|
|
||||||
fullName: CapyKit.Extensions.StringExtensions
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/StringExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: StringExtensions
|
|
||||||
path: ../CapyKit/Extensions/StringExtensions.cs
|
|
||||||
startLine: 9
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: Provides static extentions methods for providing additional functionality for <xref href="System.String" data-throw-if-not-resolved="false"></xref> types.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static class StringExtensions
|
|
||||||
content.vb: Public Module StringExtensions
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.StringExtensions.IfNullOrEmpty(System.String,System.String)
|
|
||||||
id: IfNullOrEmpty(System.String,System.String)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.StringExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: IfNullOrEmpty(string, string)
|
|
||||||
nameWithType: StringExtensions.IfNullOrEmpty(string, string)
|
|
||||||
fullName: CapyKit.Extensions.StringExtensions.IfNullOrEmpty(string, string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/StringExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: IfNullOrEmpty
|
|
||||||
path: ../CapyKit/Extensions/StringExtensions.cs
|
|
||||||
startLine: 26
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: Replaces a null or empty string with a specified replacement string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string IfNullOrEmpty(this string value, string replacement)
|
|
||||||
parameters:
|
|
||||||
- id: value
|
|
||||||
type: System.String
|
|
||||||
description: The original string.
|
|
||||||
- id: replacement
|
|
||||||
type: System.String
|
|
||||||
description: The replacement string.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: The original string if not null or empty, otherwise the replacement string.
|
|
||||||
content.vb: Public Shared Function IfNullOrEmpty(value As String, replacement As String) As String
|
|
||||||
overload: CapyKit.Extensions.StringExtensions.IfNullOrEmpty*
|
|
||||||
seealso:
|
|
||||||
- linkId: System.String.IsNullOrEmpty(System.String)
|
|
||||||
commentId: M:System.String.IsNullOrEmpty(System.String)
|
|
||||||
nameWithType.vb: StringExtensions.IfNullOrEmpty(String, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.StringExtensions.IfNullOrEmpty(String, String)
|
|
||||||
name.vb: IfNullOrEmpty(String, String)
|
|
||||||
- uid: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(System.String,System.String)
|
|
||||||
id: IfNullOrWhiteSpace(System.String,System.String)
|
|
||||||
isExtensionMethod: true
|
|
||||||
parent: CapyKit.Extensions.StringExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: IfNullOrWhiteSpace(string, string)
|
|
||||||
nameWithType: StringExtensions.IfNullOrWhiteSpace(string, string)
|
|
||||||
fullName: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(string, string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Extensions/StringExtensions.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: IfNullOrWhiteSpace
|
|
||||||
path: ../CapyKit/Extensions/StringExtensions.cs
|
|
||||||
startLine: 43
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Extensions
|
|
||||||
summary: Replaces a null or whitespace string with a specified replacement string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string IfNullOrWhiteSpace(this string value, string replacement)
|
|
||||||
parameters:
|
|
||||||
- id: value
|
|
||||||
type: System.String
|
|
||||||
description: The original string.
|
|
||||||
- id: replacement
|
|
||||||
type: System.String
|
|
||||||
description: The replacement string.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: The original string if not null or whitespace, otherwise the replacement string.
|
|
||||||
content.vb: Public Shared Function IfNullOrWhiteSpace(value As String, replacement As String) As String
|
|
||||||
overload: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace*
|
|
||||||
seealso:
|
|
||||||
- linkId: System.String.IsNullOrWhiteSpace(System.String)
|
|
||||||
commentId: M:System.String.IsNullOrWhiteSpace(System.String)
|
|
||||||
nameWithType.vb: StringExtensions.IfNullOrWhiteSpace(String, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace(String, String)
|
|
||||||
name.vb: IfNullOrWhiteSpace(String, String)
|
|
||||||
references:
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: System.String.IsNullOrEmpty(System.String)
|
|
||||||
commentId: M:System.String.IsNullOrEmpty(System.String)
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorempty
|
|
||||||
name: IsNullOrEmpty(string)
|
|
||||||
nameWithType: string.IsNullOrEmpty(string)
|
|
||||||
fullName: string.IsNullOrEmpty(string)
|
|
||||||
nameWithType.vb: String.IsNullOrEmpty(String)
|
|
||||||
fullName.vb: String.IsNullOrEmpty(String)
|
|
||||||
name.vb: IsNullOrEmpty(String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.String.IsNullOrEmpty(System.String)
|
|
||||||
name: IsNullOrEmpty
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorempty
|
|
||||||
- name: (
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.String.IsNullOrEmpty(System.String)
|
|
||||||
name: IsNullOrEmpty
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorempty
|
|
||||||
- name: (
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.StringExtensions.IfNullOrEmpty*
|
|
||||||
commentId: Overload:CapyKit.Extensions.StringExtensions.IfNullOrEmpty
|
|
||||||
href: CapyKit.Extensions.StringExtensions.html#CapyKit_Extensions_StringExtensions_IfNullOrEmpty_System_String_System_String_
|
|
||||||
name: IfNullOrEmpty
|
|
||||||
nameWithType: StringExtensions.IfNullOrEmpty
|
|
||||||
fullName: CapyKit.Extensions.StringExtensions.IfNullOrEmpty
|
|
||||||
- uid: System.String.IsNullOrWhiteSpace(System.String)
|
|
||||||
commentId: M:System.String.IsNullOrWhiteSpace(System.String)
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace
|
|
||||||
name: IsNullOrWhiteSpace(string)
|
|
||||||
nameWithType: string.IsNullOrWhiteSpace(string)
|
|
||||||
fullName: string.IsNullOrWhiteSpace(string)
|
|
||||||
nameWithType.vb: String.IsNullOrWhiteSpace(String)
|
|
||||||
fullName.vb: String.IsNullOrWhiteSpace(String)
|
|
||||||
name.vb: IsNullOrWhiteSpace(String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.String.IsNullOrWhiteSpace(System.String)
|
|
||||||
name: IsNullOrWhiteSpace
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace
|
|
||||||
- name: (
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.String.IsNullOrWhiteSpace(System.String)
|
|
||||||
name: IsNullOrWhiteSpace
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace
|
|
||||||
- name: (
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace*
|
|
||||||
commentId: Overload:CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace
|
|
||||||
href: CapyKit.Extensions.StringExtensions.html#CapyKit_Extensions_StringExtensions_IfNullOrWhiteSpace_System_String_System_String_
|
|
||||||
name: IfNullOrWhiteSpace
|
|
||||||
nameWithType: StringExtensions.IfNullOrWhiteSpace
|
|
||||||
fullName: CapyKit.Extensions.StringExtensions.IfNullOrWhiteSpace
|
|
||||||
20
Docs/api/CapyKit.Extensions.md
Normal file
20
Docs/api/CapyKit.Extensions.md
Normal file
|
|
@ -0,0 +1,20 @@
|
||||||
|
# <a id="CapyKit_Extensions"></a> Namespace CapyKit.Extensions
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
|
||||||
|
[EnumerationExtensions](CapyKit.Extensions.EnumerationExtensions.md)
|
||||||
|
|
||||||
|
Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
|
||||||
|
|
||||||
|
[LINQExtensions](CapyKit.Extensions.LINQExtensions.md)
|
||||||
|
|
||||||
|
Provides static extension methods for performing common LINQ operations on <xref href="System.Collections.Generic.IEnumerable%601" data-throw-if-not-resolved="false"></xref> and <xref href="System.Linq.IQueryable%601" data-throw-if-not-resolved="false"></xref> collections.
|
||||||
|
|
||||||
|
[ObjectExtensions](CapyKit.Extensions.ObjectExtensions.md)
|
||||||
|
|
||||||
|
An class containing extenstions that apply to any object type.
|
||||||
|
|
||||||
|
[StringExtensions](CapyKit.Extensions.StringExtensions.md)
|
||||||
|
|
||||||
|
Provides static extentions methods for providing additional functionality for <xref href="System.String" data-throw-if-not-resolved="false"></xref> types.
|
||||||
|
|
||||||
|
|
@ -1,68 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
id: CapyKit.Extensions
|
|
||||||
children:
|
|
||||||
- CapyKit.Extensions.EnumerationExtensions
|
|
||||||
- CapyKit.Extensions.LINQExtensions
|
|
||||||
- CapyKit.Extensions.ObjectExtensions
|
|
||||||
- CapyKit.Extensions.StringExtensions
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
type: Namespace
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.EnumerationExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html
|
|
||||||
name: EnumerationExtensions
|
|
||||||
nameWithType: EnumerationExtensions
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
- uid: CapyKit.Extensions.LINQExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.LINQExtensions
|
|
||||||
href: CapyKit.Extensions.LINQExtensions.html
|
|
||||||
name: LINQExtensions
|
|
||||||
nameWithType: LINQExtensions
|
|
||||||
fullName: CapyKit.Extensions.LINQExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.StringExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.StringExtensions
|
|
||||||
href: CapyKit.Extensions.StringExtensions.html
|
|
||||||
name: StringExtensions
|
|
||||||
nameWithType: StringExtensions
|
|
||||||
fullName: CapyKit.Extensions.StringExtensions
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
269
Docs/api/CapyKit.Helpers.CalculationHelper.md
Normal file
269
Docs/api/CapyKit.Helpers.CalculationHelper.md
Normal file
|
|
@ -0,0 +1,269 @@
|
||||||
|
# <a id="CapyKit_Helpers_CalculationHelper"></a> Class CalculationHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Static class providing helper methods for various calculations.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class CalculationHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[CalculationHelper](CapyKit.Helpers.CalculationHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS"></a> EARTH\_RADIUS\_KILOMETERS
|
||||||
|
|
||||||
|
The earth's radius in kilometers.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public const int EARTH_RADIUS_KILOMETERS = 6371
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Field Value
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER"></a> MILES\_PER\_KILOMETER
|
||||||
|
|
||||||
|
Ratio of miles per kilometer .
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public const double MILES_PER_KILOMETER = 0.621371
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Field Value
|
||||||
|
|
||||||
|
[double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_"></a> CalculateHash\(string\)
|
||||||
|
|
||||||
|
Calculates the hash of a given string using an <xref href="System.Security.Cryptography.MD5" data-throw-if-not-resolved="false"></xref> value as the first 32 bits.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static int CalculateHash(string str)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`str` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The string to be hashed.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The calculated hash.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method is used for a quick and consistent hash function. It should not be considered
|
||||||
|
cryptographically sound or used in security contexts.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_"></a> CalculateHexHash\(string\)
|
||||||
|
|
||||||
|
Calculates the hexadecimal hash.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string CalculateHexHash(string str)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`str` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The string to be hashed.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The calculated 16 character hexadecimal hash.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_"></a> DegreesToRadians\(double\)
|
||||||
|
|
||||||
|
Convers degrees to radians.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static double DegreesToRadians(double degrees)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`degrees` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The degree value.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The value as radians.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_"></a> GetDistance\(decimal, decimal, decimal, decimal, MeasurementSystem\)
|
||||||
|
|
||||||
|
Gets the distance between two points on earth using the <code>haversine</code> formula.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`latitudeOrigin` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
|
||||||
|
|
||||||
|
The latitude origin.
|
||||||
|
|
||||||
|
`longitudeOrigin` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
|
||||||
|
|
||||||
|
The longitude origin.
|
||||||
|
|
||||||
|
`latitudeDestination` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
|
||||||
|
|
||||||
|
The latitude destination.
|
||||||
|
|
||||||
|
`longitudeDestination` [decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
|
||||||
|
|
||||||
|
The longitude destination.
|
||||||
|
|
||||||
|
`measurementSystem` [MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)
|
||||||
|
|
||||||
|
(Optional) The measurement system.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[decimal](https://learn.microsoft.com/dotnet/api/system.decimal)
|
||||||
|
|
||||||
|
The distance.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||||
|
to calculate the "as-the-crow-flies" distance between two points on earth.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[CalculationHelper](CapyKit.Helpers.CalculationHelper.md).[GetDistance](CapyKit.Helpers.CalculationHelper.md\#CapyKit\_Helpers\_CalculationHelper\_GetDistance\_System\_Double\_System\_Double\_System\_Double\_System\_Double\_CapyKit\_Enumerations\_MeasurementSystem\_)\([double](https://learn.microsoft.com/dotnet/api/system.double), [double](https://learn.microsoft.com/dotnet/api/system.double), [double](https://learn.microsoft.com/dotnet/api/system.double), [double](https://learn.microsoft.com/dotnet/api/system.double), [MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)\)
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_"></a> GetDistance\(double, double, double, double, MeasurementSystem\)
|
||||||
|
|
||||||
|
Gets the distance between two points on earth using the <code>haversine</code> formula.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`latitudeOrigin` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The latitude of the origin.
|
||||||
|
|
||||||
|
`longitudeOrigin` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The longitude of the origin.
|
||||||
|
|
||||||
|
`latitudeDestination` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The latitude destination.
|
||||||
|
|
||||||
|
`longitudeDestination` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The longitude destination.
|
||||||
|
|
||||||
|
`measurementSystem` [MeasurementSystem](CapyKit.Enumerations.MeasurementSystem.md)
|
||||||
|
|
||||||
|
(Optional) The measurement system.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The distance.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
||||||
|
to calculate the "as-the-crow-flies" distance between two points on earth.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_"></a> KilometersToMiles\(double\)
|
||||||
|
|
||||||
|
Converts kilometers to miles.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static double KilometersToMiles(double kilometers)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`kilometers` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The value in kilometers.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The value in miles.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_"></a> MilesToKilometers\(double\)
|
||||||
|
|
||||||
|
Converts miles to kilometers.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static double MilesToKilometers(double miles)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`miles` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The value in miles.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The value in kilometers.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_"></a> RadiansToDegrees\(double\)
|
||||||
|
|
||||||
|
Converts radians to degrees.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static double RadiansToDegrees(double radians)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`radians` [double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The radian value.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[double](https://learn.microsoft.com/dotnet/api/system.double)
|
||||||
|
|
||||||
|
The value as degrees.
|
||||||
|
|
||||||
|
|
@ -1,909 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper
|
|
||||||
commentId: T:CapyKit.Helpers.CalculationHelper
|
|
||||||
id: CalculationHelper
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
|
|
||||||
- CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
|
|
||||||
- CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)
|
|
||||||
- CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CalculationHelper
|
|
||||||
nameWithType: CalculationHelper
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CalculationHelper
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 11
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Static class providing helper methods for various calculations.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static class CalculationHelper
|
|
||||||
content.vb: Public Module CalculationHelper
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
|
|
||||||
commentId: F:CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
|
|
||||||
id: EARTH_RADIUS_KILOMETERS
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EARTH_RADIUS_KILOMETERS
|
|
||||||
nameWithType: CalculationHelper.EARTH_RADIUS_KILOMETERS
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.EARTH_RADIUS_KILOMETERS
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EARTH_RADIUS_KILOMETERS
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 16
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: The earth's radius in kilometers.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public const int EARTH_RADIUS_KILOMETERS = 6371
|
|
||||||
return:
|
|
||||||
type: System.Int32
|
|
||||||
content.vb: Public Const EARTH_RADIUS_KILOMETERS As Integer = 6371
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
|
|
||||||
commentId: F:CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
|
|
||||||
id: MILES_PER_KILOMETER
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: MILES_PER_KILOMETER
|
|
||||||
nameWithType: CalculationHelper.MILES_PER_KILOMETER
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.MILES_PER_KILOMETER
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: MILES_PER_KILOMETER
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 19
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Ratio of miles per kilometer .
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public const double MILES_PER_KILOMETER = 0.621371
|
|
||||||
return:
|
|
||||||
type: System.Double
|
|
||||||
content.vb: Public Const MILES_PER_KILOMETER As Double = 0.621371
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.CalculateHash(System.String)
|
|
||||||
id: CalculateHash(System.String)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CalculateHash(string)
|
|
||||||
nameWithType: CalculationHelper.CalculateHash(string)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.CalculateHash(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CalculateHash
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 37
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Calculates the hash of a given string using an <xref href="System.Security.Cryptography.MD5" data-throw-if-not-resolved="false"></xref> value as the first 32 bits.
|
|
||||||
remarks: >-
|
|
||||||
This method is used for a quick and consistent hash function. It should not be considered
|
|
||||||
|
|
||||||
cryptographically sound or used in security contexts.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static int CalculateHash(string str)
|
|
||||||
parameters:
|
|
||||||
- id: str
|
|
||||||
type: System.String
|
|
||||||
description: The string to be hashed.
|
|
||||||
return:
|
|
||||||
type: System.Int32
|
|
||||||
description: The calculated hash.
|
|
||||||
content.vb: Public Shared Function CalculateHash(str As String) As Integer
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.CalculateHash*
|
|
||||||
nameWithType.vb: CalculationHelper.CalculateHash(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.CalculateHash(String)
|
|
||||||
name.vb: CalculateHash(String)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.CalculateHexHash(System.String)
|
|
||||||
id: CalculateHexHash(System.String)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CalculateHexHash(string)
|
|
||||||
nameWithType: CalculationHelper.CalculateHexHash(string)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.CalculateHexHash(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CalculateHexHash
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 49
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Calculates the hexadecimal hash.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string CalculateHexHash(string str)
|
|
||||||
parameters:
|
|
||||||
- id: str
|
|
||||||
type: System.String
|
|
||||||
description: The string to be hashed.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: The calculated 16 character hexadecimal hash.
|
|
||||||
content.vb: Public Shared Function CalculateHexHash(str As String) As String
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.CalculateHexHash*
|
|
||||||
nameWithType.vb: CalculationHelper.CalculateHexHash(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.CalculateHexHash(String)
|
|
||||||
name.vb: CalculateHexHash(String)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
id: GetDistance(System.Decimal,System.Decimal,System.Decimal,System.Decimal,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)
|
|
||||||
nameWithType: CalculationHelper.GetDistance(decimal, decimal, decimal, decimal, MeasurementSystem)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.GetDistance(decimal, decimal, decimal, decimal, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetDistance
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 82
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Gets the distance between two points on earth using the <code>haversine</code> formula.
|
|
||||||
remarks: >-
|
|
||||||
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
|
||||||
|
|
||||||
to calculate the "as-the-crow-flies" distance between two points on earth.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static decimal GetDistance(decimal latitudeOrigin, decimal longitudeOrigin, decimal latitudeDestination, decimal longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
|
||||||
parameters:
|
|
||||||
- id: latitudeOrigin
|
|
||||||
type: System.Decimal
|
|
||||||
description: The latitude origin.
|
|
||||||
- id: longitudeOrigin
|
|
||||||
type: System.Decimal
|
|
||||||
description: The longitude origin.
|
|
||||||
- id: latitudeDestination
|
|
||||||
type: System.Decimal
|
|
||||||
description: The latitude destination.
|
|
||||||
- id: longitudeDestination
|
|
||||||
type: System.Decimal
|
|
||||||
description: The longitude destination.
|
|
||||||
- id: measurementSystem
|
|
||||||
type: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
description: (Optional) The measurement system.
|
|
||||||
return:
|
|
||||||
type: System.Decimal
|
|
||||||
description: The distance.
|
|
||||||
content.vb: Public Shared Function GetDistance(latitudeOrigin As Decimal, longitudeOrigin As Decimal, latitudeDestination As Decimal, longitudeDestination As Decimal, measurementSystem As MeasurementSystem = MeasurementSystem.Imperial) As Decimal
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.GetDistance*
|
|
||||||
seealso:
|
|
||||||
- linkId: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
nameWithType.vb: CalculationHelper.GetDistance(Decimal, Decimal, Decimal, Decimal, MeasurementSystem)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.GetDistance(Decimal, Decimal, Decimal, Decimal, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name.vb: GetDistance(Decimal, Decimal, Decimal, Decimal, MeasurementSystem)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
id: GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetDistance(double, double, double, double, MeasurementSystem)
|
|
||||||
nameWithType: CalculationHelper.GetDistance(double, double, double, double, MeasurementSystem)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.GetDistance(double, double, double, double, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetDistance
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 105
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Gets the distance between two points on earth using the <code>haversine</code> formula.
|
|
||||||
remarks: >-
|
|
||||||
Uses the <a href="https://www.movable-type.co.uk/scripts/latlong.html">haversine</a> formula
|
|
||||||
|
|
||||||
to calculate the "as-the-crow-flies" distance between two points on earth.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static double GetDistance(double latitudeOrigin, double longitudeOrigin, double latitudeDestination, double longitudeDestination, MeasurementSystem measurementSystem = MeasurementSystem.Imperial)
|
|
||||||
parameters:
|
|
||||||
- id: latitudeOrigin
|
|
||||||
type: System.Double
|
|
||||||
description: The latitude of the origin.
|
|
||||||
- id: longitudeOrigin
|
|
||||||
type: System.Double
|
|
||||||
description: The longitude of the origin.
|
|
||||||
- id: latitudeDestination
|
|
||||||
type: System.Double
|
|
||||||
description: The latitude destination.
|
|
||||||
- id: longitudeDestination
|
|
||||||
type: System.Double
|
|
||||||
description: The longitude destination.
|
|
||||||
- id: measurementSystem
|
|
||||||
type: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
description: (Optional) The measurement system.
|
|
||||||
return:
|
|
||||||
type: System.Double
|
|
||||||
description: The distance.
|
|
||||||
content.vb: Public Shared Function GetDistance(latitudeOrigin As Double, longitudeOrigin As Double, latitudeDestination As Double, longitudeDestination As Double, measurementSystem As MeasurementSystem = MeasurementSystem.Imperial) As Double
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.GetDistance*
|
|
||||||
nameWithType.vb: CalculationHelper.GetDistance(Double, Double, Double, Double, MeasurementSystem)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.GetDistance(Double, Double, Double, Double, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name.vb: GetDistance(Double, Double, Double, Double, MeasurementSystem)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.KilometersToMiles(System.Double)
|
|
||||||
id: KilometersToMiles(System.Double)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: KilometersToMiles(double)
|
|
||||||
nameWithType: CalculationHelper.KilometersToMiles(double)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.KilometersToMiles(double)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: KilometersToMiles
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 128
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Converts kilometers to miles.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static double KilometersToMiles(double kilometers)
|
|
||||||
parameters:
|
|
||||||
- id: kilometers
|
|
||||||
type: System.Double
|
|
||||||
description: The value in kilometers.
|
|
||||||
return:
|
|
||||||
type: System.Double
|
|
||||||
description: The value in miles.
|
|
||||||
content.vb: Public Shared Function KilometersToMiles(kilometers As Double) As Double
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.KilometersToMiles*
|
|
||||||
nameWithType.vb: CalculationHelper.KilometersToMiles(Double)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.KilometersToMiles(Double)
|
|
||||||
name.vb: KilometersToMiles(Double)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.MilesToKilometers(System.Double)
|
|
||||||
id: MilesToKilometers(System.Double)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: MilesToKilometers(double)
|
|
||||||
nameWithType: CalculationHelper.MilesToKilometers(double)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.MilesToKilometers(double)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: MilesToKilometers
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 136
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Converts miles to kilometers.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static double MilesToKilometers(double miles)
|
|
||||||
parameters:
|
|
||||||
- id: miles
|
|
||||||
type: System.Double
|
|
||||||
description: The value in miles.
|
|
||||||
return:
|
|
||||||
type: System.Double
|
|
||||||
description: The value in kilometers.
|
|
||||||
content.vb: Public Shared Function MilesToKilometers(miles As Double) As Double
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.MilesToKilometers*
|
|
||||||
nameWithType.vb: CalculationHelper.MilesToKilometers(Double)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.MilesToKilometers(Double)
|
|
||||||
name.vb: MilesToKilometers(Double)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.DegreesToRadians(System.Double)
|
|
||||||
id: DegreesToRadians(System.Double)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: DegreesToRadians(double)
|
|
||||||
nameWithType: CalculationHelper.DegreesToRadians(double)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.DegreesToRadians(double)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: DegreesToRadians
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 144
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Convers degrees to radians.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static double DegreesToRadians(double degrees)
|
|
||||||
parameters:
|
|
||||||
- id: degrees
|
|
||||||
type: System.Double
|
|
||||||
description: The degree value.
|
|
||||||
return:
|
|
||||||
type: System.Double
|
|
||||||
description: The value as radians.
|
|
||||||
content.vb: Public Shared Function DegreesToRadians(degrees As Double) As Double
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.DegreesToRadians*
|
|
||||||
nameWithType.vb: CalculationHelper.DegreesToRadians(Double)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.DegreesToRadians(Double)
|
|
||||||
name.vb: DegreesToRadians(Double)
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.RadiansToDegrees(System.Double)
|
|
||||||
id: RadiansToDegrees(System.Double)
|
|
||||||
parent: CapyKit.Helpers.CalculationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: RadiansToDegrees(double)
|
|
||||||
nameWithType: CalculationHelper.RadiansToDegrees(double)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.RadiansToDegrees(double)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: RadiansToDegrees
|
|
||||||
path: ../CapyKit/Helpers/CalculationHelper.cs
|
|
||||||
startLine: 152
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Converts radians to degrees.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static double RadiansToDegrees(double radians)
|
|
||||||
parameters:
|
|
||||||
- id: radians
|
|
||||||
type: System.Double
|
|
||||||
description: The radian value.
|
|
||||||
return:
|
|
||||||
type: System.Double
|
|
||||||
description: The value as degrees.
|
|
||||||
content.vb: Public Shared Function RadiansToDegrees(radians As Double) As Double
|
|
||||||
overload: CapyKit.Helpers.CalculationHelper.RadiansToDegrees*
|
|
||||||
nameWithType.vb: CalculationHelper.RadiansToDegrees(Double)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.RadiansToDegrees(Double)
|
|
||||||
name.vb: RadiansToDegrees(Double)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: System.Int32
|
|
||||||
commentId: T:System.Int32
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.int32
|
|
||||||
name: int
|
|
||||||
nameWithType: int
|
|
||||||
fullName: int
|
|
||||||
nameWithType.vb: Integer
|
|
||||||
fullName.vb: Integer
|
|
||||||
name.vb: Integer
|
|
||||||
- uid: System.Double
|
|
||||||
commentId: T:System.Double
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
name: double
|
|
||||||
nameWithType: double
|
|
||||||
fullName: double
|
|
||||||
nameWithType.vb: Double
|
|
||||||
fullName.vb: Double
|
|
||||||
name.vb: Double
|
|
||||||
- uid: System.Security.Cryptography.MD5
|
|
||||||
commentId: T:System.Security.Cryptography.MD5
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.security.cryptography.md5
|
|
||||||
name: MD5
|
|
||||||
nameWithType: MD5
|
|
||||||
fullName: System.Security.Cryptography.MD5
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.CalculateHash*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.CalculateHash
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_CalculateHash_System_String_
|
|
||||||
name: CalculateHash
|
|
||||||
nameWithType: CalculationHelper.CalculateHash
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.CalculateHash
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.CalculateHexHash*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.CalculateHexHash
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_CalculateHexHash_System_String_
|
|
||||||
name: CalculateHexHash
|
|
||||||
nameWithType: CalculationHelper.CalculateHexHash
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.CalculateHexHash
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
commentId: M:CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_
|
|
||||||
name: GetDistance(double, double, double, double, MeasurementSystem)
|
|
||||||
nameWithType: CalculationHelper.GetDistance(double, double, double, double, MeasurementSystem)
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.GetDistance(double, double, double, double, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
nameWithType.vb: CalculationHelper.GetDistance(Double, Double, Double, Double, MeasurementSystem)
|
|
||||||
fullName.vb: CapyKit.Helpers.CalculationHelper.GetDistance(Double, Double, Double, Double, CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name.vb: GetDistance(Double, Double, Double, Double, MeasurementSystem)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name: GetDistance
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Double
|
|
||||||
name: double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Double
|
|
||||||
name: double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Double
|
|
||||||
name: double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Double
|
|
||||||
name: double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.GetDistance(System.Double,System.Double,System.Double,System.Double,CapyKit.Enumerations.MeasurementSystem)
|
|
||||||
name: GetDistance
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Double_System_Double_System_Double_System_Double_CapyKit_Enumerations_MeasurementSystem_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Double
|
|
||||||
name: Double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Double
|
|
||||||
name: Double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Double
|
|
||||||
name: Double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Double
|
|
||||||
name: Double
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.double
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
name: MeasurementSystem
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.GetDistance*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.GetDistance
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_GetDistance_System_Decimal_System_Decimal_System_Decimal_System_Decimal_CapyKit_Enumerations_MeasurementSystem_
|
|
||||||
name: GetDistance
|
|
||||||
nameWithType: CalculationHelper.GetDistance
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.GetDistance
|
|
||||||
- uid: System.Decimal
|
|
||||||
commentId: T:System.Decimal
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.decimal
|
|
||||||
name: decimal
|
|
||||||
nameWithType: decimal
|
|
||||||
fullName: decimal
|
|
||||||
nameWithType.vb: Decimal
|
|
||||||
fullName.vb: Decimal
|
|
||||||
name.vb: Decimal
|
|
||||||
- uid: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
commentId: T:CapyKit.Enumerations.MeasurementSystem
|
|
||||||
parent: CapyKit.Enumerations
|
|
||||||
href: CapyKit.Enumerations.MeasurementSystem.html
|
|
||||||
name: MeasurementSystem
|
|
||||||
nameWithType: MeasurementSystem
|
|
||||||
fullName: CapyKit.Enumerations.MeasurementSystem
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
commentId: N:CapyKit.Enumerations
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Enumerations
|
|
||||||
nameWithType: CapyKit.Enumerations
|
|
||||||
fullName: CapyKit.Enumerations
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
name: Enumerations
|
|
||||||
href: CapyKit.Enumerations.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Enumerations
|
|
||||||
name: Enumerations
|
|
||||||
href: CapyKit.Enumerations.html
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.KilometersToMiles*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.KilometersToMiles
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_KilometersToMiles_System_Double_
|
|
||||||
name: KilometersToMiles
|
|
||||||
nameWithType: CalculationHelper.KilometersToMiles
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.KilometersToMiles
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.MilesToKilometers*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.MilesToKilometers
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_MilesToKilometers_System_Double_
|
|
||||||
name: MilesToKilometers
|
|
||||||
nameWithType: CalculationHelper.MilesToKilometers
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.MilesToKilometers
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.DegreesToRadians*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.DegreesToRadians
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_DegreesToRadians_System_Double_
|
|
||||||
name: DegreesToRadians
|
|
||||||
nameWithType: CalculationHelper.DegreesToRadians
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.DegreesToRadians
|
|
||||||
- uid: CapyKit.Helpers.CalculationHelper.RadiansToDegrees*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CalculationHelper.RadiansToDegrees
|
|
||||||
href: CapyKit.Helpers.CalculationHelper.html#CapyKit_Helpers_CalculationHelper_RadiansToDegrees_System_Double_
|
|
||||||
name: RadiansToDegrees
|
|
||||||
nameWithType: CalculationHelper.RadiansToDegrees
|
|
||||||
fullName: CapyKit.Helpers.CalculationHelper.RadiansToDegrees
|
|
||||||
144
Docs/api/CapyKit.Helpers.CompressionHelper.md
Normal file
144
Docs/api/CapyKit.Helpers.CompressionHelper.md
Normal file
|
|
@ -0,0 +1,144 @@
|
||||||
|
# <a id="CapyKit_Helpers_CompressionHelper"></a> Class CompressionHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
A class that contains methods for managing data compression.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class CompressionHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[CompressionHelper](CapyKit.Helpers.CompressionHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CompressionHelper_Compress_System_Object_"></a> Compress\(object\)
|
||||||
|
|
||||||
|
Compresses a given object using the <code>gzip</code> algorithm.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static byte[] Compress(object obj)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
The object.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
A byte array representing the compressed object in <code>gzip</code> format.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_"></a> CompressToString\(object\)
|
||||||
|
|
||||||
|
Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string CompressToString(object obj)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
The object.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A string in <code>base64</code> encoding.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_"></a> Decompress<T\>\(string\)
|
||||||
|
|
||||||
|
Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Decompress<T>(string encodedString)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`encodedString` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The <code>base64</code> encoded <code>gzip</code> string.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> typed object.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CompressionHelper_Decompress__1_System_Byte___"></a> Decompress<T\>\(byte\[\]\)
|
||||||
|
|
||||||
|
Decompresses a given compressed <code>gzip</code> byte stream.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Decompress<T>(byte[] byteStream)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`byteStream` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
The compressed byte stream.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> typed object.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_"></a> DecompressToString\(string\)
|
||||||
|
|
||||||
|
Decompresses the given <code>base64</code> string in <code>gzip</code> format.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string DecompressToString(string compressed)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`compressed` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The compressed string.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A decomressed string.
|
||||||
|
|
||||||
|
|
@ -1,569 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper
|
|
||||||
commentId: T:CapyKit.Helpers.CompressionHelper
|
|
||||||
id: CompressionHelper
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.CompressionHelper.Compress(System.Object)
|
|
||||||
- CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
|
|
||||||
- CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
|
|
||||||
- CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
|
|
||||||
- CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CompressionHelper
|
|
||||||
nameWithType: CompressionHelper
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CompressionHelper
|
|
||||||
path: ../CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
startLine: 10
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: A class that contains methods for managing data compression.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static class CompressionHelper
|
|
||||||
content.vb: Public Module CompressionHelper
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.Compress(System.Object)
|
|
||||||
commentId: M:CapyKit.Helpers.CompressionHelper.Compress(System.Object)
|
|
||||||
id: Compress(System.Object)
|
|
||||||
parent: CapyKit.Helpers.CompressionHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Compress(object)
|
|
||||||
nameWithType: CompressionHelper.Compress(object)
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.Compress(object)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Compress
|
|
||||||
path: ../CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
startLine: 23
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Compresses a given object using the <code>gzip</code> algorithm.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static byte[] Compress(object obj)
|
|
||||||
parameters:
|
|
||||||
- id: obj
|
|
||||||
type: System.Object
|
|
||||||
description: The object.
|
|
||||||
return:
|
|
||||||
type: System.Byte[]
|
|
||||||
description: A byte array representing the compressed object in <code>gzip</code> format.
|
|
||||||
content.vb: Public Shared Function Compress(obj As Object) As Byte()
|
|
||||||
overload: CapyKit.Helpers.CompressionHelper.Compress*
|
|
||||||
nameWithType.vb: CompressionHelper.Compress(Object)
|
|
||||||
fullName.vb: CapyKit.Helpers.CompressionHelper.Compress(Object)
|
|
||||||
name.vb: Compress(Object)
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
|
|
||||||
commentId: M:CapyKit.Helpers.CompressionHelper.CompressToString(System.Object)
|
|
||||||
id: CompressToString(System.Object)
|
|
||||||
parent: CapyKit.Helpers.CompressionHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CompressToString(object)
|
|
||||||
nameWithType: CompressionHelper.CompressToString(object)
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.CompressToString(object)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CompressToString
|
|
||||||
path: ../CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
startLine: 51
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Compresses a given object to a string using <code>base64</code> encoding of <code>gzip</code> format.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string CompressToString(object obj)
|
|
||||||
parameters:
|
|
||||||
- id: obj
|
|
||||||
type: System.Object
|
|
||||||
description: The object.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: A string in <code>base64</code> encoding.
|
|
||||||
content.vb: Public Shared Function CompressToString(obj As Object) As String
|
|
||||||
overload: CapyKit.Helpers.CompressionHelper.CompressToString*
|
|
||||||
nameWithType.vb: CompressionHelper.CompressToString(Object)
|
|
||||||
fullName.vb: CapyKit.Helpers.CompressionHelper.CompressToString(Object)
|
|
||||||
name.vb: CompressToString(Object)
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.CompressionHelper.Decompress``1(System.String)
|
|
||||||
id: Decompress``1(System.String)
|
|
||||||
parent: CapyKit.Helpers.CompressionHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Decompress<T>(string)
|
|
||||||
nameWithType: CompressionHelper.Decompress<T>(string)
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.Decompress<T>(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Decompress
|
|
||||||
path: ../CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
startLine: 61
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Decompresses a given <code>base64</code> encoded string of <code>gzip</code> format.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static T Decompress<T>(string encodedString)
|
|
||||||
parameters:
|
|
||||||
- id: encodedString
|
|
||||||
type: System.String
|
|
||||||
description: The <code>base64</code> encoded <code>gzip</code> string.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A <code class="typeparamref">T</code> typed object.
|
|
||||||
content.vb: Public Shared Function Decompress(Of T)(encodedString As String) As T
|
|
||||||
overload: CapyKit.Helpers.CompressionHelper.Decompress*
|
|
||||||
nameWithType.vb: CompressionHelper.Decompress(Of T)(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.CompressionHelper.Decompress(Of T)(String)
|
|
||||||
name.vb: Decompress(Of T)(String)
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
|
|
||||||
commentId: M:CapyKit.Helpers.CompressionHelper.Decompress``1(System.Byte[])
|
|
||||||
id: Decompress``1(System.Byte[])
|
|
||||||
parent: CapyKit.Helpers.CompressionHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Decompress<T>(byte[])
|
|
||||||
nameWithType: CompressionHelper.Decompress<T>(byte[])
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.Decompress<T>(byte[])
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Decompress
|
|
||||||
path: ../CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
startLine: 71
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Decompresses a given compressed <code>gzip</code> byte stream.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static T Decompress<T>(byte[] byteStream)
|
|
||||||
parameters:
|
|
||||||
- id: byteStream
|
|
||||||
type: System.Byte[]
|
|
||||||
description: The compressed byte stream.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A <code class="typeparamref">T</code> typed object.
|
|
||||||
content.vb: Public Shared Function Decompress(Of T)(byteStream As Byte()) As T
|
|
||||||
overload: CapyKit.Helpers.CompressionHelper.Decompress*
|
|
||||||
nameWithType.vb: CompressionHelper.Decompress(Of T)(Byte())
|
|
||||||
fullName.vb: CapyKit.Helpers.CompressionHelper.Decompress(Of T)(Byte())
|
|
||||||
name.vb: Decompress(Of T)(Byte())
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.CompressionHelper.DecompressToString(System.String)
|
|
||||||
id: DecompressToString(System.String)
|
|
||||||
parent: CapyKit.Helpers.CompressionHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: DecompressToString(string)
|
|
||||||
nameWithType: CompressionHelper.DecompressToString(string)
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.DecompressToString(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: DecompressToString
|
|
||||||
path: ../CapyKit/Helpers/CompressionHelper.cs
|
|
||||||
startLine: 96
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Decompresses the given <code>base64</code> string in <code>gzip</code> format.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string DecompressToString(string compressed)
|
|
||||||
parameters:
|
|
||||||
- id: compressed
|
|
||||||
type: System.String
|
|
||||||
description: The compressed string.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: A decomressed string.
|
|
||||||
content.vb: Public Shared Function DecompressToString(compressed As String) As String
|
|
||||||
overload: CapyKit.Helpers.CompressionHelper.DecompressToString*
|
|
||||||
nameWithType.vb: CompressionHelper.DecompressToString(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.CompressionHelper.DecompressToString(String)
|
|
||||||
name.vb: DecompressToString(String)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.Compress*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CompressionHelper.Compress
|
|
||||||
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_Compress_System_Object_
|
|
||||||
name: Compress
|
|
||||||
nameWithType: CompressionHelper.Compress
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.Compress
|
|
||||||
- uid: System.Byte[]
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.byte
|
|
||||||
name: byte[]
|
|
||||||
nameWithType: byte[]
|
|
||||||
fullName: byte[]
|
|
||||||
nameWithType.vb: Byte()
|
|
||||||
fullName.vb: Byte()
|
|
||||||
name.vb: Byte()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Byte
|
|
||||||
name: byte
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.byte
|
|
||||||
- name: '['
|
|
||||||
- name: ']'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Byte
|
|
||||||
name: Byte
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.byte
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.CompressToString*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CompressionHelper.CompressToString
|
|
||||||
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_CompressToString_System_Object_
|
|
||||||
name: CompressToString
|
|
||||||
nameWithType: CompressionHelper.CompressToString
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.CompressToString
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.Decompress*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CompressionHelper.Decompress
|
|
||||||
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_Decompress__1_System_String_
|
|
||||||
name: Decompress
|
|
||||||
nameWithType: CompressionHelper.Decompress
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.Decompress
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: CapyKit.Helpers.CompressionHelper.DecompressToString*
|
|
||||||
commentId: Overload:CapyKit.Helpers.CompressionHelper.DecompressToString
|
|
||||||
href: CapyKit.Helpers.CompressionHelper.html#CapyKit_Helpers_CompressionHelper_DecompressToString_System_String_
|
|
||||||
name: DecompressToString
|
|
||||||
nameWithType: CompressionHelper.DecompressToString
|
|
||||||
fullName: CapyKit.Helpers.CompressionHelper.DecompressToString
|
|
||||||
41
Docs/api/CapyKit.Helpers.EncryptionHelper.md
Normal file
41
Docs/api/CapyKit.Helpers.EncryptionHelper.md
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
# <a id="CapyKit_Helpers_EncryptionHelper"></a> Class EncryptionHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class EncryptionHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[EncryptionHelper](CapyKit.Helpers.EncryptionHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<EncryptionHelper\>\(EncryptionHelper, EncryptionHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Constructors
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_EncryptionHelper__ctor_System_String_"></a> EncryptionHelper\(string\)
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public EncryptionHelper(string encryptionKey)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`encryptionKey` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
|
@ -1,556 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
commentId: T:CapyKit.Helpers.EncryptionHelper
|
|
||||||
id: EncryptionHelper
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.EncryptionHelper.#ctor(System.String)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EncryptionHelper
|
|
||||||
nameWithType: EncryptionHelper
|
|
||||||
fullName: CapyKit.Helpers.EncryptionHelper
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: EncryptionHelper
|
|
||||||
path: ../CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
startLine: 9
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: public class EncryptionHelper
|
|
||||||
content.vb: Public Class EncryptionHelper
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.Helpers.EncryptionHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper)
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper.#ctor(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.EncryptionHelper.#ctor(System.String)
|
|
||||||
id: '#ctor(System.String)'
|
|
||||||
parent: CapyKit.Helpers.EncryptionHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: EncryptionHelper(string)
|
|
||||||
nameWithType: EncryptionHelper.EncryptionHelper(string)
|
|
||||||
fullName: CapyKit.Helpers.EncryptionHelper.EncryptionHelper(string)
|
|
||||||
type: Constructor
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: .ctor
|
|
||||||
path: ../CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
startLine: 19
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: public EncryptionHelper(string encryptionKey)
|
|
||||||
parameters:
|
|
||||||
- id: encryptionKey
|
|
||||||
type: System.String
|
|
||||||
content.vb: Public Sub New(encryptionKey As String)
|
|
||||||
overload: CapyKit.Helpers.EncryptionHelper.#ctor*
|
|
||||||
nameWithType.vb: EncryptionHelper.New(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.EncryptionHelper.New(String)
|
|
||||||
name.vb: New(String)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<EncryptionHelper>(EncryptionHelper, EncryptionHelper)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<EncryptionHelper>(EncryptionHelper, EncryptionHelper)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.EncryptionHelper>(CapyKit.Helpers.EncryptionHelper, CapyKit.Helpers.EncryptionHelper)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of EncryptionHelper)(EncryptionHelper, EncryptionHelper)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.EncryptionHelper)(CapyKit.Helpers.EncryptionHelper, CapyKit.Helpers.EncryptionHelper)
|
|
||||||
name.vb: UpdateProperties(Of EncryptionHelper)(EncryptionHelper, EncryptionHelper)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper,CapyKit.Helpers.EncryptionHelper)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
name: EncryptionHelper
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
name: EncryptionHelper
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
name: EncryptionHelper
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.EncryptionHelper,CapyKit.Helpers.EncryptionHelper)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
name: EncryptionHelper
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
name: EncryptionHelper
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper
|
|
||||||
name: EncryptionHelper
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.Helpers.EncryptionHelper.#ctor*
|
|
||||||
commentId: Overload:CapyKit.Helpers.EncryptionHelper.#ctor
|
|
||||||
href: CapyKit.Helpers.EncryptionHelper.html#CapyKit_Helpers_EncryptionHelper__ctor_System_String_
|
|
||||||
name: EncryptionHelper
|
|
||||||
nameWithType: EncryptionHelper.EncryptionHelper
|
|
||||||
fullName: CapyKit.Helpers.EncryptionHelper.EncryptionHelper
|
|
||||||
nameWithType.vb: EncryptionHelper.New
|
|
||||||
fullName.vb: CapyKit.Helpers.EncryptionHelper.New
|
|
||||||
name.vb: New
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
68
Docs/api/CapyKit.Helpers.IEncryptionAlgorithm.md
Normal file
68
Docs/api/CapyKit.Helpers.IEncryptionAlgorithm.md
Normal file
|
|
@ -0,0 +1,68 @@
|
||||||
|
# <a id="CapyKit_Helpers_IEncryptionAlgorithm"></a> Interface IEncryptionAlgorithm
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public interface IEncryptionAlgorithm
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<IEncryptionAlgorithm\>\(IEncryptionAlgorithm, IEncryptionAlgorithm\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName"></a> AlgorithmName
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
string AlgorithmName { get; }
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Property Value
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___"></a> Decrypt<T\>\(EncryptedValue<T\>, params object\[\]\)
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`encryptedValue` [EncryptedValue](CapyKit.EncryptedValue\-1.md)<T\>
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___"></a> Encrypt<T\>\(object, params object\[\]\)
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[EncryptedValue](CapyKit.EncryptedValue\-1.md)<T\>
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
|
@ -1,502 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
commentId: T:CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
id: IEncryptionAlgorithm
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
|
|
||||||
- CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
|
|
||||||
- CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
nameWithType: IEncryptionAlgorithm
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
type: Interface
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: IEncryptionAlgorithm
|
|
||||||
path: ../CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
startLine: 27
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: public interface IEncryptionAlgorithm
|
|
||||||
content.vb: Public Interface IEncryptionAlgorithm
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.Helpers.IEncryptionAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm)
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
|
|
||||||
commentId: P:CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
|
|
||||||
id: AlgorithmName
|
|
||||||
parent: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: AlgorithmName
|
|
||||||
nameWithType: IEncryptionAlgorithm.AlgorithmName
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
|
|
||||||
type: Property
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: AlgorithmName
|
|
||||||
path: ../CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
startLine: 31
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: string AlgorithmName { get; }
|
|
||||||
parameters: []
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
content.vb: ReadOnly Property AlgorithmName As String
|
|
||||||
overload: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName*
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])
|
|
||||||
commentId: M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])
|
|
||||||
id: Encrypt``1(System.Object,System.Object[])
|
|
||||||
parent: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Encrypt<T>(object, params object[])
|
|
||||||
nameWithType: IEncryptionAlgorithm.Encrypt<T>(object, params object[])
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt<T>(object, params object[])
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Encrypt
|
|
||||||
path: ../CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
startLine: 37
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: EncryptedValue<T> Encrypt<T>(object obj, params object[] args)
|
|
||||||
parameters:
|
|
||||||
- id: obj
|
|
||||||
type: System.Object
|
|
||||||
- id: args
|
|
||||||
type: System.Object[]
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
return:
|
|
||||||
type: CapyKit.EncryptedValue{{T}}
|
|
||||||
content.vb: Function Encrypt(Of T)(obj As Object, ParamArray args As Object()) As EncryptedValue(Of T)
|
|
||||||
overload: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt*
|
|
||||||
nameWithType.vb: IEncryptionAlgorithm.Encrypt(Of T)(Object, ParamArray Object())
|
|
||||||
fullName.vb: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt(Of T)(Object, ParamArray Object())
|
|
||||||
name.vb: Encrypt(Of T)(Object, ParamArray Object())
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
|
|
||||||
commentId: M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
|
|
||||||
id: Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])
|
|
||||||
parent: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Decrypt<T>(EncryptedValue<T>, params object[])
|
|
||||||
nameWithType: IEncryptionAlgorithm.Decrypt<T>(EncryptedValue<T>, params object[])
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt<T>(CapyKit.EncryptedValue<T>, params object[])
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Decrypt
|
|
||||||
path: ../CapyKit/Helpers/EncryptionHelper.cs
|
|
||||||
startLine: 39
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: T Decrypt<T>(EncryptedValue<T> encryptedValue, params object[] args)
|
|
||||||
parameters:
|
|
||||||
- id: encryptedValue
|
|
||||||
type: CapyKit.EncryptedValue{{T}}
|
|
||||||
- id: args
|
|
||||||
type: System.Object[]
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
content.vb: Function Decrypt(Of T)(encryptedValue As EncryptedValue(Of T), ParamArray args As Object()) As T
|
|
||||||
overload: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt*
|
|
||||||
nameWithType.vb: IEncryptionAlgorithm.Decrypt(Of T)(EncryptedValue(Of T), ParamArray Object())
|
|
||||||
fullName.vb: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt(Of T)(CapyKit.EncryptedValue(Of T), ParamArray Object())
|
|
||||||
name.vb: Decrypt(Of T)(EncryptedValue(Of T), ParamArray Object())
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<IEncryptionAlgorithm>(IEncryptionAlgorithm, IEncryptionAlgorithm)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.IEncryptionAlgorithm>(CapyKit.Helpers.IEncryptionAlgorithm, CapyKit.Helpers.IEncryptionAlgorithm)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of IEncryptionAlgorithm)(IEncryptionAlgorithm, IEncryptionAlgorithm)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.IEncryptionAlgorithm)(CapyKit.Helpers.IEncryptionAlgorithm, CapyKit.Helpers.IEncryptionAlgorithm)
|
|
||||||
name.vb: UpdateProperties(Of IEncryptionAlgorithm)(IEncryptionAlgorithm, IEncryptionAlgorithm)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm,CapyKit.Helpers.IEncryptionAlgorithm)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.IEncryptionAlgorithm,CapyKit.Helpers.IEncryptionAlgorithm)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm
|
|
||||||
name: IEncryptionAlgorithm
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName*
|
|
||||||
commentId: Overload:CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html#CapyKit_Helpers_IEncryptionAlgorithm_AlgorithmName
|
|
||||||
name: AlgorithmName
|
|
||||||
nameWithType: IEncryptionAlgorithm.AlgorithmName
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm.AlgorithmName
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt*
|
|
||||||
commentId: Overload:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html#CapyKit_Helpers_IEncryptionAlgorithm_Encrypt__1_System_Object_System_Object___
|
|
||||||
name: Encrypt
|
|
||||||
nameWithType: IEncryptionAlgorithm.Encrypt
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Encrypt
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object[]
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object[]
|
|
||||||
nameWithType: object[]
|
|
||||||
fullName: object[]
|
|
||||||
nameWithType.vb: Object()
|
|
||||||
fullName.vb: Object()
|
|
||||||
name.vb: Object()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: '['
|
|
||||||
- name: ']'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.EncryptedValue{{T}}
|
|
||||||
commentId: T:CapyKit.EncryptedValue{``0}
|
|
||||||
parent: CapyKit
|
|
||||||
definition: CapyKit.EncryptedValue`1
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
name: EncryptedValue<T>
|
|
||||||
nameWithType: EncryptedValue<T>
|
|
||||||
fullName: CapyKit.EncryptedValue<T>
|
|
||||||
nameWithType.vb: EncryptedValue(Of T)
|
|
||||||
fullName.vb: CapyKit.EncryptedValue(Of T)
|
|
||||||
name.vb: EncryptedValue(Of T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
commentId: T:CapyKit.EncryptedValue`1
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
name: EncryptedValue<T>
|
|
||||||
nameWithType: EncryptedValue<T>
|
|
||||||
fullName: CapyKit.EncryptedValue<T>
|
|
||||||
nameWithType.vb: EncryptedValue(Of T)
|
|
||||||
fullName.vb: CapyKit.EncryptedValue(Of T)
|
|
||||||
name.vb: EncryptedValue(Of T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.EncryptedValue`1
|
|
||||||
name: EncryptedValue
|
|
||||||
href: CapyKit.EncryptedValue-1.html
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit
|
|
||||||
commentId: N:CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit
|
|
||||||
nameWithType: CapyKit
|
|
||||||
fullName: CapyKit
|
|
||||||
- uid: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt*
|
|
||||||
commentId: Overload:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt
|
|
||||||
href: CapyKit.Helpers.IEncryptionAlgorithm.html#CapyKit_Helpers_IEncryptionAlgorithm_Decrypt__1_CapyKit_EncryptedValue___0__System_Object___
|
|
||||||
name: Decrypt
|
|
||||||
nameWithType: IEncryptionAlgorithm.Decrypt
|
|
||||||
fullName: CapyKit.Helpers.IEncryptionAlgorithm.Decrypt
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
169
Docs/api/CapyKit.Helpers.KeyHelper.md
Normal file
169
Docs/api/CapyKit.Helpers.KeyHelper.md
Normal file
|
|
@ -0,0 +1,169 @@
|
||||||
|
# <a id="CapyKit_Helpers_KeyHelper"></a> Class KeyHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
A class that contains methods for managing key creation and validation against a master key.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class KeyHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[KeyHelper](CapyKit.Helpers.KeyHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<KeyHelper\>\(KeyHelper, KeyHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_GenerateKey"></a> GenerateKey\(\)
|
||||||
|
|
||||||
|
Generates a random key.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public string GenerateKey()
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The key.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_GetMasterKey"></a> GetMasterKey\(\)
|
||||||
|
|
||||||
|
Gets the master key.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public byte[] GetMasterKey()
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
An array of byte.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[InvalidOperationException](https://learn.microsoft.com/dotnet/api/system.invalidoperationexception)
|
||||||
|
|
||||||
|
Thrown when the requested operation is invalid.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_GetNumParts"></a> GetNumParts\(\)
|
||||||
|
|
||||||
|
Gets the number parts.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int GetNumParts()
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The number parts.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentException](https://learn.microsoft.com/dotnet/api/system.argumentexception)
|
||||||
|
|
||||||
|
Thrown when one or more arguments have unsupported or illegal values.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_GetSaltSize"></a> GetSaltSize\(\)
|
||||||
|
|
||||||
|
Gets the salt size.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public int GetSaltSize()
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The salt size.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_SetMasterKeyAccessor_System_Func_System_Byte____"></a> SetMasterKeyAccessor\(Func<byte\[\]\>\)
|
||||||
|
|
||||||
|
Sets the master key.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public void SetMasterKeyAccessor(Func<byte[]> accessor)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]\>
|
||||||
|
|
||||||
|
The accessor function.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_SetNumPartsAccessor_System_Func_System_Int32__"></a> SetNumPartsAccessor\(Func<int\>\)
|
||||||
|
|
||||||
|
Set and get the number of parts for the formatted key. Default is 2.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public void SetNumPartsAccessor(Func<int> accessor)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\>
|
||||||
|
|
||||||
|
The accessor function.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_SetSaltSizeAccessor_System_Func_System_Int32__"></a> SetSaltSizeAccessor\(Func<int\>\)
|
||||||
|
|
||||||
|
Sets the salt size (in bytes). Default is 4.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public void SetSaltSizeAccessor(Func<int> accessor)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[int](https://learn.microsoft.com/dotnet/api/system.int32)\>
|
||||||
|
|
||||||
|
The accessor function.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_KeyHelper_ValidateKey_System_String_"></a> ValidateKey\(string\)
|
||||||
|
|
||||||
|
Validates the provided key.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public bool ValidateKey(string providedKey)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`providedKey` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The provided key.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
|
||||||
|
|
||||||
|
True if it succeeds, false if it fails.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[KeyHelper](CapyKit.Helpers.KeyHelper.md).[GetMasterKey](CapyKit.Helpers.KeyHelper.md\#CapyKit\_Helpers\_KeyHelper\_GetMasterKey)\(\),
|
||||||
|
[KeyHelper](CapyKit.Helpers.KeyHelper.md).[SetMasterKeyAccessor](CapyKit.Helpers.KeyHelper.md\#CapyKit\_Helpers\_KeyHelper\_SetMasterKeyAccessor\_System\_Func\_System\_Byte\_\_\_\_)\([Func](https://learn.microsoft.com/dotnet/api/system.func\-1)<[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]\>\),
|
||||||
|
[KeyHelper](CapyKit.Helpers.KeyHelper.md).masterKeyAccessor
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
58
Docs/api/CapyKit.Helpers.LanguageHelper.md
Normal file
58
Docs/api/CapyKit.Helpers.LanguageHelper.md
Normal file
|
|
@ -0,0 +1,58 @@
|
||||||
|
# <a id="CapyKit_Helpers_LanguageHelper"></a> Class LanguageHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Helper class for handling text transformations.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class LanguageHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[LanguageHelper](CapyKit.Helpers.LanguageHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<LanguageHelper\>\(LanguageHelper, LanguageHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_"></a> CamelCaseToHumanReadable\(string\)
|
||||||
|
|
||||||
|
Converts camel case text to human readable text.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string CamelCaseToHumanReadable(string value)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`value` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The value.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A string in human readable format.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
Camel case is a naming convention for identifiers in which the first letter of each word is
|
||||||
|
capitalized.
|
||||||
|
|
||||||
|
|
@ -1,565 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
commentId: T:CapyKit.Helpers.LanguageHelper
|
|
||||||
id: LanguageHelper
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: LanguageHelper
|
|
||||||
nameWithType: LanguageHelper
|
|
||||||
fullName: CapyKit.Helpers.LanguageHelper
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/LanguageHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: LanguageHelper
|
|
||||||
path: ../CapyKit/Helpers/LanguageHelper.cs
|
|
||||||
startLine: 12
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Helper class for handling text transformations.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public class LanguageHelper
|
|
||||||
content.vb: Public Class LanguageHelper
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.Helpers.LanguageHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper)
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(System.String)
|
|
||||||
id: CamelCaseToHumanReadable(System.String)
|
|
||||||
parent: CapyKit.Helpers.LanguageHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: CamelCaseToHumanReadable(string)
|
|
||||||
nameWithType: LanguageHelper.CamelCaseToHumanReadable(string)
|
|
||||||
fullName: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/LanguageHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: CamelCaseToHumanReadable
|
|
||||||
path: ../CapyKit/Helpers/LanguageHelper.cs
|
|
||||||
startLine: 23
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Converts camel case text to human readable text.
|
|
||||||
remarks: >-
|
|
||||||
Camel case is a naming convention for identifiers in which the first letter of each word is
|
|
||||||
|
|
||||||
capitalized.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string CamelCaseToHumanReadable(string value)
|
|
||||||
parameters:
|
|
||||||
- id: value
|
|
||||||
type: System.String
|
|
||||||
description: The value.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: A string in human readable format.
|
|
||||||
content.vb: Public Shared Function CamelCaseToHumanReadable(value As String) As String
|
|
||||||
overload: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable*
|
|
||||||
nameWithType.vb: LanguageHelper.CamelCaseToHumanReadable(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable(String)
|
|
||||||
name.vb: CamelCaseToHumanReadable(String)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<LanguageHelper>(LanguageHelper, LanguageHelper)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<LanguageHelper>(LanguageHelper, LanguageHelper)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.LanguageHelper>(CapyKit.Helpers.LanguageHelper, CapyKit.Helpers.LanguageHelper)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of LanguageHelper)(LanguageHelper, LanguageHelper)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.LanguageHelper)(CapyKit.Helpers.LanguageHelper, CapyKit.Helpers.LanguageHelper)
|
|
||||||
name.vb: UpdateProperties(Of LanguageHelper)(LanguageHelper, LanguageHelper)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper,CapyKit.Helpers.LanguageHelper)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
name: LanguageHelper
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
name: LanguageHelper
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
name: LanguageHelper
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.LanguageHelper,CapyKit.Helpers.LanguageHelper)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
name: LanguageHelper
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
name: LanguageHelper
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper
|
|
||||||
name: LanguageHelper
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable*
|
|
||||||
commentId: Overload:CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable
|
|
||||||
href: CapyKit.Helpers.LanguageHelper.html#CapyKit_Helpers_LanguageHelper_CamelCaseToHumanReadable_System_String_
|
|
||||||
name: CamelCaseToHumanReadable
|
|
||||||
nameWithType: LanguageHelper.CamelCaseToHumanReadable
|
|
||||||
fullName: CapyKit.Helpers.LanguageHelper.CamelCaseToHumanReadable
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
371
Docs/api/CapyKit.Helpers.SecurityHelper.md
Normal file
371
Docs/api/CapyKit.Helpers.SecurityHelper.md
Normal file
|
|
@ -0,0 +1,371 @@
|
||||||
|
# <a id="CapyKit_Helpers_SecurityHelper"></a> Class SecurityHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
A class that contains methods for managing secure data processing and cryptography.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public class SecurityHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties<SecurityHelper\>\(SecurityHelper, SecurityHelper\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword__1_CapyKit_Password_System_String_System_Byte___System_Object___"></a> CompareHashedPassword<T\>\(Password, string, byte\[\], params object\[\]\)
|
||||||
|
|
||||||
|
Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
|
||||||
|
This method uses the specified password algorithm type <code class="typeparamref">T</code> to retrieve the hashed version
|
||||||
|
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static bool CompareHashedPassword<T>(Password existingPassword, string password, byte[] salt, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`existingPassword` [Password](CapyKit.Password.md)
|
||||||
|
|
||||||
|
The existing, encrypted password.
|
||||||
|
|
||||||
|
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The unencrypted password to be compared.
|
||||||
|
|
||||||
|
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
The salt value used in password hashing.
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
Additional arguments required for constructing the password algorithm instance.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
|
||||||
|
|
||||||
|
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if hash comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it fails.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
The type of the password hashing algorithm.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_CompareHashedPassword_CapyKit_Password_System_String_System_Byte___CapyKit_IPasswordAlgorithm_System_Object___"></a> CompareHashedPassword\(Password, string, byte\[\], IPasswordAlgorithm, params object\[\]\)
|
||||||
|
|
||||||
|
Compares an unencrypted <code class="paramref">password</code> with a stored, encrypted <code class="paramref">existingPassword</code>.
|
||||||
|
This method uses the specified <code class="paramref">algorithm</code> to retrieve the hashed version
|
||||||
|
of the <code class="paramref">password</code> and then compares it with the <code class="paramref">existingPassword</code>.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static bool CompareHashedPassword(Password existingPassword, string password, byte[] salt, IPasswordAlgorithm algorithm, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`existingPassword` [Password](CapyKit.Password.md)
|
||||||
|
|
||||||
|
The existing, encrypted password.
|
||||||
|
|
||||||
|
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The unencrypted password to be compared.
|
||||||
|
|
||||||
|
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
The salt value used in password hashing.
|
||||||
|
|
||||||
|
`algorithm` [IPasswordAlgorithm](CapyKit.IPasswordAlgorithm.md)
|
||||||
|
|
||||||
|
The password hashing algorithm.
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
Additional arguments required for constructing the password algorithm instance.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
|
||||||
|
|
||||||
|
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if hash comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if it fails.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_CompareSessionID_System_String_System_String_"></a> CompareSessionID\(string, string\)
|
||||||
|
|
||||||
|
Compares two session identifiers.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static bool CompareSessionID(string first, string second)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`first` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The first session identifier.
|
||||||
|
|
||||||
|
`second` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The second session identifier.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[bool](https://learn.microsoft.com/dotnet/api/system.boolean)
|
||||||
|
|
||||||
|
<a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if comparison succeeds, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if not.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Object___"></a> GetPassword<T\>\(string, params object\[\]\)
|
||||||
|
|
||||||
|
Retrieves a <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the specified password and generates a random salt value.
|
||||||
|
Then it uses that salt to call the overloaded <xref href="CapyKit.Helpers.SecurityHelper.GetPassword%60%601(System.String%2cSystem.Byte%5b%5d%2cSystem.Object%5b%5d)" data-throw-if-not-resolved="false"></xref> method with the given password and
|
||||||
|
the generated salt as arguments.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static Password GetPassword<T>(string password, params object[] args)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The plaintext password to be hashed.
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
Optional constructor arguments for the <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation
|
||||||
|
instance.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[Password](CapyKit.Password.md)
|
||||||
|
|
||||||
|
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object with the given password and a randomly generated salt, as well as an
|
||||||
|
instance of <code class="typeparamref">T</code> created using any optional constructor arguments provided.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
The type of <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation to use.
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md).SALT\_SIZE
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_GetPassword__1_System_String_System_Byte___System_Object___"></a> GetPassword<T\>\(string, byte\[\], params object\[\]\)
|
||||||
|
|
||||||
|
Retrieves a <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the specified password, salt, and optional
|
||||||
|
constructor arguments.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static Password GetPassword<T>(string password, byte[] salt, params object[] args) where T : IPasswordAlgorithm
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The plaintext password to be hashed.
|
||||||
|
|
||||||
|
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
A random value used as an additional input to the one-way function that hashes data, a
|
||||||
|
password or passphrase. This is used to make each output different for the same input
|
||||||
|
thus adding security.
|
||||||
|
|
||||||
|
`args` [object](https://learn.microsoft.com/dotnet/api/system.object)\[\]
|
||||||
|
|
||||||
|
Optional constructor arguments for the <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation
|
||||||
|
instance.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[Password](CapyKit.Password.md)
|
||||||
|
|
||||||
|
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object with the given password and salt, as well as an instance
|
||||||
|
of <code class="typeparamref">T</code> created using the provided constructor arguments.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
The type of <xref href="CapyKit.IPasswordAlgorithm" data-throw-if-not-resolved="false"></xref> implementation to use.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method uses reflection to find a constructor for the specified password algorithm type (<code class="typeparamref">T</code>).
|
||||||
|
It emits an error event if a suitable constructor is not found or if there is an error invoking the constructor.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_GetRandomPassword_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"></a> GetRandomPassword\(int, params ValidCharacterCollection\[\]\)
|
||||||
|
|
||||||
|
Gets a cryptographically strong random password.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string GetRandomPassword(int length, params ValidCharacterCollection[] validCharacters)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The length of the password to generate.
|
||||||
|
|
||||||
|
`validCharacters` [ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)\[\]
|
||||||
|
|
||||||
|
An array of <xref href="CapyKit.Helpers.ValidCharacterCollection" data-throw-if-not-resolved="false"></xref> enumeration values representing the desired
|
||||||
|
character sets.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The password.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_"></a> GetRandomString\(int\)
|
||||||
|
|
||||||
|
A convenience method to generate a random string of the specified length using all character sets.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string GetRandomString(int length)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The desired length of the generated random string.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
#### See Also
|
||||||
|
|
||||||
|
[ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md),
|
||||||
|
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md).[GetRandomString](CapyKit.Helpers.SecurityHelper.md\#CapyKit\_Helpers\_SecurityHelper\_GetRandomString\_System\_Int32\_CapyKit\_Helpers\_ValidCharacterCollection\_\_\_)\([int](https://learn.microsoft.com/dotnet/api/system.int32), params [ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)\[\]\)
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_GetRandomString_System_Int32_CapyKit_Helpers_ValidCharacterCollection___"></a> GetRandomString\(int, params ValidCharacterCollection\[\]\)
|
||||||
|
|
||||||
|
Gets a cryptographically strong random string using the character values found in VALID_CHARACTERS.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string GetRandomString(int length, params ValidCharacterCollection[] validChars)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
The length of the string to create.
|
||||||
|
|
||||||
|
`validChars` [ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)\[\]
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The random string.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_GetSalt_System_Int32_"></a> GetSalt\(int\)
|
||||||
|
|
||||||
|
Generates a random byte array that can act as a salt.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static byte[] GetSalt(int length = 32)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`length` [int](https://learn.microsoft.com/dotnet/api/system.int32)
|
||||||
|
|
||||||
|
(Optional) The desired length of the generated byte array.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
An array of byte.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
A default length of <xref href="CapyKit.Helpers.SecurityHelper.SALT_SIZE" data-throw-if-not-resolved="false"></xref> is provided as a sane default. Larger values can be used for increased
|
||||||
|
entropy.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_System_Byte___"></a> Pbkdf2\(string, byte\[\]\)
|
||||||
|
|
||||||
|
Generates a new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>
|
||||||
|
and <code class="paramref">salt</code>.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static Password Pbkdf2(string password, byte[] salt)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The clear text password to be hashed.
|
||||||
|
|
||||||
|
`salt` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
A random value used to add an additional layer of security to the generated hash.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[Password](CapyKit.Password.md)
|
||||||
|
|
||||||
|
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object containing the hashed password and salt.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate
|
||||||
|
a new password hash. The algorithm iteratively applies a pseudorandom function to the
|
||||||
|
password and salt, which increases the security of the resulting hash.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SecurityHelper_Pbkdf2_System_String_"></a> Pbkdf2\(string\)
|
||||||
|
|
||||||
|
Generates a new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object using the PBKDF2 algorithm with the provided <code class="paramref">password</code>.
|
||||||
|
This overload of the method generates a random salt value for added security.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static Password Pbkdf2(string password)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`password` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The clear text password to be hashed.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[Password](CapyKit.Password.md)
|
||||||
|
|
||||||
|
A new <xref href="CapyKit.Password" data-throw-if-not-resolved="false"></xref> object containing the hashed password and a randomly generated salt.
|
||||||
|
|
||||||
|
#### Remarks
|
||||||
|
|
||||||
|
This method uses the PBKDF2 (Password-Based Key Derivation Function 2) algorithm to generate
|
||||||
|
a new password hash. The algorithm iteratively applies a pseudorandom function to the
|
||||||
|
password and salt, which increases the security of the resulting hash. In this overload,
|
||||||
|
a random salt value is generated using <xref href="CapyKit.Helpers.SecurityHelper.GetRandomBytes(System.Int32)" data-throw-if-not-resolved="false"></xref> method.
|
||||||
|
|
||||||
File diff suppressed because it is too large
Load diff
160
Docs/api/CapyKit.Helpers.SerializationHelper.md
Normal file
160
Docs/api/CapyKit.Helpers.SerializationHelper.md
Normal file
|
|
@ -0,0 +1,160 @@
|
||||||
|
# <a id="CapyKit_Helpers_SerializationHelper"></a> Class SerializationHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class SerializationHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[SerializationHelper](CapyKit.Helpers.SerializationHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___"></a> Deserialize<T\>\(byte\[\]\)
|
||||||
|
|
||||||
|
Deserializes an object to a given <code class="typeparamref">T</code> type.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Deserialize<T>(byte[] bytes)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`bytes` [byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
The byte array representing a <code class="typeparamref">T</code> object.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> object.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[FormatException](https://learn.microsoft.com/dotnet/api/system.formatexception)
|
||||||
|
|
||||||
|
Thrown when the format of the byte array is incorrect.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_IO_Stream_"></a> Deserialize<T\>\(Stream\)
|
||||||
|
|
||||||
|
Deserializes an object to a given <code class="typeparamref">T</code> type.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Deserialize<T>(Stream stream)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`stream` [Stream](https://learn.microsoft.com/dotnet/api/system.io.stream)
|
||||||
|
|
||||||
|
The steam.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> object.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[FormatException](https://learn.microsoft.com/dotnet/api/system.formatexception)
|
||||||
|
|
||||||
|
Thrown when the format of an input is incorrect.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SerializationHelper_Deserialize__1_System_String_"></a> Deserialize<T\>\(string\)
|
||||||
|
|
||||||
|
Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T Deserialize<T>(string str)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`str` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
A <code class="typeparamref">T</code> object.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
Generic type parameter.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_"></a> SerializeToBytes\(object\)
|
||||||
|
|
||||||
|
Serializes an object to a byte array.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static byte[] SerializeToBytes(object obj)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
The object.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[byte](https://learn.microsoft.com/dotnet/api/system.byte)\[\]
|
||||||
|
|
||||||
|
A <code>JSON</code> encoded string.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_"></a> SerializeToString\(object\)
|
||||||
|
|
||||||
|
Serializes an object to a <code>JSON</code> encoded string.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static string SerializeToString(object obj)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`obj` [object](https://learn.microsoft.com/dotnet/api/system.object)
|
||||||
|
|
||||||
|
The object.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
[string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
A <code>JSON</code> encoded string.
|
||||||
|
|
||||||
|
|
@ -1,614 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper
|
|
||||||
commentId: T:CapyKit.Helpers.SerializationHelper
|
|
||||||
id: SerializationHelper
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
|
|
||||||
- CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
|
|
||||||
- CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
|
|
||||||
- CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
|
|
||||||
- CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: SerializationHelper
|
|
||||||
nameWithType: SerializationHelper
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: SerializationHelper
|
|
||||||
path: ../CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
startLine: 12
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
syntax:
|
|
||||||
content: public static class SerializationHelper
|
|
||||||
content.vb: Public Module SerializationHelper
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
|
|
||||||
commentId: M:CapyKit.Helpers.SerializationHelper.SerializeToBytes(System.Object)
|
|
||||||
id: SerializeToBytes(System.Object)
|
|
||||||
parent: CapyKit.Helpers.SerializationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: SerializeToBytes(object)
|
|
||||||
nameWithType: SerializationHelper.SerializeToBytes(object)
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.SerializeToBytes(object)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: SerializeToBytes
|
|
||||||
path: ../CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
startLine: 25
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Serializes an object to a byte array.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static byte[] SerializeToBytes(object obj)
|
|
||||||
parameters:
|
|
||||||
- id: obj
|
|
||||||
type: System.Object
|
|
||||||
description: The object.
|
|
||||||
return:
|
|
||||||
type: System.Byte[]
|
|
||||||
description: A <code>JSON</code> encoded string.
|
|
||||||
content.vb: Public Shared Function SerializeToBytes(obj As Object) As Byte()
|
|
||||||
overload: CapyKit.Helpers.SerializationHelper.SerializeToBytes*
|
|
||||||
nameWithType.vb: SerializationHelper.SerializeToBytes(Object)
|
|
||||||
fullName.vb: CapyKit.Helpers.SerializationHelper.SerializeToBytes(Object)
|
|
||||||
name.vb: SerializeToBytes(Object)
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
|
|
||||||
commentId: M:CapyKit.Helpers.SerializationHelper.SerializeToString(System.Object)
|
|
||||||
id: SerializeToString(System.Object)
|
|
||||||
parent: CapyKit.Helpers.SerializationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: SerializeToString(object)
|
|
||||||
nameWithType: SerializationHelper.SerializeToString(object)
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.SerializeToString(object)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: SerializeToString
|
|
||||||
path: ../CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
startLine: 33
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Serializes an object to a <code>JSON</code> encoded string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static string SerializeToString(object obj)
|
|
||||||
parameters:
|
|
||||||
- id: obj
|
|
||||||
type: System.Object
|
|
||||||
description: The object.
|
|
||||||
return:
|
|
||||||
type: System.String
|
|
||||||
description: A <code>JSON</code> encoded string.
|
|
||||||
content.vb: Public Shared Function SerializeToString(obj As Object) As String
|
|
||||||
overload: CapyKit.Helpers.SerializationHelper.SerializeToString*
|
|
||||||
nameWithType.vb: SerializationHelper.SerializeToString(Object)
|
|
||||||
fullName.vb: CapyKit.Helpers.SerializationHelper.SerializeToString(Object)
|
|
||||||
name.vb: SerializeToString(Object)
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
|
|
||||||
commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.Byte[])
|
|
||||||
id: Deserialize``1(System.Byte[])
|
|
||||||
parent: CapyKit.Helpers.SerializationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Deserialize<T>(byte[])
|
|
||||||
nameWithType: SerializationHelper.Deserialize<T>(byte[])
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(byte[])
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Deserialize
|
|
||||||
path: ../CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
startLine: 43
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Deserializes an object to a given <code class="typeparamref">T</code> type.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static T Deserialize<T>(byte[] bytes)
|
|
||||||
parameters:
|
|
||||||
- id: bytes
|
|
||||||
type: System.Byte[]
|
|
||||||
description: The byte array representing a <code class="typeparamref">T</code> object.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A <code class="typeparamref">T</code> object.
|
|
||||||
content.vb: Public Shared Function Deserialize(Of T)(bytes As Byte()) As T
|
|
||||||
overload: CapyKit.Helpers.SerializationHelper.Deserialize*
|
|
||||||
exceptions:
|
|
||||||
- type: System.FormatException
|
|
||||||
commentId: T:System.FormatException
|
|
||||||
description: Thrown when the format of the byte array is incorrect.
|
|
||||||
nameWithType.vb: SerializationHelper.Deserialize(Of T)(Byte())
|
|
||||||
fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(Byte())
|
|
||||||
name.vb: Deserialize(Of T)(Byte())
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
|
|
||||||
commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.IO.Stream)
|
|
||||||
id: Deserialize``1(System.IO.Stream)
|
|
||||||
parent: CapyKit.Helpers.SerializationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Deserialize<T>(Stream)
|
|
||||||
nameWithType: SerializationHelper.Deserialize<T>(Stream)
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(System.IO.Stream)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Deserialize
|
|
||||||
path: ../CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
startLine: 57
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Deserializes an object to a given <code class="typeparamref">T</code> type.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static T Deserialize<T>(Stream stream)
|
|
||||||
parameters:
|
|
||||||
- id: stream
|
|
||||||
type: System.IO.Stream
|
|
||||||
description: The steam.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A <code class="typeparamref">T</code> object.
|
|
||||||
content.vb: Public Shared Function Deserialize(Of T)(stream As Stream) As T
|
|
||||||
overload: CapyKit.Helpers.SerializationHelper.Deserialize*
|
|
||||||
exceptions:
|
|
||||||
- type: System.FormatException
|
|
||||||
commentId: T:System.FormatException
|
|
||||||
description: Thrown when the format of an input is incorrect.
|
|
||||||
nameWithType.vb: SerializationHelper.Deserialize(Of T)(Stream)
|
|
||||||
fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(System.IO.Stream)
|
|
||||||
name.vb: Deserialize(Of T)(Stream)
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.SerializationHelper.Deserialize``1(System.String)
|
|
||||||
id: Deserialize``1(System.String)
|
|
||||||
parent: CapyKit.Helpers.SerializationHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Deserialize<T>(string)
|
|
||||||
nameWithType: SerializationHelper.Deserialize<T>(string)
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.Deserialize<T>(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Deserialize
|
|
||||||
path: ../CapyKit/Helpers/SerializationHelper.cs
|
|
||||||
startLine: 87
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Deserializes a <code>JSON</code> encoded string to the given <code class="typeparamref">T</code>.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static T Deserialize<T>(string str)
|
|
||||||
parameters:
|
|
||||||
- id: str
|
|
||||||
type: System.String
|
|
||||||
description: The <code>JSON</code> encoded string representing a <code class="typeparamref">T</code> object.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: Generic type parameter.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: A <code class="typeparamref">T</code> object.
|
|
||||||
content.vb: Public Shared Function Deserialize(Of T)(str As String) As T
|
|
||||||
overload: CapyKit.Helpers.SerializationHelper.Deserialize*
|
|
||||||
nameWithType.vb: SerializationHelper.Deserialize(Of T)(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.SerializationHelper.Deserialize(Of T)(String)
|
|
||||||
name.vb: Deserialize(Of T)(String)
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.SerializeToBytes*
|
|
||||||
commentId: Overload:CapyKit.Helpers.SerializationHelper.SerializeToBytes
|
|
||||||
href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_SerializeToBytes_System_Object_
|
|
||||||
name: SerializeToBytes
|
|
||||||
nameWithType: SerializationHelper.SerializeToBytes
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.SerializeToBytes
|
|
||||||
- uid: System.Byte[]
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.byte
|
|
||||||
name: byte[]
|
|
||||||
nameWithType: byte[]
|
|
||||||
fullName: byte[]
|
|
||||||
nameWithType.vb: Byte()
|
|
||||||
fullName.vb: Byte()
|
|
||||||
name.vb: Byte()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Byte
|
|
||||||
name: byte
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.byte
|
|
||||||
- name: '['
|
|
||||||
- name: ']'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Byte
|
|
||||||
name: Byte
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.byte
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.SerializeToString*
|
|
||||||
commentId: Overload:CapyKit.Helpers.SerializationHelper.SerializeToString
|
|
||||||
href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_SerializeToString_System_Object_
|
|
||||||
name: SerializeToString
|
|
||||||
nameWithType: SerializationHelper.SerializeToString
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.SerializeToString
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: System.FormatException
|
|
||||||
commentId: T:System.FormatException
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.formatexception
|
|
||||||
name: FormatException
|
|
||||||
nameWithType: FormatException
|
|
||||||
fullName: System.FormatException
|
|
||||||
- uid: CapyKit.Helpers.SerializationHelper.Deserialize*
|
|
||||||
commentId: Overload:CapyKit.Helpers.SerializationHelper.Deserialize
|
|
||||||
href: CapyKit.Helpers.SerializationHelper.html#CapyKit_Helpers_SerializationHelper_Deserialize__1_System_Byte___
|
|
||||||
name: Deserialize
|
|
||||||
nameWithType: SerializationHelper.Deserialize
|
|
||||||
fullName: CapyKit.Helpers.SerializationHelper.Deserialize
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: System.IO.Stream
|
|
||||||
commentId: T:System.IO.Stream
|
|
||||||
parent: System.IO
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.io.stream
|
|
||||||
name: Stream
|
|
||||||
nameWithType: Stream
|
|
||||||
fullName: System.IO.Stream
|
|
||||||
- uid: System.IO
|
|
||||||
commentId: N:System.IO
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System.IO
|
|
||||||
nameWithType: System.IO
|
|
||||||
fullName: System.IO
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System
|
|
||||||
name: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
- name: .
|
|
||||||
- uid: System.IO
|
|
||||||
name: IO
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.io
|
|
||||||
spec.vb:
|
|
||||||
- uid: System
|
|
||||||
name: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
- name: .
|
|
||||||
- uid: System.IO
|
|
||||||
name: IO
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.io
|
|
||||||
137
Docs/api/CapyKit.Helpers.SettingsHelper.md
Normal file
137
Docs/api/CapyKit.Helpers.SettingsHelper.md
Normal file
|
|
@ -0,0 +1,137 @@
|
||||||
|
# <a id="CapyKit_Helpers_SettingsHelper"></a> Class SettingsHelper
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
Static class containing helper methods for retrieving and setting application settings.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static class SettingsHelper
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Inheritance
|
||||||
|
|
||||||
|
[object](https://learn.microsoft.com/dotnet/api/system.object) ←
|
||||||
|
[SettingsHelper](CapyKit.Helpers.SettingsHelper.md)
|
||||||
|
|
||||||
|
#### Inherited Members
|
||||||
|
|
||||||
|
[object.Equals\(object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\)),
|
||||||
|
[object.Equals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.equals\#system\-object\-equals\(system\-object\-system\-object\)),
|
||||||
|
[object.GetHashCode\(\)](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
|
||||||
|
[object.GetType\(\)](https://learn.microsoft.com/dotnet/api/system.object.gettype),
|
||||||
|
[object.MemberwiseClone\(\)](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone),
|
||||||
|
[object.ReferenceEquals\(object?, object?\)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
|
||||||
|
[object.ToString\(\)](https://learn.microsoft.com/dotnet/api/system.object.tostring)
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
This example demonstrates how to set up the SettingsHelper class with custom accessor and
|
||||||
|
detector methods that read from an App.config file. The setup is done at the beginning of the
|
||||||
|
application execution, before any other usage of the helper methods.
|
||||||
|
|
||||||
|
<pre><code class="lang-csharp">public int main(string[] args)
|
||||||
|
{
|
||||||
|
// Set up SettingsHelper with custom accessor and detector methods
|
||||||
|
Func<string, object> accessor = (key) =>
|
||||||
|
{
|
||||||
|
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
|
||||||
|
return config.AppSettings.Settings[key].Value;
|
||||||
|
};
|
||||||
|
|
||||||
|
Func<string, bool> detector = (key) =>
|
||||||
|
{
|
||||||
|
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
|
||||||
|
return config.AppSettings.Settings.AllKeys.Contains(key);
|
||||||
|
};
|
||||||
|
|
||||||
|
SettingsHelper.SetAccessorMethod(accessor);
|
||||||
|
SettingsHelper.SetDetectorMethod(detector);
|
||||||
|
|
||||||
|
// Use the helper to retrieve and set settings
|
||||||
|
SettingsHelper.SetApplicationSetting<int>("MySettingKey", 42);
|
||||||
|
int newSetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
||||||
|
Console.WriteLine("New setting: {0}", newSetting);
|
||||||
|
|
||||||
|
int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
||||||
|
Console.WriteLine("Retrieved setting: {0}", mySetting);
|
||||||
|
}</code></pre>
|
||||||
|
|
||||||
|
## Remarks
|
||||||
|
|
||||||
|
The specific means of accessing and storing the settings are determined by the consumer,
|
||||||
|
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
|
||||||
|
.
|
||||||
|
|
||||||
|
## Methods
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_"></a> GetApplicationSetting<T\>\(string\)
|
||||||
|
|
||||||
|
Retrieves a setting with the given <code>key</code>.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static T GetApplicationSetting<T>(string settingName)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`settingName` [string](https://learn.microsoft.com/dotnet/api/system.string)
|
||||||
|
|
||||||
|
The name of the setting to retrieve.
|
||||||
|
|
||||||
|
#### Returns
|
||||||
|
|
||||||
|
T
|
||||||
|
|
||||||
|
The value of the setting as an uncast <code class="typeparamref">T</code>.
|
||||||
|
|
||||||
|
#### Type Parameters
|
||||||
|
|
||||||
|
`T`
|
||||||
|
|
||||||
|
The type of the setting to be retrieved.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__"></a> SetAccessorMethod\(Func<string, object\>\)
|
||||||
|
|
||||||
|
Sets the function used to retrieve application settings.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void SetAccessorMethod(Func<string, object> accessor)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`accessor` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [object](https://learn.microsoft.com/dotnet/api/system.object)\>
|
||||||
|
|
||||||
|
The new function used to retrieve application settings.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
|
||||||
|
|
||||||
|
Thrown when one or more required arguments are null.
|
||||||
|
|
||||||
|
### <a id="CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__"></a> SetDetectorMethod\(Func<string, bool\>\)
|
||||||
|
|
||||||
|
Sets the function used to detect if an application setting with a given <code>key</code> exists.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public static void SetDetectorMethod(Func<string, bool> detector)
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Parameters
|
||||||
|
|
||||||
|
`detector` [Func](https://learn.microsoft.com/dotnet/api/system.func\-2)<[string](https://learn.microsoft.com/dotnet/api/system.string), [bool](https://learn.microsoft.com/dotnet/api/system.boolean)\>
|
||||||
|
|
||||||
|
The new function used to detect if an application setting exists.
|
||||||
|
|
||||||
|
#### Exceptions
|
||||||
|
|
||||||
|
[ArgumentNullException](https://learn.microsoft.com/dotnet/api/system.argumentnullexception)
|
||||||
|
|
||||||
|
Thrown when one or more required arguments are null.
|
||||||
|
|
||||||
|
|
@ -1,637 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper
|
|
||||||
commentId: T:CapyKit.Helpers.SettingsHelper
|
|
||||||
id: SettingsHelper
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)
|
|
||||||
- CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})
|
|
||||||
- CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: SettingsHelper
|
|
||||||
nameWithType: SettingsHelper
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper
|
|
||||||
type: Class
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: SettingsHelper
|
|
||||||
path: ../CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
startLine: 49
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Static class containing helper methods for retrieving and setting application settings.
|
|
||||||
remarks: >-
|
|
||||||
The specific means of accessing and storing the settings are determined by the consumer,
|
|
||||||
|
|
||||||
allowing for flexibility in various environments such as <code>App.config</code> or <code>Web.config</code>
|
|
||||||
|
|
||||||
.
|
|
||||||
example:
|
|
||||||
- >-
|
|
||||||
This example demonstrates how to set up the SettingsHelper class with custom accessor and
|
|
||||||
|
|
||||||
detector methods that read from an App.config file. The setup is done at the beginning of the
|
|
||||||
|
|
||||||
application execution, before any other usage of the helper methods.
|
|
||||||
|
|
||||||
|
|
||||||
<pre><code class="lang-csharp">public int main(string[] args)
|
|
||||||
|
|
||||||
{
|
|
||||||
// Set up SettingsHelper with custom accessor and detector methods
|
|
||||||
Func<string, object> accessor = (key) =>
|
|
||||||
{
|
|
||||||
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
|
|
||||||
return config.AppSettings.Settings[key].Value;
|
|
||||||
};
|
|
||||||
|
|
||||||
Func<string, bool> detector = (key) =>
|
|
||||||
{
|
|
||||||
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
|
|
||||||
return config.AppSettings.Settings.AllKeys.Contains(key);
|
|
||||||
};
|
|
||||||
|
|
||||||
SettingsHelper.SetAccessorMethod(accessor);
|
|
||||||
SettingsHelper.SetDetectorMethod(detector);
|
|
||||||
|
|
||||||
// Use the helper to retrieve and set settings
|
|
||||||
SettingsHelper.SetApplicationSetting<int>("MySettingKey", 42);
|
|
||||||
int newSetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
|
||||||
Console.WriteLine("New setting: {0}", newSetting);
|
|
||||||
|
|
||||||
int mySetting = SettingsHelper.GetApplicationSetting<int>("MySettingKey");
|
|
||||||
Console.WriteLine("Retrieved setting: {0}", mySetting);
|
|
||||||
}</code></pre>
|
|
||||||
syntax:
|
|
||||||
content: public static class SettingsHelper
|
|
||||||
content.vb: Public Module SettingsHelper
|
|
||||||
inheritance:
|
|
||||||
- System.Object
|
|
||||||
inheritedMembers:
|
|
||||||
- System.Object.Equals(System.Object)
|
|
||||||
- System.Object.Equals(System.Object,System.Object)
|
|
||||||
- System.Object.GetHashCode
|
|
||||||
- System.Object.GetType
|
|
||||||
- System.Object.MemberwiseClone
|
|
||||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
- System.Object.ToString
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)
|
|
||||||
commentId: M:CapyKit.Helpers.SettingsHelper.GetApplicationSetting``1(System.String)
|
|
||||||
id: GetApplicationSetting``1(System.String)
|
|
||||||
parent: CapyKit.Helpers.SettingsHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: GetApplicationSetting<T>(string)
|
|
||||||
nameWithType: SettingsHelper.GetApplicationSetting<T>(string)
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper.GetApplicationSetting<T>(string)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: GetApplicationSetting
|
|
||||||
path: ../CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
startLine: 74
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Retrieves a setting with the given <code>key</code>.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static T GetApplicationSetting<T>(string settingName)
|
|
||||||
parameters:
|
|
||||||
- id: settingName
|
|
||||||
type: System.String
|
|
||||||
description: The name of the setting to retrieve.
|
|
||||||
typeParameters:
|
|
||||||
- id: T
|
|
||||||
description: The type of the setting to be retrieved.
|
|
||||||
return:
|
|
||||||
type: '{T}'
|
|
||||||
description: The value of the setting as an uncast <code class="typeparamref">T</code>.
|
|
||||||
content.vb: Public Shared Function GetApplicationSetting(Of T)(settingName As String) As T
|
|
||||||
overload: CapyKit.Helpers.SettingsHelper.GetApplicationSetting*
|
|
||||||
nameWithType.vb: SettingsHelper.GetApplicationSetting(Of T)(String)
|
|
||||||
fullName.vb: CapyKit.Helpers.SettingsHelper.GetApplicationSetting(Of T)(String)
|
|
||||||
name.vb: GetApplicationSetting(Of T)(String)
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})
|
|
||||||
commentId: M:CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func{System.String,System.Object})
|
|
||||||
id: SetAccessorMethod(System.Func{System.String,System.Object})
|
|
||||||
parent: CapyKit.Helpers.SettingsHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: SetAccessorMethod(Func<string, object>)
|
|
||||||
nameWithType: SettingsHelper.SetAccessorMethod(Func<string, object>)
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func<string, object>)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: SetAccessorMethod
|
|
||||||
path: ../CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
startLine: 95
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Sets the function used to retrieve application settings.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void SetAccessorMethod(Func<string, object> accessor)
|
|
||||||
parameters:
|
|
||||||
- id: accessor
|
|
||||||
type: System.Func{System.String,System.Object}
|
|
||||||
description: The new function used to retrieve application settings.
|
|
||||||
content.vb: Public Shared Sub SetAccessorMethod(accessor As Func(Of String, Object))
|
|
||||||
overload: CapyKit.Helpers.SettingsHelper.SetAccessorMethod*
|
|
||||||
exceptions:
|
|
||||||
- type: System.ArgumentNullException
|
|
||||||
commentId: T:System.ArgumentNullException
|
|
||||||
description: Thrown when one or more required arguments are null.
|
|
||||||
nameWithType.vb: SettingsHelper.SetAccessorMethod(Func(Of String, Object))
|
|
||||||
fullName.vb: CapyKit.Helpers.SettingsHelper.SetAccessorMethod(System.Func(Of String, Object))
|
|
||||||
name.vb: SetAccessorMethod(Func(Of String, Object))
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})
|
|
||||||
commentId: M:CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func{System.String,System.Boolean})
|
|
||||||
id: SetDetectorMethod(System.Func{System.String,System.Boolean})
|
|
||||||
parent: CapyKit.Helpers.SettingsHelper
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: SetDetectorMethod(Func<string, bool>)
|
|
||||||
nameWithType: SettingsHelper.SetDetectorMethod(Func<string, bool>)
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func<string, bool>)
|
|
||||||
type: Method
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: SetDetectorMethod
|
|
||||||
path: ../CapyKit/Helpers/SettingsHelper.cs
|
|
||||||
startLine: 118
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Sets the function used to detect if an application setting with a given <code>key</code> exists.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public static void SetDetectorMethod(Func<string, bool> detector)
|
|
||||||
parameters:
|
|
||||||
- id: detector
|
|
||||||
type: System.Func{System.String,System.Boolean}
|
|
||||||
description: The new function used to detect if an application setting exists.
|
|
||||||
content.vb: Public Shared Sub SetDetectorMethod(detector As Func(Of String, Boolean))
|
|
||||||
overload: CapyKit.Helpers.SettingsHelper.SetDetectorMethod*
|
|
||||||
exceptions:
|
|
||||||
- type: System.ArgumentNullException
|
|
||||||
commentId: T:System.ArgumentNullException
|
|
||||||
description: Thrown when one or more required arguments are null.
|
|
||||||
nameWithType.vb: SettingsHelper.SetDetectorMethod(Func(Of String, Boolean))
|
|
||||||
fullName.vb: CapyKit.Helpers.SettingsHelper.SetDetectorMethod(System.Func(Of String, Boolean))
|
|
||||||
name.vb: SetDetectorMethod(Func(Of String, Boolean))
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: System.Object
|
|
||||||
commentId: T:System.Object
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
name: object
|
|
||||||
nameWithType: object
|
|
||||||
fullName: object
|
|
||||||
nameWithType.vb: Object
|
|
||||||
fullName.vb: Object
|
|
||||||
name.vb: Object
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
name: Equals(object)
|
|
||||||
nameWithType: object.Equals(object)
|
|
||||||
fullName: object.Equals(object)
|
|
||||||
nameWithType.vb: Object.Equals(Object)
|
|
||||||
fullName.vb: Object.Equals(Object)
|
|
||||||
name.vb: Equals(Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
name: Equals(object, object)
|
|
||||||
nameWithType: object.Equals(object, object)
|
|
||||||
fullName: object.Equals(object, object)
|
|
||||||
nameWithType.vb: Object.Equals(Object, Object)
|
|
||||||
fullName.vb: Object.Equals(Object, Object)
|
|
||||||
name.vb: Equals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.Equals(System.Object,System.Object)
|
|
||||||
name: Equals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
commentId: M:System.Object.GetHashCode
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
name: GetHashCode()
|
|
||||||
nameWithType: object.GetHashCode()
|
|
||||||
fullName: object.GetHashCode()
|
|
||||||
nameWithType.vb: Object.GetHashCode()
|
|
||||||
fullName.vb: Object.GetHashCode()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetHashCode
|
|
||||||
name: GetHashCode
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
commentId: M:System.Object.GetType
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
name: GetType()
|
|
||||||
nameWithType: object.GetType()
|
|
||||||
fullName: object.GetType()
|
|
||||||
nameWithType.vb: Object.GetType()
|
|
||||||
fullName.vb: Object.GetType()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.GetType
|
|
||||||
name: GetType
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
commentId: M:System.Object.MemberwiseClone
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
name: MemberwiseClone()
|
|
||||||
nameWithType: object.MemberwiseClone()
|
|
||||||
fullName: object.MemberwiseClone()
|
|
||||||
nameWithType.vb: Object.MemberwiseClone()
|
|
||||||
fullName.vb: Object.MemberwiseClone()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.MemberwiseClone
|
|
||||||
name: MemberwiseClone
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
name: ReferenceEquals(object, object)
|
|
||||||
nameWithType: object.ReferenceEquals(object, object)
|
|
||||||
fullName: object.ReferenceEquals(object, object)
|
|
||||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
|
||||||
name.vb: ReferenceEquals(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
|
||||||
name: ReferenceEquals
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
commentId: M:System.Object.ToString
|
|
||||||
parent: System.Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
name: ToString()
|
|
||||||
nameWithType: object.ToString()
|
|
||||||
fullName: object.ToString()
|
|
||||||
nameWithType.vb: Object.ToString()
|
|
||||||
fullName.vb: Object.ToString()
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Object.ToString
|
|
||||||
name: ToString
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
|
||||||
- name: (
|
|
||||||
- name: )
|
|
||||||
- uid: System
|
|
||||||
commentId: N:System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system
|
|
||||||
name: System
|
|
||||||
nameWithType: System
|
|
||||||
fullName: System
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper.GetApplicationSetting*
|
|
||||||
commentId: Overload:CapyKit.Helpers.SettingsHelper.GetApplicationSetting
|
|
||||||
href: CapyKit.Helpers.SettingsHelper.html#CapyKit_Helpers_SettingsHelper_GetApplicationSetting__1_System_String_
|
|
||||||
name: GetApplicationSetting
|
|
||||||
nameWithType: SettingsHelper.GetApplicationSetting
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper.GetApplicationSetting
|
|
||||||
- uid: System.String
|
|
||||||
commentId: T:System.String
|
|
||||||
parent: System
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
name: string
|
|
||||||
nameWithType: string
|
|
||||||
fullName: string
|
|
||||||
nameWithType.vb: String
|
|
||||||
fullName.vb: String
|
|
||||||
name.vb: String
|
|
||||||
- uid: '{T}'
|
|
||||||
commentId: '!:T'
|
|
||||||
definition: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: T
|
|
||||||
name: T
|
|
||||||
nameWithType: T
|
|
||||||
fullName: T
|
|
||||||
- uid: System.ArgumentNullException
|
|
||||||
commentId: T:System.ArgumentNullException
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.argumentnullexception
|
|
||||||
name: ArgumentNullException
|
|
||||||
nameWithType: ArgumentNullException
|
|
||||||
fullName: System.ArgumentNullException
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper.SetAccessorMethod*
|
|
||||||
commentId: Overload:CapyKit.Helpers.SettingsHelper.SetAccessorMethod
|
|
||||||
href: CapyKit.Helpers.SettingsHelper.html#CapyKit_Helpers_SettingsHelper_SetAccessorMethod_System_Func_System_String_System_Object__
|
|
||||||
name: SetAccessorMethod
|
|
||||||
nameWithType: SettingsHelper.SetAccessorMethod
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper.SetAccessorMethod
|
|
||||||
- uid: System.Func{System.String,System.Object}
|
|
||||||
commentId: T:System.Func{System.String,System.Object}
|
|
||||||
parent: System
|
|
||||||
definition: System.Func`2
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
name: Func<string, object>
|
|
||||||
nameWithType: Func<string, object>
|
|
||||||
fullName: System.Func<string, object>
|
|
||||||
nameWithType.vb: Func(Of String, Object)
|
|
||||||
fullName.vb: System.Func(Of String, Object)
|
|
||||||
name.vb: Func(Of String, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Func`2
|
|
||||||
name: Func
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
- name: <
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: '>'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Func`2
|
|
||||||
name: Func
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: System.Func`2
|
|
||||||
commentId: T:System.Func`2
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
name: Func<T, TResult>
|
|
||||||
nameWithType: Func<T, TResult>
|
|
||||||
fullName: System.Func<T, TResult>
|
|
||||||
nameWithType.vb: Func(Of T, TResult)
|
|
||||||
fullName.vb: System.Func(Of T, TResult)
|
|
||||||
name.vb: Func(Of T, TResult)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Func`2
|
|
||||||
name: Func
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: TResult
|
|
||||||
- name: '>'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Func`2
|
|
||||||
name: Func
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: TResult
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.SettingsHelper.SetDetectorMethod*
|
|
||||||
commentId: Overload:CapyKit.Helpers.SettingsHelper.SetDetectorMethod
|
|
||||||
href: CapyKit.Helpers.SettingsHelper.html#CapyKit_Helpers_SettingsHelper_SetDetectorMethod_System_Func_System_String_System_Boolean__
|
|
||||||
name: SetDetectorMethod
|
|
||||||
nameWithType: SettingsHelper.SetDetectorMethod
|
|
||||||
fullName: CapyKit.Helpers.SettingsHelper.SetDetectorMethod
|
|
||||||
- uid: System.Func{System.String,System.Boolean}
|
|
||||||
commentId: T:System.Func{System.String,System.Boolean}
|
|
||||||
parent: System
|
|
||||||
definition: System.Func`2
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
name: Func<string, bool>
|
|
||||||
nameWithType: Func<string, bool>
|
|
||||||
fullName: System.Func<string, bool>
|
|
||||||
nameWithType.vb: Func(Of String, Boolean)
|
|
||||||
fullName.vb: System.Func(Of String, Boolean)
|
|
||||||
name.vb: Func(Of String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: System.Func`2
|
|
||||||
name: Func
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
- name: <
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: '>'
|
|
||||||
spec.vb:
|
|
||||||
- uid: System.Func`2
|
|
||||||
name: Func
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.func-2
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
48
Docs/api/CapyKit.Helpers.ValidCharacterCollection.md
Normal file
48
Docs/api/CapyKit.Helpers.ValidCharacterCollection.md
Normal file
|
|
@ -0,0 +1,48 @@
|
||||||
|
# <a id="CapyKit_Helpers_ValidCharacterCollection"></a> Enum ValidCharacterCollection
|
||||||
|
|
||||||
|
Namespace: [CapyKit.Helpers](CapyKit.Helpers.md)
|
||||||
|
Assembly: CapyKit.dll
|
||||||
|
|
||||||
|
An enumeration that defines the types of characters that can be included in a random string.
|
||||||
|
|
||||||
|
```csharp
|
||||||
|
public enum ValidCharacterCollection
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Extension Methods
|
||||||
|
|
||||||
|
[EnumerationExtensions.GetDescription\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetDescription\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetName\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetPrettyName\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetPrettyName\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.GetValue\(Enum\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_GetValue\_System\_Enum\_),
|
||||||
|
[EnumerationExtensions.Parse<ValidCharacterCollection\>\(ValidCharacterCollection, string\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_),
|
||||||
|
[EnumerationExtensions.Parse<ValidCharacterCollection\>\(ValidCharacterCollection, string, bool\)](CapyKit.Extensions.EnumerationExtensions.md\#CapyKit\_Extensions\_EnumerationExtensions\_Parse\_\_1\_\_\_0\_System\_String\_System\_Boolean\_),
|
||||||
|
[ObjectExtensions.UpdateProperties<ValidCharacterCollection\>\(ValidCharacterCollection, ValidCharacterCollection\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_\_1\_\_\_0\_\_\_0\_),
|
||||||
|
[ObjectExtensions.UpdateProperties\(object, object\)](CapyKit.Extensions.ObjectExtensions.md\#CapyKit\_Extensions\_ObjectExtensions\_UpdateProperties\_System\_Object\_System\_Object\_)
|
||||||
|
|
||||||
|
## Fields
|
||||||
|
|
||||||
|
`Lowercase = 0`
|
||||||
|
|
||||||
|
Indicates that lower case characters should be included in the random string.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Numbers = 2`
|
||||||
|
|
||||||
|
Indicates that numeric characters should be included in the random string.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Special = 3`
|
||||||
|
|
||||||
|
Indicates that special characters should be included in the random string.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
`Uppercase = 1`
|
||||||
|
|
||||||
|
Indicates that upper case characters should be included in the random string.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1,884 +0,0 @@
|
||||||
### YamlMime:ManagedReference
|
|
||||||
items:
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
commentId: T:CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
id: ValidCharacterCollection
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
children:
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.Lowercase
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.Numbers
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.Special
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.Uppercase
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
nameWithType: ValidCharacterCollection
|
|
||||||
fullName: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
type: Enum
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: ValidCharacterCollection
|
|
||||||
path: ../CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
startLine: 374
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: An enumeration that defines the types of characters that can be included in a random string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: public enum ValidCharacterCollection
|
|
||||||
content.vb: Public Enum ValidCharacterCollection
|
|
||||||
extensionMethods:
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
|
|
||||||
- CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection)
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
- System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
- System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.Lowercase
|
|
||||||
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Lowercase
|
|
||||||
id: Lowercase
|
|
||||||
parent: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Lowercase
|
|
||||||
nameWithType: ValidCharacterCollection.Lowercase
|
|
||||||
fullName: CapyKit.Helpers.ValidCharacterCollection.Lowercase
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Lowercase
|
|
||||||
path: ../CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
startLine: 379
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Indicates that lower case characters should be included in the random string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("abcdefghijklmnopqrstuvwxyz")]
|
|
||||||
|
|
||||||
Lowercase = 0
|
|
||||||
return:
|
|
||||||
type: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("abcdefghijklmnopqrstuvwxyz")>
|
|
||||||
|
|
||||||
Lowercase = 0
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: abcdefghijklmnopqrstuvwxyz
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.Uppercase
|
|
||||||
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Uppercase
|
|
||||||
id: Uppercase
|
|
||||||
parent: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Uppercase
|
|
||||||
nameWithType: ValidCharacterCollection.Uppercase
|
|
||||||
fullName: CapyKit.Helpers.ValidCharacterCollection.Uppercase
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Uppercase
|
|
||||||
path: ../CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
startLine: 384
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Indicates that upper case characters should be included in the random string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("ABCDEFGHIJKLMNOPQRSTUVWXYZ")]
|
|
||||||
|
|
||||||
Uppercase = 1
|
|
||||||
return:
|
|
||||||
type: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("ABCDEFGHIJKLMNOPQRSTUVWXYZ")>
|
|
||||||
|
|
||||||
Uppercase = 1
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: ABCDEFGHIJKLMNOPQRSTUVWXYZ
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.Numbers
|
|
||||||
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Numbers
|
|
||||||
id: Numbers
|
|
||||||
parent: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Numbers
|
|
||||||
nameWithType: ValidCharacterCollection.Numbers
|
|
||||||
fullName: CapyKit.Helpers.ValidCharacterCollection.Numbers
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Numbers
|
|
||||||
path: ../CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
startLine: 389
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Indicates that numeric characters should be included in the random string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("0123456789")]
|
|
||||||
|
|
||||||
Numbers = 2
|
|
||||||
return:
|
|
||||||
type: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("0123456789")>
|
|
||||||
|
|
||||||
Numbers = 2
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: "0123456789"
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.Special
|
|
||||||
commentId: F:CapyKit.Helpers.ValidCharacterCollection.Special
|
|
||||||
id: Special
|
|
||||||
parent: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
langs:
|
|
||||||
- csharp
|
|
||||||
- vb
|
|
||||||
name: Special
|
|
||||||
nameWithType: ValidCharacterCollection.Special
|
|
||||||
fullName: CapyKit.Helpers.ValidCharacterCollection.Special
|
|
||||||
type: Field
|
|
||||||
source:
|
|
||||||
remote:
|
|
||||||
path: CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
branch: main
|
|
||||||
repo: https://git.jordanwages.com/wagesj45/CapyKit.git
|
|
||||||
id: Special
|
|
||||||
path: ../CapyKit/Helpers/SecurityHelper.cs
|
|
||||||
startLine: 394
|
|
||||||
assemblies:
|
|
||||||
- CapyKit
|
|
||||||
namespace: CapyKit.Helpers
|
|
||||||
summary: Indicates that special characters should be included in the random string.
|
|
||||||
example: []
|
|
||||||
syntax:
|
|
||||||
content: >-
|
|
||||||
[EnumerationDescription("!@#$%&?+-_")]
|
|
||||||
|
|
||||||
Special = 3
|
|
||||||
return:
|
|
||||||
type: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
content.vb: >-
|
|
||||||
<EnumerationDescription("!@#$%&?+-_")>
|
|
||||||
|
|
||||||
Special = 3
|
|
||||||
attributes:
|
|
||||||
- type: CapyKit.Attributes.EnumerationDescriptionAttribute
|
|
||||||
ctor: CapyKit.Attributes.EnumerationDescriptionAttribute.#ctor(System.String)
|
|
||||||
arguments:
|
|
||||||
- type: System.String
|
|
||||||
value: '!@#$%&?+-_'
|
|
||||||
references:
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
commentId: N:CapyKit.Helpers
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Helpers
|
|
||||||
nameWithType: CapyKit.Helpers
|
|
||||||
fullName: CapyKit.Helpers
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Helpers
|
|
||||||
name: Helpers
|
|
||||||
href: CapyKit.Helpers.html
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse<ValidCharacterCollection>(ValidCharacterCollection, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Helpers.ValidCharacterCollection>(CapyKit.Helpers.ValidCharacterCollection, string)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Helpers.ValidCharacterCollection)(CapyKit.Helpers.ValidCharacterCollection, String)
|
|
||||||
name.vb: Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.EnumerationExtensions.Parse``1(System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
name: Parse<ValidCharacterCollection>(ValidCharacterCollection, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<ValidCharacterCollection>(ValidCharacterCollection, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<CapyKit.Helpers.ValidCharacterCollection>(CapyKit.Helpers.ValidCharacterCollection, string, bool)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of CapyKit.Helpers.ValidCharacterCollection)(CapyKit.Helpers.ValidCharacterCollection, String, Boolean)
|
|
||||||
name.vb: Parse(Of ValidCharacterCollection)(ValidCharacterCollection, String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(CapyKit.Helpers.ValidCharacterCollection,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection.CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<ValidCharacterCollection>(ValidCharacterCollection, ValidCharacterCollection)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<ValidCharacterCollection>(ValidCharacterCollection, ValidCharacterCollection)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<CapyKit.Helpers.ValidCharacterCollection>(CapyKit.Helpers.ValidCharacterCollection, CapyKit.Helpers.ValidCharacterCollection)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of ValidCharacterCollection)(ValidCharacterCollection, ValidCharacterCollection)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of CapyKit.Helpers.ValidCharacterCollection)(CapyKit.Helpers.ValidCharacterCollection, CapyKit.Helpers.ValidCharacterCollection)
|
|
||||||
name.vb: UpdateProperties(Of ValidCharacterCollection)(ValidCharacterCollection, ValidCharacterCollection)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection,CapyKit.Helpers.ValidCharacterCollection)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(CapyKit.Helpers.ValidCharacterCollection,CapyKit.Helpers.ValidCharacterCollection)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetDescription
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetName
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetPrettyName
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Enum.CapyKit.Extensions.EnumerationExtensions.GetValue
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
parent: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
definition: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: System.Object.CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
parent: CapyKit.Extensions.ObjectExtensions
|
|
||||||
definition: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
name: Parse<T>(T, string)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
|
|
||||||
name.vb: Parse(Of T)(T, String)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.EnumerationExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html
|
|
||||||
name: EnumerationExtensions
|
|
||||||
nameWithType: EnumerationExtensions
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
name: Parse<T>(T, string, bool)
|
|
||||||
nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
|
|
||||||
nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
|
|
||||||
name.vb: Parse(Of T)(T, String, Boolean)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: string
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: bool
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
|
|
||||||
name: Parse
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_System_Boolean_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.String
|
|
||||||
name: String
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.string
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Boolean
|
|
||||||
name: Boolean
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.boolean
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
name: UpdateProperties<T>(T, T)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties<T>(T, T)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Of T)(T, T)
|
|
||||||
name.vb: UpdateProperties(Of T)(T, T)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: <
|
|
||||||
- name: T
|
|
||||||
- name: '>'
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties``1(``0,``0)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties__1___0___0_
|
|
||||||
- name: (
|
|
||||||
- name: Of
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- name: (
|
|
||||||
- name: T
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- name: T
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions
|
|
||||||
commentId: T:CapyKit.Extensions.ObjectExtensions
|
|
||||||
parent: CapyKit.Extensions
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html
|
|
||||||
name: ObjectExtensions
|
|
||||||
nameWithType: ObjectExtensions
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
name: GetDescription(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetDescription(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
|
|
||||||
name: GetDescription
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
name: GetName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
|
|
||||||
name: GetName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
name: GetPrettyName(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetPrettyName(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
|
|
||||||
name: GetPrettyName
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
name: GetValue(Enum)
|
|
||||||
nameWithType: EnumerationExtensions.GetValue(Enum)
|
|
||||||
fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
|
|
||||||
name: GetValue
|
|
||||||
href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Enum
|
|
||||||
name: Enum
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.enum
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
commentId: M:CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
isExternal: true
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
name: UpdateProperties(object, object)
|
|
||||||
nameWithType: ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
fullName: CapyKit.Extensions.ObjectExtensions.UpdateProperties(object, object)
|
|
||||||
nameWithType.vb: ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
fullName.vb: CapyKit.Extensions.ObjectExtensions.UpdateProperties(Object, Object)
|
|
||||||
name.vb: UpdateProperties(Object, Object)
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit.Extensions.ObjectExtensions.UpdateProperties(System.Object,System.Object)
|
|
||||||
name: UpdateProperties
|
|
||||||
href: CapyKit.Extensions.ObjectExtensions.html#CapyKit_Extensions_ObjectExtensions_UpdateProperties_System_Object_System_Object_
|
|
||||||
- name: (
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: ','
|
|
||||||
- name: " "
|
|
||||||
- uid: System.Object
|
|
||||||
name: Object
|
|
||||||
isExternal: true
|
|
||||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
|
||||||
- name: )
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
commentId: N:CapyKit.Extensions
|
|
||||||
href: CapyKit.html
|
|
||||||
name: CapyKit.Extensions
|
|
||||||
nameWithType: CapyKit.Extensions
|
|
||||||
fullName: CapyKit.Extensions
|
|
||||||
spec.csharp:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
spec.vb:
|
|
||||||
- uid: CapyKit
|
|
||||||
name: CapyKit
|
|
||||||
href: CapyKit.html
|
|
||||||
- name: .
|
|
||||||
- uid: CapyKit.Extensions
|
|
||||||
name: Extensions
|
|
||||||
href: CapyKit.Extensions.html
|
|
||||||
- uid: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
commentId: T:CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
parent: CapyKit.Helpers
|
|
||||||
href: CapyKit.Helpers.ValidCharacterCollection.html
|
|
||||||
name: ValidCharacterCollection
|
|
||||||
nameWithType: ValidCharacterCollection
|
|
||||||
fullName: CapyKit.Helpers.ValidCharacterCollection
|
|
||||||
42
Docs/api/CapyKit.Helpers.md
Normal file
42
Docs/api/CapyKit.Helpers.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
# <a id="CapyKit_Helpers"></a> Namespace CapyKit.Helpers
|
||||||
|
|
||||||
|
### Classes
|
||||||
|
|
||||||
|
[CalculationHelper](CapyKit.Helpers.CalculationHelper.md)
|
||||||
|
|
||||||
|
Static class providing helper methods for various calculations.
|
||||||
|
|
||||||
|
[CompressionHelper](CapyKit.Helpers.CompressionHelper.md)
|
||||||
|
|
||||||
|
A class that contains methods for managing data compression.
|
||||||
|
|
||||||
|
[EncryptionHelper](CapyKit.Helpers.EncryptionHelper.md)
|
||||||
|
|
||||||
|
[KeyHelper](CapyKit.Helpers.KeyHelper.md)
|
||||||
|
|
||||||
|
A class that contains methods for managing key creation and validation against a master key.
|
||||||
|
|
||||||
|
[LanguageHelper](CapyKit.Helpers.LanguageHelper.md)
|
||||||
|
|
||||||
|
Helper class for handling text transformations.
|
||||||
|
|
||||||
|
[SecurityHelper](CapyKit.Helpers.SecurityHelper.md)
|
||||||
|
|
||||||
|
A class that contains methods for managing secure data processing and cryptography.
|
||||||
|
|
||||||
|
[SerializationHelper](CapyKit.Helpers.SerializationHelper.md)
|
||||||
|
|
||||||
|
[SettingsHelper](CapyKit.Helpers.SettingsHelper.md)
|
||||||
|
|
||||||
|
Static class containing helper methods for retrieving and setting application settings.
|
||||||
|
|
||||||
|
### Interfaces
|
||||||
|
|
||||||
|
[IEncryptionAlgorithm](CapyKit.Helpers.IEncryptionAlgorithm.md)
|
||||||
|
|
||||||
|
### Enums
|
||||||
|
|
||||||
|
[ValidCharacterCollection](CapyKit.Helpers.ValidCharacterCollection.md)
|
||||||
|
|
||||||
|
An enumeration that defines the types of characters that can be included in a random string.
|
||||||
|
|
||||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue