Migrating to docfx
This commit is contained in:
parent
affd2899cf
commit
d7009eb597
326 changed files with 2 additions and 27821 deletions
|
|
@ -10,8 +10,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
|
||||||
.editorconfig = .editorconfig
|
.editorconfig = .editorconfig
|
||||||
EndProjectSection
|
EndProjectSection
|
||||||
EndProject
|
EndProject
|
||||||
Project("{7CF6DF6D-3B04-46F8-A40B-537D21BCA0B4}") = "Documentation", "..\Documentation\Documentation.shfbproj", "{E23D3844-E594-487E-979B-2D35B1B9AAE8}"
|
|
||||||
EndProject
|
|
||||||
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "..\Tests\Tests.csproj", "{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}"
|
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Tests", "..\Tests\Tests.csproj", "{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}"
|
||||||
EndProject
|
EndProject
|
||||||
Global
|
Global
|
||||||
|
|
@ -24,10 +22,6 @@ Global
|
||||||
{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Release|Any CPU.Build.0 = Release|Any CPU
|
{D1ACE10F-CBC8-4BA8-BB85-11DB4EEE5912}.Release|Any CPU.Build.0 = Release|Any CPU
|
||||||
{E23D3844-E594-487E-979B-2D35B1B9AAE8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
|
||||||
{E23D3844-E594-487E-979B-2D35B1B9AAE8}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
|
||||||
{E23D3844-E594-487E-979B-2D35B1B9AAE8}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
|
||||||
{E23D3844-E594-487E-979B-2D35B1B9AAE8}.Release|Any CPU.Build.0 = Release|Any CPU
|
|
||||||
{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
|
||||||
{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}.Debug|Any CPU.Build.0 = Debug|Any CPU
|
||||||
{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
{D142EF3D-8F61-40B6-8358-7D5B7F8A2B18}.Release|Any CPU.ActiveCfg = Release|Any CPU
|
||||||
|
|
@ -39,4 +33,6 @@ Global
|
||||||
GlobalSection(ExtensibilityGlobals) = postSolution
|
GlobalSection(ExtensibilityGlobals) = postSolution
|
||||||
SolutionGuid = {AF075174-308F-4D69-9160-C3CCE89EAD68}
|
SolutionGuid = {AF075174-308F-4D69-9160-C3CCE89EAD68}
|
||||||
EndGlobalSection
|
EndGlobalSection
|
||||||
|
GlobalSection(NestedProjects) = preSolution
|
||||||
|
EndGlobalSection
|
||||||
EndGlobal
|
EndGlobal
|
||||||
|
|
|
||||||
|
|
@ -1,33 +0,0 @@
|
||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<topic id="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" revisionNumber="1">
|
|
||||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
||||||
<introduction>
|
|
||||||
<para>The topics in this section describe the various changes made to the [TODO: Project Title] over the
|
|
||||||
life of the project.</para>
|
|
||||||
</introduction>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<title>Version History</title>
|
|
||||||
<content>
|
|
||||||
<para>Select a version below to see a description of its changes.</para>
|
|
||||||
|
|
||||||
<list class="bullet">
|
|
||||||
<listItem>
|
|
||||||
<para><link xlink:href="fa7407d1-9116-4ad7-a9ab-ed094685b070" /></para>
|
|
||||||
</listItem>
|
|
||||||
|
|
||||||
<listItem>
|
|
||||||
<para>[TODO: Add links to each specific version page]</para>
|
|
||||||
</listItem>
|
|
||||||
|
|
||||||
</list>
|
|
||||||
|
|
||||||
</content>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<relatedTopics>
|
|
||||||
<link xlink:href="849aa079-3d64-4cf1-966f-44af23c73160" />
|
|
||||||
</relatedTopics>
|
|
||||||
|
|
||||||
</developerConceptualDocument>
|
|
||||||
</topic>
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<topic id="fa7407d1-9116-4ad7-a9ab-ed094685b070" revisionNumber="1">
|
|
||||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
||||||
<introduction>
|
|
||||||
<para>Version [TODO: Version] was released on [TODO: Date].
|
|
||||||
</para>
|
|
||||||
</introduction>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<title>Changes in This Release</title>
|
|
||||||
<content>
|
|
||||||
|
|
||||||
<list class="bullet">
|
|
||||||
<listItem>
|
|
||||||
<para>[TODO: Add change items here]</para>
|
|
||||||
</listItem>
|
|
||||||
|
|
||||||
</list>
|
|
||||||
|
|
||||||
</content>
|
|
||||||
</section>
|
|
||||||
|
|
||||||
<relatedTopics>
|
|
||||||
<link xlink:href="7d36447b-0aab-4ce9-b5ed-e60ec5bee103" />
|
|
||||||
</relatedTopics>
|
|
||||||
|
|
||||||
</developerConceptualDocument>
|
|
||||||
</topic>
|
|
||||||
|
|
@ -1,37 +0,0 @@
|
||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<topic id="849aa079-3d64-4cf1-966f-44af23c73160" revisionNumber="1">
|
|
||||||
<developerConceptualDocument xmlns="http://ddue.schemas.microsoft.com/authoring/2003/5" xmlns:xlink="http://www.w3.org/1999/xlink">
|
|
||||||
<introduction>
|
|
||||||
<para>
|
|
||||||
Welcome to the official documentation for <bold>CapyKit</bold> – your go-to utility kit for boosting productivity in any <bold>.NET</bold> project.
|
|
||||||
Originally born out of the <em>HappyCapy</em> project, <bold>CapyKit</bold> is now fully open for the community,
|
|
||||||
offering a wide array of C# utilities and extensions.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
Whether you're looking to integrate some handy extensions into your existing project or you're exploring what
|
|
||||||
<bold>CapyKit</bold> can do for your next venture, you've come to the right place!
|
|
||||||
</para>
|
|
||||||
</introduction>
|
|
||||||
|
|
||||||
<section>
|
|
||||||
<title>Getting Started</title>
|
|
||||||
<content>
|
|
||||||
<para>
|
|
||||||
This documentation is generated directly from the source code and is constantly evolving as the project progresses.
|
|
||||||
To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md).
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
If you're new to the project, bear with us while things are still transitioning from the private repository.
|
|
||||||
We're working hard to make this resource the best it can be.
|
|
||||||
</para>
|
|
||||||
|
|
||||||
<para>
|
|
||||||
For a complete overview of the automatically generated documentation, start by exploring the
|
|
||||||
[API and Utilities Reference](R_Project_Documentation.md)
|
|
||||||
</para>
|
|
||||||
</content>
|
|
||||||
</section>
|
|
||||||
</developerConceptualDocument>
|
|
||||||
</topic>
|
|
||||||
|
|
@ -1,8 +0,0 @@
|
||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<Topics>
|
|
||||||
<Topic id="849aa079-3d64-4cf1-966f-44af23c73160" visible="True" isDefault="true" isSelected="true" apiParentMode="InsertAfter" title="CapyKit - C# Utilities">
|
|
||||||
<HelpKeywords>
|
|
||||||
<HelpKeyword index="K" term="Welcome" />
|
|
||||||
</HelpKeywords>
|
|
||||||
</Topic>
|
|
||||||
</Topics>
|
|
||||||
|
|
@ -1,124 +0,0 @@
|
||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<Project ToolsVersion="15.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
|
|
||||||
<!-- Import the common properties to support NuGet restore -->
|
|
||||||
<Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
|
|
||||||
<PropertyGroup>
|
|
||||||
<!-- A target framework version is required by Visual Studio. It can be any version with a targeting pack installed. -->
|
|
||||||
<TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
|
|
||||||
<!-- The configuration and platform will be used to determine which assemblies to include from solution and
|
|
||||||
project documentation sources -->
|
|
||||||
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
|
|
||||||
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
|
|
||||||
<SchemaVersion>2.0</SchemaVersion>
|
|
||||||
<ProjectGuid>e23d3844-e594-487e-979b-2d35b1b9aae8</ProjectGuid>
|
|
||||||
<SHFBSchemaVersion>2017.9.26.0</SHFBSchemaVersion>
|
|
||||||
<!-- AssemblyName, Name, and RootNamespace are not used by SHFB but Visual Studio adds them anyway -->
|
|
||||||
<AssemblyName>Documentation</AssemblyName>
|
|
||||||
<RootNamespace>Documentation</RootNamespace>
|
|
||||||
<Name>Documentation</Name>
|
|
||||||
<!-- SHFB properties -->
|
|
||||||
<FrameworkVersion>.NET Framework 4.7.2</FrameworkVersion>
|
|
||||||
<OutputPath>Help\</OutputPath>
|
|
||||||
<HtmlHelpName>Documentation</HtmlHelpName>
|
|
||||||
<Language>en-US</Language>
|
|
||||||
<TransformComponentArguments>
|
|
||||||
<Argument Key="BibliographyDataFile" Value="True" />
|
|
||||||
<Argument Key="MaxVersionParts" Value="3" />
|
|
||||||
<Argument Key="IncludeEnumValues" Value="True" />
|
|
||||||
<Argument Key="EnumMemberSortOrder" Value="Value" />
|
|
||||||
<Argument Key="FlagsEnumValueFormat" Value="IntegerValue" />
|
|
||||||
<Argument Key="FlagsEnumSeparatorSize" Value="0" />
|
|
||||||
<Argument Key="BaseSourceCodeUrl" Value="" />
|
|
||||||
<Argument Key="ShowParametersOnAllMethods" Value="False" />
|
|
||||||
</TransformComponentArguments>
|
|
||||||
<HelpFileFormat>Markdown</HelpFileFormat>
|
|
||||||
<SyntaxFilters>C#, F#</SyntaxFilters>
|
|
||||||
<PresentationStyle>Markdown</PresentationStyle>
|
|
||||||
<CleanIntermediates>True</CleanIntermediates>
|
|
||||||
<KeepLogFile>True</KeepLogFile>
|
|
||||||
<DisableCodeBlockComponent>False</DisableCodeBlockComponent>
|
|
||||||
<IndentHtml>False</IndentHtml>
|
|
||||||
<BuildAssemblerVerbosity>OnlyWarningsAndErrors</BuildAssemblerVerbosity>
|
|
||||||
<SaveComponentCacheCapacity>100</SaveComponentCacheCapacity>
|
|
||||||
<DocumentationSources>
|
|
||||||
<DocumentationSource sourceFile="..\CapyKit\CapyKit.sln" xmlns="" />
|
|
||||||
</DocumentationSources>
|
|
||||||
<HelpTitle>CapyKit</HelpTitle>
|
|
||||||
<HelpFileVersion>1.0.0.0</HelpFileVersion>
|
|
||||||
<NamingMethod>MemberName</NamingMethod>
|
|
||||||
<ContentPlacement>AboveNamespaces</ContentPlacement>
|
|
||||||
<RootNamespaceContainer>True</RootNamespaceContainer>
|
|
||||||
<NamespaceGrouping>False</NamespaceGrouping>
|
|
||||||
<MaximumGroupParts>2</MaximumGroupParts>
|
|
||||||
<Preliminary>False</Preliminary>
|
|
||||||
<SdkLinkTarget>Blank</SdkLinkTarget>
|
|
||||||
<VisibleItems>Attributes, ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Internals, Privates, PrivateFields, Protected, SealedProtected, ProtectedInternalAsProtected, NonBrowsable, InternalAndPrivateIfExternal</VisibleItems>
|
|
||||||
<PlugInConfigurations>
|
|
||||||
</PlugInConfigurations>
|
|
||||||
<ComponentConfigurations />
|
|
||||||
<WarnOnMissingSourceContext>False</WarnOnMissingSourceContext>
|
|
||||||
<HtmlSdkLinkType>Msdn</HtmlSdkLinkType>
|
|
||||||
<BinaryTOC>True</BinaryTOC>
|
|
||||||
<IncludeFavorites>False</IncludeFavorites>
|
|
||||||
<WebsiteSdkLinkType>Msdn</WebsiteSdkLinkType>
|
|
||||||
<AppendMarkdownFileExtensionsToUrls>True</AppendMarkdownFileExtensionsToUrls>
|
|
||||||
<ProjectSummary>Welcome to the official documentation for CapyKit, a powerful collection of C# utilities designed to enhance your .NET projects. Below, you&#39%3bll find a list of namespaces included in the library, each offering a unique set of tools, extensions, and helpers to streamline your development process.</ProjectSummary>
|
|
||||||
<NamespaceSummaries>
|
|
||||||
<NamespaceSummaryItem name="(global)" isDocumented="False" xmlns="" />
|
|
||||||
<NamespaceSummaryItem name="CapyKit" isDocumented="True" xmlns="">Core utilities and foundational methods for the CapyKit library.</NamespaceSummaryItem>
|
|
||||||
<NamespaceSummaryItem name="CapyKit.Attributes" isDocumented="True" xmlns="">Custom attributes for simplifying .NET code behavior.</NamespaceSummaryItem>
|
|
||||||
<NamespaceSummaryItem name="CapyKit.Enumerations" isDocumented="True" xmlns="">Commonly used enumerations for value comparison and logic.</NamespaceSummaryItem>
|
|
||||||
<NamespaceSummaryItem name="CapyKit.Extensions" isDocumented="True" xmlns="">Extension methods for enhancing .NET classes and simplifying operations.</NamespaceSummaryItem>
|
|
||||||
<NamespaceSummaryItem name="CapyKit.Helpers" isDocumented="True" xmlns="">Utility classes for tasks like data manipulation and reflection.</NamespaceSummaryItem>
|
|
||||||
<NamespaceSummaryItem name="Tests" isDocumented="True" xmlns="">Unit tests ensuring CapyKit functions as expected.</NamespaceSummaryItem>
|
|
||||||
<NamespaceSummaryItem name="Tests.Helpers" isDocumented="True" xmlns="">Contains unit tests specifically focused on verifying the correctness of the code in `CapyKit.Helpers`.</NamespaceSummaryItem></NamespaceSummaries>
|
|
||||||
</PropertyGroup>
|
|
||||||
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
|
|
||||||
the build. The others are optional common platform types that may appear. -->
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x64' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x64' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|Win32' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|Win32' ">
|
|
||||||
</PropertyGroup>
|
|
||||||
<ItemGroup>
|
|
||||||
<Folder Include="Content" />
|
|
||||||
<Folder Include="Content\VersionHistory" />
|
|
||||||
<Folder Include="icons" />
|
|
||||||
<Folder Include="media" />
|
|
||||||
</ItemGroup>
|
|
||||||
<ItemGroup>
|
|
||||||
<None Include="Content\VersionHistory\v1.0.0.0.aml" />
|
|
||||||
<None Include="Content\VersionHistory\VersionHistory.aml" />
|
|
||||||
<None Include="Content\Welcome.aml" />
|
|
||||||
</ItemGroup>
|
|
||||||
<ItemGroup>
|
|
||||||
<ContentLayout Include="ContentLayout.content" />
|
|
||||||
</ItemGroup>
|
|
||||||
<ItemGroup>
|
|
||||||
<Content Include="icons\Help.png" />
|
|
||||||
</ItemGroup>
|
|
||||||
<!-- Import the common build targets during NuGet restore because before the packages are being installed, $(SHFBROOT) is not set yet -->
|
|
||||||
<Import Project="$(MSBuildToolsPath)\Microsoft.Common.targets" Condition="'$(MSBuildRestoreSessionId)' != ''" />
|
|
||||||
<!-- Import the SHFB build targets during build -->
|
|
||||||
<Import Project="$(SHFBROOT)\SandcastleHelpFileBuilder.targets" Condition="'$(MSBuildRestoreSessionId)' == ''" />
|
|
||||||
<!-- The pre-build and post-build event properties must appear *after* the targets file import in order to be
|
|
||||||
evaluated correctly. -->
|
|
||||||
<PropertyGroup>
|
|
||||||
<PreBuildEvent>
|
|
||||||
</PreBuildEvent>
|
|
||||||
<PostBuildEvent>
|
|
||||||
</PostBuildEvent>
|
|
||||||
<RunPostBuildEvent>OnBuildSuccess</RunPostBuildEvent>
|
|
||||||
</PropertyGroup>
|
|
||||||
</Project>
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
# CapyKit - C# Utilities
|
|
||||||
|
|
||||||
Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. Originally born out of the *HappyCapy* project, CapyKit is now fully open for the community, offering a wide array of C# utilities and extensions.
|
|
||||||
|
|
||||||
Whether you're looking to integrate some handy extensions into your existing project or you're exploring what CapyKit can do for your next venture, you've come to the right place!
|
|
||||||
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
This documentation is generated directly from the source code and is constantly evolving as the project progresses. To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md).
|
|
||||||
|
|
||||||
If you're new to the project, bear with us while things are still transitioning from the private repository. We're working hard to make this resource the best it can be.
|
|
||||||
|
|
||||||
For a complete overview of the automatically generated documentation, start by exploring the [API and Utilities Reference](R_Project_Documentation.md)
|
|
||||||
|
|
@ -1,32 +0,0 @@
|
||||||
# uniqueIdentifiers Field
|
|
||||||
|
|
||||||
|
|
||||||
A hash set storing unique identifiers for events intended to only be emitted once.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private static HashSet<string> uniqueIdentifiers
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private uniqueIdentifiers: HashSet<string>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.hashset-1" target="_blank" rel="noopener noreferrer">HashSet</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
<a href="M_CapyKit_CapyEventReporter_EmitEventOnce.md">EmitEventOnce(EventLevel, String, String, String, Object[])</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# EARTH_RADIUS_KILOMETERS Field
|
|
||||||
|
|
||||||
|
|
||||||
The earth's radius in kilometers.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public const int EARTH_RADIUS_KILOMETERS = 6371
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable EARTH_RADIUS_KILOMETERS: int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# MILES_PER_KILOMETER Field
|
|
||||||
|
|
||||||
|
|
||||||
Ratio of miles per kilometer .
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public const double MILES_PER_KILOMETER = 0.621371
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable MILES_PER_KILOMETER: float
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# chars Field
|
|
||||||
|
|
||||||
|
|
||||||
The valid hexidecimal characters.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private const string chars = "0123456789ABCDEF"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private chars: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# encryptionKey Field
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "F:CapyKit.Helpers.EncryptionHelper.encryptionKey"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private string encryptionKey
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private encryptionKey: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# masterKeyAccessor Field
|
|
||||||
|
|
||||||
|
|
||||||
The master key accessor function.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private Func<byte[]> masterKeyAccessor
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private masterKeyAccessor: Func<byte[]>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.func-1" target="_blank" rel="noopener noreferrer">Func</a>(<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[])
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_KeyHelper.md">KeyHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# numPartsAccessor Field
|
|
||||||
|
|
||||||
|
|
||||||
Number of parts accessor function.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private Func<int> numPartsAccessor
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private numPartsAccessor: Func<int>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.func-1" target="_blank" rel="noopener noreferrer">Func</a>(<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_KeyHelper.md">KeyHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# saltSizeAccessor Field
|
|
||||||
|
|
||||||
|
|
||||||
The salt size accessor function.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private Func<int> saltSizeAccessor
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private saltSizeAccessor: Func<int>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.func-1" target="_blank" rel="noopener noreferrer">Func</a>(<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_KeyHelper.md">KeyHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# LOWER_CASE_CHARACTERS Field
|
|
||||||
|
|
||||||
|
|
||||||
A string of all the lower case characters.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
internal const string LOWER_CASE_CHARACTERS = "abcdefghijklmnopqrstuvwxyz"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable internal LOWER_CASE_CHARACTERS: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# NUMBER_CHARACTERS Field
|
|
||||||
|
|
||||||
|
|
||||||
A string of all the numeric characters.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
internal const string NUMBER_CHARACTERS = "0123456789"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable internal NUMBER_CHARACTERS: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# SALT_SIZE Field
|
|
||||||
|
|
||||||
|
|
||||||
Default size to use when generating a new salt.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private const int SALT_SIZE = 32
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private SALT_SIZE: int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# SPECIAL_CHARACTERS Field
|
|
||||||
|
|
||||||
|
|
||||||
A string of the most common non-alphanumeric characters.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
internal const string SPECIAL_CHARACTERS = "!@#$%&?+-_"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable internal SPECIAL_CHARACTERS: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# UPPER_CASE_CHARACTERS Field
|
|
||||||
|
|
||||||
|
|
||||||
A string of all the upper case characters.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
internal const string UPPER_CASE_CHARACTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable internal UPPER_CASE_CHARACTERS: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# accessor Field
|
|
||||||
|
|
||||||
|
|
||||||
Private delegate function that retrieves a setting with the given `key`.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private static Func<string, Object> accessor
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private accessor: Func<string, Object>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>, <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SettingsHelper.md">SettingsHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# detector Field
|
|
||||||
|
|
||||||
|
|
||||||
Private delegate function that detects if a setting with a given `key` exists. Returns true if the setting exists, false if not.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private static Func<string, bool> detector
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private detector: Func<string, bool>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>, <a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SettingsHelper.md">SettingsHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# pbkdf2Algorithm Field
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "F:CapyKit.Password.pbkdf2Algorithm"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private static Lazy<Pbkdf2Algorithm> pbkdf2Algorithm
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private pbkdf2Algorithm: Lazy<Pbkdf2Algorithm>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.lazy-1" target="_blank" rel="noopener noreferrer">Lazy</a>(<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Password.md">Password Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
# ITERATIONS Field
|
|
||||||
|
|
||||||
|
|
||||||
The default number of iterations.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public const int ITERATIONS = 100000
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable ITERATIONS: int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
This member is immutable.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
# LENGTH Field
|
|
||||||
|
|
||||||
|
|
||||||
(Immutable) The default length.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public const int LENGTH = 32
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable LENGTH: int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
This member is immutable.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# index Field
|
|
||||||
|
|
||||||
|
|
||||||
The zero-based index of the pooled item.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private readonly int index
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val private index: int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# item Field
|
|
||||||
|
|
||||||
|
|
||||||
The pooled item.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private readonly T item
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val private item: 'T
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="T_CapyKit_PoolItem_1.md">T</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# locked Field
|
|
||||||
|
|
||||||
|
|
||||||
A flag indicating whether the item is locked or not.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private bool locked
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private locked: bool
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# typeName Field
|
|
||||||
|
|
||||||
|
|
||||||
The name of the pooled item <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a>.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private readonly string typeName
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val private typeName: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# poolItemCollection Field
|
|
||||||
|
|
||||||
|
|
||||||
The collection of pooled items.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private readonly ConcurrentBag<PoolItem<T>> poolItemCollection
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val private poolItemCollection: ConcurrentBag<PoolItem<'T>>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.collections.concurrent.concurrentbag-1" target="_blank" rel="noopener noreferrer">ConcurrentBag</a>(<a href="T_CapyKit_PoolItem_1.md">PoolItem</a>(<a href="T_CapyKit_Pool_1.md">T</a>))
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# poolSize Field
|
|
||||||
|
|
||||||
|
|
||||||
(Immutable) The number of items in the pool.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private readonly int poolSize
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val private poolSize: int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# expression Field
|
|
||||||
|
|
||||||
|
|
||||||
The expression to retrieve the property.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private Func<T, U> expression
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private expression: Func<'T, 'U>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(<a href="T_CapyKit_PropertyComparer_2.md">T</a>, <a href="T_CapyKit_PropertyComparer_2.md">U</a>)
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# _keyHelper Field
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "F:Tests.Helpers.KeyHelperTests._keyHelper"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_Tests_Helpers.md">Tests.Helpers</a>
|
|
||||||
**Assembly:** Tests (in Tests.exe) Version: 1.0.0
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private KeyHelper _keyHelper
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
val mutable private _keyHelper: KeyHelper
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="T_CapyKit_Helpers_KeyHelper.md">KeyHelper</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_Helpers_KeyHelperTests.md">KeyHelperTests Class</a>
|
|
||||||
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# Password Field
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "F:Tests.Helpers.SecurityHelperTests.Password"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_Tests_Helpers.md">Tests.Helpers</a>
|
|
||||||
**Assembly:** Tests (in Tests.exe) Version: 1.0.0
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private const string Password = "TestPassword"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private Password: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_Helpers_SecurityHelperTests.md">SecurityHelperTests Class</a>
|
|
||||||
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# Salt Field
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "F:Tests.Helpers.SecurityHelperTests.Salt"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_Tests_Helpers.md">Tests.Helpers</a>
|
|
||||||
**Assembly:** Tests (in Tests.exe) Version: 1.0.0
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private static readonly byte[] Salt
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val private Salt: byte[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_Helpers_SecurityHelperTests.md">SecurityHelperTests Class</a>
|
|
||||||
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,31 +0,0 @@
|
||||||
# Replacement Field
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "F:Tests.StringExtensionTests.Replacement"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_Tests.md">Tests</a>
|
|
||||||
**Assembly:** Tests (in Tests.exe) Version: 1.0.0
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private const string Replacement = "Replaced"
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static val mutable private Replacement: string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Field Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_StringExtensionTests.md">StringExtensionTests Class</a>
|
|
||||||
<a href="N_Tests.md">Tests Namespace</a>
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# CapyEventReporter Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_CapyEventReporter_uniqueIdentifiers.md">uniqueIdentifiers</a></td>
|
|
||||||
<td>A hash set storing unique identifiers for events intended to only be emitted once.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
# CalculationHelper Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_CalculationHelper_chars.md">chars</a></td>
|
|
||||||
<td>The valid hexidecimal characters.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_CalculationHelper_EARTH_RADIUS_KILOMETERS.md">EARTH_RADIUS_KILOMETERS</a></td>
|
|
||||||
<td>The earth's radius in kilometers.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_CalculationHelper_MILES_PER_KILOMETER.md">MILES_PER_KILOMETER</a></td>
|
|
||||||
<td>Ratio of miles per kilometer .</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# EncryptionHelper Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_EncryptionHelper_encryptionKey.md">encryptionKey</a></td>
|
|
||||||
<td> </td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,24 +0,0 @@
|
||||||
# KeyHelper Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_KeyHelper_masterKeyAccessor.md">masterKeyAccessor</a></td>
|
|
||||||
<td>The master key accessor function.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_KeyHelper_numPartsAccessor.md">numPartsAccessor</a></td>
|
|
||||||
<td>Number of parts accessor function.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_KeyHelper_saltSizeAccessor.md">saltSizeAccessor</a></td>
|
|
||||||
<td>The salt size accessor function.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_KeyHelper.md">KeyHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,30 +0,0 @@
|
||||||
# SecurityHelper Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_LOWER_CASE_CHARACTERS.md">LOWER_CASE_CHARACTERS</a></td>
|
|
||||||
<td>A string of all the lower case characters.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_NUMBER_CHARACTERS.md">NUMBER_CHARACTERS</a></td>
|
|
||||||
<td>A string of all the numeric characters.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_SALT_SIZE.md">SALT_SIZE</a></td>
|
|
||||||
<td>Default size to use when generating a new salt.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_SPECIAL_CHARACTERS.md">SPECIAL_CHARACTERS</a></td>
|
|
||||||
<td>A string of the most common non-alphanumeric characters.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SecurityHelper_UPPER_CASE_CHARACTERS.md">UPPER_CASE_CHARACTERS</a></td>
|
|
||||||
<td>A string of all the upper case characters.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SecurityHelper.md">SecurityHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
# SettingsHelper Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SettingsHelper_accessor.md">accessor</a></td>
|
|
||||||
<td>Private delegate function that retrieves a setting with the given <code>key</code>.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Helpers_SettingsHelper_detector.md">detector</a></td>
|
|
||||||
<td>Private delegate function that detects if a setting with a given <code>key</code> exists. Returns true if the setting exists, false if not.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_SettingsHelper.md">SettingsHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# Password Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Password_pbkdf2Algorithm.md">pbkdf2Algorithm</a></td>
|
|
||||||
<td> </td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Password.md">Password Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
# Pbkdf2Algorithm Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Pbkdf2Algorithm_ITERATIONS.md">ITERATIONS</a></td>
|
|
||||||
<td>The default number of iterations.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Pbkdf2Algorithm_LENGTH.md">LENGTH</a></td>
|
|
||||||
<td>(Immutable) The default length.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Pbkdf2Algorithm.md">Pbkdf2Algorithm Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,27 +0,0 @@
|
||||||
# PoolItem<T> Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_PoolItem_1_index.md">index</a></td>
|
|
||||||
<td>The zero-based index of the pooled item.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_PoolItem_1_item.md">item</a></td>
|
|
||||||
<td>The pooled item.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_PoolItem_1_locked.md">locked</a></td>
|
|
||||||
<td>A flag indicating whether the item is locked or not.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_PoolItem_1_typeName.md">typeName</a></td>
|
|
||||||
<td>The name of the pooled item <a href="https://learn.microsoft.com/dotnet/api/system.type" target="_blank" rel="noopener noreferrer">Type</a>.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PoolItem_1.md">PoolItem(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
# Pool<T> Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Pool_1_poolItemCollection.md">poolItemCollection</a></td>
|
|
||||||
<td>The collection of pooled items.</td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_Pool_1_poolSize.md">poolSize</a></td>
|
|
||||||
<td>(Immutable) The number of items in the pool.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Pool_1.md">Pool(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# PropertyComparer<T, U> Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_CapyKit_PropertyComparer_2_expression.md">expression</a></td>
|
|
||||||
<td>The expression to retrieve the property.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_PropertyComparer_2.md">PropertyComparer(T, U) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# KeyHelperTests Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_Tests_Helpers_KeyHelperTests__keyHelper.md">_keyHelper</a></td>
|
|
||||||
<td> </td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_Helpers_KeyHelperTests.md">KeyHelperTests Class</a>
|
|
||||||
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,21 +0,0 @@
|
||||||
# SecurityHelperTests Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_Tests_Helpers_SecurityHelperTests_Password.md">Password</a></td>
|
|
||||||
<td> </td></tr>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_Tests_Helpers_SecurityHelperTests_Salt.md">Salt</a></td>
|
|
||||||
<td> </td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_Helpers_SecurityHelperTests.md">SecurityHelperTests Class</a>
|
|
||||||
<a href="N_Tests_Helpers.md">Tests.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
||||||
# StringExtensionTests Fields
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Fields
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="F_Tests_StringExtensionTests_Replacement.md">Replacement</a></td>
|
|
||||||
<td> </td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_Tests_StringExtensionTests.md">StringExtensionTests Class</a>
|
|
||||||
<a href="N_Tests.md">Tests Namespace</a>
|
|
||||||
|
|
@ -1,14 +0,0 @@
|
||||||
# CapyKit - C# Utilities
|
|
||||||
|
|
||||||
Welcome to the official documentation for CapyKit – your go-to utility kit for boosting productivity in any .NET project. Originally born out of the *HappyCapy* project, CapyKit is now fully open for the community, offering a wide array of C# utilities and extensions.
|
|
||||||
|
|
||||||
Whether you're looking to integrate some handy extensions into your existing project or you're exploring what CapyKit can do for your next venture, you've come to the right place!
|
|
||||||
|
|
||||||
|
|
||||||
## Getting Started
|
|
||||||
|
|
||||||
This documentation is generated directly from the source code and is constantly evolving as the project progresses. To dive in, check out the full reference material and guides in the [CapyKit Documentation](R_Project_Documentation.md).
|
|
||||||
|
|
||||||
If you're new to the project, bear with us while things are still transitioning from the private repository. We're working hard to make this resource the best it can be.
|
|
||||||
|
|
||||||
For a complete overview of the automatically generated documentation, start by exploring the [API and Utilities Reference](R_Project_Documentation.md)
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
# EnumerationAttribute<T> Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Gets the value of the enumeration represented by this attribute.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
protected EnumerationAttribute(
|
|
||||||
T value
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new :
|
|
||||||
value : 'T -> EnumerationAttribute
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_Attributes_EnumerationAttribute_1.md">T</a></dt><dd>Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationAttribute_1.md">EnumerationAttribute(T)</a> class with a specified value.</dd></dl>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Attributes_EnumerationAttribute_1.md">EnumerationAttribute(T) Class</a>
|
|
||||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
# EnumerationDescriptionAttribute Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Initializes a new instance of the <a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute.md">EnumerationDescriptionAttribute</a> class with the specified description.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public EnumerationDescriptionAttribute(
|
|
||||||
string description
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new :
|
|
||||||
description : string -> EnumerationDescriptionAttribute
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The description of the enumeration value.</dd></dl>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Attributes_EnumerationDescriptionAttribute.md">EnumerationDescriptionAttribute Class</a>
|
|
||||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
# GetFormatParameterizedString Method
|
|
||||||
|
|
||||||
|
|
||||||
Gets a parameterized formatted string for the specified index.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public string GetFormatParameterizedString(
|
|
||||||
int index = 0
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
member GetFormatParameterizedString :
|
|
||||||
?index : int
|
|
||||||
(* Defaults:
|
|
||||||
let _index = defaultArg index 0
|
|
||||||
*)
|
|
||||||
-> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a> (Optional)</dt><dd>(Optional) Zero-based index of the item in the string to format.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
A formatted string with the specified index and format.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
|
||||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
|
||||||
|
|
@ -1,29 +0,0 @@
|
||||||
# ValueFormatAttribute Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Default constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a> class with an empty format string.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public ValueFormatAttribute()
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new : unit -> ValueFormatAttribute
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
|
||||||
<a href="Overload_CapyKit_Attributes_ValueFormatAttribute__ctor.md">ValueFormatAttribute Overload</a>
|
|
||||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
|
||||||
|
|
@ -1,35 +0,0 @@
|
||||||
# ValueFormatAttribute(String) Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Constructor. Initializes a new instance of the <a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute</a> class with the specified format string.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Attributes.md">CapyKit.Attributes</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public ValueFormatAttribute(
|
|
||||||
string format
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new :
|
|
||||||
format : string -> ValueFormatAttribute
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The format string used to format the value.</dd></dl>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Attributes_ValueFormatAttribute.md">ValueFormatAttribute Class</a>
|
|
||||||
<a href="Overload_CapyKit_Attributes_ValueFormatAttribute__ctor.md">ValueFormatAttribute Overload</a>
|
|
||||||
<a href="N_CapyKit_Attributes.md">CapyKit.Attributes Namespace</a>
|
|
||||||
|
|
@ -1,42 +0,0 @@
|
||||||
# CapyEventArgs Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Initializes a new instance of the CapyEventArgs class with the specified event level, message, and method name.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public CapyEventArgs(
|
|
||||||
EventLevel level,
|
|
||||||
string message,
|
|
||||||
string method = null
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new :
|
|
||||||
level : EventLevel *
|
|
||||||
message : string *
|
|
||||||
?method : string
|
|
||||||
(* Defaults:
|
|
||||||
let _method = defaultArg method null
|
|
||||||
*)
|
|
||||||
-> CapyEventArgs
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>A descriptive message explaining the reason for the event.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> (Optional)</dt><dd>The name of the method where the event was raised.</dd></dl>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventArgs.md">CapyEventArgs Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
# EmitEvent Method
|
|
||||||
|
|
||||||
|
|
||||||
Emits an event with the given severity level, message, and method name.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static void EmitEvent(
|
|
||||||
EventLevel eventLevel,
|
|
||||||
string message,
|
|
||||||
string method = null,
|
|
||||||
params Object[] args
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member EmitEvent :
|
|
||||||
eventLevel : EventLevel *
|
|
||||||
message : string *
|
|
||||||
?method : string *
|
|
||||||
args : Object[]
|
|
||||||
(* Defaults:
|
|
||||||
let _method = defaultArg method null
|
|
||||||
*)
|
|
||||||
-> unit
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The message describing the reason for the event. String formatting for <em>args</em> is accepted.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> (Optional)</dt><dd>(Optional) The name of the method where the event was raised.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>A variable-length parameters list containing arguments for formatting the message.</dd></dl>
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
In order to allow for efficient calling member access via <a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute" target="_blank" rel="noopener noreferrer">CallerMemberNameAttribute</a> , it is suggested that *args* is defined explicitly for formatted messages.
|
|
||||||
|
|
||||||
## Example
|
|
||||||
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
CapyEventReporter.EmitEvent(EventLevel.Error, "Could not find the description for {0}.", args: new[] { enumeration });
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute" target="_blank" rel="noopener noreferrer">CallerMemberNameAttribute</a>
|
|
||||||
|
|
@ -1,51 +0,0 @@
|
||||||
# EmitEventOnce Method
|
|
||||||
|
|
||||||
|
|
||||||
Emits an event with the given severity level, message, unique identifier, and method name one time.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static void EmitEventOnce(
|
|
||||||
EventLevel eventLevel,
|
|
||||||
string message,
|
|
||||||
string uniqueIdentifier,
|
|
||||||
string method = null,
|
|
||||||
params Object[] args
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member EmitEventOnce :
|
|
||||||
eventLevel : EventLevel *
|
|
||||||
message : string *
|
|
||||||
uniqueIdentifier : string *
|
|
||||||
?method : string *
|
|
||||||
args : Object[]
|
|
||||||
(* Defaults:
|
|
||||||
let _method = defaultArg method null
|
|
||||||
*)
|
|
||||||
-> unit
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The message describing the reason for the event. String formatting for <em>args</em> is accepted.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>A unique identifier for the event emission.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> (Optional)</dt><dd>(Optional) The name of the method where the event was raised.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>A variable-length parameters list containing arguments for formatting the message.</dd></dl>
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
This method is similar to [!:EmitEvent(EventLevel, string, string, string, object[])] , but requires a unique identifier (such as a <a href="https://learn.microsoft.com/dotnet/api/system.guid" target="_blank" rel="noopener noreferrer">Guid</a>) to prevent duplicate emissions.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.runtime.compilerservices.callermembernameattribute" target="_blank" rel="noopener noreferrer">CallerMemberNameAttribute</a>
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.guid" target="_blank" rel="noopener noreferrer">Guid</a>
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
# Subscribe Method
|
|
||||||
|
|
||||||
|
|
||||||
Subscribes the specified event handler to the event with the given subscription level and origin.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static void Subscribe(
|
|
||||||
CapyEventHandler callback,
|
|
||||||
EventLevel subscriptionLevel,
|
|
||||||
string origin = null
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member Subscribe :
|
|
||||||
callback : CapyEventHandler *
|
|
||||||
subscriptionLevel : EventLevel *
|
|
||||||
?origin : string
|
|
||||||
(* Defaults:
|
|
||||||
let _origin = defaultArg origin null
|
|
||||||
*)
|
|
||||||
-> unit
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_CapyEventHandler.md">CapyEventHandler</a></dt><dd>The event handler to subscribe.</dd><dt> <a href="T_CapyKit_EventLevel.md">EventLevel</a></dt><dd>The severity level of the event to subscribe to.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a> (Optional)</dt><dd>(Optional) The name of the method or class where the subscription is made.</dd></dl>
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
If there is no existing list for the given subscription level, a new list is created and added to the dictionary.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,36 +0,0 @@
|
||||||
# Unsubscribe Method
|
|
||||||
|
|
||||||
|
|
||||||
Unsubscribes the specified event handler from the event with the given origin.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static void Unsubscribe(
|
|
||||||
CapyEventHandler callback,
|
|
||||||
string origin
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member Unsubscribe :
|
|
||||||
callback : CapyEventHandler *
|
|
||||||
origin : string -> unit
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_CapyEventHandler.md">CapyEventHandler</a></dt><dd>The event handler to unsubscribe.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The name of the method or class where the subscription was made.</dd></dl>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
# CapyEventReporter Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Initializes the static fields of the <a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter</a> class
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
static CapyEventReporter()
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new : unit -> CapyEventReporter
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_CapyEventReporter.md">CapyEventReporter Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
# Color Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Initializes a new instance of the <a href="T_CapyKit_Color.md">Color</a> class
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public Color()
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new : unit -> Color
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Color.md">Color Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,28 +0,0 @@
|
||||||
# EncryptedValue<T> Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Initializes a new instance of the <a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T)</a> class
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit.md">CapyKit</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public EncryptedValue()
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new : unit -> EncryptedValue
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue(T) Class</a>
|
|
||||||
<a href="N_CapyKit.md">CapyKit Namespace</a>
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
# GetDescription Method
|
|
||||||
|
|
||||||
|
|
||||||
An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a description.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string GetDescription(
|
|
||||||
this Enum enumeration
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member GetDescription :
|
|
||||||
enumeration : Enum -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a></dt><dd>The enumeration to act on.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
The description if available, otherwise the string representation of the enumeration.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
# GetName Method
|
|
||||||
|
|
||||||
|
|
||||||
An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a name.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string GetName(
|
|
||||||
this Enum enumeration
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member GetName :
|
|
||||||
enumeration : Enum -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a></dt><dd>The enumeration to act on.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
The name of the enumeration.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
# GetPrettyName Method
|
|
||||||
|
|
||||||
|
|
||||||
An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a human readable name.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string GetPrettyName(
|
|
||||||
this Enum enumeration
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member GetPrettyName :
|
|
||||||
enumeration : Enum -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a></dt><dd>The enumeration to act on.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
The human readable name of the enumeration.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,46 +0,0 @@
|
||||||
# GetValue Method
|
|
||||||
|
|
||||||
|
|
||||||
An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets an integer value representing the enumation.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static int GetValue(
|
|
||||||
this Enum enumeration
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member GetValue :
|
|
||||||
enumeration : Enum -> int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a></dt><dd>The enumeration to act on.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
The integer value of the enumeration.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,54 +0,0 @@
|
||||||
# Parse<T>(T, String) Method
|
|
||||||
|
|
||||||
|
|
||||||
A *T* extension method that parses a string into an enumeration.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static T Parse<T>(
|
|
||||||
this T enumeration,
|
|
||||||
string value
|
|
||||||
)
|
|
||||||
where T : Enum
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Parse :
|
|
||||||
enumeration : 'T *
|
|
||||||
value : string -> 'T when 'T : Enum
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> T</dt><dd>The enumeration to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The value.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
T
|
|
||||||
A T.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md">Parse Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,56 +0,0 @@
|
||||||
# Parse<T>(T, String, Boolean) Method
|
|
||||||
|
|
||||||
|
|
||||||
A *T* extension method that parses a string into an enumeration.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static T Parse<T>(
|
|
||||||
this T enumeration,
|
|
||||||
string value,
|
|
||||||
bool ignoreCase
|
|
||||||
)
|
|
||||||
where T : Enum
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Parse :
|
|
||||||
enumeration : 'T *
|
|
||||||
value : string *
|
|
||||||
ignoreCase : bool -> 'T when 'T : Enum
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> T</dt><dd>The enumeration to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The string value of the <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a>.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a></dt><dd>True to ignore case.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
T
|
|
||||||
A T.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_EnumerationExtensions_Parse.md">Parse Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,52 +0,0 @@
|
||||||
# Distinct<T, U> Method
|
|
||||||
|
|
||||||
|
|
||||||
Enumerates distinct items in this collection as defined by the key *property*.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static IEnumerable<T> Distinct<T, U>(
|
|
||||||
this IEnumerable<T> items,
|
|
||||||
Func<T, U> property
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Distinct :
|
|
||||||
items : IEnumerable<'T> *
|
|
||||||
property : Func<'T, 'U> -> IEnumerable<'T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)</dt><dd>The items to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, U)</dt><dd>The property.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter of the parent object.</dd><dt /><dd>Generic type parameter property value.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)
|
|
||||||
An enumerator that allows foreach to be used to process distinct items in this collection.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,53 +0,0 @@
|
||||||
# Filter<T>(IEnumerable<T>, Func<T, Boolean>) Method
|
|
||||||
|
|
||||||
|
|
||||||
Filters out items matching a *predicate* from the collection.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static IEnumerable<T> Filter<T>(
|
|
||||||
this IEnumerable<T> source,
|
|
||||||
Func<T, bool> predicate
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Filter :
|
|
||||||
source : IEnumerable<'T> *
|
|
||||||
predicate : Func<'T, bool> -> IEnumerable<'T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, <a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>)</dt><dd>The predicate.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)
|
|
||||||
An enumerator that allows foreach to be used to process remove in this collection.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_Filter.md">Filter Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,53 +0,0 @@
|
||||||
# Filter<T>(IQueryable<T>, Expression<Func<T, Boolean>>) Method
|
|
||||||
|
|
||||||
|
|
||||||
Filters out items matching a *predicate* from the collection.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static IQueryable<T> Filter<T>(
|
|
||||||
this IQueryable<T> source,
|
|
||||||
Expression<Func<T, bool>> predicate
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Filter :
|
|
||||||
source : IQueryable<'T> *
|
|
||||||
predicate : Expression<Func<'T, bool>> -> IQueryable<'T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, <a href="https://learn.microsoft.com/dotnet/api/system.boolean" target="_blank" rel="noopener noreferrer">Boolean</a>))</dt><dd>The predicate.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)
|
|
||||||
An enumerator that allows foreach to be used to process remove in this collection.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_Filter.md">Filter Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# LeftOuterJoin<T, U, TKey, R>(IEnumerable<T>, IEnumerable<U>, Func<T, TKey>, Func<U, TKey>, Func<T, IEnumerable<U>, R>, Func<T, U>) Method
|
|
||||||
|
|
||||||
|
|
||||||
An IEnumable<T> extension method that left outer join.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
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
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member LeftOuterJoin :
|
|
||||||
source : IEnumerable<'T> *
|
|
||||||
inner : IEnumerable<'U> *
|
|
||||||
outerSelector : Func<'T, 'TKey> *
|
|
||||||
innerSelector : Func<'U, 'TKey> *
|
|
||||||
resultSelector : Func<'T, IEnumerable<'U>, 'R> *
|
|
||||||
?defaultGenerator : Func<'T, 'U>
|
|
||||||
(* Defaults:
|
|
||||||
let _defaultGenerator = defaultArg defaultGenerator null
|
|
||||||
*)
|
|
||||||
-> IEnumerable<'R>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(U)</dt><dd>The inner.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, TKey)</dt><dd>The outer selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(U, TKey)</dt><dd>The inner selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-3" target="_blank" rel="noopener noreferrer">Func</a>(T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(U), R)</dt><dd>The result selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, U) (Optional)</dt><dd>(Optional) The default generator.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd><dt /><dd>Generic type parameter.</dd><dt /><dd>Type of the key.</dd><dt /><dd>Type of the r.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(R)
|
|
||||||
An enumerator that allows foreach to be used to process left outter join in this collection.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md">LeftOuterJoin Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# 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>) Method
|
|
||||||
|
|
||||||
|
|
||||||
An IQueryable<T> extension method that left outer join.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
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
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member LeftOuterJoin :
|
|
||||||
source : IQueryable<'T> *
|
|
||||||
inner : IQueryable<'U> *
|
|
||||||
outerSelector : Expression<Func<'T, 'TKey>> *
|
|
||||||
innerSelector : Expression<Func<'U, 'TKey>> *
|
|
||||||
resultSelector : Func<'T, IEnumerable<'U>, 'R> *
|
|
||||||
?defaultGenerator : Func<'T, 'U>
|
|
||||||
(* Defaults:
|
|
||||||
let _defaultGenerator = defaultArg defaultGenerator null
|
|
||||||
*)
|
|
||||||
-> IQueryable<'R>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(U)</dt><dd>The inner.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, TKey))</dt><dd>The outer selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(U, TKey))</dt><dd>The inner selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-3" target="_blank" rel="noopener noreferrer">Func</a>(T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(U), R)</dt><dd>The result selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, U) (Optional)</dt><dd>(Optional) The default generator.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd><dt /><dd>Generic type parameter.</dd><dt /><dd>Type of the key.</dd><dt /><dd>Type of the r.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(R)
|
|
||||||
An IQueryable<R>
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md">LeftOuterJoin Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,59 +0,0 @@
|
||||||
# LeftOuterJoin<T, U, TKey, R>(IQueryable<T>, IQueryable<U>, Expression<Func<T, TKey>>, Expression<Func<U, TKey>>, Expression<Func<T, IEnumerable<U>, R>>) Method
|
|
||||||
|
|
||||||
|
|
||||||
An IQueryable<T> extension method that left outer join.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
private 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,
|
|
||||||
Expression<Func<T, IEnumerable<U>, R>> resultSelector
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
private static member LeftOuterJoin :
|
|
||||||
source : IQueryable<'T> *
|
|
||||||
inner : IQueryable<'U> *
|
|
||||||
outerSelector : Expression<Func<'T, 'TKey>> *
|
|
||||||
innerSelector : Expression<Func<'U, 'TKey>> *
|
|
||||||
resultSelector : Expression<Func<'T, IEnumerable<'U>, 'R>> -> IQueryable<'R>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(U)</dt><dd>The inner.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(T, TKey))</dt><dd>The outer selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-2" target="_blank" rel="noopener noreferrer">Func</a>(U, TKey))</dt><dd>The inner selector.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.expressions.expression-1" target="_blank" rel="noopener noreferrer">Expression</a>(<a href="https://learn.microsoft.com/dotnet/api/system.func-3" target="_blank" rel="noopener noreferrer">Func</a>(T, <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(U), R))</dt><dd>The result selector.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd><dt /><dd>Generic type parameter.</dd><dt /><dd>Type of the key.</dd><dt /><dd>Type of the r.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(R)
|
|
||||||
An IQueryable<R>
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_LeftOuterJoin.md">LeftOuterJoin Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
# PageCount<T>(IEnumerable<T>, Int32) Method
|
|
||||||
|
|
||||||
|
|
||||||
The number of pages of *pageSize* size in the given collection.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static int PageCount<T>(
|
|
||||||
this IEnumerable<T> source,
|
|
||||||
int pageSize
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member PageCount :
|
|
||||||
source : IEnumerable<'T> *
|
|
||||||
pageSize : int -> int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>Size of the page.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
An int.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## Exceptions
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception" target="_blank" rel="noopener noreferrer">ArgumentOutOfRangeException</a></td>
|
|
||||||
<td>Thrown when <em>pageSize</em> is less than <code>1</code>.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount.md">PageCount Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,60 +0,0 @@
|
||||||
# PageCount<T>(IQueryable<T>, Int32) Method
|
|
||||||
|
|
||||||
|
|
||||||
The number of pages of *pageSize* size in the given collection.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static int PageCount<T>(
|
|
||||||
this IQueryable<T> source,
|
|
||||||
int pageSize
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member PageCount :
|
|
||||||
source : IQueryable<'T> *
|
|
||||||
pageSize : int -> int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>Size of the page.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
An int.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## Exceptions
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception" target="_blank" rel="noopener noreferrer">ArgumentOutOfRangeException</a></td>
|
|
||||||
<td>Thrown when <em>pageSize</em> is less than <code>1</code>.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_PageCount.md">PageCount Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# Page<T>(IEnumerable<T>, Int32, Int32) Method
|
|
||||||
|
|
||||||
|
|
||||||
Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* items per page.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static IEnumerable<T> Page<T>(
|
|
||||||
this IEnumerable<T> source,
|
|
||||||
int pageNumber,
|
|
||||||
int pageSize
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Page :
|
|
||||||
source : IEnumerable<'T> *
|
|
||||||
pageNumber : int *
|
|
||||||
pageSize : int -> IEnumerable<'T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The page number to retrieve.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>Number of items per page.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T)
|
|
||||||
An enumerator that allows foreach to be used to process page in this collection.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ienumerable-1" target="_blank" rel="noopener noreferrer">IEnumerable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
This method uses natural numbering starting at page 1.
|
|
||||||
|
|
||||||
## Exceptions
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception" target="_blank" rel="noopener noreferrer">ArgumentOutOfRangeException</a></td>
|
|
||||||
<td>Thrown when <em>pageNumber</em> is less than <code>1</code> or if <em>pageSize</em> is less than <code>1</code>.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_Page.md">Page Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,65 +0,0 @@
|
||||||
# Page<T>(IQueryable<T>, Int32, Int32) Method
|
|
||||||
|
|
||||||
|
|
||||||
Get a page of items from a collection, skipping *pageNumber* pages of *pageSize* items per page.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static IQueryable<T> Page<T>(
|
|
||||||
this IQueryable<T> source,
|
|
||||||
int pageNumber,
|
|
||||||
int pageSize
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member Page :
|
|
||||||
source : IQueryable<'T> *
|
|
||||||
pageNumber : int *
|
|
||||||
pageSize : int -> IQueryable<'T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)</dt><dd>The source to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>The page number to retrieve.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a></dt><dd>.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T)
|
|
||||||
An enumerator that allows foreach to be used to process page in this collection.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.linq.iqueryable-1" target="_blank" rel="noopener noreferrer">IQueryable</a>(T). When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## Remarks
|
|
||||||
This method uses natural numbering starting at page 1.
|
|
||||||
|
|
||||||
## Exceptions
|
|
||||||
<table>
|
|
||||||
<tr>
|
|
||||||
<td><a href="https://learn.microsoft.com/dotnet/api/system.argumentoutofrangeexception" target="_blank" rel="noopener noreferrer">ArgumentOutOfRangeException</a></td>
|
|
||||||
<td>Thrown when <em>pageNumber</em> is less than <code>1</code> or if <em>pageSize</em> is less than <code>1</code>.</td></tr>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_LINQExtensions.md">LINQExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_LINQExtensions_Page.md">Page Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,45 +0,0 @@
|
||||||
# UpdateProperties(Object, Object) Method
|
|
||||||
|
|
||||||
|
|
||||||
An object extension method that updates the properties of a given *target* object with the values from a given *source* object.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static void UpdateProperties(
|
|
||||||
this Object target,
|
|
||||||
Object source
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member UpdateProperties :
|
|
||||||
target : Object *
|
|
||||||
source : Object -> unit
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>The target object to act on.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>Source for the new property values.</dd></dl>
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_ObjectExtensions.md">ObjectExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_ObjectExtensions_UpdateProperties.md">UpdateProperties Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
# UpdateProperties<T>(T, T) Method
|
|
||||||
|
|
||||||
|
|
||||||
An object extension method that updates the properties of a given *target* object with the values from a given *source* object.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static void UpdateProperties<T>(
|
|
||||||
this T target,
|
|
||||||
T source
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member UpdateProperties :
|
|
||||||
target : 'T *
|
|
||||||
source : 'T -> unit
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> T</dt><dd>The target object to act on.</dd><dt> T</dt><dd>Source for the new property values.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type T. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_ObjectExtensions.md">ObjectExtensions Class</a>
|
|
||||||
<a href="Overload_CapyKit_Extensions_ObjectExtensions_UpdateProperties.md">UpdateProperties Overload</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
# IfNullOrEmpty Method
|
|
||||||
|
|
||||||
|
|
||||||
Replaces a null or empty string with a specified replacement string.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string IfNullOrEmpty(
|
|
||||||
this string value,
|
|
||||||
string replacement
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member IfNullOrEmpty :
|
|
||||||
value : string *
|
|
||||||
replacement : string -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The original string.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The replacement string.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
The original string if not null or empty, otherwise the replacement string.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_StringExtensions.md">StringExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorempty" target="_blank" rel="noopener noreferrer">IsNullOrEmpty(String)</a>
|
|
||||||
|
|
@ -1,49 +0,0 @@
|
||||||
# IfNullOrWhiteSpace Method
|
|
||||||
|
|
||||||
|
|
||||||
Replaces a null or whitespace string with a specified replacement string.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string IfNullOrWhiteSpace(
|
|
||||||
this string value,
|
|
||||||
string replacement
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
[<ExtensionAttribute>]
|
|
||||||
static member IfNullOrWhiteSpace :
|
|
||||||
value : string *
|
|
||||||
replacement : string -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The original string.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The replacement string.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
The original string if not null or whitespace, otherwise the replacement string.
|
|
||||||
|
|
||||||
#### Usage Note
|
|
||||||
In Visual Basic and C#, you can call this method as an instance method on any object of type <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
|
||||||
|
|
||||||
Extension Methods (C# Programming Guide)</a>.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Extensions_StringExtensions.md">StringExtensions Class</a>
|
|
||||||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string.isnullorwhitespace" target="_blank" rel="noopener noreferrer">IsNullOrWhiteSpace(String)</a>
|
|
||||||
|
|
@ -1,41 +0,0 @@
|
||||||
# CalculateHash Method
|
|
||||||
|
|
||||||
|
|
||||||
Calculates the hash of a given string using an <a href="https://learn.microsoft.com/dotnet/api/system.security.cryptography.md5" target="_blank" rel="noopener noreferrer">MD5</a> value as the first 32 bits.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static int CalculateHash(
|
|
||||||
string str
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member CalculateHash :
|
|
||||||
str : string -> int
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The string to be hashed.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.int32" target="_blank" rel="noopener noreferrer">Int32</a>
|
|
||||||
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.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# CalculateHexHash Method
|
|
||||||
|
|
||||||
|
|
||||||
Calculates the hexadecimal hash.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string CalculateHexHash(
|
|
||||||
string str
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member CalculateHexHash :
|
|
||||||
str : string -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The string to be hashed.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
The calculated 16 character hexadecimal hash.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# DegreesToRadians Method
|
|
||||||
|
|
||||||
|
|
||||||
Convers degrees to radians.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static double DegreesToRadians(
|
|
||||||
double degrees
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member DegreesToRadians :
|
|
||||||
degrees : float -> float
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The degree value.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a>
|
|
||||||
The value as radians.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,57 +0,0 @@
|
||||||
# GetDistance(Decimal, Decimal, Decimal, Decimal, MeasurementSystem) Method
|
|
||||||
|
|
||||||
|
|
||||||
Gets the distance between two points on earth using the `haversine` formula.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static decimal GetDistance(
|
|
||||||
decimal latitudeOrigin,
|
|
||||||
decimal longitudeOrigin,
|
|
||||||
decimal latitudeDestination,
|
|
||||||
decimal longitudeDestination,
|
|
||||||
MeasurementSystem measurementSystem = MeasurementSystem.Imperial
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member GetDistance :
|
|
||||||
latitudeOrigin : decimal *
|
|
||||||
longitudeOrigin : decimal *
|
|
||||||
latitudeDestination : decimal *
|
|
||||||
longitudeDestination : decimal *
|
|
||||||
?measurementSystem : MeasurementSystem
|
|
||||||
(* Defaults:
|
|
||||||
let _measurementSystem = defaultArg measurementSystem MeasurementSystem.Imperial
|
|
||||||
*)
|
|
||||||
-> decimal
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The latitude origin.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The longitude origin.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The latitude destination.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a></dt><dd>The longitude destination.</dd><dt> <a href="T_CapyKit_Enumerations_MeasurementSystem.md">MeasurementSystem</a> (Optional)</dt><dd>(Optional) The measurement system.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.decimal" target="_blank" rel="noopener noreferrer">Decimal</a>
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="Overload_CapyKit_Helpers_CalculationHelper_GetDistance.md">GetDistance Overload</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
<a href="M_CapyKit_Helpers_CalculationHelper_GetDistance_1.md">GetDistance(Double, Double, Double, Double, MeasurementSystem)</a>
|
|
||||||
|
|
@ -1,56 +0,0 @@
|
||||||
# GetDistance(Double, Double, Double, Double, MeasurementSystem) Method
|
|
||||||
|
|
||||||
|
|
||||||
Gets the distance between two points on earth using the `haversine` formula.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static double GetDistance(
|
|
||||||
double latitudeOrigin,
|
|
||||||
double longitudeOrigin,
|
|
||||||
double latitudeDestination,
|
|
||||||
double longitudeDestination,
|
|
||||||
MeasurementSystem measurementSystem = MeasurementSystem.Imperial
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member GetDistance :
|
|
||||||
latitudeOrigin : float *
|
|
||||||
longitudeOrigin : float *
|
|
||||||
latitudeDestination : float *
|
|
||||||
longitudeDestination : float *
|
|
||||||
?measurementSystem : MeasurementSystem
|
|
||||||
(* Defaults:
|
|
||||||
let _measurementSystem = defaultArg measurementSystem MeasurementSystem.Imperial
|
|
||||||
*)
|
|
||||||
-> float
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The latitude of the origin.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The longitude of the origin.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The latitude destination.</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The longitude destination.</dd><dt> <a href="T_CapyKit_Enumerations_MeasurementSystem.md">MeasurementSystem</a> (Optional)</dt><dd>(Optional) The measurement system.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a>
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="Overload_CapyKit_Helpers_CalculationHelper_GetDistance.md">GetDistance Overload</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# KilometersToMiles Method
|
|
||||||
|
|
||||||
|
|
||||||
Converts kilometers to miles.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static double KilometersToMiles(
|
|
||||||
double kilometers
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member KilometersToMiles :
|
|
||||||
kilometers : float -> float
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The value in kilometers.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a>
|
|
||||||
The value in miles.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# MilesToKilometers Method
|
|
||||||
|
|
||||||
|
|
||||||
Converts miles to kilometers.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static double MilesToKilometers(
|
|
||||||
double miles
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member MilesToKilometers :
|
|
||||||
miles : float -> float
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The value in miles.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a>
|
|
||||||
The value in kilometers.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# RadiansToDegrees Method
|
|
||||||
|
|
||||||
|
|
||||||
Converts radians to degrees.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static double RadiansToDegrees(
|
|
||||||
double radians
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member RadiansToDegrees :
|
|
||||||
radians : float -> float
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a></dt><dd>The radian value.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.double" target="_blank" rel="noopener noreferrer">Double</a>
|
|
||||||
The value as degrees.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CalculationHelper.md">CalculationHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# Compress Method
|
|
||||||
|
|
||||||
|
|
||||||
Compresses a given object using the `gzip` algorithm.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static byte[] Compress(
|
|
||||||
Object obj
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member Compress :
|
|
||||||
obj : Object -> byte[]
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>The object.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]
|
|
||||||
A byte array representing the compressed object in `gzip` format.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# CompressToString Method
|
|
||||||
|
|
||||||
|
|
||||||
Compresses a given object to a string using `base64` encoding of `gzip` format.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string CompressToString(
|
|
||||||
Object obj
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member CompressToString :
|
|
||||||
obj : Object -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>The object.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
A string in `base64` encoding.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,38 +0,0 @@
|
||||||
# DecompressToString Method
|
|
||||||
|
|
||||||
|
|
||||||
Decompresses the given `base64` string in `gzip` format.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static string DecompressToString(
|
|
||||||
string compressed
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member DecompressToString :
|
|
||||||
compressed : string -> string
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The compressed string.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
|
||||||
A decomressed string.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,43 +0,0 @@
|
||||||
# Decompress<T>(Byte[]) Method
|
|
||||||
|
|
||||||
|
|
||||||
Decompresses a given compressed `gzip` byte stream.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static T Decompress<T>(
|
|
||||||
byte[] byteStream
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member Decompress :
|
|
||||||
byteStream : byte[] -> 'T
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.byte" target="_blank" rel="noopener noreferrer">Byte</a>[]</dt><dd>The compressed byte stream.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
T
|
|
||||||
A *T* typed object.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
|
|
||||||
<a href="Overload_CapyKit_Helpers_CompressionHelper_Decompress.md">Decompress Overload</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,43 +0,0 @@
|
||||||
# Decompress<T>(String) Method
|
|
||||||
|
|
||||||
|
|
||||||
Decompresses a given `base64` encoded string of `gzip` format.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public static T Decompress<T>(
|
|
||||||
string encodedString
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
static member Decompress :
|
|
||||||
encodedString : string -> 'T
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>The <code>base64</code> encoded <code>gzip</code> string.</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>Generic type parameter.</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
T
|
|
||||||
A *T* typed object.
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_CompressionHelper.md">CompressionHelper Class</a>
|
|
||||||
<a href="Overload_CapyKit_Helpers_CompressionHelper_Decompress.md">Decompress Overload</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,34 +0,0 @@
|
||||||
# EncryptionHelper Constructor
|
|
||||||
|
|
||||||
|
|
||||||
Initializes a new instance of the <a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper</a> class
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
public EncryptionHelper(
|
|
||||||
string encryptionKey
|
|
||||||
)
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
new :
|
|
||||||
encryptionKey : string -> EncryptionHelper
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a></dt><dd>\[Missing <param name="encryptionKey"/> documentation for "M:CapyKit.Helpers.EncryptionHelper.#ctor(System.String)"\]</dd></dl>
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_EncryptionHelper.md">EncryptionHelper Class</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,44 +0,0 @@
|
||||||
# Decrypt<T> Method
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
T Decrypt<T>(
|
|
||||||
EncryptedValue<T> encryptedValue,
|
|
||||||
params Object[] args
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
abstract Decrypt :
|
|
||||||
encryptedValue : EncryptedValue<'T> *
|
|
||||||
args : Object[] -> 'T
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue</a>(T)</dt><dd>\[Missing <param name="encryptedValue"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>\[Missing <param name="args"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>\[Missing <typeparam name="T"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
T
|
|
||||||
\[Missing <returns> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Decrypt``1(CapyKit.EncryptedValue{``0},System.Object[])"\]
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
|
|
@ -1,44 +0,0 @@
|
||||||
# Encrypt<T> Method
|
|
||||||
|
|
||||||
|
|
||||||
\[Missing <summary> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Definition
|
|
||||||
**Namespace:** <a href="N_CapyKit_Helpers.md">CapyKit.Helpers</a>
|
|
||||||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.4
|
|
||||||
|
|
||||||
**C#**
|
|
||||||
``` C#
|
|
||||||
EncryptedValue<T> Encrypt<T>(
|
|
||||||
Object obj,
|
|
||||||
params Object[] args
|
|
||||||
)
|
|
||||||
|
|
||||||
```
|
|
||||||
**F#**
|
|
||||||
``` F#
|
|
||||||
abstract Encrypt :
|
|
||||||
obj : Object *
|
|
||||||
args : Object[] -> EncryptedValue<'T>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
#### Parameters
|
|
||||||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a></dt><dd>\[Missing <param name="obj"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]</dd><dt> <a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a>[]</dt><dd>\[Missing <param name="args"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]</dd></dl>
|
|
||||||
|
|
||||||
#### Type Parameters
|
|
||||||
<dl><dt /><dd>\[Missing <typeparam name="T"/> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]</dd></dl>
|
|
||||||
|
|
||||||
#### Return Value
|
|
||||||
<a href="T_CapyKit_EncryptedValue_1.md">EncryptedValue</a>(T)
|
|
||||||
\[Missing <returns> documentation for "M:CapyKit.Helpers.IEncryptionAlgorithm.Encrypt``1(System.Object,System.Object[])"\]
|
|
||||||
|
|
||||||
## See Also
|
|
||||||
|
|
||||||
|
|
||||||
#### Reference
|
|
||||||
<a href="T_CapyKit_Helpers_IEncryptionAlgorithm.md">IEncryptionAlgorithm Interface</a>
|
|
||||||
<a href="N_CapyKit_Helpers.md">CapyKit.Helpers Namespace</a>
|
|
||||||
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