diff --git a/._.git b/._.git deleted file mode 100644 index a5eea7c..0000000 Binary files a/._.git and /dev/null differ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 412eeda..0000000 --- a/.gitattributes +++ /dev/null @@ -1,22 +0,0 @@ -# Auto detect text files and perform LF normalization -* text=auto - -# Custom for Visual Studio -*.cs diff=csharp -*.sln merge=union -*.csproj merge=union -*.vbproj merge=union -*.fsproj merge=union -*.dbproj merge=union - -# Standard to msysgit -*.doc diff=astextplain -*.DOC diff=astextplain -*.docx diff=astextplain -*.DOCX diff=astextplain -*.dot diff=astextplain -*.DOT diff=astextplain -*.pdf diff=astextplain -*.PDF diff=astextplain -*.rtf diff=astextplain -*.RTF diff=astextplain diff --git a/.gitignore b/.gitignore index 413e875..a164f9b 100644 --- a/.gitignore +++ b/.gitignore @@ -94,6 +94,5 @@ UpgradeLog*.XML Thumbs.db # Folder config file Desktop.ini -packages/ distribution/ published/ diff --git a/.nuget/NuGet.Config b/.nuget/NuGet.Config deleted file mode 100644 index 3423ec4..0000000 --- a/.nuget/NuGet.Config +++ /dev/null @@ -1,10 +0,0 @@ - - - - - - - - - - diff --git a/.nuget/NuGet.exe b/.nuget/NuGet.exe deleted file mode 100644 index 856263d..0000000 Binary files a/.nuget/NuGet.exe and /dev/null differ diff --git a/.nuget/NuGet.targets b/.nuget/NuGet.targets deleted file mode 100644 index 3f8c37b..0000000 --- a/.nuget/NuGet.targets +++ /dev/null @@ -1,144 +0,0 @@ - - - - $(MSBuildProjectDirectory)\..\ - - - false - - - false - - - true - - - false - - - - - - - - - - - $([System.IO.Path]::Combine($(SolutionDir), ".nuget")) - - - - - $(SolutionDir).nuget - - - - $(MSBuildProjectDirectory)\packages.$(MSBuildProjectName.Replace(' ', '_')).config - $(MSBuildProjectDirectory)\packages.$(MSBuildProjectName).config - - - - $(MSBuildProjectDirectory)\packages.config - $(PackagesProjectConfig) - - - - - $(NuGetToolsPath)\NuGet.exe - @(PackageSource) - - "$(NuGetExePath)" - mono --runtime=v4.0.30319 "$(NuGetExePath)" - - $(TargetDir.Trim('\\')) - - -RequireConsent - -NonInteractive - - "$(SolutionDir) " - "$(SolutionDir)" - - - $(NuGetCommand) install "$(PackagesConfig)" -source "$(PackageSources)" $(NonInteractiveSwitch) $(RequireConsentSwitch) -solutionDir $(PaddedSolutionDir) - $(NuGetCommand) pack "$(ProjectPath)" -Properties "Configuration=$(Configuration);Platform=$(Platform)" $(NonInteractiveSwitch) -OutputDirectory "$(PackageOutputDir)" -symbols - - - - RestorePackages; - $(BuildDependsOn); - - - - - $(BuildDependsOn); - BuildPackage; - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/.vs/FFXIVAPP.Common/v15/sqlite3/storage.ide b/.vs/FFXIVAPP.Common/v15/sqlite3/storage.ide deleted file mode 100644 index bc7cf26..0000000 Binary files a/.vs/FFXIVAPP.Common/v15/sqlite3/storage.ide and /dev/null differ diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..644c6be --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,17 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "2.0.0", + "tasks": [ + { + "label": "build", + "command": "dotnet build /p:GenerateFullPaths=true", + "type": "shell", + "group": "build", + "presentation": { + "reveal": "silent" + }, + "problemMatcher": "$msCompile" + } + ] +} \ No newline at end of file diff --git a/FFXIVAPP.Common.sln b/FFXIVAPP.Common.sln index aa68207..d7a68a2 100644 --- a/FFXIVAPP.Common.sln +++ b/FFXIVAPP.Common.sln @@ -1,47 +1,34 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 15 -VisualStudioVersion = 15.0.26730.8 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FFXIVAPP.Common", "FFXIVAPP.Common\FFXIVAPP.Common.csproj", "{8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{018623DE-9F44-4F9E-A77D-5D4931079D0F}" - ProjectSection(SolutionItems) = preProject - CHANGELOG.md = CHANGELOG.md - README.md = README.md - EndProjectSection -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = ".nuget", ".nuget", "{7AE9C4C0-9725-4EDE-8F5E-F15FB33B283E}" - ProjectSection(SolutionItems) = preProject - .nuget\NuGet.Config = .nuget\NuGet.Config - EndProjectSection -EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FFXIVAPP.ResourceFiles", "..\ffxivapp-resourcefiles\FFXIVAPP.ResourceFiles\FFXIVAPP.ResourceFiles.csproj", "{38E2405F-58D4-411C-B1DF-6E2D6F14082E}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|x86 = Debug|x86 - Release|x86 = Release|x86 - ReleaseDeploy|x86 = ReleaseDeploy|x86 - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}.Debug|x86.ActiveCfg = Debug|x86 - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}.Debug|x86.Build.0 = Debug|x86 - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}.Release|x86.ActiveCfg = Release|x86 - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}.Release|x86.Build.0 = Release|x86 - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}.ReleaseDeploy|x86.ActiveCfg = ReleaseDeploy|x86 - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5}.ReleaseDeploy|x86.Build.0 = ReleaseDeploy|x86 - {38E2405F-58D4-411C-B1DF-6E2D6F14082E}.Debug|x86.ActiveCfg = Debug|x86 - {38E2405F-58D4-411C-B1DF-6E2D6F14082E}.Debug|x86.Build.0 = Debug|x86 - {38E2405F-58D4-411C-B1DF-6E2D6F14082E}.Release|x86.ActiveCfg = Release|x86 - {38E2405F-58D4-411C-B1DF-6E2D6F14082E}.Release|x86.Build.0 = Release|x86 - {38E2405F-58D4-411C-B1DF-6E2D6F14082E}.ReleaseDeploy|x86.ActiveCfg = ReleaseDeploy|x86 - {38E2405F-58D4-411C-B1DF-6E2D6F14082E}.ReleaseDeploy|x86.Build.0 = ReleaseDeploy|x86 - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(ExtensibilityGlobals) = postSolution - SolutionGuid = {2AF21813-3183-4DB2-8504-5F477A73087D} - EndGlobalSection -EndGlobal + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio 15 +VisualStudioVersion = 15.0.26124.0 +MinimumVisualStudioVersion = 15.0.26124.0 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "FFXIVAPP.Common", "FFXIVAPP.Common\FFXIVAPP.Common.csproj", "{ADE85454-1B34-40B0-9502-91D1F46203B4}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + Debug|x86 = Debug|x86 + Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + Release|x86 = Release|x86 + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Debug|x64.ActiveCfg = Debug|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Debug|x64.Build.0 = Debug|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Debug|x86.ActiveCfg = Debug|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Debug|x86.Build.0 = Debug|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Release|Any CPU.Build.0 = Release|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Release|x64.ActiveCfg = Release|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Release|x64.Build.0 = Release|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Release|x86.ActiveCfg = Release|Any CPU + {ADE85454-1B34-40B0-9502-91D1F46203B4}.Release|x86.Build.0 = Release|Any CPU + EndGlobalSection +EndGlobal diff --git a/FFXIVAPP.Common.sln.DotSettings b/FFXIVAPP.Common.sln.DotSettings deleted file mode 100644 index 5d63c8a..0000000 --- a/FFXIVAPP.Common.sln.DotSettings +++ /dev/null @@ -1,489 +0,0 @@ - - <?xml version="1.0" encoding="utf-16"?><Profile name="StyleCop"><CSArrangeQualifiers>True</CSArrangeQualifiers><CSOptimizeUsings><OptimizeUsings>True</OptimizeUsings><EmbraceInRegion>False</EmbraceInRegion><RegionName></RegionName></CSOptimizeUsings><CSReformatCode>True</CSReformatCode><CSReorderTypeMembers>True</CSReorderTypeMembers></Profile> - Solution - Required - Required - Required - Required - public protected internal private static new abstract virtual override sealed readonly extern unsafe volatile async - True - False - True - True - True - True - True - True - True - 1 - 1 - 1 - ALWAYS_ADD - ALWAYS_ADD - ALWAYS_ADD - ALWAYS_ADD - ALWAYS_ADD - True - True - True - True - True - True - 1 - 1 - False - False - False - False - EXPANDED - NEVER - - False - False - False - NEVER - False - - True - ON_SINGLE_LINE - True - - False - True - True - - CHOP_ALWAYS - True - True - - WRAP_IF_LONG - CHOP_ALWAYS - CHOP_ALWAYS - WRAP_IF_LONG - CHOP_ALWAYS - - CHOP_ALWAYS - <?xml version="1.0" encoding="utf-16"?> -<Patterns xmlns="urn:schemas-jetbrains-com:member-reordering-patterns"> - <TypePattern DisplayName="COM interfaces or structs"> - <TypePattern.Match> - <Or> - <And> - <Kind Is="Interface" /> - <Or> - <HasAttribute Name="System.Runtime.InteropServices.InterfaceTypeAttribute" /> - <HasAttribute Name="System.Runtime.InteropServices.ComImport" /> - </Or> - </And> - <Kind Is="Struct" /> - </Or> - </TypePattern.Match> - </TypePattern> - <TypePattern DisplayName="P/Invoke classes called 'NativeMethods' (StyleCop)"> - <TypePattern.Match> - <And> - <Kind Is="Class" /> - <Name Is=".*NativeMethods" /> - </And> - </TypePattern.Match> - </TypePattern> - <TypePattern DisplayName="DataMember serialisation classes (StyleCop)"> - <TypePattern.Match> - <And> - <Or> - <Kind Is="Field" /> - <Kind Is="Property" /> - </Or> - <HasAttribute Name="System.Runtime.Serialization.DataMemberAttribute" /> - </And> - </TypePattern.Match> - </TypePattern> - <TypePattern DisplayName="NUnit Test Fixtures" RemoveRegions="All"> - <TypePattern.Match> - <And> - <Kind Is="Class" /> - <HasAttribute Name="NUnit.Framework.TestFixtureAttribute" Inherited="True" /> - </And> - </TypePattern.Match> - <Entry DisplayName="Setup/Teardown Methods"> - <Entry.Match> - <And> - <Kind Is="Method" /> - <Or> - <HasAttribute Name="NUnit.Framework.SetUpAttribute" Inherited="True" /> - <HasAttribute Name="NUnit.Framework.TearDownAttribute" Inherited="True" /> - <HasAttribute Name="NUnit.Framework.FixtureSetUpAttribute" Inherited="True" /> - <HasAttribute Name="NUnit.Framework.FixtureTearDownAttribute" Inherited="True" /> - </Or> - </And> - </Entry.Match> - </Entry> - <Entry DisplayName="All other members" /> - <Entry DisplayName="Test Methods" Priority="100"> - <Entry.Match> - <And> - <Kind Is="Method" /> - <HasAttribute Name="NUnit.Framework.TestAttribute" /> - </And> - </Entry.Match> - <Entry.SortBy> - <Name /> - </Entry.SortBy> - </Entry> - </TypePattern> - <TypePattern DisplayName="Default Pattern (StyleCop)" RemoveRegions="AllExceptGenerated"> - <Entry DisplayName="Constants"> - <Entry.Match> - <Kind Is="Constant" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Static fields"> - <Entry.Match> - <And> - <Kind Is="Field" /> - <Static /> - </And> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Readonly /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Fields"> - <Entry.Match> - <Kind Is="Field" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Readonly /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Constructors and Destructors" Priority="200"> - <Entry.Match> - <Or> - <Kind Is="Constructor" /> - <Kind Is="Destructor" /> - </Or> - </Entry.Match> - <Entry.SortBy> - <Static /> - <Kind Order="Constructor Destructor" /> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Delegates"> - <Entry.Match> - <Kind Is="Delegate" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Public events"> - <Entry.Match> - <And> - <Kind Is="Event" /> - <Access Is="Public" /> - </And> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Interface events"> - <Entry.Match> - <And> - <Kind Is="Event" /> - <ImplementsInterface /> - </And> - </Entry.Match> - <Entry.SortBy> - <ImplementsInterface Immediate="True" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Other events"> - <Entry.Match> - <Kind Is="Event" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Enums"> - <Entry.Match> - <Kind Is="Enum" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Interfaces"> - <Entry.Match> - <Kind Is="Interface" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Public properties"> - <Entry.Match> - <And> - <Kind Is="Property" /> - <Access Is="Public" /> - </And> - </Entry.Match> - <Entry.SortBy> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Interface properties"> - <Entry.Match> - <And> - <Kind Is="Property" /> - <ImplementsInterface /> - </And> - </Entry.Match> - <Entry.SortBy> - <ImplementsInterface Immediate="True" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Other properties"> - <Entry.Match> - <Kind Is="Property" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Public indexers" Priority="1000"> - <Entry.Match> - <And> - <Kind Is="Indexer" /> - <Access Is="Public" /> - </And> - </Entry.Match> - <Entry.SortBy> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Interface indexers" Priority="1000"> - <Entry.Match> - <And> - <Kind Is="Indexer" /> - <ImplementsInterface /> - </And> - </Entry.Match> - <Entry.SortBy> - <ImplementsInterface Immediate="True" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Other indexers" Priority="1000"> - <Entry.Match> - <Kind Is="Indexer" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Public methods and operators"> - <Entry.Match> - <And> - <Or> - <Kind Is="Method" /> - <Kind Is="Operator" /> - </Or> - <Access Is="Public" /> - </And> - </Entry.Match> - <Entry.SortBy> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Interface methods"> - <Entry.Match> - <And> - <Kind Is="Method" /> - <ImplementsInterface /> - </And> - </Entry.Match> - <Entry.SortBy> - <ImplementsInterface Immediate="True" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Other methods"> - <Entry.Match> - <Kind Is="Method" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Operators"> - <Entry.Match> - <Kind Is="Operator" /> - </Entry.Match> - <Entry.SortBy> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Static /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Nested structs" Priority="600"> - <Entry.Match> - <Kind Is="Struct" /> - </Entry.Match> - <Entry.SortBy> - <Static /> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="Nested classes" Priority="700"> - <Entry.Match> - <Kind Is="Class" /> - </Entry.Match> - <Entry.SortBy> - <Static /> - <Access Order="Public Internal ProtectedInternal Protected Private" /> - <Name /> - </Entry.SortBy> - </Entry> - <Entry DisplayName="All other members" /> - </TypePattern> -</Patterns> - False - UseExplicitType - UseVarWhenEvident - $object$_On$event$ - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="I" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="_" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="T" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="I" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="T" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="aaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - <Policy Inspect="True" Prefix="" Suffix="" Style="AaBb" /> - C:\Users\Icehunter\AppData\Local\JetBrains\Transient\ReSharperPlatformVs15\v08_3cfe8240\SolutionCaches - LIVE_MONITOR - LIVE_MONITOR - DO_NOTHING - LIVE_MONITOR - LIVE_MONITOR - LIVE_MONITOR - LIVE_MONITOR - LIVE_MONITOR - LIVE_MONITOR - LIVE_MONITOR - LIVE_MONITOR - DO_NOTHING - LIVE_MONITOR - True - True - True - True - True - True - True - True - True - END_OF_LINE - END_OF_LINE - END_OF_LINE - END_OF_LINE - END_OF_LINE - END_OF_LINE - END_OF_LINE - TOGETHER_SAME_LINE - False - True - END_OF_LINE - 15 - True - True - <?xml version="1.0" encoding="utf-16"?><Profile name="Solution"><HtmlReformatCode>True</HtmlReformatCode><JsReformatCode>True</JsReformatCode><XMLReformatCode>True</XMLReformatCode><CSCodeStyleAttributes ArrangeTypeAccessModifier="False" ArrangeTypeMemberAccessModifier="False" SortModifiers="True" RemoveRedundantParentheses="True" AddMissingParentheses="True" ArrangeBraces="False" ArrangeAttributes="True" ArrangeArgumentsStyle="False" ArrangeCodeBodyStyle="False" /><CssReformatCode>True</CssReformatCode><VBReformatCode>True</VBReformatCode><CSOptimizeUsings><OptimizeUsings>True</OptimizeUsings><EmbraceInRegion>False</EmbraceInRegion><RegionName></RegionName></CSOptimizeUsings><CSReformatCode>True</CSReformatCode><CSReorderTypeMembers>True</CSReorderTypeMembers><CSEnforceVarKeywordUsageSettings>True</CSEnforceVarKeywordUsageSettings><RemoveCodeRedundancies>True</RemoveCodeRedundancies><CSArrangeQualifiers>True</CSArrangeQualifiers></Profile> - -------------------------------------------------------------------------------------------------------------------- -<copyright file="$FILENAME$" company="SyndicatedLife"> - Copyright(c) 2018 Ryan Wilson &amp;lt;syndicated.life@gmail.com&amp;gt; (http://syndicated.life/) - Licensed under the MIT license. See LICENSE.md in the solution root for full license information. -</copyright> -<summary> - $FILENAME$ Implementation -</summary> --------------------------------------------------------------------------------------------------------------------- diff --git a/FFXIVAPP.Common/Audio/AudioPlaybackEngine.cs b/FFXIVAPP.Common/Audio/AudioPlaybackEngine.cs index 100a63c..e2dc0f3 100644 --- a/FFXIVAPP.Common/Audio/AudioPlaybackEngine.cs +++ b/FFXIVAPP.Common/Audio/AudioPlaybackEngine.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: Audio namespace FFXIVAPP.Common.Audio { using System; @@ -71,4 +72,5 @@ private void SetupEngine() { this.OutputDevice.Play(); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Audio/AutoDisposeFileReader.cs b/FFXIVAPP.Common/Audio/AutoDisposeFileReader.cs index 9d041db..bf7f4fc 100644 --- a/FFXIVAPP.Common/Audio/AutoDisposeFileReader.cs +++ b/FFXIVAPP.Common/Audio/AutoDisposeFileReader.cs @@ -7,7 +7,7 @@ // AutoDisposeFileReader.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: Audio namespace FFXIVAPP.Common.Audio { using NAudio.Wave; @@ -37,4 +37,5 @@ public int Read(float[] buffer, int offset, int count) { return read; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Audio/CachedSound.cs b/FFXIVAPP.Common/Audio/CachedSound.cs index 60d569f..061f591 100644 --- a/FFXIVAPP.Common/Audio/CachedSound.cs +++ b/FFXIVAPP.Common/Audio/CachedSound.cs @@ -7,7 +7,7 @@ // CachedSound.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: Audio namespace FFXIVAPP.Common.Audio { using System.Collections.Generic; using System.Linq; @@ -49,4 +49,5 @@ public CachedSound(string audioFileName) { public WaveFormat WaveFormat { get; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Audio/CachedSoundSampleProvider.cs b/FFXIVAPP.Common/Audio/CachedSoundSampleProvider.cs index c2570c3..2ca5c4c 100644 --- a/FFXIVAPP.Common/Audio/CachedSoundSampleProvider.cs +++ b/FFXIVAPP.Common/Audio/CachedSoundSampleProvider.cs @@ -7,7 +7,7 @@ // CachedSoundSampleProvider.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: Audio namespace FFXIVAPP.Common.Audio { using System; @@ -55,4 +55,5 @@ public int Read(float[] buffer, int offset, int count) { return (int) samplesToCopy; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Behaviors/IgnoreMouseWheelBehavior.cs b/FFXIVAPP.Common/Behaviors/IgnoreMouseWheelBehavior.cs index 4fd3311..e1685fe 100644 --- a/FFXIVAPP.Common/Behaviors/IgnoreMouseWheelBehavior.cs +++ b/FFXIVAPP.Common/Behaviors/IgnoreMouseWheelBehavior.cs @@ -7,7 +7,7 @@ // IgnoreMouseWheelBehavior.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: Ignore mouse wheel namespace FFXIVAPP.Common.Behaviors { using System.Windows; using System.Windows.Input; @@ -33,4 +33,5 @@ private void AssociatedObjectPreviewMouseWheel(object sender, MouseWheelEventArg this.AssociatedObject.RaiseEvent(e2); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Constants.cs b/FFXIVAPP.Common/Constants.cs index fd021ba..50d3fa4 100644 --- a/FFXIVAPP.Common/Constants.cs +++ b/FFXIVAPP.Common/Constants.cs @@ -15,7 +15,7 @@ namespace FFXIVAPP.Common { using FFXIVAPP.Common.Helpers; public static class Constants { - public static readonly FlowDocHelper FD = new FlowDocHelper(); + // TODO: public static readonly FlowDocHelper FD = new FlowDocHelper(); public static string CachePath { get { diff --git a/FFXIVAPP.Common/Controls/xFlowDocument.xaml.cs b/FFXIVAPP.Common/Controls/xFlowDocument.xaml.cs index 8a532e5..440959d 100644 --- a/FFXIVAPP.Common/Controls/xFlowDocument.xaml.cs +++ b/FFXIVAPP.Common/Controls/xFlowDocument.xaml.cs @@ -19,7 +19,7 @@ public partial class xFlowDocument : INotifyPropertyChanged { private string _zoomLevel; public xFlowDocument() { - this.InitializeComponent(); + //this.InitializeComponent(); this.ZoomLevel = "100"; } diff --git a/FFXIVAPP.Common/Converters/BooleanToWidthConverter.cs b/FFXIVAPP.Common/Converters/BooleanToWidthConverter.cs index 09fc95f..6c6a118 100644 --- a/FFXIVAPP.Common/Converters/BooleanToWidthConverter.cs +++ b/FFXIVAPP.Common/Converters/BooleanToWidthConverter.cs @@ -12,7 +12,7 @@ namespace FFXIVAPP.Common.Converters { using System; using System.Globalization; using System.Text.RegularExpressions; - using System.Windows.Data; + using Avalonia.Data.Converters; public class BooleanToWidthConverter : IValueConverter { public object Convert(object value, Type targetType, object parameter, CultureInfo culture) { diff --git a/FFXIVAPP.Common/Converters/IconConverter.cs b/FFXIVAPP.Common/Converters/IconConverter.cs index 9c2536d..42adb8e 100644 --- a/FFXIVAPP.Common/Converters/IconConverter.cs +++ b/FFXIVAPP.Common/Converters/IconConverter.cs @@ -7,13 +7,13 @@ // IconConverter.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: IconConverter namespace FFXIVAPP.Common.Converters { using System; + using System.Collections.Generic; using System.Globalization; using System.IO; - using System.Windows.Data; - + using Avalonia.Data.Converters; using FFXIVAPP.Common.Utilities; using FFXIVAPP.ResourceFiles; @@ -27,7 +27,9 @@ public class IconConverter : IMultiValueConverter { /// /// /// - public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture) { + + public object Convert(IList values, Type targetType, object parameter, CultureInfo culture) + { object folder = values[1]; object name = values[2]; var location = string.Format(AppDomain.CurrentDomain.BaseDirectory + IconPath, folder, name); @@ -47,4 +49,5 @@ public object[] ConvertBack(object value, Type[] targetTypes, object parameter, throw new NotImplementedException(); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Converters/IconConverterFromModel.cs b/FFXIVAPP.Common/Converters/IconConverterFromModel.cs index 439560e..4be6bd1 100644 --- a/FFXIVAPP.Common/Converters/IconConverterFromModel.cs +++ b/FFXIVAPP.Common/Converters/IconConverterFromModel.cs @@ -7,7 +7,7 @@ // IconConverterFromModel.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: IconConverterFromModel namespace FFXIVAPP.Common.Converters { using System; using System.Globalization; @@ -47,4 +47,5 @@ public object[] ConvertBack(object value, Type[] targetTypes, object parameter, throw new NotImplementedException(); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Converters/StringToBrushConverter.cs b/FFXIVAPP.Common/Converters/StringToBrushConverter.cs index 2b95219..933074f 100644 --- a/FFXIVAPP.Common/Converters/StringToBrushConverter.cs +++ b/FFXIVAPP.Common/Converters/StringToBrushConverter.cs @@ -11,9 +11,8 @@ namespace FFXIVAPP.Common.Converters { using System; using System.Globalization; - using System.Windows.Data; - using System.Windows.Media; - + using Avalonia.Data.Converters; + using Avalonia.Media; using FFXIVAPP.Common.Models; using FFXIVAPP.Common.Utilities; diff --git a/FFXIVAPP.Common/Converters/TabStripBorderConverter.cs b/FFXIVAPP.Common/Converters/TabStripBorderConverter.cs index f8cde9b..d835dc0 100644 --- a/FFXIVAPP.Common/Converters/TabStripBorderConverter.cs +++ b/FFXIVAPP.Common/Converters/TabStripBorderConverter.cs @@ -7,7 +7,7 @@ // TabStripBorderConverter.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: TabStripBorderConverter namespace FFXIVAPP.Common.Converters { using System; using System.Globalization; @@ -39,4 +39,5 @@ public object ConvertBack(object value, Type targetType, object parameter, Cultu throw new NotImplementedException(); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Converters/ToUpperConverter.cs b/FFXIVAPP.Common/Converters/ToUpperConverter.cs new file mode 100644 index 0000000..032e3f7 --- /dev/null +++ b/FFXIVAPP.Common/Converters/ToUpperConverter.cs @@ -0,0 +1,24 @@ +using System; +using System.Globalization; +using Avalonia.Data.Converters; + +namespace FFXIVAPP.Common.Converters +{ + public class ToUpperConverter : IValueConverter + { + public object Convert(object value, Type targetType, object parameter, CultureInfo culture) + { + if (value is string) + { + return ((string)value).ToUpperInvariant(); + } + + return value; + } + + public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture) + { + return value; + } + } +} \ No newline at end of file diff --git a/FFXIVAPP.Common/Converters/VisibilityConverter.cs b/FFXIVAPP.Common/Converters/VisibilityConverter.cs index 5e96d99..6512fd9 100644 --- a/FFXIVAPP.Common/Converters/VisibilityConverter.cs +++ b/FFXIVAPP.Common/Converters/VisibilityConverter.cs @@ -7,7 +7,7 @@ // VisibilityConverter.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: VisiblityConverter, Should be able to remove because we use IsVisible (on avalonia objects) instead namespace FFXIVAPP.Common.Converters { using System; using System.Globalization; @@ -47,4 +47,5 @@ public object ConvertBack(object value, Type targetType, object parameter, Cultu return (Visibility) value == Visibility.Visible; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/FFXIVAPP.Common.csproj b/FFXIVAPP.Common/FFXIVAPP.Common.csproj index a8be753..b1d72a3 100644 --- a/FFXIVAPP.Common/FFXIVAPP.Common.csproj +++ b/FFXIVAPP.Common/FFXIVAPP.Common.csproj @@ -1,131 +1,21 @@ - - - - + - Debug - x86 - {8D6CDA64-78BE-4BF0-B613-0C9AFA225DF5} - Library - Properties - FFXIVAPP.Common - FFXIVAPP.Common - v4.6.2 - 512 - - ..\..\ - true + netstandard2.0 + false + false + false + false + false + false + false - - ..\packages\FFXIVAPP.ResourceFiles.2.0.1\lib\net462\FFXIVAPP.ResourceFiles.dll - - - ..\packages\HtmlAgilityPack.1.8.4\lib\Net45\HtmlAgilityPack.dll - - - ..\packages\MahApps.Metro.1.5.0\lib\net45\MahApps.Metro.dll - - - - ..\packages\NAudio.1.8.4\lib\net35\NAudio.dll - - - ..\packages\Newtonsoft.Json.11.0.2\lib\net45\Newtonsoft.Json.dll - - - ..\packages\NLog.4.5.6\lib\net45\NLog.dll - - - - - - - - - - - - - - - ..\packages\MahApps.Metro.1.5.0\lib\net45\System.Windows.Interactivity.dll - - - - - + + + + - - Designer - - - Designer - - + - - - - - - - - - xFlowDocument.xaml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - MSBuild:Compile - Designer - - - - - $(SolutionDir).nuget\nuget.exe pack $(ProjectPath) -Properties Configuration=$(ConfigurationName) -Properties Platform=$(PlatformName) -IncludeReferencedProjects -Symbols -OutputDirectory ..\packages\ -%25SYSTEMROOT%25\System32\WindowsPowerShell\v1.0\powershell.exe –NonInteractive –ExecutionPolicy Unrestricted –command "& { &'$(SolutionDir)RenameSymbolsToPackage.ps1' '$(TargetName)' }" - - \ No newline at end of file diff --git a/FFXIVAPP.Common/FFXIVAPP.Common.csproj.nuspec b/FFXIVAPP.Common/FFXIVAPP.Common.csproj.nuspec deleted file mode 100644 index 08a3d9c..0000000 --- a/FFXIVAPP.Common/FFXIVAPP.Common.csproj.nuspec +++ /dev/null @@ -1,17 +0,0 @@ - - - - $id$ - $version$ - $title$ - $author$ - $author$ - https://github.com/Icehunter/ffxivapp-common/blob/master/LICENSE.md - https://github.com/Icehunter/ffxivapp-common - https://raw.githubusercontent.com/Icehunter/ffxivapp-common/master/FFXIVAPP.Common/Logo.png - true - $description$ - $copyright$ - ffxiv ffxivapp common helpers - - diff --git a/FFXIVAPP.Common/Helpers/BindingHelper.cs b/FFXIVAPP.Common/Helpers/BindingHelper.cs index 9d29da7..4a08e8e 100644 --- a/FFXIVAPP.Common/Helpers/BindingHelper.cs +++ b/FFXIVAPP.Common/Helpers/BindingHelper.cs @@ -8,10 +8,11 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: BindingHelper namespace FFXIVAPP.Common.Helpers { using System.Windows; using System.Windows.Data; - + using Avalonia.Data; using FFXIVAPP.Common.Converters; public static class BindingHelper { @@ -40,4 +41,5 @@ public static Binding ZoomBinding(object source, string path) { return binding; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Helpers/DispatcherHelper.cs b/FFXIVAPP.Common/Helpers/DispatcherHelper.cs index 46aba2f..a462d75 100644 --- a/FFXIVAPP.Common/Helpers/DispatcherHelper.cs +++ b/FFXIVAPP.Common/Helpers/DispatcherHelper.cs @@ -12,11 +12,11 @@ namespace FFXIVAPP.Common.Helpers { using System; using System.Threading; using System.Windows; - using System.Windows.Threading; + using Avalonia.Threading; public static class DispatcherHelper { public static void Invoke(Action action, DispatcherPriority dispatcherPriority = DispatcherPriority.Background) { - Application.Current.Dispatcher.BeginInvoke(dispatcherPriority, new ThreadStart(action)); + DispatcherTimer.RunOnce(() => { action(); }, new TimeSpan(0), dispatcherPriority); } } -} \ No newline at end of file +} diff --git a/FFXIVAPP.Common/Helpers/FlowDocHelper.cs b/FFXIVAPP.Common/Helpers/FlowDocHelper.cs index 0be47c1..9588f6f 100644 --- a/FFXIVAPP.Common/Helpers/FlowDocHelper.cs +++ b/FFXIVAPP.Common/Helpers/FlowDocHelper.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: FlowDochHelper namespace FFXIVAPP.Common.Helpers { using System; using System.Windows; @@ -80,4 +81,5 @@ private static void BlockLoaded(object sender, RoutedEventArgs e) { block.Loaded -= BlockLoaded; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Helpers/ResourceHelper.cs b/FFXIVAPP.Common/Helpers/ResourceHelper.cs index 0529979..aa6e727 100644 --- a/FFXIVAPP.Common/Helpers/ResourceHelper.cs +++ b/FFXIVAPP.Common/Helpers/ResourceHelper.cs @@ -10,19 +10,26 @@ namespace FFXIVAPP.Common.Helpers { using System; - using System.Windows; - using System.Windows.Resources; + using System.IO; + using System.Reflection; using System.Xml.Linq; public static class ResourceHelper { + private static Stream GetResource(Assembly assembly, string path) => assembly.GetManifestResourceStream(path); + /// /// /// /// - public static StreamResourceInfo StreamResource(string path) { - return Application.GetResourceStream(new Uri(path)); + public static Stream StreamResource(string path) { + return StreamResource(System.Reflection.Assembly.GetCallingAssembly(), path); + } + + public static Stream StreamResource(Assembly assembly, string path) { + return GetResource(assembly, path); } + /* TODO: StringResource /// /// /// @@ -30,6 +37,7 @@ public static StreamResourceInfo StreamResource(string path) { public static string StringResource(string key) { return (string) Application.Current.FindResource(key); } + */ /// /// @@ -45,10 +53,10 @@ public static string StringResource(object source, string field) { /// /// public static XDocument XDocResource(string path) { - StreamResourceInfo resource = StreamResource(path); + var resource = GetResource(System.Reflection.Assembly.GetCallingAssembly(), path); return resource == null ? null - : new XDocument(XElement.Load(resource.Stream)); + : new XDocument(XElement.Load(resource)); } } -} \ No newline at end of file +} diff --git a/FFXIVAPP.Common/Helpers/SoundPlayerHelper.cs b/FFXIVAPP.Common/Helpers/SoundPlayerHelper.cs index f5d9851..07471a5 100644 --- a/FFXIVAPP.Common/Helpers/SoundPlayerHelper.cs +++ b/FFXIVAPP.Common/Helpers/SoundPlayerHelper.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: Audio namespace FFXIVAPP.Common.Helpers { using System; using System.Collections.Generic; @@ -127,4 +128,5 @@ public static CachedSound TryGetSetSoundFile(string soundFile, int volume = 100) } } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Helpers/ThemeHelper.cs b/FFXIVAPP.Common/Helpers/ThemeHelper.cs index 4832097..6b0c112 100644 --- a/FFXIVAPP.Common/Helpers/ThemeHelper.cs +++ b/FFXIVAPP.Common/Helpers/ThemeHelper.cs @@ -7,19 +7,16 @@ // ThemeHelper.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: Theme namespace FFXIVAPP.Common.Helpers { using System; using System.Collections.Generic; using System.Linq; using System.Windows; - + using Avalonia.Controls; using FFXIVAPP.Common.Models; using FFXIVAPP.Common.Utilities; - using MahApps.Metro; - using MahApps.Metro.Controls; - using NLog; public static class ThemeHelper { @@ -29,14 +26,14 @@ public static class ThemeHelper { /// /// /// - public static void ChangeTheme(string theme, List window) { + public static void ChangeTheme(string theme, List window) { try { if (window == null || !window.Any()) { Apply(theme, Application.Current.MainWindow); return; } - foreach (MetroWindow metroWindow in window.Where(metroWindow => metroWindow != null)) { + foreach (var metroWindow in window.Where(metroWindow => metroWindow != null)) { Apply(theme, metroWindow); } } @@ -56,4 +53,5 @@ private static void Apply(string theme, Window window) { ThemeManager.ChangeAppStyle(window, ThemeManager.Accents.First(a => a.Name == accent), ThemeManager.AppThemes.First(t => t.Name == "Base" + shade)); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/JsonConverters/ColorConverter.cs b/FFXIVAPP.Common/JsonConverters/ColorConverter.cs new file mode 100644 index 0000000..3d990e8 --- /dev/null +++ b/FFXIVAPP.Common/JsonConverters/ColorConverter.cs @@ -0,0 +1,53 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using Avalonia.Media; +using Newtonsoft.Json; +using Newtonsoft.Json.Linq; + +namespace FFXIVAPP.Common.JsonConverters +{ + public class ColorConverter : JsonConverter + { + public override Color ReadJson(JsonReader reader, Type objectType, Color existingValue, bool hasExistingValue, JsonSerializer serializer) + { + var s = (string)reader.Value; + return Color.Parse(s); + } + + public override void WriteJson(JsonWriter writer, Color value, JsonSerializer serializer) + { + writer.WriteValue(value.ToString()); + } + + /* + public override bool CanConvert(Type objectType) + { + return objectType == typeof(Color) || objectType == typeof(string); + } + + public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) + { + throw new NotImplementedException(); + } + + public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) + { + JToken t = JToken.FromObject(value); + if (t.Type != JTokenType.Object) + { + t.WriteTo(writer); + } + else + { + JObject o = (JObject)t; + IList propertyNames = o.Properties().Select(p => p.Name).ToList(); + + o.AddFirst(new JProperty("Keys", new JArray(propertyNames))); + + o.WriteTo(writer); + } + } + */ + } +} \ No newline at end of file diff --git a/FFXIVAPP.Common/Utilities/GridViewSort.cs b/FFXIVAPP.Common/Utilities/GridViewSort.cs index 482f3d5..0954371 100644 --- a/FFXIVAPP.Common/Utilities/GridViewSort.cs +++ b/FFXIVAPP.Common/Utilities/GridViewSort.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: GridViewSort namespace FFXIVAPP.Common.Utilities { using System.ComponentModel; using System.Linq; @@ -318,4 +319,5 @@ private Geometry GetDefaultGlyph() { // Using a DependencyProperty as the backing store for SortedColumn. This enables animation, styling, binding, etc... } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Utilities/ImageUtilities.cs b/FFXIVAPP.Common/Utilities/ImageUtilities.cs index 42219d4..b0ec4e1 100644 --- a/FFXIVAPP.Common/Utilities/ImageUtilities.cs +++ b/FFXIVAPP.Common/Utilities/ImageUtilities.cs @@ -10,21 +10,18 @@ namespace FFXIVAPP.Common.Utilities { using System.IO; - using System.Windows.Media.Imaging; + using Avalonia.Media.Imaging; public static class ImageUtilities { - public static BitmapImage LoadImageFromStream(string location) { - BitmapImage result = null; - if (location != null) { - var bitmapImage = new BitmapImage(); - using (FileStream stream = File.OpenRead(location)) { - bitmapImage.BeginInit(); - bitmapImage.CacheOption = BitmapCacheOption.OnLoad; - bitmapImage.StreamSource = stream; - bitmapImage.EndInit(); - } - - result = bitmapImage; + /// + /// Loads an image from a filepath + /// + /// Path to image + /// Image as an Bitmap object. Null if not found + public static Bitmap LoadImageFromStream(string location) { + Bitmap result = null; + if (File.Exists(location)) { + result = new Bitmap(location); } return result; diff --git a/FFXIVAPP.Common/Utilities/ScreenCapture.cs b/FFXIVAPP.Common/Utilities/ScreenCapture.cs index 7b092a8..1884cff 100644 --- a/FFXIVAPP.Common/Utilities/ScreenCapture.cs +++ b/FFXIVAPP.Common/Utilities/ScreenCapture.cs @@ -7,7 +7,7 @@ // ScreenCapture.cs Implementation // // -------------------------------------------------------------------------------------------------------------------- - +/* TODO: ScreenCapture namespace FFXIVAPP.Common.Utilities { using System.IO; using System.Windows; @@ -49,4 +49,5 @@ public static byte[] GetJpgImage(UIElement source, double scale, int quality) { return imageArray; } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/Utilities/SelectionBehavior.cs b/FFXIVAPP.Common/Utilities/SelectionBehavior.cs index 27548f5..3f78c6b 100644 --- a/FFXIVAPP.Common/Utilities/SelectionBehavior.cs +++ b/FFXIVAPP.Common/Utilities/SelectionBehavior.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: SelectionBehavior namespace FFXIVAPP.Common.Utilities { using System; using System.Windows; @@ -54,4 +55,5 @@ private static void SelectionChanged(object sender, SelectionChangedEventArgs e) command.Execute(((Selector) sender).SelectedValue); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/ViewModelBase/CommandManagerHelper.cs b/FFXIVAPP.Common/ViewModelBase/CommandManagerHelper.cs index a148c6c..cfcee41 100644 --- a/FFXIVAPP.Common/ViewModelBase/CommandManagerHelper.cs +++ b/FFXIVAPP.Common/ViewModelBase/CommandManagerHelper.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: CommandManagerHelper namespace FFXIVAPP.Common.ViewModelBase { using System; using System.Collections.Generic; @@ -121,4 +122,5 @@ internal static void RemoveWeakReferenceHandler(List handlers, Ev } } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/ViewModelBase/DelegateCommand.cs b/FFXIVAPP.Common/ViewModelBase/DelegateCommand.cs index 9746f67..c83e3c2 100644 --- a/FFXIVAPP.Common/ViewModelBase/DelegateCommand.cs +++ b/FFXIVAPP.Common/ViewModelBase/DelegateCommand.cs @@ -10,7 +10,6 @@ namespace FFXIVAPP.Common.ViewModelBase { using System; - using System.Collections.Generic; using System.Windows.Input; // =================================================================================== @@ -24,15 +23,12 @@ namespace FFXIVAPP.Common.ViewModelBase { // This code is released under the terms of the MS-LPL license, // http://microsoftnlayerapp.codeplex.com/license // =================================================================================== + // Modification done to remove CommandManager dependency (and probably make the code worse...) public class DelegateCommand : ICommand { private readonly Func _canExecuteMethod; private readonly Action _executeMethod; - private List _canExecuteChangedHandlers; - - private bool _isAutomaticRequeryDisabled; - /// /// /// @@ -58,93 +54,20 @@ private DelegateCommand(Action executeMethod, Func canExecuteMethod, bool this._executeMethod = executeMethod; this._canExecuteMethod = canExecuteMethod; - this._isAutomaticRequeryDisabled = isAutomaticRequeryDisabled; - } - - /// - /// - public event EventHandler CanExecuteChanged { - add { - if (!this._isAutomaticRequeryDisabled) { - CommandManager.RequerySuggested += value; - } - - CommandManagerHelper.AddWeakReferenceHandler(ref this._canExecuteChangedHandlers, value, 2); - } - - remove { - if (!this._isAutomaticRequeryDisabled) { - CommandManager.RequerySuggested -= value; - } - - CommandManagerHelper.RemoveWeakReferenceHandler(this._canExecuteChangedHandlers, value); - } } - /// - /// - public bool IsAutomaticRequeryDisabled { - get { - return this._isAutomaticRequeryDisabled; - } + public event EventHandler CanExecuteChanged; - set { - if (this._isAutomaticRequeryDisabled == value) { - return; - } - - if (value) { - CommandManagerHelper.RemoveHandlersFromRequerySuggested(this._canExecuteChangedHandlers); - } - else { - CommandManagerHelper.AddHandlersToRequerySuggested(this._canExecuteChangedHandlers); - } - - this._isAutomaticRequeryDisabled = value; - } - } - - /// - /// - public void RaiseCanExecuteChanged() { - this.OnCanExecuteChanged(); - } - - /// - /// - /// - /// - bool ICommand.CanExecute(object parameter) { - return this.CanExecute(); - } - - /// - /// - /// - void ICommand.Execute(object parameter) { - this.Execute(); - } - - /// - /// - /// - private bool CanExecute() { + public bool CanExecute(object parameter) + { return this._canExecuteMethod == null || this._canExecuteMethod(); } - /// - /// - private void Execute() { + public void Execute(object parameter) { if (this._executeMethod != null) { this._executeMethod(); } } - - /// - /// - private void OnCanExecuteChanged() { - CommandManagerHelper.CallWeakReferenceHandlers(this._canExecuteChangedHandlers); - } } public sealed class DelegateCommand : ICommand { @@ -152,10 +75,6 @@ public sealed class DelegateCommand : ICommand { private readonly Action _executeMethod; - private List _canExecuteChangedHandlers; - - private bool _isAutomaticRequeryDisabled; - /// /// /// @@ -175,55 +94,11 @@ public DelegateCommand(Action executeMethod, Func canExecuteMethod = this._executeMethod = executeMethod; this._canExecuteMethod = canExecuteMethod; - this._isAutomaticRequeryDisabled = isAutomaticRequeryDisabled; - } - - /// - /// - public event EventHandler CanExecuteChanged { - add { - if (!this._isAutomaticRequeryDisabled) { - CommandManager.RequerySuggested += value; - } - - CommandManagerHelper.AddWeakReferenceHandler(ref this._canExecuteChangedHandlers, value, 2); - } - - remove { - if (!this._isAutomaticRequeryDisabled) { - CommandManager.RequerySuggested -= value; - } - - CommandManagerHelper.RemoveWeakReferenceHandler(this._canExecuteChangedHandlers, value); - } } /// /// - public bool IsAutomaticRequeryDisabled { - get { - return this._isAutomaticRequeryDisabled; - } - - set { - if (this._isAutomaticRequeryDisabled != value) { - if (value) { - CommandManagerHelper.RemoveHandlersFromRequerySuggested(this._canExecuteChangedHandlers); - } - else { - CommandManagerHelper.AddHandlersToRequerySuggested(this._canExecuteChangedHandlers); - } - - this._isAutomaticRequeryDisabled = value; - } - } - } - - /// - /// - public void RaiseCanExecuteChanged() { - this.OnCanExecuteChanged(); - } + public event EventHandler CanExecuteChanged; /// /// @@ -260,11 +135,5 @@ private void Execute(T parameter) { this._executeMethod(parameter); } } - - /// - /// - private void OnCanExecuteChanged() { - CommandManagerHelper.CallWeakReferenceHandlers(this._canExecuteChangedHandlers); - } } -} \ No newline at end of file +} diff --git a/FFXIVAPP.Common/WPF/ColumnDefinitionExtended.cs b/FFXIVAPP.Common/WPF/ColumnDefinitionExtended.cs index de91c28..fbada21 100644 --- a/FFXIVAPP.Common/WPF/ColumnDefinitionExtended.cs +++ b/FFXIVAPP.Common/WPF/ColumnDefinitionExtended.cs @@ -8,6 +8,7 @@ // // -------------------------------------------------------------------------------------------------------------------- +/* TODO: ColumnDefinition extended namespace FFXIVAPP.Common.WPF { using System.Windows; using System.Windows.Controls; @@ -63,4 +64,5 @@ private static void OnVisibleChanged(DependencyObject obj, DependencyPropertyCha obj.CoerceValue(MinWidthProperty); } } -} \ No newline at end of file +} +*/ \ No newline at end of file diff --git a/FFXIVAPP.Common/packages.config b/FFXIVAPP.Common/packages.config deleted file mode 100644 index e104548..0000000 --- a/FFXIVAPP.Common/packages.config +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - - \ No newline at end of file diff --git a/FixLineEndings.bat b/FixLineEndings.bat deleted file mode 100644 index bbc4ba6..0000000 --- a/FixLineEndings.bat +++ /dev/null @@ -1,4 +0,0 @@ -git rm --cached -r . -git reset --hard -git add . -git commit -m "normalize line endings" \ No newline at end of file diff --git a/RenameSymbolsToPackage.ps1 b/RenameSymbolsToPackage.ps1 deleted file mode 100644 index cca6bf0..0000000 --- a/RenameSymbolsToPackage.ps1 +++ /dev/null @@ -1,11 +0,0 @@ -$source = $args[0] - -Set-Location $PSScriptRoot\packages - -Dir | -Where-Object { $_.Name -match "$source.[\d\.]+.nupkg" -and $_.Name -notmatch "\.(symbols)"} | -Remove-Item - -Dir | -Where-Object { $_.Name.Contains($source) } | -Rename-Item -NewName { $_.Name -replace ".symbols","" } \ No newline at end of file diff --git a/distribution/FFXIVAPP.Common.dll b/distribution/FFXIVAPP.Common.dll deleted file mode 100644 index dc693b5..0000000 Binary files a/distribution/FFXIVAPP.Common.dll and /dev/null differ diff --git a/distribution/FFXIVAPP.Common.xml b/distribution/FFXIVAPP.Common.xml deleted file mode 100644 index 6266aa2..0000000 --- a/distribution/FFXIVAPP.Common.xml +++ /dev/null @@ -1,472 +0,0 @@ - - - - FFXIVAPP.Common - - - - - Interaction logic for xFlowDocument.xaml - - - xFlowDocument - - - - - Codes Name Field - - - - - RegEx Name Field - - - - - _FDR Name Field - - - - - _FD Name Field - - - - - InitializeComponent - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/distribution/FFXIVAPP.ResourceFiles.dll b/distribution/FFXIVAPP.ResourceFiles.dll deleted file mode 100644 index fc99026..0000000 Binary files a/distribution/FFXIVAPP.ResourceFiles.dll and /dev/null differ diff --git a/distribution/FFXIVAPP.ResourceFiles.xml b/distribution/FFXIVAPP.ResourceFiles.xml deleted file mode 100644 index 85ee54f..0000000 --- a/distribution/FFXIVAPP.ResourceFiles.xml +++ /dev/null @@ -1,8 +0,0 @@ - - - - FFXIVAPP.ResourceFiles - - - - diff --git a/distribution/FFXIVAPP.Resources.dll b/distribution/FFXIVAPP.Resources.dll deleted file mode 100644 index 3fab485..0000000 Binary files a/distribution/FFXIVAPP.Resources.dll and /dev/null differ diff --git a/distribution/HtmlAgilityPack.dll b/distribution/HtmlAgilityPack.dll deleted file mode 100644 index 51e514c..0000000 Binary files a/distribution/HtmlAgilityPack.dll and /dev/null differ diff --git a/distribution/HtmlAgilityPack.xml b/distribution/HtmlAgilityPack.xml deleted file mode 100644 index b94f09d..0000000 --- a/distribution/HtmlAgilityPack.xml +++ /dev/null @@ -1,2989 +0,0 @@ - - - - HtmlAgilityPack - - - - - A utility class to compute CRC32. - - - - - Compute a checksum for a given array of bytes. - - The array of bytes to compute the checksum for. - The computed checksum. - - - - Compute a checksum for a given string. - - The string to compute the checksum for. - The computed checksum. - - - - Represents an HTML attribute. - - - - - Gets the line number of this attribute in the document. - - - - - Gets the column number of this attribute in the document. - - - - - Gets the stream position of the value of this attribute in the document, relative to the start of the document. - - - - - Gets the length of the value. - - - - - Gets the qualified name of the attribute. - - - - - Name of attribute with original case - - - - - Gets the HTML document to which this attribute belongs. - - - - - Gets the HTML node to which this attribute belongs. - - - - - Specifies what type of quote the data should be wrapped in - - - - - Gets the stream position of this attribute in the document, relative to the start of the document. - - - - - Gets or sets the value of the attribute. - - - - - Gets the DeEntitized value of the attribute. - - - - - Gets a valid XPath string that points to this Attribute - - - - - Compares the current instance with another attribute. Comparison is based on attributes' name. - - An attribute to compare with this instance. - A 32-bit signed integer that indicates the relative order of the names comparison. - - - - Creates a duplicate of this attribute. - - The cloned attribute. - - - - Removes this attribute from it's parents collection - - - - - An Enum representing different types of Quotes used for surrounding attribute values - - - - - A single quote mark ' - - - - - A double quote mark " - - - - - Represents a combined list and collection of HTML nodes. - - - - - Gets the number of elements actually contained in the list. - - - - - Gets readonly status of colelction - - - - - Gets the attribute at the specified index. - - - - - Gets a given attribute from the list using its name. - - - - - Adds supplied item to collection - - - - - - Explicit clear - - - - - Retreives existence of supplied item - - - - - - - Copies collection to array - - - - - - - Get Explicit enumerator - - - - - - Explicit non-generic enumerator - - - - - - Retrieves the index for the supplied item, -1 if not found - - - - - - - Inserts given item into collection at supplied index - - - - - - - Explicit collection remove - - - - - - - Removes the attribute at the specified index. - - The index of the attribute to remove. - - - - Adds a new attribute to the collection with the given values - - - - - - - Inserts the specified attribute as the last attribute in the collection. - - The attribute to insert. May not be null. - The appended attribute. - - - - Creates and inserts a new attribute as the last attribute in the collection. - - The name of the attribute to insert. - The appended attribute. - - - - Creates and inserts a new attribute as the last attribute in the collection. - - The name of the attribute to insert. - The value of the attribute to insert. - The appended attribute. - - - - Checks for existance of attribute with given name - - - - - - - Inserts the specified attribute as the first node in the collection. - - The attribute to insert. May not be null. - The prepended attribute. - - - - Removes a given attribute from the list. - - The attribute to remove. May not be null. - - - - Removes an attribute from the list, using its name. If there are more than one attributes with this name, they will all be removed. - - The attribute's name. May not be null. - - - - Remove all attributes in the list. - - - - - Returns all attributes with specified name. Handles case insentivity - - Name of the attribute - - - - - Removes all attributes from the collection - - - - - Clears the attribute collection - - - - - Represents an HTML comment. - - - - - Gets or Sets the comment text of the node. - - - - - Gets or Sets the HTML between the start and end tags of the object. In the case of a text node, it is equals to OuterHtml. - - - - - Gets or Sets the object and its content in HTML. - - - - - Represents a complete HTML document. - - - - True to disable, false to enable the behavaior tag p. - - - Default builder to use in the HtmlDocument constructor - - - Action to execute before the Parse is executed - - - - Defines the max level we would go deep into the html document - - - - The HtmlDocument Text. Careful if you modify it. - - - True to stay backward compatible with previous version of HAP. This option does not guarantee 100% compatibility. - - - - Adds Debugging attributes to node. Default is false. - - - - - Defines if closing for non closed nodes must be done at the end or directly in the document. - Setting this to true can actually change how browsers render the page. Default is false. - - - - - Defines if non closed nodes will be checked at the end of parsing. Default is true. - - - - - Defines if a checksum must be computed for the document while parsing. Default is false. - - - - - Defines if SelectNodes method will return null or empty collection when no node matched the XPath expression. - Setting this to true will return empty collection and false will return null. Default is false. - - - - True to disable, false to enable the server side code. - - - - Defines the default stream encoding to use. Default is System.Text.Encoding.Default. - - - - - Defines if source text must be extracted while parsing errors. - If the document has a lot of errors, or cascading errors, parsing performance can be dramatically affected if set to true. - Default is false. - - - - - Defines the maximum length of source text or parse errors. Default is 100. - - - - - Defines if LI, TR, TH, TD tags must be partially fixed when nesting errors are detected. Default is false. - - - - - Defines if output must conform to XML, instead of HTML. - - - - - If used together with and enabled, Xml namespaces in element names are preserved. Default is false. - - - - - Defines if attribute value output must be optimized (not bound with double quotes if it is possible). Default is false. - - - - - Defines if name must be output with it's original case. Useful for asp.net tags and attributes - - - - - Defines if name must be output in uppercase. Default is false. - - - - - Defines if declared encoding must be read from the document. - Declared encoding is determined using the meta http-equiv="content-type" content="text/html;charset=XXXXX" html node. - Default is true. - - - - - Defines the name of a node that will throw the StopperNodeException when found as an end node. Default is null. - - - - - Defines if the 'id' attribute must be specifically used. Default is true. - - - - - Defines if empty nodes must be written as closed during output. Default is false. - - - - - Creates an instance of an HTML document. - - - - Gets the parsed text. - The parsed text. - - - - Defines the max level we would go deep into the html document. If this depth level is exceeded, and exception is - thrown. - - - - - Gets the document CRC32 checksum if OptionComputeChecksum was set to true before parsing, 0 otherwise. - - - - - Gets the document's declared encoding. - Declared encoding is determined using the meta http-equiv="content-type" content="text/html;charset=XXXXX" html node (pre-HTML5) or the meta charset="XXXXX" html node (HTML5). - - - - - Gets the root node of the document. - - - - - Gets the document's output encoding. - - - - - Gets a list of parse errors found in the document. - - - - - Gets the remaining text. - Will always be null if OptionStopperNodeName is null. - - - - - Gets the offset of Remainder in the original Html text. - If OptionStopperNodeName is null, this will return the length of the original Html text. - - - - - Gets the document's stream encoding. - - - - - Gets a valid XML name. - - Any text. - A string that is a valid XML name. - - - - Applies HTML encoding to a specified string. - - The input string to encode. May not be null. - The encoded string. - - - - Determines if the specified character is considered as a whitespace character. - - The character to check. - true if if the specified character is considered as a whitespace character. - - - - Creates an HTML attribute with the specified name. - - The name of the attribute. May not be null. - The new HTML attribute. - - - - Creates an HTML attribute with the specified name. - - The name of the attribute. May not be null. - The value of the attribute. - The new HTML attribute. - - - - Creates an HTML comment node. - - The new HTML comment node. - - - - Creates an HTML comment node with the specified comment text. - - The comment text. May not be null. - The new HTML comment node. - - - - Creates an HTML element node with the specified name. - - The qualified name of the element. May not be null. - The new HTML node. - - - - Creates an HTML text node. - - The new HTML text node. - - - - Creates an HTML text node with the specified text. - - The text of the node. May not be null. - The new HTML text node. - - - - Detects the encoding of an HTML stream. - - The input stream. May not be null. - The detected encoding. - - - - Detects the encoding of an HTML text provided on a TextReader. - - The TextReader used to feed the HTML. May not be null. - The detected encoding. - - - - Detects the encoding of an HTML text. - - The input html text. May not be null. - The detected encoding. - - - - Gets the HTML node with the specified 'id' attribute value. - - The attribute id to match. May not be null. - The HTML node with the matching id or null if not found. - - - - Loads an HTML document from a stream. - - The input stream. - - - - Loads an HTML document from a stream. - - The input stream. - Indicates whether to look for byte order marks at the beginning of the stream. - - - - Loads an HTML document from a stream. - - The input stream. - The character encoding to use. - - - - Loads an HTML document from a stream. - - The input stream. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the stream. - - - - Loads an HTML document from a stream. - - The input stream. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the stream. - The minimum buffer size. - - - - Loads the HTML document from the specified TextReader. - - The TextReader used to feed the HTML data into the document. May not be null. - - - - Loads the HTML document from the specified string. - - String containing the HTML document to load. May not be null. - - - - Saves the HTML document to the specified stream. - - The stream to which you want to save. - - - - Saves the HTML document to the specified stream. - - The stream to which you want to save. May not be null. - The character encoding to use. May not be null. - - - - Saves the HTML document to the specified StreamWriter. - - The StreamWriter to which you want to save. - - - - Saves the HTML document to the specified TextWriter. - - The TextWriter to which you want to save. May not be null. - - - - Saves the HTML document to the specified XmlWriter. - - The XmlWriter to which you want to save. - - - - Detects the encoding of an HTML document from a file first, and then loads the file. - - The complete file path to be read. - - - - Detects the encoding of an HTML document from a file first, and then loads the file. - - The complete file path to be read. May not be null. - true to detect encoding, false otherwise. - - - - Detects the encoding of an HTML file. - - Path for the file containing the HTML document to detect. May not be null. - The detected encoding. - - - - Loads an HTML document from a file. - - The complete file path to be read. May not be null. - - - - Loads an HTML document from a file. - - The complete file path to be read. May not be null. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Loads an HTML document from a file. - - The complete file path to be read. May not be null. - The character encoding to use. May not be null. - - - - Loads an HTML document from a file. - - The complete file path to be read. May not be null. - The character encoding to use. May not be null. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Loads an HTML document from a file. - - The complete file path to be read. May not be null. - The character encoding to use. May not be null. - Indicates whether to look for byte order marks at the beginning of the file. - The minimum buffer size. - - - - Saves the mixed document to the specified file. - - The location of the file where you want to save the document. - - - - Saves the mixed document to the specified file. - - The location of the file where you want to save the document. May not be null. - The character encoding to use. May not be null. - - - - Creates a new XPathNavigator object for navigating this HTML document. - - An XPathNavigator object. The XPathNavigator is positioned on the root of the document. - - - - Flags that describe the behavior of an Element node. - - - - - The node is a CDATA node. - - - - - The node is empty. META or IMG are example of such nodes. - - - - - The node will automatically be closed during parsing. - - - - - The node can overlap. - - - - - A utility class to replace special characters by entities and vice-versa. - Follows HTML 4.0 specification found at http://www.w3.org/TR/html4/sgml/entities.html - Follows Additional specification found at https://en.wikipedia.org/wiki/List_of_XML_and_HTML_character_entity_references - See also: https://html.spec.whatwg.org/multipage/named-characters.html#named-character-references - - - - - A collection of entities indexed by name. - - - - - A collection of entities indexed by value. - - - - - Replace known entities by characters. - - The source text. - The result text. - - - - Clone and entitize an HtmlNode. This will affect attribute values and nodes' text. It will also entitize all child nodes. - - The node to entitize. - An entitized cloned node. - - - - Replace characters above 127 by entities. - - The source text. - The result text. - - - - Replace characters above 127 by entities. - - The source text. - If set to false, the function will not use known entities name. Default is true. - The result text. - - - - Replace characters above 127 by entities. - - The source text. - If set to false, the function will not use known entities name. Default is true. - If set to true, the [quote], [ampersand], [lower than] and [greather than] characters will be entitized. - The result text - - - - Represents an HTML node. - - - - - Gets the name of a comment node. It is actually defined as '#comment'. - - - - - Gets the name of the document node. It is actually defined as '#document'. - - - - - Gets the name of a text node. It is actually defined as '#text'. - - - - - Gets a collection of flags that define specific behaviors for specific element nodes. - The table contains a DictionaryEntry list with the lowercase tag name as the Key, and a combination of HtmlElementFlags as the Value. - - - - - Initialize HtmlNode. Builds a list of all tags that have special allowances - - - - - Initializes HtmlNode, providing type, owner and where it exists in a collection - - - - - - - - Gets the collection of HTML attributes for this node. May not be null. - - - - - Gets all the children of the node. - - - - - Gets a value indicating if this node has been closed or not. - - - - - Gets the collection of HTML attributes for the closing tag. May not be null. - - - - - Gets the closing tag of the node, null if the node is self-closing. - - - - - Gets the first child of the node. - - - - - Gets a value indicating whether the current node has any attributes. - - - - - Gets a value indicating whether this node has any child nodes. - - - - - Gets a value indicating whether the current node has any attributes on the closing tag. - - - - - Gets or sets the value of the 'id' HTML attribute. The document must have been parsed using the OptionUseIdAttribute set to true. - - - - - Gets or Sets the HTML between the start and end tags of the object. - - - - - Gets or Sets the text between the start and end tags of the object. - - - - - Gets the last child of the node. - - - - - Gets the line number of this node in the document. - - - - - Gets the column number of this node in the document. - - - - - Gets the stream position of the area between the opening and closing tag of the node, relative to the start of the document. - - - - - Gets the length of the area between the opening and closing tag of the node. - - - - - Gets the length of the entire node, opening and closing tag included. - - - - - Gets or sets this node's name. - - - - - Gets the HTML node immediately following this element. - - - - - Gets the type of this node. - - - - - The original unaltered name of the tag - - - - - Gets or Sets the object and its content in HTML. - - - - - Gets the to which this node belongs. - - - - - Gets the parent of this node (for nodes that can have parents). - - - - - Gets the node immediately preceding this node. - - - - - Gets the stream position of this node in the document, relative to the start of the document. - - - - - Gets a valid XPath string that points to this node - - - - - Determines if an element node can be kept overlapped. - - The name of the element node to check. May not be null. - true if the name is the name of an element node that can be kept overlapped, false otherwise. - - - - Creates an HTML node from a string representing literal HTML. - - The HTML text. - The newly created node instance. - - - - Determines if an element node is a CDATA element node. - - The name of the element node to check. May not be null. - true if the name is the name of a CDATA element node, false otherwise. - - - - Determines if an element node is closed. - - The name of the element node to check. May not be null. - true if the name is the name of a closed element node, false otherwise. - - - - Determines if an element node is defined as empty. - - The name of the element node to check. May not be null. - true if the name is the name of an empty element node, false otherwise. - - - - Determines if a text corresponds to the closing tag of an node that can be kept overlapped. - - The text to check. May not be null. - true or false. - - - - Returns a collection of all ancestor nodes of this element. - - - - - - Get Ancestors with matching name - - - - - - - Returns a collection of all ancestor nodes of this element. - - - - - - Gets all anscestor nodes and the current node - - - - - - - Adds the specified node to the end of the list of children of this node. - - The node to add. May not be null. - The node added. - - - Sets child nodes identifier. - The chil node. - - - - Adds the specified node to the end of the list of children of this node. - - The node list to add. May not be null. - - - - Gets all Attributes with name - - - - - - - Creates a duplicate of the node - - - - - - Creates a duplicate of the node and changes its name at the same time. - - The new name of the cloned node. May not be null. - The cloned node. - - - - Creates a duplicate of the node and changes its name at the same time. - - The new name of the cloned node. May not be null. - true to recursively clone the subtree under the specified node; false to clone only the node itself. - The cloned node. - - - - Creates a duplicate of the node. - - true to recursively clone the subtree under the specified node; false to clone only the node itself. - The cloned node. - - - - Creates a duplicate of the node and the subtree under it. - - The node to duplicate. May not be null. - - - - Creates a duplicate of the node. - - The node to duplicate. May not be null. - true to recursively clone the subtree under the specified node, false to clone only the node itself. - - - - Gets all Descendant nodes for this node and each of child nodes - - The depth level of the node to parse in the html tree - the current element as an HtmlNode - - - - Returns a collection of all descendant nodes of this element, in document order - - - - - - Gets all Descendant nodes in enumerated list - - - - - - Gets all Descendant nodes in enumerated list - - - - - - Get all descendant nodes with matching name - - - - - - - Returns a collection of all descendant nodes of this element, in document order - - - - - - Gets all descendant nodes including this node - - - - - - - Gets first generation child node matching name - - - - - - - Gets matching first generation child nodes matching name - - - - - - - Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned. - - The name of the attribute to get. May not be null. - The default value to return if not found. - The value of the attribute if found, the default value if not found. - - - - Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned. - - The name of the attribute to get. May not be null. - The default value to return if not found. - The value of the attribute if found, the default value if not found. - - - - Helper method to get the value of an attribute of this node. If the attribute is not found, the default value will be returned. - - The name of the attribute to get. May not be null. - The default value to return if not found. - The value of the attribute if found, the default value if not found. - - - - Inserts the specified node immediately after the specified reference node. - - The node to insert. May not be null. - The node that is the reference node. The newNode is placed after the refNode. - The node being inserted. - - - - Inserts the specified node immediately before the specified reference node. - - The node to insert. May not be null. - The node that is the reference node. The newChild is placed before this node. - The node being inserted. - - - - Adds the specified node to the beginning of the list of children of this node. - - The node to add. May not be null. - The node added. - - - - Adds the specified node list to the beginning of the list of children of this node. - - The node list to add. May not be null. - - - - Removes node from parent collection - - - - - Removes all the children and/or attributes of the current node. - - - - - Removes all the children of the current node. - - - - Removes all id for node described by node. - The node. - - - - Removes the specified child node. - - The node being removed. May not be null. - The node removed. - - - - Removes the specified child node. - - The node being removed. May not be null. - true to keep grand children of the node, false otherwise. - The node removed. - - - - Replaces the child node oldChild with newChild node. - - The new node to put in the child list. - The node being replaced in the list. - The node replaced. - - - - Helper method to set the value of an attribute of this node. If the attribute is not found, it will be created automatically. - - The name of the attribute to set. May not be null. - The value for the attribute. - The corresponding attribute instance. - - - - Saves all the children of the node to the specified TextWriter. - - The TextWriter to which you want to save. - Identifies the level we are in starting at root with 0 - - - - Saves all the children of the node to a string. - - The saved string. - - - - Saves the current node to the specified TextWriter. - - The TextWriter to which you want to save. - identifies the level we are in starting at root with 0 - - - - Saves the current node to the specified XmlWriter. - - The XmlWriter to which you want to save. - - - - Saves the current node to a string. - - The saved string. - - - - Adds one or more classes to this node. - - The node list to add. May not be null. - - - - Adds one or more classes to this node. - - The node list to add. May not be null. - true to throw Error if class name exists, false otherwise. - - - - Removes the class attribute from the node. - - - - - Removes the class attribute from the node. - - true to throw Error if class name doesn't exist, false otherwise. - - - - Removes the specified class from the node. - - The class being removed. May not be null. - - - - Removes the specified class from the node. - - The class being removed. May not be null. - true to throw Error if class name doesn't exist, false otherwise. - - - - Replaces the class name oldClass with newClass name. - - The new class name. - The class being replaced. - - - - Replaces the class name oldClass with newClass name. - - The new class name. - The class being replaced. - true to throw Error if class name doesn't exist, false otherwise. - - - Gets the CSS Class from the node. - - The CSS Class from the node - - - - Check if the node class has the parameter class. - The class. - True if node class has the parameter class, false if not. - - - - Fill an object and go through it's properties and fill them too. - - Type of object to want to fill. It should have atleast one property that defined XPath. - If htmlDocument includes data , leave this parameter null. Else pass your specific htmldocument. - Returns an object of type T including Encapsulated data. - - - - Fill an object and go through it's properties and fill them too. - - Type of object to want to fill. It should have atleast one property that defined XPath. - If htmlDocument includes data , leave this parameter null. Else pass your specific htmldocument. - Returns an object of type targetType including Encapsulated data. - - - - Creates a new XPathNavigator object for navigating this HTML node. - - An XPathNavigator object. The XPathNavigator is positioned on the node from which the method was called. It is not positioned on the root of the document. - - - - Creates an XPathNavigator using the root of this document. - - - - - - Selects a list of nodes matching the expression. - - The XPath expression. - An containing a collection of nodes matching the query, or null if no node matched the XPath expression. - - - - Selects a list of nodes matching the expression. - - The XPath expression. - An containing a collection of nodes matching the query, or null if no node matched the XPath expression. - - - - Selects the first XmlNode that matches the XPath expression. - - The XPath expression. May not be null. - The first that matches the XPath query or a null reference if no matching node was found. - - - - Selects a list of nodes matching the expression. - - The XPath expression. - An containing a collection of nodes matching the query, or null if no node matched the XPath expression. - - - - Includes tools that GetEncapsulatedData method uses them. - - - - - Determine if a type define an attribute or not , supporting both .NetStandard and .NetFramework2.0 - - Type you want to test it. - Attribute that type must have or not. - If true , The type parameter define attributeType parameter. - - - - Retrive properties of type that defined . - - Type that you want to find it's XPath-Defined properties. - IEnumerable of property infos of a type , that defined specific attribute. - - - - Determine if a has implemented BUT is considered as NONE-IEnumerable ! - - The property info you want to test. - True if property info is IEnumerable. - - - - Returns T type(first generic type) of or . - - IEnumerable-Implemented property - List of generic types. - - - - Find and Return a mehtod that defined in a class by it's name. - - Type of class include requested method. - Name of requested method as string. - Method info of requested method. - - - - Create of given type. - - Type that you want to make a List of it. - Returns IList of given type. - - - - Returns the part of value of you want as . - - A htmlNode instance. - Attribute that includes ReturnType - String that choosen from HtmlNode as result. - - - - Returns parts of values of you want as . - - that you want to retrive each value. - A instnce incules . - Type of IList generic you want. - - - - - Simulate Func method to use in Lambada Expression. - - - - - - - - - This method works like Where method in LINQ. - - - - - - - - - Check if the type can instantiated. - - - - - - - Returns count of elements stored in IEnumerable of T - - - - - - - - Specify which part of is requested. - - - - - Just mark and flag classes to show they have properties that defined . - - - - - Includes XPath and . XPath for finding html tags and for specify which part of you want to return. - - - - - Represents a combined list and collection of HTML nodes. - - - - - Initialize the HtmlNodeCollection with the base parent node - - The base node of the collection - - - - Gets a given node from the list. - - - - - Get node with tag name - - - - - - - Gets the number of elements actually contained in the list. - - - - - Is collection read only - - - - - Gets the node at the specified index. - - - - - Add node to the collection - - - - - - Add node to the collection - - - - - - - Clears out the collection of HtmlNodes. Removes each nodes reference to parentnode, nextnode and prevnode - - - - - Gets existence of node in collection - - - - - - - Copy collection to array - - - - - - - Get Enumerator - - - - - - Get Explicit Enumerator - - - - - - Get index of node - - - - - - - Insert node at index - - - - - - - Remove node - - - - - - - Remove at index - - - - - - Get first instance of node in supplied collection - - - - - - - - Add node to the end of the collection - - - - - - Get first instance of node with name - - - - - - - Get index of node - - - - - - - Add node to the beginning of the collection - - - - - - Remove node at index - - - - - - - Replace node at index - - - - - - - Get all node descended from this collection - - - - - - Get all node descended from this collection with matching name - - - - - - Gets all first generation elements in collection - - - - - - Gets all first generation elements matching name - - - - - - - All first generation nodes in collection - - - - - - Represents an HTML navigator on an HTML document seen as a data store. - - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a stream. - - The input stream. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a stream. - - The input stream. - Indicates whether to look for byte order marks at the beginning of the stream. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a stream. - - The input stream. - The character encoding to use. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a stream. - - The input stream. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the stream. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a stream. - - The input stream. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the stream. - The minimum buffer size. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a TextReader. - - The TextReader used to feed the HTML data into the document. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a file. - - The complete file path to be read. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a file. - - The complete file path to be read. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a file. - - The complete file path to be read. - The character encoding to use. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a file. - - The complete file path to be read. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Initializes a new instance of the HtmlNavigator and loads an HTML document from a file. - - The complete file path to be read. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the file. - The minimum buffer size. - - - - Gets the base URI for the current node. - Always returns string.Empty in the case of HtmlNavigator implementation. - - - - - Gets the current HTML document. - - - - - Gets the current HTML node. - - - - - Gets a value indicating whether the current node has child nodes. - - - - - Gets a value indicating whether the current node has child nodes. - - - - - Gets a value indicating whether the current node is an empty element. - - - - - Gets the name of the current HTML node without the namespace prefix. - - - - - Gets the qualified name of the current node. - - - - - Gets the namespace URI (as defined in the W3C Namespace Specification) of the current node. - Always returns string.Empty in the case of HtmlNavigator implementation. - - - - - Gets the associated with this implementation. - - - - - Gets the type of the current node. - - - - - Gets the prefix associated with the current node. - Always returns string.Empty in the case of HtmlNavigator implementation. - - - - - Gets the text value of the current node. - - - - - Gets the xml:lang scope for the current node. - Always returns string.Empty in the case of HtmlNavigator implementation. - - - - - Creates a new HtmlNavigator positioned at the same node as this HtmlNavigator. - - A new HtmlNavigator object positioned at the same node as the original HtmlNavigator. - - - - Gets the value of the HTML attribute with the specified LocalName and NamespaceURI. - - The local name of the HTML attribute. - The namespace URI of the attribute. Unsupported with the HtmlNavigator implementation. - The value of the specified HTML attribute. String.Empty or null if a matching attribute is not found or if the navigator is not positioned on an element node. - - - - Returns the value of the namespace node corresponding to the specified local name. - Always returns string.Empty for the HtmlNavigator implementation. - - The local name of the namespace node. - Always returns string.Empty for the HtmlNavigator implementation. - - - - Determines whether the current HtmlNavigator is at the same position as the specified HtmlNavigator. - - The HtmlNavigator that you want to compare against. - true if the two navigators have the same position, otherwise, false. - - - - Moves to the same position as the specified HtmlNavigator. - - The HtmlNavigator positioned on the node that you want to move to. - true if successful, otherwise false. If false, the position of the navigator is unchanged. - - - - Moves to the HTML attribute with matching LocalName and NamespaceURI. - - The local name of the HTML attribute. - The namespace URI of the attribute. Unsupported with the HtmlNavigator implementation. - true if the HTML attribute is found, otherwise, false. If false, the position of the navigator does not change. - - - - Moves to the first sibling of the current node. - - true if the navigator is successful moving to the first sibling node, false if there is no first sibling or if the navigator is currently positioned on an attribute node. - - - - Moves to the first HTML attribute. - - true if the navigator is successful moving to the first HTML attribute, otherwise, false. - - - - Moves to the first child of the current node. - - true if there is a first child node, otherwise false. - - - - Moves the XPathNavigator to the first namespace node of the current element. - Always returns false for the HtmlNavigator implementation. - - An XPathNamespaceScope value describing the namespace scope. - Always returns false for the HtmlNavigator implementation. - - - - Moves to the node that has an attribute of type ID whose value matches the specified string. - - A string representing the ID value of the node to which you want to move. This argument does not need to be atomized. - true if the move was successful, otherwise false. If false, the position of the navigator is unchanged. - - - - Moves the XPathNavigator to the namespace node with the specified local name. - Always returns false for the HtmlNavigator implementation. - - The local name of the namespace node. - Always returns false for the HtmlNavigator implementation. - - - - Moves to the next sibling of the current node. - - true if the navigator is successful moving to the next sibling node, false if there are no more siblings or if the navigator is currently positioned on an attribute node. If false, the position of the navigator is unchanged. - - - - Moves to the next HTML attribute. - - - - - - Moves the XPathNavigator to the next namespace node. - Always returns falsefor the HtmlNavigator implementation. - - An XPathNamespaceScope value describing the namespace scope. - Always returns false for the HtmlNavigator implementation. - - - - Moves to the parent of the current node. - - true if there is a parent node, otherwise false. - - - - Moves to the previous sibling of the current node. - - true if the navigator is successful moving to the previous sibling node, false if there is no previous sibling or if the navigator is currently positioned on an attribute node. - - - - Moves to the root node to which the current node belongs. - - - - - Represents the type of a node. - - - - - The root of a document. - - - - - An HTML element. - - - - - An HTML comment. - - - - - A text node is always the child of an element or a document node. - - - - - Represents a parsing error found during document parsing. - - - - - Gets the type of error. - - - - - Gets the line number of this error in the document. - - - - - Gets the column number of this error in the document. - - - - - Gets a description for the error. - - - - - Gets the the full text of the line containing the error. - - - - - Gets the absolute stream position of this error in the document, relative to the start of the document. - - - - - Represents the type of parsing error. - - - - - A tag was not closed. - - - - - A tag was not opened. - - - - - There is a charset mismatch between stream and declared (META) encoding. - - - - - An end tag was not required. - - - - - An end tag is invalid at this position. - - - - - Represents an HTML text node. - - - - - Gets or Sets the HTML between the start and end tags of the object. In the case of a text node, it is equals to OuterHtml. - - - - - Gets or Sets the object and its content in HTML. - - - - - Gets or Sets the text of the node. - - - - - A utility class to get HTML document from HTTP. - - - - - Represents the method that will handle the PostResponse event. - - - - - Represents the method that will handle the PreHandleDocument event. - - - - - Represents the method that will handle the PreRequest event. - - - - - Occurs after an HTTP request has been executed. - - - - - Occurs before an HTML document is handled. - - - - - Occurs before an HTTP request is executed. - - - - - Gets or Sets a value indicating if document encoding must be automatically detected. - - - - - Gets or sets the Encoding used to override the response stream from any web request - - - - - Gets or Sets a value indicating whether to get document only from the cache. - If this is set to true and document is not found in the cache, nothing will be loaded. - - - - - Gets or Sets a value indicating whether to get document from the cache if exists, otherwise from the web - A value indicating whether to get document from the cache if exists, otherwise from the web - - - - - Gets or Sets the cache path. If null, no caching mechanism will be used. - - - - - Gets a value indicating if the last document was retrieved from the cache. - - - - - Gets the last request duration in milliseconds. - - - - - Gets the URI of the Internet resource that actually responded to the request. - - - - - Gets the last request status. - - - - - Gets or Sets the size of the buffer used for memory operations. - - - - - Gets or Sets a value indicating if cookies will be stored. - - - - Gets or sets a value indicating whether redirect should be captured instead of the current location. - True if capture redirect, false if not. - - - - Gets or Sets the User Agent HTTP 1.1 header sent on any webrequest - - - - - Gets or Sets a value indicating whether the caching mechanisms should be used or not. - - - - - Gets the MIME content type for a given path extension. - - The input path extension. - The default content type to return if any error occurs. - The path extension's MIME content type. - - - - Gets the path extension for a given MIME content type. - - The input MIME content type. - The default path extension to return if any error occurs. - The MIME content type's path extension. - - - - Creates an instance of the given type from the specified Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The requested type. - An newly created instance. - - - - Gets an HTML document from an Internet resource and saves it to the specified file. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The location of the file where you want to save the document. - - - - Gets an HTML document from an Internet resource and saves it to the specified file. - Proxy aware - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The location of the file where you want to save the document. - - - - - - Gets an HTML document from an Internet resource and saves it to the specified file. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The location of the file where you want to save the document. - The HTTP method used to open the connection, such as GET, POST, PUT, or PROPFIND. - - - - Gets an HTML document from an Internet resource and saves it to the specified file. Understands Proxies - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The location of the file where you want to save the document. - - The HTTP method used to open the connection, such as GET, POST, PUT, or PROPFIND. - - - - - Gets the cache file path for a specified url. - - The url fo which to retrieve the cache path. May not be null. - The cache file path. - - - - Gets an HTML document from an Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - A new HTML document. - - - - Gets an HTML document from an Internet resource. - - The requested Uri, such as new Uri("http://Myserver/Mypath/Myfile.asp"). - A new HTML document. - - - - Gets an HTML document from an Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - Host to use for Proxy - Port the Proxy is on - User Id for Authentication - Password for Authentication - A new HTML document. - - - - Gets an HTML document from an Internet resource. - - The requested Uri, such as new Uri("http://Myserver/Mypath/Myfile.asp"). - Host to use for Proxy - Port the Proxy is on - User Id for Authentication - Password for Authentication - A new HTML document. - - - - Loads an HTML document from an Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The HTTP method used to open the connection, such as GET, POST, PUT, or PROPFIND. - A new HTML document. - - - - Loads an HTML document from an Internet resource. - - The requested URL, such as new Uri("http://Myserver/Mypath/Myfile.asp"). - The HTTP method used to open the connection, such as GET, POST, PUT, or PROPFIND. - A new HTML document. - - - - Loads an HTML document from an Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The HTTP method used to open the connection, such as GET, POST, PUT, or PROPFIND. - Proxy to use with this request - Credentials to use when authenticating - A new HTML document. - - - - Loads an HTML document from an Internet resource. - - The requested Uri, such as new Uri("http://Myserver/Mypath/Myfile.asp"). - The HTTP method used to open the connection, such as GET, POST, PUT, or PROPFIND. - Proxy to use with this request - Credentials to use when authenticating - A new HTML document. - - - - Loads an HTML document from an Internet resource and saves it to the specified XmlTextWriter. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The XmlTextWriter to which you want to save to. - - - - Begins the process of downloading an internet resource - - Url to the html document - - - - Begins the process of downloading an internet resource - - Url to the html document - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - Username to use for credentials in the web request - Password to use for credentials in the web request - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - Username to use for credentials in the web request - Password to use for credentials in the web request - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - Username to use for credentials in the web request - Password to use for credentials in the web request - Domain to use for credentials in the web request - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - Username to use for credentials in the web request - Password to use for credentials in the web request - Domain to use for credentials in the web request - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - Username to use for credentials in the web request - Password to use for credentials in the web request - Domain to use for credentials in the web request - - - - Begins the process of downloading an internet resource - - Url to the html document - Username to use for credentials in the web request - Password to use for credentials in the web request - Domain to use for credentials in the web request - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - Username to use for credentials in the web request - Password to use for credentials in the web request - - - - Begins the process of downloading an internet resource - - Url to the html document - Username to use for credentials in the web request - Password to use for credentials in the web request - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - The credentials to use for authenticating the web request - - - - Begins the process of downloading an internet resource - - Url to the html document - The credentials to use for authenticating the web request - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - The credentials to use for authenticating the web request - - - - Begins the process of downloading an internet resource - - Url to the html document - The encoding to use while downloading the document - The credentials to use for authenticating the web request - A cancellation token that can be used by other objects or threads to receive notice of cancellation. - - - Gets or sets the web browser timeout. - - - - Gets or sets the web browser delay. - - - Loads HTML using a WebBrowser and Application.DoEvents. - Thrown when an exception error condition occurs. - The requested URL, such as "http://html-agility-pack.net/". - A new HTML document. - - - Loads HTML using a WebBrowser and Application.DoEvents. - Thrown when an exception error condition occurs. - The requested URL, such as "http://html-agility-pack.net/". - (Optional) Check if the browser script has all been run and completed. - A new HTML document. - - - Loads HTML using a WebBrowser and Application.DoEvents. - Thrown when an exception error condition occurs. - The requested URL, such as "http://html-agility-pack.net/". - (Optional) Check if the browser script has all been run and completed. - A new HTML document. - - - - Creates an instance of the given type from the specified Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The URL that specifies the XSLT stylesheet to load. - An containing the namespace-qualified arguments used as input to the transform. - The requested type. - An newly created instance. - - - - Creates an instance of the given type from the specified Internet resource. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The URL that specifies the XSLT stylesheet to load. - An containing the namespace-qualified arguments used as input to the transform. - The requested type. - A file path where the temporary XML before transformation will be saved. Mostly used for debugging purposes. - An newly created instance. - - - - Loads an HTML document from an Internet resource and saves it to the specified XmlTextWriter, after an XSLT transformation. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". - The URL that specifies the XSLT stylesheet to load. - An XsltArgumentList containing the namespace-qualified arguments used as input to the transform. - The XmlTextWriter to which you want to save. - - - - Loads an HTML document from an Internet resource and saves it to the specified XmlTextWriter, after an XSLT transformation. - - The requested URL, such as "http://Myserver/Mypath/Myfile.asp". May not be null. - The URL that specifies the XSLT stylesheet to load. - An XsltArgumentList containing the namespace-qualified arguments used as input to the transform. - The XmlTextWriter to which you want to save. - A file path where the temporary XML before transformation will be saved. Mostly used for debugging purposes. - - - - Wraps getting AppDomain permissions - - - - - Checks to see if Registry access is available to the caller - - - - - - Checks to see if DNS information is available to the caller - - - - - - An interface for getting permissions of the running application - - - - - Checks to see if Registry access is available to the caller - - - - - - Checks to see if DNS information is available to the caller - - - - - - Represents an exception thrown by the HtmlWeb utility class. - - - - - Creates an instance of the HtmlWebException. - - The exception's message. - - - - Represents a document with mixed code and text. ASP, ASPX, JSP, are good example of such documents. - - - - - Gets or sets the token representing code end. - - - - - Gets or sets the token representing code start. - - - - - Gets or sets the token representing code directive. - - - - - Gets or sets the token representing response write directive. - - - - - Creates a mixed code document instance. - - - - - Gets the code represented by the mixed code document seen as a template. - - - - - Gets the list of code fragments in the document. - - - - - Gets the list of all fragments in the document. - - - - - Gets the encoding of the stream used to read the document. - - - - - Gets the list of text fragments in the document. - - - - - Create a code fragment instances. - - The newly created code fragment instance. - - - - Create a text fragment instances. - - The newly created text fragment instance. - - - - Loads a mixed code document from a stream. - - The input stream. - - - - Loads a mixed code document from a stream. - - The input stream. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Loads a mixed code document from a stream. - - The input stream. - The character encoding to use. - - - - Loads a mixed code document from a stream. - - The input stream. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Loads a mixed code document from a stream. - - The input stream. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the file. - The minimum buffer size. - - - - Loads a mixed code document from a file. - - The complete file path to be read. - - - - Loads a mixed code document from a file. - - The complete file path to be read. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Loads a mixed code document from a file. - - The complete file path to be read. - The character encoding to use. - - - - Loads a mixed code document from a file. - - The complete file path to be read. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the file. - - - - Loads a mixed code document from a file. - - The complete file path to be read. - The character encoding to use. - Indicates whether to look for byte order marks at the beginning of the file. - The minimum buffer size. - - - - Loads the mixed code document from the specified TextReader. - - The TextReader used to feed the HTML data into the document. - - - - Loads a mixed document from a text - - The text to load. - - - - Saves the mixed document to the specified stream. - - The stream to which you want to save. - - - - Saves the mixed document to the specified stream. - - The stream to which you want to save. - The character encoding to use. - - - - Saves the mixed document to the specified file. - - The location of the file where you want to save the document. - - - - Saves the mixed document to the specified file. - - The location of the file where you want to save the document. - The character encoding to use. - - - - Saves the mixed document to the specified StreamWriter. - - The StreamWriter to which you want to save. - - - - Saves the mixed document to the specified TextWriter. - - The TextWriter to which you want to save. - - - - Represents a fragment of code in a mixed code document. - - - - - Gets the fragment code text. - - - - - Represents a base class for fragments in a mixed code document. - - - - - Gets the fragement text. - - - - - Gets the type of fragment. - - - - - Gets the line number of the fragment. - - - - - Gets the line position (column) of the fragment. - - - - - Gets the fragment position in the document's stream. - - - - - Represents a list of mixed code fragments. - - - - - Gets the Document - - - - - Gets the number of fragments contained in the list. - - - - - Gets a fragment from the list using its index. - - - - - Gets an enumerator that can iterate through the fragment list. - - - - - Appends a fragment to the list of fragments. - - The fragment to append. May not be null. - - - - Gets an enumerator that can iterate through the fragment list. - - - - - Prepends a fragment to the list of fragments. - - The fragment to append. May not be null. - - - - Remove a fragment from the list of fragments. If this fragment was not in the list, an exception will be raised. - - The fragment to remove. May not be null. - - - - Remove all fragments from the list. - - - - - Remove a fragment from the list of fragments, using its index in the list. - - The index of the fragment to remove. - - - - Represents a fragment enumerator. - - - - - Gets the current element in the collection. - - - - - Gets the current element in the collection. - - - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - - - Represents the type of fragment in a mixed code document. - - - - - The fragment contains code. - - - - - The fragment contains text. - - - - - Represents a fragment of text in a mixed code document. - - - - - Gets the fragment text. - - - - diff --git a/distribution/MahApps.Metro.dll b/distribution/MahApps.Metro.dll deleted file mode 100644 index 4c52491..0000000 Binary files a/distribution/MahApps.Metro.dll and /dev/null differ diff --git a/distribution/MahApps.Metro.xml b/distribution/MahApps.Metro.xml deleted file mode 100644 index 99d7199..0000000 --- a/distribution/MahApps.Metro.xml +++ /dev/null @@ -1,8287 +0,0 @@ - - - - MahApps.Metro - - - - - Helper class for a common focusing problem. - The focus itself isn't the problem. If we use the common focusing methods the control get the focus - but it doesn't get the focus visual style. - The KeyboardNavigation class handles the visual style only if the control get the focus from a keyboard - device or if the SystemParameters.KeyboardCues is true. - - - - - Gets the KeyboardNavigationEx singleton instance. - - - - - Shows the focus visual of the current focused UI element. - Works only together with AlwaysShowFocusVisual property. - - - - - Focuses the specified element and shows the focus visual style. - - The element which will be focused. - - - - Attached DependencyProperty for setting AlwaysShowFocusVisual for a UI element. - - - - - Gets a the value which indicates if the UI element always show the focus visual style. - - - - - Sets a the value which indicates if the UI element always show the focus visual style. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - With this class we can make custom window styles. - - - - Add and remove a native WindowStyle from the HWND. - The styles to be removed. These can be bitwise combined. - The styles to be added. These can be bitwise combined. - Whether the styles of the HWND were modified as a result of this call. - - Critical : Calls critical methods - - - - - Updates all glow windows (visible, hidden, collapsed) - - - - - Sets the opacity to all glow windows - - - - - Starts the opacity storyboard 0 -> 1 - - - - - Shows all glow windows - - - - - Gets or sets the bindable Password property on the PasswordBox control. This is a dependency property. - - - - - Handles changes to the 'Password' attached property. - - - - - Handle the 'PasswordChanged'-event on the PasswordBox - - - - - Called after the behavior is attached to an AssociatedObject. - - - Override this to hook up functionality to the AssociatedObject. - - - - - Called when the behavior is being detached from its AssociatedObject, but before it has actually occurred. - - - Override this to unhook functionality from the AssociatedObject. - - - - - - Sets the first TabItem with Visibility="" as - the SelectedItem of the TabControl. - - - If there is no visible TabItem, null is set as the SelectedItem - - - - - - Represents a border whose contents are clipped within the bounds - of the border. The border may have rounded corners. - - - - - BorderThickness Dependency Property - - - - - Gets or sets the BorderThickness property. This dependency property - indicates the BorderThickness. - - - - - Checks if the given Thickness is valid or not - - Thickness - - - - - Padding Dependency Property - - - - - Gets or sets the Padding property. This dependency property - indicates the Padding. - - - - - CornerRadius Dependency Property - - - - - Gets or sets the CornerRadius property. This dependency property - indicates the CornerRadius of the border. - - - - - Checks if the given CornerRadius is valid or not - - CornerRadius - - - - - BorderBrush Dependency Property - - - - - Gets or sets the BorderBrush property. This dependency property - indicates the BorderBrush with which the Border is drawn. - - - - - Background Dependency Property - - - - - Gets or sets the Background property. This dependency property - indicates the Background with which the Background is drawn. - - - - - OptimizeClipRendering Dependency Property - - - - - Gets or sets the OptimizeClipRendering property. This dependency property - indicates whether the rendering of the clip should be optimized. When set to true, - In order to optimize the rendering of the clipped Child, - the background is rendered with the same brush as the border. Any other brush set for - the background will be ignored. The Child will be rendered on top of it. - This is done to prevent any gaps between the border the the clipped Child (this is - evidently visible if both the Border and the Child are of same color). - This works best when the Child does not have any level of transparency and is opaque. - - - - - Updates DesiredSize of the ClipBorder. Called by parent UIElement. This is the first pass of layout. - - - Border determines its desired size it needs from the specified border the child: its sizing - properties, margin, and requested size. - - Constraint size is an "upper limit" that the return value should not exceed. - The Decorator's desired size. - - - - ClipBorder computes the position of its single child and applies its child's alignments to the child. - - - The size reserved for this element by the parent - The actual ink area of the element, typically the same as finalSize - - - - Here the ClipBorder's Child, Border and Background are rendered. - - Drawing Context - - - - Generates a StreamGeometry. - - An already opened StreamGeometryContext. - Rectangle for geomentry conversion. - The core points of the border which needs to be used to create - the geometry - Result geometry. - - - - Encapsulates the details of each of the core points of the border which is calculated - based on the given CornerRadius, BorderThickness, Padding and a flag to indicate whether - the inner or outer border is to be calculated. - - CornerRadius - BorderThickness - Padding - Flag to indicate whether outer or inner border needs - to be calculated - - - - A few very useful extension methods - - - - - Returns whether or not two doubles are "close". - - The first double to compare. - The second double to compare. - - bool - the result of the AreClose comparision. - - - - - Returns whether or not the first double is less than the second double. - - The first double to compare. - The second double to compare. - - bool - the result of the LessThan comparision. - - - - - Returns whether or not the first double is greater than the second double. - - The first double to compare. - The second double to compare. - - bool - the result of the GreaterThan comparision. - - - - - Returns whether or not the double is "close" to 1. Same as AreClose(double, 1), - but this is faster. - - The double to compare to 1. - - bool - the result of the AreClose comparision. - - - - - IsZero - Returns whether or not the double is "close" to 0. Same as AreClose(double, 0), - but this is faster. - - The double to compare to 0. - - bool - the result of the AreClose comparision. - - - - - Compares two points for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first point to compare - The second point to compare - Whether or not the two points are equal - - - - Compares two Size instances for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first size to compare - The second size to compare - Whether or not the two Size instances are equal - - - - Compares two Vector instances for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first Vector to compare - The second Vector to compare - Whether or not the two Vector instances are equal - - - - Compares two rectangles for fuzzy equality. This function - helps compensate for the fact that double values can - acquire error when operated upon - - The first rectangle to compare - The second rectangle to compare - Whether or not the two rectangles are equal - - - - Faster check for NaN ( faster than double.IsNaN() ) - IEEE 754 : If the argument is any value in the range 0x7ff0000000000001L through 0x7fffffffffffffffL - or in the range 0xfff0000000000001L through 0xffffffffffffffffL, the result will be NaN. - - Value to check - - - - - Rounds the given value based on the DPI scale - - Value to round - DPI Scale - - - - - Verifies if this Thickness contains only valid values - The set of validity checks is passed as parameters. - - Thickness value - allows negative values - allows Double.NaN - allows Double.PositiveInfinity - allows Double.NegativeInfinity - Whether or not the thickness complies to the range specified - - - - Method to add up the left and right size as width, as well as the top and bottom size as height - - Thickness - Size - - - - Verifies if the Thickness contains only zero values - - Thickness - Size - - - - Verifies if all the values in Thickness are same - - Thickness - true if yes, otherwise false - - - - Verifies if this CornerRadius contains only valid values - The set of validity checks is passed as parameters. - - CornerRadius value - allows negative values - allows Double.NaN - allows Double.PositiveInfinity - allows Double.NegativeInfinity - Whether or not the CornerRadius complies to the range specified - - - - Verifies if the CornerRadius contains only zero values - - CornerRadius - Size - - - - Verifies if the CornerRadius contains same values - - CornerRadius - true if yes, otherwise false - - - - Deflates rectangle by given thickness - - Rectangle - Thickness - Deflated Rectangle - - - - Inflates rectangle by given thickness - - Rectangle - Thickness - Inflated Rectangle - - - - Verifies if the given brush is a SolidColorBrush and - its color does not include transparency. - - Brush - true if yes, otherwise false - - - - Verifies if the given brush is the same as the otherBrush. - - Brush - Brush - true if yes, otherwise false - - - - Defines the method that determines whether the command can execute in its current state. - - - true if this command can be executed; otherwise, false. - - Data used by the command. If the command does not require data to be passed, this object can be set to null. - - - - Defines the method to be called when the command is invoked. - - Data used by the command. If the command does not require data to be passed, this object can be set to null. - - - - The DependencyProperty for the CharacterCasing property. - Controls whether or not content is converted to upper or lower case - Default Value: CharacterCasing.Normal - - - - - Character casing of the Content - - - - - The DependencyProperty for the RecognizesAccessKey property. - Default Value: false - - - - - Determine if the inner ContentPresenter should use AccessText in its style - - - - - This custom popup is used by the validation error template. - It provides some additional nice features: - - repositioning if host-window size or location changed - - repositioning if host-window gets maximized and vice versa - - it's only topmost if the host-window is activated - - - - - Gets/sets if the popup can be closed by left mouse button down. - - - - - Called when a cell has just switched to edit mode. - - A reference to element returned by GenerateEditingElement. - The event args of the input event that caused the cell to go into edit mode. May be null. - The unedited value of the cell. - - - - Synchronizes the column property. Taken from Helper code for DataGrid. - - - - - Taken from Helper code for DataGrid. - - - - - The DependencyProperty for the FontFamily property. - Default Value: SystemFonts.MessageFontFamily - - - - - The font family of the desired font. - - - - - The DependencyProperty for the FontSize property. - Default Value: SystemFonts.MessageFontSize - - - - - The size of the desired font. - - - - - The DependencyProperty for the FontStyle property. - Default Value: SystemFonts.MessageFontStyle - - - - - The style of the desired font. - - - - - The DependencyProperty for the FontWeight property. - Default Value: SystemFonts.MessageFontWeight - - - - - The weight or thickness of the desired font. - - - - - The DependencyProperty for the Foreground property. - Default Value: SystemColors.ControlTextBrush - - - - - An brush that describes the foreground color. This overrides the cell foreground inherited color. - - - - - Method used as property changed callback for properties which need RefreshCellContent to be called - - - - - The base class for dialogs. - - You probably don't want to use this class, if you want to add arbitrary content to your dialog, - use the class. - - - - - Gets/sets the dialog's title. - - - - - Gets/sets arbitrary content on top of the dialog. - - - - - Gets/sets arbitrary content below the dialog. - - - - - Gets or sets the size of the dialog title font. - - - The size of the dialog title font. - - - - - Gets or sets the size of the dialog message font. - - - The size of the dialog message font. - - - - - Initializes a new MahApps.Metro.Controls.BaseMetroDialog. - - The window that is the parent of the dialog. - The settings for the message dialog. - - - - Initializes a new MahApps.Metro.Controls.BaseMetroDialog. - - - - - With this method it's possible to return your own settings in a custom dialog. - - - - - - - This is called in the loaded event. - - - - - Waits for the dialog to become ready for interaction. - - A task that represents the operation and it's status. - - - - Requests an externally shown Dialog to close. Will throw an exception if the Dialog is inside of a MetroWindow. - - - - - A last chance virtual method for stopping an external dialog from closing. - - - - - - Gets the window that owns the current Dialog IF AND ONLY IF the dialog is shown externally. - - - - - Gets the window that owns the current Dialog IF AND ONLY IF the dialog is shown inside of a window. - - - - - Waits until this dialog gets unloaded. - - - - - - A class that represents the settings used by Metro Dialogs. - - - - - Gets/sets the text used for the Affirmative button. For example: "OK" or "Yes". - - - - - Gets/sets the text used for the Negative button. For example: "Cancel" or "No". - - - - - Gets/sets whether the metro dialog should use the default black/white appearance (theme) or try to use the current accent. - - - - - Enable/disable dialog showing animation. - "True" - play showing animation. - "False" - skip showing animation. - - - - - Enable/disable dialog hiding animation - "True" - play hiding animation. - "False" - skip hiding animation. - - - - - Gets/sets the default text( just the inputdialog needed) - - - - - Gets/sets the maximum height. (Default is unlimited height, Double.NaN) - - - - - Gets or sets which button should be focused by default - - - - - Gets/sets the token to cancel the dialog. - - - - - Gets/sets a custom resource dictionary which can contains custom styles, brushes or something else. - - - - - If set, stops standard resource dictionaries being applied to the dialog. - - - - - Gets or sets the size of the dialog title font. - - - The size of the dialog title font. - - - - - Gets or sets the size of the dialog message font. - - - The size of the dialog message font. - - - - - An enum representing the different choices for a color scheme in a Metro Dialog. - - - - - An implementation of BaseMetroDialog allowing arbitrary content. - - - - - Gets the default instance if the dialog coordinator, which can be injected into a view model. - - - - - Creates a LoginDialog inside of the current window. - - The window that is the parent of the dialog. - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a InputDialog inside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a MessageDialog inside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Creates a ProgressDialog inside of the current window. - - The MetroWindow - The title of the ProgressDialog. - The message within the ProgressDialog. - Determines if the cancel button is visible. - Optional Settings that override the global metro dialog settings. - A task promising the instance of ProgressDialogController for this operation. - - - - Adds a Metro Dialog instance to the specified window and makes it visible asynchronously. - If you want to wait until the user has closed the dialog, use - You have to close the resulting dialog yourself with . - - The owning window of the dialog. - The dialog instance itself. - An optional pre-defined settings instance. - A task representing the operation. - The is already visible in the window. - - - - Adds a Metro Dialog instance of the given type to the specified window and makes it visible asynchronously. - If you want to wait until the user has closed the dialog, use - You have to close the resulting dialog yourself with . - - The owning window of the dialog. - An optional pre-defined settings instance. - A task with the dialog representing the operation. - - - - Hides a visible Metro Dialog instance. - - The window with the dialog that is visible. - The dialog instance to hide. - An optional pre-defined settings instance. - A task representing the operation. - - The is not visible in the window. - This happens if hasn't been called before. - - - - - Gets the current shown dialog in async way. - - The dialog owner. - - - - Creates a LoginDialog outside of the current window. - - The window that is the parent of the dialog. - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a InputDialog outside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a MessageDialog ouside of the current window. - - The MetroWindow - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Use the dialog coordinator to help you interfact with dialogs from a view model. - - - - - Shows the input dialog. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Shows the input dialog. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a LoginDialog inside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a LoginDialog outside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the LoginDialog. - The message contained within the LoginDialog. - Optional settings that override the global metro dialog settings. - The text that was entered or null (Nothing in Visual Basic) if the user cancelled the operation. - - - - Creates a MessageDialog inside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Creates a MessageDialog outside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the MessageDialog. - The message contained within the MessageDialog. - The type of buttons to use. - Optional settings that override the global metro dialog settings. - A task promising the result of which button was pressed. - - - - Creates a ProgressDialog inside of the current window. - - Typically this should be the view model, which you register in XAML using . - The title of the ProgressDialog. - The message within the ProgressDialog. - Determines if the cancel button is visible. - Optional Settings that override the global metro dialog settings. - A task promising the instance of ProgressDialogController for this operation. - - - - Adds a Metro Dialog instance to the specified window and makes it visible asynchronously. - You have to close the resulting dialog yourself with . - - Typically this should be the view model, which you register in XAML using . - The dialog instance itself. - An optional pre-defined settings instance. - A task representing the operation. - The is already visible in the window. - - - - Hides a visible Metro Dialog instance. - - Typically this should be the view model, which you register in XAML using . - The dialog instance to hide. - An optional pre-defined settings instance. - A task representing the operation. - - The is not visible in the window. - This happens if hasn't been called before. - - - - - Gets the current shown dialog. - - Typically this should be the view model, which you register in XAML using . - - - - InputDialog - - - - - InitializeComponent - - - - - LoginDialog - - - - - InitializeComponent - - - - - An internal control that represents a message dialog. Please use MetroWindow.ShowMessage instead! - - - MessageDialog - - - - - InitializeComponent - - - - - An enum representing the result of a Message Dialog. - - - - - An enum representing the different button states for a Message Dialog. - - - - - Just "OK" - - - - - "OK" and "Cancel" - - - - - An internal control that represents a message dialog. Please use MetroWindow.ShowMessage instead! - - - ProgressDialog - - - - - InitializeComponent - - - - - A class for manipulating an open ProgressDialog. - - - - - This event is raised when the associated was closed programmatically. - - - - - This event is raised when the associated was cancelled by the user. - - - - - Gets if the Cancel button has been pressed. - - - - - Gets if the wrapped ProgressDialog is open. - - - - - Sets the ProgressBar's IsIndeterminate to true. To set it to false, call SetProgress. - - - - - Sets if the Cancel button is visible. - - - - - - Sets the dialog's progress bar value and sets IsIndeterminate to false. - - The percentage to set as the value. - - - - Gets/Sets the minimum restriction of the progress Value property - - - - - Gets/Sets the maximum restriction of the progress Value property - - - - - Sets the dialog's message content. - - The message to be set. - - - - Sets the dialog's title. - - The title to be set. - - - - Begins an operation to close the ProgressDialog. - - A task representing the operation. - - - - The DependencyProperty for the ContentTemplate property. - - - - - The DependencyProperty for the ContentTemplateSelector property. - - - - - The DependencyProperty for the ContentStringFormat property. - - - - - Gets or sets the Content of this control.. - - - - - ContentTemplate is the template used to display the content of the control. - - - - - ContentTemplateSelector allows to provide custom logic for choosing the template used to display the content of the control. - - - This property is ignored if is set. - - - - - ContentStringFormat is the format used to display the content of the control as a string - - - This property is ignored if is set. - - - - - Reflects the parameter to pass to the CommandProperty upon execution. - - - - - Gets or sets the target element on which to fire the command. - - - - - Get or sets the Command property. - - - - - Indicates whether the Menu is visible. - - - - - Gets or sets an extra tag. - - - - - Gets or sets the dimension of children stacking. - - - - - Gets or sets the Content used to generate the icon part. - - - - - Gets or sets the ContentTemplate used to display the content of the icon part. - - - - - Gets/sets the button style. - - - - - Gets/sets the menu style. - - - - - Gets/sets the brush of the button arrow icon. - - - - - Gets/sets the brush of the button arrow icon if the mouse is over the drop down button. - - - - - Gets/sets the brush of the button arrow icon if the arrow button is pressed. - - - - - Gets/sets the visibility of the button arrow icon. - - - - Invoked when the property changes. - Information about the change. - - - - Executes the specified action asynchronously with the DispatcherPriority.Background on the thread that the Dispatcher was created on. - - The dispatcher object where the action runs. - An action that takes no parameters. - The dispatcher priority. - - - - A control that imitate a slideshow with back/forward buttons. - - - - - To counteract the double Loaded event issue. - - - - - Coerce SelectedIndexProperty's value. - - The object that the property exists on. - The new value of the property, prior to any coercion attempt. - The coerced value (with appropriate type). - - - - Computes the transition when changing selected index. - - Previous selected index. - New selected index. - - - - Gets the navigation buttons. - - Previous button. - Next button. - Inactive buttons. - - - - Applies actions to navigation buttons. - - Action applied to the previous button. - Action applied to the next button. - Action applied to the inactive buttons. - Any action is null. - - - - Sets the visibility of navigation buttons. - - Visibility of active buttons. - - - - Changes the current slide to the previous item. - - - - - Changes the current to the next item. - - - - - Brings the control buttons (next/previous) into view. - - - - - Removes the control buttons (next/previous) from view. - - - - - Gets or sets a value indicating whether the border for mouse over state is enabled or not. - - - - - Gets or sets the mouse hover border brush. - - - - - Gets or sets the mouse hover border thickness. - - - - - Gets/sets the text that is displayed in the FlipView's banner. - - - - - Gets/sets whether the FlipView's banner is visible. - - - - - Gets or sets a value indicating whether the navigation is circular, so you get the first after last and the last before first. - - - - - Gets/sets whether the FlipView's NavigationButton is visible. - - - - - A sliding panel control that is hosted in a MetroWindow via a FlyoutsControl. - - - - - - - An event that is raised when IsOpen changes. - - - - - An event that is raised when the closing animation has finished. - - - - - Gets/sets if the title is visible in this flyout. - - - - - Gets/sets if the close button is visible in this flyout. - - - - - Gets/sets if the close button is a cancel button in this flyout. - - - - - Gets/sets a command which will be executed if the close button was clicked. - Note that this won't execute when is set to false. - - - - - Gets/sets the command parameter which will be passed by the CloseCommand. - - - - - Gets/sets a command which will be executed if the close button was clicked. - - - - - Gets/sets whether this flyout is visible. - - - - - Gets/sets whether this flyout uses the open/close animation when changing the property. (default is true) - - - - - Gets/sets whether this flyout animates the opacity of the flyout when opening/closing. - - - - - Gets/sets whether this flyout stays open when the user clicks outside of it. - - - - - Gets/sets the mouse button that closes the flyout on an external mouse click. - - - - - Gets/sets whether this flyout is modal. - - - - - Gets/sets this flyout's position in the FlyoutsControl/MetroWindow. - - - - - Gets or sets the theme of this flyout. - - - - - Gets or sets the focused element. - - - - - Gets or sets a value indicating whether the flyout should auto close after AutoCloseInterval has passed. - - - - - Gets or sets the time in milliseconds when the flyout should auto close. - - - - - Gets or sets a value indicating whether the flyout should try focus an element. - - - - - A FlyoutsControl is for displaying flyouts in a MetroWindow. - - - - - - Gets/sets whether is ignored and all flyouts behave as if it was set to the value of this property. - - - - - Gets/sets whether is ignored and all flyouts behave as if it was set false. - - - - - Adapts the Flyout's theme to the theme of its host window. - - - - - Adapts the Flyout's theme to the theme of its host window, but inverted. - This theme can only be applied if the host window's theme abides the "Dark" and "Light" affix convention. - (see for more infos. - - - - - The dark theme. This is the default theme. - - - - - The flyouts theme will match the host window's accent color. - - - - - GlowWindow - - - - - InitializeComponent - - - - - The HamburgerMenu is based on a SplitView control. By default it contains a HamburgerButton and a ListView to display menu items. - - - The HamburgerMenu is based on a SplitView control. By default it contains a HamburgerButton and a ListView to display menu items. - - - The HamburgerMenu is based on a SplitView control. By default it contains a HamburgerButton and a ListView to display menu items. - - - The HamburgerMenu is based on a SplitView control. By default it contains a HamburgerButton and a ListView to display menu items. - - - The HamburgerMenu is based on a SplitView control. By default it contains a HamburgerButton and a ListView to display menu items. - - - - - Initializes a new instance of the class. - - - - - Override default OnApplyTemplate to capture children controls - - - - - Event raised when an item is clicked - - - - - Event raised when an options' item is clicked - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets a template for the hamburger icon. - - - - - Identifies the dependency property. - - - - - Gets or sets a template for the hamburger icon. - - - - - Gets or sets main button's width. - - - - - Gets or sets main button's height. - - - - - Gets or sets main button's margin. - - - - - Gets or sets main button's visibility. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets an object source used to generate the content of the options. - - - - - Gets or sets the DataTemplate used to display each item in the options. - - - - - Gets or sets the DataTemplateSelector used to display each item in the options. - - - - - Gets the collection used to generate the content of the option list. - - - Exception thrown if OptionsListView is not yet defined. - - - - - Gets or sets the visibility of the options menu. - - - - - Gets or sets the selected options menu item. - - - - - Gets or sets the selected options menu index. - - - - - Gets or sets a command which will be executed if an options item is clicked by the user. - - - - - Gets or sets the command parameter which will be passed by the OptionsItemCommand. - - - - - Executes the options item command which can be set by the user. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets the width of the pane when it's fully expanded. - - - - - Gets or sets a value that specifies whether the pane is shown on the right or left side of the control. - - - - - Gets or sets a value that specifies how the pane and content areas are shown. - - - - - Gets or sets the width of the pane in its compact display mode. - - - - - Gets or sets the Brush to apply to the background of the Pane area of the control. - - - - - Gets or sets the Brush to apply to the foreground of the Pane area of the control. - - - - - Gets or sets a value indicating whether gets or sets a value that specifies whether the pane is expanded to its full width. - - - - - Gets or sets an object source used to generate the content of the menu. - - - - - Gets or sets the DataTemplate used to display each item. - - - - - Gets or sets the DataTemplateSelector used to display each item. - - - - - Gets the collection used to generate the content of the items list. - - - Exception thrown if ButtonsListView is not yet defined. - - - - - Gets or sets the selected menu item. - - - - - Gets or sets the selected menu index. - - - - - Gets or sets a command which will be executed if an item is clicked by the user. - - - - - Gets or sets the command parameter which will be passed by the ItemCommand. - - - - - Gets or sets wheather the ScrollBar of the HamburgerMenu is on the left side or on the right side. - - - - - Executes the item command which can be set by the user. - - - - - The HamburgerMenuGlyphItem provides a glyph based implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies the glyph to use from Segoe MDL2 Assets font. - - - - - The HamburgerMenuIconItem provides an icon based implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies an user specific object which can be used as icon. - - - - - The HamburgerMenuImageItem provides an image based implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies a bitmap to display with an Image control. - - - - - The HamburgerMenuItem provides an implementation for HamburgerMenu entries. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Identifies the dependency property. - - - - - Gets or sets a value that specifies label to display. - - - - - Gets or sets a value that specifies the page to navigate to (if you use the HamburgerMenu with a Frame content) - - - - - Gets or sets a value that specifies an user specific value. - - - - - Gets or sets a command which will be executed if an item is clicked by the user. - - - - - Gets or sets the command parameter which will be passed by the Command. - - - - - Gets or sets the element on which to raise the specified command. - - - Element on which to raise a command. - - - - - Gets or sets a value indicating whether this item is enabled in the user interface (UI). This is a dependency property. - - - true if the item is enabled; otherwise, false. The default value is true. - - - - - Executes the command which can be set by the user. - - - - - The HamburgerMenuItemCollection provides typed collection of HamburgerMenuItem. - - - - - Represents an hour comparison operation that ensures that 12 is smaller than 1. - This ensures that in the control the first hour that is selectable is 12 (AM/PM). - - - This ensures that the first hour that is selectable is 12 (AM/PM).

- This comparer is used only if in the corresponding the value for is false. - - - - - Overrides the text case behavior for certain buttons. - When set to true, the text case will be preserved and won't be changed to upper or lower case. - - - - - DependencyProperty for property. - - - - - The CornerRadius property allows users to control the roundness of the button corners independently by - setting a radius value for each corner. Radius values that are too large are scaled so that they - smoothly blend from corner to corner. (Can be used e.g. at MetroButton style) - Description taken from original Microsoft description :-D - - - - - A helper class that provides various attached properties for the ComboBox control. - - - - - - Gets the Maximum number of characters the TextBox can accept. - - - - - Sets the Maximum number of characters the TextBox can accept. - - - - - Gets the Character casing of the TextBox. - - - - - Sets the Character casing of the TextBox. - - - - - A helper class that provides various controls. - - - - - Gets the value to handle the visibility of the DisabledVisualElement in the template. - - - - - Sets the value to handle the visibility of the DisabledVisualElement in the template. - - - - - The DependencyProperty for the CharacterCasing property. - Controls whether or not content is converted to upper or lower case - - - - - Gets the character casing of the control - - - - - Sets the character casing of the control - - - - - This property can be used to set the button width (PART_ClearText) of TextBox, PasswordBox, ComboBox, NumericUpDown - - - - - Sets the brush used to draw the focus border. - - - - - Gets the brush used to draw the focus border. - - - - - Sets the brush used to draw the mouse over brush. - - - - - Gets the brush used to draw the mouse over brush. - - - - - DependencyProperty for property. - - - - - The CornerRadius property allows users to control the roundness of the button corners independently by - setting a radius value for each corner. Radius values that are too large are scaled so that they - smoothly blend from corner to corner. (Can be used e.g. at MetroButton style) - Description taken from original Microsoft description :-D - - - - - Save the DataGrid. - - - - - Get the DataGrid. - - - - - Gets the value to define the DataGridCell selection behavior. - - - - - Sets the value to define the DataGridCell selection behavior. - - - - - Gets the value to define the DataGridCell selection behavior. - - - - - Sets the value to define the DataGridCell selection behavior. - - - - - Gets a value which indicates the preview cell editing is enabled or not. - - - - - Sets a value which indicates the preview cell editing is enabled or not. - - - - - Gets the value to define the DataGridRow selection behavior. - - - - - Sets the value to define the DataGridRow selection behavior. - - - - - A helper class that provides various attached properties for the Expander control. - - - - - - Gets the toggle button style used for the ExpandDirection Up. - - - - - Sets the toggle button style used for the ExpandDirection Up. - - - - - Gets the toggle button style used for the ExpandDirection Down. - - - - - Sets the toggle button style used for the ExpandDirection Down. - - - - - Gets the toggle button style used for the ExpandDirection Left. - - - - - Sets the toggle button style used for the ExpandDirection Left. - - - - - Gets the toggle button style used for the ExpandDirection Right. - - - - - Sets the toggle button style used for the ExpandDirection Right. - - - - - Change the value of the slider if the user rotates the mouse wheel by the value defined for - - - - - Change the value of the slider if the user rotates the mouse wheel by the value defined for - - - - - Do not change the value of the slider if the user rotates the mouse wheel. - - - - - Change the value of the slider only if the control is focused. - - - - - Changes the value of the slider if the mouse pointer is over this element. - - - - - This property can be used to set vertical scrollbar left side from the tabpanel (look at MetroAnimatedSingleRowTabControl) - - - - - Gets/Sets the type how the value will be changed if the user rotates the mouse wheel. - - - - - Gets/Sets the type how the value will be changed if the user rotates the mouse wheel. - - - - - Gets/Sets the value when the slider will be changed. Possible values are if the slider is focused or if the mouse is over the slider. - - - - - Gets/Sets the value when the slider will be changed. Possible values are if the slider is focused or if the mouse is over the slider. - - - - - Specifies the underline position of a TabControl. - - - - - Defines whether the underline below the is shown or not. - - - - - Defines whether the underline below the or is shown or not. - - - - - Defines the underline brush below the or . - - - - - Defines the underline brush below the or of an selected item. - - - - - Defines the underline brush below the or if the mouse is over an item. - - - - - Defines the underline brush below the or if the mouse is over a selected item. - - - - - This property can be used to set the Transition for animated TabControls - - - - - A helper class that provides various attached properties for the TextBox control. - - - Password watermarking code from: http://prabu-guru.blogspot.com/2010/06/how-to-add-watermark-text-to-textbox.html - - - - - The clear text button behavior property. It sets a click event to the button if the value is true. - - - - - This property can be used to set the button width (PART_ClearText) of TextBox, PasswordBox, ComboBox, NumericUpDown - - - - - This property can be used to retrieve the watermark using the of bound property. - - - Setting this property to true will uses reflection. - - - - - Indicates if a TextBox or RichTextBox should use SpellCheck context menu - - - - - Indicates if the watermark is automatically retrieved by using the of the bound property. - - This attached property uses reflection; thus it might reduce the performance of the application. - The auto-watermak does work for the following controls: - In the following case no custom watermark is shown - - There is no binding - Binding path errors - Binding to a element of a collection without using a property of that element Binding Path=Collection[0] use: Binding Path=Collection[0].SubProperty - The bound property does not have a - - - - - Gets a value that indicates the horizontal alignment of the watermark. - - - One of the values that specifies the desired alignment. The default is . - - - - - Sets a value that indicates the horizontal alignment of the watermark. - - - - - Gets if the attached TextBox has text. - - - - - Gets the clear text button visibility / feature. Can be used to enable text deletion. - - - - - Sets the clear text button visibility / feature. Can be used to enable text deletion. - - - - - Gets the text button visibility. - - - - - Sets the text button visibility. - - - - - Gets the buttons placement variant. - - - - - Sets the buttons placement variant. - - - - - Gets the clear text button behavior. - - - - - Sets the clear text button behavior. - - - - - ButtonContentTemplate is the template used to display the content of the ClearText button. - - - - - This property can be used to handle the style for CheckBox and RadioButton - LeftToRight means content left and button right and RightToLeft vise versa - - - - - This property can be used to handle the style for CheckBox and RadioButton - LeftToRight means content left and button right and RightToLeft vise versa - - - - - A MetroTabControl (Pivot) that wraps TabItem/MetroTabItem headers on a single row. - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroAnimatedSingleRowTabControl class. - - - - - A MetroTabControl (Pivot) that uses a TransitioningContentControl to animate the contents of a TabItem/MetroTabItem. - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroAnimatedTabControl class. - - - - - Originally from http://xamlcoder.com/blog/2010/11/04/creating-a-metro-ui-style-control/ - - - - - A reimplementation of NavigationWindow based on MetroWindow. - - - - MetroNavigationWindow - - - - - Gets an IEnumerable that you use to enumerate the entries in back navigation history for a NavigationWindow. - - - - - - Gets an IEnumerable that you use to enumerate the entries in back navigation history for a NavigationWindow. - - - - - - Gets the NavigationService that is used by this MetroNavigationWindow to provide navigation services to its content. - - - - - - Gets a value that indicates whether there is at least one entry in back navigation history. - - - - - - Gets a value that indicates whether there is at least one entry in forward navigation history. - - - - - - Gets or sets the base uniform resource identifier (URI) of the current context. - - - - - - Gets or sets the uniform resource identifier (URI) of the current content, or the URI of new content that is currently being navigated to. - - - - - - Adds an entry to back navigation history that contains a CustomContentState object. - - A CustomContentState object that represents application-defined state that is associated with a specific piece of content. - - - - - Removes the most recent journal entry from back history. - - The most recent JournalEntry in back navigation history, if there is one. - - - - - Navigates to the most recent item in back navigation history. - - - - - - Navigates to the most recent item in forward navigation history. - - - - - - Navigates asynchronously to content that is contained by an object. - - An Object that contains the content to navigate to. - true if a navigation is not canceled; otherwise, false. - - - - - Navigates asynchronously to content that is specified by a uniform resource identifier (URI). - - A Uri object initialized with the URI for the desired content. - true if a navigation is not canceled; otherwise, false. - - - - - Navigates asynchronously to content that is contained by an object, and passes an object that contains data to be used for processing during navigation. - - An Object that contains the content to navigate to. - A Object that contains data to be used for processing during navigation. - true if a navigation is not canceled; otherwise, false. - - - - - Navigates asynchronously to source content located at a uniform resource identifier (URI), and pass an object that contains data to be used for processing during navigation. - - A Uri object initialized with the URI for the desired content. - A Object that contains data to be used for processing during navigation. - true if a navigation is not canceled; otherwise, false. - - - - - Stops further downloading of content for the current navigation request. - - - - - - Occurs when navigation to a content fragment begins, which occurs immediately, if the desired fragment is in the current content, or after the source XAML content has been loaded, if the desired fragment is in different content. - - - - - - Occurs when a new navigation is requested. - - - - - - Occurs when an error is raised while navigating to the requested content. - - - - - - Occurs periodically during a download to provide navigation progress information. - - - - - - Occurs when the StopLoading method is called, or when a new navigation is requested while a current navigation is in progre - - - - - - Occurs when the content that is being navigated to has been found, and is available from the PageContent property, although it may not have completed loading - - - - - - Occurs when content that was navigated to has been loaded, parsed, and has begun rendering. - - - - - - InitializeComponent - - - - - A metrofied ProgressBar. - - - - - - Gets/sets the diameter of the ellipses used in the indeterminate animation. - - - - - Gets/sets the offset of the ellipses used in the indeterminate animation. - - - - - A standard MetroTabControl (Pivot). - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroTabControl class. - - - - - A base class for every MetroTabControl (Pivot). - - - - - Get/sets the command that executes when a MetroTabItem's close button is clicked. - - - - - An event that is raised when a TabItem is closed. - - - - - Event args that is created when a TabItem is closed. - - - - - Gets the MetroTabItem that will be closed. - - - - - An extended TabItem with a metro style. - - - - - Gets/sets whether the Close Button is visible. - - - - - Gets/sets the command that is executed when the Close Button is clicked. - - - - - Gets/sets the command that is executed when the Close Button is clicked. - - - - - Gets/sets the command parameter which is passed to the close button command. - - - - - Gets/sets the Close Button Margin. - - - - - The MetroThumbContentControl control can be used for titles or something else and enables basic drag movement functionality. - - - - - Adds or remove a DragStartedEvent handler - - - - - Adds or remove a DragDeltaEvent handler - - - - - Adds or remove a DragCompletedEvent handler - - - - - DependencyProperty for the IsDragging property. - - - - - Indicates that the left mouse button is pressed and is over the MetroThumbContentControl. - - - - - An extended, metrofied Window class. - - - - - Allows easy handling of window commands brush. Theme is also applied based on this brush. - - - - - Gets/sets whether the window's entrance transition animation is enabled. - - - - - Gets/sets the FlyoutsControl that hosts the window's flyouts. - - - - - Gets/sets the icon content template to show a custom icon. - - - - - Gets/sets the title content template to show a custom title. - - - - - Gets/sets the left window commands that hosts the user commands. - - - - - Gets/sets the right window commands that hosts the user commands. - - - - - Gets/sets the window button commands that hosts the min/max/close commands. - - - - - Gets/sets whether the window will ignore (and overlap) the taskbar when maximized. - - - - - Gets/sets the brush used for the titlebar's foreground. - - - - - Gets/sets whether the window will save it's position between loads. - - - - - Gets the window placement settings (can be overwritten). - - - - - Get/sets whether the titlebar icon is visible or not. - - - - - Get/sets whether dialogs show over the title bar. - - - - - Gets/sets edge mode of the titlebar icon. - - - - - Gets/sets bitmap scaling mode of the titlebar icon. - - - - - Gets/sets icon scaling mode of the titlebar. - - - - - Gets/sets whether the TitleBar is visible or not. - - - - - Gets/sets whether the WindowStyle is None or not. - - - - - Gets/sets if the minimize button is visible. - - - - - Gets/sets if the Maximize/Restore button is visible. - - - - - Gets/sets if the close button is visible. - - - - - Gets/sets if the min button is enabled. - - - - - Gets/sets if the max/restore button is enabled. - - - - - Gets/sets if the close button is enabled. - - - - - Gets/sets if the the system menu should popup on right click. - - - - - Gets/sets the TitleBar's height. - - - - - Gets/sets if the TitleBar's text is automatically capitalized. - - - - - Character casing of the title - - - - - Gets/sets the title horizontal alignment. - - - - - Gets/sets the brush used for the Window's title bar. - - - - - Gets/sets the brush used for the Window's glow. - - - - - Gets/sets the brush used for the Window's non-active glow. - - - - - Gets/sets the brush used for the Window's non-active border. - - - - - Gets/sets the brush used for the Window's non-active title bar. - - - - - Gets/sets the brush used for the dialog overlay. - - - - - Gets/sets the opacity used for the dialog overlay. - - - - - Begins to show the MetroWindow's overlay effect. - - A task representing the process. - - - - Begins to hide the MetroWindow's overlay effect. - - A task representing the process. - - - - Stores the given element, or the last focused element via FocusManager, for restoring the focus after closing a dialog. - - The element which will be focused again. - - - - Clears the stored element which would get the focus after closing a dialog. - - - - - Initializes a new instance of the MahApps.Metro.Controls.MetroWindow class. - - - - - Gets the template child with the given name. - - The interface type inheirted from DependencyObject. - The name of the template child. - - - - Gets the template child with the given name. - - The name of the template child. - - - - This class eats little children. - - - - - Sets the IsHitTestVisibleInChromeProperty to a MetroWindow template child - - The MetroWindow. - The name of the template child. - - - - - Sets the WindowChrome ResizeGripDirection to a MetroWindow template child. - - The MetroWindow. - The name of the template child. - The direction. - - - - Adapts the WindowCommands to the theme of the first opened, topmost && (top || right || left) flyout - - The MetroWindow - All the flyouts! Or flyouts that fall into the category described in the summary. - An optional brush to reset the window commands brush to. - - - - Represents a Windows spin box (also known as an up-down control) that displays numeric values. - - - - - Event fired from this NumericUpDown when its value has reached the maximum value - - - - - Event fired from this NumericUpDown when its value has reached the minimum value - - - - - Gets or sets the amount of time, in milliseconds, the NumericUpDown waits while the up/down button is pressed - before it starts increasing/decreasing the - for the specified . The value must be - non-negative. - - - - - Gets or sets a value indicating whether the user can use the arrow keys and to change values. - - - - - Gets or sets a value indicating whether the user can use the mouse wheel to change values. - - - - - Gets or sets a value indicating whether the control must have the focus in order to change values using the mouse wheel. - - If the value is true then the value changes when the mouse wheel is over the control. If the value is false then the value changes only if the control has the focus. If is set to "false" then this property has no effect. - - - - - - Gets or sets a value indicating whether the user can enter text in the control. - - - - - Gets or sets a value indicating the culture to be used in string formatting operations. - - - - - Gets or sets a value indicating whether the +/- button of the control is visible. - - - If the value is false then the of the control can be changed only if one of the following cases is satisfied: - - - is true. - - - is true. - - - is true. - - - - - - - Gets or sets a value indicating whether the text can be changed by the use of the up or down buttons only. - - - - - Gets or sets a value indicating whether the value to be added to or subtracted from remains - always - or if it will increase faster after pressing the up/down button/arrow some time. - - - - - Gets or sets the formatting for the displaying - - - - - - - - Gets or sets the horizontal alignment of the contents of the text box. - - - - - Indicates if the NumericUpDown should show the decimal separator or not. - - - - - Called when this element or any below gets focus. - - - - - When overridden in a derived class, is invoked whenever application code or internal processes call - . - - - - - Raises the routed event. - - - Old value of the property - - - New value of the property - - - - - Based on Greg Schechter's Planerator - http://blogs.msdn.com/b/greg_schechter/archive/2007/10/26/enter-the-planerator-dead-simple-3d-in-wpf-with-a-stupid-name.aspx - - - - - An Enum representing different positions, such as Left or Right. - - - - - AddValueChanged of dependency property descriptor results in memory leak as you already know. - So, as described here, you can create custom class PropertyChangeNotifier to listen - to any dependency property changes. - - This class takes advantage of the fact that bindings use weak references to manage associations - so the class will not root the object who property changes it is watching. It also uses a WeakReference - to maintain a reference to the object whose property it is watching without rooting that object. - In this way, you can maintain a collection of these objects so that you can unhook the property - change later without worrying about that collection rooting the object whose values you are watching. - - Complete implementation can be found here: http://agsmith.wordpress.com/2008/04/07/propertydescriptor-addvaluechanged-alternative/ - - - - - Identifies the dependency property - - - - - Returns/sets the value of the property - - - - - - Event arguments created for the RangeSlider's SelectionChanged event. - - - - - - The value of the new range's beginning. - - - - - The value of the new range's ending. - - - - - A slider control with the ability to select a range between two values. - - - - - Get/sets value how fast thumbs will move when user press on left/right/central with left mouse button (IsMoveToPoint must be set to FALSE) - - - - - Get/sets precision of the value, which displaying inside AutotToolTip - - - - - Get/sets the converter for the tooltip text - - - - - Get/sets tooltip, which will show while dragging thumbs and display currect value - - - - - Get/sets tick placement position - - - - - Get/sets IsMoveToPoint feature which will enable/disable moving to exact point inside control when user clicked on it - - - - - Get/sets tickFrequency - - - - - Get/sets orientation of range slider - - - - - Get/sets whether possibility to make manipulations inside range with left/right mouse buttons + cotrol button - - - - - Get/sets whether possibility to make manipulations inside range with left/right mouse buttons + cotrol button - - - - - Get/sets whether whole range will be moved when press on right/left/central part of control - - - - - Get/sets the minimal distance between two thumbs. - - - - - Get/sets the beginning of the range selection. - - - - - Get/sets the end of the range selection. - - - - - Get/sets the minimum range that can be selected. - - - - - Responds to a change in the value of the property. - - The old value of the property.The new value of the property. - - - - Responds to a change in the value of the property. - - The old value of the property.The new value of the property. - - - - RevealImage - - - - - InitializeComponent - - - - - Reflects the parameter to pass to the CommandProperty upon execution. - - - - - Gets or sets the target element on which to fire the command. - - - - - Get or sets the Command property. - - - - - Indicates whether the Popup is visible. - - - - - Gets or sets an extra tag. - - - - - Gets or sets the dimension of children stacking. - - - - - Gets or sets the Content used to generate the icon part. - - - - - Gets or sets the ContentTemplate used to display the content of the icon part. - - - - - Gets/sets the button style. - - - - - Gets/sets the button arrow style. - - - - - Gets/sets the popup listbox style. - - - - - Gets/sets the brush of the button arrow icon. - - - - - Gets/sets the brush of the button arrow icon if the mouse is over the split button. - - - - - Gets/sets the brush of the button arrow icon if the arrow button is pressed. - - - - Updates the current selection when an item in the has changed - The event data. - - - - A special animation used to animates the length of a . - - - - - - - Represents a container with two views; one view for the main content and another view that is typically used for - navigation commands. - - - - - Identifies the dependency property. - - The identifier for the property. - - - - Gets or sets the width of the pane in its compact display mode. - - - The width of the pane in it's compact display mode. The default is 48 device-independent pixel (DIP) (defined - by the SplitViewCompactPaneThemeLength resource). - - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets or sets the contents of the main panel of a . - - The contents of the main panel of a . The default is null. - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets of sets a value that specifies how the pane and content areas of a are shown. - - - A value of the enumeration that specifies how the pane and content areas of a are - shown. The default is . - - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets or sets a value that specifies whether the pane is expanded to its full width. - - true if the pane is expanded to its full width; otherwise, false. The default is true. - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets or sets the width of the pane when it's fully expanded. - - - The width of the pane when it's fully expanded. The default is 320 device-independent - pixel (DIP). - - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets or sets the contents of the pane of a . - - The contents of the pane of a . The default is null. - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets or sets the Brush to apply to the background of the area of the control. - - The Brush to apply to the background of the area of the control. - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets or sets the Brush to apply to the foreground of the area of the control. - - The Brush to apply to the background of the area of the control. - - - - Identifies the PanePlacement dependency property. - - The identifier for the PanePlacement dependency property. - - - - Gets or sets a value that specifies whether the pane is shown on the right or left side of the - . - - - A value of the enumeration that specifies whether the pane is shown on the right or left side of the - . The default is . - - - - - Identifies the dependency property. - - The identifier for the dependency property. - - - - Gets an object that provides calculated values that can be referenced as TemplateBinding sources when defining - templates for a control. - - An object that provides calculated values for templates. - - - - Initializes a new instance of the class. - - - - - Occurs when the pane is closed. - - - - - Occurs when the pane is closing. - - - - - Constants that specify how the pane is shown in a . - - - - - The pane covers the content when it's open and does not take up space in the control layout. - - - - - The pane is shown side-by-side with the content and takes up space in the control layout. - - - - - The amount of the pane defined by the property is shown side-by-side - with the content and takes up space in the control layout. - The remaining part of the pane covers the content when it's open and does not take up space in the control layout. - - - - - The amount of the pane defined by the property is shown side-by-side - with the content and takes up space in the control layout. - The remaining part of the pane pushes the content to the side when it's open and takes up space in the control - layout. - - - - - Provides event data for the event. - - - - - Gets or sets a value that indicates whether the pane closing action should be canceled. - - true to cancel the pane closing action; otherwise, false. - - - - Constants that specify whether the pane is set to the left or to the right of the content in a - . - - - - - The pane is shown to the left of the content. - - - - - The pane is shown to the right of the content. - - - - - Provides calculated values that can be referenced as TemplatedParent sources when defining templates for a - . - Not intended for general use. - - - - - Gets the value as a GridLength. - - - - - Gets the negative of the value. - - - - - Gets the negative of the value calculated by subtracting the value from - the value. - - - - - Gets the value as a GridLength. - - - - - Gets the value. - - - - - Gets a value calculated by subtracting the value from the - value. - - - - - An Enum representing different themes for window commands. - - - - - HorizontalTitleAlignment Dependency Property. - Default Value: HorizontalAlignment.Left - - - - - Gets/Sets the horizontal alignment of the title. - - - - - VerticalTitleAlignment Dependency Property. - Default Value: VerticalAlignment.Bottom - - - - - Gets/Sets the vertical alignment of the title. - - - - - Represents a control that allows the user to select a date and a time. - - - - - Occurs when the property is changed. - - - - - Gets or sets the date to display - - - The date to display. The default is . - - - - - Gets or sets the last date to be displayed. - - The last date to display. - - - - Gets or sets the first date to be displayed. - - The first date to display. - - - - Gets or sets the day that is considered the beginning of the week. - - - A that represents the beginning of the week. The default is the - that is determined by the current culture. - - - - - Gets or sets a value that indicates whether the current date will be highlighted. - - true if the current date is highlighted; otherwise, false. The default is true. - - - - Gets or sets a value that indicates the dimension by which calendar and clock are stacked. - - - The of the calendar and clock. The default is - . - - - - - Gets or sets the currently selected date. - - - The date currently selected. The default is null. - - - - - Defines the visibility for time-parts that are visible for the . - - - - - Represents a control that allows the user to select a time. - - - - - Represents a base-class for time picking. - - - - - This readonly dependency property is to control whether to show the date-picker (in case of ) or hide it (in case of . - - - - - Represents the time 00:00:00; 12:00:00 AM respectively - - - - - Represents the time 23:59:59.9999999; 11:59:59.9999999 PM respectively - - - - - This list contains values from 0 to 55 with an interval of 5. It can be used to bind to and . - - - <MahApps:TimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf5}" /> - <MahApps:DateTimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf5}" /> - - - Returns a list containing {0, 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55}. - - - - - This list contains values from 0 to 50 with an interval of 10. It can be used to bind to and . - - - <MahApps:TimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf10}" /> - <MahApps:DateTimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf10}" /> - - - Returns a list containing {0, 10, 20, 30, 40, 50}. - - - - - This list contains values from 0 to 45 with an interval of 15. It can be used to bind to and . - - - <MahApps:TimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf15}" /> - <MahApps:DateTimePicker SourceSeconds="{x:Static MahApps:TimePickerBase.IntervalOf15}" /> - - - Returns a list containing {0, 15, 30, 45}. - - - - - Occurs when the property is changed. - - - - - Gets or sets a value indicating the culture to be used in string formatting operations. - - - - - Gets or sets a value indicating the visibility of the clock hands in the user interface (UI). - - - The visibility definition of the clock hands. The default is . - - - - - Gets or sets a value indicating whether the date can be selected or not. This property is read-only. - - - - - Gets or sets a value indicating whether the clock of this control is visible in the user interface (UI). This is a - dependency property. - - - If this value is set to false then is set to - - - - true if the clock is visible; otherwise, false. The default value is true. - - - - - Gets or sets a value indicating whether the drop-down for a box is currently - open. - - true if the drop-down is open; otherwise, false. The default is false. - - - - Gets or sets a value indicating whether the contents of the are not editable. - - - true if the is read-only; otherwise, false. The default is false. - - - - - Gets or sets a value indicating the visibility of the selectable date-time-parts in the user interface (UI). - - - visibility definition of the selectable date-time-parts. The default is . - - - - - Gets or sets the currently selected time. - - - The time currently selected. The default is null. - - - - - Gets or sets a collection used to generate the content for selecting the hours. - - - A collection that is used to generate the content for selecting the hours. The default is a list of interger from 0 - to 23 if is false or a list of interger from - 1 to 12 otherwise.. - - - - - Gets or sets a collection used to generate the content for selecting the minutes. - - - A collection that is used to generate the content for selecting the minutes. The default is a list of int from - 0 to 59. - - - - - Gets or sets a collection used to generate the content for selecting the seconds. - - - A collection that is used to generate the content for selecting the minutes. The default is a list of int from - 0 to 59. - - - - - Gets a value indicating whether the that is specified by the - - set by the ( if null) has not a value. - - - - - When overridden in a derived class, is invoked whenever application code or internal processes call - . - - - - - Gets the offset from the selected to use it in as hour - parameter. - - The current hour. - - An integer representing the offset to add to the hour that is selected in the hour-picker for setting the correct - . The offset is determined as follows: - - - ConditionOffset - - - is false0 - - - Selected hour is between 1 AM and 11 AM0 - - - Selected hour is 12 AM-12h - - - Selected hour is between 12 PM and 11 PM+12h - - - - - - - A control that allows the user to toggle between two states: One represents true; The other represents false. - - - - - Gets/sets the font family of the header. - - - - - Gets/sets the text to display when the control is in it's On state. - - - - - Gets/sets the text to display when the control is in it's Off state. - - - - - Gets/sets the brush used for the switch's foreground. - - - - - Gets/sets the brush used for the on-switch's foreground. - - - - - Gets/sets the brush used for the off-switch's foreground. - - - - - Gets/sets the brush used for the thumb indicator. - - - - - Gets/sets the brush used for the thumb indicator. - - - - - Gets/sets the width of the thumb indicator. - - - - - Gets/sets the control's content flow direction. - - - - - Gets/sets the control's toggle switch button style. - - - - - Gets/sets whether the control is Checked (On) or not (Off). - - - - - Gets/sets the command which will be executed if the IsChecked property was changed. - - - - - Gets/sets the command which will be executed if the checked event of the control is fired. - - - - - Gets/sets the command which will be executed if the checked event of the control is fired. - - - - - Gets/sets the command parameter which will be passed by the CheckChangedCommand. - - - - - Gets/sets the command parameter which will be passed by the CheckedCommand. - - - - - Gets/sets the command parameter which will be passed by the UnCheckedCommand. - - - - - An event that is raised when the value of IsChecked changes. - - - - - A Button that allows the user to toggle between two states. - - - - - Gets/sets the brush used for the control's foreground. - - - - - Gets/sets the brush used for the on-switch's foreground. - - - - - Gets/sets the brush used for the off-switch's foreground. - - - - - Gets/sets the brush used for the thumb indicator. - - - - - Gets/sets the brush used for the thumb indicator. - - - - - Gets/sets the width of the thumb indicator. - - - - - enumeration for the different transition types - - - - - Use the VisualState DefaultTransition - - - - - Use the VisualState Normal - - - - - Use the VisualState UpTransition - - - - - Use the VisualState DownTransition - - - - - Use the VisualState RightTransition - - - - - Use the VisualState RightReplaceTransition - - - - - Use the VisualState LeftTransition - - - - - Use the VisualState LeftReplaceTransition - - - - - Use a custom VisualState, the name must be set using CustomVisualStatesName property - - - - - A ContentControl that animates content as it loads and unloads. - - - - - Gets or sets the name of the custom transition visual state. - - - - - Gets/sets if the content is transitioning. - - - - - Reload the current transition if the content is the same. - - - - - Helper methods for UI-related tasks. - This class was obtained from Philip Sumi (a fellow WPF Disciples blog) - http://www.hardcodet.net/uploads/2009/06/UIHelper.cs - - - - - Finds a parent of a given item on the visual tree. - - The type of the queried item. - A direct or indirect child of the - queried item. - The first parent item that matches the submitted - type parameter. If not matching item can be found, a null - reference is being returned. - - - - Finds a Child of a given item in the visual tree. - - A direct parent of the queried item. - The type of the queried item. - x:Name or Name of child. - The first parent item that matches the submitted type parameter. - If not matching item can be found, - a null parent is being returned. - - - - This method is an alternative to WPF's - method, which also - supports content elements. Keep in mind that for content element, - this method falls back to the logical tree of the element! - - The item to be processed. - The submitted item's parent, if available. Otherwise - null. - - - - Analyzes both visual and logical tree in order to find all elements of a given - type that are descendants of the item. - - The type of the queried items. - The root element that marks the source of the search. If the - source is already of the requested type, it will not be included in the result. - Sometimes it's better to search in the VisualTree (e.g. in tests) - All descendants of that match the requested type. - - - - This method is an alternative to WPF's - method, which also - supports content elements. Keep in mind that for content elements, - this method falls back to the logical tree of the element. - - The item to be processed. - Sometimes it's better to search in the VisualTree (e.g. in tests) - The submitted item's child elements, if available. - - - - Tries to locate a given item within the visual tree, - starting with the dependency object at a given position. - - The type of the element to be found - on the visual tree of the element at the given location. - The main element which is used to perform - hit testing. - The position to be evaluated on the origin. - - - - Gets the relative mouse position to the given handle in client coordinates. - - The handle for this method. - - - - Try to get the relative mouse position to the given handle in client coordinates. - - The handle for this method. - - - - Gets or sets the value indicating current light style for the minimize button. - - - - - Gets or sets the value indicating current light style for the maximize button. - - - - - Gets or sets the value indicating current light style for the close button. - - - - - Gets or sets the value indicating current dark style for the minimize button. - - - - - Gets or sets the value indicating current dark style for the maximize button. - - - - - Gets or sets the value indicating current dark style for the close button. - - - - - Gets or sets the value indicating current theme. - - - - - Gets or sets the minimize button tooltip. - - - - - Gets or sets the maximize button tooltip. - - - - - Gets or sets the close button tooltip. - - - - - Gets or sets the restore button tooltip. - - - - - Gets or sets the value indicating current theme. - - - - - Gets or sets the value indicating light theme template. - - - - - Gets or sets the value indicating light theme template. - - - - - Gets or sets the value indicating whether to show the separators. - - - - - Gets or sets the value indicating whether to show the last separator. - - - - - Gets or sets the value indicating separator height. - - - - - Gets or sets the value indicating whether to show the separator. - - - - - Doesn't overlay flyouts nor a hidden TitleBar. - - - - - Overlays opened controls. - - - - - Overlays a hidden TitleBar. - - - - - Refreshes the application settings property values from persistent storage. - - - - - Upgrades the application settings on loading. - - - - - Updates application settings to reflect a more recent installation of the application. - - - - - Stores the current values of the settings properties. - - - - - this settings class is the default way to save the placement of the window - - - - - Upgrades the application settings on loading. - - - - - Determining Ideal Text Color Based on Specified Background Color - http://www.codeproject.com/KB/GDI-plus/IdealTextColor.aspx - - The bg. - - - - - Converts a double representing either hour/minute/second to the corresponding angle. - - - - - Converts the value from true to false and false to true. - - - - - Converts a String into a Visibility enumeration (and back) - The FalseEquivalent can be declared with the "FalseEquivalent" property - - - - - Initialize the properties with standard values - - - - - FalseEquivalent (default : Visibility.Collapsed => see Constructor) - - - - - Define whether the opposite boolean value is crucial (default : false) - - - - - Converts a Thickness to a new Thickness. It's possible to ignore a side With the IgnoreThicknessSide property. - - - - - Use all sides. - - - - - Ignore the left side. - - - - - Ignore the top side. - - - - - Ignore the right side. - - - - - Ignore the bottom side. - - - - Converts a value. - A converted value. If the method returns null, the valid null value is used. - The value produced by the binding source. - The type of the binding target property. - The converter parameter to use. - The culture to use in the converter. - - - Converts a value. - A converted value. If the method returns null, the valid null value is used. - The value that is produced by the binding target. - The type to convert to. - The converter parameter to use. - The culture to use in the converter. - - - - Windows Messages - Defined in winuser.h from Windows SDK v6.1 - Documentation pulled from MSDN. - - - - - The WM_NULL message performs no operation. An application sends the WM_NULL message if it wants to post a message that the recipient window will ignore. - - - - - The WM_CREATE message is sent when an application requests that a window be created by calling the CreateWindowEx or CreateWindow function. (The message is sent before the function returns.) The window procedure of the new window receives this message after the window is created, but before the window becomes visible. - - - - - The WM_DESTROY message is sent when a window is being destroyed. It is sent to the window procedure of the window being destroyed after the window is removed from the screen. - This message is sent first to the window being destroyed and then to the child windows (if any) as they are destroyed. During the processing of the message, it can be assumed that all child windows still exist. - /// - - - - The WM_MOVE message is sent after a window has been moved. - - - - - The WM_SIZE message is sent to a window after its size has changed. - - - - - The WM_ACTIVATE message is sent to both the window being activated and the window being deactivated. If the windows use the same input queue, the message is sent synchronously, first to the window procedure of the top-level window being deactivated, then to the window procedure of the top-level window being activated. If the windows use different input queues, the message is sent asynchronously, so the window is activated immediately. - - - - - The WM_SETFOCUS message is sent to a window after it has gained the keyboard focus. - - - - - The WM_KILLFOCUS message is sent to a window immediately before it loses the keyboard focus. - - - - - The WM_ENABLE message is sent when an application changes the enabled state of a window. It is sent to the window whose enabled state is changing. This message is sent before the EnableWindow function returns, but after the enabled state (WS_DISABLED style bit) of the window has changed. - - - - - An application sends the WM_SETREDRAW message to a window to allow changes in that window to be redrawn or to prevent changes in that window from being redrawn. - - - - - An application sends a WM_SETTEXT message to set the text of a window. - - - - - An application sends a WM_GETTEXT message to copy the text that corresponds to a window into a buffer provided by the caller. - - - - - An application sends a WM_GETTEXTLENGTH message to determine the length, in characters, of the text associated with a window. - - - - - The WM_PAINT message is sent when the system or another application makes a request to paint a portion of an application's window. The message is sent when the UpdateWindow or RedrawWindow function is called, or by the DispatchMessage function when the application obtains a WM_PAINT message by using the GetMessage or PeekMessage function. - - - - - The WM_CLOSE message is sent as a signal that a window or an application should terminate. - - - - - The WM_QUERYENDSESSION message is sent when the user chooses to end the session or when an application calls one of the system shutdown functions. If any application returns zero, the session is not ended. The system stops sending WM_QUERYENDSESSION messages as soon as one application returns zero. - After processing this message, the system sends the WM_ENDSESSION message with the wParam parameter set to the results of the WM_QUERYENDSESSION message. - - - - - The WM_QUERYOPEN message is sent to an icon when the user requests that the window be restored to its previous size and position. - - - - - The WM_ENDSESSION message is sent to an application after the system processes the results of the WM_QUERYENDSESSION message. The WM_ENDSESSION message informs the application whether the session is ending. - - - - - The WM_QUIT message indicates a request to terminate an application and is generated when the application calls the PostQuitMessage function. It causes the GetMessage function to return zero. - - - - - The WM_ERASEBKGND message is sent when the window background must be erased (for example, when a window is resized). The message is sent to prepare an invalidated portion of a window for painting. - - - - - This message is sent to all top-level windows when a change is made to a system color setting. - - - - - The WM_SHOWWINDOW message is sent to a window when the window is about to be hidden or shown. - - - - - An application sends the WM_WININICHANGE message to all top-level windows after making a change to the WIN.INI file. The SystemParametersInfo function sends this message after an application uses the function to change a setting in WIN.INI. - Note The WM_WININICHANGE message is provided only for compatibility with earlier versions of the system. Applications should use the WM_SETTINGCHANGE message. - - - - - An application sends the WM_WININICHANGE message to all top-level windows after making a change to the WIN.INI file. The SystemParametersInfo function sends this message after an application uses the function to change a setting in WIN.INI. - Note The WM_WININICHANGE message is provided only for compatibility with earlier versions of the system. Applications should use the WM_SETTINGCHANGE message. - - - - - The WM_DEVMODECHANGE message is sent to all top-level windows whenever the user changes device-mode settings. - - - - - The WM_ACTIVATEAPP message is sent when a window belonging to a different application than the active window is about to be activated. The message is sent to the application whose window is being activated and to the application whose window is being deactivated. - - - - - An application sends the WM_FONTCHANGE message to all top-level windows in the system after changing the pool of font resources. - - - - - A message that is sent whenever there is a change in the system time. - - - - - The WM_CANCELMODE message is sent to cancel certain modes, such as mouse capture. For example, the system sends this message to the active window when a dialog box or message box is displayed. Certain functions also send this message explicitly to the specified window regardless of whether it is the active window. For example, the EnableWindow function sends this message when disabling the specified window. - - - - - The WM_SETCURSOR message is sent to a window if the mouse causes the cursor to move within a window and mouse input is not captured. - - - - - The WM_MOUSEACTIVATE message is sent when the cursor is in an inactive window and the user presses a mouse button. The parent window receives this message only if the child window passes it to the DefWindowProc function. - - - - - The WM_CHILDACTIVATE message is sent to a child window when the user clicks the window's title bar or when the window is activated, moved, or sized. - - - - - The WM_QUEUESYNC message is sent by a computer-based training (CBT) application to separate user-input messages from other messages sent through the WH_JOURNALPLAYBACK Hook procedure. - - - - - The WM_GETMINMAXINFO message is sent to a window when the size or position of the window is about to change. An application can use this message to override the window's default maximized size and position, or its default minimum or maximum tracking size. - - - - - Windows NT 3.51 and earlier: The WM_PAINTICON message is sent to a minimized window when the icon is to be painted. This message is not sent by newer versions of Microsoft Windows, except in unusual circumstances explained in the Remarks. - - - - - Windows NT 3.51 and earlier: The WM_ICONERASEBKGND message is sent to a minimized window when the background of the icon must be filled before painting the icon. A window receives this message only if a class icon is defined for the window; otherwise, WM_ERASEBKGND is sent. This message is not sent by newer versions of Windows. - - - - - The WM_NEXTDLGCTL message is sent to a dialog box procedure to set the keyboard focus to a different control in the dialog box. - - - - - The WM_SPOOLERSTATUS message is sent from Print Manager whenever a job is added to or removed from the Print Manager queue. - - - - - The WM_DRAWITEM message is sent to the parent window of an owner-drawn button, combo box, list box, or menu when a visual aspect of the button, combo box, list box, or menu has changed. - - - - - The WM_MEASUREITEM message is sent to the owner window of a combo box, list box, list view control, or menu item when the control or menu is created. - - - - - Sent to the owner of a list box or combo box when the list box or combo box is destroyed or when items are removed by the LB_DELETESTRING, LB_RESETCONTENT, CB_DELETESTRING, or CB_RESETCONTENT message. The system sends a WM_DELETEITEM message for each deleted item. The system sends the WM_DELETEITEM message for any deleted list box or combo box item with nonzero item data. - - - - - Sent by a list box with the LBS_WANTKEYBOARDINPUT style to its owner in response to a WM_KEYDOWN message. - - - - - Sent by a list box with the LBS_WANTKEYBOARDINPUT style to its owner in response to a WM_CHAR message. - - - - - An application sends a WM_SETFONT message to specify the font that a control is to use when drawing text. - - - - - An application sends a WM_GETFONT message to a control to retrieve the font with which the control is currently drawing its text. - - - - - An application sends a WM_SETHOTKEY message to a window to associate a hot key with the window. When the user presses the hot key, the system activates the window. - - - - - An application sends a WM_GETHOTKEY message to determine the hot key associated with a window. - - - - - The WM_QUERYDRAGICON message is sent to a minimized (iconic) window. The window is about to be dragged by the user but does not have an icon defined for its class. An application can return a handle to an icon or cursor. The system displays this cursor or icon while the user drags the icon. - - - - - The system sends the WM_COMPAREITEM message to determine the relative position of a new item in the sorted list of an owner-drawn combo box or list box. Whenever the application adds a new item, the system sends this message to the owner of a combo box or list box created with the CBS_SORT or LBS_SORT style. - - - - - Active Accessibility sends the WM_GETOBJECT message to obtain information about an accessible object contained in a server application. - Applications never send this message directly. It is sent only by Active Accessibility in response to calls to AccessibleObjectFromPoint, AccessibleObjectFromEvent, or AccessibleObjectFromWindow. However, server applications handle this message. - - - - - The WM_COMPACTING message is sent to all top-level windows when the system detects more than 12.5 percent of system time over a 30- to 60-second interval is being spent compacting memory. This indicates that system memory is low. - - - - - WM_COMMNOTIFY is Obsolete for Win32-Based Applications - - - - - The WM_WINDOWPOSCHANGING message is sent to a window whose size, position, or place in the Z order is about to change as a result of a call to the SetWindowPos function or another window-management function. - - - - - The WM_WINDOWPOSCHANGED message is sent to a window whose size, position, or place in the Z order has changed as a result of a call to the SetWindowPos function or another window-management function. - - - - - Notifies applications that the system, typically a battery-powered personal computer, is about to enter a suspended mode. - Use: POWERBROADCAST - - - - - An application sends the WM_COPYDATA message to pass data to another application. - - - - - The WM_CANCELJOURNAL message is posted to an application when a user cancels the application's journaling activities. The message is posted with a NULL window handle. - - - - - Sent by a common control to its parent window when an event has occurred or the control requires some information. - - - - - The WM_INPUTLANGCHANGEREQUEST message is posted to the window with the focus when the user chooses a new input language, either with the hotkey (specified in the Keyboard control panel application) or from the indicator on the system taskbar. An application can accept the change by passing the message to the DefWindowProc function or reject the change (and prevent it from taking place) by returning immediately. - - - - - The WM_INPUTLANGCHANGE message is sent to the topmost affected window after an application's input language has been changed. You should make any application-specific settings and pass the message to the DefWindowProc function, which passes the message to all first-level child windows. These child windows can pass the message to DefWindowProc to have it pass the message to their child windows, and so on. - - - - - Sent to an application that has initiated a training card with Microsoft Windows Help. The message informs the application when the user clicks an authorable button. An application initiates a training card by specifying the HELP_TCARD command in a call to the WinHelp function. - - - - - Indicates that the user pressed the F1 key. If a menu is active when F1 is pressed, WM_HELP is sent to the window associated with the menu; otherwise, WM_HELP is sent to the window that has the keyboard focus. If no window has the keyboard focus, WM_HELP is sent to the currently active window. - - - - - The WM_USERCHANGED message is sent to all windows after the user has logged on or off. When the user logs on or off, the system updates the user-specific settings. The system sends this message immediately after updating the settings. - - - - - Determines if a window accepts ANSI or Unicode structures in the WM_NOTIFY notification message. WM_NOTIFYFORMAT messages are sent from a common control to its parent window and from the parent window to the common control. - - - - - The WM_CONTEXTMENU message notifies a window that the user clicked the right mouse button (right-clicked) in the window. - - - - - The WM_STYLECHANGING message is sent to a window when the SetWindowLong function is about to change one or more of the window's styles. - - - - - The WM_STYLECHANGED message is sent to a window after the SetWindowLong function has changed one or more of the window's styles - - - - - The WM_DISPLAYCHANGE message is sent to all windows when the display resolution has changed. - - - - - The WM_GETICON message is sent to a window to retrieve a handle to the large or small icon associated with a window. The system displays the large icon in the ALT+TAB dialog, and the small icon in the window caption. - - - - - An application sends the WM_SETICON message to associate a new large or small icon with a window. The system displays the large icon in the ALT+TAB dialog box, and the small icon in the window caption. - - - - - The WM_NCCREATE message is sent prior to the WM_CREATE message when a window is first created. - - - - - The WM_NCDESTROY message informs a window that its nonclient area is being destroyed. The DestroyWindow function sends the WM_NCDESTROY message to the window following the WM_DESTROY message. WM_DESTROY is used to free the allocated memory object associated with the window. - The WM_NCDESTROY message is sent after the child windows have been destroyed. In contrast, WM_DESTROY is sent before the child windows are destroyed. - - - - - The WM_NCCALCSIZE message is sent when the size and position of a window's client area must be calculated. By processing this message, an application can control the content of the window's client area when the size or position of the window changes. - - - - - The WM_NCHITTEST message is sent to a window when the cursor moves, or when a mouse button is pressed or released. If the mouse is not captured, the message is sent to the window beneath the cursor. Otherwise, the message is sent to the window that has captured the mouse. - - - - - The WM_NCPAINT message is sent to a window when its frame must be painted. - - - - - The WM_NCACTIVATE message is sent to a window when its nonclient area needs to be changed to indicate an active or inactive state. - - - - - The WM_GETDLGCODE message is sent to the window procedure associated with a control. By default, the system handles all keyboard input to the control; the system interprets certain types of keyboard input as dialog box navigation keys. To override this default behavior, the control can respond to the WM_GETDLGCODE message to indicate the types of input it wants to process itself. - - - - - The WM_SYNCPAINT message is used to synchronize painting while avoiding linking independent GUI threads. - - - - - The WM_NCMOUSEMOVE message is posted to a window when the cursor is moved within the nonclient area of the window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCLBUTTONDOWN message is posted when the user presses the left mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCLBUTTONUP message is posted when the user releases the left mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCLBUTTONDBLCLK message is posted when the user double-clicks the left mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCRBUTTONDOWN message is posted when the user presses the right mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCRBUTTONUP message is posted when the user releases the right mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCRBUTTONDBLCLK message is posted when the user double-clicks the right mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCMBUTTONDOWN message is posted when the user presses the middle mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCMBUTTONUP message is posted when the user releases the middle mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCMBUTTONDBLCLK message is posted when the user double-clicks the middle mouse button while the cursor is within the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCXBUTTONDOWN message is posted when the user presses the first or second X button while the cursor is in the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCXBUTTONUP message is posted when the user releases the first or second X button while the cursor is in the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_NCXBUTTONDBLCLK message is posted when the user double-clicks the first or second X button while the cursor is in the nonclient area of a window. This message is posted to the window that contains the cursor. If a window has captured the mouse, this message is not posted. - - - - - The WM_INPUT_DEVICE_CHANGE message is sent to the window that registered to receive raw input. A window receives this message through its WindowProc function. - - - - - The WM_INPUT message is sent to the window that is getting raw input. - - - - - This message filters for keyboard messages. - - - - - The WM_KEYDOWN message is posted to the window with the keyboard focus when a nonsystem key is pressed. A nonsystem key is a key that is pressed when the ALT key is not pressed. - - - - - The WM_KEYUP message is posted to the window with the keyboard focus when a nonsystem key is released. A nonsystem key is a key that is pressed when the ALT key is not pressed, or a keyboard key that is pressed when a window has the keyboard focus. - - - - - The WM_CHAR message is posted to the window with the keyboard focus when a WM_KEYDOWN message is translated by the TranslateMessage function. The WM_CHAR message contains the character code of the key that was pressed. - - - - - The WM_DEADCHAR message is posted to the window with the keyboard focus when a WM_KEYUP message is translated by the TranslateMessage function. WM_DEADCHAR specifies a character code generated by a dead key. A dead key is a key that generates a character, such as the umlaut (double-dot), that is combined with another character to form a composite character. For example, the umlaut-O character (Ö) is generated by typing the dead key for the umlaut character, and then typing the O key. - - - - - The WM_SYSKEYDOWN message is posted to the window with the keyboard focus when the user presses the F10 key (which activates the menu bar) or holds down the ALT key and then presses another key. It also occurs when no window currently has the keyboard focus; in this case, the WM_SYSKEYDOWN message is sent to the active window. The window that receives the message can distinguish between these two contexts by checking the context code in the lParam parameter. - - - - - The WM_SYSKEYUP message is posted to the window with the keyboard focus when the user releases a key that was pressed while the ALT key was held down. It also occurs when no window currently has the keyboard focus; in this case, the WM_SYSKEYUP message is sent to the active window. The window that receives the message can distinguish between these two contexts by checking the context code in the lParam parameter. - - - - - The WM_SYSCHAR message is posted to the window with the keyboard focus when a WM_SYSKEYDOWN message is translated by the TranslateMessage function. It specifies the character code of a system character key — that is, a character key that is pressed while the ALT key is down. - - - - - The WM_SYSDEADCHAR message is sent to the window with the keyboard focus when a WM_SYSKEYDOWN message is translated by the TranslateMessage function. WM_SYSDEADCHAR specifies the character code of a system dead key — that is, a dead key that is pressed while holding down the ALT key. - - - - - The WM_UNICHAR message is posted to the window with the keyboard focus when a WM_KEYDOWN message is translated by the TranslateMessage function. The WM_UNICHAR message contains the character code of the key that was pressed. - The WM_UNICHAR message is equivalent to WM_CHAR, but it uses Unicode Transformation Format (UTF)-32, whereas WM_CHAR uses UTF-16. It is designed to send or post Unicode characters to ANSI windows and it can can handle Unicode Supplementary Plane characters. - - - - - This message filters for keyboard messages. - - - - - Sent immediately before the IME generates the composition string as a result of a keystroke. A window receives this message through its WindowProc function. - - - - - Sent to an application when the IME ends composition. A window receives this message through its WindowProc function. - - - - - Sent to an application when the IME changes composition status as a result of a keystroke. A window receives this message through its WindowProc function. - - - - - The WM_INITDIALOG message is sent to the dialog box procedure immediately before a dialog box is displayed. Dialog box procedures typically use this message to initialize controls and carry out any other initialization tasks that affect the appearance of the dialog box. - - - - - The WM_COMMAND message is sent when the user selects a command item from a menu, when a control sends a notification message to its parent window, or when an accelerator keystroke is translated. - - - - - A window receives this message when the user chooses a command from the Window menu, clicks the maximize button, minimize button, restore button, close button, or moves the form. You can stop the form from moving by filtering this out. - - - - - The WM_TIMER message is posted to the installing thread's message queue when a timer expires. The message is posted by the GetMessage or PeekMessage function. - - - - - The WM_HSCROLL message is sent to a window when a scroll event occurs in the window's standard horizontal scroll bar. This message is also sent to the owner of a horizontal scroll bar control when a scroll event occurs in the control. - - - - - The WM_VSCROLL message is sent to a window when a scroll event occurs in the window's standard vertical scroll bar. This message is also sent to the owner of a vertical scroll bar control when a scroll event occurs in the control. - - - - - The WM_INITMENU message is sent when a menu is about to become active. It occurs when the user clicks an item on the menu bar or presses a menu key. This allows the application to modify the menu before it is displayed. - - - - - The WM_INITMENUPOPUP message is sent when a drop-down menu or submenu is about to become active. This allows an application to modify the menu before it is displayed, without changing the entire menu. - - - - - The WM_MENUSELECT message is sent to a menu's owner window when the user selects a menu item. - - - - - The WM_MENUCHAR message is sent when a menu is active and the user presses a key that does not correspond to any mnemonic or accelerator key. This message is sent to the window that owns the menu. - - - - - The WM_ENTERIDLE message is sent to the owner window of a modal dialog box or menu that is entering an idle state. A modal dialog box or menu enters an idle state when no messages are waiting in its queue after it has processed one or more previous messages. - - - - - The WM_MENURBUTTONUP message is sent when the user releases the right mouse button while the cursor is on a menu item. - - - - - The WM_MENUDRAG message is sent to the owner of a drag-and-drop menu when the user drags a menu item. - - - - - The WM_MENUGETOBJECT message is sent to the owner of a drag-and-drop menu when the mouse cursor enters a menu item or moves from the center of the item to the top or bottom of the item. - - - - - The WM_UNINITMENUPOPUP message is sent when a drop-down menu or submenu has been destroyed. - - - - - The WM_MENUCOMMAND message is sent when the user makes a selection from a menu. - - - - - An application sends the WM_CHANGEUISTATE message to indicate that the user interface (UI) state should be changed. - - - - - An application sends the WM_UPDATEUISTATE message to change the user interface (UI) state for the specified window and all its child windows. - - - - - An application sends the WM_QUERYUISTATE message to retrieve the user interface (UI) state for a window. - - - - - The WM_CTLCOLORMSGBOX message is sent to the owner window of a message box before Windows draws the message box. By responding to this message, the owner window can set the text and background colors of the message box by using the given display device context handle. - - - - - An edit control that is not read-only or disabled sends the WM_CTLCOLOREDIT message to its parent window when the control is about to be drawn. By responding to this message, the parent window can use the specified device context handle to set the text and background colors of the edit control. - - - - - Sent to the parent window of a list box before the system draws the list box. By responding to this message, the parent window can set the text and background colors of the list box by using the specified display device context handle. - - - - - The WM_CTLCOLORBTN message is sent to the parent window of a button before drawing the button. The parent window can change the button's text and background colors. However, only owner-drawn buttons respond to the parent window processing this message. - - - - - The WM_CTLCOLORDLG message is sent to a dialog box before the system draws the dialog box. By responding to this message, the dialog box can set its text and background colors using the specified display device context handle. - - - - - The WM_CTLCOLORSCROLLBAR message is sent to the parent window of a scroll bar control when the control is about to be drawn. By responding to this message, the parent window can use the display context handle to set the background color of the scroll bar control. - - - - - A static control, or an edit control that is read-only or disabled, sends the WM_CTLCOLORSTATIC message to its parent window when the control is about to be drawn. By responding to this message, the parent window can use the specified device context handle to set the text and background colors of the static control. - - - - - Use WM_MOUSEFIRST to specify the first mouse message. Use the PeekMessage() Function. - - - - - The WM_MOUSEMOVE message is posted to a window when the cursor moves. If the mouse is not captured, the message is posted to the window that contains the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_LBUTTONDOWN message is posted when the user presses the left mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_LBUTTONUP message is posted when the user releases the left mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_LBUTTONDBLCLK message is posted when the user double-clicks the left mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_RBUTTONDOWN message is posted when the user presses the right mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_RBUTTONUP message is posted when the user releases the right mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_RBUTTONDBLCLK message is posted when the user double-clicks the right mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_MBUTTONDOWN message is posted when the user presses the middle mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_MBUTTONUP message is posted when the user releases the middle mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_MBUTTONDBLCLK message is posted when the user double-clicks the middle mouse button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_MOUSEWHEEL message is sent to the focus window when the mouse wheel is rotated. The DefWindowProc function propagates the message to the window's parent. There should be no internal forwarding of the message, since DefWindowProc propagates it up the parent chain until it finds a window that processes it. - - - - - The WM_XBUTTONDOWN message is posted when the user presses the first or second X button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_XBUTTONUP message is posted when the user releases the first or second X button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_XBUTTONDBLCLK message is posted when the user double-clicks the first or second X button while the cursor is in the client area of a window. If the mouse is not captured, the message is posted to the window beneath the cursor. Otherwise, the message is posted to the window that has captured the mouse. - - - - - The WM_MOUSEHWHEEL message is sent to the focus window when the mouse's horizontal scroll wheel is tilted or rotated. The DefWindowProc function propagates the message to the window's parent. There should be no internal forwarding of the message, since DefWindowProc propagates it up the parent chain until it finds a window that processes it. - - - - - Use WM_MOUSELAST to specify the last mouse message. Used with PeekMessage() Function. - - - - - The WM_PARENTNOTIFY message is sent to the parent of a child window when the child window is created or destroyed, or when the user clicks a mouse button while the cursor is over the child window. When the child window is being created, the system sends WM_PARENTNOTIFY just before the CreateWindow or CreateWindowEx function that creates the window returns. When the child window is being destroyed, the system sends the message before any processing to destroy the window takes place. - - - - - The WM_ENTERMENULOOP message informs an application's main window procedure that a menu modal loop has been entered. - - - - - The WM_EXITMENULOOP message informs an application's main window procedure that a menu modal loop has been exited. - - - - - The WM_NEXTMENU message is sent to an application when the right or left arrow key is used to switch between the menu bar and the system menu. - - - - - The WM_SIZING message is sent to a window that the user is resizing. By processing this message, an application can monitor the size and position of the drag rectangle and, if needed, change its size or position. - - - - - The WM_CAPTURECHANGED message is sent to the window that is losing the mouse capture. - - - - - The WM_MOVING message is sent to a window that the user is moving. By processing this message, an application can monitor the position of the drag rectangle and, if needed, change its position. - - - - - Notifies applications that a power-management event has occurred. - - - - - Notifies an application of a change to the hardware configuration of a device or the computer. - - - - - An application sends the WM_MDICREATE message to a multiple-document interface (MDI) client window to create an MDI child window. - - - - - An application sends the WM_MDIDESTROY message to a multiple-document interface (MDI) client window to close an MDI child window. - - - - - An application sends the WM_MDIACTIVATE message to a multiple-document interface (MDI) client window to instruct the client window to activate a different MDI child window. - - - - - An application sends the WM_MDIRESTORE message to a multiple-document interface (MDI) client window to restore an MDI child window from maximized or minimized size. - - - - - An application sends the WM_MDINEXT message to a multiple-document interface (MDI) client window to activate the next or previous child window. - - - - - An application sends the WM_MDIMAXIMIZE message to a multiple-document interface (MDI) client window to maximize an MDI child window. The system resizes the child window to make its client area fill the client window. The system places the child window's window menu icon in the rightmost position of the frame window's menu bar, and places the child window's restore icon in the leftmost position. The system also appends the title bar text of the child window to that of the frame window. - - - - - An application sends the WM_MDITILE message to a multiple-document interface (MDI) client window to arrange all of its MDI child windows in a tile format. - - - - - An application sends the WM_MDICASCADE message to a multiple-document interface (MDI) client window to arrange all its child windows in a cascade format. - - - - - An application sends the WM_MDIICONARRANGE message to a multiple-document interface (MDI) client window to arrange all minimized MDI child windows. It does not affect child windows that are not minimized. - - - - - An application sends the WM_MDIGETACTIVE message to a multiple-document interface (MDI) client window to retrieve the handle to the active MDI child window. - - - - - An application sends the WM_MDISETMENU message to a multiple-document interface (MDI) client window to replace the entire menu of an MDI frame window, to replace the window menu of the frame window, or both. - - - - - The WM_ENTERSIZEMOVE message is sent one time to a window after it enters the moving or sizing modal loop. The window enters the moving or sizing modal loop when the user clicks the window's title bar or sizing border, or when the window passes the WM_SYSCOMMAND message to the DefWindowProc function and the wParam parameter of the message specifies the SC_MOVE or SC_SIZE value. The operation is complete when DefWindowProc returns. - The system sends the WM_ENTERSIZEMOVE message regardless of whether the dragging of full windows is enabled. - - - - - The WM_EXITSIZEMOVE message is sent one time to a window, after it has exited the moving or sizing modal loop. The window enters the moving or sizing modal loop when the user clicks the window's title bar or sizing border, or when the window passes the WM_SYSCOMMAND message to the DefWindowProc function and the wParam parameter of the message specifies the SC_MOVE or SC_SIZE value. The operation is complete when DefWindowProc returns. - - - - - Sent when the user drops a file on the window of an application that has registered itself as a recipient of dropped files. - - - - - An application sends the WM_MDIREFRESHMENU message to a multiple-document interface (MDI) client window to refresh the window menu of the MDI frame window. - - - - - Sent to an application when a window is activated. A window receives this message through its WindowProc function. - - - - - Sent to an application to notify it of changes to the IME window. A window receives this message through its WindowProc function. - - - - - Sent by an application to direct the IME window to carry out the requested command. The application uses this message to control the IME window that it has created. To send this message, the application calls the SendMessage function with the following parameters. - - - - - Sent to an application when the IME window finds no space to extend the area for the composition window. A window receives this message through its WindowProc function. - - - - - Sent to an application when the operating system is about to change the current IME. A window receives this message through its WindowProc function. - - - - - Sent to an application when the IME gets a character of the conversion result. A window receives this message through its WindowProc function. - - - - - Sent to an application to provide commands and request information. A window receives this message through its WindowProc function. - - - - - Sent to an application by the IME to notify the application of a key press and to keep message order. A window receives this message through its WindowProc function. - - - - - Sent to an application by the IME to notify the application of a key release and to keep message order. A window receives this message through its WindowProc function. - - - - - The WM_MOUSEHOVER message is posted to a window when the cursor hovers over the client area of the window for the period of time specified in a prior call to TrackMouseEvent. - - - - - The WM_MOUSELEAVE message is posted to a window when the cursor leaves the client area of the window specified in a prior call to TrackMouseEvent. - - - - - The WM_NCMOUSEHOVER message is posted to a window when the cursor hovers over the nonclient area of the window for the period of time specified in a prior call to TrackMouseEvent. - - - - - The WM_NCMOUSELEAVE message is posted to a window when the cursor leaves the nonclient area of the window specified in a prior call to TrackMouseEvent. - - - - - The WM_WTSSESSION_CHANGE message notifies applications of changes in session state. - - - - - An application sends a WM_CUT message to an edit control or combo box to delete (cut) the current selection, if any, in the edit control and copy the deleted text to the clipboard in CF_TEXT format. - - - - - An application sends the WM_COPY message to an edit control or combo box to copy the current selection to the clipboard in CF_TEXT format. - - - - - An application sends a WM_PASTE message to an edit control or combo box to copy the current content of the clipboard to the edit control at the current caret position. Data is inserted only if the clipboard contains data in CF_TEXT format. - - - - - An application sends a WM_CLEAR message to an edit control or combo box to delete (clear) the current selection, if any, from the edit control. - - - - - An application sends a WM_UNDO message to an edit control to undo the last operation. When this message is sent to an edit control, the previously deleted text is restored or the previously added text is deleted. - - - - - The WM_RENDERFORMAT message is sent to the clipboard owner if it has delayed rendering a specific clipboard format and if an application has requested data in that format. The clipboard owner must render data in the specified format and place it on the clipboard by calling the SetClipboardData function. - - - - - The WM_RENDERALLFORMATS message is sent to the clipboard owner before it is destroyed, if the clipboard owner has delayed rendering one or more clipboard formats. For the content of the clipboard to remain available to other applications, the clipboard owner must render data in all the formats it is capable of generating, and place the data on the clipboard by calling the SetClipboardData function. - - - - - The WM_DESTROYCLIPBOARD message is sent to the clipboard owner when a call to the EmptyClipboard function empties the clipboard. - - - - - The WM_DRAWCLIPBOARD message is sent to the first window in the clipboard viewer chain when the content of the clipboard changes. This enables a clipboard viewer window to display the new content of the clipboard. - - - - - The WM_PAINTCLIPBOARD message is sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and the clipboard viewer's client area needs repainting. - - - - - The WM_VSCROLLCLIPBOARD message is sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and an event occurs in the clipboard viewer's vertical scroll bar. The owner should scroll the clipboard image and update the scroll bar values. - - - - - The WM_SIZECLIPBOARD message is sent to the clipboard owner by a clipboard viewer window when the clipboard contains data in the CF_OWNERDISPLAY format and the clipboard viewer's client area has changed size. - - - - - The WM_ASKCBFORMATNAME message is sent to the clipboard owner by a clipboard viewer window to request the name of a CF_OWNERDISPLAY clipboard format. - - - - - The WM_CHANGECBCHAIN message is sent to the first window in the clipboard viewer chain when a window is being removed from the chain. - - - - - The WM_HSCROLLCLIPBOARD message is sent to the clipboard owner by a clipboard viewer window. This occurs when the clipboard contains data in the CF_OWNERDISPLAY format and an event occurs in the clipboard viewer's horizontal scroll bar. The owner should scroll the clipboard image and update the scroll bar values. - - - - - This message informs a window that it is about to receive the keyboard focus, giving the window the opportunity to realize its logical palette when it receives the focus. - - - - - The WM_PALETTEISCHANGING message informs applications that an application is going to realize its logical palette. - - - - - This message is sent by the OS to all top-level and overlapped windows after the window with the keyboard focus realizes its logical palette. - This message enables windows that do not have the keyboard focus to realize their logical palettes and update their client areas. - - - - - The WM_HOTKEY message is posted when the user presses a hot key registered by the RegisterHotKey function. The message is placed at the top of the message queue associated with the thread that registered the hot key. - - - - - The WM_PRINT message is sent to a window to request that it draw itself in the specified device context, most commonly in a printer device context. - - - - - The WM_PRINTCLIENT message is sent to a window to request that it draw its client area in the specified device context, most commonly in a printer device context. - - - - - The WM_APPCOMMAND message notifies a window that the user generated an application command event, for example, by clicking an application command button using the mouse or typing an application command key on the keyboard. - - - - - The WM_THEMECHANGED message is broadcast to every window following a theme change event. Examples of theme change events are the activation of a theme, the deactivation of a theme, or a transition from one theme to another. - - - - - Sent when the contents of the clipboard have changed. - - - - - The system will send a window the WM_DWMCOMPOSITIONCHANGED message to indicate that the availability of desktop composition has changed. - - - - - WM_DWMNCRENDERINGCHANGED is called when the non-client area rendering status of a window has changed. Only windows that have set the flag DWM_BLURBEHIND.fTransitionOnMaximized to true will get this message. - - - - - Sent to all top-level windows when the colorization color has changed. - - - - - WM_DWMWINDOWMAXIMIZEDCHANGE will let you know when a DWM composed window is maximized. You also have to register for this message as well. You'd have other windowd go opaque when this message is sent. - - - - - Sent to request extended title bar information. A window receives this message through its WindowProc function. - - - - - The WM_APP constant is used by applications to help define private messages, usually of the form WM_APP+X, where X is an integer value. - - - - - The WM_USER constant is used by applications to help define private messages for use by private window classes, usually of the form WM_USER+X, where X is an integer value. - - - - - An application sends the WM_CPL_LAUNCH message to Windows Control Panel to request that a Control Panel application be started. - - - - - The WM_CPL_LAUNCHED message is sent when a Control Panel application, started by the WM_CPL_LAUNCH message, has closed. The WM_CPL_LAUNCHED message is sent to the window identified by the wParam parameter of the WM_CPL_LAUNCH message that started the application. - - - - - WM_SYSTIMER is a well-known yet still undocumented message. Windows uses WM_SYSTIMER for internal actions like scrolling. - - - - The window has a thin-line border. - - - The window has a title bar (includes the WS_BORDER style). - - - The window is a child window. A window with this style cannot have a menu bar. This style cannot be used with the WS_POPUP style. - - - Excludes the area occupied by child windows when drawing occurs within the parent window. This style is used when creating the parent window. - - - - Clips child windows relative to each other; that is, when a particular child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips all other overlapping child windows out of the region of the child window to be updated. - If WS_CLIPSIBLINGS is not specified and child windows overlap, it is possible, when drawing within the client area of a child window, to draw within the client area of a neighboring child window. - - - - The window is initially disabled. A disabled window cannot receive input from the user. To change this after a window has been created, use the EnableWindow function. - - - The window has a border of a style typically used with dialog boxes. A window with this style cannot have a title bar. - - - - The window is the first control of a group of controls. The group consists of this first control and all controls defined after it, up to the next control with the WS_GROUP style. - The first control in each group usually has the WS_TABSTOP style so that the user can move from group to group. The user can subsequently change the keyboard focus from one control in the group to the next control in the group by using the direction keys. - You can turn this style on and off to change dialog box navigation. To change this style after a window has been created, use the SetWindowLong function. - - - - The window has a horizontal scroll bar. - - - The window is initially maximized. - - - The window has a maximize button. Cannot be combined with the WS_EX_CONTEXTHELP style. The WS_SYSMENU style must also be specified. - - - The window is initially minimized. - - - The window has a minimize button. Cannot be combined with the WS_EX_CONTEXTHELP style. The WS_SYSMENU style must also be specified. - - - The window is an overlapped window. An overlapped window has a title bar and a border. - - - The window is an overlapped window. - - - The window is a pop-up window. This style cannot be used with the WS_CHILD style. - - - The window is a pop-up window. The WS_CAPTION and WS_POPUPWINDOW styles must be combined to make the window menu visible. - - - The window has a sizing border. - - - The window has a window menu on its title bar. The WS_CAPTION style must also be specified. - - - - The window is a control that can receive the keyboard focus when the user presses the TAB key. - Pressing the TAB key changes the keyboard focus to the next control with the WS_TABSTOP style. - You can turn this style on and off to change dialog box navigation. To change this style after a window has been created, use the SetWindowLong function. - For user-created windows and modeless dialogs to work with tab stops, alter the message loop to call the IsDialogMessage function. - - - - The window is initially visible. This style can be turned on and off by using the ShowWindow or SetWindowPos function. - - - The window has a vertical scroll bar. - - - - Specifies that a window created with this style accepts drag-drop files. - - - - - Forces a top-level window onto the taskbar when the window is visible. - - - - - Specifies that a window has a border with a sunken edge. - - - - - Windows XP: Paints all descendants of a window in bottom-to-top painting order using double-buffering. For more information, see Remarks. This cannot be used if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Includes a question mark in the title bar of the window. When the user clicks the question mark, the cursor changes to a question mark with a pointer. If the user then clicks a child window, the child receives a WM_HELP message. The child window should pass the message to the parent window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The Help application displays a pop-up window that typically contains help for the child window. - WS_EX_CONTEXTHELP cannot be used with the WS_MAXIMIZEBOX or WS_MINIMIZEBOX styles. - - - - - The window itself contains child windows that should take part in dialog box navigation. If this style is specified, the dialog manager recurses into children of this window when performing navigation operations such as handling the TAB key, an arrow key, or a keyboard mnemonic. - - - - - Creates a window that has a double border; the window can, optionally, be created with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. - - - - - Windows 2000/XP: Creates a layered window. Note that this cannot be used for child windows. Also, this cannot be used if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Arabic and Hebrew versions of Windows 98/Me, Windows 2000/XP: Creates a window whose horizontal origin is on the right edge. Increasing horizontal values advance to the left. - - - - - Creates a window that has generic left-aligned properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading order alignment, the vertical scroll bar (if present) is to the left of the client area. For other languages, the style is ignored. - - - - - The window text is displayed using left-to-right reading-order properties. This is the default. - - - - - Creates a multiple-document interface (MDI) child window. - - - - - Windows 2000/XP: A top-level window created with this style does not become the foreground window when the user clicks it. The system does not bring this window to the foreground when the user minimizes or closes the foreground window. - To activate the window, use the SetActiveWindow or SetForegroundWindow function. - The window does not appear on the taskbar by default. To force the window to appear on the taskbar, use the WS_EX_APPWINDOW style. - - - - - Windows 2000/XP: A window created with this style does not pass its window layout to its child windows. - - - - - Specifies that a child window created with this style does not send the WM_PARENTNOTIFY message to its parent window when it is created or destroyed. - - - - - Combines the WS_EX_CLIENTEDGE and WS_EX_WINDOWEDGE styles. - - - - - Combines the WS_EX_WINDOWEDGE, WS_EX_TOOLWINDOW, and WS_EX_TOPMOST styles. - - - - - The window has generic "right-aligned" properties. This depends on the window class. This style has an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order alignment; otherwise, the style is ignored. - Using the WS_EX_RIGHT style for static or edit controls has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. - - - - - Vertical scroll bar (if present) is to the right of the client area. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading-order alignment, the window text is displayed using right-to-left reading-order properties. For other languages, the style is ignored. - - - - - Creates a window with a three-dimensional border style intended to be used for items that do not accept user input. - - - - - Creates a tool window; that is, a window intended to be used as a floating toolbar. A tool window has a title bar that is shorter than a normal title bar, and the window title is drawn using a smaller font. A tool window does not appear in the taskbar or in the dialog that appears when the user presses ALT+TAB. If a tool window has a system menu, its icon is not displayed on the title bar. However, you can display the system menu by right-clicking or by typing ALT+SPACE. - - - - - Specifies that a window created with this style should be placed above all non-topmost windows and should stay above them, even when the window is deactivated. To add or remove this style, use the SetWindowPos function. - - - - - Specifies that a window created with this style should not be painted until siblings beneath the window (that were created by the same thread) have been painted. The window appears transparent because the bits of underlying sibling windows have already been painted. - To achieve transparency without these restrictions, use the SetWindowRgn function. - - - - - Specifies that a window has a border with a raised edge. - - - - - Hides the window and activates another window. - - - - - Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time. - - - - - Activates and displays a window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when displaying the window for the first time. - - - - - Activates the window and displays it as a minimized window. - - - - - Activates the window and displays it as a maximized window. - - - - - Maximizes the specified window. - - - - - Displays a window in its most recent size and position. This value is similar to , except the window is not activated. - - - - - Activates the window and displays it in its current size and position. - - - - - Minimizes the specified window and activates the next top-level window in the z-order. - - - - - Displays the window as a minimized window. This value is similar to , except the window is not activated. - - - - - Displays the window in its current size and position. This value is similar to , except the window is not activated. - - - - - Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. An application should specify this flag when restoring a minimized window. - - - - - Invalidates the rectangle or region that you specify in lprcUpdate or hrgnUpdate. - You can set only one of these parameters to a non-NULL value. If both are NULL, RDW_INVALIDATE invalidates the entire window. - - - - Causes the OS to post a WM_PAINT message to the window regardless of whether a portion of the window is invalid. - - - - Causes the window to receive a WM_ERASEBKGND message when the window is repainted. - Specify this value in combination with the RDW_INVALIDATE value; otherwise, RDW_ERASE has no effect. - - - - - Validates the rectangle or region that you specify in lprcUpdate or hrgnUpdate. - You can set only one of these parameters to a non-NULL value. If both are NULL, RDW_VALIDATE validates the entire window. - This value does not affect internal WM_PAINT messages. - - - - Suppresses any pending WM_ERASEBKGND messages. - - - Excludes child windows, if any, from the repainting operation. - - - Includes child windows, if any, in the repainting operation. - - - Causes the affected windows, which you specify by setting the RDW_ALLCHILDREN and RDW_NOCHILDREN values, to receive WM_ERASEBKGND and WM_PAINT messages before the RedrawWindow returns, if necessary. - - - - Causes the affected windows, which you specify by setting the RDW_ALLCHILDREN and RDW_NOCHILDREN values, to receive WM_ERASEBKGND messages before RedrawWindow returns, if necessary. - The affected windows receive WM_PAINT messages at the ordinary time. - - - - Determine if 2 RECT are equal (deep compare) - - - Return the HashCode for this struct (not garanteed to be unique) - - - http://msdn.microsoft.com/en-us/library/ms182161.aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms633572%28v=vs.85%29.aspx - - - http://msdn.microsoft.com/en-us/library/dd144901%28v=VS.85%29.aspx - - - http://msdn.microsoft.com/en-us/library/dd145064%28v=VS.85%29.aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms633545(v=vs.85).aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms647486%28v=vs.85%29.aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms633528(v=vs.85).aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms647985(v=vs.85).aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms648003(v=vs.85).aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms644944(v=vs.85).aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms684175%28v=vs.85%29.aspx - - - http://msdn.microsoft.com/en-us/library/windows/desktop/ms683152%28v=vs.85%29.aspx - - - - Sets the show state and the restored, minimized, and maximized positions of the specified window. - - - A handle to the window. - - - A pointer to a WINDOWPLACEMENT structure that specifies the new show state and window positions. - - Before calling SetWindowPlacement, set the length member of the WINDOWPLACEMENT structure to sizeof(WINDOWPLACEMENT). SetWindowPlacement fails if the length member is not set correctly. - - - - If the function succeeds, the return value is nonzero. - - If the function fails, the return value is zero. To get extended error information, call GetLastError. - - - - - - Retrieves the show state and the restored, minimized, and maximized positions of the specified window. - - - A handle to the window. - - - A pointer to the WINDOWPLACEMENT structure that receives the show state and position information. - - Before calling GetWindowPlacement, set the length member to sizeof(WINDOWPLACEMENT). GetWindowPlacement fails if lpwndpl-> length is not set correctly. - - - - If the function succeeds, the return value is nonzero. - - If the function fails, the return value is zero. To get extended error information, call GetLastError. - - - - - - An object that represents the foreground color for a Metro . - - - - - The ResourceDictionary that represents this Accent. - - - - - Gets/sets the name of the Accent. - - - - - Initializes a new instance of the MahApps.Metro.Accent class. - - - - - Initializes a new instance of the MahApps.Metro.Accent class. - - The name of the new Accent. - The URI of the accent ResourceDictionary. - - - - Represents the background theme of the application. - - - - - The ResourceDictionary that represents this application theme. - - - - - Gets the name of the application theme. - - - - - A class that allows for the detection and alteration of a MetroWindow's theme and accent. - - - - - Gets a list of all of default themes. - - - - - Gets a list of all of default metro themes. - - - - - Adds an accent with the given name. - - - - true if the accent does not exists and can be added. - - - - Adds an app theme with the given name. - - - - true if the app theme does not exists and can be added. - - - - Gets app theme with the given resource dictionary. - - - AppTheme - - - - Gets app theme with the given name and theme type (light or dark). - - - AppTheme - - - - Gets the inverse of the given . - This method relies on the "Dark" or "Light" affix to be present. - - The app theme. - The inverse or null if it couldn't be found. - - Returns BaseLight, if BaseDark is given or vice versa. - Custom Themes must end with "Dark" or "Light" for this to work, for example "CustomDark" and "CustomLight". - - - - - Gets the with the given name. - - - The or null, if the app theme wasn't found - - - - Gets the with the given resource dictionary. - - - The or null, if the accent wasn't found. - - - - Determines whether the specified resource dictionary represents an . - - This might include runtime accents which do not have a resource uri. - - The resources. - true if the resource dictionary is an ; otherwise, false. - resources - - - - Gets a resource from the detected AppStyle. - - The window to check. If this is null, the Application's sources will be checked. - The key to check against. - The resource object or null, if the resource wasn't found. - - - - Change the theme for the whole application. - - - - - - - Change theme for the given window. - - - - - - - Change accent and theme for the whole application. - - The instance of Application to change. - The accent to apply. - The theme to apply. - - - - Change accent and theme for the given window. - - The Window to change. - The accent to apply. - The theme to apply. - - - - Changes the accent and theme of a ResourceDictionary directly. - - The ResourceDictionary to modify. - The accent to apply to the ResourceDictionary. - The theme to apply to the ResourceDictionary. - - - - Copies all resource keys from one resource to another. - - The source resource dictionary. - The destination resource dictionary. - - fromRD - or - toRD - - - - - Scans the window resources and returns it's accent and theme. - - - - - Scans the window resources and returns it's accent and theme. - - The Window to scan. - - - - Scans the application resources and returns it's accent and theme. - - The Application instance to scan. - - - - Scans a resources and returns it's accent and theme. - - The ResourceDictionary to check. - - - - This event fires if accent color and theme was changed - this should be using the weak event pattern, but for now it's enough - - - - - Invalidates global colors and resources. - Sometimes the ContextMenu is not changing the colors, so this will fix it. - - - - IID_IApplicationAssociationRegistration - - - IID_IConnectionPoint - - - IID_IConnectionPointContainer - - - IID_IEnumConnectionPoints - - - IID_IEnumConnections - - - IID_IEnumIDList - - - IID_IEnumObjects - - - IID_IFileDialog - - - IID_IFileDialogEvents - - - IID_IFileOpenDialog - - - IID_IFileSaveDialog - - - IID_IHTMLDocument - - - IID_IHTMLDocument2 - - - IID_IModalWindow - - - IID_IObjectArray - - - IID_IObjectCollection - - - IID_IPropertyNotifySink - - - IID_IPropertyStore - - - IID_IServiceProvider - - - IID_IShellFolder - - - IID_IShellLink - - - IID_IShellItem - - - IID_IShellItem2 - - - IID_IShellItemArray - - - IID_ITaskbarList - - - IID_ITaskbarList2 - - - IID_IUnknown - - - IID_IWebBrowser2 - - - DIID_DWebBrowserEvents - - - IID_DWebBrowserEvents2 - - - IID_IWICBitmapDecoder - - - IID_IWICBitmapFlipRotator - - - IID_IWICBitmapFrameDecode - - - IID_IWICBitmap - - - IID_IWICBitmapSource - - - IID_IWICFormatConverter - - - IID_IWICImagingFactory - - - IID_IWICStream - - - IID_IApplicationDestinations - - - IID_IApplicationDocumentLists - - - IID_ICustomDestinationList - - - IID_IObjectWithAppUserModelID - - - IID_IObjectWithProgID - - - IID_ITaskbarList3 - - - IID_ITaskbarList4 - - - SID_SWebBrowserApp - - - CLSID_ApplicationAssociationRegistration - IID_IApplicationAssociationRegistration - - - CLSID_DragDropHelper - - - CLSID_FileOpenDialog - IID_IFileOpenDialog - - - CLSID_FileSaveDialog - IID_IFileSaveDialog - - - CLSID_TaskbarList - IID_ITaskbarList - - - CLSID_EnumerableObjectCollection - IID_IEnumObjects. - - - CLSID_ShellLink - IID_IShellLink - - - CLSID_WICImagingFactory - - - CLSID_DestinationList - IID_ICustomDestinationList - - - CLSID_ApplicationDestinations - IID_IApplicationDestinations - - - CLSID_ApplicationDocumentLists - IID_IApplicationDocumentLists - - - A static class for verifying assumptions. - - - A function signature for Assert.Evaluate. - - - A function signature for Assert.Implies. - Returns the truth of a predicate. - - - - Executes the specified argument. - - The function to execute. - - - Obsolete: Use Standard.Assert.AreEqual instead of Assert.Equals - The generic type to compare for equality. - The first generic type data to compare. This is is the expected value. - The second generic type data to compare. This is the actual value. - - - - Verifies that two generic type data are equal. The assertion fails if they are not. - - The generic type to compare for equality. - The first generic type data to compare. This is is the expected value. - The second generic type data to compare. This is the actual value. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that two generic type data are not equal. The assertion fails if they are. - - The generic type to compare for inequality. - The first generic type data to compare. This is is the value that's not expected. - The second generic type data to compare. This is the actual value. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that if the specified condition is true, then so is the result. - The assertion fails if the condition is true but the result is false. - - if set to true [condition]. - - A second Boolean statement. If the first was true then so must this be. - If the first statement was false then the value of this is ignored. - - This breaks into the debugger in the case of a failed assertion. - - - - Lazy evaluation overload. Verifies that if a condition is true, then so is a secondary value. - - The conditional value. - A function to be evaluated for truth if the condition argument is true. - - This overload only evaluates the result if the first condition is true. - - - - - Verifies that a string has content. I.e. it is not null and it is not empty. - - The string to verify. - - - - Verifies that a string has content. I.e. it is not null and it is not purely whitespace. - - The string to verify. - - - - Verifies the specified value is not null. The assertion fails if it is. - - The generic reference type. - The value to check for nullness. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that the specified condition is false. The assertion fails if it is true. - - The expression that should be false. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that the specified condition is false. The assertion fails if it is true. - - The expression that should be false. - The message to display if the condition is true. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that the specified condition is true. The assertion fails if it is not. - - A condition that is expected to be true. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that the specified condition is true. The assertion fails if it is not. - - A condition that is expected to be true. - The message to write in case the condition is false. - This breaks into the debugger in the case of a failed assertion. - - - - This line should never be executed. The assertion always fails. - - This breaks into the debugger in the case of a failed assertion. - - - - This line should never be executed. The assertion always fails. - - The message to display if this function is executed. - This breaks into the debugger in the case of a failed assertion. - - - - Verifies that the specified object is null. The assertion fails if it is not. - - The item to verify is null. - - - - Verifies that the specified value is within the expected range. The assertion fails if it isn't. - - The lower bound inclusive value. - The value to verify. - The upper bound inclusive value. - - - - Verifies that the specified value is within the expected range. The assertion fails if it isn't. - - The lower bound inclusive value. - The value to verify. - The upper bound exclusive value. - - - - Verify the current thread's apartment state is what's expected. The assertion fails if it isn't - - - The expected apartment state for the current thread. - - This breaks into the debugger in the case of a failed assertion. - - - - DoubleUtil uses fixed eps to provide fuzzy comparison functionality for doubles. - Note that FP noise is a big problem and using any of these compare - methods is not a complete solution, but rather the way to reduce - the probability of repeating unnecessary work. - - - - - Epsilon - more or less random, more or less small number. - - - - - AreClose returns whether or not two doubles are "close". That is, whether or - not they are within epsilon of each other. - There are plenty of ways for this to return false even for numbers which - are theoretically identical, so no code calling this should fail to work if this - returns false. - - The first double to compare. - The second double to compare. - The result of the AreClose comparision. - - - - LessThan returns whether or not the first double is less than the second double. - That is, whether or not the first is strictly less than *and* not within epsilon of - the other number. - There are plenty of ways for this to return false even for numbers which - are theoretically identical, so no code calling this should fail to work if this - returns false. - - The first double to compare. - The second double to compare. - The result of the LessThan comparision. - - - - GreaterThan returns whether or not the first double is greater than the second double. - That is, whether or not the first is strictly greater than *and* not within epsilon of - the other number. - There are plenty of ways for this to return false even for numbers which - are theoretically identical, so no code calling this should fail to work if this - returns false. - - The first double to compare. - The second double to compare. - The result of the GreaterThan comparision. - - - - LessThanOrClose returns whether or not the first double is less than or close to - the second double. That is, whether or not the first is strictly less than or within - epsilon of the other number. - There are plenty of ways for this to return false even for numbers which - are theoretically identical, so no code calling this should fail to work if this - returns false. - - The first double to compare. - The second double to compare. - The result of the LessThanOrClose comparision. - - - - GreaterThanOrClose returns whether or not the first double is greater than or close to - the second double. That is, whether or not the first is strictly greater than or within - epsilon of the other number. - There are plenty of ways for this to return false even for numbers which - are theoretically identical, so no code calling this should fail to work if this - returns false. - - The first double to compare. - The second double to compare. - The result of the GreaterThanOrClose comparision. - - - - Test to see if a double is a finite number (is not NaN or Infinity). - - The value to test. - Whether or not the value is a finite number. - - - - Test to see if a double a valid size value (is finite and > 0). - - The value to test. - Whether or not the value is a valid size value. - - - - Convert a point in device independent pixels (1/96") to a point in the system coordinates. - - A point in the logical coordinate system. - Returns the parameter converted to the system's coordinates. - - - - Convert a point in system coordinates to a point in device independent pixels (1/96"). - - A point in the physical coordinate system. - Returns the parameter converted to the device independent coordinate system. - - - - Wrapper for common Win32 status codes. - - - - The operation completed successfully. - - - Incorrect function. - - - The system cannot find the file specified. - - - The system cannot find the path specified. - - - The system cannot open the file. - - - Access is denied. - - - The handle is invalid. - - - Not enough storage is available to complete this operation. - - - There are no more files. - - - The process cannot access the file because it is being used by another process. - - - The parameter is incorrect. - - - The data area passed to a system call is too small. - - - Cannot nest calls to LoadModule. - - - Illegal operation attempted on a registry key that has been marked for deletion. - - - Element not found. - - - There was no match for the specified key in the index. - - - An invalid device was specified. - - - The operation was canceled by the user. - - - Cannot find window class. - - - The window class was already registered. - - - The specified datatype is invalid. - - - - Create a new Win32 error. - - The integer value of the error. - - - Performs HRESULT_FROM_WIN32 conversion. - The Win32 error being converted to an HRESULT. - The equivilent HRESULT value. - - - Performs HRESULT_FROM_WIN32 conversion. - The equivilent HRESULT value. - - - Performs the equivalent of Win32's GetLastError() - A Win32Error instance with the result of the native GetLastError - - - - Compare two Win32 error codes for equality. - - The first error code to compare. - The second error code to compare. - Whether the two error codes are the same. - - - - Compare two Win32 error codes for inequality. - - The first error code to compare. - The second error code to compare. - Whether the two error codes are not the same. - - - FACILITY_NULL - - - FACILITY_RPC - - - FACILITY_DISPATCH - - - FACILITY_STORAGE - - - FACILITY_ITF - - - FACILITY_WIN32 - - - FACILITY_WINDOWS - - - FACILITY_CONTROL - - - MSDN doced facility code for ESE errors. - - - FACILITY_WINCODEC (WIC) - - - Wrapper for HRESULT status codes. - - - S_OK - - - S_FALSE - - - E_PENDING - - - E_NOTIMPL - - - E_NOINTERFACE - - - E_POINTER - - - E_ABORT - - - E_FAIL - - - E_UNEXPECTED - - - STG_E_INVALIDFUNCTION - - - REGDB_E_CLASSNOTREG - - - DESTS_E_NO_MATCHING_ASSOC_HANDLER. Win7 internal error code for Jump Lists. - There is no Assoc Handler for the given item registered by the specified application. - - - DESTS_E_NORECDOCS. Win7 internal error code for Jump Lists. - The given item is excluded from the recent docs folder by the NoRecDocs bit on its registration. - - - DESTS_E_NOTALLCLEARED. Win7 internal error code for Jump Lists. - Not all of the items were successfully cleared - - - E_ACCESSDENIED - Win32Error ERROR_ACCESS_DENIED. - - - E_OUTOFMEMORY - Win32Error ERROR_OUTOFMEMORY. - - - E_INVALIDARG - Win32Error ERROR_INVALID_PARAMETER. - - - INTSAFE_E_ARITHMETIC_OVERFLOW - - - COR_E_OBJECTDISPOSED - - - WC_E_GREATERTHAN - - - WC_E_SYNTAX - - - - Create an HRESULT from an integer value. - - - - - - Convert an HRESULT to an int. Used for COM interface declarations out of our control. - - - - - retrieve HRESULT_FACILITY - - - - - retrieve HRESULT_CODE - - - - - Get a string representation of this HRESULT. - - - - - - Convert the result of Win32 GetLastError() into a raised exception. - - - - - HIGHCONTRAST flags - - - - - DROPIMAGE_* - - - - - BITMAPINFOHEADER Compression type. BI_*. - - - - - CombingRgn flags. RGN_* - - - - - Creates the intersection of the two combined regions. - - - - - Creates the union of two combined regions. - - - - - Creates the union of two combined regions except for any overlapping areas. - - - - - Combines the parts of hrgnSrc1 that are not part of hrgnSrc2. - - - - - Creates a copy of the region identified by hrgnSrc1. - - - - - For IWebBrowser2. OLECMDEXECOPT_* - - - - - For IWebBrowser2. OLECMDF_* - - - - - For IWebBrowser2. OLECMDID_* - - - - - For IWebBrowser2. READYSTATE_* - - - - - DATAOBJ_GET_ITEM_FLAGS. DOGIF_*. - - - - Use the system default, which is to display all error dialog boxes. - - - - The system does not display the critical-error-handler message box. - Instead, the system sends the error to the calling process. - - - - - 64-bit Windows: The system automatically fixes memory alignment faults and makes them - invisible to the application. It does this for the calling process and any descendant processes. - After this value is set for a process, subsequent attempts to clear the value are ignored. - - - - - The system does not display the general-protection-fault message box. - This flag should only be set by debugging applications that handle general - protection (GP) faults themselves with an exception handler. - - - - - The system does not display a message box when it fails to find a file. - Instead, the error is returned to the calling process. - - - - - Non-client hit test values, HT* - - - - - GetClassLongPtr values, GCLP_* - - - - - GetWindowLongPtr values, GWL_* - - - - - SystemMetrics. SM_* - - - - - SystemParameterInfo values, SPI_* - - - - - SystemParameterInfo flag values, SPIF_* - - - - - CS_* - - - - - WindowStyle values, WS_* - - - - - Window message values, WM_* - - - - - Window style extended values, WS_EX_* - - - - - GetDeviceCaps nIndex values. - - - - Number of bits per pixel - - - - - Number of planes - - - - - Logical pixels inch in X - - - - - Logical pixels inch in Y - - - - - "FILEOP_FLAGS", FOF_*. - - - - - EnableMenuItem uEnable values, MF_* - - - - - Possible return value for EnableMenuItem - - - - Specifies the type of visual style attribute to set on a window. - - - Non-client area window attributes will be set. - - - - DWMFLIP3DWINDOWPOLICY. DWMFLIP3D_* - - - - - DWMNCRENDERINGPOLICY. DWMNCRP_* - - - - - DWMWINDOWATTRIBUTE. DWMWA_* - - - - - WindowThemeNonClientAttributes - - - - Prevents the window caption from being drawn. - - - Prevents the system icon from being drawn. - - - Prevents the system icon menu from appearing. - - - Prevents mirroring of the question mark, even in right-to-left (RTL) layout. - - - A mask that contains all the valid bits. - - - - SetWindowPos options - - - - - ShowWindow options - - - - - SCF_ISSECURE - - - - - GDI+ Status codes - - - - - MSGFLT_*. New in Vista. Realiased in Windows 7. - - - - - Shell_NotifyIcon messages. NIM_* - - - - - SHAddToRecentDocuments flags. SHARD_* - - - - - Shell_NotifyIcon flags. NIF_* - - - - - Vista only. - - - - - Vista only. - - - - - Shell_NotifyIcon info flags. NIIF_* - - - - XP SP2 and later. - - - XP and later. - - - Vista and later. - - - Windows 7 and later - - - XP and later. Native version called NIIF_ICON_MASK. - - - - AC_* - - - - - The state of the icon. There are two flags that can be set independently. - NIS_HIDDEN = 1. The icon is hidden. - NIS_SHAREDICON = 2. The icon is shared. - - - - The idlist for the shell item that should be added to the recent docs folder. - - - The id of the application that should be associated with this recent doc. - - - Defines options that are used to set window visual style attributes. - - - - A combination of flags that modify window visual style attributes. - Can be a combination of the WTNCA constants. - - - - - A bitmask that describes how the values specified in dwFlags should be applied. - If the bit corresponding to a value in dwFlags is 0, that flag will be removed. - If the bit is 1, the flag will be added. - - - - Width of left border that retains its size. - - - Width of right border that retains its size. - - - Height of top border that retains its size. - - - Height of bottom border that retains its size. - - - - initialize this field using: Marshal.SizeOf(typeof(APPBARDATA)); - - - - Delegate declaration that matches native WndProc signatures. - - - Delegate declaration that matches managed WndProc signatures. - - - - Sets attributes to control how visual styles are applied to a specified window. - - - Handle to a window to apply changes to. - - - Value of type WINDOWTHEMEATTRIBUTETYPE that specifies the type of attribute to set. - The value of this parameter determines the type of data that should be passed in the pvAttribute parameter. - Can be the following value: - WTA_NONCLIENT (Specifies non-client related attributes). - pvAttribute must be a pointer of type WTA_OPTIONS. - - - A pointer that specifies attributes to set. Type is determined by the value of the eAttribute value. - - - Specifies the size, in bytes, of the data pointed to by pvAttribute. - - - - Overload of SystemParametersInfo for getting and setting NONCLIENTMETRICS. - - - Overload of SystemParametersInfo for getting and setting HIGHCONTRAST. - - - - Sets the User Model AppID for the current process, enabling Windows to retrieve this ID - - - - - - Retrieves the User Model AppID that has been explicitly set for the current process via SetCurrentProcessExplicitAppUserModelID - - - - - ASSOCIATIONLEVEL, AL_* - - - ASSOCIATIONTYPE, AT_* - - - FileDialog AddPlace options. FDAP_* - - - IFileDialog options. FOS_* - - - FDE_OVERWRITE_RESPONSE. FDEOR_* - - - FDE_SHAREVIOLATION_RESPONSE. FDESVR_* - - - ShellItem attribute flags. SIATTRIBFLAGS_* - - - - Flags for SetTabProperties. STPF_* - - The native enum was called STPFLAG. - - - - Flags for Setting Taskbar Progress state. TBPF_* - - - The native enum was called TBPFLAG. - - - - - THUMBBUTTON mask. THB_* - - - - - THUMBBUTTON flags. THBF_* - - - - - GetPropertyStoreFlags. GPS_*. - - - These are new for Vista, but are used in downlevel components - - - - - KNOWNDESTCATEGORY. KDC_* - - - - Objects can be copied - DROPEFFECT_COPY - - - Objects can be moved - DROPEFFECT_MOVE - - - Objects can be linked - - DROPEFFECT_LINK. - - If this bit is set on an item in the shell folder, a - 'Create Shortcut' menu item will be added to the File - menu and context menus for the item. If the user selects - that command, your IContextMenu::InvokeCommand() will be called - with 'link'. - That flag will also be used to determine if 'Create Shortcut' - should be added when the item in your folder is dragged to another - folder. - - - - supports BindToObject(IID_IStorage) - - - Objects can be renamed - - - Objects can be deleted - - - Objects have property sheets - - - Objects are drop target - - - Object is encrypted (use alt color) - - - 'Slow' object - - - Ghosted icon - - - Shortcut (link) - - - Shared - - - Read-only - - - Hidden object - - - May contain children with SFGAO_FILESYSTEM - - - Support BindToObject(IID_IShellFolder) - - - Is a win32 file system object (file/folder/root) - - - May contain children with SFGAO_FOLDER (may be slow) - - - Invalidate cached information (may be slow) - - - Is this removeable media? - - - Object is compressed (use alt color) - - - Supports IShellFolder, but only implements CreateViewObject() (non-folder view) - - - Is a non-enumerated object (should be hidden) - - - Should show bold in explorer tree - - - Obsolete - - - Obsolete - - - Supports BindToObject(IID_IStream) - - - May contain children with SFGAO_STORAGE or SFGAO_STREAM - - - For determining storage capabilities, ie for open/save semantics - - - - Attributes that are masked out for PKEY_SFGAOFlags because they are considered - to cause slow calculations or lack context - (SFGAO_VALIDATE | SFGAO_ISSLOW | SFGAO_HASSUBFOLDER and others) - - - - - IShellFolder::EnumObjects grfFlags bits. Also called SHCONT - - - - - IShellFolder::GetDisplayNameOf/SetNameOf uFlags. Also called SHGDNF. - - - For compatibility with SIGDN, these bits must all sit in the LOW word. - - - - - SHELLITEMCOMPAREHINTF. SICHINT_*. - - - - iOrder based on display in a folder view - - - exact instance compare - - - iOrder based on canonical name (better performance) - - - - ShellItem enum. SIGDN_*. - - - - - STR_GPS_* - - - When requesting a property store through IShellFolder, you can specify the equivalent of - GPS_DEFAULT by passing in a null IBindCtx parameter. - - You can specify the equivalent of GPS_READWRITE by passing a mode of STGM_READWRITE | STGM_EXCLUSIVE - in the bind context - - Here are the string versions of GPS_ flags, passed to IShellFolder::BindToObject() via IBindCtx::RegisterObjectParam() - These flags are valid when requesting an IPropertySetStorage or IPropertyStore handler - - The meaning of these flags are described above. - - There is no STR_ equivalent for GPS_TEMPORARY because temporary property stores - are provided by IShellItem2 only -- not by the underlying IShellFolder. - - - - - WPARAM value for a THUMBBUTTON being clicked. - - - - fmtid - - - pid - - - PKEY_Title - - - PKEY_AppUserModel_ID - - - PKEY_AppUserModel_IsDestListSeparator - - - PKEY_AppUserModel_RelaunchCommand - - - PKEY_AppUserModel_RelaunchDisplayNameResource - - - PKEY_AppUserModel_RelaunchIconResource - - - Unknown Object Array - - - - Shell Namespace helper - - - - - Shell Namespace helper 2 - - - - - This function must be called first to validate use of other members. - - - - - This function adds a tab for hwnd to the taskbar. - - The HWND for which to add the tab. - - - - This function deletes a tab for hwnd from the taskbar. - - The HWND for which the tab is to be deleted. - - - - This function activates the tab associated with hwnd on the taskbar. - - The HWND for which the tab is to be actuvated. - - - - This function marks hwnd in the taskbar as the active tab. - - The HWND to activate. - - - - Marks a window as full-screen. - - The handle of the window to be marked. - A Boolean value marking the desired full-screen status of the window. - - Setting the value of fFullscreen to true, the Shell treats this window as a full-screen window, and the taskbar - is moved to the bottom of the z-order when this window is active. Setting the value of fFullscreen to false - removes the full-screen marking, but does not cause the Shell to treat the window as though it were - definitely not full-screen. With a false fFullscreen value, the Shell depends on its automatic detection facility - to specify how the window should be treated, possibly still flagging the window as full-screen. - - - - - Allows an application to retrieve the most recent and frequent documents opened in that app, as reported via SHAddToRecentDocs - - - - - Set the App User Model ID for the application retrieving this list. If an AppID is not provided via this method, - the system will use a heuristically determined ID. This method must be called before GetList. - - App Id. - - - - Retrieve an IEnumObjects or IObjectArray for IShellItems and/or IShellLinks. - Items may appear in both the frequent and recent lists. - - - - - - Provides access to the App User Model ID on objects supporting this value. - - - - - Provides access to the ProgID associated with an object - - - - - Wraps an IStream interface pointer from COM into a form consumable by .Net. - - - This implementation is immutable, though it's possible that the underlying - stream can be changed in another context. - - - - - Wraps a native IStream interface into a CLR Stream subclass. - - - The stream that this object wraps. - - - Note that the parameter is passed by ref. On successful creation it is - zeroed out to the caller. This object becomes responsible for the lifetime - management of the wrapped IStream. - - - - - Wraps a managed stream instance into an interface pointer consumable by COM. - - - - - Initializes a new instance of the ManagedIStream class with the specified managed Stream object. - - - The stream that this IStream reference is wrapping. - - - - - Creates a new stream object with its own seek pointer that - references the same bytes as the original stream. - - - When this method returns, contains the new stream object. This parameter is passed uninitialized. - - - For more information, see the existing documentation for IStream::Clone in the MSDN library. - This class doesn't implement Clone. A COMException is thrown if it is used. - - - - - Ensures that any changes made to a stream object that is open in transacted - mode are reflected in the parent storage. - - - A value that controls how the changes for the stream object are committed. - - - For more information, see the existing documentation for IStream::Commit in the MSDN library. - - - - - Copies a specified number of bytes from the current seek pointer in the - stream to the current seek pointer in another stream. - - - A reference to the destination stream. - - - The number of bytes to copy from the source stream. - - - On successful return, contains the actual number of bytes read from the source. - (Note the native signature is to a ULARGE_INTEGER*, so 64 bits are written - to this parameter on success.) - - - On successful return, contains the actual number of bytes written to the destination. - (Note the native signature is to a ULARGE_INTEGER*, so 64 bits are written - to this parameter on success.) - - - - - Restricts access to a specified range of bytes in the stream. - - - The byte offset for the beginning of the range. - - - The length of the range, in bytes, to restrict. - - - The requested restrictions on accessing the range. - - - For more information, see the existing documentation for IStream::LockRegion in the MSDN library. - This class doesn't implement LockRegion. A COMException is thrown if it is used. - - - - - Reads a specified number of bytes from the stream object into memory starting at the current seek pointer. - - - When this method returns, contains the data read from the stream. This parameter is passed uninitialized. - - - The number of bytes to read from the stream object. - - - A pointer to a ULONG variable that receives the actual number of bytes read from the stream object. - - - For more information, see the existing documentation for ISequentialStream::Read in the MSDN library. - - - - - Discards all changes that have been made to a transacted stream since the last Commit call. - - - This class doesn't implement Revert. A COMException is thrown if it is used. - - - - - Changes the seek pointer to a new location relative to the beginning of the - stream, to the end of the stream, or to the current seek pointer. - - - The displacement to add to dwOrigin. - - - The origin of the seek. The origin can be the beginning of the file, the current seek pointer, or the end of the file. - - - On successful return, contains the offset of the seek pointer from the beginning of the stream. - (Note the native signature is to a ULARGE_INTEGER*, so 64 bits are written - to this parameter on success.) - - - For more information, see the existing documentation for IStream::Seek in the MSDN library. - - - - - Changes the size of the stream object. - - - The new size of the stream as a number of bytes. - - - For more information, see the existing documentation for IStream::SetSize in the MSDN library. - - - - - Retrieves the STATSTG structure for this stream. - - - When this method returns, contains a STATSTG structure that describes this stream object. - This parameter is passed uninitialized. - - - Members in the STATSTG structure that this method does not return, thus saving some memory allocation operations. - - - - - Removes the access restriction on a range of bytes previously restricted with the LockRegion method. - - The byte offset for the beginning of the range. - - - The length, in bytes, of the range to restrict. - - - The access restrictions previously placed on the range. - - - For more information, see the existing documentation for IStream::UnlockRegion in the MSDN library. - This class doesn't implement UnlockRegion. A COMException is thrown if it is used. - - - - - Writes a specified number of bytes into the stream object starting at the current seek pointer. - - - The buffer to write this stream to. - - - The number of bytes to write to the stream. - - - On successful return, contains the actual number of bytes written to the stream object. - If the caller sets this pointer to null, this method does not provide the actual number - of bytes written. - - - - - Releases resources controlled by this object. - - - Dispose can be called multiple times, but trying to use the object - after it has been disposed will generally throw ObjectDisposedExceptions. - - - - - Wrapper around File.Copy to provide feedback as to whether the file wasn't copied because it didn't exist. - - - - - - Simple guard against the exceptions that File.Delete throws on null and empty strings. - - The path to delete. Unlike File.Delete, this can be null or empty. - - Note that File.Delete, and by extension SafeDeleteFile, does not throw an exception - if the file does not exist. - - - - - Utility to help classes catenate their properties for implementing ToString(). - - The StringBuilder to catenate the results into. - The name of the property to be catenated. - The value of the property to be catenated. - - - - Generates ToString functionality for a struct. This is an expensive way to do it, - it exists for the sake of debugging while classes are in flux. - Eventually this should just be removed and the classes should - do this without reflection. - - - - - - - - Encodes a URL string. Duplicated functionality from System.Web.HttpUtility.UrlEncode. - - - - - Duplicated from System.Web.HttpUtility because System.Web isn't part of the client profile. - URL Encoding replaces ' ' with '+' and unsafe ASCII characters with '%XX'. - Safe characters are defined in RFC2396 (http://www.ietf.org/rfc/rfc2396.txt). - They are the 7-bit ASCII alphanumerics and the mark characters "-_.!~*'()". - This implementation does not treat '~' as a safe character to be consistent with the System.Web version. - - - - GDI's DeleteObject - - - GDI+'s DisposeImage - - - - From a list of BitmapFrames find the one that best matches the requested dimensions. - The methods used here are copied from Win32 sources. We want to be consistent with - system behaviors. - - - Convert a native integer that represent a color with an alpha channel into a Color struct. - The integer that represents the color. Its bits are of the format 0xAARRGGBB. - A Color representation of the parameter. - - - - A static class for retail validated assertions. - Instead of breaking into the debugger an exception is thrown. - - - - - Ensure that the current thread's apartment state is what's expected. - - - The required apartment state for the current thread. - - - The message string for the exception to be thrown if the state is invalid. - - - Thrown if the calling thread's apartment state is not the same as the requiredState. - - - - - Ensure that an argument is neither null nor empty. - - The string to validate. - The name of the parameter that will be presented if an exception is thrown. - - - - Ensure that an argument is neither null nor does it consist only of whitespace. - - The string to validate. - The name of the parameter that will be presented if an exception is thrown. - - - Verifies that an argument is not null. - Type of the object to validate. Must be a class. - The object to validate. - The name of the parameter that will be presented if an exception is thrown. - - - Verifies that an argument is not null. - Type of the object to validate. Must be a class. - The object to validate. - The name of the parameter that will be presented if an exception is thrown. - - - Verifies that an argument is null. - Type of the object to validate. Must be a class. - The object to validate. - The name of the parameter that will be presented if an exception is thrown. - - - - Verifies the specified statement is true. Throws an ArgumentException if it's not. - - The statement to be verified as true. - Name of the parameter to include in the ArgumentException. - The message to include in the ArgumentException. - - - - Verifies that the specified value is within the expected range. The assertion fails if it isn't. - - The lower bound inclusive value. - The value to verify. - The upper bound exclusive value. - The name of the parameter that caused the current exception. - - - Display the system menu at a specified location. - The MetroWindow - The location to display the system menu, in logical screen coordinates. - - - - Private constructor. The public way to access this class is through the static Current property. - - - - The extent of the top of the window to treat as the caption. - - - Dependency property for IgnoreTaskbarOnMaximize - - - - If this property is true and the attached window's WindowStyle=None then when the window is maximized it will cover the entire - monitor, including the taskbar. - - - - - Is this using WPF4? - - - There are a few specific bugs in Window in 3.5SP1 and below that require workarounds - when handling WM_NCCALCSIZE on the HWND. - - - - The Window that's chrome is being modified. - - - Underlying HWND for the _window. - - Critical : Critical member - - - - Underlying HWND for the _window. - - Critical : Critical member provides access to HWND's window messages which are critical - - - - Object that describes the current modifications being made to the chrome. - - - - Critical : Store critical methods in critical callback table - Safe : Demands full trust permissions - - - - - Critical : Calls critical methods - Safe : Demands full trust permissions - - - - - Critical : Calls critical methods - Safe : Demands full trust permissions - - - - - Critical : Calls critical methods - Safe : Demands full trust permissions - - - - - Critical : Calls critical methods - - - - - Critical : Store critical methods in critical callback table - Safe : Demands full trust permissions - - - - - Critical : References critical methods - - - - - Critical : Store critical methods in critical callback table - Safe : Demands full trust permissions - - - - - Critical : Accesses critical _hwnd field - Safe : Demands full trust permissions - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Store critical methods in critical callback table - Safe : Demands full trust permissions - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical method - - - - A borderless window lost his animation, with this we bring it back. - - - - Critical : Accesses critical _hwnd - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - This method handles the window size if the taskbar is set to auto-hide. - - - Critical : Calls critical methods - - - - - Critical : Calls critical Marshal.PtrToStructure - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical method - - - - - Critical : Calls critical method - - - - - Critical : Calls critical Marshal.PtrToStructure - - - - - Critical : Calls critical Marshal.PtrToStructure - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - Add and remove a native WindowStyle from the HWND. - The styles to be removed. These can be bitwise combined. - The styles to be added. These can be bitwise combined. - Whether the styles of the HWND were modified as a result of this call. - - Critical : Calls critical methods - - - - - Get the WindowState as the native HWND knows it to be. This isn't necessarily the same as what Window thinks. - - - Critical : Calls critical methods - - - - - Get the bounding rectangle for the window in physical coordinates. - - The bounding rectangle for the window. - - Critical : Calls critical methods - - - - - Update the items in the system menu based on the current, or assumed, WindowState. - - - The state to assume that the Window is in. This can be null to query the Window's state. - - - We want to update the menu while we have some control over whether the caption will be repainted. - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - Matrix of the HT values to return when responding to NC window messages. - - - - - Critical : Calls critical methods - - - - - Critical : Unsubscribes event handler from critical _hwndSource - - - - - Critical : Unsubscribes critical event handler - - - - - Critical : Calls critical methods - - - - - Critical : Calls critical methods - - - - - GeneratedInternalTypeHelper - - - - - CreateInstance - - - - - GetPropertyValue - - - - - SetPropertyValue - - - - - CreateDelegate - - - - - AddEventHandler - - - - diff --git a/distribution/NAudio.dll b/distribution/NAudio.dll deleted file mode 100644 index 9425d40..0000000 Binary files a/distribution/NAudio.dll and /dev/null differ diff --git a/distribution/NAudio.xml b/distribution/NAudio.xml deleted file mode 100644 index 4d26c0e..0000000 --- a/distribution/NAudio.xml +++ /dev/null @@ -1,22883 +0,0 @@ - - - - NAudio - - - - - a-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts an a-law encoded byte to a 16 bit linear sample - - a-law encoded byte - Linear sample - - - - A-law encoder - - - - - Encodes a single 16 bit sample to a-law - - 16 bit PCM sample - a-law encoded byte - - - - SpanDSP - a series of DSP components for telephony - - g722_decode.c - The ITU G.722 codec, decode part. - - Written by Steve Underwood <steveu@coppice.org> - - Copyright (C) 2005 Steve Underwood - Ported to C# by Mark Heath 2011 - - Despite my general liking of the GPL, I place my own contributions - to this code in the public domain for the benefit of all mankind - - even the slimy ones who might try to proprietize my work and use it - to my detriment. - - Based in part on a single channel G.722 codec which is: - Copyright (c) CMU 1993 - Computer Science, Speech Group - Chengxiang Lu and Alex Hauptmann - - - - - hard limits to 16 bit samples - - - - - Decodes a buffer of G722 - - Codec state - Output buffer (to contain decompressed PCM samples) - - Number of bytes in input G722 data to decode - Number of samples written into output buffer - - - - Encodes a buffer of G722 - - Codec state - Output buffer (to contain encoded G722) - PCM 16 bit samples to encode - Number of samples in the input buffer to encode - Number of encoded bytes written into output buffer - - - - Stores state to be used between calls to Encode or Decode - - - - - ITU Test Mode - TRUE if the operating in the special ITU test mode, with the band split filters disabled. - - - - - TRUE if the G.722 data is packed - - - - - 8kHz Sampling - TRUE if encode from 8k samples/second - - - - - Bits Per Sample - 6 for 48000kbps, 7 for 56000kbps, or 8 for 64000kbps. - - - - - Signal history for the QMF (x) - - - - - Band - - - - - In bit buffer - - - - - Number of bits in InBuffer - - - - - Out bit buffer - - - - - Number of bits in OutBuffer - - - - - Creates a new instance of G722 Codec State for a - new encode or decode session - - Bitrate (typically 64000) - Special options - - - - Band data for G722 Codec - - - - s - - - sp - - - sz - - - r - - - a - - - ap - - - p - - - d - - - b - - - bp - - - sg - - - nb - - - det - - - - G722 Flags - - - - - None - - - - - Using a G722 sample rate of 8000 - - - - - Packed - - - - - mu-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts a mu-law encoded byte to a 16 bit linear sample - - mu-law encoded byte - Linear sample - - - - mu-law encoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - Encodes a single 16 bit sample to mu-law - - 16 bit PCM sample - mu-law encoded byte - - - - Audio Capture Client - - - - - Gets a pointer to the buffer - - Pointer to the buffer - - - - Gets a pointer to the buffer - - Number of frames to read - Buffer flags - Pointer to the buffer - - - - Gets the size of the next packet - - - - - Release buffer - - Number of frames written - - - - Release the COM object - - - - - Windows CoreAudio AudioClient - - - - - Retrieves the stream format that the audio engine uses for its internal processing of shared-mode streams. - Can be called before initialize - - - - - Initializes the Audio Client - - Share Mode - Stream Flags - Buffer Duration - Periodicity - Wave Format - Audio Session GUID (can be null) - - - - Retrieves the size (maximum capacity) of the audio buffer associated with the endpoint. (must initialize first) - - - - - Retrieves the maximum latency for the current stream and can be called any time after the stream has been initialized. - - - - - Retrieves the number of frames of padding in the endpoint buffer (must initialize first) - - - - - Retrieves the length of the periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer. - (can be called before initialize) - - - - - Gets the minimum device period - (can be called before initialize) - - - - - Returns the AudioStreamVolume service for this AudioClient. - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Gets the AudioClockClient service - - - - - Gets the AudioRenderClient service - - - - - Gets the AudioCaptureClient service - - - - - Determines whether if the specified output format is supported - - The share mode. - The desired format. - True if the format is supported - - - - Determines if the specified output format is supported in shared mode - - Share Mode - Desired Format - Output The closest match format. - True if the format is supported - - - - Starts the audio stream - - - - - Stops the audio stream. - - - - - Set the Event Handle for buffer synchro. - - The Wait Handle to setup - - - - Resets the audio stream - Reset is a control method that the client calls to reset a stopped audio stream. - Resetting the stream flushes all pending data and resets the audio clock stream - position to 0. This method fails if it is called on a stream that is not stopped - - - - - Dispose - - - - - Audio Client Buffer Flags - - - - - None - - - - - AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY - - - - - AUDCLNT_BUFFERFLAGS_SILENT - - - - - AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR - - - - - The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream. - - http://msdn.microsoft.com/en-us/library/windows/desktop/hh968105(v=vs.85).aspx - - - - The size of the buffer for the audio stream. - - - - - Boolean value to indicate whether or not the audio stream is hardware-offloaded - - - - - An enumeration that is used to specify the category of the audio stream. - - - - - A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later. - - - - - AUDCLNT_SHAREMODE - - - - - AUDCLNT_SHAREMODE_SHARED, - - - - - AUDCLNT_SHAREMODE_EXCLUSIVE - - - - - AUDCLNT_STREAMFLAGS - - - - - None - - - - - AUDCLNT_STREAMFLAGS_CROSSPROCESS - - - - - AUDCLNT_STREAMFLAGS_LOOPBACK - - - - - AUDCLNT_STREAMFLAGS_EVENTCALLBACK - - - - - AUDCLNT_STREAMFLAGS_NOPERSIST - - - - - Defines values that describe the characteristics of an audio stream. - - - - - No stream options. - - - - - The audio stream is a 'raw' stream that bypasses all signal processing except for endpoint specific, always-on processing in the APO, driver, and hardware. - - - - - Audio Clock Client - - - - - Characteristics - - - - - Frequency - - - - - Get Position - - - - - Adjusted Position - - - - - Can Adjust Position - - - - - Dispose - - - - - Audio Endpoint Volume Channel - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - Volume Level - - - - - Volume Level Scalar - - - - - Audio Endpoint Volume Channels - - - - - Channel Count - - - - - Indexer - get a specific channel - - - - - Audio Endpoint Volume Notifiaction Delegate - - Audio Volume Notification Data - - - - Audio Endpoint Volume Step Information - - - - - Step - - - - - StepCount - - - - - Audio Endpoint Volume Volume Range - - - - - Minimum Decibels - - - - - Maximum Decibels - - - - - Increment Decibels - - - - - Audio Meter Information Channels - - - - - Metering Channel Count - - - - - Get Peak value - - Channel index - Peak value - - - - Audio Render Client - - - - - Gets a pointer to the buffer - - Number of frames requested - Pointer to the buffer - - - - Release buffer - - Number of frames written - Buffer flags - - - - Release the COM object - - - - - AudioSessionControl object for information - regarding an audio session - - - - - Constructor. - - - - - - Dispose - - - - - Finalizer - - - - - Audio meter information of the audio session. - - - - - Simple audio volume of the audio session (for volume and mute status). - - - - - The current state of the audio session. - - - - - The name of the audio session. - - - - - the path to the icon shown in the mixer. - - - - - The session identifier of the audio session. - - - - - The session instance identifier of the audio session. - - - - - The process identifier of the audio session. - - - - - Is the session a system sounds session. - - - - - the grouping param for an audio session grouping - - - - - - For chanigng the grouping param and supplying the context of said change - - - - - - - Registers an even client for callbacks - - - - - - Unregisters an event client from receiving callbacks - - - - - - AudioSessionEvents callback implementation - - - - - Constructor. - - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - AudioSessionManager - - Designed to manage audio sessions and in particuar the - SimpleAudioVolume interface to adjust a session volume - - - - - Session created delegate - - - - - Occurs when audio session has been added (for example run another program that use audio playback). - - - - - SimpleAudioVolume object - for adjusting the volume for the user session - - - - - AudioSessionControl object - for registring for callbacks and other session information - - - - - Refresh session of current device. - - - - - Returns list of sessions of current device. - - - - - Dispose. - - - - - Finalizer. - - - - - Specifies the category of an audio stream. - - - - - Other audio stream. - - - - - Media that will only stream when the app is in the foreground. - - - - - Media that can be streamed when the app is in the background. - - - - - Real-time communications, such as VOIP or chat. - - - - - Alert sounds. - - - - - Sound effects. - - - - - Game sound effects. - - - - - Background audio for games. - - - - - Manages the AudioStreamVolume for the . - - - - - Verify that the channel index is valid. - - - - - - - Return the current stream volumes for all channels - - An array of volume levels between 0.0 and 1.0 for each channel in the audio stream. - - - - Returns the current number of channels in this audio stream. - - - - - Return the current volume for the requested channel. - - The 0 based index into the channels. - The volume level for the channel between 0.0 and 1.0. - - - - Set the volume level for each channel of the audio stream. - - An array of volume levels (between 0.0 and 1.0) one for each channel. - - A volume level MUST be supplied for reach channel in the audio stream. - - - Thrown when does not contain elements. - - - - - Sets the volume level for one channel in the audio stream. - - The 0-based index into the channels to adjust the volume of. - The volume level between 0.0 and 1.0 for this channel of the audio stream. - - - - Dispose - - - - - Release/cleanup objects during Dispose/finalization. - - True if disposing and false if being finalized. - - - - Audio Volume Notification Data - - - - - Event Context - - - - - Muted - - - - - Guid that raised the event - - - - - Master Volume - - - - - Channels - - - - - Channel Volume - - - - - Audio Volume Notification Data - - - - - - - - - - Audio Client WASAPI Error Codes (HResult) - - - - - AUDCLNT_E_NOT_INITIALIZED - - - - - AUDCLNT_E_UNSUPPORTED_FORMAT - - - - - AUDCLNT_E_DEVICE_IN_USE - - - - - AUDCLNT_E_RESOURCES_INVALIDATED - - - - - Defined in AudioClient.h - - - - - Defined in AudioClient.h - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier for the audio session. - - Receives the session identifier. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier of the audio session instance. - - Receives the identifier of a particular instance. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the process identifier of the audio session. - - Receives the process identifier of the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Indicates whether the session is a system sounds session. - - An HRESULT code indicating whether the operation succeeded of failed. - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Defines constants that indicate the current state of an audio session. - - - MSDN Reference: http://msdn.microsoft.com/en-us/library/dd370792.aspx - - - - - The audio session is inactive. - - - - - The audio session is active. - - - - - The audio session has expired. - - - - - Defines constants that indicate a reason for an audio session being disconnected. - - - MSDN Reference: Unknown - - - - - The user removed the audio endpoint device. - - - - - The Windows audio service has stopped. - - - - - The stream format changed for the device that the audio session is connected to. - - - - - The user logged off the WTS session that the audio session was running in. - - - - - The WTS session that the audio session was running in was disconnected. - - - - - The (shared-mode) audio session was disconnected to make the audio endpoint device available for an exclusive-mode connection. - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - interface to receive session related events - - - - - notification of volume changes including muting of audio session - - the current volume - the current mute state, true muted, false otherwise - - - - notification of display name changed - - the current display name - - - - notification of icon path changed - - the current icon path - - - - notification of the client that the volume level of an audio channel in the session submix has changed - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - - - - notification of the client that the grouping parameter for the session has changed - - >The new grouping parameter for the session. - - - - notification of the client that the stream-activity state of the session has changed - - The new session state. - - - - notification of the client that the session has been disconnected - - The reason that the audio session was disconnected. - - - - Windows CoreAudio IAudioSessionManager interface - Defined in AudioPolicy.h - - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionNotification interface - Defined in AudioPolicy.h - - - - - - - session being added - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio ISimpleAudioVolume interface - Defined in AudioClient.h - - - - - Sets the master volume level for the audio session. - - The new volume level expressed as a normalized value between 0.0 and 1.0. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the client volume level for the audio session. - - Receives the volume level expressed as a normalized value between 0.0 and 1.0. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Sets the muting state for the audio session. - - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the current muting state for the audio session. - - Receives the muting state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Representation of binary large object container. - - - - - Length of binary object. - - - - - Pointer to buffer storing data. - - - - - is defined in WTypes.h - - - - - Windows CoreAudio IAudioClient interface - Defined in AudioClient.h - - - - - The GetBufferSize method retrieves the size (maximum capacity) of the endpoint buffer. - - - - - The GetService method accesses additional services from the audio client object. - - The interface ID for the requested service. - Pointer to a pointer variable into which the method writes the address of an instance of the requested interface. - - - - defined in MMDeviceAPI.h - - - - - IMMNotificationClient - - - - - Device State Changed - - - - - Device Added - - - - - Device Removed - - - - - Default Device Changed - - - - - Property Value Changed - - - - - - - is defined in propsys.h - - - - - implements IMMDeviceEnumerator - - - - - MMDevice STGM enumeration - - - - - Read-only access mode. - - - - - Write-only access mode. - - - - - Read-write access mode. - - - - - from Propidl.h. - http://msdn.microsoft.com/en-us/library/aa380072(VS.85).aspx - contains a union so we have to do an explicit layout - - - - - Value type tag. - - - - - Reserved1. - - - - - Reserved2. - - - - - Reserved3. - - - - - cVal. - - - - - bVal. - - - - - iVal. - - - - - uiVal. - - - - - lVal. - - - - - ulVal. - - - - - intVal. - - - - - uintVal. - - - - - hVal. - - - - - uhVal. - - - - - fltVal. - - - - - dblVal. - - - - - boolVal. - - - - - scode. - - - - - Date time. - - - - - Binary large object. - - - - - Pointer value. - - - - - Creates a new PropVariant containing a long value - - - - - Helper method to gets blob data - - - - - Interprets a blob as an array of structs - - - - - Gets the type of data in this PropVariant - - - - - Property value - - - - - allows freeing up memory, might turn this into a Dispose method? - - - - - Clears with a known pointer - - - - - Multimedia Device Collection - - - - - Device count - - - - - Get device by index - - Device index - Device at the specified index - - - - Get Enumerator - - Device enumerator - - - - Property Keys - - - - - PKEY_DeviceInterface_FriendlyName - - - - - PKEY_AudioEndpoint_FormFactor - - - - - PKEY_AudioEndpoint_ControlPanelPageProvider - - - - - PKEY_AudioEndpoint_Association - - - - - PKEY_AudioEndpoint_PhysicalSpeakers - - - - - PKEY_AudioEndpoint_GUID - - - - - PKEY_AudioEndpoint_Disable_SysFx - - - - - PKEY_AudioEndpoint_FullRangeSpeakers - - - - - PKEY_AudioEndpoint_Supports_EventDriven_Mode - - - - - PKEY_AudioEndpoint_JackSubType - - - - - PKEY_AudioEngine_DeviceFormat - - - - - PKEY_AudioEngine_OEMFormat - - - - - PKEY _Devie_FriendlyName - - - - - PKEY _Device_IconPath - - - - - Device description property. - - - - - Id of controller device for endpoint device property. - - - - - Device interface key property. - - - - - Collection of sessions. - - - - - Returns session at index. - - - - - - - Number of current sessions. - - - - - Windows CoreAudio SimpleAudioVolume - - - - - Creates a new Audio endpoint volume - - ISimpleAudioVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Allows the user to adjust the volume from - 0.0 to 1.0 - - - - - Mute - - - - - Represents state of a capture device - - - - - Not recording - - - - - Beginning to record - - - - - Recording in progress - - - - - Requesting stop - - - - - Audio Capture using Wasapi - See http://msdn.microsoft.com/en-us/library/dd370800%28VS.85%29.aspx - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - Length of the audio buffer in milliseconds. A lower value means lower latency but increased CPU usage. - - - - Share Mode - set before calling StartRecording - - - - - Current Capturing State - - - - - Capturing wave format - - - - - Gets the default audio capture device - - The default audio capture device - - - - To allow overrides to specify different flags (e.g. loopback) - - - - - Start Capturing - - - - - Stop Capturing (requests a stop, wait for RecordingStopped event to know it has finished) - - - - - Dispose - - - - - Audio Endpoint Volume - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - On Volume Notification - - - - - Volume Range - - - - - Hardware Support - - - - - Step Information - - - - - Channels - - - - - Master Volume Level - - - - - Master Volume Level Scalar - - - - - Mute - - - - - Volume Step Up - - - - - Volume Step Down - - - - - Creates a new Audio endpoint volume - - IAudioEndpointVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Audio Meter Information - - - - - Peak Values - - - - - Hardware Support - - - - - Master Peak Value - - - - - Device State - - - - - DEVICE_STATE_ACTIVE - - - - - DEVICE_STATE_DISABLED - - - - - DEVICE_STATE_NOTPRESENT - - - - - DEVICE_STATE_UNPLUGGED - - - - - DEVICE_STATEMASK_ALL - - - - - Endpoint Hardware Support - - - - - Volume - - - - - Mute - - - - - Meter - - - - - The EDataFlow enumeration defines constants that indicate the direction - in which audio data flows between an audio endpoint device and an application - - - - - Audio rendering stream. - Audio data flows from the application to the audio endpoint device, which renders the stream. - - - - - Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, - to the application - - - - - Audio rendering or capture stream. Audio data can flow either from the application to the audio - endpoint device, or from the audio endpoint device to the application. - - - - - PROPERTYKEY is defined in wtypes.h - - - - - Format ID - - - - - Property ID - - - - - - - - - - - The ERole enumeration defines constants that indicate the role - that the system has assigned to an audio endpoint device - - - - - Games, system notification sounds, and voice commands. - - - - - Music, movies, narration, and live music recording - - - - - Voice communications (talking to another person). - - - - - MM Device - - - - - Initializes the device's property store. - - The storage-access mode to open store for. - Administrative client is required for Write and ReadWrite modes. - - - - Audio Client - - - - - Audio Meter Information - - - - - Audio Endpoint Volume - - - - - AudioSessionManager instance - - - - - Properties - - - - - Friendly name for the endpoint - - - - - Friendly name of device - - - - - Icon path of device - - - - - Device ID - - - - - Data Flow - - - - - Device State - - - - - To string - - - - - Dispose - - - - - Finalizer - - - - - MM Device Enumerator - - - - - Creates a new MM Device Enumerator - - - - - Enumerate Audio Endpoints - - Desired DataFlow - State Mask - Device Collection - - - - Get Default Endpoint - - Data Flow - Role - Device - - - - Check to see if a default audio end point exists without needing an exception. - - Data Flow - Role - True if one exists, and false if one does not exist. - - - - Get device by ID - - Device ID - Device - - - - Registers a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - Unregisters a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - - - - Called to dispose/finalize contained objects. - - True if disposing, false if called from a finalizer. - - - - Property Store class, only supports reading properties at the moment. - - - - - Property Count - - - - - Gets property by index - - Property index - The property - - - - Contains property guid - - Looks for a specific key - True if found - - - - Indexer by guid - - Property Key - Property or null if not found - - - - Gets property key at sepecified index - - Index - Property key - - - - Gets property value at specified index - - Index - Property value - - - - Sets property value at specified key. - - Key of property to set. - Value to write. - - - - Saves a property change. - - - - - Creates a new property store - - IPropertyStore COM interface - - - - Property Store Property - - - - - Property Key - - - - - Property Value - - - - - Envelope generator (ADSR) - - - - - Envelope State - - - - - Idle - - - - - Attack - - - - - Decay - - - - - Sustain - - - - - Release - - - - - Creates and Initializes an Envelope Generator - - - - - Attack Rate (seconds * SamplesPerSecond) - - - - - Decay Rate (seconds * SamplesPerSecond) - - - - - Release Rate (seconds * SamplesPerSecond) - - - - - Sustain Level (1 = 100%) - - - - - Sets the attack curve - - - - - Sets the decay release curve - - - - - Read the next volume multiplier from the envelope generator - - A volume multiplier - - - - Trigger the gate - - If true, enter attack phase, if false enter release phase (unless already idle) - - - - Current envelope state - - - - - Reset to idle state - - - - - Get the current output level - - - - - Fully managed resampler, based on Cockos WDL Resampler - - - - - Creates a new Resampler - - - - - sets the mode - if sinc set, it overrides interp or filtercnt - - - - - Sets the filter parameters - used for filtercnt>0 but not sinc - - - - - Set feed mode - - if true, that means the first parameter to ResamplePrepare will specify however much input you have, not how much you want - - - - Reset - - - - - Prepare - note that it is safe to call ResamplePrepare without calling ResampleOut (the next call of ResamplePrepare will function as normal) - nb inbuffer was WDL_ResampleSample **, returning a place to put the in buffer, so we return a buffer and offset - - req_samples is output samples desired if !wantInputDriven, or if wantInputDriven is input samples that we have - - - - returns number of samples desired (put these into *inbuffer) - - - - SMB Pitch Shifter - - - - - Pitch Shift - - - - - Pitch Shift - - - - - Short Time Fourier Transform - - - - - BiQuad filter - - - - - Passes a single sample through the filter - - Input sample - Output sample - - - - Set this up as a low pass filter - - Sample Rate - Cut-off Frequency - Bandwidth - - - - Set this up as a peaking EQ - - Sample Rate - Centre Frequency - Bandwidth (Q) - Gain in decibels - - - - Set this as a high pass filter - - - - - Create a low pass filter - - - - - Create a High pass filter - - - - - Create a bandpass filter with constant skirt gain - - - - - Create a bandpass filter with constant peak gain - - - - - Creates a notch filter - - - - - Creaes an all pass filter - - - - - Create a Peaking EQ - - - - - H(s) = A * (s^2 + (sqrt(A)/Q)*s + A)/(A*s^2 + (sqrt(A)/Q)*s + 1) - - - - a "shelf slope" parameter (for shelving EQ only). - When S = 1, the shelf slope is as steep as it can be and remain monotonically - increasing or decreasing gain with frequency. The shelf slope, in dB/octave, - remains proportional to S for all other values for a fixed f0/Fs and dBgain. - Gain in decibels - - - - H(s) = A * (A*s^2 + (sqrt(A)/Q)*s + 1)/(s^2 + (sqrt(A)/Q)*s + A) - - - - - - - - - - Type to represent complex number - - - - - Real Part - - - - - Imaginary Part - - - - - Summary description for FastFourierTransform. - - - - - This computes an in-place complex-to-complex FFT - x and y are the real and imaginary arrays of 2^m points. - - - - - Applies a Hamming Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hamming window - - - - Applies a Hann Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hann window - - - - Applies a Blackman-Harris Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Blackmann-Harris window - - - - Summary description for ImpulseResponseConvolution. - - - - - A very simple mono convolution algorithm - - - This will be very slow - - - - - This is actually a downwards normalize for data that will clip - - - - - http://tech.ebu.ch/docs/tech/tech3306-2009.pdf - - - - - WaveFormat - - - - - Data Chunk Position - - - - - Data Chunk Length - - - - - Riff Chunks - - - - - Represents an entry in a Cakewalk drum map - - - - - User customisable note name - - - - - Input MIDI note number - - - - - Output MIDI note number - - - - - Output port - - - - - Output MIDI Channel - - - - - Velocity adjustment - - - - - Velocity scaling - in percent - - - - - Describes this drum map entry - - - - - Represents a Cakewalk Drum Map file (.map) - - - - - Parses a Cakewalk Drum Map file - - Path of the .map file - - - - The drum mappings in this drum map - - - - - Describes this drum map - - - - - MP3 Frame decompressor using the Windows Media MP3 Decoder DMO object - - - - - Initializes a new instance of the DMO MP3 Frame decompressor - - - - - - Converted PCM WaveFormat - - - - - Decompress a single frame of MP3 - - - - - Alerts us that a reposition has occured so the MP3 decoder needs to reset its state - - - - - Dispose of this obejct and clean up resources - - - - - Audio Subtype GUIDs - http://msdn.microsoft.com/en-us/library/windows/desktop/aa372553%28v=vs.85%29.aspx - - - - - Advanced Audio Coding (AAC). - - - - - Not used - - - - - Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF). - - - - - Encrypted audio data used with secure audio path. - - - - - Digital Theater Systems (DTS) audio. - - - - - Uncompressed IEEE floating-point audio. - - - - - MPEG Audio Layer-3 (MP3). - - - - - MPEG-1 audio payload. - - - - - Windows Media Audio 9 Voice codec. - - - - - Uncompressed PCM audio. - - - - - Windows Media Audio 9 Professional codec over S/PDIF. - - - - - Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec. - - - - - Dolby Digital (AC-3). - - - - - MPEG-4 and AAC Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - μ-law coding - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Adaptive delta pulse code modulation (ADPCM) - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Dolby Digital Plus formatted for HDMI output. - http://msdn.microsoft.com/en-us/library/windows/hardware/ff538392(v=vs.85).aspx - Reference : internet - - - - - MSAudio1 - unknown meaning - Reference : wmcodecdsp.h - - - - - IMA ADPCM ACM Wrapper - - - - - WMSP2 - unknown meaning - Reference: wmsdkidl.h - - - - - Creates an instance of either the sink writer or the source reader. - - - - - Creates an instance of the sink writer or source reader, given a URL. - - - - - Creates an instance of the sink writer or source reader, given an IUnknown pointer. - - - - - CLSID_MFReadWriteClassFactory - - - - - Media Foundation Errors - - - - RANGES - 14000 - 14999 = General Media Foundation errors - 15000 - 15999 = ASF parsing errors - 16000 - 16999 = Media Source errors - 17000 - 17999 = MEDIAFOUNDATION Network Error Events - 18000 - 18999 = MEDIAFOUNDATION WMContainer Error Events - 19000 - 19999 = MEDIAFOUNDATION Media Sink Error Events - 20000 - 20999 = Renderer errors - 21000 - 21999 = Topology Errors - 25000 - 25999 = Timeline Errors - 26000 - 26999 = Unused - 28000 - 28999 = Transform errors - 29000 - 29999 = Content Protection errors - 40000 - 40999 = Clock errors - 41000 - 41999 = MF Quality Management Errors - 42000 - 42999 = MF Transcode API Errors - - - - - MessageId: MF_E_PLATFORM_NOT_INITIALIZED - - MessageText: - - Platform not initialized. Please call MFStartup().%0 - - - - - MessageId: MF_E_BUFFERTOOSMALL - - MessageText: - - The buffer was too small to carry out the requested action.%0 - - - - - MessageId: MF_E_INVALIDREQUEST - - MessageText: - - The request is invalid in the current state.%0 - - - - - MessageId: MF_E_INVALIDSTREAMNUMBER - - MessageText: - - The stream number provided was invalid.%0 - - - - - MessageId: MF_E_INVALIDMEDIATYPE - - MessageText: - - The data specified for the media type is invalid, inconsistent, or not supported by this object.%0 - - - - - MessageId: MF_E_NOTACCEPTING - - MessageText: - - The callee is currently not accepting further input.%0 - - - - - MessageId: MF_E_NOT_INITIALIZED - - MessageText: - - This object needs to be initialized before the requested operation can be carried out.%0 - - - - - MessageId: MF_E_UNSUPPORTED_REPRESENTATION - - MessageText: - - The requested representation is not supported by this object.%0 - - - - - MessageId: MF_E_NO_MORE_TYPES - - MessageText: - - An object ran out of media types to suggest therefore the requested chain of streaming objects cannot be completed.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SERVICE - - MessageText: - - The object does not support the specified service.%0 - - - - - MessageId: MF_E_UNEXPECTED - - MessageText: - - An unexpected error has occurred in the operation requested.%0 - - - - - MessageId: MF_E_INVALIDNAME - - MessageText: - - Invalid name.%0 - - - - - MessageId: MF_E_INVALIDTYPE - - MessageText: - - Invalid type.%0 - - - - - MessageId: MF_E_INVALID_FILE_FORMAT - - MessageText: - - The file does not conform to the relevant file format specification. - - - - - MessageId: MF_E_INVALIDINDEX - - MessageText: - - Invalid index.%0 - - - - - MessageId: MF_E_INVALID_TIMESTAMP - - MessageText: - - An invalid timestamp was given.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SCHEME - - MessageText: - - The scheme of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_BYTESTREAM_TYPE - - MessageText: - - The byte stream type of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_TIME_FORMAT - - MessageText: - - The given time format is unsupported.%0 - - - - - MessageId: MF_E_NO_SAMPLE_TIMESTAMP - - MessageText: - - The Media Sample does not have a timestamp.%0 - - - - - MessageId: MF_E_NO_SAMPLE_DURATION - - MessageText: - - The Media Sample does not have a duration.%0 - - - - - MessageId: MF_E_INVALID_STREAM_DATA - - MessageText: - - The request failed because the data in the stream is corrupt.%0\n. - - - - - MessageId: MF_E_RT_UNAVAILABLE - - MessageText: - - Real time services are not available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE - - MessageText: - - The specified rate is not supported.%0 - - - - - MessageId: MF_E_THINNING_UNSUPPORTED - - MessageText: - - This component does not support stream-thinning.%0 - - - - - MessageId: MF_E_REVERSE_UNSUPPORTED - - MessageText: - - The call failed because no reverse playback rates are available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE_TRANSITION - - MessageText: - - The requested rate transition cannot occur in the current state.%0 - - - - - MessageId: MF_E_RATE_CHANGE_PREEMPTED - - MessageText: - - The requested rate change has been pre-empted and will not occur.%0 - - - - - MessageId: MF_E_NOT_FOUND - - MessageText: - - The specified object or value does not exist.%0 - - - - - MessageId: MF_E_NOT_AVAILABLE - - MessageText: - - The requested value is not available.%0 - - - - - MessageId: MF_E_NO_CLOCK - - MessageText: - - The specified operation requires a clock and no clock is available.%0 - - - - - MessageId: MF_S_MULTIPLE_BEGIN - - MessageText: - - This callback and state had already been passed in to this event generator earlier.%0 - - - - - MessageId: MF_E_MULTIPLE_BEGIN - - MessageText: - - This callback has already been passed in to this event generator.%0 - - - - - MessageId: MF_E_MULTIPLE_SUBSCRIBERS - - MessageText: - - Some component is already listening to events on this event generator.%0 - - - - - MessageId: MF_E_TIMER_ORPHANED - - MessageText: - - This timer was orphaned before its callback time arrived.%0 - - - - - MessageId: MF_E_STATE_TRANSITION_PENDING - - MessageText: - - A state transition is already pending.%0 - - - - - MessageId: MF_E_UNSUPPORTED_STATE_TRANSITION - - MessageText: - - The requested state transition is unsupported.%0 - - - - - MessageId: MF_E_UNRECOVERABLE_ERROR_OCCURRED - - MessageText: - - An unrecoverable error has occurred.%0 - - - - - MessageId: MF_E_SAMPLE_HAS_TOO_MANY_BUFFERS - - MessageText: - - The provided sample has too many buffers.%0 - - - - - MessageId: MF_E_SAMPLE_NOT_WRITABLE - - MessageText: - - The provided sample is not writable.%0 - - - - - MessageId: MF_E_INVALID_KEY - - MessageText: - - The specified key is not valid. - - - - - MessageId: MF_E_BAD_STARTUP_VERSION - - MessageText: - - You are calling MFStartup with the wrong MF_VERSION. Mismatched bits? - - - - - MessageId: MF_E_UNSUPPORTED_CAPTION - - MessageText: - - The caption of the given URL is unsupported.%0 - - - - - MessageId: MF_E_INVALID_POSITION - - MessageText: - - The operation on the current offset is not permitted.%0 - - - - - MessageId: MF_E_ATTRIBUTENOTFOUND - - MessageText: - - The requested attribute was not found.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_ALLOWED - - MessageText: - - The specified property type is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_SUPPORTED - - MessageText: - - The specified property type is not supported.%0 - - - - - MessageId: MF_E_PROPERTY_EMPTY - - MessageText: - - The specified property is empty.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_EMPTY - - MessageText: - - The specified property is not empty.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_NOT_ALLOWED - - MessageText: - - The vector property specified is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_REQUIRED - - MessageText: - - A vector property is required in this context.%0 - - - - - MessageId: MF_E_OPERATION_CANCELLED - - MessageText: - - The operation is cancelled.%0 - - - - - MessageId: MF_E_BYTESTREAM_NOT_SEEKABLE - - MessageText: - - The provided bytestream was expected to be seekable and it is not.%0 - - - - - MessageId: MF_E_DISABLED_IN_SAFEMODE - - MessageText: - - The Media Foundation platform is disabled when the system is running in Safe Mode.%0 - - - - - MessageId: MF_E_CANNOT_PARSE_BYTESTREAM - - MessageText: - - The Media Source could not parse the byte stream.%0 - - - - - MessageId: MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS - - MessageText: - - Mutually exclusive flags have been specified to source resolver. This flag combination is invalid.%0 - - - - - MessageId: MF_E_MEDIAPROC_WRONGSTATE - - MessageText: - - MediaProc is in the wrong state%0 - - - - - MessageId: MF_E_RT_THROUGHPUT_NOT_AVAILABLE - - MessageText: - - Real time I/O service can not provide requested throughput.%0 - - - - - MessageId: MF_E_RT_TOO_MANY_CLASSES - - MessageText: - - The workqueue cannot be registered with more classes.%0 - - - - - MessageId: MF_E_RT_WOULDBLOCK - - MessageText: - - This operation cannot succeed because another thread owns this object.%0 - - - - - MessageId: MF_E_NO_BITPUMP - - MessageText: - - Internal. Bitpump not found.%0 - - - - - MessageId: MF_E_RT_OUTOFMEMORY - - MessageText: - - No more RT memory available.%0 - - - - - MessageId: MF_E_RT_WORKQUEUE_CLASS_NOT_SPECIFIED - - MessageText: - - An MMCSS class has not been set for this work queue.%0 - - - - - MessageId: MF_E_INSUFFICIENT_BUFFER - - MessageText: - - Insufficient memory for response.%0 - - - - - MessageId: MF_E_CANNOT_CREATE_SINK - - MessageText: - - Activate failed to create mediasink. Call OutputNode::GetUINT32(MF_TOPONODE_MAJORTYPE) for more information. %0 - - - - - MessageId: MF_E_BYTESTREAM_UNKNOWN_LENGTH - - MessageText: - - The length of the provided bytestream is unknown.%0 - - - - - MessageId: MF_E_SESSION_PAUSEWHILESTOPPED - - MessageText: - - The media session cannot pause from a stopped state.%0 - - - - - MessageId: MF_S_ACTIVATE_REPLACED - - MessageText: - - The activate could not be created in the remote process for some reason it was replaced with empty one.%0 - - - - - MessageId: MF_E_FORMAT_CHANGE_NOT_SUPPORTED - - MessageText: - - The data specified for the media type is supported, but would require a format change, which is not supported by this object.%0 - - - - - MessageId: MF_E_INVALID_WORKQUEUE - - MessageText: - - The operation failed because an invalid combination of workqueue ID and flags was specified.%0 - - - - - MessageId: MF_E_DRM_UNSUPPORTED - - MessageText: - - No DRM support is available.%0 - - - - - MessageId: MF_E_UNAUTHORIZED - - MessageText: - - This operation is not authorized.%0 - - - - - MessageId: MF_E_OUT_OF_RANGE - - MessageText: - - The value is not in the specified or valid range.%0 - - - - - MessageId: MF_E_INVALID_CODEC_MERIT - - MessageText: - - The registered codec merit is not valid.%0 - - - - - MessageId: MF_E_HW_MFT_FAILED_START_STREAMING - - MessageText: - - Hardware MFT failed to start streaming due to lack of hardware resources.%0 - - - - - MessageId: MF_S_ASF_PARSEINPROGRESS - - MessageText: - - Parsing is still in progress and is not yet complete.%0 - - - - - MessageId: MF_E_ASF_PARSINGINCOMPLETE - - MessageText: - - Not enough data have been parsed to carry out the requested action.%0 - - - - - MessageId: MF_E_ASF_MISSINGDATA - - MessageText: - - There is a gap in the ASF data provided.%0 - - - - - MessageId: MF_E_ASF_INVALIDDATA - - MessageText: - - The data provided are not valid ASF.%0 - - - - - MessageId: MF_E_ASF_OPAQUEPACKET - - MessageText: - - The packet is opaque, so the requested information cannot be returned.%0 - - - - - MessageId: MF_E_ASF_NOINDEX - - MessageText: - - The requested operation failed since there is no appropriate ASF index.%0 - - - - - MessageId: MF_E_ASF_OUTOFRANGE - - MessageText: - - The value supplied is out of range for this operation.%0 - - - - - MessageId: MF_E_ASF_INDEXNOTLOADED - - MessageText: - - The index entry requested needs to be loaded before it can be available.%0 - - - - - MessageId: MF_E_ASF_TOO_MANY_PAYLOADS - - MessageText: - - The packet has reached the maximum number of payloads.%0 - - - - - MessageId: MF_E_ASF_UNSUPPORTED_STREAM_TYPE - - MessageText: - - Stream type is not supported.%0 - - - - - MessageId: MF_E_ASF_DROPPED_PACKET - - MessageText: - - One or more ASF packets were dropped.%0 - - - - - MessageId: MF_E_NO_EVENTS_AVAILABLE - - MessageText: - - There are no events available in the queue.%0 - - - - - MessageId: MF_E_INVALID_STATE_TRANSITION - - MessageText: - - A media source cannot go from the stopped state to the paused state.%0 - - - - - MessageId: MF_E_END_OF_STREAM - - MessageText: - - The media stream cannot process any more samples because there are no more samples in the stream.%0 - - - - - MessageId: MF_E_SHUTDOWN - - MessageText: - - The request is invalid because Shutdown() has been called.%0 - - - - - MessageId: MF_E_MP3_NOTFOUND - - MessageText: - - The MP3 object was not found.%0 - - - - - MessageId: MF_E_MP3_OUTOFDATA - - MessageText: - - The MP3 parser ran out of data before finding the MP3 object.%0 - - - - - MessageId: MF_E_MP3_NOTMP3 - - MessageText: - - The file is not really a MP3 file.%0 - - - - - MessageId: MF_E_MP3_NOTSUPPORTED - - MessageText: - - The MP3 file is not supported.%0 - - - - - MessageId: MF_E_NO_DURATION - - MessageText: - - The Media stream has no duration.%0 - - - - - MessageId: MF_E_INVALID_FORMAT - - MessageText: - - The Media format is recognized but is invalid.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_FOUND - - MessageText: - - The property requested was not found.%0 - - - - - MessageId: MF_E_PROPERTY_READ_ONLY - - MessageText: - - The property is read only.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_ALLOWED - - MessageText: - - The specified property is not allowed in this context.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NOT_STARTED - - MessageText: - - The media source is not started.%0 - - - - - MessageId: MF_E_UNSUPPORTED_FORMAT - - MessageText: - - The Media format is recognized but not supported.%0 - - - - - MessageId: MF_E_MP3_BAD_CRC - - MessageText: - - The MPEG frame has bad CRC.%0 - - - - - MessageId: MF_E_NOT_PROTECTED - - MessageText: - - The file is not protected.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_WRONGSTATE - - MessageText: - - The media source is in the wrong state%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NO_STREAMS_SELECTED - - MessageText: - - No streams are selected in source presentation descriptor.%0 - - - - - MessageId: MF_E_CANNOT_FIND_KEYFRAME_SAMPLE - - MessageText: - - No key frame sample was found.%0 - - - - - MessageId: MF_E_NETWORK_RESOURCE_FAILURE - - MessageText: - - An attempt to acquire a network resource failed.%0 - - - - - MessageId: MF_E_NET_WRITE - - MessageText: - - Error writing to the network.%0 - - - - - MessageId: MF_E_NET_READ - - MessageText: - - Error reading from the network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_NETWORK - - MessageText: - - Internal. Entry cannot complete operation without network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_ASYNC - - MessageText: - - Internal. Async op is required.%0 - - - - - MessageId: MF_E_NET_BWLEVEL_NOT_SUPPORTED - - MessageText: - - Internal. Bandwidth levels are not supported.%0 - - - - - MessageId: MF_E_NET_STREAMGROUPS_NOT_SUPPORTED - - MessageText: - - Internal. Stream groups are not supported.%0 - - - - - MessageId: MF_E_NET_MANUALSS_NOT_SUPPORTED - - MessageText: - - Manual stream selection is not supported.%0 - - - - - MessageId: MF_E_NET_INVALID_PRESENTATION_DESCRIPTOR - - MessageText: - - Invalid presentation descriptor.%0 - - - - - MessageId: MF_E_NET_CACHESTREAM_NOT_FOUND - - MessageText: - - Cannot find cache stream.%0 - - - - - MessageId: MF_I_MANUAL_PROXY - - MessageText: - - The proxy setting is manual.%0 - - - - duplicate removed - MessageId=17011 Severity=Informational Facility=MEDIAFOUNDATION SymbolicName=MF_E_INVALID_REQUEST - Language=English - The request is invalid in the current state.%0 - . - - MessageId: MF_E_NET_REQUIRE_INPUT - - MessageText: - - Internal. Entry cannot complete operation without input.%0 - - - - - MessageId: MF_E_NET_REDIRECT - - MessageText: - - The client redirected to another server.%0 - - - - - MessageId: MF_E_NET_REDIRECT_TO_PROXY - - MessageText: - - The client is redirected to a proxy server.%0 - - - - - MessageId: MF_E_NET_TOO_MANY_REDIRECTS - - MessageText: - - The client reached maximum redirection limit.%0 - - - - - MessageId: MF_E_NET_TIMEOUT - - MessageText: - - The server, a computer set up to offer multimedia content to other computers, could not handle your request for multimedia content in a timely manner. Please try again later.%0 - - - - - MessageId: MF_E_NET_CLIENT_CLOSE - - MessageText: - - The control socket is closed by the client.%0 - - - - - MessageId: MF_E_NET_BAD_CONTROL_DATA - - MessageText: - - The server received invalid data from the client on the control connection.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_SERVER - - MessageText: - - The server is not a compatible streaming media server.%0 - - - - - MessageId: MF_E_NET_UNSAFE_URL - - MessageText: - - Url.%0 - - - - - MessageId: MF_E_NET_CACHE_NO_DATA - - MessageText: - - Data is not available.%0 - - - - - MessageId: MF_E_NET_EOL - - MessageText: - - End of line.%0 - - - - - MessageId: MF_E_NET_BAD_REQUEST - - MessageText: - - The request could not be understood by the server.%0 - - - - - MessageId: MF_E_NET_INTERNAL_SERVER_ERROR - - MessageText: - - The server encountered an unexpected condition which prevented it from fulfilling the request.%0 - - - - - MessageId: MF_E_NET_SESSION_NOT_FOUND - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_NET_NOCONNECTION - - MessageText: - - There is no connection established with the Windows Media server. The operation failed.%0 - - - - - MessageId: MF_E_NET_CONNECTION_FAILURE - - MessageText: - - The network connection has failed.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_PUSHSERVER - - MessageText: - - The Server service that received the HTTP push request is not a compatible version of Windows Media Services (WMS). This error may indicate the push request was received by IIS instead of WMS. Ensure WMS is started and has the HTTP Server control protocol properly enabled and try again.%0 - - - - - MessageId: MF_E_NET_SERVER_ACCESSDENIED - - MessageText: - - The Windows Media server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_PROXY_ACCESSDENIED - - MessageText: - - The proxy server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_CANNOTCONNECT - - MessageText: - - Unable to establish a connection to the server.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_TEMPLATE - - MessageText: - - The specified push template is invalid.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_PUBLISHING_POINT - - MessageText: - - The specified push publishing point is invalid.%0 - - - - - MessageId: MF_E_NET_BUSY - - MessageText: - - The requested resource is in use.%0 - - - - - MessageId: MF_E_NET_RESOURCE_GONE - - MessageText: - - The Publishing Point or file on the Windows Media Server is no longer available.%0 - - - - - MessageId: MF_E_NET_ERROR_FROM_PROXY - - MessageText: - - The proxy experienced an error while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_PROXY_TIMEOUT - - MessageText: - - The proxy did not receive a timely response while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_SERVER_UNAVAILABLE - - MessageText: - - The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.%0 - - - - - MessageId: MF_E_NET_TOO_MUCH_DATA - - MessageText: - - The encoding process was unable to keep up with the amount of supplied data.%0 - - - - - MessageId: MF_E_NET_SESSION_INVALID - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_OFFLINE_MODE - - MessageText: - - The requested URL is not available in offline mode.%0 - - - - - MessageId: MF_E_NET_UDP_BLOCKED - - MessageText: - - A device in the network is blocking UDP traffic.%0 - - - - - MessageId: MF_E_NET_UNSUPPORTED_CONFIGURATION - - MessageText: - - The specified configuration value is not supported.%0 - - - - - MessageId: MF_E_NET_PROTOCOL_DISABLED - - MessageText: - - The networking protocol is disabled.%0 - - - - - MessageId: MF_E_ALREADY_INITIALIZED - - MessageText: - - This object has already been initialized and cannot be re-initialized at this time.%0 - - - - - MessageId: MF_E_BANDWIDTH_OVERRUN - - MessageText: - - The amount of data passed in exceeds the given bitrate and buffer window.%0 - - - - - MessageId: MF_E_LATE_SAMPLE - - MessageText: - - The sample was passed in too late to be correctly processed.%0 - - - - - MessageId: MF_E_FLUSH_NEEDED - - MessageText: - - The requested action cannot be carried out until the object is flushed and the queue is emptied.%0 - - - - - MessageId: MF_E_INVALID_PROFILE - - MessageText: - - The profile is invalid.%0 - - - - - MessageId: MF_E_INDEX_NOT_COMMITTED - - MessageText: - - The index that is being generated needs to be committed before the requested action can be carried out.%0 - - - - - MessageId: MF_E_NO_INDEX - - MessageText: - - The index that is necessary for the requested action is not found.%0 - - - - - MessageId: MF_E_CANNOT_INDEX_IN_PLACE - - MessageText: - - The requested index cannot be added in-place to the specified ASF content.%0 - - - - - MessageId: MF_E_MISSING_ASF_LEAKYBUCKET - - MessageText: - - The ASF leaky bucket parameters must be specified in order to carry out this request.%0 - - - - - MessageId: MF_E_INVALID_ASF_STREAMID - - MessageText: - - The stream id is invalid. The valid range for ASF stream id is from 1 to 127.%0 - - - - - MessageId: MF_E_STREAMSINK_REMOVED - - MessageText: - - The requested Stream Sink has been removed and cannot be used.%0 - - - - - MessageId: MF_E_STREAMSINKS_OUT_OF_SYNC - - MessageText: - - The various Stream Sinks in this Media Sink are too far out of sync for the requested action to take place.%0 - - - - - MessageId: MF_E_STREAMSINKS_FIXED - - MessageText: - - Stream Sinks cannot be added to or removed from this Media Sink because its set of streams is fixed.%0 - - - - - MessageId: MF_E_STREAMSINK_EXISTS - - MessageText: - - The given Stream Sink already exists.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_CANCELED - - MessageText: - - Sample allocations have been canceled.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_EMPTY - - MessageText: - - The sample allocator is currently empty, due to outstanding requests.%0 - - - - - MessageId: MF_E_SINK_ALREADYSTOPPED - - MessageText: - - When we try to sopt a stream sink, it is already stopped %0 - - - - - MessageId: MF_E_ASF_FILESINK_BITRATE_UNKNOWN - - MessageText: - - The ASF file sink could not reserve AVIO because the bitrate is unknown.%0 - - - - - MessageId: MF_E_SINK_NO_STREAMS - - MessageText: - - No streams are selected in sink presentation descriptor.%0 - - - - - MessageId: MF_S_SINK_NOT_FINALIZED - - MessageText: - - The sink has not been finalized before shut down. This may cause sink generate a corrupted content.%0 - - - - - MessageId: MF_E_METADATA_TOO_LONG - - MessageText: - - A metadata item was too long to write to the output container.%0 - - - - - MessageId: MF_E_SINK_NO_SAMPLES_PROCESSED - - MessageText: - - The operation failed because no samples were processed by the sink.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_PROCAMP_HW - - MessageText: - - There is no available procamp hardware with which to perform color correction.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_DEINTERLACE_HW - - MessageText: - - There is no available deinterlacing hardware with which to deinterlace the video stream.%0 - - - - - MessageId: MF_E_VIDEO_REN_COPYPROT_FAILED - - MessageText: - - A video stream requires copy protection to be enabled, but there was a failure in attempting to enable copy protection.%0 - - - - - MessageId: MF_E_VIDEO_REN_SURFACE_NOT_SHARED - - MessageText: - - A component is attempting to access a surface for sharing that is not shared.%0 - - - - - MessageId: MF_E_VIDEO_DEVICE_LOCKED - - MessageText: - - A component is attempting to access a shared device that is already locked by another component.%0 - - - - - MessageId: MF_E_NEW_VIDEO_DEVICE - - MessageText: - - The device is no longer available. The handle should be closed and a new one opened.%0 - - - - - MessageId: MF_E_NO_VIDEO_SAMPLE_AVAILABLE - - MessageText: - - A video sample is not currently queued on a stream that is required for mixing.%0 - - - - - MessageId: MF_E_NO_AUDIO_PLAYBACK_DEVICE - - MessageText: - - No audio playback device was found.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_IN_USE - - MessageText: - - The requested audio playback device is currently in use.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_INVALIDATED - - MessageText: - - The audio playback device is no longer present.%0 - - - - - MessageId: MF_E_AUDIO_SERVICE_NOT_RUNNING - - MessageText: - - The audio service is not running.%0 - - - - - MessageId: MF_E_TOPO_INVALID_OPTIONAL_NODE - - MessageText: - - The topology contains an invalid optional node. Possible reasons are incorrect number of outputs and inputs or optional node is at the beginning or end of a segment. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_FIND_DECRYPTOR - - MessageText: - - No suitable transform was found to decrypt the content. %0 - - - - - MessageId: MF_E_TOPO_CODEC_NOT_FOUND - - MessageText: - - No suitable transform was found to encode or decode the content. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_CONNECT - - MessageText: - - Unable to find a way to connect nodes%0 - - - - - MessageId: MF_E_TOPO_UNSUPPORTED - - MessageText: - - Unsupported operations in topoloader%0 - - - - - MessageId: MF_E_TOPO_INVALID_TIME_ATTRIBUTES - - MessageText: - - The topology or its nodes contain incorrectly set time attributes%0 - - - - - MessageId: MF_E_TOPO_LOOPS_IN_TOPOLOGY - - MessageText: - - The topology contains loops, which are unsupported in media foundation topologies%0 - - - - - MessageId: MF_E_TOPO_MISSING_PRESENTATION_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_STREAM_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a stream descriptor%0 - - - - - MessageId: MF_E_TOPO_STREAM_DESCRIPTOR_NOT_SELECTED - - MessageText: - - A stream descriptor was set on a source stream node but it was not selected on the presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_SOURCE - - MessageText: - - A source stream node in the topology does not have a source%0 - - - - - MessageId: MF_E_TOPO_SINK_ACTIVATES_UNSUPPORTED - - MessageText: - - The topology loader does not support sink activates on output nodes.%0 - - - - - MessageId: MF_E_SEQUENCER_UNKNOWN_SEGMENT_ID - - MessageText: - - The sequencer cannot find a segment with the given ID.%0\n. - - - - - MessageId: MF_S_SEQUENCER_CONTEXT_CANCELED - - MessageText: - - The context was canceled.%0\n. - - - - - MessageId: MF_E_NO_SOURCE_IN_CACHE - - MessageText: - - Cannot find source in source cache.%0\n. - - - - - MessageId: MF_S_SEQUENCER_SEGMENT_AT_END_OF_STREAM - - MessageText: - - Cannot update topology flags.%0\n. - - - - - MessageId: MF_E_TRANSFORM_TYPE_NOT_SET - - MessageText: - - A valid type has not been set for this stream or a stream that it depends on.%0 - - - - - MessageId: MF_E_TRANSFORM_STREAM_CHANGE - - MessageText: - - A stream change has occurred. Output cannot be produced until the streams have been renegotiated.%0 - - - - - MessageId: MF_E_TRANSFORM_INPUT_REMAINING - - MessageText: - - The transform cannot take the requested action until all of the input data it currently holds is processed or flushed.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_MISSING - - MessageText: - - The transform requires a profile but no profile was supplied or found.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_INVALID_OR_CORRUPT - - MessageText: - - The transform requires a profile but the supplied profile was invalid or corrupt.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_TRUNCATED - - MessageText: - - The transform requires a profile but the supplied profile ended unexpectedly while parsing.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_PID_NOT_RECOGNIZED - - MessageText: - - The property ID does not match any property supported by the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VARIANT_TYPE_WRONG - - MessageText: - - The variant does not have the type expected for this property ID.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_NOT_WRITEABLE - - MessageText: - - An attempt was made to set the value on a read-only property.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_ARRAY_VALUE_WRONG_NUM_DIM - - MessageText: - - The array property value has an unexpected number of dimensions.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_SIZE_WRONG - - MessageText: - - The array or blob property value has an unexpected size.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_OUT_OF_RANGE - - MessageText: - - The property value is out of range for this transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_INCOMPATIBLE - - MessageText: - - The property value is incompatible with some other property or mediatype set on the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_OUTPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set output mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_INPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set input mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_MEDIATYPE_COMBINATION - - MessageText: - - The requested operation is not supported for the currently set combination of mediatypes.%0 - - - - - MessageId: MF_E_TRANSFORM_CONFLICTS_WITH_OTHER_CURRENTLY_ENABLED_FEATURES - - MessageText: - - The requested feature is not supported in combination with some other currently enabled feature.%0 - - - - - MessageId: MF_E_TRANSFORM_NEED_MORE_INPUT - - MessageText: - - The transform cannot produce output until it gets more input samples.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_SPKR_CONFIG - - MessageText: - - The requested operation is not supported for the current speaker configuration.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING - - MessageText: - - The transform cannot accept mediatype changes in the middle of processing.%0 - - - - - MessageId: MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT - - MessageText: - - The caller should not propagate this event to downstream components.%0 - - - - - MessageId: MF_E_UNSUPPORTED_D3D_TYPE - - MessageText: - - The input type is not supported for D3D device.%0 - - - - - MessageId: MF_E_TRANSFORM_ASYNC_LOCKED - - MessageText: - - The caller does not appear to support this transform's asynchronous capabilities.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_INITIALIZE_ACM_DRIVER - - MessageText: - - An audio compression manager driver could not be initialized by the transform.%0 - - - - - MessageId: MF_E_LICENSE_INCORRECT_RIGHTS - - MessageText: - - You are not allowed to open this file. Contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_OUTOFDATE - - MessageText: - - The license for this media file has expired. Get a new license or contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_REQUIRED - - MessageText: - - You need a license to perform the requested operation on this media file.%0 - - - - - MessageId: MF_E_DRM_HARDWARE_INCONSISTENT - - MessageText: - - The licenses for your media files are corrupted. Contact Microsoft product support.%0 - - - - - MessageId: MF_E_NO_CONTENT_PROTECTION_MANAGER - - MessageText: - - The APP needs to provide IMFContentProtectionManager callback to access the protected media file.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NO_RIGHTS - - MessageText: - - Client does not have rights to restore licenses.%0 - - - - - MessageId: MF_E_BACKUP_RESTRICTED_LICENSE - - MessageText: - - Licenses are restricted and hence can not be backed up.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NEEDS_INDIVIDUALIZATION - - MessageText: - - License restore requires machine to be individualized.%0 - - - - - MessageId: MF_S_PROTECTION_NOT_REQUIRED - - MessageText: - - Protection for stream is not required.%0 - - - - - MessageId: MF_E_COMPONENT_REVOKED - - MessageText: - - Component is revoked.%0 - - - - - MessageId: MF_E_TRUST_DISABLED - - MessageText: - - Trusted functionality is currently disabled on this component.%0 - - - - - MessageId: MF_E_WMDRMOTA_NO_ACTION - - MessageText: - - No Action is set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_ALREADY_SET - - MessageText: - - Action is already set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_HEADER_NOT_AVAILABLE - - MessageText: - - DRM Heaader is not available.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_ENCRYPTION_SCHEME_NOT_SUPPORTED - - MessageText: - - Current encryption scheme is not supported.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_MISMATCH - - MessageText: - - Action does not match with current configuration.%0 - - - - - MessageId: MF_E_WMDRMOTA_INVALID_POLICY - - MessageText: - - Invalid policy for WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_POLICY_UNSUPPORTED - - MessageText: - - The policies that the Input Trust Authority requires to be enforced are unsupported by the outputs.%0 - - - - - MessageId: MF_E_OPL_NOT_SUPPORTED - - MessageText: - - The OPL that the license requires to be enforced are not supported by the Input Trust Authority.%0 - - - - - MessageId: MF_E_TOPOLOGY_VERIFICATION_FAILED - - MessageText: - - The topology could not be successfully verified.%0 - - - - - MessageId: MF_E_SIGNATURE_VERIFICATION_FAILED - - MessageText: - - Signature verification could not be completed successfully for this component.%0 - - - - - MessageId: MF_E_DEBUGGING_NOT_ALLOWED - - MessageText: - - Running this process under a debugger while using protected content is not allowed.%0 - - - - - MessageId: MF_E_CODE_EXPIRED - - MessageText: - - MF component has expired.%0 - - - - - MessageId: MF_E_GRL_VERSION_TOO_LOW - - MessageText: - - The current GRL on the machine does not meet the minimum version requirements.%0 - - - - - MessageId: MF_E_GRL_RENEWAL_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any renewal entries for the specified revocation.%0 - - - - - MessageId: MF_E_GRL_EXTENSIBLE_ENTRY_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any extensible entries for the specified extension GUID.%0 - - - - - MessageId: MF_E_KERNEL_UNTRUSTED - - MessageText: - - The kernel isn't secure for high security level content.%0 - - - - - MessageId: MF_E_PEAUTH_UNTRUSTED - - MessageText: - - The response from protected environment driver isn't valid.%0 - - - - - MessageId: MF_E_NON_PE_PROCESS - - MessageText: - - A non-PE process tried to talk to PEAuth.%0 - - - - - MessageId: MF_E_REBOOT_REQUIRED - - MessageText: - - We need to reboot the machine.%0 - - - - - MessageId: MF_S_WAIT_FOR_POLICY_SET - - MessageText: - - Protection for this stream is not guaranteed to be enforced until the MEPolicySet event is fired.%0 - - - - - MessageId: MF_S_VIDEO_DISABLED_WITH_UNKNOWN_SOFTWARE_OUTPUT - - MessageText: - - This video stream is disabled because it is being sent to an unknown software output.%0 - - - - - MessageId: MF_E_GRL_INVALID_FORMAT - - MessageText: - - The GRL file is not correctly formed, it may have been corrupted or overwritten.%0 - - - - - MessageId: MF_E_GRL_UNRECOGNIZED_FORMAT - - MessageText: - - The GRL file is in a format newer than those recognized by this GRL Reader.%0 - - - - - MessageId: MF_E_ALL_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and required all processes that can run protected media to restart.%0 - - - - - MessageId: MF_E_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and the current process needs to restart.%0 - - - - - MessageId: MF_E_USERMODE_UNTRUSTED - - MessageText: - - The user space is untrusted for protected content play.%0 - - - - - MessageId: MF_E_PEAUTH_SESSION_NOT_STARTED - - MessageText: - - PEAuth communication session hasn't been started.%0 - - - - - MessageId: MF_E_PEAUTH_PUBLICKEY_REVOKED - - MessageText: - - PEAuth's public key is revoked.%0 - - - - - MessageId: MF_E_GRL_ABSENT - - MessageText: - - The GRL is absent.%0 - - - - - MessageId: MF_S_PE_TRUSTED - - MessageText: - - The Protected Environment is trusted.%0 - - - - - MessageId: MF_E_PE_UNTRUSTED - - MessageText: - - The Protected Environment is untrusted.%0 - - - - - MessageId: MF_E_PEAUTH_NOT_STARTED - - MessageText: - - The Protected Environment Authorization service (PEAUTH) has not been started.%0 - - - - - MessageId: MF_E_INCOMPATIBLE_SAMPLE_PROTECTION - - MessageText: - - The sample protection algorithms supported by components are not compatible.%0 - - - - - MessageId: MF_E_PE_SESSIONS_MAXED - - MessageText: - - No more protected environment sessions can be supported.%0 - - - - - MessageId: MF_E_HIGH_SECURITY_LEVEL_CONTENT_NOT_ALLOWED - - MessageText: - - WMDRM ITA does not allow protected content with high security level for this release.%0 - - - - - MessageId: MF_E_TEST_SIGNED_COMPONENTS_NOT_ALLOWED - - MessageText: - - WMDRM ITA cannot allow the requested action for the content as one or more components is not properly signed.%0 - - - - - MessageId: MF_E_ITA_UNSUPPORTED_ACTION - - MessageText: - - WMDRM ITA does not support the requested action.%0 - - - - - MessageId: MF_E_ITA_ERROR_PARSING_SAP_PARAMETERS - - MessageText: - - WMDRM ITA encountered an error in parsing the Secure Audio Path parameters.%0 - - - - - MessageId: MF_E_POLICY_MGR_ACTION_OUTOFBOUNDS - - MessageText: - - The Policy Manager action passed in is invalid.%0 - - - - - MessageId: MF_E_BAD_OPL_STRUCTURE_FORMAT - - MessageText: - - The structure specifying Output Protection Level is not the correct format.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_PROTECTION_GUID - - MessageText: - - WMDRM ITA does not recognize the Explicite Analog Video Output Protection guid specified in the license.%0 - - - - - MessageId: MF_E_NO_PMP_HOST - - MessageText: - - IMFPMPHost object not available.%0 - - - - - MessageId: MF_E_ITA_OPL_DATA_NOT_INITIALIZED - - MessageText: - - WMDRM ITA could not initialize the Output Protection Level data.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Analog Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_DIGITAL_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Digital Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_CLOCK_INVALID_CONTINUITY_KEY - - MessageText: - - The continuity key supplied is not currently valid.%0 - - - - - MessageId: MF_E_CLOCK_NO_TIME_SOURCE - - MessageText: - - No Presentation Time Source has been specified.%0 - - - - - MessageId: MF_E_CLOCK_STATE_ALREADY_SET - - MessageText: - - The clock is already in the requested state.%0 - - - - - MessageId: MF_E_CLOCK_NOT_SIMPLE - - MessageText: - - The clock has too many advanced features to carry out the request.%0 - - - - - MessageId: MF_S_CLOCK_STOPPED - - MessageText: - - Timer::SetTimer returns this success code if called happened while timer is stopped. Timer is not going to be dispatched until clock is running%0 - - - - - MessageId: MF_E_NO_MORE_DROP_MODES - - MessageText: - - The component does not support any more drop modes.%0 - - - - - MessageId: MF_E_NO_MORE_QUALITY_LEVELS - - MessageText: - - The component does not support any more quality levels.%0 - - - - - MessageId: MF_E_DROPTIME_NOT_SUPPORTED - - MessageText: - - The component does not support drop time functionality.%0 - - - - - MessageId: MF_E_QUALITYKNOB_WAIT_LONGER - - MessageText: - - Quality Manager needs to wait longer before bumping the Quality Level up.%0 - - - - - MessageId: MF_E_QM_INVALIDSTATE - - MessageText: - - Quality Manager is in an invalid state. Quality Management is off at this moment.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_CONTAINERTYPE - - MessageText: - - No transcode output container type is specified.%0 - - - - - MessageId: MF_E_TRANSCODE_PROFILE_NO_MATCHING_STREAMS - - MessageText: - - The profile does not have a media type configuration for any selected source streams.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_MATCHING_ENCODER - - MessageText: - - Cannot find an encoder MFT that accepts the user preferred output type.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_INITIALIZED - - MessageText: - - Memory allocator is not initialized.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_COMMITED - - MessageText: - - Memory allocator is not committed yet.%0 - - - - - MessageId: MF_E_ALLOCATOR_ALREADY_COMMITED - - MessageText: - - Memory allocator has already been committed.%0 - - - - - MessageId: MF_E_STREAM_ERROR - - MessageText: - - An error occurred in media stream.%0 - - - - - MessageId: MF_E_INVALID_STREAM_STATE - - MessageText: - - Stream is not in a state to handle the request.%0 - - - - - MessageId: MF_E_HW_STREAM_NOT_CONNECTED - - MessageText: - - Hardware stream is not connected yet.%0 - - - - - Major Media Types - http://msdn.microsoft.com/en-us/library/windows/desktop/aa367377%28v=vs.85%29.aspx - - - - - Default - - - - - Audio - - - - - Video - - - - - Protected Media - - - - - Synchronized Accessible Media Interchange (SAMI) captions. - - - - - Script stream - - - - - Still image stream. - - - - - HTML stream. - - - - - Binary stream. - - - - - A stream that contains data files. - - - - - IMFActivate, defined in mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Creates the object associated with this activation object. - - - - - Shuts down the created object. - - - - - Detaches the created object from the activation object. - - - - - Represents a generic collection of IUnknown pointers. - - - - - Retrieves the number of objects in the collection. - - - - - Retrieves an object in the collection. - - - - - Adds an object to the collection. - - - - - Removes an object from the collection. - - - - - Removes an object from the collection. - - - - - Removes all items from the collection. - - - - - IMFMediaEvent - Represents an event generated by a Media Foundation object. Use this interface to get information about the event. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms702249%28v=vs.85%29.aspx - Mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the event type. - - - virtual HRESULT STDMETHODCALLTYPE GetType( - /* [out] */ __RPC__out MediaEventType *pmet) = 0; - - - - - Retrieves the extended type of the event. - - - virtual HRESULT STDMETHODCALLTYPE GetExtendedType( - /* [out] */ __RPC__out GUID *pguidExtendedType) = 0; - - - - - Retrieves an HRESULT that specifies the event status. - - - virtual HRESULT STDMETHODCALLTYPE GetStatus( - /* [out] */ __RPC__out HRESULT *phrStatus) = 0; - - - - - Retrieves the value associated with the event, if any. - - - virtual HRESULT STDMETHODCALLTYPE GetValue( - /* [out] */ __RPC__out PROPVARIANT *pvValue) = 0; - - - - - Implemented by the Microsoft Media Foundation sink writer object. - - - - - Adds a stream to the sink writer. - - - - - Sets the input format for a stream on the sink writer. - - - - - Initializes the sink writer for writing. - - - - - Delivers a sample to the sink writer. - - - - - Indicates a gap in an input stream. - - - - - Places a marker in the specified stream. - - - - - Notifies the media sink that a stream has reached the end of a segment. - - - - - Flushes one or more streams. - - - - - (Finalize) Completes all writing operations on the sink writer. - - - - - Queries the underlying media sink or encoder for an interface. - - - - - Gets statistics about the performance of the sink writer. - - - - - IMFTransform, defined in mftransform.h - - - - - Retrieves the minimum and maximum number of input and output streams. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamLimits( - /* [out] */ __RPC__out DWORD *pdwInputMinimum, - /* [out] */ __RPC__out DWORD *pdwInputMaximum, - /* [out] */ __RPC__out DWORD *pdwOutputMinimum, - /* [out] */ __RPC__out DWORD *pdwOutputMaximum) = 0; - - - - - Retrieves the current number of input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamCount( - /* [out] */ __RPC__out DWORD *pcInputStreams, - /* [out] */ __RPC__out DWORD *pcOutputStreams) = 0; - - - - - Retrieves the stream identifiers for the input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamIDs( - DWORD dwInputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwInputIDArraySize) DWORD *pdwInputIDs, - DWORD dwOutputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwOutputIDArraySize) DWORD *pdwOutputIDs) = 0; - - - - - Gets the buffer requirements and other information for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamInfo( - DWORD dwInputStreamID, - /* [out] */ __RPC__out MFT_INPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the buffer requirements and other information for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamInfo( - DWORD dwOutputStreamID, - /* [out] */ __RPC__out MFT_OUTPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the global attribute store for this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetAttributes( - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an input stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamAttributes( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamAttributes( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Removes an input stream from this MFT. - - - virtual HRESULT STDMETHODCALLTYPE DeleteInputStream( - DWORD dwStreamID) = 0; - - - - - Adds one or more new input streams to this MFT. - - - virtual HRESULT STDMETHODCALLTYPE AddInputStreams( - DWORD cStreams, - /* [in] */ __RPC__in DWORD *adwStreamIDs) = 0; - - - - - Gets an available media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputAvailableType( - DWORD dwInputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Retrieves an available media type for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputAvailableType( - DWORD dwOutputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Sets, tests, or clears the media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetInputType( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Sets, tests, or clears the media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetOutputType( - DWORD dwOutputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Gets the current media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputCurrentType( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Gets the current media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputCurrentType( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Queries whether an input stream on this Media Foundation transform (MFT) can accept more data. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStatus( - DWORD dwInputStreamID, - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Queries whether the Media Foundation transform (MFT) is ready to produce output data. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStatus( - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Sets the range of time stamps the client needs for output. - - - virtual HRESULT STDMETHODCALLTYPE SetOutputBounds( - LONGLONG hnsLowerBound, - LONGLONG hnsUpperBound) = 0; - - - - - Sends an event to an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessEvent( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaEvent *pEvent) = 0; - - - - - Sends a message to the Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessMessage( - MFT_MESSAGE_TYPE eMessage, - ULONG_PTR ulParam) = 0; - - - - - Delivers data to an input stream on this Media Foundation transform (MFT). - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessInput( - DWORD dwInputStreamID, - IMFSample *pSample, - DWORD dwFlags) = 0; - - - - - Generates output from the current input data. - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessOutput( - DWORD dwFlags, - DWORD cOutputBufferCount, - /* [size_is][out][in] */ MFT_OUTPUT_DATA_BUFFER *pOutputSamples, - /* [out] */ DWORD *pdwStatus) = 0; - - - - - See mfobjects.h - - - - - Unknown event type. - - - - - Signals a serious error. - - - - - Custom event type. - - - - - A non-fatal error occurred during streaming. - - - - - Session Unknown - - - - - Raised after the IMFMediaSession::SetTopology method completes asynchronously - - - - - Raised by the Media Session when the IMFMediaSession::ClearTopologies method completes asynchronously. - - - - - Raised when the IMFMediaSession::Start method completes asynchronously. - - - - - Raised when the IMFMediaSession::Pause method completes asynchronously. - - - - - Raised when the IMFMediaSession::Stop method completes asynchronously. - - - - - Raised when the IMFMediaSession::Close method completes asynchronously. - - - - - Raised by the Media Session when it has finished playing the last presentation in the playback queue. - - - - - Raised by the Media Session when the playback rate changes. - - - - - Raised by the Media Session when it completes a scrubbing request. - - - - - Raised by the Media Session when the session capabilities change. - - - - - Raised by the Media Session when the status of a topology changes. - - - - - Raised by the Media Session when a new presentation starts. - - - - - Raised by a media source a new presentation is ready. - - - - - License acquisition is about to begin. - - - - - License acquisition is complete. - - - - - Individualization is about to begin. - - - - - Individualization is complete. - - - - - Signals the progress of a content enabler object. - - - - - A content enabler object's action is complete. - - - - - Raised by a trusted output if an error occurs while enforcing the output policy. - - - - - Contains status information about the enforcement of an output policy. - - - - - A media source started to buffer data. - - - - - A media source stopped buffering data. - - - - - The network source started opening a URL. - - - - - The network source finished opening a URL. - - - - - Raised by a media source at the start of a reconnection attempt. - - - - - Raised by a media source at the end of a reconnection attempt. - - - - - Raised by the enhanced video renderer (EVR) when it receives a user event from the presenter. - - - - - Raised by the Media Session when the format changes on a media sink. - - - - - Source Unknown - - - - - Raised when a media source starts without seeking. - - - - - Raised by a media stream when the source starts without seeking. - - - - - Raised when a media source seeks to a new position. - - - - - Raised by a media stream after a call to IMFMediaSource::Start causes a seek in the stream. - - - - - Raised by a media source when it starts a new stream. - - - - - Raised by a media source when it restarts or seeks a stream that is already active. - - - - - Raised by a media source when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media source when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media source when a presentation ends. - - - - - Raised by a media stream when the stream ends. - - - - - Raised when a media stream delivers a new sample. - - - - - Signals that a media stream does not have data available at a specified time. - - - - - Raised by a media stream when it starts or stops thinning the stream. - - - - - Raised by a media stream when the media type of the stream changes. - - - - - Raised by a media source when the playback rate changes. - - - - - Raised by the sequencer source when a segment is completed and is followed by another segment. - - - - - Raised by a media source when the source's characteristics change. - - - - - Raised by a media source to request a new playback rate. - - - - - Raised by a media source when it updates its metadata. - - - - - Raised by the sequencer source when the IMFSequencerSource::UpdateTopology method completes asynchronously. - - - - - Sink Unknown - - - - - Raised by a stream sink when it completes the transition to the running state. - - - - - Raised by a stream sink when it completes the transition to the stopped state. - - - - - Raised by a stream sink when it completes the transition to the paused state. - - - - - Raised by a stream sink when the rate has changed. - - - - - Raised by a stream sink to request a new media sample from the pipeline. - - - - - Raised by a stream sink after the IMFStreamSink::PlaceMarker method is called. - - - - - Raised by a stream sink when the stream has received enough preroll data to begin rendering. - - - - - Raised by a stream sink when it completes a scrubbing request. - - - - - Raised by a stream sink when the sink's media type is no longer valid. - - - - - Raised by the stream sinks of the EVR if the video device changes. - - - - - Provides feedback about playback quality to the quality manager. - - - - - Raised when a media sink becomes invalid. - - - - - The audio session display name changed. - - - - - The volume or mute state of the audio session changed - - - - - The audio device was removed. - - - - - The Windows audio server system was shut down. - - - - - The grouping parameters changed for the audio session. - - - - - The audio session icon changed. - - - - - The default audio format for the audio device changed. - - - - - The audio session was disconnected from a Windows Terminal Services session - - - - - The audio session was preempted by an exclusive-mode connection. - - - - - Trust Unknown - - - - - The output policy for a stream changed. - - - - - Content protection message - - - - - The IMFOutputTrustAuthority::SetPolicy method completed. - - - - - DRM License Backup Completed - - - - - DRM License Backup Progress - - - - - DRM License Restore Completed - - - - - DRM License Restore Progress - - - - - DRM License Acquisition Completed - - - - - DRM Individualization Completed - - - - - DRM Individualization Progress - - - - - DRM Proximity Completed - - - - - DRM License Store Cleaned - - - - - DRM Revocation Download Completed - - - - - Transform Unknown - - - - - Sent by an asynchronous MFT to request a new input sample. - - - - - Sent by an asynchronous MFT when new output data is available from the MFT. - - - - - Sent by an asynchronous Media Foundation transform (MFT) when a drain operation is complete. - - - - - Sent by an asynchronous MFT in response to an MFT_MESSAGE_COMMAND_MARKER message. - - - - - Media Foundation attribute guids - http://msdn.microsoft.com/en-us/library/windows/desktop/ms696989%28v=vs.85%29.aspx - - - - - Specifies whether an MFT performs asynchronous processing. - - - - - Enables the use of an asynchronous MFT. - - - - - Contains flags for an MFT activation object. - - - - - Specifies the category for an MFT. - - - - - Contains the class identifier (CLSID) of an MFT. - - - - - Contains the registered input types for a Media Foundation transform (MFT). - - - - - Contains the registered output types for a Media Foundation transform (MFT). - - - - - Contains the symbolic link for a hardware-based MFT. - - - - - Contains the display name for a hardware-based MFT. - - - - - Contains a pointer to the stream attributes of the connected stream on a hardware-based MFT. - - - - - Specifies whether a hardware-based MFT is connected to another hardware-based MFT. - - - - - Specifies the preferred output format for an encoder. - - - - - Specifies whether an MFT is registered only in the application's process. - - - - - Contains configuration properties for an encoder. - - - - - Specifies whether a hardware device source uses the system time for time stamps. - - - - - Contains an IMFFieldOfUseMFTUnlock pointer, which can be used to unlock the MFT. - - - - - Contains the merit value of a hardware codec. - - - - - Specifies whether a decoder is optimized for transcoding rather than for playback. - - - - - Contains a pointer to the proxy object for the application's presentation descriptor. - - - - - Contains a pointer to the presentation descriptor from the protected media path (PMP). - - - - - Specifies the duration of a presentation, in 100-nanosecond units. - - - - - Specifies the total size of the source file, in bytes. - - - - - Specifies the audio encoding bit rate for the presentation, in bits per second. - - - - - Specifies the video encoding bit rate for the presentation, in bits per second. - - - - - Specifies the MIME type of the content. - - - - - Specifies when a presentation was last modified. - - - - - The identifier of the playlist element in the presentation. - - - - - Contains the preferred RFC 1766 language of the media source. - - - - - The time at which the presentation must begin, relative to the start of the media source. - - - - - Specifies whether the audio streams in the presentation have a variable bit rate. - - - - - Media type Major Type - - - - - Media Type subtype - - - - - Audio block alignment - - - - - Audio average bytes per second - - - - - Audio number of channels - - - - - Audio samples per second - - - - - Audio bits per sample - - - - - Enables the source reader or sink writer to use hardware-based Media Foundation transforms (MFTs). - - - - - Contains additional format data for a media type. - - - - - Specifies for a media type whether each sample is independent of the other samples in the stream. - - - - - Specifies for a media type whether the samples have a fixed size. - - - - - Contains a DirectShow format GUID for a media type. - - - - - Specifies the preferred legacy format structure to use when converting an audio media type. - - - - - Specifies for a media type whether the media data is compressed. - - - - - Approximate data rate of the video stream, in bits per second, for a video media type. - - - - - Specifies the payload type of an Advanced Audio Coding (AAC) stream. - 0 - The stream contains raw_data_block elements only - 1 - Audio Data Transport Stream (ADTS). The stream contains an adts_sequence, as defined by MPEG-2. - 2 - Audio Data Interchange Format (ADIF). The stream contains an adif_sequence, as defined by MPEG-2. - 3 - The stream contains an MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - - - - - Specifies the audio profile and level of an Advanced Audio Coding (AAC) stream, as defined by ISO/IEC 14496-3. - - - - - Main interface for using Media Foundation with NAudio - - - - - initializes MediaFoundation - only needs to be called once per process - - - - - Enumerate the installed MediaFoundation transforms in the specified category - - A category from MediaFoundationTransformCategories - - - - - uninitializes MediaFoundation - - - - - Creates a Media type - - - - - Creates a media type from a WaveFormat - - - - - Creates a memory buffer of the specified size - - Memory buffer size in bytes - The memory buffer - - - - Creates a sample object - - The sample object - - - - Creates a new attributes store - - Initial size - The attributes store - - - - Creates a media foundation byte stream based on a stream object - (usable with WinRT streams) - - The input stream - A media foundation byte stream - - - - Creates a source reader based on a byte stream - - The byte stream - A media foundation source reader - - - - Interop definitions for MediaFoundation - thanks to Lucian Wischik for the initial work on many of these definitions (also various interfaces) - n.b. the goal is to make as much of this internal as possible, and provide - better .NET APIs using the MediaFoundationApi class instead - - - - - Initializes Microsoft Media Foundation. - - - - - Shuts down the Microsoft Media Foundation platform - - - - - Creates an empty media type. - - - - - Initializes a media type from a WAVEFORMATEX structure. - - - - - Converts a Media Foundation audio media type to a WAVEFORMATEX structure. - - TODO: try making second parameter out WaveFormatExtraData - - - - Creates the source reader from a URL. - - - - - Creates the source reader from a byte stream. - - - - - Creates the sink writer from a URL or byte stream. - - - - - Creates a Microsoft Media Foundation byte stream that wraps an IRandomAccessStream object. - - - - - Gets a list of Microsoft Media Foundation transforms (MFTs) that match specified search criteria. - - - - - Creates an empty media sample. - - - - - Allocates system memory and creates a media buffer to manage it. - - - - - Creates an empty attribute store. - - - - - Gets a list of output formats from an audio encoder. - - - - - All streams - - - - - First audio stream - - - - - First video stream - - - - - Media source - - - - - Media Foundation SDK Version - - - - - Media Foundation API Version - - - - - Media Foundation Version - - - - - Provides a generic way to store key/value pairs on an object. - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms704598%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - IMFByteStream - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms698720%28v=vs.85%29.aspx - - - - - Retrieves the characteristics of the byte stream. - virtual HRESULT STDMETHODCALLTYPE GetCapabilities(/*[out]*/ __RPC__out DWORD *pdwCapabilities) = 0; - - - - - Retrieves the length of the stream. - virtual HRESULT STDMETHODCALLTYPE GetLength(/*[out]*/ __RPC__out QWORD *pqwLength) = 0; - - - - - Sets the length of the stream. - virtual HRESULT STDMETHODCALLTYPE SetLength(/*[in]*/ QWORD qwLength) = 0; - - - - - Retrieves the current read or write position in the stream. - virtual HRESULT STDMETHODCALLTYPE GetCurrentPosition(/*[out]*/ __RPC__out QWORD *pqwPosition) = 0; - - - - - Sets the current read or write position. - virtual HRESULT STDMETHODCALLTYPE SetCurrentPosition(/*[in]*/ QWORD qwPosition) = 0; - - - - - Queries whether the current position has reached the end of the stream. - virtual HRESULT STDMETHODCALLTYPE IsEndOfStream(/*[out]*/ __RPC__out BOOL *pfEndOfStream) = 0; - - - - - Reads data from the stream. - virtual HRESULT STDMETHODCALLTYPE Read(/*[size_is][out]*/ __RPC__out_ecount_full(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbRead) = 0; - - - - - Begins an asynchronous read operation from the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginRead(/*[out]*/ _Out_writes_bytes_(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous read operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndRead(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbRead) = 0; - - - - - Writes data to the stream. - virtual HRESULT STDMETHODCALLTYPE Write(/*[size_is][in]*/ __RPC__in_ecount_full(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbWritten) = 0; - - - - - Begins an asynchronous write operation to the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginWrite(/*[in]*/ _In_reads_bytes_(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous write operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndWrite(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbWritten) = 0; - - - - - Moves the current position in the stream by a specified offset. - virtual HRESULT STDMETHODCALLTYPE Seek(/*[in]*/ MFBYTESTREAM_SEEK_ORIGIN SeekOrigin, /*[in]*/ LONGLONG llSeekOffset, /*[in]*/ DWORD dwSeekFlags, /*[out]*/ __RPC__out QWORD *pqwCurrentPosition) = 0; - - - - - Clears any internal buffers used by the stream. - virtual HRESULT STDMETHODCALLTYPE Flush( void) = 0; - - - - - Closes the stream and releases any resources associated with the stream. - virtual HRESULT STDMETHODCALLTYPE Close( void) = 0; - - - - - IMFMediaBuffer - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms696261%28v=vs.85%29.aspx - - - - - Gives the caller access to the memory in the buffer. - - - - - Unlocks a buffer that was previously locked. - - - - - Retrieves the length of the valid data in the buffer. - - - - - Sets the length of the valid data in the buffer. - - - - - Retrieves the allocated size of the buffer. - - - - - Represents a description of a media format. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms704850%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the major type of the format. - - - - - Queries whether the media type is a compressed format. - - - - - Compares two media types and determines whether they are identical. - - - - - Retrieves an alternative representation of the media type. - - - - - Frees memory that was allocated by the GetRepresentation method. - - - - - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms702192%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves flags associated with the sample. - - - - - Sets flags associated with the sample. - - - - - Retrieves the presentation time of the sample. - - - - - Sets the presentation time of the sample. - - - - - Retrieves the duration of the sample. - - - - - Sets the duration of the sample. - - - - - Retrieves the number of buffers in the sample. - - - - - Retrieves a buffer from the sample. - - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - - - - Adds a buffer to the end of the list of buffers in the sample. - - - - - Removes a buffer at a specified index from the sample. - - - - - Removes all buffers from the sample. - - - - - Retrieves the total length of the valid data in all of the buffers in the sample. - - - - - Copies the sample data to a buffer. - - - - - IMFSourceReader interface - http://msdn.microsoft.com/en-us/library/windows/desktop/dd374655%28v=vs.85%29.aspx - - - - - Queries whether a stream is selected. - - - - - Selects or deselects one or more streams. - - - - - Gets a format that is supported natively by the media source. - - - - - Gets the current media type for a stream. - - - - - Sets the media type for a stream. - - - - - Seeks to a new position in the media source. - - - - - Reads the next sample from the media source. - - - - - Flushes one or more streams. - - - - - Queries the underlying media source or decoder for an interface. - - - - - Gets an attribute from the underlying media source. - - - - - Contains flags that indicate the status of the IMFSourceReader::ReadSample method - http://msdn.microsoft.com/en-us/library/windows/desktop/dd375773(v=vs.85).aspx - - - - - No Error - - - - - An error occurred. If you receive this flag, do not make any further calls to IMFSourceReader methods. - - - - - The source reader reached the end of the stream. - - - - - One or more new streams were created - - - - - The native format has changed for one or more streams. The native format is the format delivered by the media source before any decoders are inserted. - - - - - The current media has type changed for one or more streams. To get the current media type, call the IMFSourceReader::GetCurrentMediaType method. - - - - - There is a gap in the stream. This flag corresponds to an MEStreamTick event from the media source. - - - - - All transforms inserted by the application have been removed for a particular stream. - - - - - Media Foundation Transform Categories - - - - - MFT_CATEGORY_VIDEO_DECODER - - - - - MFT_CATEGORY_VIDEO_ENCODER - - - - - MFT_CATEGORY_VIDEO_EFFECT - - - - - MFT_CATEGORY_MULTIPLEXER - - - - - MFT_CATEGORY_DEMULTIPLEXER - - - - - MFT_CATEGORY_AUDIO_DECODER - - - - - MFT_CATEGORY_AUDIO_ENCODER - - - - - MFT_CATEGORY_AUDIO_EFFECT - - - - - MFT_CATEGORY_VIDEO_PROCESSOR - - - - - MFT_CATEGORY_OTHER - - - - - Contains information about an input stream on a Media Foundation transform (MFT) - - - - - Maximum amount of time between an input sample and the corresponding output sample, in 100-nanosecond units. - - - - - Bitwise OR of zero or more flags from the _MFT_INPUT_STREAM_INFO_FLAGS enumeration. - - - - - The minimum size of each input buffer, in bytes. - - - - - Maximum amount of input data, in bytes, that the MFT holds to perform lookahead. - - - - - The memory alignment required for input buffers. If the MFT does not require a specific alignment, the value is zero. - - - - - Contains information about an output buffer for a Media Foundation transform. - - - - - Output stream identifier. - - - - - Pointer to the IMFSample interface. - - - - - Before calling ProcessOutput, set this member to zero. - - - - - Before calling ProcessOutput, set this member to NULL. - - - - - Contains information about an output stream on a Media Foundation transform (MFT). - - - - - Bitwise OR of zero or more flags from the _MFT_OUTPUT_STREAM_INFO_FLAGS enumeration. - - - - - Minimum size of each output buffer, in bytes. - - - - - The memory alignment required for output buffers. - - - - - Defines messages for a Media Foundation transform (MFT). - - - - - Requests the MFT to flush all stored data. - - - - - Requests the MFT to drain any stored data. - - - - - Sets or clears the Direct3D Device Manager for DirectX Video Accereration (DXVA). - - - - - Drop samples - requires Windows 7 - - - - - Command Tick - requires Windows 8 - - - - - Notifies the MFT that streaming is about to begin. - - - - - Notifies the MFT that streaming is about to end. - - - - - Notifies the MFT that an input stream has ended. - - - - - Notifies the MFT that the first sample is about to be processed. - - - - - Marks a point in the stream. This message applies only to asynchronous MFTs. Requires Windows 7 - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The Media Subtype - - - - - Contains statistics about the performance of the sink writer. - - - - - The size of the structure, in bytes. - - - - - The time stamp of the most recent sample given to the sink writer. - - - - - The time stamp of the most recent sample to be encoded. - - - - - The time stamp of the most recent sample given to the media sink. - - - - - The time stamp of the most recent stream tick. - - - - - The system time of the most recent sample request from the media sink. - - - - - The number of samples received. - - - - - The number of samples encoded. - - - - - The number of samples given to the media sink. - - - - - The number of stream ticks received. - - - - - The amount of data, in bytes, currently waiting to be processed. - - - - - The total amount of data, in bytes, that has been sent to the media sink. - - - - - The number of pending sample requests. - - - - - The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink. - - - - - Contains flags for registering and enumeration Media Foundation transforms (MFTs). - - - - - None - - - - - The MFT performs synchronous data processing in software. - - - - - The MFT performs asynchronous data processing in software. - - - - - The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. - - - - - The MFT that must be unlocked by the application before use. - - - - - For enumeration, include MFTs that were registered in the caller's process. - - - - - The MFT is optimized for transcoding rather than playback. - - - - - For enumeration, sort and filter the results. - - - - - Bitwise OR of all the flags, excluding MFT_ENUM_FLAG_SORTANDFILTER. - - - - - Indicates the status of an input stream on a Media Foundation transform (MFT). - - - - - None - - - - - The input stream can receive more data at this time. - - - - - Describes an input stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of input data must contain complete, unbroken units of data. - - - - - Each media sample that the client provides as input must contain exactly one unit of data, as defined for the MFT_INPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All input samples must be the same size. - - - - - MTF Input Stream Holds buffers - - - - - The MFT does not hold input samples after the IMFTransform::ProcessInput method returns. - - - - - This input stream can be removed by calling IMFTransform::DeleteInputStream. - - - - - This input stream is optional. - - - - - The MFT can perform in-place processing. - - - - - Defines flags for the IMFTransform::ProcessOutput method. - - - - - None - - - - - The MFT can still generate output from this stream without receiving any more input. - - - - - The format has changed on this output stream, or there is a new preferred format for this stream. - - - - - The MFT has removed this output stream. - - - - - There is no sample ready for this stream. - - - - - Indicates whether a Media Foundation transform (MFT) can produce output data. - - - - - None - - - - - There is a sample available for at least one output stream. - - - - - Describes an output stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of output data from the MFT contains complete, unbroken units of data. - - - - - Each output sample contains exactly one unit of data, as defined for the MFT_OUTPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All output samples are the same size. - - - - - The MFT can discard the output data from this output stream, if requested by the client. - - - - - This output stream is optional. - - - - - The MFT provides the output samples for this stream, either by allocating them internally or by operating directly on the input samples. - - - - - The MFT can either provide output samples for this stream or it can use samples that the client allocates. - - - - - The MFT does not require the client to process the output for this stream. - - - - - The MFT might remove this output stream during streaming. - - - - - Defines flags for processing output samples in a Media Foundation transform (MFT). - - - - - None - - - - - Do not produce output for streams in which the pSample member of the MFT_OUTPUT_DATA_BUFFER structure is NULL. - - - - - Regenerates the last output sample. - - - - - Process Output Status flags - - - - - None - - - - - The Media Foundation transform (MFT) has created one or more new output streams. - - - - - Defines flags for the setting or testing the media type on a Media Foundation transform (MFT). - - - - - None - - - - - Test the proposed media type, but do not set it. - - - - - Media Type helper class, simplifying working with IMFMediaType - (will probably change in the future, to inherit from an attributes class) - Currently does not release the COM object, so you must do that yourself - - - - - Wraps an existing IMFMediaType object - - The IMFMediaType object - - - - Creates and wraps a new IMFMediaType object - - - - - Creates and wraps a new IMFMediaType object based on a WaveFormat - - WaveFormat - - - - Tries to get a UINT32 value, returning a default value if it doesn't exist - - Attribute key - Default value - Value or default if key doesn't exist - - - - The Sample Rate (valid for audio media types) - - - - - The number of Channels (valid for audio media types) - - - - - The number of bits per sample (n.b. not always valid for compressed audio types) - - - - - The average bytes per second (valid for audio media types) - - - - - The Media Subtype. For audio, is a value from the AudioSubtypes class - - - - - The Major type, e.g. audio or video (from the MediaTypes class) - - - - - Access to the actual IMFMediaType object - Use to pass to MF APIs or Marshal.ReleaseComObject when you are finished with it - - - - - An abstract base class for simplifying working with Media Foundation Transforms - You need to override the method that actually creates and configures the transform - - - - - The Source Provider - - - - - The Output WaveFormat - - - - - Constructs a new MediaFoundationTransform wrapper - Will read one second at a time - - The source provider for input data to the transform - The desired output format - - - - To be implemented by overriding classes. Create the transform object, set up its input and output types, - and configure any custom properties in here - - An object implementing IMFTrasform - - - - Disposes this MediaFoundation transform - - - - - Disposes this Media Foundation Transform - - - - - Destructor - - - - - The output WaveFormat of this Media Foundation Transform - - - - - Reads data out of the source, passing it through the transform - - Output buffer - Offset within buffer to write to - Desired byte count - Number of bytes read - - - - Attempts to read from the transform - Some useful info here: - http://msdn.microsoft.com/en-gb/library/windows/desktop/aa965264%28v=vs.85%29.aspx#process_data - - - - - - Indicate that the source has been repositioned and completely drain out the transforms buffers - - - - - Represents a MIDI meta event with raw data - - - - - Raw data contained in the meta event - - - - - Creates a meta event with raw data - - - - - Creates a deep clone of this MIDI event. - - - - - Describes this meta event - - - - - - - - - - MIDI In Message Information - - - - - Create a new MIDI In Message EventArgs - - - - - - - The Raw message received from the MIDI In API - - - - - The raw message interpreted as a MidiEvent - - - - - The timestamp in milliseconds for this message - - - - - Represents a MIDI Channel AfterTouch Event. - - - - - Creates a new ChannelAfterTouchEvent from raw MIDI data - - A binary reader - - - - Creates a new Channel After-Touch Event - - Absolute time - Channel - After-touch pressure - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The aftertouch pressure value - - - - - Represents a MIDI control change event - - - - - Reads a control change event from a MIDI stream - - Binary reader on the MIDI stream - - - - Creates a control change event - - Time - MIDI Channel Number - The MIDI Controller - Controller value - - - - Describes this control change event - - A string describing this event - - - - - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The controller number - - - - - The controller value - - - - - Represents a MIDI key signature event event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new Key signature event with the specified data - - - - - Creates a deep clone of this MIDI event. - - - - - Number of sharps or flats - - - - - Major or Minor key - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event - - - - - Gets the type of this meta event - - - - - Empty constructor - - - - - Custom constructor for use by derived types, who will manage the data themselves - - Meta event type - Meta data length - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Reads a meta-event from a stream - - A binary reader based on the stream of MIDI data - A new MetaEvent object - - - - Describes this meta event - - - - - - - - - - MIDI MetaEvent Type - - - - Track sequence number - - - Text event - - - Copyright - - - Sequence track name - - - Track instrument name - - - Lyric - - - Marker - - - Cue point - - - Program (patch) name - - - Device (port) name - - - MIDI Channel (not official?) - - - MIDI Port (not official?) - - - End track - - - Set tempo - - - SMPTE offset - - - Time signature - - - Key signature - - - Sequencer specific - - - - MIDI command codes - - - - Note Off - - - Note On - - - Key After-touch - - - Control change - - - Patch change - - - Channel after-touch - - - Pitch wheel change - - - Sysex message - - - Eox (comes at end of a sysex message) - - - Timing clock (used when synchronization is required) - - - Start sequence - - - Continue sequence - - - Stop sequence - - - Auto-Sensing - - - Meta-event - - - - MidiController enumeration - http://www.midi.org/techspecs/midimessages.php#3 - - - - Bank Select (MSB) - - - Modulation (MSB) - - - Breath Controller - - - Foot controller (MSB) - - - Main volume - - - Pan - - - Expression - - - Bank Select LSB - - - Sustain - - - Portamento On/Off - - - Sostenuto On/Off - - - Soft Pedal On/Off - - - Legato Footswitch - - - Reset all controllers - - - All notes off - - - - Represents an individual MIDI event - - - - The MIDI command code - - - - Creates a MidiEvent from a raw message received using - the MME MIDI In APIs - - The short MIDI message - A new MIDI Event - - - - Constructs a MidiEvent from a BinaryStream - - The binary stream of MIDI data - The previous MIDI event (pass null for first event) - A new MidiEvent - - - - Converts this MIDI event to a short message (32 bit integer) that - can be sent by the Windows MIDI out short message APIs - Cannot be implemented for all MIDI messages - - A short message - - - - Default constructor - - - - - Creates a MIDI event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - - - - Creates a deep clone of this MIDI event. - - - - - The MIDI Channel Number for this event (1-16) - - - - - The Delta time for this event - - - - - The absolute time for this event - - - - - The command code for this event - - - - - Whether this is a note off event - - - - - Whether this is a note on event - - - - - Determines if this is an end track event - - - - - Displays a summary of the MIDI event - - A string containing a brief description of this MIDI event - - - - Utility function that can read a variable length integer from a binary stream - - The binary stream - The integer read - - - - Writes a variable length integer to a binary stream - - Binary stream - The value to write - - - - Exports this MIDI event's data - Overriden in derived classes, but they should call this version - - Absolute time used to calculate delta. - Is updated ready for the next delta calculation - Stream to write to - - - - A helper class to manage collection of MIDI events - It has the ability to organise them in tracks - - - - - Creates a new Midi Event collection - - Initial file type - Delta Ticks Per Quarter Note - - - - The number of tracks - - - - - The absolute time that should be considered as time zero - Not directly used here, but useful for timeshifting applications - - - - - The number of ticks per quarter note - - - - - Gets events on a specified track - - Track number - The list of events - - - - Gets events on a specific track - - Track number - The list of events - - - - Adds a new track - - The new track event list - - - - Adds a new track - - Initial events to add to the new track - The new track event list - - - - Removes a track - - Track number to remove - - - - Clears all events - - - - - The MIDI file type - - - - - Adds an event to the appropriate track depending on file type - - The event to be added - The original (or desired) track number - When adding events in type 0 mode, the originalTrack parameter - is ignored. If in type 1 mode, it will use the original track number to - store the new events. If the original track was 0 and this is a channel based - event, it will create new tracks if necessary and put it on the track corresponding - to its channel number - - - - Sorts, removes empty tracks and adds end track markers - - - - - Gets an enumerator for the lists of track events - - - - - Gets an enumerator for the lists of track events - - - - - Utility class for comparing MidiEvent objects - - - - - Compares two MidiEvents - Sorts by time, with EndTrack always sorted to the end - - - - - Class able to read a MIDI file - - - - - Opens a MIDI file for reading - - Name of MIDI file - - - - MIDI File format - - - - - Opens a MIDI file for reading - - Name of MIDI file - If true will error on non-paired note events - - - - Opens a MIDI file stream for reading - - The input stream containing a MIDI file - If true will error on non-paired note events - - - - The collection of events in this MIDI file - - - - - Number of tracks in this MIDI file - - - - - Delta Ticks Per Quarter Note - - - - - Describes the MIDI file - - A string describing the MIDI file and its events - - - - Exports a MIDI file - - Filename to export to - Events to export - - - - Represents a MIDI in device - - - - - Called when a MIDI message is received - - - - - An invalid MIDI message - - - - - Gets the number of MIDI input devices available in the system - - - - - Opens a specified MIDI in device - - The device number - - - - Closes this MIDI in device - - - - - Closes this MIDI in device - - - - - Start the MIDI in device - - - - - Stop the MIDI in device - - - - - Reset the MIDI in device - - - - - Gets the MIDI in device info - - - - - Closes the MIDI out device - - True if called from Dispose - - - - Cleanup - - - - - MIDI In Device Capabilities - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name - - - - - Support - Reserved - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - MIM_OPEN - - - - - MIM_CLOSE - - - - - MIM_DATA - - - - - MIM_LONGDATA - - - - - MIM_ERROR - - - - - MIM_LONGERROR - - - - - MIM_MOREDATA - - - - - MOM_OPEN - - - - - MOM_CLOSE - - - - - MOM_DONE - - - - - Represents a MIDI message - - - - - Creates a new MIDI message - - Status - Data parameter 1 - Data parameter 2 - - - - Creates a new MIDI message from a raw message - - A packed MIDI message from an MMIO function - - - - Creates a Note On message - - Note number (0 to 127) - Volume (0 to 127) - MIDI channel (1 to 16) - A new MidiMessage object - - - - Creates a Note Off message - - Note number - Volume - MIDI channel (1-16) - A new MidiMessage object - - - - Creates a patch change message - - The patch number - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Creates a Control Change message - - The controller number to change - The value to set the controller to - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Returns the raw MIDI message data - - - - - Represents a MIDI out device - - - - - Gets the number of MIDI devices available in the system - - - - - Gets the MIDI Out device info - - - - - Opens a specified MIDI out device - - The device number - - - - Closes this MIDI out device - - - - - Closes this MIDI out device - - - - - Gets or sets the volume for this MIDI out device - - - - - Resets the MIDI out device - - - - - Sends a MIDI out message - - Message - Parameter 1 - Parameter 2 - - - - Sends a MIDI message to the MIDI out device - - The message to send - - - - Closes the MIDI out device - - True if called from Dispose - - - - Send a long message, for example sysex. - - The bytes to send. - - - - Cleanup - - - - - class representing the capabilities of a MIDI out device - MIDIOUTCAPS: http://msdn.microsoft.com/en-us/library/dd798467%28VS.85%29.aspx - - - - - MIDICAPS_VOLUME - - - - - separate left-right volume control - MIDICAPS_LRVOLUME - - - - - MIDICAPS_CACHE - - - - - MIDICAPS_STREAM - driver supports midiStreamOut directly - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - Returns the number of supported voices - - - - - Gets the polyphony of the device - - - - - Returns true if the device supports all channels - - - - - Queries whether a particular channel is supported - - Channel number to test - True if the channel is supported - - - - Returns true if the device supports patch caching - - - - - Returns true if the device supports separate left and right volume - - - - - Returns true if the device supports MIDI stream out - - - - - Returns true if the device supports volume control - - - - - Returns the type of technology used by this MIDI out device - - - - - Represents the different types of technology used by a MIDI out device - - from mmsystem.h - - - The device is a MIDI port - - - The device is a MIDI synth - - - The device is a square wave synth - - - The device is an FM synth - - - The device is a MIDI mapper - - - The device is a WaveTable synth - - - The device is a software synth - - - - Represents a note MIDI event - - - - - Reads a NoteEvent from a stream of MIDI data - - Binary Reader for the stream - - - - Creates a MIDI Note Event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - MIDI Note Number - MIDI Note Velocity - - - - - - - - - The MIDI note number - - - - - The note velocity - - - - - The note name - - - - - Describes the Note Event - - Note event as a string - - - - - - - - - Represents a MIDI note on event - - - - - Reads a new Note On event from a stream of MIDI data - - Binary reader on the MIDI data stream - - - - Creates a NoteOn event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI note number - MIDI note velocity - MIDI note duration - - - - Creates a deep clone of this MIDI event. - - - - - The associated Note off event - - - - - Get or set the Note Number, updating the off event at the same time - - - - - Get or set the channel, updating the off event at the same time - - - - - The duration of this note - - - There must be a note off event - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI patch change event - - - - - Gets the default MIDI instrument names - - - - - Reads a new patch change event from a MIDI stream - - Binary reader for the MIDI stream - - - - Creates a new patch change event - - Time of the event - Channel number - Patch number - - - - The Patch Number - - - - - Describes this patch change event - - String describing the patch change event - - - - Gets as a short message for sending with the midiOutShortMsg API - - short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI pitch wheel change event - - - - - Reads a pitch wheel change event from a MIDI stream - - The MIDI stream to read from - - - - Creates a new pitch wheel change event - - Absolute event time - Channel - Pitch wheel value - - - - Describes this pitch wheel change event - - String describing this pitch wheel change event - - - - Pitch Wheel Value 0 is minimum, 0x2000 (8192) is default, 0x3FFF (16383) is maximum - - - - - Gets a short message - - Integer to sent as short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a Sequencer Specific event - - - - - Reads a new sequencer specific event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new Sequencer Specific event - - The sequencer specific data - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this sequencer specific - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Creates a new time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a deep clone of this MIDI event. - - - - - Hours - - - - - Minutes - - - - - Seconds - - - - - Frames - - - - - SubFrames - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI sysex message - - - - - Reads a sysex message from a MIDI stream - - Stream of MIDI data - a new sysex message - - - - Creates a deep clone of this MIDI event. - - - - - Describes this sysex message - - A string describing the sysex message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI tempo event - - - - - Reads a new tempo event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new tempo event with specified settings - - Microseconds per quarter note - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Describes this tempo event - - String describing the tempo event - - - - Microseconds per quarter note - - - - - Tempo - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI text event - - - - - Reads a new text event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TextEvent - - The text in this type - MetaEvent type (must be one that is - associated with text data) - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this text event - - - - - The raw contents of this text event - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TimeSignatureEvent - - Time at which to create this event - Numerator - Denominator - Ticks in Metronome Click - No of 32nd Notes in Quarter Click - - - - Creates a deep clone of this MIDI event. - - - - - Numerator (number of beats in a bar) - - - - - Denominator (Beat unit), - 1 means 2, 2 means 4 (crochet), 3 means 8 (quaver), 4 means 16 and 5 means 32 - - - - - Ticks in a metronome click - - - - - Number of 32nd notes in a quarter note - - - - - The time signature - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI track sequence number event event - - - - - Creates a new track sequence number event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a deep clone of this MIDI event. - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Chunk Identifier helpers - - - - - Chunk identifier to Int32 (replaces mmioStringToFOURCC) - - four character chunk identifier - Chunk identifier as int 32 - - - - Allows us to add descriptions to interop members - - - - - The description - - - - - Field description - - - - - String representation - - - - - - these will become extension methods once we move to .NET 3.5 - - - - - Checks if the buffer passed in is entirely full of nulls - - - - - Converts to a string containing the buffer described in hex - - - - - Decodes the buffer using the specified encoding, stopping at the first null - - - - - Concatenates the given arrays into a single array. - - The arrays to concatenate - The concatenated resulting array. - - - - Helper to get descriptions - - - - - Describes the Guid by looking for a FieldDescription attribute on the specified class - - - - - Support for Marshal Methods in both UWP and .NET 3.5 - - - - - SizeOf a structure - - - - - Offset of a field in a structure - - - - - Pointer to Structure - - - - - WavePosition extension methods - - - - - Get Position as timespan - - - - - Methods for converting between IEEE 80-bit extended double precision - and standard C# double precision. - - - - - Converts a C# double precision number to an 80-bit - IEEE extended double precision number (occupying 10 bytes). - - The double precision number to convert to IEEE extended. - An array of 10 bytes containing the IEEE extended number. - - - - Converts an IEEE 80-bit extended precision number to a - C# double precision number. - - The 80-bit IEEE extended number (as an array of 10 bytes). - A C# double precision number that is a close representation of the IEEE extended number. - - - - General purpose native methods for internal NAudio use - - - - - Helper methods for working with audio buffers - - - - - Ensures the buffer is big enough - - - - - - - - Ensures the buffer is big enough - - - - - - - - An encoding for use with file types that have one byte per character - - - - - The one and only instance of this class - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A very basic circular buffer implementation - - - - - Create a new circular buffer - - Max buffer size in bytes - - - - Write data to the buffer - - Data to write - Offset into data - Number of bytes to write - number of bytes written - - - - Read from the buffer - - Buffer to read into - Offset into read buffer - Bytes to read - Number of bytes actually read - - - - Maximum length of this circular buffer - - - - - Number of bytes currently stored in the circular buffer - - - - - Resets the buffer - - - - - Advances the buffer, discarding bytes - - Bytes to advance - - - - A util class for conversions - - - - - linear to dB conversion - - linear value - decibel value - - - - dB to linear conversion - - decibel value - linear value - - - - HResult - - - - - S_OK - - - - - S_FALSE - - - - - E_INVALIDARG (from winerror.h) - - - - - MAKE_HRESULT macro - - - - - Helper to deal with the fact that in Win Store apps, - the HResult property name has changed - - COM Exception - The HResult - - - - Pass-through stream that ignores Dispose - Useful for dealing with MemoryStreams that you want to re-use - - - - - The source stream all other methods fall through to - - - - - If true the Dispose will be ignored, if false, will pass through to the SourceStream - Set to true by default - - - - - Creates a new IgnoreDisposeStream - - The source stream - - - - Can Read - - - - - Can Seek - - - - - Can write to the underlying stream - - - - - Flushes the underlying stream - - - - - Gets the length of the underlying stream - - - - - Gets or sets the position of the underlying stream - - - - - Reads from the underlying stream - - - - - Seeks on the underlying stream - - - - - Sets the length of the underlying stream - - - - - Writes to the underlying stream - - - - - Dispose - by default (IgnoreDispose = true) will do nothing, - leaving the underlying stream undisposed - - - - - In-place and stable implementation of MergeSort - - - - - MergeSort a list of comparable items - - - - - MergeSort a list - - - - - A thread-safe Progress Log Control - - - - - Creates a new progress log control - - - - - The contents of the log as text - - - - - Log a message - - - - - Clear the log - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - ASIO 64 bit value - Unfortunately the ASIO API was implemented it before compiler supported consistently 64 bit - integer types. By using the structure the data layout on a little-endian system like the - Intel x86 architecture will result in a "non native" storage of the 64 bit data. The most - significant 32 bit are stored first in memory, the least significant bits are stored in the - higher memory space. However each 32 bit is stored in the native little-endian fashion - - - - - most significant bits (Bits 32..63) - - - - - least significant bits (Bits 0..31) - - - - - ASIO Callbacks - - - - - ASIO Buffer Switch Callback - - - - - ASIO Sample Rate Did Change Callback - - - - - ASIO Message Callback - - - - - ASIO Buffer Switch Time Info Callback - - - - - Buffer switch callback - void (*bufferSwitch) (long doubleBufferIndex, AsioBool directProcess); - - - - - Sample Rate Changed callback - void (*sampleRateDidChange) (AsioSampleRate sRate); - - - - - ASIO Message callback - long (*asioMessage) (long selector, long value, void* message, double* opt); - - - - - ASIO Buffer Switch Time Info Callback - AsioTime* (*bufferSwitchTimeInfo) (AsioTime* params, long doubleBufferIndex, AsioBool directProcess); - - - - - ASIO Channel Info - - - - - on input, channel index - - - - - Is Input - - - - - Is Active - - - - - Channel Info - - - - - ASIO Sample Type - - - - - Name - - - - - ASIODriverCapability holds all the information from the AsioDriver. - Use ASIODriverExt to get the Capabilities - - - - - Drive Name - - - - - Number of Input Channels - - - - - Number of Output Channels - - - - - Input Latency - - - - - Output Latency - - - - - Buffer Minimum Size - - - - - Buffer Maximum Size - - - - - Buffer Preferred Size - - - - - Buffer Granularity - - - - - Sample Rate - - - - - Input Channel Info - - - - - Output Channel Info - - - - - ASIO Error Codes - - - - - This value will be returned whenever the call succeeded - - - - - unique success return value for ASIOFuture calls - - - - - hardware input or output is not present or available - - - - - hardware is malfunctioning (can be returned by any ASIO function) - - - - - input parameter invalid - - - - - hardware is in a bad mode or used in a bad mode - - - - - hardware is not running when sample position is inquired - - - - - sample clock or rate cannot be determined or is not present - - - - - not enough memory for completing the request - - - - - ASIO Message Selector - - - - - selector in <value>, returns 1L if supported, - - - - - returns engine (host) asio implementation version, - - - - - request driver reset. if accepted, this - - - - - not yet supported, will currently always return 0L. - - - - - the driver went out of sync, such that - - - - - the drivers latencies have changed. The engine - - - - - if host returns true here, it will expect the - - - - - supports timecode - - - - - unused - value: number of commands, message points to mmc commands - - - - - kAsioSupportsXXX return 1 if host supports this - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - driver detected an overload - - - - - ASIO Sample Type - - - - - Int 16 MSB - - - - - Int 24 MSB (used for 20 bits as well) - - - - - Int 32 MSB - - - - - IEEE 754 32 bit float - - - - - IEEE 754 64 bit double float - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - Int 16 LSB - - - - - Int 24 LSB - used for 20 bits as well - - - - - Int 32 LSB - - - - - IEEE 754 32 bit float, as found on Intel x86 architecture - - - - - IEEE 754 64 bit double float, as found on Intel x86 architecture - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - DSD 1 bit data, 8 samples per byte. First sample in Least significant bit. - - - - - DSD 1 bit data, 8 samples per byte. First sample in Most significant bit. - - - - - DSD 8 bit data, 1 sample per byte. No Endianness required. - - - - - Main AsioDriver Class. To use this class, you need to query first the GetAsioDriverNames() and - then use the GetAsioDriverByName to instantiate the correct AsioDriver. - This is the first AsioDriver binding fully implemented in C#! - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Gets the ASIO driver names installed. - - a list of driver names. Use this name to GetAsioDriverByName - - - - Instantiate a AsioDriver given its name. - - The name of the driver - an AsioDriver instance - - - - Instantiate the ASIO driver by GUID. - - The GUID. - an AsioDriver instance - - - - Inits the AsioDriver.. - - The sys handle. - - - - - Gets the name of the driver. - - - - - - Gets the driver version. - - - - - - Gets the error message. - - - - - - Starts this instance. - - - - - Stops this instance. - - - - - Gets the number of channels. - - The num input channels. - The num output channels. - - - - Gets the latencies (n.b. does not throw an exception) - - The input latency. - The output latency. - - - - Gets the size of the buffer. - - Size of the min. - Size of the max. - Size of the preferred. - The granularity. - - - - Determines whether this instance can use the specified sample rate. - - The sample rate. - - true if this instance [can sample rate] the specified sample rate; otherwise, false. - - - - - Gets the sample rate. - - - - - - Sets the sample rate. - - The sample rate. - - - - Gets the clock sources. - - The clocks. - The num sources. - - - - Sets the clock source. - - The reference. - - - - Gets the sample position. - - The sample pos. - The time stamp. - - - - Gets the channel info. - - The channel number. - if set to true [true for input info]. - Channel Info - - - - Creates the buffers. - - The buffer infos. - The num channels. - Size of the buffer. - The callbacks. - - - - Disposes the buffers. - - - - - Controls the panel. - - - - - Futures the specified selector. - - The selector. - The opt. - - - - Notifies OutputReady to the AsioDriver. - - - - - - Releases this instance. - - - - - Handles the exception. Throws an exception based on the error. - - The error to check. - Method name - - - - Inits the vTable method from GUID. This is a tricky part of this class. - - The ASIO GUID. - - - - Internal VTable structure to store all the delegates to the C++ COM method. - - - - - Callback used by the AsioDriverExt to get wave data - - - - - AsioDriverExt is a simplified version of the AsioDriver. It provides an easier - way to access the capabilities of the Driver and implement the callbacks necessary - for feeding the driver. - Implementation inspired from Rob Philpot's with a managed C++ ASIO wrapper BlueWave.Interop.Asio - http://www.codeproject.com/KB/mcpp/Asio.Net.aspx - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Initializes a new instance of the class based on an already - instantiated AsioDriver instance. - - A AsioDriver already instantiated. - - - - Allows adjustment of which is the first output channel we write to - - Output Channel offset - Input Channel offset - - - - Gets the driver used. - - The ASIOdriver. - - - - Starts playing the buffers. - - - - - Stops playing the buffers. - - - - - Shows the control panel. - - - - - Releases this instance. - - - - - Determines whether the specified sample rate is supported. - - The sample rate. - - true if [is sample rate supported]; otherwise, false. - - - - - Sets the sample rate. - - The sample rate. - - - - Gets or sets the fill buffer callback. - - The fill buffer callback. - - - - Gets the capabilities of the AsioDriver. - - The capabilities. - - - - Creates the buffers for playing. - - The number of outputs channels. - The number of input channel. - if set to true [use max buffer size] else use Prefered size - - - - Builds the capabilities internally. - - - - - Callback called by the AsioDriver on fill buffer demand. Redirect call to external callback. - - Index of the double buffer. - if set to true [direct process]. - - - - Callback called by the AsioDriver on event "Samples rate changed". - - The sample rate. - - - - Asio message call back. - - The selector. - The value. - The message. - The opt. - - - - - Buffers switch time info call back. - - The asio time param. - Index of the double buffer. - if set to true [direct process]. - - - - - This class stores convertors for different interleaved WaveFormat to ASIOSampleType separate channel - format. - - - - - Selects the sample convertor based on the input WaveFormat and the output ASIOSampleTtype. - - The wave format. - The type. - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor SHORT - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor SHORT - - - - - Generic converter 24 LSB - - - - - Generic convertor for float - - - - - ASIO common Exception. - - - - - Gets the name of the error. - - The error. - the name of the error - - - - Flags for use with acmDriverAdd - - - - - ACM_DRIVERADDF_LOCAL - - - - - ACM_DRIVERADDF_GLOBAL - - - - - ACM_DRIVERADDF_FUNCTION - - - - - ACM_DRIVERADDF_NOTIFYHWND - - - - - Represents an installed ACM Driver - - - - - Helper function to determine whether a particular codec is installed - - The short name of the function - Whether the codec is installed - - - - Attempts to add a new ACM driver from a file - - Full path of the .acm or dll file containing the driver - Handle to the driver - - - - Removes a driver previously added using AddLocalDriver - - Local driver to remove - - - - Show Format Choose Dialog - - Owner window handle, can be null - Window title - Enumeration flags. None to get everything - Enumeration format. Only needed with certain enumeration flags - The selected format - Textual description of the selected format - Textual description of the selected format tag - True if a format was selected - - - - Gets the maximum size needed to store a WaveFormat for ACM interop functions - - - - - Finds a Driver by its short name - - Short Name - The driver, or null if not found - - - - Gets a list of the ACM Drivers installed - - - - - The callback for acmDriverEnum - - - - - Creates a new ACM Driver object - - Driver handle - - - - The short name of this driver - - - - - The full name of this driver - - - - - The driver ID - - - - - ToString - - - - - The list of FormatTags for this ACM Driver - - - - - Gets all the supported formats for a given format tag - - Format tag - Supported formats - - - - Opens this driver - - - - - Closes this driver - - - - - Dispose - - - - - Interop structure for ACM driver details (ACMDRIVERDETAILS) - http://msdn.microsoft.com/en-us/library/dd742889%28VS.85%29.aspx - - - - - DWORD cbStruct - - - - - FOURCC fccType - - - - - FOURCC fccComp - - - - - WORD wMid; - - - - - WORD wPid - - - - - DWORD vdwACM - - - - - DWORD vdwDriver - - - - - DWORD fdwSupport; - - - - - DWORD cFormatTags - - - - - DWORD cFilterTags - - - - - HICON hicon - - - - - TCHAR szShortName[ACMDRIVERDETAILS_SHORTNAME_CHARS]; - - - - - TCHAR szLongName[ACMDRIVERDETAILS_LONGNAME_CHARS]; - - - - - TCHAR szCopyright[ACMDRIVERDETAILS_COPYRIGHT_CHARS]; - - - - - TCHAR szLicensing[ACMDRIVERDETAILS_LICENSING_CHARS]; - - - - - TCHAR szFeatures[ACMDRIVERDETAILS_FEATURES_CHARS]; - - - - - ACMDRIVERDETAILS_SHORTNAME_CHARS - - - - - ACMDRIVERDETAILS_LONGNAME_CHARS - - - - - ACMDRIVERDETAILS_COPYRIGHT_CHARS - - - - - ACMDRIVERDETAILS_LICENSING_CHARS - - - - - ACMDRIVERDETAILS_FEATURES_CHARS - - - - - Flags indicating what support a particular ACM driver has - - - - ACMDRIVERDETAILS_SUPPORTF_CODEC - Codec - - - ACMDRIVERDETAILS_SUPPORTF_CONVERTER - Converter - - - ACMDRIVERDETAILS_SUPPORTF_FILTER - Filter - - - ACMDRIVERDETAILS_SUPPORTF_HARDWARE - Hardware - - - ACMDRIVERDETAILS_SUPPORTF_ASYNC - Async - - - ACMDRIVERDETAILS_SUPPORTF_LOCAL - Local - - - ACMDRIVERDETAILS_SUPPORTF_DISABLED - Disabled - - - - ACM_DRIVERENUMF_NOLOCAL, Only global drivers should be included in the enumeration - - - - - ACM_DRIVERENUMF_DISABLED, Disabled ACM drivers should be included in the enumeration - - - - - ACM Format - - - - - Format Index - - - - - Format Tag - - - - - Support Flags - - - - - WaveFormat - - - - - WaveFormat Size - - - - - Format Description - - - - - ACMFORMATCHOOSE - http://msdn.microsoft.com/en-us/library/dd742911%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD fdwStyle; - - - - - HWND hwndOwner; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - LPCTSTR pszTitle; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - LPTSTR pszName; - n.b. can be written into - - - - - DWORD cchName - Should be at least 128 unless name is zero - - - - - DWORD fdwEnum; - - - - - LPWAVEFORMATEX pwfxEnum; - - - - - HINSTANCE hInstance; - - - - - LPCTSTR pszTemplateName; - - - - - LPARAM lCustData; - - - - - ACMFORMATCHOOSEHOOKPROC pfnHook; - - - - - None - - - - - ACMFORMATCHOOSE_STYLEF_SHOWHELP - - - - - ACMFORMATCHOOSE_STYLEF_ENABLEHOOK - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATE - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATEHANDLE - - - - - ACMFORMATCHOOSE_STYLEF_INITTOWFXSTRUCT - - - - - ACMFORMATCHOOSE_STYLEF_CONTEXTHELP - - - - - ACMFORMATDETAILS - http://msdn.microsoft.com/en-us/library/dd742913%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD dwFormatIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD fdwSupport; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - ACMFORMATDETAILS_FORMAT_CHARS - - - - - Format Enumeration Flags - - - - - None - - - - - ACM_FORMATENUMF_CONVERT - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will only enumerate destination formats that can be converted from the given pwfx format. - - - - - ACM_FORMATENUMF_HARDWARE - The enumerator should only enumerate formats that are supported as native input or output formats on one or more of the installed waveform-audio devices. This flag provides a way for an application to choose only formats native to an installed waveform-audio device. This flag must be used with one or both of the ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT flags. Specifying both ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT will enumerate only formats that can be opened for input or output. This is true regardless of whether this flag is specified. - - - - - ACM_FORMATENUMF_INPUT - Enumerator should enumerate only formats that are supported for input (recording). - - - - - ACM_FORMATENUMF_NCHANNELS - The nChannels member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_NSAMPLESPERSEC - The nSamplesPerSec member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_OUTPUT - Enumerator should enumerate only formats that are supported for output (playback). - - - - - ACM_FORMATENUMF_SUGGEST - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate all suggested destination formats for the given pwfx format. This mechanism can be used instead of the acmFormatSuggest function to allow an application to choose the best suggested format for conversion. The dwFormatIndex member will always be set to zero on return. - - - - - ACM_FORMATENUMF_WBITSPERSAMPLE - The wBitsPerSample member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_WFORMATTAG - The wFormatTag member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. The dwFormatTag member of the ACMFORMATDETAILS structure must be equal to the wFormatTag member. - - - - - ACM_FORMATSUGGESTF_WFORMATTAG - - - - - ACM_FORMATSUGGESTF_NCHANNELS - - - - - ACM_FORMATSUGGESTF_NSAMPLESPERSEC - - - - - ACM_FORMATSUGGESTF_WBITSPERSAMPLE - - - - - ACM_FORMATSUGGESTF_TYPEMASK - - - - - ACM Format Tag - - - - - Format Tag Index - - - - - Format Tag - - - - - Format Size - - - - - Support Flags - - - - - Standard Formats Count - - - - - Format Description - - - - - DWORD cbStruct; - - - - - DWORD dwFormatTagIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD cbFormatSize; - - - - - DWORD fdwSupport; - - - - - DWORD cStandardFormats; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - ACMFORMATTAGDETAILS_FORMATTAG_CHARS - - - - - Interop definitions for Windows ACM (Audio Compression Manager) API - - - - - http://msdn.microsoft.com/en-us/library/dd742910%28VS.85%29.aspx - UINT ACMFORMATCHOOSEHOOKPROC acmFormatChooseHookProc( - HWND hwnd, - UINT uMsg, - WPARAM wParam, - LPARAM lParam - - - - - http://msdn.microsoft.com/en-us/library/dd742916%28VS.85%29.aspx - MMRESULT acmFormatSuggest( - HACMDRIVER had, - LPWAVEFORMATEX pwfxSrc, - LPWAVEFORMATEX pwfxDst, - DWORD cbwfxDst, - DWORD fdwSuggest); - - - - - http://msdn.microsoft.com/en-us/library/dd742928%28VS.85%29.aspx - MMRESULT acmStreamOpen( - LPHACMSTREAM phas, - HACMDRIVER had, - LPWAVEFORMATEX pwfxSrc, - LPWAVEFORMATEX pwfxDst, - LPWAVEFILTER pwfltr, - DWORD_PTR dwCallback, - DWORD_PTR dwInstance, - DWORD fdwOpen - - - - - A version with pointers for troubleshooting - - - - - AcmStream encapsulates an Audio Compression Manager Stream - used to convert audio from one format to another - - - - - Creates a new ACM stream to convert one format to another. Note that - not all conversions can be done in one step - - The source audio format - The destination audio format - - - - Creates a new ACM stream to convert one format to another, using a - specified driver identified and wave filter - - the driver identifier - the source format - the wave filter - - - - Returns the number of output bytes for a given number of input bytes - - Number of input bytes - Number of output bytes - - - - Returns the number of source bytes for a given number of destination bytes - - Number of destination bytes - Number of source bytes - - - - Suggests an appropriate PCM format that the compressed format can be converted - to in one step - - The compressed format - The PCM format - - - - Returns the Source Buffer. Fill this with data prior to calling convert - - - - - Returns the Destination buffer. This will contain the converted data - after a successful call to Convert - - - - - Report that we have repositioned in the source stream - - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of source bytes actually converted - The number of converted bytes in the DestinationBuffer - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of converted bytes in the DestinationBuffer - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - ACMSTREAMHEADER_STATUSF_DONE - - - - - ACMSTREAMHEADER_STATUSF_PREPARED - - - - - ACMSTREAMHEADER_STATUSF_INQUEUE - - - - - Interop structure for ACM stream headers. - ACMSTREAMHEADER - http://msdn.microsoft.com/en-us/library/dd742926%28VS.85%29.aspx - - - - - ACM_STREAMOPENF_QUERY, ACM will be queried to determine whether it supports the given conversion. A conversion stream will not be opened, and no handle will be returned in the phas parameter. - - - - - ACM_STREAMOPENF_ASYNC, Stream conversion should be performed asynchronously. If this flag is specified, the application can use a callback function to be notified when the conversion stream is opened and closed and after each buffer is converted. In addition to using a callback function, an application can examine the fdwStatus member of the ACMSTREAMHEADER structure for the ACMSTREAMHEADER_STATUSF_DONE flag. - - - - - ACM_STREAMOPENF_NONREALTIME, ACM will not consider time constraints when converting the data. By default, the driver will attempt to convert the data in real time. For some formats, specifying this flag might improve the audio quality or other characteristics. - - - - - CALLBACK_TYPEMASK, callback type mask - - - - - CALLBACK_NULL, no callback - - - - - CALLBACK_WINDOW, dwCallback is a HWND - - - - - CALLBACK_TASK, dwCallback is a HTASK - - - - - CALLBACK_FUNCTION, dwCallback is a FARPROC - - - - - CALLBACK_THREAD, thread ID replaces 16 bit task - - - - - CALLBACK_EVENT, dwCallback is an EVENT Handle - - - - - ACM_STREAMSIZEF_SOURCE - - - - - ACM_STREAMSIZEF_DESTINATION - - - - - Summary description for WaveFilter. - - - - - cbStruct - - - - - dwFilterTag - - - - - fdwFilter - - - - - reserved - - - - - ADSR sample provider allowing you to specify attack, decay, sustain and release values - - - - - Creates a new AdsrSampleProvider with default values - - - - - Attack time in seconds - - - - - Release time in seconds - - - - - Reads audio from this sample provider - - - - - Enters the Release phase - - - - - The output WaveFormat - - - - - Sample Provider to concatenate multiple sample providers together - - - - - Creates a new ConcatenatingSampleProvider - - The source providers to play one after the other. Must all share the same sample rate and channel count - - - - The WaveFormat of this Sample Provider - - - - - Read Samples from this sample provider - - - - - Sample Provider to allow fading in and out - - - - - Creates a new FadeInOutSampleProvider - - The source stream with the audio to be faded in or out - If true, we start faded out - - - - Requests that a fade-in begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Requests that a fade-out begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Reads samples from this sample provider - - Buffer to read into - Offset within buffer to write to - Number of samples desired - Number of samples read - - - - WaveFormat of this SampleProvider - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing sample provider, allowing re-patching of input channels to different - output channels - - Input sample providers. Must all be of the same sample rate, but can have any number of channels - Desired number of output channels. - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads samples from this sample provider - - Buffer to be filled with sample data - Offset into buffer to start writing to, usually 0 - Number of samples required - Number of samples read - - - - The output WaveFormat for this SampleProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Allows you to: - 1. insert a pre-delay of silence before the source begins - 2. skip over a certain amount of the beginning of the source - 3. only play a set amount from the source - 4. insert silence at the end after the source is complete - - - - - Number of samples of silence to insert before playing source - - - - - Amount of silence to insert before playing - - - - - Number of samples in source to discard - - - - - Amount of audio to skip over from the source before beginning playback - - - - - Number of samples to read from source (if 0, then read it all) - - - - - Amount of audio to take from the source (TimeSpan.Zero means play to end) - - - - - Number of samples of silence to insert after playing source - - - - - Amount of silence to insert after playing source - - - - - Creates a new instance of offsetSampleProvider - - The Source Sample Provider to read from - - - - The WaveFormat of this SampleProvider - - - - - Reads from this sample provider - - Sample buffer - Offset within sample buffer to read to - Number of samples required - Number of samples read - - - - Converts an IWaveProvider containing 32 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm32BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Utility class for converting to SampleProvider - - - - - Helper function to go from IWaveProvider to a SampleProvider - Must already be PCM or IEEE float - - The WaveProvider to convert - A sample provider - - - - Converts a sample provider to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts a sample provider to 24 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream, clipping if necessary - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - The Format of this IWaveProvider - - - - - - Volume of this channel. 1.0 = full scale, 0.0 to mute - - - - - Signal Generator - Sin, Square, Triangle, SawTooth, White Noise, Pink Noise, Sweep. - - - Posibility to change ISampleProvider - Example : - --------- - WaveOut _waveOutGene = new WaveOut(); - WaveGenerator wg = new SignalGenerator(); - wg.Type = ... - wg.Frequency = ... - wg ... - _waveOutGene.Init(wg); - _waveOutGene.Play(); - - - - - Initializes a new instance for the Generator (Default :: 44.1Khz, 2 channels, Sinus, Frequency = 440, Gain = 1) - - - - - Initializes a new instance for the Generator (UserDef SampleRate & Channels) - - Desired sample rate - Number of channels - - - - The waveformat of this WaveProvider (same as the source) - - - - - Frequency for the Generator. (20.0 - 20000.0 Hz) - Sin, Square, Triangle, SawTooth, Sweep (Start Frequency). - - - - - Return Log of Frequency Start (Read only) - - - - - End Frequency for the Sweep Generator. (Start Frequency in Frequency) - - - - - Return Log of Frequency End (Read only) - - - - - Gain for the Generator. (0.0 to 1.0) - - - - - Channel PhaseReverse - - - - - Type of Generator. - - - - - Length Seconds for the Sweep Generator. - - - - - Reads from this provider. - - - - - Private :: Random for WhiteNoise & Pink Noise (Value form -1 to 1) - - Random value from -1 to +1 - - - - Signal Generator type - - - - - Pink noise - - - - - White noise - - - - - Sweep - - - - - Sine wave - - - - - Square wave - - - - - Triangle Wave - - - - - Sawtooth wave - - - - - Author: Freefall - Date: 05.08.16 - Based on: the port of Stephan M. Bernsee´s pitch shifting class - Port site: https://sites.google.com/site/mikescoderama/pitch-shifting - Test application and github site: https://github.com/Freefall63/NAudio-Pitchshifter - - NOTE: I strongly advice to add a Limiter for post-processing. - For my needs the FastAttackCompressor1175 provides acceptable results: - https://github.com/Jiyuu/SkypeFX/blob/master/JSNet/FastAttackCompressor1175.cs - - UPDATE: Added a simple Limiter based on the pydirac implementation. - https://github.com/echonest/remix/blob/master/external/pydirac225/source/Dirac_LE.cpp - - - - - - Creates a new SMB Pitch Shifting Sample Provider with default settings - - Source provider - - - - Creates a new SMB Pitch Shifting Sample Provider with custom settings - - Source provider - FFT Size (any power of two <= 4096: 4096, 2048, 1024, 512, ...) - Oversampling (number of overlapping windows) - Initial pitch (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - Read from this sample provider - - - - - WaveFormat - - - - - Pitch Factor (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - - Takes a stereo input and turns it to mono - - - - - Creates a new mono ISampleProvider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this SampleProvider - - - - - Helper class turning an already 64 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Fully managed resampling sample provider, based on the WDL Resampler - - - - - Constructs a new resampler - - Source to resample - Desired output sample rate - - - - Reads from this sample provider - - - - - Output WaveFormat - - - - - Sample provider interface to make WaveChannel32 extensible - Still a bit ugly, hence internal at the moment - and might even make these into - bit depth converting WaveProviders - - - - - A sample provider mixer, allowing inputs to be added and removed - - - - - Creates a new MixingSampleProvider, with no inputs, but a specified WaveFormat - - The WaveFormat of this mixer. All inputs must be in this format - - - - Creates a new MixingSampleProvider, based on the given inputs - - Mixer inputs - must all have the same waveformat, and must - all be of the same WaveFormat. There must be at least one input - - - - Returns the mixer inputs (read-only - use AddMixerInput to add an input - - - - - When set to true, the Read method always returns the number - of samples requested, even if there are no inputs, or if the - current inputs reach their end. Setting this to true effectively - makes this a never-ending sample provider, so take care if you plan - to write it out to a file. - - - - - Adds a WaveProvider as a Mixer input. - Must be PCM or IEEE float already - - IWaveProvider mixer input - - - - Adds a new mixer input - - Mixer input - - - - Raised when a mixer input has been removed because it has ended - - - - - Removes a mixer input - - Mixer input to remove - - - - Removes all mixer inputs - - - - - The output WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - SampleProvider event args - - - - - Constructs a new SampleProviderEventArgs - - - - - The Sample Provider - - - - - Converts a mono sample provider to stereo, with a customisable pan strategy - - - - - Initialises a new instance of the PanningSampleProvider - - Source sample provider, must be mono - - - - Pan value, must be between -1 (left) and 1 (right) - - - - - The pan strategy currently in use - - - - - The WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Pair of floating point values, representing samples or multipliers - - - - - Left value - - - - - Right value - - - - - Required Interface for a Panning Strategy - - - - - Gets the left and right multipliers for a given pan value - - Pan value from -1 to 1 - Left and right multipliers in a stereo sample pair - - - - Simplistic "balance" control - treating the mono input as if it was stereo - In the centre, both channels full volume. Opposite channel decays linearly - as balance is turned to to one side - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Square Root Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Sinus Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Linear Pan - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Simple SampleProvider that passes through audio unchanged and raises - an event every n samples with the maximum sample value from the period - for metering purposes - - - - - Number of Samples per notification - - - - - Raised periodically to inform the user of the max volume - - - - - Initialises a new instance of MeteringSampleProvider that raises 10 stream volume - events per second - - Source sample provider - - - - Initialises a new instance of MeteringSampleProvider - - source sampler provider - Number of samples between notifications - - - - The WaveFormat of this sample provider - - - - - Reads samples from this Sample Provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Event args for aggregated stream volume - - - - - Max sample values array (one for each channel) - - - - - Simple class that raises an event on every sample - - - - - Initializes a new instance of NotifyingSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Sample notifier - - - - - Very simple sample provider supporting adjustable gain - - - - - Initializes a new instance of VolumeSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Helper base class for classes converting to ISampleProvider - - - - - Source Wave Provider - - - - - Source buffer (to avoid constantly creating small buffers during playback) - - - - - Initialises a new instance of SampleProviderConverterBase - - Source Wave provider - - - - Wave format of this wave provider - - - - - Reads samples from the source wave provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Ensure the source buffer exists and is big enough - - Bytes required - - - - Helper class for when you need to convert back to an IWaveProvider from - an ISampleProvider. Keeps it as IEEE float - - - - - Initializes a new instance of the WaveProviderFloatToWaveProvider class - - Source wave provider - - - - Reads from this provider - - - - - The waveformat of this WaveProvider (same as the source) - - - - - No nonsense mono to stereo provider, no volume adjustment, - just copies input to left and right. - - - - - Initializes a new instance of MonoToStereoSampleProvider - - Source sample provider - - - - WaveFormat of this provider - - - - - Reads samples from this provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Multiplier for left channel (default is 1.0) - - - - - Multiplier for right channel (default is 1.0) - - - - - Helper class turning an already 32 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Converts an IWaveProvider containing 16 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm16BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Samples required - Number of samples read - - - - Converts an IWaveProvider containing 24 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm24BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 8 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm8BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples to read - Number of samples read - - - - Utility class that takes an IWaveProvider input at any bit depth - and exposes it as an ISampleProvider. Can turn mono inputs into stereo, - and allows adjusting of volume - (The eventual successor to WaveChannel32) - This class also serves as an example of how you can link together several simple - Sample Providers to form a more useful class. - - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - force mono inputs to become stereo - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - The WaveFormat of this Sample Provider - - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Raised periodically to inform the user of the max volume - (before the volume meter) - - - - - Useful extension methods to make switching between WaveAndSampleProvider easier - - - - - Converts a WaveProvider into a SampleProvider (only works for PCM) - - WaveProvider to convert - - - - - Allows sending a SampleProvider directly to an IWavePlayer without needing to convert - back to an IWaveProvider - - The WavePlayer - - - - - - Turns WaveFormatExtensible into a standard waveformat if possible - - Input wave format - A standard PCM or IEEE waveformat, or the original waveformat - - - - Converts a ISampleProvider to a IWaveProvider but still 32 bit float - - SampleProvider to convert - An IWaveProvider - - - - Converts a ISampleProvider to a IWaveProvider but and convert to 16 bit - - SampleProvider to convert - A 16 bit IWaveProvider - - - - Concatenates one Sample Provider on the end of another - - The sample provider to play first - The sample provider to play next - A single sampleprovider to play one after the other - - - - Concatenates one Sample Provider on the end of another with silence inserted - - The sample provider to play first - Silence duration to insert between the two - The sample provider to play next - A single sample provider - - - - Skips over a specified amount of time (by consuming source stream) - - Source sample provider - Duration to skip over - A sample provider that skips over the specified amount of time - - - - Takes a specified amount of time from the source stream - - Source sample provider - Duration to take - A sample provider that reads up to the specified amount of time - - - - Converts a Stereo Sample Provider to mono, allowing mixing of channel volume - - Stereo Source Provider - Amount of left channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - Amount of right channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - A mono SampleProvider - - - - Converts a Mono ISampleProvider to stereo - - Mono Source Provider - Amount to mix to left channel (1.0 is full volume) - Amount to mix to right channel (1.0 is full volume) - - - - - Recording using waveIn api with event callbacks. - Use this for recording in non-gui applications - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Start recording - - - - - Stop recording - - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - Channel Mode - - - - - Stereo - - - - - Joint Stereo - - - - - Dual Channel - - - - - Mono - - - - - An ID3v2 Tag - - - - - Reads an ID3v2 tag from a stream - - - - - Creates a new ID3v2 tag from a collection of key-value pairs. - - A collection of key-value pairs containing the tags to include in the ID3v2 tag. - A new ID3v2 tag - - - - Convert the frame size to a byte array. - - The frame body size. - - - - - Creates an ID3v2 frame for the given key-value pair. - - - - - - - - Gets the Id3v2 Header size. The size is encoded so that only 7 bits per byte are actually used. - - - - - - - Creates the Id3v2 tag header and returns is as a byte array. - - The Id3v2 frames that will be included in the file. This is used to calculate the ID3v2 tag size. - - - - - Creates the Id3v2 tag for the given key-value pairs and returns it in the a stream. - - - - - - - Raw data from this tag - - - - - Interface for MP3 frame by frame decoder - - - - - Decompress a single MP3 frame - - Frame to decompress - Output buffer - Offset within output buffer - Bytes written to output buffer - - - - Tell the decoder that we have repositioned - - - - - PCM format that we are converting into - - - - - Represents an MP3 Frame - - - - - Reads an MP3 frame from a stream - - input stream - A valid MP3 frame, or null if none found - - - Reads an MP3Frame from a stream - http://mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm has some good info - also see http://www.codeproject.com/KB/audio-video/mpegaudioinfo.aspx - - A valid MP3 frame, or null if none found - - - - Constructs an MP3 frame - - - - - checks if the four bytes represent a valid header, - if they are, will parse the values into Mp3Frame - - - - - Sample rate of this frame - - - - - Frame length in bytes - - - - - Bit Rate - - - - - Raw frame data (includes header bytes) - - - - - MPEG Version - - - - - MPEG Layer - - - - - Channel Mode - - - - - The number of samples in this frame - - - - - The channel extension bits - - - - - The bitrate index (directly from the header) - - - - - Whether the Copyright bit is set - - - - - Whether a CRC is present - - - - - Not part of the MP3 frame itself - indicates where in the stream we found this header - - - - - MP3 Frame Decompressor using ACM - - - - - Creates a new ACM frame decompressor - - The MP3 source format - - - - Output format (PCM) - - - - - Decompresses a frame - - The MP3 frame - destination buffer - Offset within destination buffer - Bytes written into destination buffer - - - - Resets the MP3 Frame Decompressor after a reposition operation - - - - - Disposes of this MP3 frame decompressor - - - - - Finalizer ensuring that resources get released properly - - - - - MPEG Layer flags - - - - - Reserved - - - - - Layer 3 - - - - - Layer 2 - - - - - Layer 1 - - - - - MPEG Version Flags - - - - - Version 2.5 - - - - - Reserved - - - - - Version 2 - - - - - Version 1 - - - - - Represents a Xing VBR header - - - - - Load Xing Header - - Frame - Xing Header - - - - Sees if a frame contains a Xing header - - - - - Number of frames - - - - - Number of bytes - - - - - VBR Scale property - - - - - The MP3 frame - - - - ACM_METRIC_COUNT_DRIVERS - - - ACM_METRIC_COUNT_CODECS - - - ACM_METRIC_COUNT_CONVERTERS - - - ACM_METRIC_COUNT_FILTERS - - - ACM_METRIC_COUNT_DISABLED - - - ACM_METRIC_COUNT_HARDWARE - - - ACM_METRIC_COUNT_LOCAL_DRIVERS - - - ACM_METRIC_COUNT_LOCAL_CODECS - - - ACM_METRIC_COUNT_LOCAL_CONVERTERS - - - ACM_METRIC_COUNT_LOCAL_FILTERS - - - ACM_METRIC_COUNT_LOCAL_DISABLED - - - ACM_METRIC_HARDWARE_WAVE_INPUT - - - ACM_METRIC_HARDWARE_WAVE_OUTPUT - - - ACM_METRIC_MAX_SIZE_FORMAT - - - ACM_METRIC_MAX_SIZE_FILTER - - - ACM_METRIC_DRIVER_SUPPORT - - - ACM_METRIC_DRIVER_PRIORITY - - - - ACM_STREAMCONVERTF_BLOCKALIGN - - - - - ACM_STREAMCONVERTF_START - - - - - ACM_STREAMCONVERTF_END - - - - - WaveHeader interop structure (WAVEHDR) - http://msdn.microsoft.com/en-us/library/dd743837%28VS.85%29.aspx - - - - pointer to locked data buffer (lpData) - - - length of data buffer (dwBufferLength) - - - used for input only (dwBytesRecorded) - - - for client's use (dwUser) - - - assorted flags (dwFlags) - - - loop control counter (dwLoops) - - - PWaveHdr, reserved for driver (lpNext) - - - reserved for driver - - - - Wave Header Flags enumeration - - - - - WHDR_BEGINLOOP - This buffer is the first buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_DONE - Set by the device driver to indicate that it is finished with the buffer and is returning it to the application. - - - - - WHDR_ENDLOOP - This buffer is the last buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_INQUEUE - Set by Windows to indicate that the buffer is queued for playback. - - - - - WHDR_PREPARED - Set by Windows to indicate that the buffer has been prepared with the waveInPrepareHeader or waveOutPrepareHeader function. - - - - - WASAPI Loopback Capture - based on a contribution from "Pygmy" - http://naudio.codeplex.com/discussions/203605 - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Gets the default audio loopback capture device - - The default audio loopback capture device - - - - Capturing wave format - - - - - Specify loopback - - - - - Allows recording using the Windows waveIn APIs - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Creates a WaveIn device using the specified window handle for callbacks - - A valid window handle - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Called when we get a new buffer of recorded data - - - - - Start recording - - - - - Stop recording - - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - WaveInCapabilities structure (based on WAVEINCAPS2 from mmsystem.h) - http://msdn.microsoft.com/en-us/library/ms713726(VS.85).aspx - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Number of channels supported - - - - - The product name - - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name from the registry if supported - - - - - Event Args for WaveInStream event - - - - - Creates new WaveInEventArgs - - - - - Buffer containing recorded data. Note that it might not be completely - full. - - - - - The number of recorded bytes in Buffer. - - - - - MME Wave function interop - - - - - CALLBACK_NULL - No callback - - - - - CALLBACK_FUNCTION - dwCallback is a FARPROC - - - - - CALLBACK_EVENT - dwCallback is an EVENT handle - - - - - CALLBACK_WINDOW - dwCallback is a HWND - - - - - CALLBACK_THREAD - callback is a thread ID - - - - - WIM_OPEN - - - - - WIM_CLOSE - - - - - WIM_DATA - - - - - WOM_CLOSE - - - - - WOM_DONE - - - - - WOM_OPEN - - - - - WaveOutCapabilities structure (based on WAVEOUTCAPS2 from mmsystem.h) - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/multimed/htm/_win32_waveoutcaps_str.asp - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Optional functionality supported by the device - - - - - Number of channels supported - - - - - Whether playback control is supported - - - - - The product name - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Supported wave formats for WaveOutCapabilities - - - - - 11.025 kHz, Mono, 8-bit - - - - - 11.025 kHz, Stereo, 8-bit - - - - - 11.025 kHz, Mono, 16-bit - - - - - 11.025 kHz, Stereo, 16-bit - - - - - 22.05 kHz, Mono, 8-bit - - - - - 22.05 kHz, Stereo, 8-bit - - - - - 22.05 kHz, Mono, 16-bit - - - - - 22.05 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 48 kHz, Mono, 8-bit - - - - - 48 kHz, Stereo, 8-bit - - - - - 48 kHz, Mono, 16-bit - - - - - 48 kHz, Stereo, 16-bit - - - - - 96 kHz, Mono, 8-bit - - - - - 96 kHz, Stereo, 8-bit - - - - - 96 kHz, Mono, 16-bit - - - - - 96 kHz, Stereo, 16-bit - - - - - Flags indicating what features this WaveOut device supports - - - - supports pitch control (WAVECAPS_PITCH) - - - supports playback rate control (WAVECAPS_PLAYBACKRATE) - - - supports volume control (WAVECAPS_VOLUME) - - - supports separate left-right volume control (WAVECAPS_LRVOLUME) - - - (WAVECAPS_SYNC) - - - (WAVECAPS_SAMPLEACCURATE) - - - - GSM 610 - - - - - Creates a GSM 610 WaveFormat - For now hardcoded to 13kbps - - - - - Samples per block - - - - - Writes this structure to a BinaryWriter - - - - - IMA/DVI ADPCM Wave Format - Work in progress - - - - - parameterless constructor for Marshalling - - - - - Creates a new IMA / DVI ADPCM Wave Format - - Sample Rate - Number of channels - Bits Per Sample - - - - MP3 WaveFormat, MPEGLAYER3WAVEFORMAT from mmreg.h - - - - - Wave format ID (wID) - - - - - Padding flags (fdwFlags) - - - - - Block Size (nBlockSize) - - - - - Frames per block (nFramesPerBlock) - - - - - Codec Delay (nCodecDelay) - - - - - Creates a new MP3 WaveFormat - - - - - Wave Format Padding Flags - - - - - MPEGLAYER3_FLAG_PADDING_ISO - - - - - MPEGLAYER3_FLAG_PADDING_ON - - - - - MPEGLAYER3_FLAG_PADDING_OFF - - - - - Wave Format ID - - - - MPEGLAYER3_ID_UNKNOWN - - - MPEGLAYER3_ID_MPEG - - - MPEGLAYER3_ID_CONSTANTFRAMESIZE - - - - DSP Group TrueSpeech - - - - - DSP Group TrueSpeech WaveFormat - - - - - Writes this structure to a BinaryWriter - - - - - Represents a Wave file format - - - - format type - - - number of channels - - - sample rate - - - for buffer estimation - - - block size of data - - - number of bits per sample of mono data - - - number of following bytes - - - - Creates a new PCM 44.1Khz stereo 16 bit format - - - - - Creates a new 16 bit wave format with the specified sample - rate and channel count - - Sample Rate - Number of channels - - - - Gets the size of a wave buffer equivalent to the latency in milliseconds. - - The milliseconds. - - - - - Creates a WaveFormat with custom members - - The encoding - Sample Rate - Number of channels - Average Bytes Per Second - Block Align - Bits Per Sample - - - - - Creates an A-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a Mu-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a new PCM format with the specified sample rate, bit depth and channels - - - - - Creates a new 32 bit IEEE floating point wave format - - sample rate - number of channels - - - - Helper function to retrieve a WaveFormat structure from a pointer - - WaveFormat structure - - - - - Helper function to marshal WaveFormat to an IntPtr - - WaveFormat - IntPtr to WaveFormat structure (needs to be freed by callee) - - - - Reads in a WaveFormat (with extra data) from a fmt chunk (chunk identifier and - length should already have been read) - - Binary reader - Format chunk length - A WaveFormatExtraData - - - - Reads a new WaveFormat object from a stream - - A binary reader that wraps the stream - - - - Reports this WaveFormat as a string - - String describing the wave format - - - - Compares with another WaveFormat object - - Object to compare to - True if the objects are the same - - - - Provides a Hashcode for this WaveFormat - - A hashcode - - - - Returns the encoding type used - - - - - Writes this WaveFormat object to a stream - - the output stream - - - - Returns the number of channels (1=mono,2=stereo etc) - - - - - Returns the sample rate (samples per second) - - - - - Returns the average number of bytes used per second - - - - - Returns the block alignment - - - - - Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) - Can be 0 for some codecs - - - - - Returns the number of extra bytes used by this waveformat. Often 0, - except for compressed formats which store extra data after the WAVEFORMATEX header - - - - - Microsoft ADPCM - See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm - - - - - Empty constructor needed for marshalling from a pointer - - - - - Samples per block - - - - - Number of coefficients - - - - - Coefficients - - - - - Microsoft ADPCM - - Sample Rate - Channels - - - - Serializes this wave format - - Binary writer - - - - String Description of this WaveFormat - - - - - Custom marshaller for WaveFormat structures - - - - - Gets the instance of this marshaller - - - - - - - Clean up managed data - - - - - Clean up native data - - - - - - Get native data size - - - - - Marshal managed to native - - - - - Marshal Native to Managed - - - - - Summary description for WaveFormatEncoding. - - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - - - - - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - WAVE_FORMAT_EXTENSIBLE - - - - - - - WaveFormatExtensible - http://www.microsoft.com/whdc/device/audio/multichaud.mspx - - - - - Parameterless constructor for marshalling - - - - - Creates a new WaveFormatExtensible for PCM or IEEE - - - - - WaveFormatExtensible for PCM or floating point can be awkward to work with - This creates a regular WaveFormat structure representing the same audio format - Returns the WaveFormat unchanged for non PCM or IEEE float - - - - - - SubFormat (may be one of AudioMediaSubtypes) - - - - - Serialize - - - - - - String representation - - - - - This class used for marshalling from unmanaged code - - - - - Allows the extra data to be read - - - - - parameterless constructor for marshalling - - - - - Reads this structure from a BinaryReader - - - - - Writes this structure to a BinaryWriter - - - - - The WMA wave format. - May not be much use because WMA codec is a DirectShow DMO not an ACM - - - - - Generic interface for wave recording - - - - - Recording WaveFormat - - - - - Start Recording - - - - - Stop Recording - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - This class writes audio data to a .aif file on disk - - - - - Creates an Aiff file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Aiff File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - AiffFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new AiffFileWriter - - The filename to write to - The Wave Format of the output data - - - - The aiff file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - WaveFormat of this aiff file - - - - - Returns false: Cannot read from a AiffFileWriter - - - - - Returns true: Can write to a AiffFileWriter - - - - - Returns false: Cannot seek within a AiffFileWriter - - - - - Read is not supported for a AiffFileWriter - - - - - Seek is not supported for a AiffFileWriter - - - - - SetLength is not supported for AiffFileWriter - - - - - - Gets the Position in the AiffFile (i.e. number of bytes written so far) - - - - - Appends bytes to the AiffFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Aiff file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Aiff file - They will be converted to the appropriate bit depth depending on the WaveFormat of the AIF file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Aiff file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this AiffFileWriter - - - - - Raised when ASIO data has been recorded. - It is important to handle this as quickly as possible as it is in the buffer callback - - - - - Initialises a new instance of AsioAudioAvailableEventArgs - - Pointers to the ASIO buffers for each channel - Pointers to the ASIO buffers for each channel - Number of samples in each buffer - Audio format within each buffer - - - - Pointer to a buffer per input channel - - - - - Pointer to a buffer per output channel - Allows you to write directly to the output buffers - If you do so, set SamplesPerBuffer = true, - and make sure all buffers are written to with valid data - - - - - Set to true if you have written to the output buffers - If so, AsioOut will not read from its source - - - - - Number of samples in each buffer - - - - - Converts all the recorded audio into a buffer of 32 bit floating point samples, interleaved by channel - - The samples as 32 bit floating point, interleaved - - - - Audio format within each buffer - Most commonly this will be one of, Int32LSB, Int16LSB, Int24LSB or Float32LSB - - - - - Gets as interleaved samples, allocating a float array - - The samples as 32 bit floating point values - - - - ASIO Out Player. New implementation using an internal C# binding. - - This implementation is only supporting Short16Bit and Float32Bit formats and is optimized - for 2 outputs channels . - SampleRate is supported only if AsioDriver is supporting it - - This implementation is probably the first AsioDriver binding fully implemented in C#! - - Original Contributor: Mark Heath - New Contributor to C# binding : Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Playback Stopped - - - - - When recording, fires whenever recorded audio is available - - - - - Initializes a new instance of the class with the first - available ASIO Driver. - - - - - Initializes a new instance of the class with the driver name. - - Name of the device. - - - - Opens an ASIO output device - - Device number (zero based) - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Dispose - - - - - Gets the names of the installed ASIO Driver. - - an array of driver names - - - - Determines whether ASIO is supported. - - - true if ASIO is supported; otherwise, false. - - - - - Inits the driver from the asio driver name. - - Name of the driver. - - - - Shows the control panel - - - - - Starts playback - - - - - Stops playback - - - - - Pauses playback - - - - - Initialises to play - - Source wave provider - - - - Initialises to play, with optional recording - - Source wave provider - set to null for record only - Number of channels to record - Specify sample rate here if only recording, ignored otherwise - - - - driver buffer update callback to fill the wave buffer. - - The input channels. - The output channels. - - - - Gets the latency (in ms) of the playback driver - - - - - Playback State - - - - - Driver Name - - - - - The number of output channels we are currently using for playback - (Must be less than or equal to DriverOutputChannelCount) - - - - - The number of input channels we are currently recording from - (Must be less than or equal to DriverInputChannelCount) - - - - - The maximum number of input channels this ASIO driver supports - - - - - The maximum number of output channels this ASIO driver supports - - - - - The number of samples per channel, per buffer. - - - - - By default the first channel on the input WaveProvider is sent to the first ASIO output. - This option sends it to the specified channel number. - Warning: make sure you don't set it higher than the number of available output channels - - the number of source channels. - n.b. Future NAudio may modify this - - - - - Input channel offset (used when recording), allowing you to choose to record from just one - specific input rather than them all - - - - - Sets the volume (1.0 is unity gain) - Not supported for ASIO Out. Set the volume on the input stream instead - - - - - Get the input channel name - - channel index (zero based) - channel name - - - - Get the output channel name - - channel index (zero based) - channel name - - - - https://tech.ebu.ch/docs/tech/tech3285.pdf - - - - - Constructs a new BextChunkInfo - - - - - Description (max 256 chars) - - - - - Originator (max 32 chars) - - - - - Originator Reference (max 32 chars) - - - - - Originator Date Time - - - - - Origination Date as string - - - - - Origination as time - - - - - Time reference (first sample count since midnight) - - - - - version 2 has loudness stuff which we don't know so using version 1 - - - - - 64 bytes http://en.wikipedia.org/wiki/UMID - - - - - for version 2 = 180 bytes (10 before are loudness values), using version 1 = 190 bytes - - - - - Coding history arbitrary length string at end of structure - http://www.ebu.ch/CMSimages/fr/tec_text_r98-1999_tcm7-4709.pdf - A=PCM,F=48000,W=16,M=stereo,T=original,CR/LF - - - - - Broadcast WAVE File Writer - - - - - Createa a new BwfWriter - - Rarget filename - WaveFormat - Chunk information - - - - Write audio data to this BWF - - - - - Flush writer, and fix up header sizes - - - - - Disposes this writer - - - - - A wave file writer that adds cue support - - - - - Writes a wave file, including a cues chunk - - - - - Adds a cue to the Wave file - - Sample position - Label text - - - - Updates the header, and writes the cues out - - - - - Media Foundation Encoder class allows you to use Media Foundation to encode an IWaveProvider - to any supported encoding format - - - - - Queries the available bitrates for a given encoding output type, sample rate and number of channels - - Audio subtype - a value from the AudioSubtypes class - The sample rate of the PCM to encode - The number of channels of the PCM to encode - An array of available bitrates in average bits per second - - - - Gets all the available media types for a particular - - Audio subtype - a value from the AudioSubtypes class - An array of available media types that can be encoded with this subtype - - - - Helper function to simplify encoding Window Media Audio - Should be supported on Vista and above (not tested) - - Input provider, must be PCM - Output file path, should end with .wma - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to MP3 - By default, will only be available on Windows 8 and above - - Input provider, must be PCM - Output file path, should end with .mp3 - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to AAC - By default, will only be available on Windows 7 and above - - Input provider, must be PCM - Output file path, should end with .mp4 (or .aac on Windows 8) - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Tries to find the encoding media type with the closest bitrate to that specified - - Audio subtype, a value from AudioSubtypes - Your encoder input format (used to check sample rate and channel count) - Your desired bitrate - The closest media type, or null if none available - - - - Creates a new encoder that encodes to the specified output media type - - Desired output media type - - - - Encodes a file - - Output filename (container type is deduced from the filename) - Input provider (should be PCM, some encoders will also allow IEEE float) - - - - Disposes this instance - - - - - - Disposes this instance - - - - - Finalizer - - - - - Stopped Event Args - - - - - Initializes a new instance of StoppedEventArgs - - An exception to report (null if no exception) - - - - An exception. Will be null if the playback or record operation stopped due to - the user requesting stop or reached the end of the input audio - - - - - IWaveBuffer interface use to store wave datas. - Data can be manipulated with arrays (,, - , ) that are pointing to the same memory buffer. - This is a requirement for all subclasses. - - Use the associated Count property based on the type of buffer to get the number of data in the - buffer. - - for the standard implementation using C# unions. - - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets the byte buffer count. - - The byte buffer count. - - - - Gets the float buffer count. - - The float buffer count. - - - - Gets the short buffer count. - - The short buffer count. - - - - Gets the int buffer count. - - The int buffer count. - - - - Represents the interface to a device that can play a WaveFile - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Initialise playback - - The waveprovider to be played - - - - Current playback state - - - - - The volume - 1.0f is full scale - Note that not all implementations necessarily support volume changes - - - - - Indicates that playback has gone into a stopped state due to - reaching the end of the input stream or an error has been encountered during playback - - - - - Interface for IWavePlayers that can report position - - - - - Position (in terms of bytes played - does not necessarily translate directly to the position within the source audio file) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Generic interface for all WaveProviders. - - - - - Gets the WaveFormat of this WaveProvider. - - The wave format. - - - - Fill the specified buffer with wave data. - - The buffer to fill of wave data. - Offset into buffer - The number of bytes to read - the number of bytes written to the buffer. - - - - NativeDirectSoundOut using DirectSound COM interop. - Contact author: Alexandre Mutel - alexandre_mutel at yahoo.fr - Modified by: Graham "Gee" Plumb - - - - - Playback Stopped - - - - - Gets the DirectSound output devices in the system - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - (40ms seems to work under Vista). - - The latency. - Selected device - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets the current position from the wave output device. - - - - - Initialise playback - - The waveprovider to be played - - - - Current playback state - - - - - - The volume 1.0 is full scale - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Determines whether the SecondaryBuffer is lost. - - - true if [is buffer lost]; otherwise, false. - - - - - Convert ms to bytes size according to WaveFormat - - The ms - number of byttes - - - - Processes the samples in a separate thread. - - - - - Stop playback - - - - - Clean up the SecondaryBuffer - - - - In DirectSound, when playback is started, - the rest of the sound that was played last time is played back as noise. - This happens even if the secondary buffer is completely silenced, - so it seems that the buffer in the primary buffer or higher is not cleared. - - - To solve this problem fill the secondary buffer with silence data when stop playback. - - - - - - Feeds the SecondaryBuffer with the WaveStream - - number of bytes to feed - - - - IDirectSound interface - - - - - IDirectSoundBuffer interface - - - - - IDirectSoundNotify interface - - - - - Instanciate DirectSound from the DLL - - The GUID. - The direct sound. - The p unk outer. - - - - DirectSound default playback device GUID - - - - - DirectSound default capture device GUID - - - - - DirectSound default device for voice playback - - - - - DirectSound default device for voice capture - - - - - The DSEnumCallback function is an application-defined callback function that enumerates the DirectSound drivers. - The system calls this function in response to the application's call to the DirectSoundEnumerate or DirectSoundCaptureEnumerate function. - - Address of the GUID that identifies the device being enumerated, or NULL for the primary device. This value can be passed to the DirectSoundCreate8 or DirectSoundCaptureCreate8 function to create a device object for that driver. - Address of a null-terminated string that provides a textual description of the DirectSound device. - Address of a null-terminated string that specifies the module name of the DirectSound driver corresponding to this device. - Address of application-defined data. This is the pointer passed to DirectSoundEnumerate or DirectSoundCaptureEnumerate as the lpContext parameter. - Returns TRUE to continue enumerating drivers, or FALSE to stop. - - - - The DirectSoundEnumerate function enumerates the DirectSound drivers installed in the system. - - callback function - User context - - - - Gets the HANDLE of the desktop window. - - HANDLE of the Desktop window - - - - Class for enumerating DirectSound devices - - - - - The device identifier - - - - - Device description - - - - - Device module name - - - - - Like IWaveProvider, but makes it much simpler to put together a 32 bit floating - point mixing engine - - - - - Gets the WaveFormat of this Sample Provider. - - The wave format. - - - - Fill the specified buffer with 32 bit floating point samples - - The buffer to fill with samples. - Offset into buffer - The number of samples to read - the number of samples written to the buffer. - - - - Playback State - - - - - Stopped - - - - - Playing - - - - - Paused - - - - - Support for playback using Wasapi - - - - - Playback Stopped - - - - - WASAPI Out shared mode, defauult - - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - Desired latency in milliseconds - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Creates a new WASAPI Output - - Device to use - - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Begin Playback - - - - - Stop playback and flush buffers - - - - - Stop playback without flushing buffers - - - - - Initialize for playing the specified wave stream - - IWaveProvider to play - - - - Playback State - - - - - Volume - - - - - Retrieve the AudioStreamVolume object for this audio stream - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Dispose - - - - - WaveBuffer class use to store wave datas. Data can be manipulated with arrays - (,,, ) that are pointing to the - same memory buffer. Use the associated Count property based on the type of buffer to get the number of - data in the buffer. - Implicit casting is now supported to float[], byte[], int[], short[]. - You must not use Length on returned arrays. - - n.b. FieldOffset is 8 now to allow it to work natively on 64 bit - - - - - Number of Bytes - - - - - Initializes a new instance of the class. - - The number of bytes. The size of the final buffer will be aligned on 4 Bytes (upper bound) - - - - Initializes a new instance of the class binded to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Binds this WaveBuffer instance to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets or sets the byte buffer count. - - The byte buffer count. - - - - Gets or sets the float buffer count. - - The float buffer count. - - - - Gets or sets the short buffer count. - - The short buffer count. - - - - Gets or sets the int buffer count. - - The int buffer count. - - - - Clears the associated buffer. - - - - - Copy this WaveBuffer to a destination buffer up to ByteBufferCount bytes. - - - - - Checks the validity of the count parameters. - - Name of the arg. - The value. - The size of value. - - - - Wave Callback Info - - - - - Callback Strategy - - - - - Window Handle (if applicable) - - - - - Sets up a new WaveCallbackInfo for function callbacks - - - - - Sets up a new WaveCallbackInfo to use a New Window - IMPORTANT: only use this on the GUI thread - - - - - Sets up a new WaveCallbackInfo to use an existing window - IMPORTANT: only use this on the GUI thread - - - - - Wave Callback Strategy - - - - - Use a function - - - - - Create a new window (should only be done if on GUI thread) - - - - - Use an existing window handle - - - - - Use an event handle - - - - - This class writes WAV data to a .wav file on disk - - - - - Creates a 16 bit Wave File from an ISampleProvider - BEWARE: the source provider must not return data indefinitely - - The filename to write to - The source sample provider - - - - Creates a Wave file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - Writes to a stream by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The stream the method will output to - The source WaveProvider - - - - WaveFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new WaveFileWriter - - The filename to write to - The Wave Format of the output data - - - - The wave file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - Total time (calculated from Length and average bytes per second) - - - - - WaveFormat of this wave file - - - - - Returns false: Cannot read from a WaveFileWriter - - - - - Returns true: Can write to a WaveFileWriter - - - - - Returns false: Cannot seek within a WaveFileWriter - - - - - Read is not supported for a WaveFileWriter - - - - - Seek is not supported for a WaveFileWriter - - - - - SetLength is not supported for WaveFileWriter - - - - - - Gets the Position in the WaveFile (i.e. number of bytes written so far) - - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Wave file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Wave file - They will be converted to the appropriate bit depth depending on the WaveFormat of the WAV file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - Also updates header, so that WAV file will be valid up to the point currently written - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this WaveFileWriter - - - - - Represents a wave out device - - - - - Indicates playback has stopped automatically - - - - - Retrieves the capabilities of a waveOut device - - Device to test - The WaveOut device capabilities - - - - Returns the number of Wave Out devices available in the system - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Creates a default WaveOut device - Will use window callbacks if called from a GUI thread, otherwise function - callbacks - - - - - Creates a WaveOut device using the specified window handle for callbacks - - A valid window handle - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Volume for this device 1.0 is full scale - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Alternative WaveOut class, making use of the Event callback - - - - - Indicates playback has stopped automatically - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Obsolete property - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Provides a buffered store of samples - Read method will return queued samples or fill buffer with zeroes - Now backed by a circular buffer - - - - - Creates a new buffered WaveProvider - - WaveFormat - - - - If true, always read the amount of data requested, padding with zeroes if necessary - By default is set to true - - - - - Buffer length in bytes - - - - - Buffer duration - - - - - If true, when the buffer is full, start throwing away data - if false, AddSamples will throw an exception when buffer is full - - - - - The number of buffered bytes - - - - - Buffered Duration - - - - - Gets the WaveFormat - - - - - Adds samples. Takes a copy of buffer, so that buffer can be reused if necessary - - - - - Reads from this WaveProvider - Will always return count bytes, since we will zero-fill the buffer if not enough available - - - - - Discards all audio from the buffer - - - - - The Media Foundation Resampler Transform - - - - - Creates the Media Foundation Resampler, allowing modifying of sample rate, bit depth and channel count - - Source provider, must be PCM - Output format, must also be PCM - - - - Creates a resampler with a specified target output sample rate - - Source provider - Output sample rate - - - - Creates and configures the actual Resampler transform - - A newly created and configured resampler MFT - - - - Gets or sets the Resampler quality. n.b. set the quality before starting to resample. - 1 is lowest quality (linear interpolation) and 60 is best quality - - - - - Disposes this resampler - - - - - WaveProvider that can mix together multiple 32 bit floating point input provider - All channels must have the same number of inputs and same sample rate - n.b. Work in Progress - not tested yet - - - - - Creates a new MixingWaveProvider32 - - - - - Creates a new 32 bit MixingWaveProvider32 - - inputs - must all have the same format. - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove an input from the mixer - - waveProvider to remove - - - - The number of inputs to this mixer - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels. Number of outputs is equal to total number of channels in inputs - - Input wave providers. Must all be of the same format, but can have any number of channels - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels - - Input wave providers. Must all be of the same format, but can have any number of channels - Desired number of output channels. (-1 means use total number of input channels) - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads data from this WaveProvider - - Buffer to be filled with sample data - Offset to write to within buffer, usually 0 - Number of bytes required - Number of bytes read - - - - The WaveFormat of this WaveProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Silence producing wave provider - Useful for playing silence when doing a WASAPI Loopback Capture - - - - - Creates a new silence producing wave provider - - Desired WaveFormat (should be PCM / IEE float - - - - Read silence from into the buffer - - - - - WaveFormat of this silence producing wave provider - - - - - Takes a stereo 16 bit input and turns it mono, allowing you to select left or right channel only or mix them together - - - - - Creates a new mono waveprovider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Converts from mono to stereo, allowing freedom to route all, some, or none of the incoming signal to left or right channels - - - - - Creates a new stereo waveprovider based on a mono input - - Mono 16 bit PCM input - - - - 1.0 to copy the mono stream to the left channel without adjusting volume - - - - - 1.0 to copy the mono stream to the right channel without adjusting volume - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Helper class allowing us to modify the volume of a 16 bit stream without converting to IEEE float - - - - - Constructs a new VolumeWaveProvider16 - - Source provider, must be 16 bit PCM - - - - Gets or sets volume. - 1.0 is full scale, 0.0 is silence, anything over 1.0 will amplify but potentially clip - - - - - WaveFormat of this WaveProvider - - - - - Read bytes from this WaveProvider - - Buffer to read into - Offset within buffer to read to - Bytes desired - Bytes read - - - - Converts IEEE float to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Creates a new WaveFloatTo16Provider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts 16 bit PCM to IEEE float, optionally adjusting volume along the way - - - - - Creates a new Wave16toFloatProvider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Buffered WaveProvider taking source data from WaveIn - - - - - Creates a new WaveInProvider - n.b. Should make sure the WaveFormat is set correctly on IWaveIn before calling - - The source of wave data - - - - Reads data from the WaveInProvider - - - - - The WaveFormat - - - - - Base class for creating a 16 bit wave provider - - - - - Initializes a new instance of the WaveProvider16 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider16 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a short array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Base class for creating a 32 bit floating point wave provider - Can also be used as a base class for an ISampleProvider that can - be plugged straight into anything requiring an IWaveProvider - - - - - Initializes a new instance of the WaveProvider32 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider32 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a float array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Utility class to intercept audio from an IWaveProvider and - save it to disk - - - - - Constructs a new WaveRecorder - - The location to write the WAV file to - The Source Wave Provider - - - - Read simply returns what the source returns, but writes to disk along the way - - - - - The WaveFormat - - - - - Closes the WAV file - - - - A read-only stream of AIFF data based on an aiff file - with an associated WaveFormat - originally contributed to NAudio by Giawa - - - - Supports opening a AIF file - The AIF is of similar nastiness to the WAV format. - This supports basic reading of uncompressed PCM AIF files, - with 8, 16, 24 and 32 bit PCM data. - - - - - Creates an Aiff File Reader based on an input stream - - The input stream containing a AIF file including header - - - - Ensures valid AIFF header and then finds data offset. - - The stream, positioned at the start of audio data - The format found - The position of the data chunk - The length of the data chunk - Additional chunks found - - - - Cleans up the resources associated with this AiffFileReader - - - - - - - - - - - - - - - Number of Samples (if possible to calculate) - - - - - Position in the AIFF file - - - - - - Reads bytes from the AIFF File - - - - - - AIFF Chunk - - - - - Chunk Name - - - - - Chunk Length - - - - - Chunk start - - - - - Creates a new AIFF Chunk - - - - - AudioFileReader simplifies opening an audio file in NAudio - Simply pass in the filename, and it will attempt to open the - file and set up a conversion path that turns into PCM IEEE float. - ACM codecs will be used for conversion. - It provides a volume property and implements both WaveStream and - ISampleProvider, making it possibly the only stage in your audio - pipeline necessary for simple playback scenarios - - - - - Initializes a new instance of AudioFileReader - - The file to open - - - - Creates the reader stream, supporting all filetypes in the core NAudio library, - and ensuring we are in PCM format - - File Name - - - - File Name - - - - - WaveFormat of this stream - - - - - Length of this stream (in bytes) - - - - - Position of this stream (in bytes) - - - - - Reads from this wave stream - - Audio buffer - Offset into buffer - Number of bytes required - Number of bytes read - - - - Reads audio from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Gets or Sets the Volume of this AudioFileReader. 1.0f is full volume - - - - - Helper to convert source to dest bytes - - - - - Helper to convert dest to source bytes - - - - - Disposes this AudioFileReader - - True if called from Dispose - - - - Helper stream that lets us read from compressed audio files with large block alignment - as though we could read any amount and reposition anywhere - - - - - Creates a new BlockAlignReductionStream - - the input stream - - - - Block alignment of this stream - - - - - Wave Format - - - - - Length of this Stream - - - - - Current position within stream - - - - - Disposes this WaveStream - - - - - Reads data from this stream - - - - - - - - - Implementation of Com IStream - - - - - Holds information on a cue: a labeled position within a Wave file - - - - - Cue position in samples - - - - - Label of the cue - - - - - Creates a Cue based on a sample position and label - - - - - - - Holds a list of cues - - - The specs for reading and writing cues from the cue and list RIFF chunks - are from http://www.sonicspot.com/guide/wavefiles.html and http://www.wotsit.org/ - ------------------------------ - The cues are stored like this: - ------------------------------ - struct CuePoint - { - Int32 dwIdentifier; - Int32 dwPosition; - Int32 fccChunk; - Int32 dwChunkStart; - Int32 dwBlockStart; - Int32 dwSampleOffset; - } - - struct CueChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwCuePoints; - CuePoint[] points; - } - ------------------------------ - Labels look like this: - ------------------------------ - struct ListHeader - { - Int32 listID; /* 'list' */ - Int32 chunkSize; /* includes the Type ID below */ - Int32 typeID; /* 'adtl' */ - } - - struct LabelChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwIdentifier; - Char[] dwText; /* Encoded with extended ASCII */ - } LabelChunk; - - - - - Creates an empty cue list - - - - - Adds an item to the list - - Cue - - - - Gets sample positions for the embedded cues - - Array containing the cue positions - - - - Gets labels for the embedded cues - - Array containing the labels - - - - Creates a cue list from the cue RIFF chunk and the list RIFF chunk - - The data contained in the cue chunk - The data contained in the list chunk - - - - Gets the cues as the concatenated cue and list RIFF chunks. - - RIFF chunks containing the cue data - - - - Number of cues - - - - - Accesses the cue at the specified index - - - - - - - Checks if the cue and list chunks exist and if so, creates a cue list - - - - - A wave file reader supporting cue reading - - - - - Loads a wavefile and supports reading cues - - - - - - Cue List (can be null if cues not present) - - - - - An interface for WaveStreams which can report notification of individual samples - - - - - A sample has been detected - - - - - Sample event arguments - - - - - Left sample - - - - - Right sample - - - - - Constructor - - - - - Class for reading any file that Media Foundation can play - Will only work in Windows Vista and above - Automatically converts to PCM - If it is a video file with multiple audio streams, it will pick out the first audio stream - - - - - Allows customisation of this reader class - - - - - Sets up the default settings for MediaFoundationReader - - - - - Allows us to request IEEE float output (n.b. no guarantee this will be accepted) - - - - - If true, the reader object created in the constructor is used in Read - Should only be set to true if you are working entirely on an STA thread, or - entirely with MTA threads. - - - - - If true, the reposition does not happen immediately, but waits until the - next call to read to be processed. - - - - - Default constructor - - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename (can also be a URL e.g. http:// mms:// file://) - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename - Advanced settings - - - - Initializes - - - - - Creates the reader (overridable by ) - - - - - Reads from this wave stream - - Buffer to read into - Offset in buffer - Bytes required - Number of bytes read; 0 indicates end of stream - - - - WaveFormat of this stream (n.b. this is after converting to PCM) - - - - - The bytesRequired of this stream in bytes (n.b may not be accurate) - - - - - Current position within this stream - - - - - Cleans up after finishing with this reader - - true if called from Dispose - - - - WaveFormat has changed - - - - - Class for reading from MP3 files - - - - - The MP3 wave format (n.b. NOT the output format of this stream - see the WaveFormat property) - - - - Supports opening a MP3 file - - - Supports opening a MP3 file - MP3 File name - Factory method to build a frame decompressor - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - Factory method to build a frame decompressor - - - - Function that can create an MP3 Frame decompressor - - A WaveFormat object describing the MP3 file format - An MP3 Frame decompressor - - - - Creates an ACM MP3 Frame decompressor. This is the default with NAudio - - A WaveFormat object based - - - - - Gets the total length of this file in milliseconds. - - - - - ID3v2 tag if present - - - - - ID3v1 tag if present - - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - This is the length in bytes of data available to be read out from the Read method - (i.e. the decompressed MP3 length) - n.b. this may return 0 for files whose length is unknown - - - - - - - - - - - - - - - Reads decompressed PCM data from our MP3 file. - - - - - Xing header if present - - - - - Disposes this WaveStream - - - - - WaveStream that simply passes on data from its source stream - (e.g. a MemoryStream) - - - - - Initialises a new instance of RawSourceWaveStream - - The source stream containing raw audio - The waveformat of the audio in the source stream - - - - Initialises a new instance of RawSourceWaveStream - - The buffer containing raw audio - Offset in the source buffer to read from - Number of bytes to read in the buffer - The waveformat of the audio in the source stream - - - - The WaveFormat of this stream - - - - - The length in bytes of this stream (if supported) - - - - - The current position in this stream - - - - - Reads data from the stream - - - - - Wave Stream for converting between sample rates - - - - - WaveStream to resample using the DMO Resampler - - Input Stream - Desired Output Format - - - - Stream Wave Format - - - - - Stream length in bytes - - - - - Stream position in bytes - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Dispose - - True if disposing (not from finalizer) - - - - Holds information about a RIFF file chunk - - - - - Creates a RiffChunk object - - - - - The chunk identifier - - - - - The chunk identifier converted to a string - - - - - The chunk length - - - - - The stream position this chunk is located at - - - - - A simple compressor - - - - - Create a new simple compressor stream - - Source stream - - - - Make-up Gain - - - - - Threshold - - - - - Ratio - - - - - Attack time - - - - - Release time - - - - - Determine whether the stream has the required amount of data. - - Number of bytes of data required from the stream. - Flag indicating whether the required amount of data is avialable. - - - - Turns gain on or off - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Gets the WaveFormat of this stream - - - - - Reads bytes from this stream - - Buffer to read into - Offset in array to read into - Number of bytes to read - Number of bytes read - - - - Disposes this stream - - true if the user called this - - - - Gets the block alignment for this stream - - - - - MediaFoundationReader supporting reading from a stream - - - - - Constructs a new media foundation reader from a stream - - - - - Creates the reader - - - - - WaveStream that converts 32 bit audio back down to 16 bit, clipping if necessary - - - - - The method reuses the same buffer to prevent - unnecessary allocations. - - - - - Creates a new Wave32To16Stream - - the source stream - - - - Sets the volume for this stream. 1.0f is full scale - - - - - - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - Destination buffer - Offset into destination buffer - - Number of bytes read. - - - - Conversion to 16 bit and clipping - - - - - - - - - - Clip indicator. Can be reset. - - - - - Disposes this WaveStream - - - - - Represents Channel for the WaveMixerStream - 32 bit output and 16 bit input - It's output is always stereo - The input stream can be panned - - - - - Creates a new WaveChannel32 - - the source stream - stream volume (1 is 0dB) - pan control (-1 to 1) - - - - Creates a WaveChannel32 with default settings - - The source stream - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - If true, Read always returns the number of bytes requested - - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Pan of this channel (from -1 to 1) - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - Sample - - - - - Raise the sample event (no check for null because it has already been done) - - - - This class supports the reading of WAV files, - providing a repositionable WaveStream that returns the raw data - contained in the WAV file - - - - Supports opening a WAV file - The WAV file format is a real mess, but we will only - support the basic WAV file format which actually covers the vast - majority of WAV files out there. For more WAV file format information - visit www.wotsit.org. If you have a WAV file that can't be read by - this class, email it to the NAudio project and we will probably - fix this reader to support it - - - - - Creates a Wave File Reader based on an input stream - - The input stream containing a WAV file including header - - - - Gets a list of the additional chunks found in this file - - - - - Gets the data for the specified chunk - - - - - Cleans up the resources associated with this WaveFileReader - - - - - - - - - - This is the length of audio data contained in this WAV file, in bytes - (i.e. the byte length of the data chunk, not the length of the WAV file itself) - - - - - - Number of Sample Frames (if possible to calculate) - This currently does not take into account number of channels - Multiply number of channels if you want the total number of samples - - - - - Position in the WAV data chunk. - - - - - - Reads bytes from the Wave File - - - - - - Attempts to read the next sample or group of samples as floating point normalised into the range -1.0f to 1.0f - - An array of samples, 1 for mono, 2 for stereo etc. Null indicates end of file reached - - - - - Attempts to read a sample into a float. n.b. only applicable for uncompressed formats - Will normalise the value read into the range -1.0f to 1.0f if it comes from a PCM encoding - - False if the end of the WAV data chunk was reached - - - - IWaveProvider that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source Provider - - - - Gets the WaveFormat of this stream - - - - - Indicates that a reposition has taken place, and internal buffers should be reset - - - - - Reads bytes from this stream - - Buffer to read into - Offset in buffer to read into - Number of bytes to read - Number of bytes read - - - - Disposes this stream - - true if the user called this - - - - Disposes this resource - - - - - Finalizer - - - - - WaveStream that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source stream - - - - Creates a stream that can convert to PCM - - The source stream - A PCM stream - - - - Gets or sets the current position in the stream - - - - - Converts source bytes to destination bytes - - - - - Converts destination bytes to source bytes - - - - - Returns the stream length - - - - - Gets the WaveFormat of this stream - - - - - - - Buffer to read into - Offset within buffer to write to - Number of bytes to read - Bytes read - - - - Disposes this stream - - true if the user called this - - - - A buffer of Wave samples - - - - - creates a new wavebuffer - - WaveIn device to write to - Buffer size in bytes - - - - Place this buffer back to record more audio - - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - - Provides access to the actual record buffer (for reading only) - - - - - Indicates whether the Done flag is set on this buffer - - - - - Indicates whether the InQueue flag is set on this buffer - - - - - Number of bytes recorded - - - - - The buffer size in bytes - - - - - WaveStream that can mix together multiple 32 bit input streams - (Normally used with stereo input channels) - All channels must have the same number of inputs - - - - - Creates a new 32 bit WaveMixerStream - - - - - Creates a new 32 bit WaveMixerStream - - An Array of WaveStreams - must all have the same format. - Use WaveChannel is designed for this purpose. - Automatically stop when all inputs have been read - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove a WaveStream from the mixer - - waveStream to remove - - - - The number of inputs to this mixer - - - - - Automatically stop when all inputs have been read - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Length of this Wave Stream (in bytes) - - - - - - Position within this Wave Stream (in bytes) - - - - - - - - - - - Disposes this WaveStream - - - - - Simply shifts the input stream in time, optionally - clipping its start and end. - (n.b. may include looping in the future) - - - - - Creates a new WaveOffsetStream - - the source stream - the time at which we should start reading from the source stream - amount to trim off the front of the source stream - length of time to play from source stream - - - - Creates a WaveOffsetStream with default settings (no offset or pre-delay, - and whole length of source stream) - - The source stream - - - - The length of time before which no audio will be played - - - - - An offset into the source stream from which to start playing - - - - - Length of time to read from the source stream - - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - A buffer of Wave samples for streaming to a Wave Output device - - - - - creates a new wavebuffer - - WaveOut device to write to - Buffer size in bytes - Stream to provide more data - Lock to protect WaveOut API's from being called on >1 thread - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - this is called by the WAVE callback and should be used to refill the buffer - - - - Whether the header's in queue flag is set - - - - - The buffer size in bytes - - - - - Base class for all WaveStream classes. Derives from stream. - - - - - Retrieves the WaveFormat for this stream - - - - - We can read from this stream - - - - - We can seek within this stream - - - - - We can't write to this stream - - - - - Flush does not need to do anything - See - - - - - An alternative way of repositioning. - See - - - - - Sets the length of the WaveStream. Not Supported. - - - - - - Writes to the WaveStream. Not Supported. - - - - - The block alignment for this wavestream. Do not modify the Position - to anything that is not a whole multiple of this value - - - - - Moves forward or backwards the specified number of seconds in the stream - - Number of seconds to move, can be negative - - - - The current position in the stream in Time format - - - - - Total length in real-time of the stream (may be an estimate for compressed files) - - - - - Whether the WaveStream has non-zero sample data at the current position for the - specified count - - Number of bytes to read - - - - Contains the name and CLSID of a DirectX Media Object - - - - - Name - - - - - CLSID - - - - - Initializes a new instance of DmoDescriptor - - - - - DirectX Media Object Enumerator - - - - - Get audio effect names - - Audio effect names - - - - Get audio encoder names - - Audio encoder names - - - - Get audio decoder names - - Audio decoder names - - - - DMO Guids for use with DMOEnum - dmoreg.h - - - - - MediaErr.h - - - - - DMO_PARTIAL_MEDIATYPE - - - - - defined in Medparam.h - - - - - Windows Media Resampler Props - wmcodecdsp.h - - - - - Range is 1 to 60 - - - - - Specifies the channel matrix. - - - - - Attempting to implement the COM IMediaBuffer interface as a .NET object - Not sure what will happen when I pass this to an unmanaged object - - - - - Creates a new Media Buffer - - Maximum length in bytes - - - - Dispose and free memory for buffer - - - - - Finalizer - - - - - Set length of valid data in the buffer - - length - HRESULT - - - - Gets the maximum length of the buffer - - Max length (output parameter) - HRESULT - - - - Gets buffer and / or length - - Pointer to variable into which buffer pointer should be written - Pointer to variable into which valid data length should be written - HRESULT - - - - Length of data in the media buffer - - - - - Loads data into this buffer - - Data to load - Number of bytes to load - - - - Retrieves the data in the output buffer - - buffer to retrieve into - offset within that buffer - - - - Media Object - - - - - Creates a new Media Object - - Media Object COM interface - - - - Number of input streams - - - - - Number of output streams - - - - - Gets the input media type for the specified input stream - - Input stream index - Input type index - DMO Media Type or null if there are no more input types - - - - Gets the DMO Media Output type - - The output stream - Output type index - DMO Media Type or null if no more available - - - - retrieves the media type that was set for an output stream, if any - - Output stream index - DMO Media Type or null if no more available - - - - Enumerates the supported input types - - Input stream index - Enumeration of input types - - - - Enumerates the output types - - Output stream index - Enumeration of supported output types - - - - Querys whether a specified input type is supported - - Input stream index - Media type to check - true if supports - - - - Sets the input type helper method - - Input stream index - Media type - Flags (can be used to test rather than set) - - - - Sets the input type - - Input stream index - Media Type - - - - Sets the input type to the specified Wave format - - Input stream index - Wave format - - - - Requests whether the specified Wave format is supported as an input - - Input stream index - Wave format - true if supported - - - - Helper function to make a DMO Media Type to represent a particular WaveFormat - - - - - Checks if a specified output type is supported - n.b. you may need to set the input type first - - Output stream index - Media type - True if supported - - - - Tests if the specified Wave Format is supported for output - n.b. may need to set the input type first - - Output stream index - Wave format - True if supported - - - - Helper method to call SetOutputType - - - - - Sets the output type - n.b. may need to set the input type first - - Output stream index - Media type to set - - - - Set output type to the specified wave format - n.b. may need to set input type first - - Output stream index - Wave format - - - - Get Input Size Info - - Input Stream Index - Input Size Info - - - - Get Output Size Info - - Output Stream Index - Output Size Info - - - - Process Input - - Input Stream index - Media Buffer - Flags - Timestamp - Duration - - - - Process Output - - Flags - Output buffer count - Output buffers - - - - Gives the DMO a chance to allocate any resources needed for streaming - - - - - Tells the DMO to free any resources needed for streaming - - - - - Gets maximum input latency - - input stream index - Maximum input latency as a ref-time - - - - Flushes all buffered data - - - - - Report a discontinuity on the specified input stream - - Input Stream index - - - - Is this input stream accepting data? - - Input Stream index - true if accepting data - - - - Experimental code, not currently being called - Not sure if it is necessary anyway - - - - - Media Object Size Info - - - - - Minimum Buffer Size, in bytes - - - - - Max Lookahead - - - - - Alignment - - - - - Media Object Size Info - - - - - ToString - - - - - MP_PARAMINFO - - - - - MP_TYPE - - - - - MPT_INT - - - - - MPT_FLOAT - - - - - MPT_BOOL - - - - - MPT_ENUM - - - - - MPT_MAX - - - - - MP_CURVE_TYPE - - - - - uuids.h, ksuuids.h - - - - - implements IMediaObject (DirectX Media Object) - implements IMFTransform (Media Foundation Transform) - On Windows XP, it is always an MM (if present at all) - - - - - Windows Media MP3 Decoder (as a DMO) - WORK IN PROGRESS - DO NOT USE! - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - DMO Input Data Buffer Flags - - - - - None - - - - - DMO_INPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_INPUT_DATA_BUFFERF_TIME - - - - - DMO_INPUT_DATA_BUFFERF_TIMELENGTH - - - - - http://msdn.microsoft.com/en-us/library/aa929922.aspx - DMO_MEDIA_TYPE - - - - - Major type - - - - - Major type name - - - - - Subtype - - - - - Subtype name - - - - - Fixed size samples - - - - - Sample size - - - - - Format type - - - - - Format type name - - - - - Gets the structure as a Wave format (if it is one) - - - - - Sets this object up to point to a wave format - - Wave format structure - - - - DMO Output Data Buffer - - - - - Creates a new DMO Output Data Buffer structure - - Maximum buffer size - - - - Dispose - - - - - Media Buffer - - - - - Length of data in buffer - - - - - Status Flags - - - - - Timestamp - - - - - Duration - - - - - Retrives the data in this buffer - - Buffer to receive data - Offset into buffer - - - - Is more data available - If true, ProcessOuput should be called again - - - - - DMO Output Data Buffer Flags - - - - - None - - - - - DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_OUTPUT_DATA_BUFFERF_TIME - - - - - DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH - - - - - DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE - - - - - DMO Process Output Flags - - - - - None - - - - - DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER - - - - - IMediaBuffer Interface - - - - - Set Length - - Length - HRESULT - - - - Get Max Length - - Max Length - HRESULT - - - - Get Buffer and Length - - Pointer to variable into which to write the Buffer Pointer - Pointer to variable into which to write the Valid Data Length - HRESULT - - - - defined in mediaobj.h - - - - - From wmcodecsdp.h - Implements: - - IMediaObject - - IMFTransform (Media foundation - we will leave this for now as there is loads of MF stuff) - - IPropertyStore - - IWMResamplerProps - Can resample PCM or IEEE - - - - - DMO Resampler - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - Soundfont generator - - - - - Gets the generator type - - - - - Generator amount as an unsigned short - - - - - Generator amount as a signed short - - - - - Low byte amount - - - - - High byte amount - - - - - Instrument - - - - - Sample Header - - - - - - - - - - Generator types - - - - Start address offset - - - End address offset - - - Start loop address offset - - - End loop address offset - - - Start address coarse offset - - - Modulation LFO to pitch - - - Vibrato LFO to pitch - - - Modulation envelope to pitch - - - Initial filter cutoff frequency - - - Initial filter Q - - - Modulation LFO to filter Cutoff frequency - - - Modulation envelope to filter cutoff frequency - - - End address coarse offset - - - Modulation LFO to volume - - - Unused - - - Chorus effects send - - - Reverb effects send - - - Pan - - - Unused - - - Unused - - - Unused - - - Delay modulation LFO - - - Frequency modulation LFO - - - Delay vibrato LFO - - - Frequency vibrato LFO - - - Delay modulation envelope - - - Attack modulation envelope - - - Hold modulation envelope - - - Decay modulation envelope - - - Sustain modulation envelop - - - Release modulation envelope - - - Key number to modulation envelope hold - - - Key number to modulation envelope decay - - - Delay volume envelope - - - Attack volume envelope - - - Hold volume envelope - - - Decay volume envelope - - - Sustain volume envelope - - - Release volume envelope - - - Key number to volume envelope hold - - - Key number to volume envelope decay - - - Instrument - - - Reserved - - - Key range - - - Velocity range - - - Start loop address coarse offset - - - Key number - - - Velocity - - - Initial attenuation - - - Reserved - - - End loop address coarse offset - - - Coarse tune - - - Fine tune - - - Sample ID - - - Sample modes - - - Reserved - - - Scale tuning - - - Exclusive class - - - Overriding root key - - - Unused - - - Unused - - - - A soundfont info chunk - - - - - SoundFont Version - - - - - WaveTable sound engine - - - - - Bank name - - - - - Data ROM - - - - - Creation Date - - - - - Author - - - - - Target Product - - - - - Copyright - - - - - Comments - - - - - Tools - - - - - ROM Version - - - - - - - - - - SoundFont instrument - - - - - instrument name - - - - - Zones - - - - - - - - - - Instrument Builder - - - - - Transform Types - - - - - Linear - - - - - Modulator - - - - - Source Modulation data type - - - - - Destination generator type - - - - - Amount - - - - - Source Modulation Amount Type - - - - - Source Transform Type - - - - - - - - - - Controller Sources - - - - - No Controller - - - - - Note On Velocity - - - - - Note On Key Number - - - - - Poly Pressure - - - - - Channel Pressure - - - - - Pitch Wheel - - - - - Pitch Wheel Sensitivity - - - - - Source Types - - - - - Linear - - - - - Concave - - - - - Convex - - - - - Switch - - - - - Modulator Type - - - - - - - - - - - A SoundFont Preset - - - - - Preset name - - - - - Patch Number - - - - - Bank number - - - - - Zones - - - - - - - - - - Class to read the SoundFont file presets chunk - - - - - The Presets contained in this chunk - - - - - The instruments contained in this chunk - - - - - The sample headers contained in this chunk - - - - - - - - - - just reads a chunk ID at the current position - - chunk ID - - - - reads a chunk at the current position - - - - - creates a new riffchunk from current position checking that we're not - at the end of this chunk first - - the new chunk - - - - useful for chunks that just contain a string - - chunk as string - - - - A SoundFont Sample Header - - - - - The sample name - - - - - Start offset - - - - - End offset - - - - - Start loop point - - - - - End loop point - - - - - Sample Rate - - - - - Original pitch - - - - - Pitch correction - - - - - Sample Link - - - - - SoundFont Sample Link Type - - - - - - - - - - SoundFont sample modes - - - - - No loop - - - - - Loop Continuously - - - - - Reserved no loop - - - - - Loop and continue - - - - - Sample Link Type - - - - - Mono Sample - - - - - Right Sample - - - - - Left Sample - - - - - Linked Sample - - - - - ROM Mono Sample - - - - - ROM Right Sample - - - - - ROM Left Sample - - - - - ROM Linked Sample - - - - - SoundFont Version Structure - - - - - Major Version - - - - - Minor Version - - - - - Builds a SoundFont version - - - - - Reads a SoundFont Version structure - - - - - Writes a SoundFont Version structure - - - - - Gets the length of this structure - - - - - Represents a SoundFont - - - - - Loads a SoundFont from a file - - Filename of the SoundFont - - - - Loads a SoundFont from a stream - - stream - - - - The File Info Chunk - - - - - The Presets - - - - - The Instruments - - - - - The Sample Headers - - - - - The Sample Data - - - - - - - - - - base class for structures that can read themselves - - - - - A SoundFont zone - - - - - - - - - - Modulators for this Zone - - - - - Generators for this Zone - - - - - Summary description for Fader. - - - - - Required designer variable. - - - - - Creates a new Fader control - - - - - Clean up any resources being used. - - - - - - - - - - - - - - - - - - - - - - - - - Minimum value of this fader - - - - - Maximum value of this fader - - - - - Current value of this fader - - - - - Fader orientation - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Pan slider control - - - - - Required designer variable. - - - - - True when pan value changed - - - - - Creates a new PanSlider control - - - - - Clean up any resources being used. - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - - - - - - - - - - - - - - - - - The current Pan setting - - - - - Control that represents a potentiometer - TODO list: - Optional Log scale - Optional reverse scale - Keyboard control - Optional bitmap mode - Optional complete draw mode - Tooltip support - - - - - Value changed event - - - - - Creates a new pot control - - - - - Minimum Value of the Pot - - - - - Maximum Value of the Pot - - - - - The current value of the pot - - - - - Draws the control - - - - - Handles the mouse down event to allow changing value by dragging - - - - - Handles the mouse up event to allow changing value by dragging - - - - - Handles the mouse down event to allow changing value by dragging - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Implements a rudimentary volume meter - - - - - Basic volume meter - - - - - On Fore Color Changed - - - - - Current Value - - - - - Minimum decibels - - - - - Maximum decibels - - - - - Meter orientation - - - - - Paints the volume meter - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - VolumeSlider control - - - - - Required designer variable. - - - - - Volume changed event - - - - - Creates a new VolumeSlider control - - - - - Clean up any resources being used. - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - - - - - - - - - - - - - - - - The volume for this control - - - - - Windows Forms control for painting audio waveforms - - - - - Constructs a new instance of the WaveFormPainter class - - - - - On Resize - - - - - On ForeColor Changed - - - - - - Add Max Value - - - - - - On Paint - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Control for viewing waveforms - - - - - Required designer variable. - - - - - Creates a new WaveViewer control - - - - - sets the associated wavestream - - - - - The zoom level, in samples per pixel - - - - - Start position (currently in bytes) - - - - - Clean up any resources being used. - - - - - - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Boolean mixer control - - - - - Gets the details for this control - - memory pointer - - - - The current value of the control - - - - - Custom Mixer control - - - - - Get the data for this custom control - - pointer to memory to receive data - - - - List text mixer control - - - - - Get the details for this control - - Memory location to read to - - - Represents a Windows mixer device - - - The number of mixer devices available - - - Connects to the specified mixer - The index of the mixer to use. - This should be between zero and NumberOfDevices - 1 - - - The number of destinations this mixer supports - - - The name of this mixer device - - - The manufacturer code for this mixer device - - - The product identifier code for this mixer device - - - Retrieve the specified MixerDestination object - The ID of the destination to use. - Should be between 0 and DestinationCount - 1 - - - - A way to enumerate the destinations - - - - - A way to enumerate all available devices - - - - - Represents a mixer control - - - - - Mixer Handle - - - - - Number of Channels - - - - - Mixer Handle Type - - - - - Gets all the mixer controls - - Mixer Handle - Mixer Line - Mixer Handle Type - - - - - Gets a specified Mixer Control - - Mixer Handle - Line ID - Control ID - Number of Channels - Flags to use (indicates the meaning of mixerHandle) - - - - - Gets the control details - - - - - Gets the control details - - - - - - Mixer control name - - - - - Mixer control type - - - - - Returns true if this is a boolean control - - Control type - - - - Is this a boolean control - - - - - Determines whether a specified mixer control type is a list text control - - - - - True if this is a list text control - - - - - True if this is a signed control - - - - - True if this is an unsigned control - - - - - True if this is a custom control - - - - - String representation for debug purposes - - - - - Mixer control types - - - - Custom - - - Boolean meter - - - Signed meter - - - Peak meter - - - Unsigned meter - - - Boolean - - - On Off - - - Mute - - - Mono - - - Loudness - - - Stereo Enhance - - - Button - - - Decibels - - - Signed - - - Unsigned - - - Percent - - - Slider - - - Pan - - - Q-sound pan - - - Fader - - - Volume - - - Bass - - - Treble - - - Equaliser - - - Single Select - - - Mux - - - Multiple select - - - Mixer - - - Micro time - - - Milli time - - - - Represents a mixer line (source or destination) - - - - - Creates a new mixer destination - - Mixer Handle - Destination Index - Mixer Handle Type - - - - Creates a new Mixer Source For a Specified Source - - Mixer Handle - Destination Index - Source Index - Flag indicating the meaning of mixerHandle - - - - Creates a new Mixer Source - - Wave In Device - - - - Mixer Line Name - - - - - Mixer Line short name - - - - - The line ID - - - - - Component Type - - - - - Mixer destination type description - - - - - Number of channels - - - - - Number of sources - - - - - Number of controls - - - - - Is this destination active - - - - - Is this destination disconnected - - - - - Is this destination a source - - - - - Gets the specified source - - - - - Enumerator for the controls on this Mixer Limne - - - - - Enumerator for the sources on this Mixer Line - - - - - The name of the target output device - - - - - Describes this Mixer Line (for diagnostic purposes) - - - - - Mixer Interop Flags - - - - - MIXER_OBJECTF_HANDLE = 0x80000000; - - - - - MIXER_OBJECTF_MIXER = 0x00000000; - - - - - MIXER_OBJECTF_HMIXER - - - - - MIXER_OBJECTF_WAVEOUT - - - - - MIXER_OBJECTF_HWAVEOUT - - - - - MIXER_OBJECTF_WAVEIN - - - - - MIXER_OBJECTF_HWAVEIN - - - - - MIXER_OBJECTF_MIDIOUT - - - - - MIXER_OBJECTF_HMIDIOUT - - - - - MIXER_OBJECTF_MIDIIN - - - - - MIXER_OBJECTF_HMIDIIN - - - - - MIXER_OBJECTF_AUX - - - - - MIXER_GETCONTROLDETAILSF_VALUE = 0x00000000; - MIXER_SETCONTROLDETAILSF_VALUE = 0x00000000; - - - - - MIXER_GETCONTROLDETAILSF_LISTTEXT = 0x00000001; - MIXER_SETCONTROLDETAILSF_LISTTEXT = 0x00000001; - - - - - MIXER_GETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_SETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_GETLINECONTROLSF_QUERYMASK = 0x0000000F; - - - - - MIXER_GETLINECONTROLSF_ALL = 0x00000000; - - - - - MIXER_GETLINECONTROLSF_ONEBYID = 0x00000001; - - - - - MIXER_GETLINECONTROLSF_ONEBYTYPE = 0x00000002; - - - - - MIXER_GETLINEINFOF_DESTINATION = 0x00000000; - - - - - MIXER_GETLINEINFOF_SOURCE = 0x00000001; - - - - - MIXER_GETLINEINFOF_LINEID = 0x00000002; - - - - - MIXER_GETLINEINFOF_COMPONENTTYPE = 0x00000003; - - - - - MIXER_GETLINEINFOF_TARGETTYPE = 0x00000004; - - - - - MIXER_GETLINEINFOF_QUERYMASK = 0x0000000F; - - - - - Mixer Line Flags - - - - - Audio line is active. An active line indicates that a signal is probably passing - through the line. - - - - - Audio line is disconnected. A disconnected line's associated controls can still be - modified, but the changes have no effect until the line is connected. - - - - - Audio line is an audio source line associated with a single audio destination line. - If this flag is not set, this line is an audio destination line associated with zero - or more audio source lines. - - - - - BOUNDS structure - - - - - dwMinimum / lMinimum / reserved 0 - - - - - dwMaximum / lMaximum / reserved 1 - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - METRICS structure - - - - - cSteps / reserved[0] - - - - - cbCustomData / reserved[1], number of bytes for control details - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - MIXERCONTROL struct - http://msdn.microsoft.com/en-us/library/dd757293%28VS.85%29.aspx - - - - - Mixer Line Component type enumeration - - - - - Audio line is a destination that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_DST_UNDEFINED - - - - - Audio line is a digital destination (for example, digital input to a DAT or CD audio device). - MIXERLINE_COMPONENTTYPE_DST_DIGITAL - - - - - Audio line is a line level destination (for example, line level input from a CD audio device) that will be the final recording source for the analog-to-digital converter (ADC). Because most audio cards for personal computers provide some sort of gain for the recording audio source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_DST_WAVEIN type. - MIXERLINE_COMPONENTTYPE_DST_LINE - - - - - Audio line is a destination used for a monitor. - MIXERLINE_COMPONENTTYPE_DST_MONITOR - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive speakers. This is the typical component type for the audio output of audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_SPEAKERS - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive headphones. Most audio cards use the same audio destination line for speakers and headphones, in which case the mixer device simply uses the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS type. - MIXERLINE_COMPONENTTYPE_DST_HEADPHONES - - - - - Audio line is a destination that will be routed to a telephone line. - MIXERLINE_COMPONENTTYPE_DST_TELEPHONE - - - - - Audio line is a destination that will be the final recording source for the waveform-audio input (ADC). This line typically provides some sort of gain or attenuation. This is the typical component type for the recording line of most audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_WAVEIN - - - - - Audio line is a destination that will be the final recording source for voice input. This component type is exactly like MIXERLINE_COMPONENTTYPE_DST_WAVEIN but is intended specifically for settings used during voice recording/recognition. Support for this line is optional for a mixer device. Many mixer devices provide only MIXERLINE_COMPONENTTYPE_DST_WAVEIN. - MIXERLINE_COMPONENTTYPE_DST_VOICEIN - - - - - Audio line is a source that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_SRC_UNDEFINED - - - - - Audio line is a digital source (for example, digital output from a DAT or audio CD). - MIXERLINE_COMPONENTTYPE_SRC_DIGITAL - - - - - Audio line is a line-level source (for example, line-level input from an external stereo) that can be used as an optional recording source. Because most audio cards for personal computers provide some sort of gain for the recording source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY type. - MIXERLINE_COMPONENTTYPE_SRC_LINE - - - - - Audio line is a microphone recording source. Most audio cards for personal computers provide at least two types of recording sources: an auxiliary audio line and microphone input. A microphone audio line typically provides some sort of gain. Audio cards that use a single input for use with a microphone or auxiliary audio line should use the MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE component type. - MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE - - - - - Audio line is a source originating from the output of an internal synthesizer. Most audio cards for personal computers provide some sort of MIDI synthesizer (for example, an Adlib®-compatible or OPL/3 FM synthesizer). - MIXERLINE_COMPONENTTYPE_SRC_SYNTHESIZER - - - - - Audio line is a source originating from the output of an internal audio CD. This component type is provided for audio cards that provide an audio source line intended to be connected to an audio CD (or CD-ROM playing an audio CD). - MIXERLINE_COMPONENTTYPE_SRC_COMPACTDISC - - - - - Audio line is a source originating from an incoming telephone line. - MIXERLINE_COMPONENTTYPE_SRC_TELEPHONE - - - - - Audio line is a source originating from personal computer speaker. Several audio cards for personal computers provide the ability to mix what would typically be played on the internal speaker with the output of an audio card. Some audio cards support the ability to use this output as a recording source. - MIXERLINE_COMPONENTTYPE_SRC_PCSPEAKER - - - - - Audio line is a source originating from the waveform-audio output digital-to-analog converter (DAC). Most audio cards for personal computers provide this component type as a source to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination. Some cards also allow this source to be routed to the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_WAVEOUT - - - - - Audio line is a source originating from the auxiliary audio line. This line type is intended as a source with gain or attenuation that can be routed to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination and/or recorded from the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY - - - - - Audio line is an analog source (for example, analog output from a video-cassette tape). - MIXERLINE_COMPONENTTYPE_SRC_ANALOG - - - - - Represents a signed mixer control - - - - - Gets details for this contrl - - - - - The value of the control - - - - - Minimum value for this control - - - - - Maximum value for this control - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - - Represents an unsigned mixer control - - - - - Gets the details for this control - - - - - The control value - - - - - The control's minimum value - - - - - The control's maximum value - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - Manufacturer codes from mmreg.h - - - - Microsoft Corporation - - - Creative Labs, Inc - - - Media Vision, Inc. - - - Fujitsu Corp. - - - Artisoft, Inc. - - - Turtle Beach, Inc. - - - IBM Corporation - - - Vocaltec LTD. - - - Roland - - - DSP Solutions, Inc. - - - NEC - - - ATI - - - Wang Laboratories, Inc - - - Tandy Corporation - - - Voyetra - - - Antex Electronics Corporation - - - ICL Personal Systems - - - Intel Corporation - - - Advanced Gravis - - - Video Associates Labs, Inc. - - - InterActive Inc - - - Yamaha Corporation of America - - - Everex Systems, Inc - - - Echo Speech Corporation - - - Sierra Semiconductor Corp - - - Computer Aided Technologies - - - APPS Software International - - - DSP Group, Inc - - - microEngineering Labs - - - Computer Friends, Inc. - - - ESS Technology - - - Audio, Inc. - - - Motorola, Inc. - - - Canopus, co., Ltd. - - - Seiko Epson Corporation - - - Truevision - - - Aztech Labs, Inc. - - - Videologic - - - SCALACS - - - Korg Inc. - - - Audio Processing Technology - - - Integrated Circuit Systems, Inc. - - - Iterated Systems, Inc. - - - Metheus - - - Logitech, Inc. - - - Winnov, Inc. - - - NCR Corporation - - - EXAN - - - AST Research Inc. - - - Willow Pond Corporation - - - Sonic Foundry - - - Vitec Multimedia - - - MOSCOM Corporation - - - Silicon Soft, Inc. - - - Supermac - - - Audio Processing Technology - - - Speech Compression - - - Ahead, Inc. - - - Dolby Laboratories - - - OKI - - - AuraVision Corporation - - - Ing C. Olivetti & C., S.p.A. - - - I/O Magic Corporation - - - Matsushita Electric Industrial Co., LTD. - - - Control Resources Limited - - - Xebec Multimedia Solutions Limited - - - New Media Corporation - - - Natural MicroSystems - - - Lyrrus Inc. - - - Compusic - - - OPTi Computers Inc. - - - Adlib Accessories Inc. - - - Compaq Computer Corp. - - - Dialogic Corporation - - - InSoft, Inc. - - - M.P. Technologies, Inc. - - - Weitek - - - Lernout & Hauspie - - - Quanta Computer Inc. - - - Apple Computer, Inc. - - - Digital Equipment Corporation - - - Mark of the Unicorn - - - Workbit Corporation - - - Ositech Communications Inc. - - - miro Computer Products AG - - - Cirrus Logic - - - ISOLUTION B.V. - - - Horizons Technology, Inc - - - Computer Concepts Ltd - - - Voice Technologies Group, Inc. - - - Radius - - - Rockwell International - - - Co. XYZ for testing - - - Opcode Systems - - - Voxware Inc - - - Northern Telecom Limited - - - APICOM - - - Grande Software - - - ADDX - - - Wildcat Canyon Software - - - Rhetorex Inc - - - Brooktree Corporation - - - ENSONIQ Corporation - - - FAST Multimedia AG - - - NVidia Corporation - - - OKSORI Co., Ltd. - - - DiAcoustics, Inc. - - - Gulbransen, Inc. - - - Kay Elemetrics, Inc. - - - Crystal Semiconductor Corporation - - - Splash Studios - - - Quarterdeck Corporation - - - TDK Corporation - - - Digital Audio Labs, Inc. - - - Seer Systems, Inc. - - - PictureTel Corporation - - - AT&T Microelectronics - - - Osprey Technologies, Inc. - - - Mediatrix Peripherals - - - SounDesignS M.C.S. Ltd. - - - A.L. Digital Ltd. - - - Spectrum Signal Processing, Inc. - - - Electronic Courseware Systems, Inc. - - - AMD - - - Core Dynamics - - - CANAM Computers - - - Softsound, Ltd. - - - Norris Communications, Inc. - - - Danka Data Devices - - - EuPhonics - - - Precept Software, Inc. - - - Crystal Net Corporation - - - Chromatic Research, Inc - - - Voice Information Systems, Inc - - - Vienna Systems - - - Connectix Corporation - - - Gadget Labs LLC - - - Frontier Design Group LLC - - - Viona Development GmbH - - - Casio Computer Co., LTD - - - Diamond Multimedia - - - S3 - - - Fraunhofer - - - - Summary description for MmException. - - - - - Creates a new MmException - - The result returned by the Windows API call - The name of the Windows API that failed - - - - Helper function to automatically raise an exception on failure - - The result of the API call - The API function name - - - - Returns the Windows API result - - - - - Windows multimedia error codes from mmsystem.h. - - - - no error, MMSYSERR_NOERROR - - - unspecified error, MMSYSERR_ERROR - - - device ID out of range, MMSYSERR_BADDEVICEID - - - driver failed enable, MMSYSERR_NOTENABLED - - - device already allocated, MMSYSERR_ALLOCATED - - - device handle is invalid, MMSYSERR_INVALHANDLE - - - no device driver present, MMSYSERR_NODRIVER - - - memory allocation error, MMSYSERR_NOMEM - - - function isn't supported, MMSYSERR_NOTSUPPORTED - - - error value out of range, MMSYSERR_BADERRNUM - - - invalid flag passed, MMSYSERR_INVALFLAG - - - invalid parameter passed, MMSYSERR_INVALPARAM - - - handle being used simultaneously on another thread (eg callback),MMSYSERR_HANDLEBUSY - - - specified alias not found, MMSYSERR_INVALIDALIAS - - - bad registry database, MMSYSERR_BADDB - - - registry key not found, MMSYSERR_KEYNOTFOUND - - - registry read error, MMSYSERR_READERROR - - - registry write error, MMSYSERR_WRITEERROR - - - registry delete error, MMSYSERR_DELETEERROR - - - registry value not found, MMSYSERR_VALNOTFOUND - - - driver does not call DriverCallback, MMSYSERR_NODRIVERCB - - - more data to be returned, MMSYSERR_MOREDATA - - - unsupported wave format, WAVERR_BADFORMAT - - - still something playing, WAVERR_STILLPLAYING - - - header not prepared, WAVERR_UNPREPARED - - - device is synchronous, WAVERR_SYNC - - - Conversion not possible (ACMERR_NOTPOSSIBLE) - - - Busy (ACMERR_BUSY) - - - Header Unprepared (ACMERR_UNPREPARED) - - - Cancelled (ACMERR_CANCELED) - - - invalid line (MIXERR_INVALLINE) - - - invalid control (MIXERR_INVALCONTROL) - - - invalid value (MIXERR_INVALVALUE) - - - diff --git a/distribution/NLog.dll b/distribution/NLog.dll deleted file mode 100644 index a0879e6..0000000 Binary files a/distribution/NLog.dll and /dev/null differ diff --git a/distribution/NLog.xml b/distribution/NLog.xml deleted file mode 100644 index 921e00f..0000000 --- a/distribution/NLog.xml +++ /dev/null @@ -1,26907 +0,0 @@ - - - - NLog - - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage - - - [CanBeNull] public object Test() { return null; } - public void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null - - - [NotNull] public object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form - - - [StringFormatMethod("message")] - public void ShowError(string message, params object[] args) { /* do something */ } - public void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of - - - public void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - interface - and this method is used to notify that some property value changed - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - internal class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - private string _name; - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) - for method output means that the methos doesn't return normally.
- canbenull annotation is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, - or use single attribute with rows separated by semicolon.
- - - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("s:null=>false; =>true,result:notnull; =>false, result:null")] - public bool TryParse(string s, out Person result) - - - - - - Indicates that marked element should be localized or not - - - [LocalizationRequiredAttribute(true)] - internal class Foo { - private string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - class UsesNoEquality { - public void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - internal class ComponentAttribute : Attribute { } - [Component] // ComponentAttribute requires implementing IComponent interface - internal class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly - (e.g. via reflection, in external library), so this symbol - will not be marked as unused (as well as by other usage inspections) - - - - - Should be used on attributes and causes ReSharper - to not mark symbols marked with such attributes as unused - (as well as by other usage inspections) - - - - Only entity marked with attribute considered used - - - Indicates implicit assignment to a member - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type - - - - Specify what is considered used implicitly - when marked with - or - - - - Members of entity marked with attribute are considered used - - - Entity marked with attribute and all its members considered used - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used - - - - - Tells code analysis engine if the parameter is completely handled - when the invoked method is on stack. If the parameter is a delegate, - indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated - while the method is executed - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute - - - [Pure] private int Multiply(int x, int y) { return x * y; } - public void Foo() { - const int a = 2, b = 2; - Multiply(a, b); // Waring: Return value of pure method is not used - } - - - - - Indicates that a parameter is a path to a file or a folder - within a web project. Path can be relative or absolute, - starting from web root (~) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that - the parameter is an MVC controller. If applied to a method, - the MVC controller name is calculated implicitly from the context. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(String, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(String, Object) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that - the parameter is an MVC partial view. If applied to a method, - the MVC partial view name is calculated implicitly from the context. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Allows disabling all inspections - for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String) - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String) - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object) - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String) - - - - - Asynchronous continuation delegate - function invoked at the end of asynchronous - processing. - - Exception during asynchronous processing or null if no exception - was thrown. - - - - Helpers for asynchronous operations. - - - - - Iterates over all items in the given collection and runs the specified action - in sequence (each action executes only after the preceding one has completed without an error). - - Type of each item. - The items to iterate. - The asynchronous continuation to invoke once all items - have been iterated. - The action to invoke for each item. - - - - Repeats the specified asynchronous action multiple times and invokes asynchronous continuation at the end. - - The repeat count. - The asynchronous continuation to invoke at the end. - The action to invoke. - - - - Modifies the continuation by pre-pending given action to execute just before it. - - The async continuation. - The action to pre-pend. - Continuation which will execute the given action before forwarding to the actual continuation. - - - - Attaches a timeout to a continuation which will invoke the continuation when the specified - timeout has elapsed. - - The asynchronous continuation. - The timeout. - Wrapped continuation. - - - - Iterates over all items in the given collection and runs the specified action - in parallel (each action executes on a thread from thread pool). - - Type of each item. - The items to iterate. - The asynchronous continuation to invoke once all items - have been iterated. - The action to invoke for each item. - - - - Runs the specified asynchronous action synchronously (blocks until the continuation has - been invoked). - - The action. - - Using this method is not recommended because it will block the calling thread. - - - - - Wraps the continuation with a guard which will only make sure that the continuation function - is invoked only once. - - The asynchronous continuation. - Wrapped asynchronous continuation. - - - - Gets the combined exception from all exceptions in the list. - - The exceptions. - Combined exception or null if no exception was thrown. - - - - Disposes the Timer, and waits for it to leave the Timer-callback-method - - The Timer object to dispose - Timeout to wait (TimeSpan.Zero means dispose without wating) - Timer disposed within timeout (true/false) - - - - Asynchronous action. - - Continuation to be invoked at the end of action. - - - - Asynchronous action with one argument. - - Type of the argument. - Argument to the action. - Continuation to be invoked at the end of action. - - - - Represents the logging event with asynchronous continuation. - - - - - Initializes a new instance of the struct. - - The log event. - The continuation. - - - - Gets the log event. - - - - - Gets the continuation. - - - - - Implements the operator ==. - - The event info1. - The event info2. - The result of the operator. - - - - Implements the operator ==. - - The event info1. - The event info2. - The result of the operator. - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - A value of true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - String Conversion Helpers - - - - - Converts input string value into - - Input value - Output value - Default value - Returns failure if the input value could not be parsed - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded. - - The enumeration type to which to convert value. - The string representation of the enumeration name or underlying value to convert. - When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need not be a member of the TEnum enumeration. This parameter is passed uninitialized. - true if the value parameter was converted successfully; otherwise, false. - Wrapper because Enum.TryParse is not present in .net 3.5 - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object. A parameter specifies whether the operation is case-sensitive. The return value indicates whether the conversion succeeded. - - The enumeration type to which to convert value. - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - When this method returns, result contains an object of type TEnum whose value is represented by value if the parse operation succeeds. If the parse operation fails, result contains the default value of the underlying type of TEnum. Note that this value need not be a member of the TEnum enumeration. This parameter is passed uninitialized. - true if the value parameter was converted successfully; otherwise, false. - Wrapper because Enum.TryParse is not present in .net 3.5 - - - - Enum.TryParse implementation for .net 3.5 - - - - Don't uses reflection - - - - NLog internal logger. - - Writes to file, console or custom textwriter (see ) - - - Don't use as that can lead to recursive calls - stackoverflows - - - - - Gets a value indicating whether internal log includes Trace messages. - - - - - Gets a value indicating whether internal log includes Debug messages. - - - - - Gets a value indicating whether internal log includes Info messages. - - - - - Gets a value indicating whether internal log includes Warn messages. - - - - - Gets a value indicating whether internal log includes Error messages. - - - - - Gets a value indicating whether internal log includes Fatal messages. - - - - - Logs the specified message without an at the Trace level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - Log message. - - - - Logs the specified message without an at the Trace level. - will be only called when logging is enabled for level Trace. - - Function that returns the log message. - - - - Logs the specified message with an at the Trace level. - - Exception to be logged. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - Message which may include positional parameters. - Argument {0} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - Argument {2} to the message. - - - - Logs the specified message with an at the Trace level. - - Exception to be logged. - Log message. - - - - Logs the specified message with an at the Trace level. - will be only called when logging is enabled for level Trace. - - Exception to be logged. - Function that returns the log message. - - - - Logs the specified message without an at the Debug level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Debug level. - - Log message. - - - - Logs the specified message without an at the Debug level. - will be only called when logging is enabled for level Debug. - - Function that returns the log message. - - - - Logs the specified message with an at the Debug level. - - Exception to be logged. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - Message which may include positional parameters. - Argument {0} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - Argument {2} to the message. - - - - Logs the specified message with an at the Debug level. - - Exception to be logged. - Log message. - - - - Logs the specified message with an at the Debug level. - will be only called when logging is enabled for level Debug. - - Exception to be logged. - Function that returns the log message. - - - - Logs the specified message without an at the Info level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Info level. - - Log message. - - - - Logs the specified message without an at the Info level. - will be only called when logging is enabled for level Info. - - Function that returns the log message. - - - - Logs the specified message with an at the Info level. - - Exception to be logged. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - Message which may include positional parameters. - Argument {0} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - Argument {2} to the message. - - - - Logs the specified message with an at the Info level. - - Exception to be logged. - Log message. - - - - Logs the specified message with an at the Info level. - will be only called when logging is enabled for level Info. - - Exception to be logged. - Function that returns the log message. - - - - Logs the specified message without an at the Warn level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Warn level. - - Log message. - - - - Logs the specified message without an at the Warn level. - will be only called when logging is enabled for level Warn. - - Function that returns the log message. - - - - Logs the specified message with an at the Warn level. - - Exception to be logged. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - Message which may include positional parameters. - Argument {0} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - Argument {2} to the message. - - - - Logs the specified message with an at the Warn level. - - Exception to be logged. - Log message. - - - - Logs the specified message with an at the Warn level. - will be only called when logging is enabled for level Warn. - - Exception to be logged. - Function that returns the log message. - - - - Logs the specified message without an at the Error level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Error level. - - Log message. - - - - Logs the specified message without an at the Error level. - will be only called when logging is enabled for level Error. - - Function that returns the log message. - - - - Logs the specified message with an at the Error level. - - Exception to be logged. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - Message which may include positional parameters. - Argument {0} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - Argument {2} to the message. - - - - Logs the specified message with an at the Error level. - - Exception to be logged. - Log message. - - - - Logs the specified message with an at the Error level. - will be only called when logging is enabled for level Error. - - Exception to be logged. - Function that returns the log message. - - - - Logs the specified message without an at the Fatal level. - - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Fatal level. - - Log message. - - - - Logs the specified message without an at the Fatal level. - will be only called when logging is enabled for level Fatal. - - Function that returns the log message. - - - - Logs the specified message with an at the Fatal level. - - Exception to be logged. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - Message which may include positional parameters. - Argument {0} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - - - - Logs the specified message without an at the Trace level. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - Message which may include positional parameters. - Argument {0} to the message. - Argument {1} to the message. - Argument {2} to the message. - - - - Logs the specified message with an at the Fatal level. - - Exception to be logged. - Log message. - - - - Logs the specified message with an at the Fatal level. - will be only called when logging is enabled for level Fatal. - - Exception to be logged. - Function that returns the log message. - - - - Initializes static members of the InternalLogger class. - - - - - Set the config of the InternalLogger with defaults and config. - - - - - Gets or sets the minimal internal log level. - - If set to , then messages of the levels , and will be written. - - - - Gets or sets a value indicating whether internal messages should be written to the console output stream. - - Your application must be a console application. - - - - Gets or sets a value indicating whether internal messages should be written to the console error stream. - - Your application must be a console application. - - - - Gets or sets a value indicating whether internal messages should be written to the .Trace - - - - - Gets or sets the file path of the internal log file. - - A value of value disables internal logging to a file. - - - - Gets or sets the text writer that will receive internal logs. - - - - - Gets or sets a value indicating whether timestamp should be included in internal log output. - - - - - Is there an thrown when writing the message? - - - - - Logs the specified message without an at the specified level. - - Log level. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message without an at the specified level. - - Log level. - Log message. - - - - Logs the specified message without an at the specified level. - will be only called when logging is enabled for level . - - Log level. - Function that returns the log message. - - - - Logs the specified message with an at the specified level. - will be only called when logging is enabled for level . - - Exception to be logged. - Log level. - Function that returns the log message. - - - - Logs the specified message with an at the specified level. - - Exception to be logged. - Log level. - Message which may include positional parameters. - Arguments to the message. - - - - Logs the specified message with an at the specified level. - - Exception to be logged. - Log level. - Log message. - - - - Write to internallogger. - - optional exception to be logged. - level - message - optional args for - - - - Determine if logging should be avoided because of exception type. - - The exception to check. - true if logging should be avoided; otherwise, false. - - - - Determine if logging is enabled. - - The for the log event. - true if logging is enabled; otherwise, false. - - - - Write internal messages to the log file defined in . - - Message to write. - - Message will be logged only when the property is not null, otherwise the - method has no effect. - - - - - Write internal messages to the defined in . - - Message to write. - - Message will be logged only when the property is not null, otherwise the - method has no effect. - - - - - Write internal messages to the . - - Message to write. - - Message will be logged only when the property is true, otherwise the - method has no effect. - - - - - Write internal messages to the . - - Message to write. - - Message will be logged when the property is true, otherwise the - method has no effect. - - - - - Write internal messages to the . - - A message to write. - - Works when property set to true. - The is used in Debug and Relese configuration. - The works only in Debug configuration and this is reason why is replaced by . - in DEBUG - - - - - Logs the assembly version and file version of the given Assembly. - - The assembly to log. - - - - A cyclic buffer of object. - - - - - Initializes a new instance of the class. - - Buffer size. - Whether buffer should grow as it becomes full. - The maximum number of items that the buffer can grow to. - - - - Gets the number of items in the array. - - - - - Adds the specified log event to the buffer. - - Log event. - The number of items in the buffer. - - - - Gets the array of events accumulated in the buffer and clears the buffer as one atomic operation. - - Events in the buffer. - - - - Condition and expression. - - - - - Initializes a new instance of the class. - - Left hand side of the AND expression. - Right hand side of the AND expression. - - - - Gets the left hand side of the AND expression. - - - - - Gets the right hand side of the AND expression. - - - - - Returns a string representation of this expression. - - A concatenated '(Left) and (Right)' string. - - - - Evaluates the expression by evaluating and recursively. - - Evaluation context. - The value of the conjunction operator. - - - - Exception during evaluation of condition expression. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - Base class for representing nodes in condition expression trees. - - - - - Converts condition text to a condition expression tree. - - Condition text to be converted. - Condition expression tree. - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Condition layout expression (represented by a string literal - with embedded ${}). - - - - - Initializes a new instance of the class. - - The layout. - - - - Gets the layout. - - The layout. - - - - Returns a string representation of this expression. - - String literal in single quotes. - - - - Evaluates the expression by calculating the value - of the layout in the specified evaluation context. - - Evaluation context. - The value of the layout. - - - - Condition level expression (represented by the level keyword). - - - - - Returns a string representation of the expression. - - The 'level' string. - - - - Evaluates to the current log level. - - Evaluation context. Ignored. - The object representing current log level. - - - - Condition literal expression (numeric, LogLevel.XXX, true or false). - - - - - Initializes a new instance of the class. - - Literal value. - - - - Gets the literal value. - - The literal value. - - - - Returns a string representation of the expression. - - The literal value. - - - - Evaluates the expression. - - Evaluation context. - The literal value as passed in the constructor. - - - - Condition logger name expression (represented by the logger keyword). - - - - - Returns a string representation of this expression. - - A logger string. - - - - Evaluates to the logger name. - - Evaluation context. - The logger name. - - - - Condition message expression (represented by the message keyword). - - - - - Returns a string representation of this expression. - - The 'message' string. - - - - Evaluates to the logger message. - - Evaluation context. - The logger message. - - - - Marks class as a log event Condition and assigns a name to it. - - - - - Initializes a new instance of the class. - - Condition method name. - - - - Condition method invocation expression (represented by method(p1,p2,p3) syntax). - - - - - Initializes a new instance of the class. - - Name of the condition method. - of the condition method. - The method parameters. - - - - Gets the method info. - - - - - Gets the method parameters. - - The method parameters. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - A bunch of utility methods (mostly predicates) which can be used in - condition expressions. Partially inspired by XPath 1.0. - - - - - Compares two values for equality. - - The first value. - The second value. - true when two objects are equal, false otherwise. - - - - Compares two strings for equality. - - The first string. - The second string. - Optional. If true, case is ignored; if false (default), case is significant. - true when two strings are equal, false otherwise. - - - - Gets or sets a value indicating whether the second string is a substring of the first one. - - The first string. - The second string. - Optional. If true (default), case is ignored; if false, case is significant. - true when the second string is a substring of the first string, false otherwise. - - - - Gets or sets a value indicating whether the second string is a prefix of the first one. - - The first string. - The second string. - Optional. If true (default), case is ignored; if false, case is significant. - true when the second string is a prefix of the first string, false otherwise. - - - - Gets or sets a value indicating whether the second string is a suffix of the first one. - - The first string. - The second string. - Optional. If true (default), case is ignored; if false, case is significant. - true when the second string is a prefix of the first string, false otherwise. - - - - Returns the length of a string. - - A string whose lengths is to be evaluated. - The length of the string. - - - - Indicates whether the specified regular expression finds a match in the specified input string. - - The string to search for a match. - The regular expression pattern to match. - A string consisting of the desired options for the test. The possible values are those of the separated by commas. - true if the regular expression finds a match; otherwise, false. - - - - - - - - - - - Marks the class as containing condition methods. - - - - - Condition not expression. - - - - - Initializes a new instance of the class. - - The expression. - - - - Gets the expression to be negated. - - The expression. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Condition or expression. - - - - - Initializes a new instance of the class. - - Left hand side of the OR expression. - Right hand side of the OR expression. - - - - Gets the left expression. - - The left expression. - - - - Gets the right expression. - - The right expression. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression by evaluating and recursively. - - Evaluation context. - The value of the alternative operator. - - - - Exception during parsing of condition expression. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - Condition parser. Turns a string representation of condition expression - into an expression tree. - - - - - Initializes a new instance of the class. - - The string reader. - Instance of used to resolve references to condition methods and layout renderers. - - - - Parses the specified condition string and turns it into - tree. - - The expression to be parsed. - The root of the expression syntax tree which can be used to get the value of the condition in a specified context. - - - - Parses the specified condition string and turns it into - tree. - - The expression to be parsed. - Instance of used to resolve references to condition methods and layout renderers. - The root of the expression syntax tree which can be used to get the value of the condition in a specified context. - - - - Parses the specified condition string and turns it into - tree. - - The string reader. - Instance of used to resolve references to condition methods and layout renderers. - - The root of the expression syntax tree which can be used to get the value of the condition in a specified context. - - - - - Try stringed keyword to - - - - success? - - - - Parse number - - negative number? minus should be parsed first. - - - - - Condition relational (==, !=, <, <=, - > or >=) expression. - - - - - Initializes a new instance of the class. - - The left expression. - The right expression. - The relational operator. - - - - Gets the left expression. - - The left expression. - - - - Gets the right expression. - - The right expression. - - - - Gets the relational operator. - - The operator. - - - - Returns a string representation of the expression. - - - A that represents the condition expression. - - - - - Evaluates the expression. - - Evaluation context. - Expression result. - - - - Compares the specified values using specified relational operator. - - The first value. - The second value. - The relational operator. - Result of the given relational operator. - - - - Promote values to the type needed for the comparision, e.g. parse a string to int. - - - - - - - Promoto to type - - - - success? - - - - Try to promote both values. First try to promote to , - when failed, try to . - - - - - - Get the order for the type for comparision. - - - index, 0 to maxint. Lower is first - - - - Dictionary from type to index. Lower index should be tested first. - - - - - Build the dictionary needed for the order of the types. - - - - - - Get the string representing the current - - - - - - Relational operators used in conditions. - - - - - Equality (==). - - - - - Inequality (!=). - - - - - Less than (<). - - - - - Greater than (>). - - - - - Less than or equal (<=). - - - - - Greater than or equal (>=). - - - - - Hand-written tokenizer for conditions. - - - - - Initializes a new instance of the class. - - The string reader. - - - - Gets the type of the token. - - The type of the token. - - - - Gets the token value. - - The token value. - - - - Gets the value of a string token. - - The string token value. - - - - Asserts current token type and advances to the next token. - - Expected token type. - If token type doesn't match, an exception is thrown. - - - - Asserts that current token is a keyword and returns its value and advances to the next token. - - Keyword value. - - - - Gets or sets a value indicating whether current keyword is equal to the specified value. - - The keyword. - - A value of true if current keyword is equal to the specified value; otherwise, false. - - - - - Gets or sets a value indicating whether the tokenizer has reached the end of the token stream. - - - A value of true if the tokenizer has reached the end of the token stream; otherwise, false. - - - - - Gets or sets a value indicating whether current token is a number. - - - A value of true if current token is a number; otherwise, false. - - - - - Gets or sets a value indicating whether the specified token is of specified type. - - The token type. - - A value of true if current token is of specified type; otherwise, false. - - - - - Gets the next token and sets and properties. - - - - - Try the comparison tokens (greater, smaller, greater-equals, smaller-equals) - - current char - is match - - - - Try the logical tokens (and, or, not, equals) - - current char - is match - - - - Mapping between characters and token types for punctuations. - - - - - Initializes a new instance of the CharToTokenType struct. - - The character. - Type of the token. - - - - Token types for condition expressions. - - - - - Marks the class or a member as advanced. Advanced classes and members are hidden by - default in generated documentation. - - - - - Initializes a new instance of the class. - - - - - Identifies that the output of layout or layout render does not change for the lifetime of the current appdomain. - - - A layout(renderer) could be converted to a literal when: - - The layout and all layout properies are SimpleLayout or [AppDomainFixedOutput] - - Recommendation: Apply this attribute to a layout or layout-renderer which have the result only changes by properties of type Layout. - - - - - Used to mark configurable parameters which are arrays. - Specifies the mapping between XML elements and .NET types. - - - - - Initializes a new instance of the class. - - The type of the array item. - The XML element name that represents the item. - - - - Gets the .NET type of the array item. - - - - - Gets the XML element name. - - - - - An assembly is trying to load. - - - - - New event args - - - - - - The assembly that is trying to load. - - - - - NLog configuration section handler class for configuring NLog from App.config. - - - - - Creates a configuration section handler. - - Parent object. - Configuration context object. - Section XML node. - The created section handler object. - - - - Constructs a new instance the configuration item (target, layout, layout renderer, etc.) given its type. - - Type of the item. - Created object of the specified type. - - - - Provides registration information for named items (targets, layouts, layout renderers, etc.) managed by NLog. - - Everything of an assembly could be loaded by - - - - - Called before the assembly will be loaded. - - - - - Initializes a new instance of the class. - - The assemblies to scan for named items. - - - - Gets or sets default singleton instance of . - - - This property implements lazy instantiation so that the is not built before - the internal logger is configured. - - - - - Gets or sets the creator delegate used to instantiate configuration objects. - - - By overriding this property, one can enable dependency injection or interception for created objects. - - - - - Gets the factory. - - The target factory. - - - - Gets the factory. - - The filter factory. - - - - gets the factory - - not using due to backwardscomp. - - - - - Gets the factory. - - The layout renderer factory. - - - - Gets the factory. - - The layout factory. - - - - Gets the ambient property factory. - - The ambient property factory. - - - - Legacy interface, no longer used by the NLog engine - - - - - Gets or sets the JSON serializer to use with or - - - - - Gets or sets the string serializer to use with - - - - - Perform mesage template parsing and formatting of LogEvent messages (True = Always, False = Never, Null = Auto Detect) - - - - Null (Auto Detect) : NLog-parser checks for positional parameters, and will then fallback to string.Format-rendering. - - True: Always performs the parsing of and rendering of using the NLog-parser (Allows custom formatting with ) - - False: Always performs parsing and rendering using string.Format (Fastest if not using structured logging) - - - - - Gets the time source factory. - - The time source factory. - - - - Gets the condition method factory. - - The condition method factory. - - - - Registers named items from the assembly. - - The assembly. - - - - Registers named items from the assembly. - - The assembly. - Item name prefix. - - - - Call Preload for NLogPackageLoader - - - Every package could implement a class "NLogPackageLoader" (namespace not important) with the public static method "Preload" (no arguments) - This method will be called just before registering all items in the assembly. - - - - - - Call the Preload method for . The Preload method must be static. - - - - - - Clears the contents of all factories. - - - - - Registers the type. - - The type to register. - The item name prefix. - - - - Builds the default configuration item factory. - - Default factory. - - - - Registers items in NLog.Extended.dll using late-bound types, so that we don't need a reference to NLog.Extended.dll. - - - - - Attribute used to mark the default parameters for layout renderers. - - - - - Initializes a new instance of the class. - - - - - Format of the excpetion output to the specific target. - - - - - Appends the Message of an Exception to the specified target. - - - - - Appends the type of an Exception to the specified target. - - - - - Appends the short type of an Exception to the specified target. - - - - - Appends the result of calling ToString() on an Exception to the specified target. - - - - - Appends the method name from Exception's stack trace to the specified target. - - - - - Appends the stack trace from an Exception to the specified target. - - - - - Appends the contents of an Exception's Data property to the specified target. - - - - - Destructure the exception (usually into JSON) - - - - - Factory for class-based items. - - The base type of each item. - The type of the attribute used to annotate items. - - - - Scans the assembly. - - The types to scan. - The prefix. - - - - Registers the type. - - The type to register. - The item name prefix. - - - - Registers the item based on a type name. - - Name of the item. - Name of the type. - - - - Clears the contents of the factory. - - - - - Registers a single type definition. - - The item name. - The type of the item. - - - - Tries to get registered item definition. - - Name of the item. - Reference to a variable which will store the item definition. - Item definition. - - - - Tries to create an item instance. - - Name of the item. - The result. - True if instance was created successfully, false otherwise. - - - - Creates an item instance. - - The name of the item. - Created item. - - - - Factory specialized for s. - - - - - Clear all func layouts - - - - - Register a layout renderer with a callback function. - - Name of the layoutrenderer, without ${}. - the renderer that renders the value. - - - - Tries to create an item instance. - - Name of the item. - The result. - True if instance was created successfully, false otherwise. - - - - Provides means to populate factories of named items (such as targets, layouts, layout renderers, etc.). - - - - - Implemented by objects which support installation and uninstallation. - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Represents a factory of named items (such as targets, layouts, layout renderers, etc.). - - Base type for each item instance. - Item definition type (typically or ). - - - - Registers new item definition. - - Name of the item. - Item definition. - - - - Tries to get registered item definition. - - Name of the item. - Reference to a variable which will store the item definition. - Item definition. - - - - Creates item instance. - - Name of the item. - Newly created item instance. - - - - Tries to create an item instance. - - Name of the item. - The result. - True if instance was created successfully, false otherwise. - - - - Provides context for install/uninstall operations. - - - - - Mapping between log levels and console output colors. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log output. - - - - Gets or sets the installation log level. - - - - - Gets or sets a value indicating whether to ignore failures during installation. - - - - - Whether installation exceptions should be rethrown. If IgnoreFailures is set to true, - this property has no effect (there are no exceptions to rethrow). - - - - - Gets the installation parameters. - - - - - Gets or sets the log output. - - - - - Logs the specified trace message. - - The message. - The arguments. - - - - Logs the specified debug message. - - The message. - The arguments. - - - - Logs the specified informational message. - - The message. - The arguments. - - - - Logs the specified warning message. - - The message. - The arguments. - - - - Logs the specified error message. - - The message. - The arguments. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Creates the log event which can be used to render layouts during installation/uninstallations. - - Log event info object. - - - - Keeps logging configuration and provides simple API - to modify it. - - This class is thread-safe..ToList() is used for that purpose. - - - - Variables defined in xml or in API. name is case case insensitive. - - - - - Initializes a new instance of the class. - - - - - Use the old exception log handling of NLog 3.0? - - This method was marked as obsolete on NLog 4.1 and it may be removed in a future release. - - - - Gets the variables defined in the configuration. - - - - - Gets a collection of named targets specified in the configuration. - - - A list of named targets. - - - Unnamed targets (such as those wrapped by other targets) are not returned. - - - - - Gets the collection of file names which should be watched for changes by NLog. - - - - - Gets the collection of logging rules. - - - - - Gets or sets the default culture info to use as . - - - Specific culture info or null to use - - - - - Gets all targets. - - - - - Compare objects based on their name. - - This property is use to cache the comparer object. - - - - Defines methods to support the comparison of objects for equality based on their name. - - - - - Registers the specified target object. The name of the target is read from . - - - The target object with a non - - when is - - - - Registers the specified target object under a given name. - - Name of the target. - The target object. - when is - when is - - - - Finds the target with the specified name. - - - The name of the target to be found. - - - Found target or when the target is not found. - - - - - Finds the target with the specified name and specified type. - - - The name of the target to be found. - - Type of the target - - Found target or when the target is not found of not of type - - - - - Add a rule with min- and maxLevel. - - Minimum log level needed to trigger this rule. - Maximum log level needed to trigger this rule. - Name of the target to be written when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - - - - Add a rule with min- and maxLevel. - - Minimum log level needed to trigger this rule. - Maximum log level needed to trigger this rule. - Target to be written to when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - - - - Add a rule with min- and maxLevel. - - Minimum log level needed to trigger this rule. - Maximum log level needed to trigger this rule. - Target to be written to when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Gets or sets a value indicating whether to quit processing any further rule when this one matches. - - - - Add a rule for one loglevel. - - log level needed to trigger this rule. - Name of the target to be written when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - - - - Add a rule for one loglevel. - - log level needed to trigger this rule. - Target to be written to when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - - - - Add a rule for one loglevel. - - log level needed to trigger this rule. - Target to be written to when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Gets or sets a value indicating whether to quit processing any further rule when this one matches. - - - - Add a rule for alle loglevels. - - Name of the target to be written when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - - - - Add a rule for alle loglevels. - - Target to be written to when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - - - - Add a rule for alle loglevels. - - Target to be written to when the rule matches. - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Gets or sets a value indicating whether to quit processing any further rule when this one matches. - - - - Called by LogManager when one of the log configuration files changes. - - - A new instance of that represents the updated configuration. - - - - - Removes the specified named target. - - Name of the target. - - - - Installs target-specific objects on current system. - - The installation context. - - Installation typically runs with administrative permissions. - - - - - Uninstalls target-specific objects from current system. - - The installation context. - - Uninstallation typically runs with administrative permissions. - - - - - Closes all targets and releases any unmanaged resources. - - - - - Log to the internal (NLog) logger the information about the and associated with this instance. - - - The information are only recorded in the internal logger if Debug level is enabled, otherwise nothing is - recorded. - - - - - Flushes any pending log messages on all appenders. - - The asynchronous continuation. - - - - Validates the configuration. - - - - - Copies all variables from provided dictionary into current configuration variables. - - Master variables dictionary - - - - Arguments for events. - - - - - Initializes a new instance of the class. - - The new configuration. - The old configuration. - - - - Gets the old configuration. - - The old configuration. - - - - Gets the new configuration. - - The new configuration. - - - - Gets the new configuration - - The new configuration. - - - - Gets the old configuration - - The old configuration. - - - - Arguments for . - - - - - Initializes a new instance of the class. - - Whether configuration reload has succeeded. - - - - Initializes a new instance of the class. - - Whether configuration reload has succeeded. - The exception during configuration reload. - - - - Gets a value indicating whether configuration reload has succeeded. - - A value of true if succeeded; otherwise, false. - - - - Gets the exception which occurred during configuration reload. - - The exception. - - - - Represents a logging rule. An equivalent of <logger /> configuration element. - - - - - Create an empty . - - - - - Create a new with a and which writes to . - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Minimum log level needed to trigger this rule. - Maximum log level needed to trigger this rule. - Target to be written to when the rule matches. - - - - Create a new with a which writes to . - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Minimum log level needed to trigger this rule. - Target to be written to when the rule matches. - - - - Create a (disabled) . You should call or see cref="EnableLoggingForLevels"/> to enable logging. - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends. - Target to be written to when the rule matches. - - - - Gets a collection of targets that should be written to when this rule matches. - - - - - Gets a collection of child rules to be evaluated when this rule matches. - - - - - Gets a collection of filters to be checked before writing to targets. - - - - - Gets or sets a value indicating whether to quit processing any further rule when this one matches. - - - - - Gets or sets logger name pattern. - - - Logger name pattern. It may include the '*' wildcard at the beginning, at the end or at both ends but not anywhere else. - - - - - Gets the collection of log levels enabled by this rule. - - - - - Enables logging for a particular level. - - Level to be enabled. - - - - Enables logging for a particular levels between (included) and . - - Minimum log level needed to trigger this rule. - Maximum log level needed to trigger this rule. - - - - Disables logging for a particular level. - - Level to be disabled. - - - - Disables logging for particular levels between (included) and . - - Minimum log level to be disables. - Maximum log level to de disabled. - - - - Enables logging the levels between (included) and . All the other levels will be disabled. - - >Minimum log level needed to trigger this rule. - Maximum log level needed to trigger this rule. - - - - Returns a string representation of . Used for debugging. - - - A that represents the current . - - - - - Checks whether te particular log level is enabled for this rule. - - Level to be checked. - A value of when the log level is enabled, otherwise. - - - - Checks whether given name matches the logger name pattern. - - String to be matched. - A value of when the name matches, otherwise. - - - - Factory for locating methods. - - The type of the class marker attribute. - The type of the method marker attribute. - - - - Gets a collection of all registered items in the factory. - - - Sequence of key/value pairs where each key represents the name - of the item and value is the of - the item. - - - - - Scans the assembly for classes marked with - and methods marked with and adds them - to the factory. - - The types to scan. - The prefix to use for names. - - - - Registers the type. - - The type to register. - The item name prefix. - - - - Clears contents of the factory. - - - - - Registers the definition of a single method. - - The method name. - The method info. - - - - Tries to retrieve method by name. - - The method name. - The result. - A value of true if the method was found, false otherwise. - - - - Retrieves method by name. - - Method name. - MethodInfo object. - - - - Tries to get method definition. - - The method name. - The result. - A value of true if the method was found, false otherwise. - - - - Marks the layout or layout renderer depends on mutable objects from the LogEvent - - This can be or - - - - - Attaches a simple name to an item (such as , - , , etc.). - - - - - Initializes a new instance of the class. - - The name of the item. - - - - Gets the name of the item. - - The name of the item. - - - - Indicates NLog should not scan this property during configuration. - - - - - Initializes a new instance of the class. - - - - - Marks the object as configuration item for NLog. - - - - - Initializes a new instance of the class. - - - - - Represents simple XML element with case-insensitive attribute semantics. - - - - - Initializes a new instance of the class. - - The input URI. - - - - Initializes a new instance of the class. - - The reader to initialize element from. - - - - Prevents a default instance of the class from being created. - - - - - Gets the element name. - - - - - Gets the dictionary of attribute values. - - - - - Gets the collection of child elements. - - - - - Gets the value of the element. - - - - - Last error occured during configuration read - - - - - Returns children elements with the specified element name. - - Name of the element. - Children elements with the specified element name. - - - - Gets the required attribute. - - Name of the attribute. - Attribute value. - Throws if the attribute is not specified. - - - - Gets the optional boolean attribute value. - - Name of the attribute. - Default value to return if the attribute is not found. - Boolean attribute value or default. - - - - Gets the optional boolean attribute value. If whitespace, then returning null. - - Name of the attribute. - Default value to return if the attribute is not found. - Boolean attribute value or default. - - - - Gets the optional attribute value. - - Name of the attribute. - The default value. - Value of the attribute or default value. - - - - Asserts that the name of the element is among specified element names. - - The allowed names. - - - - Returns all parsing errors from current and all child elements. - - - - - Attribute used to mark the required parameters for targets, - layout targets and filters. - - - - - Provides simple programmatic configuration API used for trivial logging cases. - - Warning, these methods will overwrite the current config. - - - - - Configures NLog for console logging so that all messages above and including - the level are output to the console. - - - - - Configures NLog for console logging so that all messages above and including - the specified level are output to the console. - - The minimal logging level. - - - - Configures NLog for to log to the specified target so that all messages - above and including the level are output. - - The target to log all messages to. - - - - Configures NLog for to log to the specified target so that all messages - above and including the specified level are output. - - The target to log all messages to. - The minimal logging level. - - - - Configures NLog for file logging so that all messages above and including - the level are written to the specified file. - - Log file name. - - - - Configures NLog for file logging so that all messages above and including - the specified level are written to the specified file. - - Log file name. - The minimal logging level. - - - - Value indicating how stack trace should be captured when processing the log event. - - - - - Stack trace should not be captured. - - - - - Stack trace should be captured without source-level information. - - - - - Stack trace should be captured including source-level information such as line numbers. - - - - - Capture maximum amount of the stack trace information supported on the platform. - - - - - Marks the layout or layout renderer as thread independent - it producing correct results - regardless of the thread it's running on. - - Without this attribute everything is rendered on the main thread. - - - If this attribute is set on a layout, it could be rendered on the another thread. - This could be more efficient as it's skipped when not needed. - - If context like HttpContext.Current is needed, which is only available on the main thread, this attribute should not be applied. - - See the AsyncTargetWrapper and BufferTargetWrapper with the , using - - Apply this attribute when: - - The result can we rendered in another thread. Delaying this could be more efficient. And/Or, - - The result should not be precalculated, for example the target sends some extra context information. - - - - - Marks the layout or layout renderer as thread safe - it producing correct results - regardless of the number of threads it's running on. - - Without this attribute then the target concurrency will be reduced - - - - - A class for configuring NLog through an XML configuration file - (App.config style or App.nlog style). - - Parsing of the XML file is also implemented in this class. - - - - This class is thread-safe..ToList() is used for that purpose. - - Update TemplateXSD.xml for changes outside targets - - - - - Initializes a new instance of the class. - - Configuration file to be read. - - - - Initializes a new instance of the class. - - Configuration file to be read. - The to which to apply any applicable configuration values. - - - - Initializes a new instance of the class. - - Configuration file to be read. - Ignore any errors during configuration. - - - - Initializes a new instance of the class. - - Configuration file to be read. - Ignore any errors during configuration. - The to which to apply any applicable configuration values. - - - - Create XML reader for (xml config) file. - - filepath - reader or null if filename is empty. - - - - Initializes a new instance of the class. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - - - - Initializes a new instance of the class. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - The to which to apply any applicable configuration values. - - - - Initializes a new instance of the class. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - Ignore any errors during configuration. - - - - Initializes a new instance of the class. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - Ignore any errors during configuration. - The to which to apply any applicable configuration values. - - - - Initializes a new instance of the class. - - The XML element. - Name of the XML file. - - - - Initializes a new instance of the class. - - The XML element. - Name of the XML file. - If set to true errors will be ignored during file processing. - - - - Gets the default object by parsing - the application configuration file (app.exe.config). - - - - - Did the Succeeded? true= success, false= error, null = initialize not started yet. - - - - - Gets or sets a value indicating whether all of the configuration files - should be watched for changes and reloaded automatically when changed. - - - - - Gets the collection of file names which should be watched for changes by NLog. - This is the list of configuration files processed. - If the autoReload attribute is not set it returns empty collection. - - - - - Re-reads the original configuration file and returns the new object. - - The new object. - - - - Get file paths (including filename) for the possible NLog config files. - - The filepaths to the possible config file - - - - Overwrite the paths (including filename) for the possible NLog config files. - - The filepaths to the possible config file - - - - Clear the candidate file paths and return to the defaults. - - - - - Remove all spaces, also in between text. - - text - text without spaces - Tabs and other whitespace is not removed! - - - - Remove the namespace (before :) - - - x:a, will be a - - - - - - - Initializes the configuration. - - containing the configuration section. - Name of the file that contains the element (to be used as a base for including other files). - Ignore any errors during configuration. - - - - Checks whether any error during XML configuration parsing has occured. - If there are any and ThrowConfigExceptions or ThrowExceptions - setting is enabled - throws NLogConfigurationException, otherwise - just write an internal log at Warn level. - - Root NLog configuration xml element - - - - Checks whether unused targets exist. If found any, just write an internal log at Warn level. - If initializing not started or failed, then checking process will be canceled - - - - - Add a file with configuration. Check if not already included. - - - - - - - Parse the root - - - path to config file. - The default value for the autoReload option. - - - - Parse {configuration} xml element. - - - path to config file. - The default value for the autoReload option. - - - - Parse {NLog} xml element. - - - path to config file. - The default value for the autoReload option. - - - - Parse {Rules} xml element - - - Rules are added to this parameter. - - - - Parse {Logger} xml element - - - Rules are added to this parameter. - - - - Split list on comma, trim items - - - no empty items - - - - Include (multiple) files by filemask, e.g. *.nlog - - base directory in case if is relative - relative or absolute fileMask - - - - - Replace a simple variable with a value. The orginal value is removed and thus we cannot redo this in a later stage. - - Use for that: - - - - - - - Matches when the specified condition is met. - - - Conditions are expressed using a simple language - described here. - - - - - Gets or sets the condition expression. - - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - An abstract filter class. Provides a way to eliminate log messages - based on properties other than logger name and log level. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the action to be taken when filter matches. - - - - - - Gets the result of evaluating filter against given log event. - - The log event. - Filter result. - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - Marks class as a layout renderer and assigns a name to it. - - - - - Initializes a new instance of the class. - - Name of the filter. - - - - Filter result. - - - - - The filter doesn't want to decide whether to log or discard the message. - - - - - The message should be logged. - - - - - The message should not be logged. - - - - - The message should be logged and processing should be finished. - - - - - The message should not be logged and processing should be finished. - - - - - A base class for filters that are based on comparing a value to a layout. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the layout to be used to filter log messages. - - The layout. - - - - - Matches when the calculated layout contains the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Gets or sets the substring to be matched. - - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - Matches when the calculated layout is equal to the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Gets or sets a string to compare the layout to. - - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - Matches when the calculated layout does NOT contain the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Gets or sets the substring to be matched. - - - - - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - Matches when the calculated layout is NOT equal to the specified substring. - This filter is deprecated in favor of <when /> which is based on conditions. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a string to compare the layout to. - - - - - - Gets or sets a value indicating whether to ignore case when comparing strings. - - - - - - Checks whether log event should be logged or not. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - Matches when the result of the calculated layout has been repeated a moment ago - - - - - How long before a filter expires, and logging is accepted again - - - - - - Max length of filter values, will truncate if above limit - - - - - - Applies the configured action to the initial logevent that starts the timeout period. - Used to configure that it should ignore all events until timeout. - - - - - - Max number of unique filter values to expect simultaneously - - - - - - Default number of unique filter values to expect, will automatically increase if needed - - - - - - Insert FilterCount value into when an event is no longer filtered - - - - - - Append FilterCount to the when an event is no longer filtered - - - - - - Reuse internal buffers, and doesn't have to constantly allocate new buffers - - - - - - Default buffer size for the internal buffers - - - - - - Can be used if has been enabled. - - - - - Constructor - - - - - Checks whether log event should be logged or not. In case the LogEvent has just been repeated. - - Log event. - - - if the log event should be ignored
- - if the filter doesn't want to decide
- - if the log event should be logged
- . - - - - Uses object pooling, and prunes stale filter items when the pool runs dry - - - - - Remove stale filter-value from the cache, and fill them into the pool for reuse - - - - - Renders the Log Event into a filter value, that is used for checking if just repeated - - - - - Repeated LogEvent detected. Checks if it should activate filter-action - - - - - Filter Value State (mutable) - - - - - Filter Lookup Key (immutable) - - - - - A global logging class using caller info to find the logger. - - - - - Starts building a log event with the specified . - - The log level. - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - Starts building a log event at the Trace level. - - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - Starts building a log event at the Debug level. - - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - Starts building a log event at the Info level. - - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - Starts building a log event at the Warn level. - - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - Starts building a log event at the Error level. - - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - Starts building a log event at the Fatal level. - - The full path of the source file that contains the caller. This is the file path at the time of compile. - An instance of the fluent . - - - - A fluent class to build log events for NLog. - - - - - Initializes a new instance of the class. - - The to send the log event. - - - - Initializes a new instance of the class. - - The to send the log event. - The for the log event. - - - - Gets the created by the builder. - - - - - Sets the information of the logging event. - - The exception information of the logging event. - current for chaining calls. - - - - Sets the level of the logging event. - - The level of the logging event. - current for chaining calls. - - - - Sets the logger name of the logging event. - - The logger name of the logging event. - current for chaining calls. - - - - Sets the log message on the logging event. - - The log message for the logging event. - current for chaining calls. - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The object to format. - current for chaining calls. - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The first object to format. - The second object to format. - current for chaining calls. - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The first object to format. - The second object to format. - The third object to format. - current for chaining calls. - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - The first object to format. - The second object to format. - The third object to format. - The fourth object to format. - current for chaining calls. - - - - Sets the log message and parameters for formatting on the logging event. - - A composite format string. - An object array that contains zero or more objects to format. - current for chaining calls. - - - - Sets the log message and parameters for formatting on the logging event. - - An object that supplies culture-specific formatting information. - A composite format string. - An object array that contains zero or more objects to format. - current for chaining calls. - - - - Sets a per-event context property on the logging event. - - The name of the context property. - The value of the context property. - current for chaining calls. - - - - Sets multiple per-event context properties on the logging event. - - The properties to set. - current for chaining calls. - - - - Sets the timestamp of the logging event. - - The timestamp of the logging event. - current for chaining calls. - - - - Sets the stack trace for the event info. - - The stack trace. - Index of the first user stack frame within the stack trace. - current for chaining calls. - - - - Writes the log event to the underlying logger. - - The method or property name of the caller to the method. This is set at by the compiler. - The full path of the source file that contains the caller. This is set at by the compiler. - The line number in the source file at which the method is called. This is set at by the compiler. - - - - Writes the log event to the underlying logger if the condition delegate is true. - - If condition is true, write log event; otherwise ignore event. - The method or property name of the caller to the method. This is set at by the compiler. - The full path of the source file that contains the caller. This is set at by the compiler. - The line number in the source file at which the method is called. This is set at by the compiler. - - - - Writes the log event to the underlying logger if the condition is true. - - If condition is true, write log event; otherwise ignore event. - The method or property name of the caller to the method. This is set at by the compiler. - The full path of the source file that contains the caller. This is set at by the compiler. - The line number in the source file at which the method is called. This is set at by the compiler. - - - - Extension methods for NLog . - - - - - Starts building a log event with the specified . - - The logger to write the log event to. - The log level. - current for chaining calls. - - - - Starts building a log event at the Trace level. - - The logger to write the log event to. - current for chaining calls. - - - - Starts building a log event at the Debug level. - - The logger to write the log event to. - current for chaining calls. - - - - Starts building a log event at the Info level. - - The logger to write the log event to. - current for chaining calls. - - - - Starts building a log event at the Warn level. - - The logger to write the log event to. - current for chaining calls. - - - - Starts building a log event at the Error level. - - The logger to write the log event to. - current for chaining calls. - - - - Starts building a log event at the Fatal level. - - The logger to write the log event to. - current for chaining calls. - - - - Global Diagnostics Context - used for log4net compatibility. - - This class was marked as obsolete on NLog 2.0 and it may be removed in a future release. - - - - Sets the Global Diagnostics Context item to the specified value. - - Item name. - Item value. - - - - Gets the Global Diagnostics Context named item. - - Item name. - The value of , if defined; otherwise . - If the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the Global Diagnostics Context item. - - Item name. - to use when converting the item's value to a string. - The value of as a string, if defined; otherwise . - If is null and the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the Global Diagnostics Context named item. - - Item name. - The value of , if defined; otherwise null. - - - - Checks whether the specified item exists in the Global Diagnostics Context. - - Item name. - A boolean indicating whether the specified item exists in current thread GDC. - - - - Removes the specified item from the Global Diagnostics Context. - - Item name. - - - - Clears the content of the GDC. - - - - - Global Diagnostics Context - a dictionary structure to hold per-application-instance values. - - - - - Sets the Global Diagnostics Context item to the specified value. - - Item name. - Item value. - - - - Sets the Global Diagnostics Context item to the specified value. - - Item name. - Item value. - - - - Gets the Global Diagnostics Context named item. - - Item name. - The value of , if defined; otherwise . - If the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the Global Diagnostics Context item. - - Item name. - to use when converting the item's value to a string. - The value of as a string, if defined; otherwise . - If is null and the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the Global Diagnostics Context named item. - - Item name. - The item value, if defined; otherwise null. - - - - Returns all item names - - A collection of the names of all items in the Global Diagnostics Context. - - - - Checks whether the specified item exists in the Global Diagnostics Context. - - Item name. - A boolean indicating whether the specified item exists in current thread GDC. - - - - Removes the specified item from the Global Diagnostics Context. - - Item name. - - - - Clears the content of the GDC. - - - - - Include context properties - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Gets or sets the option to include all properties from the log events - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Interface for serialization of object values into JSON format - - - - - Serialization of an object into JSON format. - - The object to serialize to JSON. - Output destination. - Serialize succeeded (true/false) - - - - Auto-generated Logger members for binary compatibility with NLog 1.0. - - - Provides logging interface and utility functions. - - - - - Writes the diagnostic message at the Trace level. - - A to be written. - - - - Writes the diagnostic message at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format.s - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level. - - A to be written. - - - - Writes the diagnostic message at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level. - - A to be written. - - - - Writes the diagnostic message at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level. - - A to be written. - - - - Writes the diagnostic message at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level. - - A to be written. - - - - Writes the diagnostic message at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level. - - A to be written. - - - - Writes the diagnostic message at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Gets a value indicating whether logging is enabled for the Trace level. - - A value of if logging is enabled for the Trace level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Debug level. - - A value of if logging is enabled for the Debug level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Info level. - - A value of if logging is enabled for the Info level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Warn level. - - A value of if logging is enabled for the Warn level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Error level. - - A value of if logging is enabled for the Error level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Fatal level. - - A value of if logging is enabled for the Fatal level, otherwise it returns . - - - - Writes the diagnostic message at the Trace level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Trace level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level. - - Log message. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Debug level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level. - - Log message. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Info level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Info level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Info level. - - Log message. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Info level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Warn level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Warn level. - - Log message. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Warn level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Error level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Error level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Error level. - - Log message. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Error level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level. - - Log message. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Fatal level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Auto-generated Logger members for binary compatibility with NLog 1.0. - - - Logger with only generic methods (passing 'LogLevel' to methods) and core properties. - - - - - Writes the diagnostic message at the specified level. - - The log level. - A to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Occurs when logger configuration changes. - - - - - Gets the name of the logger. - - - - - Gets the factory that created this logger. - - - - - Gets a value indicating whether logging is enabled for the specified level. - - Log level to be checked. - A value of if logging is enabled for the specified level, otherwise it returns . - - - - Writes the specified diagnostic message. - - Log event. - - - - Writes the specified diagnostic message. - - The name of the type that wraps Logger. - Log event. - - - - Writes the diagnostic message at the specified level using the specified format provider and format parameters. - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - Log message. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the specified level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameter. - - The type of the argument. - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Extensions for NLog . - - - - - Writes the diagnostic message and exception at the specified level. - - A logger implementation that will handle the message. - The log level. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - - A logger implementation that will handle the message. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - - A logger implementation that will handle the message. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Info level. - - A logger implementation that will handle the message. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Warn level. - - A logger implementation that will handle the message. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Error level. - - A logger implementation that will handle the message. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Fatal level. - - A logger implementation that will handle the message. - An exception to be logged. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Allocates new builder and appends to the provided target builder on dispose - - - - - Access the new builder allocated - - - - - Helpers for . - - - - - Load from url - - file or path, including .dll - basepath, optional - - - - - Load from url - - name without .dll - - - - - Keeps track of pending operation count, and can notify when pending operation count reaches zero - - - - - Mark operation has started - - - - - Mark operation has completed - - Exception coming from the completed operation [optional] - - - - Registers an AsyncContinuation to be called when all pending operations have completed - - Invoked on completion - AsyncContinuation operation - - - - Clear o - - - - - Sets the stack trace for the event info. - - The stack trace. - Index of the first user stack frame within the stack trace. - Index of the first user stack frame within the stack trace. - - - - Sets the details retrieved from the Caller Information Attributes - - - - - - - - - Gets the stack frame of the method that did the logging. - - - - - Gets the number index of the stack frame that represents the user - code (not the NLog code). - - - - - Legacy attempt to skip async MoveNext, but caused source file line number to be lost - - - - - Gets the entire stack trace. - - - - - Internal configuration manager used to read .NET configuration files. - Just a wrapper around the BCL ConfigurationManager, but used to enable - unit testing. - - - - - Gets the wrapper around ConfigurationManager.AppSettings. - - - - - Provides untyped IDictionary interface on top of generic IDictionary. - - The type of the key. - The type of the value. - - - - Initializes a new instance of the DictionaryAdapter class. - - The implementation. - - - - Gets an object containing the values in the object. - - - - An object containing the values in the object. - - - - - Gets the number of elements contained in the . - - - - The number of elements contained in the . - - - - - Gets a value indicating whether access to the is synchronized (thread safe). - - - true if access to the is synchronized (thread safe); otherwise, false. - - - - - Gets an object that can be used to synchronize access to the . - - - - An object that can be used to synchronize access to the . - - - - - Gets a value indicating whether the object has a fixed size. - - - true if the object has a fixed size; otherwise, false. - - - - - Gets a value indicating whether the object is read-only. - - - true if the object is read-only; otherwise, false. - - - - - Gets an object containing the keys of the object. - - - - An object containing the keys of the object. - - - - - Gets or sets the with the specified key. - - Dictionary key. - Value corresponding to key or null if not found - - - - Adds an element with the provided key and value to the object. - - The to use as the key of the element to add. - The to use as the value of the element to add. - - - - Removes all elements from the object. - - - - - Determines whether the object contains an element with the specified key. - - The key to locate in the object. - - True if the contains an element with the key; otherwise, false. - - - - - Returns an object for the object. - - - An object for the object. - - - - - Removes the element with the specified key from the object. - - The key of the element to remove. - - - - Copies the elements of the to an , starting at a particular index. - - The one-dimensional that is the destination of the elements copied from . The must have zero-based indexing. - The zero-based index in at which copying begins. - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Wrapper IDictionaryEnumerator. - - - - - Initializes a new instance of the class. - - The wrapped. - - - - Gets both the key and the value of the current dictionary entry. - - - - A containing both the key and the value of the current dictionary entry. - - - - - Gets the key of the current dictionary entry. - - - - The key of the current element of the enumeration. - - - - - Gets the value of the current dictionary entry. - - - - The value of the current element of the enumeration. - - - - - Gets the current element in the collection. - - - - The current element in the collection. - - - - - Advances the enumerator to the next element of the collection. - - - True if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - - - UTF-8 BOM 239, 187, 191 - - - - - Safe way to get environment variables. - - - - - Helper class for dealing with exceptions. - - - - - Mark this exception as logged to the . - - - - - - - Is this exception logged to the ? - - - trueif the has been logged to the . - - - - Determines whether the exception must be rethrown and logs the error to the if is false. - - Advised to log first the error to the before calling this method. - - The exception to check. - trueif the must be rethrown, false otherwise. - - - - Determines whether the exception must be rethrown immediately, without logging the error to the . - - Only used this method in special cases. - - The exception to check. - trueif the must be rethrown, false otherwise. - - - - Object construction helper. - - - - - Adapter for to - - - - - Initializes a new instance of the class. - - The to wrap. - - - - Creates an AppDomainWrapper for the current - - - - - Gets or sets the base directory that the assembly resolver uses to probe for assemblies. - - - - - Gets or sets the name of the configuration file for an application domain. - - - - - Gets or sets the list of directories under the application base directory that are probed for private assemblies. - - - - - Gets or set the friendly name. - - - - - Gets an integer that uniquely identifies the application domain within the process. - - - - - Gets the assemblies that have been loaded into the execution context of this application domain. - - A list of assemblies in this application domain. - - - - Process exit event. - - - - - Domain unloaded event. - - - - - Interface for fakeable the current . Not fully implemented, please methods/properties as necessary. - - - - - Gets or sets the base directory that the assembly resolver uses to probe for assemblies. - - - - - Gets or sets the name of the configuration file for an application domain. - - - - - Gets or sets the list of directories under the application base directory that are probed for private assemblies. - - - - - Gets or set the friendly name. - - - - - Gets an integer that uniquely identifies the application domain within the process. - - - - - Gets the assemblies that have been loaded into the execution context of this application domain. - - A list of assemblies in this application domain. - - - - Process exit event. - - - - - Domain unloaded event. - - - - - Base class for optimized file appenders. - - - - - Initializes a new instance of the class. - - Name of the file. - The create parameters. - - - - Gets the path of the file, including file extension. - - The name of the file. - - - - Gets or sets the creation time for a file associated with the appender. The time returned is in Coordinated - Universal Time [UTC] standard. - - The creation time of the file. - - - - Gets or sets the creation time for a file associated with the appender. Synchronized by - The time format is based on - - - - - Gets the last time the file associated with the appeander is opened. The time returned is in Coordinated - Universal Time [UTC] standard. - - The time the file was last opened. - - - - Gets the last time the file associated with the appeander is written. The time returned is in - Coordinated Universal Time [UTC] standard. - - The time the file was last written to. - - - - Gets the file creation parameters. - - The file creation parameters. - - - - Writes the specified bytes. - - The bytes. - - - - Flushes this instance. - - - - - Closes this instance. - - - - - Gets the creation time for a file associated with the appender. The time returned is in Coordinated Universal - Time [UTC] standard. - - The file creation time. - - - - Gets the last time the file associated with the appeander is written. The time returned is in Coordinated - Universal Time [UTC] standard. - - The time the file was last written to. - - - - Gets the length in bytes of the file associated with the appeander. - - A long value representing the length of the file in bytes. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Updates the last write time of the file. - - - - - Updates the last write time of the file to the specified date. - - Date and time when the last write occurred in UTC. - - - - Creates the file stream. - - If set to true sets the file stream to allow shared writing. - A object which can be used to write to the file. - - - - Base class for optimized file appenders which require the usage of a mutex. - - It is possible to use this class as replacement of BaseFileAppender and the mutex functionality - is not enforced to the implementing subclasses. - - - - - Initializes a new instance of the class. - - Name of the file. - The create parameters. - - - - Gets the mutually-exclusive lock for archiving files. - - The mutex for archiving. - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Creates a mutex that is sharable by more than one process. - - The prefix to use for the name of the mutex. - A object which is sharable by multiple processes. - - - - Implementation of which caches - file information. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Closes this instance of the appender. - - - - - Flushes this current appender. - - - - - Gets the creation time for a file associated with the appender. The time returned is in Coordinated Universal - Time [UTC] standard. - - The file creation time. - - - - Gets the last time the file associated with the appeander is written. The time returned is in Coordinated - Universal Time [UTC] standard. - - The time the file was last written to. - - - - Gets the length in bytes of the file associated with the appeander. - - A long value representing the length of the file in bytes. - - - - Writes the specified bytes to a file. - - The bytes array. - The bytes array offset. - The number of bytes. - - - - Factory class which creates objects. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Maintains a collection of file appenders usually associated with file targets. - - - - - An "empty" instance of the class with zero size and empty list of appenders. - - - - - Initializes a new "empty" instance of the class with zero size and empty - list of appenders. - - - - - Initializes a new instance of the class. - - - The size of the list should be positive. No validations are performed during initialisation as it is an - intenal class. - - Total number of appenders allowed in list. - Factory used to create each appender. - Parameters used for creating a file. - - - - The archive file path pattern that is used to detect when archiving occurs. - - - - - Invalidates appenders for all files that were archived. - - - - - Gets the parameters which will be used for creating a file. - - - - - Gets the file appender factory used by all the appenders in this list. - - - - - Gets the number of appenders which the list can hold. - - - - - Subscribe to background monitoring of active file appenders - - - - - It allocates the first slot in the list when the file name does not already in the list and clean up any - unused slots. - - File name associated with a single appender. - The allocated appender. - - Thrown when is called on an Empty instance. - - - - - Close all the allocated appenders. - - - - - Close the allocated appenders initialised before the supplied time. - - The time which prior the appenders considered expired - - - - Fluch all the allocated appenders. - - - - - Closes the specified appender and removes it from the list. - - File name of the appender to be closed. - File Appender that matched the filePath (null if none found) - - - - Interface that provides parameters for create file function. - - - - - Gets or sets the delay in milliseconds to wait before attempting to write to the file again. - - - - - Gets or sets the number of times the write is appended on the file before NLog - discards the log message. - - - - - Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host. - - - This makes multi-process logging possible. NLog uses a special technique - that lets it keep the files open for writing. - - - - - Gets or sets a value indicating whether to create directories if they do not exist. - - - Setting this to false may improve performance a bit, but you'll receive an error - when attempting to write to a directory that's not present. - - - - - Gets or sets a value indicating whether to enable log file(s) to be deleted. - - - - - Gets or sets the log file buffer size in bytes. - - - - - Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation. - - - - - Gets or sets the file attributes (Windows only). - - - - - Should we capture the last write time of a file? - - - - - Should archive mutex be created? - - - - - Interface implemented by all factories capable of creating file appenders. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - Instance of which can be used to write to the file. - - - - Provides a multiprocess-safe atomic file appends while - keeping the files open. - - - On Unix you can get all the appends to be atomic, even when multiple - processes are trying to write to the same file, because setting the file - pointer to the end of the file and appending can be made one operation. - On Win32 we need to maintain some synchronization between processes - (global named mutex is used for this) - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Writes the specified bytes. - - The bytes array. - The bytes array offset. - The number of bytes. - - - - Closes this instance. - - - - - Flushes this instance. - - - - - Gets the creation time for a file associated with the appender. The time returned is in Coordinated Universal - Time [UTC] standard. - - The file creation time. - - - - Gets the last time the file associated with the appeander is written. The time returned is in Coordinated - Universal Time [UTC] standard. - - The time the file was last written to. - - - - Gets the length in bytes of the file associated with the appeander. - - A long value representing the length of the file in bytes. - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Appender used to discard data for the FileTarget. - Used mostly for testing entire stack except the actual writing to disk. - Throws away all data. - - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Multi-process and multi-host file appender which attempts - to get exclusive write access and retries if it's not available. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Writes the specified bytes. - - The bytes array. - The bytes array offset. - The number of bytes. - - - - Flushes this instance. - - - - - Closes this instance. - - - - - Gets the creation time for a file associated with the appender. The time returned is in Coordinated Universal - Time [UTC] standard. - - The file creation time. - - - - Gets the last time the file associated with the appeander is written. The time returned is in Coordinated - Universal Time [UTC] standard. - - The time the file was last written to. - - - - Gets the length in bytes of the file associated with the appeander. - - A long value representing the length of the file in bytes. - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Optimized single-process file appender which keeps the file open for exclusive write. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Writes the specified bytes. - - The bytes array. - The bytes array offset. - The number of bytes. - - - - Flushes this instance. - - - - - Closes this instance. - - - - - Gets the creation time for a file associated with the appender. The time returned is in Coordinated Universal - Time [UTC] standard. - - The file creation time. - - - - Gets the last time the file associated with the appeander is written. The time returned is in Coordinated - Universal Time [UTC] standard. - - The time the file was last written to. - - - - Gets the length in bytes of the file associated with the appeander. - - A long value representing the length of the file in bytes. - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - Provides a multiprocess-safe atomic file append while - keeping the files open. - - - - - Initializes a new instance of the class. - - Name of the file. - The parameters. - - - - Creates or opens a file in a special mode, so that writes are automatically - as atomic writes at the file end. - See also "UnixMultiProcessFileAppender" which does a similar job on *nix platforms. - - File to create or open - - - - Writes the specified bytes. - - The bytes array. - The bytes array offset. - The number of bytes. - - - - Closes this instance. - - - - - Flushes this instance. - - - - - Gets the length in bytes of the file associated with the appeander. - - A long value representing the length of the file in bytes. - - - - Factory class. - - - - - Opens the appender for given file name and parameters. - - Name of the file. - Creation parameters. - - Instance of which can be used to write to the file. - - - - - An immutable object that stores basic file info. - - - - - Constructs a FileCharacteristics object. - - The time the file was created in UTC. - The time the file was last written to in UTC. - The size of the file in bytes. - - - - The time the file was created in UTC. - - - - - The time the file was last written to in UTC. - - - - - The size of the file in bytes. - - - - - Optimized routines to get the basic file characteristics of the specified file. - - - - - Initializes static members of the FileCharacteristicsHelper class. - - - - - Gets the information about a file. - - Name of the file. - The file stream. - The file characteristics, if the file information was retrieved successfully, otherwise null. - - - - A layout that represents a filePath. - - - - - Cached directory separator char array to avoid memory allocation on each method call. - - - - - Cached invalid filenames char array to avoid memory allocation everytime Path.GetInvalidFileNameChars() is called. - - - - - not null when == false - - - - - non null is fixed, - - - - - is the cache-key, and when newly rendered filename matches the cache-key, - then it reuses the cleaned cache-value . - - - - - is the cache-value that is reused, when the newly rendered filename - matches the cache-key - - - - Initializes a new instance of the class. - - - - Render the raw filename from Layout - - The log event. - StringBuilder to minimize allocations [optional]. - String representation of a layout. - - - - Convert the raw filename to a correct filename - - The filename generated by Layout. - String representation of a correct filename. - - - - Is this (templated/invalid) path an absolute, relative or unknown? - - - - - Is this (templated/invalid) path an absolute, relative or unknown? - - - - - Convert object to string - - value - format for conversion. - - - If is null and isn't a already, then the will get a locked by - - - - - Interface for the wrapper around System.Configuration.ConfigurationManager. - - - - - Gets the wrapper around ConfigurationManager.AppSettings. - - - - - Format a log message - - - - - Format the message and return - - LogEvent with message to be formatted - formatted message - - - - Has the logevent properties? - - LogEvent with message to be formatted - False when logevent has no properties to be extracted - - - - Appends the logevent message to the provided StringBuilder - - LogEvent with message to be formatted - The to append the formatted message. - - - - Interface implemented by layouts and layout renderers. - - - - - Renders the the value of layout or layout renderer in the context of the specified log event. - - The log event. - String representation of a layout. - - - - Supports mocking of SMTP Client code. - - - - - Specifies how outgoing email messages will be handled. - - - - - Gets or sets the name or IP address of the host used for SMTP transactions. - - - - - Gets or sets the port used for SMTP transactions. - - - - - Gets or sets a value that specifies the amount of time after which a synchronous Send call times out. - - - - - Gets or sets the credentials used to authenticate the sender. - - - - - Sends an e-mail message to an SMTP server for delivery. These methods block while the message is being transmitted. - - - System.Net.Mail.MailMessage - MailMessage - A MailMessage that contains the message to send. - - - - Gets or sets the folder where applications save mail messages to be processed by the local SMTP server. - - - - - Supports object initialization and termination. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Allows components to request stack trace information to be provided in the . - - - - - Gets the level of stack trace information required by the implementing class. - - - - - Render the event info as parse as short - - current layout - - default value when the render - layout name for log message to internal log when logging fails - - - - - Render the event info as parse as int - - current layout - - default value when the render - layout name for log message to internal log when logging fails - - - - - Render the event info as parse as bool - - current layout - - default value when the render - layout name for log message to internal log when logging fails - - - - - Logger configuration. - - - - - Initializes a new instance of the class. - - The targets by level. - Use the old exception log handling of NLog 3.0? - - - - - Use the old exception log handling of NLog 3.0? - - This method was marked as obsolete before NLog 4.3.11 and it will be removed in NLog 5. - - - - Gets targets for the specified level. - - The level. - Chain of targets with attached filters. - - - - Determines whether the specified level is enabled. - - The level. - - A value of true if the specified level is enabled; otherwise, false. - - - - - When true: Do not fallback to StringBuilder.Format for positional templates - - - - - New formatter - - When true: Do not fallback to StringBuilder.Format for positional templates - - - - - The MessageFormatter delegate - - - - - - - - Most-Recently-Used-Cache, that discards less frequently used items on overflow - - - - - Constructor - - Maximum number of items the cache will hold before discarding. - - - - Attempt to insert item into cache. - - Key of the item to be inserted in the cache. - Value of the item to be inserted in the cache. - true when the key does not already exist in the cache, false otherwise. - - - - Lookup existing item in cache. - - Key of the item to be searched in the cache. - Output value of the item found in the cache. - True when the key is found in the cache, false otherwise. - - - - Watches multiple files at the same time and raises an event whenever - a single change is detected in any of those files. - - - - - The types of changes to watch for. - - - - - Occurs when a change is detected in one of the monitored files. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Stops watching all files. - - - - - Stops watching the specified file. - - - - - - Watches the specified files for changes. - - The file names. - - - - Supports mocking of SMTP Client code. - - - Disabled Error CS0618 'SmtpClient' is obsolete: 'SmtpClient and its network of types are poorly designed, - we strongly recommend you use https://github.com/jstedfast/MailKit and https://github.com/jstedfast/MimeKit instead' - - - - - Network sender which uses HTTP or HTTPS POST. - - - - - Initializes a new instance of the class. - - The network URL. - - - - Actually sends the given text over the specified protocol. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Creates instances of objects for given URLs. - - - - - Creates a new instance of the network sender based on a network URL. - - - URL that determines the network sender to be created. - - - The maximum queue size. - - - A newly created network sender. - - - - - Interface for mocking socket calls. - - - - - A base class for all network senders. Supports one-way sending of messages - over various protocols. - - - - - Initializes a new instance of the class. - - The network URL. - - - - Gets the address of the network endpoint. - - - - - Gets the last send time. - - - - - Initializes this network sender. - - - - - Closes the sender and releases any unmanaged resources. - - The continuation. - - - - Flushes any pending messages and invokes a continuation. - - The continuation. - - - - Send the given text over the specified protocol. - - Bytes to be sent. - Offset in buffer. - Number of bytes to send. - The asynchronous continuation. - - - - Closes the sender and releases any unmanaged resources. - - - - - Performs sender-specific initialization. - - - - - Performs sender-specific close operation. - - The continuation. - - - - Performs sender-specific flush. - - The continuation. - - - - Actually sends the given text over the specified protocol. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Parses the URI into an endpoint address. - - The URI to parse. - The address family. - Parsed endpoint. - - - - Default implementation of . - - - - - Creates a new instance of the network sender based on a network URL:. - - - URL that determines the network sender to be created. - - - The maximum queue size. - - /// - A newly created network sender. - - - - - Socket proxy for mocking Socket code. - - - - - Initializes a new instance of the class. - - The address family. - Type of the socket. - Type of the protocol. - - - - Gets underlying socket instance. - - - - - Closes the wrapped socket. - - - - - Invokes ConnectAsync method on the wrapped socket. - - The instance containing the event data. - Result of original method. - - - - Invokes SendAsync method on the wrapped socket. - - The instance containing the event data. - Result of original method. - - - - Invokes SendToAsync method on the wrapped socket. - - The instance containing the event data. - Result of original method. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Sends messages over a TCP network connection. - - - - - Initializes a new instance of the class. - - URL. Must start with tcp://. - The address family. - - - - Creates the socket with given parameters. - - The address family. - Type of the socket. - Type of the protocol. - Instance of which represents the socket. - - - - Performs sender-specific initialization. - - - - - Closes the socket. - - The continuation. - - - - Performs sender-specific flush. - - The continuation. - - - - Sends the specified text over the connected socket. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Facilitates mocking of class. - - - - - Raises the Completed event. - - - - - Sends messages over the network as UDP datagrams. - - - - - Initializes a new instance of the class. - - URL. Must start with udp://. - The address family. - - - - Creates the socket. - - The address family. - Type of the socket. - Type of the protocol. - Implementation of to use. - - - - Performs sender-specific initialization. - - - - - Closes the socket. - - The continuation. - - - - Sends the specified text as a UDP datagram. - - The bytes to be sent. - Offset in buffer. - Number of bytes to send. - The async continuation to be invoked after the buffer has been sent. - To be overridden in inheriting classes. - - - - Scans (breadth-first) the object graph following all the edges whose are - instances have attached and returns - all objects implementing a specified interfaces. - - - - - Finds the objects which have attached which are reachable - from any of the given root objects when traversing the object graph over public properties. - - Type of the objects to return. - Also search the properties of the wanted objects. - The root objects. - Ordered list of objects implementing T. - - - ISet is not there in .net35, so using HashSet - - - - Combine paths - - basepath, not null - optional dir - optional file - - - - - Detects the platform the NLog is running on. - - - - - Gets the current runtime OS. - - - - - Gets a value indicating whether current OS is a desktop version of Windows. - - - - - Gets a value indicating whether current OS is Win32-based (desktop or mobile). - - - - - Gets a value indicating whether current OS is Unix-based. - - - - - Gets a value indicating whether current runtime is Mono-based - - - - - Gets a value indicating whether current runtime supports use of mutex - - - - - Portable implementation of . - - - - - Gets the information about a file. - - Name of the file. - The file stream. - The file characteristics, if the file information was retrieved successfully, otherwise null. - - - - Portable implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets current process ID. - - - - - - Gets current process name. - - - - - - Gets current process name (excluding filename extension, if any). - - - - - - Gets the name of the process. - - - - - Dictionary that combines the standard with the - MessageTemplate-properties extracted from the . - - The are returned as the first items - in the collection, and in positional order. - - - - - Value of the property - - - - - Is this a property of the message? - - - - - - - Value of the property - Is this a property of the message? - - - - The properties of the logEvent - - - - - The properties extracted from the message - - - - - Injects the list of message-template-parameter into the IDictionary-interface - - Message-template-parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Check if the message-template-parameters can be used directly without allocating a dictionary - - Message-template-parameters - Are all parameter names unique (true / false) - - - - Attempt to insert the message-template-parameters into an empty dictionary - - Message-template-parameters - The initially empty dictionary - Message-template-parameters was inserted into dictionary without trouble (true/false) - - - - Attempt to override the existing dictionary values using the message-template-parameters - - Message-template-parameters - The already filled dictionary - List of unique message-template-parameters - - - - - - - - - - - - - - - - - - - - - Will always throw, as collection is readonly - - - Will always throw, as collection is readonly - - - Will always throw, as collection is readonly - - - - - - - - - - - - - - - - - - - Reflection helpers for accessing properties. - - - - - Set value parsed from string. - - object instance to set with property - name of the property on - The value to be parsed. - - - - - Is the property of array-type? - - Type which has the property - name of the property. - - - - - Get propertyinfo - - object which could have property - propertyname on - result when success. - success. - - - - Try parse of string to (Generic) list, comma separated. - - - If there is a comma in the value, then (single) quote the value. For single quotes, use the backslash as escape - - - - - - - - - Reflection helpers. - - - - - Gets all usable exported types from the given assembly. - - Assembly to scan. - Usable types from the given assembly. - Types which cannot be loaded are skipped. - - - - Is this a static class? - - - - This is a work around, as Type doesn't have this property. - From: http://stackoverflow.com/questions/1175888/determine-if-a-type-is-static - - - - - Optimized delegate for calling MethodInfo - - Object instance, use null for static methods. - Complete list of parameters that matches the method, including optional/default parameters. - - - - - Creates an optimized delegate for calling the MethodInfo using Expression-Trees - - Method to optimize - Optimized delegate for invoking the MethodInfo - - - - Controls a single allocated AsyncLogEventInfo-List for reuse (only one active user) - - - - - Controls a single allocated char[]-buffer for reuse (only one active user) - - - - - Controls a single allocated StringBuilder for reuse (only one active user) - - - - - Controls a single allocated object for reuse (only one active user) - - - - Empty handle when is disabled - - - - Creates handle to the reusable char[]-buffer for active usage - - Handle to the reusable item, that can release it again - - - - Access the acquired reusable object - - - - - Controls a single allocated MemoryStream for reuse (only one active user) - - - - - Supported operating systems. - - - If you add anything here, make sure to add the appropriate detection - code to - - - - - Any operating system. - - - - - Unix/Linux operating systems. - - - - - Windows CE. - - - - - Desktop versions of Windows (95,98,ME). - - - - - Windows NT, 2000, 2003 and future versions based on NT technology. - - - - - Unknown operating system. - - - - - Simple character tokenizer. - - - - - Initializes a new instance of the class. - - The text to be tokenized. - - - - Current position in - - - - - Full text to be parsed - - - - - Check current char while not changing the position. - - - - - - Read the current char and change position - - - - - - Get the substring of the - - - - - - - - Implements a single-call guard around given continuation function. - - - - - Initializes a new instance of the class. - - The asynchronous continuation. - - - - Continuation function which implements the single-call guard. - - The exception. - - - - HashSet optimized for single item - - - - - - Insert single item on scope start, and remove on scope exit - - Item to insert in scope - Existing hashset to update - Force allocation of real hashset-container - - - - Add item to collection, if it not already exists - - Item to insert - - - - Clear hashset - - - - - Check if hashset contains item - - - Item exists in hashset (true/false) - - - - Remove item from hashset - - - Item removed from hashset (true/false) - - - - Copy items in hashset to array - - Destination array - Array offset - - - - Create hashset enumerator - - Enumerator - - - - Provides helpers to sort log events and associated continuations. - - - - - Key selector delegate. - - The type of the value. - The type of the key. - Value to extract key information from. - Key selected from log event. - - - - Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. - - The type of the value. - The type of the key. - The inputs. - The key selector function. - - Dictionary where keys are unique input keys, and values are lists of . - - - - - Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. - - The type of the value. - The type of the key. - The inputs. - The key selector function. - - Dictionary where keys are unique input keys, and values are lists of . - - - - - Performs bucket sort (group by) on an array of items and returns a dictionary for easy traversal of the result set. - - The type of the value. - The type of the key. - The inputs. - The key selector function. - The key comparer function. - - Dictionary where keys are unique input keys, and values are lists of . - - - - - Single-Bucket optimized readonly dictionary. Uses normal internally Dictionary if multiple buckets are needed. - - Avoids allocating a new dictionary, when all items are using the same bucket - - The type of the key. - The type of the value. - - - - - - - - - - - - - - - - Allows direct lookup of existing keys. If trying to access non-existing key exception is thrown. - Consider to use instead for better safety. - - Key value for lookup - Mapped value found - - - - Non-Allocating struct-enumerator - - - - - - - - - - - - - Will always throw, as dictionary is readonly - - - Will always throw, as dictionary is readonly - - - - - - Will always throw, as dictionary is readonly - - - Will always throw, as dictionary is readonly - - - - - - - - - Will always throw, as dictionary is readonly - - - - Utilities for dealing with values. - - - - - Gets the fully qualified name of the class invoking the calling method, including the - namespace but not the assembly. - - - - - Gets the fully qualified name of the class invoking the calling method, including the - namespace but not the assembly. - - StackFrame from the calling method - Fully qualified class name - - - - Returns the assembly from the provided StackFrame (If not internal assembly) - - Valid asssembly, or null if assembly was internal - - - - Returns the classname from the provided StackFrame (If not from internal assembly) - - - Valid class name, or empty string if assembly was internal - - - - Stream helpers - - - - - Copy to output stream and skip BOM if encoding is UTF8 - - - - - - - - Copy stream input to output. Skip the first bytes - - stream to read from - stream to write to - .net35 doesn't have a .copyto - - - - Copy stream input to output. Skip the first bytes - - stream to read from - stream to write to - first bytes to skip (optional) - - - - Helpers for , which is used in e.g. layout renderers. - - - - - Renders the specified log event context item and appends it to the specified . - - append to this - value to be appended - formatstring. If @, then serialize the value with the Default JsonConverter. - provider, for example culture - - - - Appends int without using culture, and most importantly without garbage - - - value to append - - - - Appends uint without using culture, and most importantly without garbage - - Credits Gavin Pugh - http://www.gavpugh.com/2010/04/01/xnac-avoiding-garbage-when-working-with-stringbuilder/ - - - value to append - - - - Clears the provider StringBuilder - - - - - - Copies the contents of the StringBuilder to the MemoryStream using the specified encoding (Without BOM/Preamble) - - StringBuilder source - MemoryStream destination - Encoding used for converter string into byte-stream - Helper char-buffer to minimize memory allocations - - - - Copies the contents of the StringBuilder to the destination StringBuilder - - StringBuilder source - StringBuilder destination - - - - Append a number and pad with 0 to 2 digits - - append to this - the number - - - - Append a number and pad with 0 to 4 digits - - append to this - the number - - - - Apend a int type (byte, int) as string - - - - - Constructor - - Max number of items - Initial StringBuilder Size - Max StringBuilder Size - - - - Takes StringBuilder from pool - - Allow return to pool - - - - Releases StringBuilder back to pool at its right place - - - - - Keeps track of acquired pool item - - - - - Releases pool item back into pool - - - - - Helpers for . - - - - - IsNullOrWhiteSpace, including for .NET 3.5 - - - - - - - Split a string - - - - - Split string with escape. The escape char is the same as the splitchar - - - split char. escaped also with this char - - - - - Split string with escape - - - - - - - - - Split a string, optional quoted value - - Text to split - Character to split the - Quote character - - Escape for the , not escape for the - , use quotes for that. - - - - - - Represents target with a chain of filters which determine - whether logging should happen. - - - - - cached result as calculating is expensive. - - - - - Initializes a new instance of the class. - - The target. - The filter chain. - - - - Gets the target. - - The target. - - - - Gets the filter chain. - - The filter chain. - - - - Gets or sets the next item in the chain. - - The next item in the chain. - This is for example the 'target2' logger in writeTo='target1,target2' - - - - Gets the stack trace usage. - - A value that determines stack trace handling. - - - - Returns details about current process and thread in a portable manner. - - - - - Initializes static members of the ThreadIDHelper class. - - - - - Gets the singleton instance of PortableThreadIDHelper or - Win32ThreadIDHelper depending on runtime environment. - - The instance. - - - - Gets current process ID. - - - - - Gets current process name. - - - - - Gets current process name (excluding filename extension, if any). - - - - - Helper for dealing with thread-local storage. - - - - - Allocates the data slot for storing thread-local information. - - Allocated slot key. - - - - Gets the data for a slot in thread-local storage. - - Type of the data. - The slot to get data for. - Automatically create the object if it doesn't exist. - - Slot data (will create T if null). - - - - - Wraps with a timeout. - - - - - Initializes a new instance of the class. - - The asynchronous continuation. - The timeout. - - - - Continuation function which implements the timeout logic. - - The exception. - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - URL Encoding helper. - - - - Allow UnreservedMarks instead of ReservedMarks, as specified by chosen RFC - - - Use RFC2396 standard (instead of RFC3986) - - - Should use lowercase when doing HEX escaping of special characters - - - Replace space ' ' with '+' instead of '%20' - - - Skip UTF8 encoding, and prefix special characters with '%u' - - - - Escape unicode string data for use in http-requests - - unicode string-data to be encoded - target for the encoded result - s for how to perform the encoding - - - - Convert the wide-char into utf8-bytes, and then escape - - - - - - - - - Is allowed? - - - - - - - - Is a-z / A-Z / 0-9 - - - - - - - Win32-optimized implementation of . - - - - - Gets the information about a file. - - Name of the file. - The file stream. - The file characteristics, if the file information was retrieved successfully, otherwise null. - - - - Win32-optimized implementation of . - - - - - Initializes a new instance of the class. - - - - - Gets current process ID. - - - - - - Gets current process name. - - - - - - Gets current process name (excluding filename extension, if any). - - - - - - Helper class for XML - - - - - removes any unusual unicode characters that can't be encoded into XML - - - - - Cleans string of any invalid XML chars found - - unclean string - string with only valid XML chars - - - - Converts object value to invariant format, and strips any invalid xml-characters - - Object value - Object value converted to string - - - - Converts object value to invariant format (understood by JavaScript) - - Object value - Object value converted to string - - - - Converts object value to invariant format (understood by JavaScript) - - Object value - Object TypeCode - Object value converted to string - - - - Safe version of WriteAttributeString - - - - - - - - - - Safe version of WriteAttributeString - - - - - - - - Safe version of WriteElementSafeString - - - - - - - - - - Safe version of WriteCData - - - - - - - Provides an interface to execute System.Actions without surfacing any exceptions raised for that action. - - - - - Runs the provided action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. - - Action to execute. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a default value is returned instead. - - Return type of the provided function. - Function to run. - Result returned by the provided function or the default value of type in case of exception. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a fallback value is returned instead. - - Return type of the provided function. - Function to run. - Fallback value to return in case of exception. - Result returned by the provided function or fallback value in case of exception. - - - - Logs an exception is logged at Error level if the provided task does not run to completion. - - The task for which to log an error if it does not run to completion. - This method is useful in fire-and-forget situations, where application logic does not depend on completion of task. This method is avoids C# warning CS4014 in such situations. - - - - Returns a task that completes when a specified task to completes. If the task does not run to completion, an exception is logged at Error level. The returned task always runs to completion. - - The task for which to log an error if it does not run to completion. - A task that completes in the state when completes. - - - - Runs async action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. - - Async action to execute. - A task that completes in the state when completes. - - - - Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. - The exception is not propagated outside of this method; a default value is returned instead. - - Return type of the provided function. - Async function to run. - A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the default value of type . - - - - Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. - The exception is not propagated outside of this method; a fallback value is returned instead. - - Return type of the provided function. - Async function to run. - Fallback value to return if the task does not end in the state. - A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the fallback value. - - - - Render a message template property to a string - - - - - Serialization of an object, e.g. JSON and append to - - The object to serialize to string. - Parameter Format - Parameter CaptureType - An object that supplies culture-specific formatting information. - Output destination. - Serialize succeeded (true/false) - - - - Log event context data. - - - - - Initializes a new instance of the class. - - - - - Gets or sets string that will be used to separate key/value pairs. - - - - - - Also render the caller information attributes? (, - , ). - - See https://msdn.microsoft.com/en-us/library/hh534540.aspx - - - - - - Gets or sets how key/value pairs will be formatted. - - - - - - Renders all log event's properties and appends them to the specified . - - The to append the rendered data to. - Logging event. - - - - The names of caller information attributes. - https://msdn.microsoft.com/en-us/library/hh534540.aspx - TODO NLog ver. 5 - Remove these properties - - - - - Also render the call attributes? (, - , ). - - - - - - Designates a property of the class as an ambient property. - - - non-ambient: ${uppercase:${level}} - ambient : ${level:uppercase} - - - - - Initializes a new instance of the class. - - Ambient property name. - - - - Used to render the application domain name. - - - - - Create a new renderer - - - - - Create a new renderer - - - - - Format string. Possible values: "Short", "Long" or custom like {0} {1}. Default "Long" - The first parameter is the , the second the second the - This string is used in - - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Render the layout - - - - - - - Convert the formatting string - - - - - - - Renders the assembly version information for the entry assembly or a named assembly. - - - As this layout renderer uses reflection and version information is unlikely to change during application execution, - it is recommended to use it in conjunction with the . - - - The entry assembly can't be found in some cases e.g. ASP.NET, unit tests, etc. - - - - - Initializes a new instance of the class. - - - - - The (full) name of the assembly. If null, using the entry assembly. - - - - - - Gets or sets the type of assembly version to retrieve. - - - Some version type and platform combinations are not fully supported. - - UWP earlier than .NET Standard 1.5: Value for is always returned unless the parameter is specified. - - Silverlight: Value for is always returned. - - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Renders an assembly version and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Type of assembly version to retrieve. - - - - - Gets the assembly version. - - - - - Gets the file version. - - - - - Gets additional version information. - - - - - The current application domain's base directory. - - - - - cached - - - - - Use base dir of current process. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name of the file to be Path.Combine()'d with with the base directory. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with with the base directory. - - - - - - Renders the application base directory and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The call site source file name. Full callsite - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to include source file path. - - - - - - Gets or sets the number of frames to skip. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The call site (class name, method name and source information). - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to render the class name. - - - - - - Gets or sets a value indicating whether to render the include the namespace with . - - - - - - Gets or sets a value indicating whether to render the method name. - - - - - - Gets or sets a value indicating whether the method name will be cleaned up if it is detected as an anonymous delegate. - - - - - - Gets or sets a value indicating whether the method and class names will be cleaned up if it is detected as an async continuation - (everything after an await-statement inside of an async method). - - - - - - Gets or sets the number of frames to skip. - - - - - - Gets or sets a value indicating whether to render the source file name and line number. - - - - - - Gets or sets a value indicating whether to include source file path. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The call site source line number. Full callsite - - - - - Gets or sets the number of frames to skip. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A counter value (increases on each layout rendering). - - - - - Initializes a new instance of the class. - - - - - Gets or sets the initial value of the counter. - - - - - - Gets or sets the value to be added to the counter after each layout rendering. - - - - - - Gets or sets the name of the sequence. Different named sequences can have individual values. - - - - - - Renders the specified counter value and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The current working directory of the application. - - - - - Gets or sets the name of the file to be Path.Combine()'d with the current directory. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the current directory. - - - - - - Renders the current directory and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Current date and time. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the culture used for rendering. - - - - - - Gets or sets the date format. Can be any argument accepted by DateTime.ToString(format). - - - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - Renders the current date and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The environment variable. - - - - - Gets or sets the name of the environment variable. - - - - - - Gets or sets the default value to be used when the environment variable is not set. - - - - - - Renders the specified environment variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Log event context data. - - This class was marked as obsolete on NLog 2.0 and it may be removed in a future release. - - - - Gets or sets the name of the item. - - - - - - Renders the specified log event context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Log event context data. See . - - - - - Log event context data with default options. - - - - - Gets or sets the name of the item. - - - - - - Format string for conversion from object to string. - - - - - - Gets or sets the culture used for rendering. - - - - - - Renders the specified log event context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Exception information provided through - a call to one of the Logger.*Exception() methods. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the format of the output. Must be a comma-separated list of exception - properties: Message, Type, ShortType, ToString, Method, StackTrace. - This parameter value is case-insensitive. - - - - - - - - Gets or sets the format of the output of inner exceptions. Must be a comma-separated list of exception - properties: Message, Type, ShortType, ToString, Method, StackTrace. - This parameter value is case-insensitive. - - - - - - Gets or sets the separator used to concatenate parts specified in the Format. - - - - - - Gets or sets the separator used to concatenate exception data specified in the Format. - - - - - - Gets or sets the maximum number of inner exceptions to include in the output. - By default inner exceptions are not enabled for compatibility with NLog 1.0. - - - - - - Gets or sets the separator between inner exceptions. - - - - - - Gets the formats of the output of inner exceptions to be rendered in target. - - - - - - - Gets the formats of the output to be rendered in target. - - - - - - - Renders the specified exception information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Appends the Message of an Exception to the specified . - - The to append the rendered data to. - The exception containing the Message to append. - - - - Appends the method name from Exception's stack trace to the specified . - - The to append the rendered data to. - The Exception whose method name should be appended. - - - - Appends the stack trace from an Exception to the specified . - - The to append the rendered data to. - The Exception whose stack trace should be appended. - - - - Appends the result of calling ToString() on an Exception to the specified . - - The to append the rendered data to. - The Exception whose call to ToString() should be appended. - - - - Appends the type of an Exception to the specified . - - The to append the rendered data to. - The Exception whose type should be appended. - - - - Appends the short type of an Exception to the specified . - - The to append the rendered data to. - The Exception whose short type should be appended. - - - - Appends the contents of an Exception's Data property to the specified . - - The to append the rendered data to. - The Exception whose Data property elements should be appended. - - - - Appends all the serialized properties of an Exception into the specified . - - The to append the rendered data to. - The Exception whose properties should be appended. - - - - Split the string and then compile into list of Rendering formats. - - - - - - - Renders contents of the specified file. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name of the file. - - - - - - Gets or sets the encoding used in the file. - - The encoding. - - - - - Renders the contents of the specified file and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A layout renderer which could have different behavior per instance by using a . - - - - - Create a new. - - Name without ${}. - Method that renders the layout. - - - - Name used in config without ${}. E.g. "test" could be used as "${test}". - - - - - Method that renders the layout. - - - - - Renders the specified environmental information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The information about the garbage collector. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the property to retrieve. - - - - - - Renders the selected process information. - - The to append the rendered data to. - Logging event. - - - - Gets or sets the property of System.GC to retrieve. - - - - - Total memory allocated. - - - - - Total memory allocated (perform full garbage collection first). - - - - - Gets the number of Gen0 collections. - - - - - Gets the number of Gen1 collections. - - - - - Gets the number of Gen2 collections. - - - - - Maximum generation number supported by GC. - - - - - Global Diagnostics Context item. Provided for compatibility with log4net. - - - - - Gets or sets the name of the item. - - - - - - Format string for conversion from object to string. - - - - - - Renders the specified Global Diagnostics Context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Globally-unique identifier (GUID). - - - - - Initializes a new instance of the class. - - - - - Gets or sets the GUID format as accepted by Guid.ToString() method. - - - - - - Generate the Guid from the NLog LogEvent (Will be the same for all targets) - - - - - - Renders a newly generated GUID string and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Thread identity information (name and authentication information). - - - - - Initializes a new instance of the class. - - - - - Gets or sets the separator to be used when concatenating - parts of identity information. - - - - - - Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.Name. - - - - - - Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.AuthenticationType. - - - - - - Gets or sets a value indicating whether to render Thread.CurrentPrincipal.Identity.IsAuthenticated. - - - - - - Renders the specified identity information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Installation parameter (passed to InstallNLogConfig). - - - - - Gets or sets the name of the parameter. - - - - - - Renders the specified installation parameter and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Render environmental information related to logging events. - - - - - Gets the logging configuration this target is part of. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Renders the the value of layout renderer in the context of the specified log event. - - The log event. - String representation of a layout renderer. - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Renders the the value of layout renderer in the context of the specified log event. - - The log event. - The layout render output is appended to builder - - - - Renders the specified environmental information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Get the for rendering the messages to a - - LogEvent with culture - Culture in on Layout level - - - - - Get the for rendering the messages to a , needed for date and number formats - - LogEvent with culture - Culture in on Layout level - - - is preferred - - - - - Register a custom layout renderer. - - Short-cut for registing to default - Type of the layout renderer. - Name of the layout renderer - without ${}. - - - - Register a custom layout renderer. - - Short-cut for registing to default - Type of the layout renderer. - Name of the layout renderer - without ${}. - - - - Register a custom layout renderer with a callback function . The callback recieves the logEvent. - - Name of the layout renderer - without ${}. - Callback that returns the value for the layout renderer. - - - - Register a custom layout renderer with a callback function . The callback recieves the logEvent and the current configuration. - - Name of the layout renderer - without ${}. - Callback that returns the value for the layout renderer. - - - - Marks class as a layout renderer and assigns a name to it. - - This attribute is not required when registering the layout in the API. - - - - Initializes a new instance of the class. - - Name of the layout renderer, without the `${ }` - - - - Format of the ${level} layout renderer output. - - - - - Render the full level name. - - - - - Render the first character of the level. - - - - - Render the ordinal (aka number) for the level. - - - - - The log level. - - - - - Gets or sets a value indicating the output format of the level. - - - - - - Renders the current log level and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A string literal. - - - This is used to escape '${' sequence - as ;${literal:text=${}' - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The literal text value. - This is used by the layout compiler. - - - - Gets or sets the literal text. - - - - - - Renders the specified string literal and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - XML event description compatible with log4j, Chainsaw and NLogViewer. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes the layout renderer. - - - - - Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema. - - - - - - Gets or sets a value indicating whether the XML should use spaces for indentation. - - - - - - Gets or sets the AppInfo field. By default it's the friendly name of the current AppDomain. - - - - - - Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Gets or sets the NDLC item separator. - - - - - - Gets or sets the option to include all properties from the log events - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Gets or sets the NDC item separator. - - - - - - Gets or sets the log4j:event logger-xml-attribute (Default ${logger}) - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - Renders the XML logging event and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The logger name. - - - - - Gets or sets a value indicating whether to render short logger name (the part after the trailing dot character). - - - - - - Renders the logger name and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The date and time in a long, sortable format yyyy-MM-dd HH:mm:ss.mmm. - - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - Renders the date in the long format (yyyy-MM-dd HH:mm:ss.mmm) and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The machine name that the process is running on. - - - - - Initializes the layout renderer. - - - - - Renders the machine name and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Mapped Diagnostic Context item. Provided for compatibility with log4net. - - - - - Gets or sets the name of the item. - - - - - - Format string for conversion from object to string. - - - - - - Renders the specified MDC item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Mapped Diagnostic Logical Context item (based on CallContext). - - - - - Gets or sets the name of the item. - - - - - - Format string for conversion from object to string. - - - - - - Renders the specified MDLC item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The formatted log message. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to log exception along with message. - - - - - - Gets or sets the string that separates message from the exception. - - - - - - Gets or sets whether it should render the raw message without formatting parameters - - - - - - Renders the log message including any positional parameters and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Nested Diagnostic Context item. Provided for compatibility with log4net. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the number of top stack frames to be rendered. - - - - - - Gets or sets the number of bottom stack frames to be rendered. - - - - - - Gets or sets the separator to be used for concatenating nested diagnostics context output. - - - - - - Renders the specified Nested Diagnostics Context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Renderer (Async scope) - - - - - Initializes a new instance of the class. - - - - - Gets or sets the number of top stack frames to be rendered. - - - - - - Gets or sets the number of bottom stack frames to be rendered. - - - - - - Gets or sets the separator to be used for concatenating nested logical context output. - - - - - - Renders the specified Nested Logical Context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Timing Renderer (Async scope) - - - - - Gets or sets whether to only include the duration of the last scope created - - - - - - Gets or sets whether to just display the scope creation time, and not the duration - - - - - - Gets or sets the TimeSpan format. Can be any argument accepted by TimeSpan.ToString(format). - - - - - - Renders the timing details of the Nested Logical Context item and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A newline literal. - - - - - Renders the specified string literal and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The directory where NLog.dll is located. - - - - - Initializes static members of the NLogDirLayoutRenderer class. - - - - - Gets or sets the name of the file to be Path.Combine()'d with the directory name. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the directory name. - - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Renders the directory where NLog is located and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The performance counter. - - - - - Gets or sets the name of the counter category. - - - - - - Gets or sets the name of the performance counter. - - - - - - Gets or sets the name of the performance counter instance (e.g. this.Global_). - - - - - - Gets or sets the name of the machine to read the performance counter from. - - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Renders the specified environment variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The identifier of the current process. - - - - - Renders the current process ID. - - The to append the rendered data to. - Logging event. - - - - The information about the running process. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the property to retrieve. - - - - - - Gets or sets the format-string to use if the property supports it (Ex. DateTime / TimeSpan / Enum) - - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Renders the selected process information. - - The to append the rendered data to. - Logging event. - - - - Property of System.Diagnostics.Process to retrieve. - - - - - Base Priority. - - - - - Exit Code. - - - - - Exit Time. - - - - - Process Handle. - - - - - Handle Count. - - - - - Whether process has exited. - - - - - Process ID. - - - - - Machine name. - - - - - Handle of the main window. - - - - - Title of the main window. - - - - - Maximum Working Set. - - - - - Minimum Working Set. - - - - - Non-paged System Memory Size. - - - - - Non-paged System Memory Size (64-bit). - - - - - Paged Memory Size. - - - - - Paged Memory Size (64-bit).. - - - - - Paged System Memory Size. - - - - - Paged System Memory Size (64-bit). - - - - - Peak Paged Memory Size. - - - - - Peak Paged Memory Size (64-bit). - - - - - Peak Virtual Memory Size. - - - - - Peak Virtual Memory Size (64-bit).. - - - - - Peak Working Set Size. - - - - - Peak Working Set Size (64-bit). - - - - - Whether priority boost is enabled. - - - - - Priority Class. - - - - - Private Memory Size. - - - - - Private Memory Size (64-bit). - - - - - Privileged Processor Time. - - - - - Process Name. - - - - - Whether process is responding. - - - - - Session ID. - - - - - Process Start Time. - - - - - Total Processor Time. - - - - - User Processor Time. - - - - - Virtual Memory Size. - - - - - Virtual Memory Size (64-bit). - - - - - Working Set Size. - - - - - Working Set Size (64-bit). - - - - - The name of the current process. - - - - - Gets or sets a value indicating whether to write the full path to the process executable. - - - - - - Renders the current process name (optionally with a full path). - - The to append the rendered data to. - Logging event. - - - - The process time in format HH:mm:ss.mmm. - - - - - Gets or sets a value indicating whether to output in culture invariant format - - - - - - Renders the current process running time and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Write timestamp to builder with format hh:mm:ss:fff - - - - - - - - High precision timer, based on the value returned from QueryPerformanceCounter() optionally converted to seconds. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to normalize the result by subtracting - it from the result of the first call (so that it's effectively zero-based). - - - - - - Gets or sets a value indicating whether to output the difference between the result - of QueryPerformanceCounter and the previous one. - - - - - - Gets or sets a value indicating whether to convert the result to seconds by dividing - by the result of QueryPerformanceFrequency(). - - - - - - Gets or sets the number of decimal digits to be included in output. - - - - - - Gets or sets a value indicating whether to align decimal point (emit non-significant zeros). - - - - - - Initializes the layout renderer. - - - - - Renders the ticks value of current time and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A value from the Registry. - - - - - Create new renderer - - - - - Gets or sets the registry value name. - - - - - - Gets or sets the value to be output when the specified registry key or value is not found. - - - - - - Require escaping backward slashes in . Need to be backwardscompatible. - - When true: - - `\` in value should be configured as `\\` - `\\` in value should be configured as `\\\\`. - - Default value wasn't a Layout before and needed an escape of the slash - - - - - Gets or sets the registry view (see: https://msdn.microsoft.com/de-de/library/microsoft.win32.registryview.aspx). - Allowed values: Registry32, Registry64, Default - - - - - - Gets or sets the registry key. - - - HKCU\Software\NLogTest - - - Possible keys: -
    -
  • HKEY_LOCAL_MACHINE
    • -
  • HKLM
    • -
  • HKEY_CURRENT_USER
    • -
  • HKCU
    • -
  • HKEY_CLASSES_ROOT
    • -
  • HKEY_USERS
    • -
  • HKEY_CURRENT_CONFIG
    • -
  • HKEY_DYN_DATA
    • -
  • HKEY_PERFORMANCE_DATA
    • -
- - - - - - Reads the specified registry key and value and appends it to - the passed . - - The to append the rendered data to. - Logging event. Ignored. - - - - Has ? - - - - - Parse key to and subkey. - - full registry key name - Result of parsing, never null. - - - - Aliases for the hives. See https://msdn.microsoft.com/en-us/library/ctb3kd86(v=vs.110).aspx - - - - - The sequence ID - - - - - Renders the current log sequence ID and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The short date in a sortable format yyyy-MM-dd. - - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - Renders the current short date string (yyyy-MM-dd) and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - System special folder path (includes My Documents, My Music, Program Files, Desktop, and more). - - - - - Gets or sets the system special folder to use. - - - Full list of options is available at MSDN. - The most common ones are: -
    -
  • ApplicationData - roaming application data for current user.
    • -
  • CommonApplicationData - application data for all users.
    • -
  • MyDocuments - My Documents
    • -
  • DesktopDirectory - Desktop directory
    • -
  • LocalApplicationData - non roaming application data
    • -
  • Personal - user profile directory
    • -
  • System - System directory
    • -
- - - - - - Gets or sets the name of the file to be Path.Combine()'d with the directory name. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the directory name. - - - - - - Renders the directory where NLog is located and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Format of the ${stacktrace} layout renderer output. - - - - - Raw format (multiline - as returned by StackFrame.ToString() method). - - - - - Flat format (class and method names displayed in a single line). - - - - - Detailed flat format (method signatures displayed in a single line). - - - - - Stack trace renderer. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the output format of the stack trace. - - - - - - Gets or sets the number of top stack frames to be rendered. - - - - - - Gets or sets the number of frames to skip. - - - - - - Gets or sets the stack frame separator string. - - - - - - Gets the level of stack trace information required by the implementing class. - - - - - - Renders the call site and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A temporary directory. - - - - - Gets or sets the name of the file to be Path.Combine()'d with the directory name. - - - - - - Gets or sets the name of the directory to be Path.Combine()'d with the directory name. - - - - - - Renders the directory where NLog is located and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The identifier of the current thread. - - - - - Renders the current thread identifier and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The name of the current thread. - - - - - Renders the current thread name and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The Ticks value of current date and time. - - - - - Renders the ticks value of current time and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - The time in a 24-hour, sortable format HH:mm:ss.mmmm. - - - - - Gets or sets a value indicating whether to output UTC time instead of local time. - - - - - - Gets or sets a value indicating whether to output in culture invariant format - - - - - - Renders time in the 24-h format (HH:mm:ss.mmm) and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - A renderer that puts into log a System.Diagnostics trace correlation id. - - - - - Renders the current trace activity ID. - - The to append the rendered data to. - Logging event. - - - - Render a NLog variable (xml or config) - - - - - Gets or sets the name of the NLog variable. - - - - - - Gets or sets the default value to be used when the variable is not set. - - Not used if Name is null - - - - - Initializes the layout renderer. - - - - - Try get the - - - - - - - Renders the specified variable and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Thread Windows identity information (username). - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether domain name should be included. - - - - - - Gets or sets a value indicating whether username should be included. - - - - - - Renders the current thread windows identity information and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Applies caching to another layout output. - - - The value of the inner layout will be rendered only once and reused subsequently. - - - - - A value indicating when the cache is cleared. - - - - Never clear the cache. - - - Clear the cache whenever the is initialized. - - - Clear the cache whenever the is closed. - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether this is enabled. - - - - - - Gets or sets a value indicating when the cache is cleared. - - - - - - Cachekey. If the cachekey changes, resets the value. For example, the cachekey would be the current day.s - - - - - - Initializes the layout renderer. - - - - - Closes the layout renderer. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - Contents of inner layout. - - - - Filters characters not allowed in the file names by replacing them with safe character. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to modify the output of this renderer so it can be used as a part of file path - (illegal characters are replaced with '_'). - - - - - - Replaces all non-safe characters with underscore to make valid filepath - - Output to be transformed. - - - - Escapes output of another layout using JSON rules. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to apply JSON encoding. - - - - - - Gets or sets a value indicating whether to escape non-ascii characters - - - - - - Render to local target using Inner Layout, and then transform before final append - - - - - - - Post-processes the rendered message. - - The text to be JSON-encoded. - - - - Converts the result of another layout output to lower case. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether lower case conversion should be applied. - - A value of true if lower case conversion should be applied; otherwise, false. - - - - - Gets or sets the culture used for rendering. - - - - - - Post-processes the rendered message. - - Output to be post-processed. - - - - Only outputs the inner layout when exception has been defined for log message. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - - Contents of inner layout. - - - - - Horizontal alignment for padding layout renderers. - - - - - When layout text is too long, align it to the left - (remove characters from the right). - - - - - When layout text is too long, align it to the right - (remove characters from the left). - - - - - Applies padding to another layout output. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the number of characters to pad the output to. - - - Positive padding values cause left padding, negative values - cause right padding to the desired width. - - - - - - Gets or sets the padding character. - - - - - - Gets or sets a value indicating whether to trim the - rendered text to the absolute value of the padding length. - - - - - - Gets or sets a value indicating whether a value that has - been truncated (when is true) - will be left-aligned (characters removed from the right) - or right-aligned (characters removed from the left). The - default is left alignment. - - RegistryLayoutRenderer - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Replaces a string in the output of another layout with another string. - - - ${replace:searchFor=\\n+:replaceWith=-:regex=true:inner=${message}} - - - - - Gets or sets the text to search for. - - The text search for. - - - - - Gets or sets a value indicating whether regular expressions should be used. - - A value of true if regular expressions should be used otherwise, false. - - - - - Gets or sets the replacement string. - - The replacement string. - - - - - Gets or sets the group name to replace when using regular expressions. - Leave null or empty to replace without using group name. - - The group name. - - - - - Gets or sets a value indicating whether to ignore case. - - A value of true if case should be ignored when searching; otherwise, false. - - - - - Gets or sets a value indicating whether to search for whole words. - - A value of true if whole words should be searched for; otherwise, false. - - - - - Initializes the layout renderer. - - - - - Post-processes the rendered message. - - The text to be post-processed. - Post-processed text. - - - - This class was created instead of simply using a lambda expression so that the "ThreadAgnosticAttributeTest" will pass - - - - - A match evaluator for Regular Expression based replacing - - Input string. - Group name in the regex. - Replace value. - Match from regex. - Groups replaced with . - - - - Replaces newline characters from the result of another layout renderer with spaces. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating the string that should be used for separating lines. - - - - - - Post-processes the rendered message. - - Output to be post-processed. - - - - Decodes text "encrypted" with ROT-13. - - - See http://en.wikipedia.org/wiki/ROT13. - - - - - Gets or sets the layout to be wrapped. - - The layout to be wrapped. - This variable is for backwards compatibility - - - - - Encodes/Decodes ROT-13-encoded string. - - The string to be encoded/decoded. - Encoded/Decoded text. - - - - Encodes/Decodes ROT-13-encoded string. - - The string to be encoded/decoded. - - - - Post-processes the rendered message. - - Output to be transform. - - - - Trims the whitespace from the result of another layout renderer. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether lower case conversion should be applied. - - A value of true if lower case conversion should be applied; otherwise, false. - - - - - Removes white-spaces from both sides of the provided target - - Output to be transform. - - - - Converts the result of another layout output to upper case. - - - ${uppercase:${level}} //[DefaultParameter] - ${uppercase:Inner=${level}} - ${level:uppercase} // [AmbientProperty] - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether upper case conversion should be applied. - - A value of true if upper case conversion should be applied otherwise, false. - - - - - Gets or sets the culture used for rendering. - - - - - - Post-processes the rendered message. - - Output to be post-processed. - - - - Encodes the result of another layout output for use with URLs. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether spaces should be translated to '+' or '%20'. - - A value of true if space should be translated to '+'; otherwise, false. - - - - - Gets or sets a value whether escaping be done according to Rfc3986 (Supports Internationalized Resource Identifiers - IRIs) - - A value of true if Rfc3986; otherwise, false for legacy Rfc2396. - - - - - Gets or sets a value whether escaping be done according to the old NLog style (Very non-standard) - - A value of true if legacy encoding; otherwise, false for standard UTF8 encoding. - - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Outputs alternative layout when the inner layout produces empty result. - - - - - Gets or sets the layout to be rendered when original layout produced empty result. - - - - - - Transforms the output of another layout. - - Output to be transform. - - - - Renders the inner layout contents. - - for the result - The log event. - - - - Only outputs the inner layout when the specified condition has been met. - - - - - Gets or sets the condition that must be met for the layout to be printed. - - - - - - If is not met, print this layout. - - - - - - Transforms the output of another layout. - - Output to be transform. - - - - Renders the inner layout contents. - - for the result - The log event. - - - - Replaces newline characters from the result of another layout renderer with spaces. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the line length for wrapping. - - - Only positive values are allowed - - - - - - Post-processes the rendered message. - - The text to be post-processed. - Post-processed text. - - - - Base class for s which wrapping other s. - - This has the property (which is default) and can be used to wrap. - - - ${uppercase:${level}} //[DefaultParameter] - ${uppercase:Inner=${level}} - - - - - Gets or sets the wrapped layout. - - [DefaultParameter] so Inner: is not required if it's the first - - - - - - Renders the inner message, processes it and appends it to the specified . - - The to append the rendered data to. - Logging event. - - - - Transforms the output of another layout. - - Logging event. - Output to be transform. - Transformed text. - - - - Transforms the output of another layout. - - Output to be transform. - Transformed text. - - - - Renders the inner layout contents. - - The log event. - Contents of inner layout. - - - - Base class for s which wrapping other s. - - This expects the transformation to work on a - - - - - Render to local target using Inner Layout, and then transform before final append - - - - - - - Transforms the output of another layout. - - - Output to be transform. - - - - Transforms the output of another layout. - - Output to be transform. - - - - Renders the inner layout contents. - - - for the result - - - - - - - - - - - - - - - - - - Converts the result of another layout output to be XML-compliant. - - - - - Initializes a new instance of the class. - - - - - Gets or sets a value indicating whether to apply XML encoding. - - - - - - Post-processes the rendered message. - - The text to be post-processed. - Padded and trimmed string. - - - - A layout containing one or more nested layouts. - - - - - Initializes a new instance of the class. - - - - - Gets the inner layouts. - - - - - - Initializes the layout. - - - - - Formats the log event relying on inner layouts. - - The log event to be formatted. - A string representation of the log event. - - - - Formats the log event relying on inner layouts. - - The logging event. - for the result - - - - Closes the layout. - - - - - Generate description of Compound Layout - - Compound Layout String Description - - - - A column in the CSV. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name of the column. - The layout of the column. - - - - Gets or sets the name of the column. - - - - - - Gets or sets the layout of the column. - - - - - - Specifies allowed column delimiters. - - - - - Automatically detect from regional settings. - - - - - Comma (ASCII 44). - - - - - Semicolon (ASCII 59). - - - - - Tab character (ASCII 9). - - - - - Pipe character (ASCII 124). - - - - - Space character (ASCII 32). - - - - - Custom string, specified by the CustomDelimiter. - - - - - A specialized layout that renders CSV-formatted events. - - If is set, then the header generation with columnnames will be disabled. - - - - Initializes a new instance of the class. - - - - - Gets the array of parameters to be passed. - - - - - - Gets or sets a value indicating whether CVS should include header. - - A value of true if CVS should include header; otherwise, false. - - - - - Gets or sets the column delimiter. - - - - - - Gets or sets the quoting mode. - - - - - - Gets or sets the quote Character. - - - - - - Gets or sets the custom column delimiter value (valid when ColumnDelimiter is set to 'Custom'). - - - - - - Initializes the layout. - - - - - Formats the log event for write. - - The log event to be formatted. - A string representation of the log event. - - - - Formats the log event for write. - - The logging event. - for the result - - - - Get the headers with the column names. - - - - - - Render 1 columnvalue (text or header) to - - write-to - current col index - col text - - - - Header with column names for CSV layout. - - - - - Initializes a new instance of the class. - - The parent. - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - for the result - - - - Generate description of CSV Layout - - CSV Layout String Description - - - - Specifies CSV quoting modes. - - - - - Quote all column. - - - - - Quote nothing. - - - - - Quote only whose values contain the quote symbol or - the separator. - - - - - JSON attribute. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name of the attribute. - The layout of the attribute's value. - - - - Initializes a new instance of the class. - - The name of the attribute. - The layout of the attribute's value. - Encode value with json-encode - - - - Gets or sets the name of the attribute. - - - - - - Gets or sets the layout that will be rendered as the attribute's value. - - - - - - Determines wether or not this attribute will be Json encoded. - - - - - - Gets or sets a value indicating whether to escape non-ascii characters - - - - - - Gets or sets whether an attribute with empty value should be included in the output - - - - - - A specialized layout that renders JSON-formatted events. - - - - - Initializes a new instance of the class. - - - - - Gets the array of attributes' configurations. - - - - - - Gets or sets the option to suppress the extra spaces in the output json - - - - - - Gets or sets the option to render the empty object value {} - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets the option to include all properties from the log event (as JSON) - - - - - - List of property names to exclude when is true - - - - - - How far should the JSON serializer follow object references before backing off - - - - - Initializes the layout. - - - - - Closes the layout. - - - - - Formats the log event as a JSON document for writing. - - The logging event. - for the result - - - - Formats the log event as a JSON document for writing. - - The log event to be formatted. - A JSON string representation of the log event. - - - - Generate description of JSON Layout - - JSON Layout String Description - - - - Abstract interface that layouts must implement. - - - - - Is this layout initialized? See - - - - - Gets a value indicating whether this layout is thread-agnostic (can be rendered on any thread). - - - Layout is thread-agnostic if it has been marked with [ThreadAgnostic] attribute and all its children are - like that as well. - - Thread-agnostic layouts only use contents of for its output. - - - - - Gets the level of stack trace information required for rendering. - - - - - Gets the logging configuration this target is part of. - - - - - Converts a given text to a . - - Text to be converted. - object represented by the text. - - - - Implicitly converts the specified string to a . - - The layout string. - Instance of . - - - - Implicitly converts the specified string to a . - - The layout string. - The NLog factories to use when resolving layout renderers. - Instance of . - - - - Precalculates the layout for the specified log event and stores the result - in per-log event cache. - - Only if the layout doesn't have [ThreadAgnostic] and doens't contain layouts with [ThreadAgnostic]. - - The log event. - - Calling this method enables you to store the log event in a buffer - and/or potentially evaluate it in another thread even though the - layout may contain thread-dependent renderer. - - - - - Renders the event info in layout. - - The event info. - String representing log event. - - - - Optimized version of for internal Layouts. Works best - when override of is available. - - The event info. - Appends the string representing log event to target - Should rendering result be cached on LogEventInfo - - - - Valid default implementation of , when having implemented the optimized - - The logging event. - StringBuilder to help minimize allocations [optional]. - The rendered layout. - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - for the result - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Initializes the layout. - - - - - Closes the layout. - - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Register a custom Layout. - - Short-cut for registing to default - Type of the Layout. - Name of the Layout. - - - - Register a custom Layout. - - Short-cut for registing to default - Type of the Layout. - Name of the Layout. - - - - Optimized version of for internal Layouts, when - override of is available. - - - - - Marks class as a layout renderer and assigns a format string to it. - - - - - Initializes a new instance of the class. - - Layout name. - - - - Parses layout strings. - - - - - Add to - - - - - - - A specialized layout that supports header and footer. - - - - - Gets or sets the body layout (can be repeated multiple times). - - - - - - Gets or sets the header layout. - - - - - - Gets or sets the footer layout. - - - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - for the result. - - - - A specialized layout that renders Log4j-compatible XML events. - - - This layout is not meant to be used explicitly. Instead you can use ${log4jxmlevent} layout renderer. - - - - - Initializes a new instance of the class. - - - - - Gets the instance that renders log events. - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets the option to include all properties from the log events - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Gets or sets a value indicating whether to include contents of the dictionary. - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - The rendered layout. - - - - Renders the layout for the specified logging event by invoking layout renderers. - - The logging event. - for the result - - - - Represents a string with embedded placeholders that can render contextual information. - - - This layout is not meant to be used explicitly. Instead you can just use a string containing layout - renderers everywhere the layout is required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The layout string to parse. - - - - Initializes a new instance of the class. - - The layout string to parse. - The NLog factories to use when creating references to layout renderers. - - - - Original text before compile to Layout renderes - - - - - Gets or sets the layout text. - - - - - - Is the message fixed? (no Layout renderers used) - - - - - Get the fixed text. Only set when is true - - - - - Gets a collection of objects that make up this layout. - - - - - Gets the level of stack trace information required for rendering. - - - - - Converts a text to a simple layout. - - Text to be converted. - A object. - - - - Escapes the passed text so that it can - be used literally in all places where - layout is normally expected without being - treated as layout. - - The text to be escaped. - The escaped text. - - Escaping is done by replacing all occurrences of - '${' with '${literal:text=${}' - - - - - Evaluates the specified text by expanding all layout renderers. - - The text to be evaluated. - Log event to be used for evaluation. - The input text with all occurrences of ${} replaced with - values provided by the appropriate layout renderers. - - - - Evaluates the specified text by expanding all layout renderers - in new context. - - The text to be evaluated. - The input text with all occurrences of ${} replaced with - values provided by the appropriate layout renderers. - - - - Returns a that represents the current object. - - - A that represents the current object. - - - - - Initializes the layout. - - - - - Renders the layout for the specified logging event by invoking layout renderers - that make up the event. - - The logging event. - The rendered layout. - - - - Renders the layout for the specified logging event by invoking layout renderers - that make up the event. - - The logging event. - for the result - - - - Represents the logging event. - - - - - Gets the date of the first log event created. - - - - - The formatted log message. - - - - - The log message including any parameter placeholders - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Log level. - Logger name. - Log message including parameter placeholders. - - - - Initializes a new instance of the class. - - Log level. - Logger name. - Log message including parameter placeholders. - Log message including parameter placeholders. - - - - Initializes a new instance of the class. - - Log level. - Logger name. - An IFormatProvider that supplies culture-specific formatting information. - Log message including parameter placeholders. - Parameter array. - - - - Initializes a new instance of the class. - - Log level. - Logger name. - An IFormatProvider that supplies culture-specific formatting information. - Log message including parameter placeholders. - Parameter array. - Exception information. - - - - Gets the unique identifier of log event which is automatically generated - and monotonously increasing. - - - - - Gets or sets the timestamp of the logging event. - - - - - Gets or sets the level of the logging event. - - - - - Gets a value indicating whether stack trace has been set for this event. - - - - - Gets the stack frame of the method that did the logging. - - - - - Gets the number index of the stack frame that represents the user - code (not the NLog code). - - - - - Gets the entire stack trace. - - - - - Gets the callsite class name - - - - - Gets the callsite member function name - - - - - Gets the callsite source file path - - - - - Gets the callsite source file line number - - - - - Gets or sets the exception information. - - - - - Gets or sets the logger name. - - - - - Gets the logger short name. - - This property was marked as obsolete on NLog 2.0 and it may be removed in a future release. - - - - Gets or sets the log message including any parameter placeholders. - - - - - Gets or sets the parameter values or null if no parameters have been specified. - - - - - Gets or sets the format provider that was provided while logging or - when no formatProvider was specified. - - - - - Gets or sets the message formatter for generating - Uses string.Format(...) when nothing else has been configured. - - - - - Gets the formatted message. - - - - - Checks if any per-event properties (Without allocation) - - - - - Gets the dictionary of per-event context properties. - - - - - Gets the dictionary of per-event context properties. - Internal helper for the PropertiesDictionary type. - - Create the event-properties dictionary, even if no initial template parameters - Provided when having parsed the message template and capture template parameters (else null) - - - - - Gets the named parameters extracted from parsing as MessageTemplate - - - - - Gets the dictionary of per-event context properties. - - This property was marked as obsolete on NLog 2.0 and it may be removed in a future release. - - - - Creates the null event. - - Null log event. - - - - Creates the log event. - - The log level. - Name of the logger. - The message. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The format provider. - The message. - The parameters. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The format provider. - The message. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The message. - The exception. - Instance of . - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Creates the log event. - - The log level. - Name of the logger. - The exception. - The format provider. - The message. - Instance of . - - - - Creates the log event. - - The log level. - Name of the logger. - The exception. - The format provider. - The message. - The parameters. - Instance of . - - - - Creates from this by attaching the specified asynchronous continuation. - - The asynchronous continuation. - Instance of with attached continuation. - - - - Returns a string representation of this log event. - - String representation of the log event. - - - - Sets the stack trace for the event info. - - The stack trace. - Index of the first user stack frame within the stack trace. - - - - Sets the details retrieved from the Caller Information Attributes - - - - - - - - - Set the - - true = Always, false = Never, null = Auto Detect - - - - Specialized LogFactory that can return instances of custom logger types. - - The type of the logger to be returned. Must inherit from . - - - - Gets the logger with type . - - The logger name. - An instance of . - - - - Gets a custom logger with the name of the current class and type . - - An instance of . - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Creates and manages instances of objects. - - - - - Internal for unit tests - - - - - Overwrite possible file paths (including filename) for possible NLog config files. - When this property is null, the default file paths ( are used. - - - - - Occurs when logging changes. - - - - - Occurs when logging gets reloaded. - - - - - Initializes static members of the LogManager class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The config. - - - - Gets the current . - - - - - Gets or sets a value indicating whether exceptions should be thrown. See also . - - A value of true if exception should be thrown; otherwise, false. - By default exceptions are not thrown under any circumstances. - - - - Gets or sets a value indicating whether should be thrown. - - If null then is used. - - A value of true if exception should be thrown; otherwise, false. - - This option is for backwards-compatiblity. - By default exceptions are not thrown under any circumstances. - - - - - Gets or sets a value indicating whether Variables should be kept on configuration reload. - Default value - false. - - - - - Gets or sets the current logging configuration. After setting this property all - existing loggers will be re-configured, so there is no need to call - manually. - - - - - Gets or sets the global log level threshold. Log events below this threshold are not logged. - - - - - Gets the default culture info to use as . - - - Specific culture info or null to use - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting - unmanaged resources. - - - - - Creates a logger that discards all log messages. - - Null logger instance. - - - - Gets the logger with the name of the current class. - - The logger. - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Gets the logger with the name of the current class. - - The logger with type . - Type of the logger - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Gets a custom logger with the name of the current class. Use to pass the type of the needed Logger. - - The type of the logger to create. The type must inherit from - The logger of type . - This is a slow-running method. Make sure you are not calling this method in a - loop. - - - - Gets the specified named logger. - - Name of the logger. - The logger reference. Multiple calls to GetLogger with the same argument - are not guaranteed to return the same logger reference. - - - - Gets the specified named logger. - - Name of the logger. - Type of the logger - The logger reference with type . Multiple calls to GetLogger with the same argument - are not guaranteed to return the same logger reference. - - - - Gets the specified named logger. Use to pass the type of the needed Logger. - - Name of the logger. - The type of the logger to create. The type must inherit from . - The logger of type . Multiple calls to GetLogger with the - same argument aren't guaranteed to return the same logger reference. - - - - Loops through all loggers previously returned by GetLogger and recalculates their - target and filter list. Useful after modifying the configuration programmatically - to ensure that all loggers have been properly configured. - - - - - Flush any pending log messages (in case of asynchronous targets) with the default timeout of 15 seconds. - - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages after that time - will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages - after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages - after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Decreases the log enable counter and if it reaches -1 the logs are disabled. - - - Logging is enabled if the number of calls is greater than - or equal to calls. - - This method was marked as obsolete on NLog 4.0 and it may be removed in a future release. - - An object that implements IDisposable whose Dispose() method re-enables logging. - To be used with C# using () statement. - - - - Increases the log enable counter and if it reaches 0 the logs are disabled. - - - Logging is enabled if the number of calls is greater than - or equal to calls. - - This method was marked as obsolete on NLog 4.0 and it may be removed in a future release. - - - - - Decreases the log enable counter and if it reaches -1 the logs are disabled. - - - Logging is enabled if the number of calls is greater than - or equal to calls. - - An object that implements IDisposable whose Dispose() method re-enables logging. - To be used with C# using () statement. - - - - Increases the log enable counter and if it reaches 0 the logs are disabled. - - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Returns if logging is currently enabled. - - A value of if logging is currently enabled, - otherwise. - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Raises the event when the configuration is reloaded. - - Event arguments. - - - - Raises the event when the configuration is reloaded. - - Event arguments - - - - Currently this logfactory is disposing? - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; - false to release only unmanaged resources. - - - - Get file paths (including filename) for the possible NLog config files. - - The filepaths to the possible config file - - - - Overwrite the paths (including filename) for the possible NLog config files. - - The filepaths to the possible config file - - - - Clear the candidate file paths and return to the defaults. - - - - - Get default file paths (including filename) for possible NLog config files. - - - - - Loads logging configuration from file (Currently only XML configuration files supported) - - Configuration file to be read - LogFactory instance for fluent interface - - - - Logger cache key. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Determines if two objects are equal in value. - - Other object to compare to. - True if objects are equal, false otherwise. - - - - Determines if two objects of the same type are equal in value. - - Other object to compare to. - True if objects are equal, false otherwise. - - - - Logger cache. - - - - - Inserts or updates. - - - - - - - Enables logging in implementation. - - - - - Initializes a new instance of the class. - - The factory. - - - - Enables logging. - - - - - Logging methods which only are executed when the DEBUG conditional compilation symbol is set. - - - The DEBUG conditional compilation symbol is default enabled (only) in a debug build. - - If the DEBUG conditional compilation symbol isn't set in the calling library, the compiler will remove all the invocations to these methods. - This could lead to better performance. - - See: https://msdn.microsoft.com/en-us/library/4xssyw96%28v=vs.90%29.aspx - - - Provides logging interface and utility functions. - - - Auto-generated Logger members for binary compatibility with NLog 1.0. - - - Provides logging interface and utility functions. - - - - - Writes the diagnostic message at the Debug level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - Log message. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - - - - Writes the diagnostic message at the Debug level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - Log message. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - A to be written. - - - - Writes the diagnostic message at the Trace level. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - Only executed when the DEBUG conditional compilation symbol is set. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - Only executed when the DEBUG conditional compilation symbol is set. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - Only executed when the DEBUG conditional compilation symbol is set. - A containing one format item. - The argument to format. - - - - Gets a value indicating whether logging is enabled for the Trace level. - - A value of if logging is enabled for the Trace level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Debug level. - - A value of if logging is enabled for the Debug level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Info level. - - A value of if logging is enabled for the Info level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Warn level. - - A value of if logging is enabled for the Warn level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Error level. - - A value of if logging is enabled for the Error level, otherwise it returns . - - - - Gets a value indicating whether logging is enabled for the Fatal level. - - A value of if logging is enabled for the Fatal level, otherwise it returns . - - - - Writes the diagnostic message at the Trace level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Trace level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Trace level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Trace level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Trace level. - - Log message. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Trace level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Debug level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Debug level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Debug level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Debug level. - - Log message. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Debug level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Info level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Info level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Info level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Info level. - - Log message. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Info level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Info level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Info level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Warn level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Warn level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Warn level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Warn level. - - Log message. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Warn level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Warn level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Error level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Error level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Error level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Error level. - - Log message. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Error level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Error level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Error level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified format provider and format parameters. - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - Type of the value. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the Fatal level. - - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the Fatal level using the specified parameters and formatting them with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level. - - Log message. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - - - - Writes the diagnostic message and exception at the Fatal level. - - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message and exception at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - An exception to be logged. - Arguments to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameter. - - The type of the argument. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - A to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter and formatting it with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified value as a parameter. - - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level. - - A to be written. - - - - Writes the diagnostic message at the Trace level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Trace level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Trace level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level. - - A to be written. - - - - Writes the diagnostic message at the Debug level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Debug level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Debug level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level. - - A to be written. - - - - Writes the diagnostic message at the Info level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Info level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Info level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level. - - A to be written. - - - - Writes the diagnostic message at the Warn level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Warn level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Warn level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level. - - A to be written. - - - - Writes the diagnostic message at the Error level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Error level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Error level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level. - - A to be written. - - - - Writes the diagnostic message at the Fatal level. - - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified parameters. - - A containing format items. - First argument to format. - Second argument to format. - Third argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter and formatting it with the supplied format provider. - - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the Fatal level using the specified value as a parameter. - - A containing one format item. - The argument to format. - - - - Initializes a new instance of the class. - - - - - Occurs when logger configuration changes. - - - - - Gets the name of the logger. - - - - - Gets the factory that created this logger. - - - - - Gets a value indicating whether logging is enabled for the specified level. - - Log level to be checked. - A value of if logging is enabled for the specified level, otherwise it returns . - - - - Writes the specified diagnostic message. - - Log event. - - - - Writes the specified diagnostic message. - - The name of the type that wraps Logger. - Log event. - - - - Writes the diagnostic message at the specified level using the specified format provider and format parameters. - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - Type of the value. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - The value to be written. - - - - Writes the diagnostic message at the specified level. - - The log level. - A function returning message to be written. Function is not evaluated if logging is not enabled. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message at the specified level using the specified parameters and formatting them with the supplied format provider. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message at the specified level. - - The log level. - Log message. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The log level. - A containing format items. - Arguments to format. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - An exception to be logged. - This method was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message and exception at the specified level. - - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A to be written. - Arguments to format. - An exception to be logged. - - - - Writes the diagnostic message at the specified level using the specified parameter and formatting it with the supplied format provider. - - The type of the argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameter. - - The type of the argument. - The log level. - A containing one format item. - The argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - - - - Writes the diagnostic message at the specified level using the specified arguments formatting it with the supplied format provider. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - An IFormatProvider that supplies culture-specific formatting information. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Writes the diagnostic message at the specified level using the specified parameters. - - The type of the first argument. - The type of the second argument. - The type of the third argument. - The log level. - A containing one format item. - The first argument to format. - The second argument to format. - The third argument to format. - - - - Runs the provided action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. - - Action to execute. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a default value is returned instead. - - Return type of the provided function. - Function to run. - Result returned by the provided function or the default value of type in case of exception. - - - - Runs the provided function and returns its result. If an exception is thrown, it is logged at Error level. - The exception is not propagated outside of this method; a fallback value is returned instead. - - Return type of the provided function. - Function to run. - Fallback value to return in case of exception. - Result returned by the provided function or fallback value in case of exception. - - - - Logs an exception is logged at Error level if the provided task does not run to completion. - - The task for which to log an error if it does not run to completion. - This method is useful in fire-and-forget situations, where application logic does not depend on completion of task. This method is avoids C# warning CS4014 in such situations. - - - - Returns a task that completes when a specified task to completes. If the task does not run to completion, an exception is logged at Error level. The returned task always runs to completion. - - The task for which to log an error if it does not run to completion. - A task that completes in the state when completes. - - - - Runs async action. If the action throws, the exception is logged at Error level. The exception is not propagated outside of this method. - - Async action to execute. - - - - Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. - The exception is not propagated outside of this method; a default value is returned instead. - - Return type of the provided function. - Async function to run. - A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the default value of type . - - - - Runs the provided async function and returns its result. If the task does not run to completion, an exception is logged at Error level. - The exception is not propagated outside of this method; a fallback value is returned instead. - - Return type of the provided function. - Async function to run. - Fallback value to return if the task does not end in the state. - A task that represents the completion of the supplied task. If the supplied task ends in the state, the result of the new task will be the result of the supplied task; otherwise, the result of the new task will be the fallback value. - - - - Raises the event when the logger is reconfigured. - - Event arguments - - - - Implementation of logging engine. - - - - - Finds first user stack frame in a stack trace - - The stack trace of the logging method invocation - Type of the logger or logger wrapper. This is still Logger if it's a subclass of Logger. - Index of the first user stack frame or 0 if all stack frames are non-user - - - - This is only done for legacy reason, as the correct method-name and line-number should be extracted from the MoveNext-StackFrame - - The stack trace of the logging method invocation - Starting point for skipping async MoveNext-frames - - - - Assembly to skip? - - Find assembly via this frame. - true, we should skip. - - - - Is this the type of the logger? - - get type of this logger in this frame. - Type of the logger. - - - - - Gets the filter result. - - The filter chain. - The log event. - The result of the filter. - - - - Defines available log levels. - - - - - Trace log level. - - - - - Debug log level. - - - - - Info log level. - - - - - Warn log level. - - - - - Error log level. - - - - - Fatal log level. - - - - - Off log level. - - - - - Gets all the available log levels (Trace, Debug, Info, Warn, Error, Fatal, Off). - - - - - Gets all the log levels that can be used to log events (Trace, Debug, Info, Warn, Error, Fatal) - i.e LogLevel.Off is excluded. - - - - - Initializes a new instance of . - - The log level name. - The log level ordinal number. - - - - Gets the name of the log level. - - - - - Gets the ordinal of the log level. - - - - - Compares two objects - and returns a value indicating whether - the first one is equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal == level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is not equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal != level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is greater than the second one. - - The first level. - The second level. - The value of level1.Ordinal > level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is greater than or equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal >= level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is less than the second one. - - The first level. - The second level. - The value of level1.Ordinal < level2.Ordinal. - - - - Compares two objects - and returns a value indicating whether - the first one is less than or equal to the second one. - - The first level. - The second level. - The value of level1.Ordinal <= level2.Ordinal. - - - - Gets the that corresponds to the specified ordinal. - - The ordinal. - The instance. For 0 it returns , 1 gives and so on. - - - - Returns the that corresponds to the supplied . - - The textual representation of the log level. - The enumeration value. - - - - Returns a string representation of the log level. - - Log level name. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - Value of true if the specified is equal to - this instance; otherwise, false. - - - - Determines whether the specified instance is equal to this instance. - - The to compare with this instance. - Value of true if the specified is equal to - this instance; otherwise, false. - - - - Compares the level to the other object. - - - The object object. - - - A value less than zero when this logger's is - less than the other logger's ordinal, 0 when they are equal and - greater than zero when this ordinal is greater than the - other ordinal. - - - - - Creates and manages instances of objects. - - - - - Internal for unit tests - - - - - Delegate used to set/get the culture in use. - - This delegate marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Gets the instance used in the . - - Could be used to pass the to other methods - - - - Occurs when logging changes. - - - - - Occurs when logging gets reloaded. - - - - - Gets or sets a value indicating whether NLog should throw exceptions. - By default exceptions are not thrown under any circumstances. - - - - - Gets or sets a value indicating whether should be thrown. - - A value of true if exception should be thrown; otherwise, false. - - This option is for backwards-compatiblity. - By default exceptions are not thrown under any circumstances. - - - - - - Gets or sets a value indicating whether Variables should be kept on configuration reload. - Default value - false. - - - - - Gets or sets the current logging configuration. - - - - - - Loads logging configuration from file (Currently only XML configuration files supported) - - Configuration file to be read - LogFactory instance for fluent interface - - - - Gets or sets the global log threshold. Log events below this threshold are not logged. - - - - - Gets or sets the default culture to use. - - This property was marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Gets the logger with the name of the current class. - - The logger. - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Adds the given assembly which will be skipped - when NLog is trying to find the calling method on stack trace. - - The assembly to skip. - - - - Gets a custom logger with the name of the current class. Use to pass the type of the needed Logger. - - The logger class. The class must inherit from . - The logger of type . - This is a slow-running method. - Make sure you're not doing this in a loop. - - - - Creates a logger that discards all log messages. - - Null logger which discards all log messages. - - - - Gets the specified named logger. - - Name of the logger. - The logger reference. Multiple calls to GetLogger with the same argument aren't guaranteed to return the same logger reference. - - - - Gets the specified named custom logger. Use to pass the type of the needed Logger. - - Name of the logger. - The logger class. The class must inherit from . - The logger of type . Multiple calls to GetLogger with the same argument aren't guaranteed to return the same logger reference. - The generic way for this method is - - - - Loops through all loggers previously returned by GetLogger. - and recalculates their target and filter list. Useful after modifying the configuration programmatically - to ensure that all loggers have been properly configured. - - - - - Flush any pending log messages (in case of asynchronous targets) with the default timeout of 15 seconds. - - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - Maximum time to allow for the flush. Any messages after that time will be discarded. - - - - Decreases the log enable counter and if it reaches -1 the logs are disabled. - - Logging is enabled if the number of calls is greater - than or equal to calls. - An object that implements IDisposable whose Dispose() method reenables logging. - To be used with C# using () statement. - - - - Increases the log enable counter and if it reaches 0 the logs are disabled. - - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Checks if logging is currently enabled. - - if logging is currently enabled, - otherwise. - Logging is enabled if the number of calls is greater - than or equal to calls. - - - - Dispose all targets, and shutdown logging. - - - - - Generates a formatted message from the log event - - Log event. - Formatted message - - - - Returns a log message. Used to defer calculation of - the log message until it's actually needed. - - Log message. - - - - Base implementation of a log receiver server which forwards received logs through or a given . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log factory. - - - - Processes the log messages. - - The events to process. - - - - Processes the log messages. - - The log events. - - - - Service contract for Log Receiver client. - - This class marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Begins processing of log messages. - - The events. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Service contract for Log Receiver client. - - - - - Begins processing of log messages. - - The events. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Service contract for Log Receiver server. - - - - - Processes the log messages. - - The events. - - - - Service contract for Log Receiver server. - - - - - Processes the log messages. - - The events. - - - - Service contract for Log Receiver client. - - - - - Begins processing of log messages. - - The events. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Client of - - - - - Occurs when the log message processing has completed. - - - - - Occurs when Open operation has completed. - - - - - Occurs when Close operation has completed. - - - - - Enables the user to configure client and service credentials as well as service credential authentication settings for use on the client side of communication. - - - - - Gets the underlying implementation. - - - - - Gets the target endpoint for the service to which the WCF client can connect. - - - - - Opens the client asynchronously. - - - - - Opens the client asynchronously. - - User-specific state. - - - - Closes the client asynchronously. - - - - - Closes the client asynchronously. - - User-specific state. - - - - Processes the log messages asynchronously. - - The events to send. - - - - Processes the log messages asynchronously. - - The events to send. - User-specific state. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. - - - - - Gets or sets the cookie container. - - The cookie container. - - - - Implementation of which forwards received logs through or a given . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log factory. - - - - Implementation of which forwards received logs through or a given . - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The log factory. - - - - Internal configuration of Log Receiver Service contracts. - - - - - Wire format for NLog Event. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the client-generated identifier of the event. - - - - - Gets or sets the ordinal of the log level. - - - - - Gets or sets the logger ordinal (index into . - - The logger ordinal. - - - - Gets or sets the time delta (in ticks) between the time of the event and base time. - - - - - Gets or sets the message string index. - - - - - Gets or sets the collection of layout values. - - - - - Gets the collection of indexes into array for each layout value. - - - - - Converts the to . - - The object this is part of.. - The logger name prefix to prepend in front of the logger name. - Converted . - - - - Wire format for NLog event package. - - - - - Gets or sets the name of the client. - - The name of the client. - - - - Gets or sets the base time (UTC ticks) for all events in the package. - - The base time UTC. - - - - Gets or sets the collection of layout names which are shared among all events. - - The layout names. - - - - Gets or sets the collection of logger names. - - The logger names. - - - - Gets or sets the list of events. - - The events. - - - - Converts the events to sequence of objects suitable for routing through NLog. - - The logger name prefix to prepend in front of each logger name. - - Sequence of objects. - - - - - Converts the events to sequence of objects suitable for routing through NLog. - - - Sequence of objects. - - - - - List of strings annotated for more terse serialization. - - - - - Initializes a new instance of the class. - - - - - Log Receiver Client using WCF. - - - This class marked as obsolete before NLog 4.3.11 and it will be removed in a future release. - - It provides an implementation of the legacy interface and it will be completely obsolete when the - ILogReceiverClient is removed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Log Receiver Client facade. It allows the use either of the one way or two way - service contract using WCF through its unified interface. - - - Delegating methods are generated with Resharper. - 1. change ProxiedClient to private field (instead of public property) - 2. delegate members - 3. change ProxiedClient back to public property. - - - - - - The client getting proxied - - - - - Do we use one-way or two-way messaging? - - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Whether to use the one way or two way WCF client. - The binding. - The remote address. - - - - Causes a communication object to transition immediately from its current state into the closed state. - - - - - Begins an asynchronous operation to close a communication object. - - - The that references the asynchronous close operation. - - The delegate that receives notification of the completion of the asynchronous close operation.An object, specified by the application, that contains state information associated with the asynchronous close operation. was called on an object in the state.The default timeout elapsed before the was able to close gracefully. - - - - Begins an asynchronous operation to close a communication object with a specified timeout. - - - The that references the asynchronous close operation. - - The that specifies how long the send operation has to complete before timing out.The delegate that receives notification of the completion of the asynchronous close operation.An object, specified by the application, that contains state information associated with the asynchronous close operation. was called on an object in the state.The specified timeout elapsed before the was able to close gracefully. - - - - Begins an asynchronous operation to open a communication object. - - - The that references the asynchronous open operation. - - The delegate that receives notification of the completion of the asynchronous open operation.An object, specified by the application, that contains state information associated with the asynchronous open operation.The was unable to be opened and has entered the state.The default open timeout elapsed before the was able to enter the state and has entered the state. - - - - Begins an asynchronous operation to open a communication object within a specified interval of time. - - - The that references the asynchronous open operation. - - The that specifies how long the send operation has to complete before timing out.The delegate that receives notification of the completion of the asynchronous open operation.An object, specified by the application, that contains state information associated with the asynchronous open operation.The was unable to be opened and has entered the state.The specified timeout elapsed before the was able to enter the state and has entered the state. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Enables the user to configure client and service credentials as well as service credential authentication settings for use on the client side of communication. - - - - - Causes a communication object to transition from its current state into the closed state. - - The that specifies how long the send operation has to complete before timing out. was called on an object in the state.The timeout elapsed before the was able to close gracefully. - - - - Causes a communication object to transition from its current state into the closed state. - - was called on an object in the state.The default close timeout elapsed before the was able to close gracefully. - - - - Closes the client asynchronously. - - User-specific state. - - - - Closes the client asynchronously. - - - - - Occurs when Close operation has completed. - - - - - Occurs when the communication object completes its transition from the closing state into the closed state. - - - - - Occurs when the communication object first enters the closing state. - - - - - Instructs the inner channel to display a user interface if one is required to initialize the channel prior to using it. - - - - - Gets or sets the cookie container. - - The cookie container. - - - - Completes an asynchronous operation to close a communication object. - - The that is returned by a call to the method. was called on an object in the state.The timeout elapsed before the was able to close gracefully. - - - - Completes an asynchronous operation to open a communication object. - - The that is returned by a call to the method.The was unable to be opened and has entered the state.The timeout elapsed before the was able to enter the state and has entered the state. - - - - Gets the target endpoint for the service to which the WCF client can connect. - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Occurs when the communication object first enters the faulted state. - - - - - Gets the underlying implementation. - - - - - Causes a communication object to transition from the created state into the opened state. - - The was unable to be opened and has entered the state.The default open timeout elapsed before the was able to enter the state and has entered the state. - - - - Causes a communication object to transition from the created state into the opened state within a specified interval of time. - - The that specifies how long the send operation has to complete before timing out.The was unable to be opened and has entered the state.The specified timeout elapsed before the was able to enter the state and has entered the state. - - - - Opens the client asynchronously. - - - - - Opens the client asynchronously. - - User-specific state. - - - - Occurs when Open operation has completed. - - - - - Occurs when the communication object completes its transition from the opening state into the opened state. - - - - - Occurs when the communication object first enters the opening state. - - - - - Processes the log messages asynchronously. - - The events to send. - - - - Processes the log messages asynchronously. - - The events to send. - User-specific state. - - - - Occurs when the log message processing has completed. - - - - - Gets the current state of the communication-oriented object. - - - The value of the of the object. - - - - - Causes a communication object to transition from its current state into the closed state. - - - - - Abstract base class for the WcfLogReceiverXXXWay classes. It can only be - used internally (see internal constructor). It passes off any Channel usage - to the inheriting class. - - Type of the WCF service. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Occurs when the log message processing has completed. - - - - - Occurs when Open operation has completed. - - - - - Occurs when Close operation has completed. - - - - - Gets or sets the cookie container. - - The cookie container. - - - - Opens the client asynchronously. - - - - - Opens the client asynchronously. - - User-specific state. - - - - Closes the client asynchronously. - - - - - Closes the client asynchronously. - - User-specific state. - - - - Processes the log messages asynchronously. - - The events to send. - - - - Processes the log messages asynchronously. - - The events to send. - User-specific state. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Log Receiver Client using WCF. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Log Receiver Client using WCF. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - Name of the endpoint configuration. - The remote address. - - - - Initializes a new instance of the class. - - The binding. - The remote address. - - - - Begins processing of log messages. - - The events to send. - The callback. - Asynchronous state. - - IAsyncResult value which can be passed to . - - - - - Ends asynchronous processing of log messages. - - The result. - - - - Mapped Diagnostics Context - a thread-local structure that keeps a dictionary - of strings and provides methods to output them in layouts. - Mostly for compatibility with log4net. - - - - - - - - - - Gets the thread-local dictionary - - Must be true for any subsequent dictionary modification operation - - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - An that can be used to remove the item from the current thread MDC. - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - >An that can be used to remove the item from the current thread MDC. - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - - - - Gets the current thread MDC named item, as . - - Item name. - The value of , if defined; otherwise . - If the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the current thread MDC named item, as . - - Item name. - The to use when converting a value to a . - The value of , if defined; otherwise . - If is null and the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the current thread MDC named item, as . - - Item name. - The value of , if defined; otherwise null. - - - - Returns all item names - - A set of the names of all items in current thread-MDC. - - - - Checks whether the specified item exists in current thread MDC. - - Item name. - A boolean indicating whether the specified exists in current thread MDC. - - - - Removes the specified from current thread MDC. - - Item name. - - - - Clears the content of current thread MDC. - - - - - Async version of Mapped Diagnostics Context - a logical context structure that keeps a dictionary - of strings and provides methods to output them in layouts. Allows for maintaining state across - asynchronous tasks and call contexts. - - - Ideally, these changes should be incorporated as a new version of the MappedDiagnosticsContext class in the original - NLog library so that state can be maintained for multiple threads in asynchronous situations. - - - - - - - - - - Simulate ImmutableDictionary behavior (which is not yet part of all .NET frameworks). - In future the real ImmutableDictionary could be used here to minimize memory usage and copying time. - - Must be true for any subsequent dictionary modification operation - - - - - Gets the current logical context named item, as . - - Item name. - The value of , if defined; otherwise . - If the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the current logical context named item, as . - - Item name. - The to use when converting a value to a string. - The value of , if defined; otherwise . - If is null and the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the current logical context named item, as . - - Item name. - The value of , if defined; otherwise null. - - - - Sets the current logical context item to the specified value. - - Item name. - Item value. - >An that can be used to remove the item from the current logical context. - - - - Sets the current logical context item to the specified value. - - Item name. - Item value. - >An that can be used to remove the item from the current logical context. - - - - Sets the current logical context item to the specified value. - - Item name. - Item value. - - - - Sets the current logical context item to the specified value. - - Item name. - Item value. - - - - Returns all item names - - A collection of the names of all items in current logical context. - - - - Checks whether the specified exists in current logical context. - - Item name. - A boolean indicating whether the specified exists in current logical context. - - - - Removes the specified from current logical context. - - Item name. - - - - Clears the content of current logical context. - - - - - Clears the content of current logical context. - - Free the full slot. - - - - Mapped Diagnostics Context - used for log4net compatibility. - - This class marked as obsolete before NLog 2.0 and it may be removed in a future release. - - - - Sets the current thread MDC item to the specified value. - - Item name. - Item value. - - - - Gets the current thread MDC named item. - - Item name. - The value of , if defined; otherwise . - If the value isn't a already, this call locks the for reading the needed for converting to . - - - - Gets the current thread MDC named item. - - Item name. - The value of , if defined; otherwise null. - - - - Checks whether the specified item exists in current thread MDC. - - Item name. - A boolean indicating whether the specified item exists in current thread MDC. - - - - Removes the specified item from current thread MDC. - - Item name. - - - - Clears the content of current thread MDC. - - - - - Mark a parameter of a method for message templating - - - - - Specifies which parameter of an annotated method should be treated as message-template-string - - - - - The name of the parameter that should be as treated as message-template-string - - - - - The type of the captured hole - - - - - Not decided - - - - - normal {x} - - - - - Serialize operator {@x} (aka destructure) - - - - - stringification operator {$x} - - - - - A hole that will be replaced with a value - - - - - Constructor - - - - Parameter name sent to structured loggers. - This is everything between "{" and the first of ",:}". - Including surrounding spaces and names that are numbers. - - - Format to render the parameter. - This is everything between ":" and the first unescaped "}" - - - - Type - - - - When the template is positional, this is the parsed name of this parameter. - For named templates, the value of Index is undefined. - - - Alignment to render the parameter, by default 0. - This is the parsed value between "," and the first of ":}" - - - - A fixed value - - - - Number of characters from the original template to copy at the current position. - This can be 0 when the template starts with a hole or when there are multiple consecutive holes. - - - Number of characters to skip in the original template at the current position. - 0 is a special value that mean: 1 escaped char, no hole. It can also happen last when the template ends with a literal. - - - - Combines Literal and Hole - - - - Literal - - - Hole - Uninitialized when = 0. - - - - Description of a single parameter extracted from a MessageTemplate - - - - - Parameter Name extracted from - This is everything between "{" and the first of ",:}". - - - - - Parameter Value extracted from the -array - - - - - Format to render the parameter. - This is everything between ":" and the first unescaped "}" - - - - - Parameter method that should be used to render the parameter - See also - - - - - Returns index for , when - - - - - Constructs a single message template parameter - - Parameter Name - Parameter Value - Parameter Format - - - - Constructs a single message template parameter - - Parameter Name - Parameter Value - Parameter Format - Parameter CaptureType - - - - Parameters extracted from parsing as MessageTemplate - - - - - - - - - - - Gets the parameters at the given index - - - - - Number of parameters - - - - Indicates whether the template should be interpreted as positional - (all holes are numbers) or named. - - - - Indicates whether the template was parsed successful, and there are no unmatched parameters - - - - - Constructor for parsing the message template with parameters - - including any parameter placeholders - All - - - - Constructor for named parameters that already has been parsed - - - - - Create MessageTemplateParameter from - - - - - - - - - - A mesage template - - - - The original template string. - This is the key passed to structured targets. - - - The list of literal parts, useful for string rendering. - It indicates the number of characters from the original string to print, - then there's a hole with how many chars to skip. - - "Hello {firstName} {lastName}!" - ------------------------------------- - ║P |S ║P|S ║P|S║ - ║6 |11 ║1|10 ║1|0║ - ║Hello |{firstName}║ |{lastName}║!║ - - "{x} * 2 = {2x}" - -------------------- - ║P|S ║P |S ║ - ║0|3 ║7 |4 ║ - ║{x}║ * 2 = |{2x}║ - - The tricky part is escaped braces. They are represented by a skip = 0, - which is interpreted as "move one char forward, no hole". - - "Escaped }} is fun." - ---------------------- - ║P |S║P |S║ - ║9 |0║8 |0║ - ║Escaped }|}║ is fun.|║ - - - - This list of holes. It's used both to fill the string rendering - and to send values along the template to structured targets. - - - Indicates whether the template should be interpreted as positional - (all holes are numbers) or named. - - - - Create a template, which is already parsed - - - - - - - - - Create a template, which is already parsed - - - - - - - - This is for testing only: recreates from the parsed data. - - - - This is for testing only: rebuilds the hole - - Add to this string builder - ref for performance - - - - Parse templates. - - - - - Parse a template. - - Template to be parsed. - When is null. - Template, never null - - - - Gets the current literal/hole in the template - - - - - Clears the enumerator - - - - - Restarts the enumerator of the template - - - - - Moves to the next literal/hole in the template - - Found new element [true/false] - - - - Parse format after hole name/index. Handle the escaped { and } in the format. Don't read the last } - - - - - - Parse templates. - - - - - Parse a template. - - Template to be parsed. - When is null. - Template, never null - - - - Error when parsing a template. - - - - - Current index when the error occurred. - - - - - The template we were parsing - - - - - New exception - - The message to be shown. - Current index when the error occurred. - - - - - Render templates - - - - - Render a template to a string. - - The template. - Culture. - Parameters for the holes. - Do not fallback to StringBuilder.Format for positional templates. - The String Builder destination. - Parameters for the holes. - - - - Render a template to a string. - - The template. - The String Builder destination. - Culture. - Parameters for the holes. - Rendered template, never null. - - - - Convert Render or serialize a value, with optionnally backwardscompatible with - - - - Singleton - - - - Serialization of an object, e.g. JSON and append to - - The object to serialize to string. - Parameter Format - Parameter CaptureType - An object that supplies culture-specific formatting information. - Output destination. - Serialize succeeded (true/false) - - - - Format an object to a readable string, or if it's an object, serialize - - The value to convert - - - - - - - - Try serialising a scalar (string, int, NULL) or simple type (IFormattable) - - - - - - - - - - Serialize Dictionary as JSON like structure, without { and } - - - "FirstOrder"=true, "Previous login"=20-12-2017 14:55:32, "number of tries"=1 - - - formatstring of an item - - - - - - - - - Convert a value to a string with format and append to . - - The value to convert. - Format sting for the value. - Format provider for the value. - Append to this - - - - Nested Diagnostics Context - for log4net compatibility. - - This class marked as obsolete on NLog 2.0 and it may be removed in a future release. - - - - Gets the top NDC message but doesn't remove it. - - The top message. . - - - - Gets the top NDC object but doesn't remove it. - - The object from the top of the NDC stack, if defined; otherwise null. - - - - Pushes the specified text on current thread NDC. - - The text to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pops the top message off the NDC stack. - - The top message which is no longer on the stack. - - - - Pops the top object off the NDC stack. The object is removed from the stack. - - The top object from the NDC stack, if defined; otherwise null. - - - - Clears current thread NDC stack. - - - - - Gets all messages on the stack. - - Array of strings on the stack. - - - - Gets all objects on the NDC stack. The objects are not removed from the stack. - - Array of objects on the stack. - - - - Nested Diagnostics Context - a thread-local structure that keeps a stack - of strings and provides methods to output them in layouts - Mostly for compatibility with log4net. - - - - - Gets the top NDC message but doesn't remove it. - - The top message. . - - - - Gets the top NDC object but doesn't remove it. - - The object at the top of the NDC stack if defined; otherwise null. - - - - Pushes the specified text on current thread NDC. - - The text to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pushes the specified object on current thread NDC. - - The object to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pops the top message off the NDC stack. - - The top message which is no longer on the stack. - - - - Pops the top message from the NDC stack. - - The to use when converting the value to a string. - The top message, which is removed from the stack, as a string value. - - - - Pops the top object off the NDC stack. - - The object from the top of the NDC stack, if defined; otherwise null. - - - - Peeks the first object on the NDC stack - - The object from the top of the NDC stack, if defined; otherwise null. - - - - Clears current thread NDC stack. - - - - - Gets all messages on the stack. - - Array of strings on the stack. - - - - Gets all messages from the stack, without removing them. - - The to use when converting a value to a string. - Array of strings. - - - - Gets all objects on the stack. - - Array of objects on the stack. - - - - Resets the stack to the original count during . - - - - - Initializes a new instance of the class. - - The stack. - The previous count. - - - - Reverts the stack to original item count. - - - - - Async version of - a logical context structure that keeps a stack - Allows for maintaining scope across asynchronous tasks and call contexts. - - - - - Pushes the specified value on current stack - - The value to be pushed. - An instance of the object that implements IDisposable that returns the stack to the previous level when IDisposable.Dispose() is called. To be used with C# using() statement. - - - - Pops the top message off the NDLC stack. - - The top message which is no longer on the stack. - this methods returns a object instead of string, this because of backwardscompatibility - - - - Pops the top message from the NDLC stack. - - The to use when converting the value to a string. - The top message, which is removed from the stack, as a string value. - - - - Pops the top message off the current NDLC stack - - The object from the top of the NDLC stack, if defined; otherwise null. - - - - Peeks the top object on the current NDLC stack - - The object from the top of the NDLC stack, if defined; otherwise null. - - - - Peeks the current scope, and returns its start time - - Scope Creation Time - - - - Peeks the first scope, and returns its start time - - Scope Creation Time - - - - Clears current stack. - - - - - Gets all messages on the stack. - - Array of strings on the stack. - - - - Gets all messages from the stack, without removing them. - - The to use when converting a value to a string. - Array of strings. - - - - Gets all objects on the stack. The objects are not removed from the stack. - - Array of objects on the stack. - - - - Exception thrown during NLog configuration. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - Parameters for the message - - - - Initializes a new instance of the class. - - The inner exception. - The message. - Parameters for the message - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - Exception thrown during log event processing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message. - - - - Initializes a new instance of the class. - - The message. - Parameters for the message - - - - Initializes a new instance of the class. - - The message. - The inner exception. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - The parameter is null. - - - The class name is null or is zero (0). - - - - - TraceListener which routes all messages through NLog. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the log factory to use when outputting messages (null - use LogManager). - - - - - Gets or sets the default log level. - - - - - Gets or sets the log which should be always used regardless of source level. - - - - - Gets or sets a value indicating whether flush calls from trace sources should be ignored. - - - - - Gets a value indicating whether the trace listener is thread safe. - - - true if the trace listener is thread safe; otherwise, false. The default is false. - - - - Gets or sets a value indicating whether to use auto logger name detected from the stack trace. - - - - - When overridden in a derived class, writes the specified message to the listener you create in the derived class. - - A message to write. - - - - When overridden in a derived class, writes a message to the listener you create in the derived class, followed by a line terminator. - - A message to write. - - - - When overridden in a derived class, closes the output stream so it no longer receives tracing or debugging output. - - - - - Emits an error message. - - A message to emit. - - - - Emits an error message and a detailed error message. - - A message to emit. - A detailed message to emit. - - - - Flushes the output (if is not true) buffer with the default timeout of 15 seconds. - - - - - Writes trace information, a data object and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - The trace data to emit. - - - - Writes trace information, an array of data objects and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - An array of objects to emit as data. - - - - Writes trace and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - - - - Writes trace information, a formatted array of objects and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - A format string that contains zero or more format items, which correspond to objects in the array. - An object array containing zero or more objects to format. - - - - Writes trace information, a message, and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - One of the values specifying the type of event that has caused the trace. - A numeric identifier for the event. - A message to write. - - - - Writes trace information, a message, a related activity identity and event information to the listener specific output. - - A object that contains the current process ID, thread ID, and stack trace information. - A name used to identify the output, typically the name of the application that generated the trace event. - A numeric identifier for the event. - A message to write. - A object identifying a related activity. - - - - Gets the custom attributes supported by the trace listener. - - - A string array naming the custom attributes supported by the trace listener, or null if there are no custom attributes. - - - - - Translates the event type to level from . - - Type of the event. - Translated log level. - - - - Process the log event - The log level. - The name of the logger. - The log message. - The log parameters. - The event id. - The event type. - The related activity id. - - - - - It works as a normal but it discards all messages which an application requests - to be logged. - - It effectively implements the "Null Object" pattern for objects. - - - - - Initializes a new instance of . - - The factory class to be used for the creation of this logger. - - - - Specifies the way archive numbering is performed. - - - - - Sequence style numbering. The most recent archive has the highest number. - - - - - Rolling style numbering (the most recent is always #0 then #1, ..., #N. - - - - - Date style numbering. Archives will be stamped with the prior period - (Year, Month, Day, Hour, Minute) datetime. - - - - - Date and sequence style numbering. - Archives will be stamped with the prior period (Year, Month, Day) datetime. - The most recent archive has the highest number (in combination with the date). - - - - - Abstract Target with async Task support - - - - - How many seconds a Task is allowed to run before it is cancelled. - - - - - Task Scheduler used for processing async Tasks - - - - - Constructor - - - - - Override this to create the actual logging task - - Example of how to override this method, and call custom async method - - protected override Task WriteAsyncTask(LogEventInfo logEvent, CancellationToken token) - { - return CustomWriteAsync(logEvent, token); - } - - private async Task CustomWriteAsync(LogEventInfo logEvent, CancellationToken token) - { - await MyLogMethodAsync(logEvent, token).ConfigureAwait(false); - } - - - The log event. - The cancellation token - - - - - Schedules the LogEventInfo for async writing - - The log event. - - - - Schedules notification of when all messages has been written - - - - - - Closes Target by updating CancellationToken - - - - - Releases any managed resources - - - - - - Checks the internal queue for the next to create a new task for - - Used for race-condition validation betweewn task-completion and timeout - - - - Creates new task to handle the writing of the input - - LogEvent to write - New Task created [true / false] - - - - Handles that scheduled task has completed (succesfully or failed), and starts the next pending task - - Task just completed - AsyncContinuation to notify of success or failure - - - - Timer method, that is fired when pending task fails to complete within timeout - - - - - - Sends log messages to the remote instance of Chainsaw application from log4j. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -

- - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a name. - - Name of the target. - - - - Writes log messages to the console with customizable coloring. - - Documentation on NLog Wiki - - - - Should logging being paused/stopped because of the race condition bug in Console.Writeline? - - - Console.Out.Writeline / Console.Error.Writeline could throw 'IndexOutOfRangeException', which is a bug. - See http://stackoverflow.com/questions/33915790/console-out-and-console-error-race-condition-error-in-a-windows-service-written - and https://connect.microsoft.com/VisualStudio/feedback/details/2057284/console-out-probable-i-o-race-condition-issue-in-multi-threaded-windows-service - - Full error: - Error during session close: System.IndexOutOfRangeException: Probable I/ O race condition detected while copying memory. - The I/ O package is not thread safe by default.In multithreaded applications, - a stream must be accessed in a thread-safe way, such as a thread - safe wrapper returned by TextReader's or - TextWriter's Synchronized methods.This also applies to classes like StreamWriter and StreamReader. - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets or sets a value indicating whether the error stream (stderr) should be used instead of the output stream (stdout). - - - - - - Gets or sets a value indicating whether to use default row highlighting rules. - - - The default rules are: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
ConditionForeground ColorBackground Color
level == LogLevel.FatalRedNoChange
level == LogLevel.ErrorYellowNoChange
level == LogLevel.WarnMagentaNoChange
level == LogLevel.InfoWhiteNoChange
level == LogLevel.DebugGrayNoChange
level == LogLevel.TraceDarkGrayNoChange
- - - - - - The encoding for writing messages to the . - - Has side effect - - - - - Gets or sets a value indicating whether to auto-check if the console is available. - - Disables console writing if Environment.UserInteractive = False (Windows Service) - - Disables console writing if Console Standard Input is not available (Non-Console-App) - - - - - - Gets the row highlighting rules. - - - - - - Gets the word highlighting rules. - - - - - - Initializes the target. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified log event to the console highlighting entries - and words based on a set of defined rules. - - Log event. - - - - Color pair (foreground and background). - - - - - Colored console output color. - - - Note that this enumeration is defined to be binary compatible with - .NET 2.0 System.ConsoleColor + some additions - - - - - Black Color (#000000). - - - - - Dark blue Color (#000080). - - - - - Dark green Color (#008000). - - - - - Dark Cyan Color (#008080). - - - - - Dark Red Color (#800000). - - - - - Dark Magenta Color (#800080). - - - - - Dark Yellow Color (#808000). - - - - - Gray Color (#C0C0C0). - - - - - Dark Gray Color (#808080). - - - - - Blue Color (#0000FF). - - - - - Green Color (#00FF00). - - - - - Cyan Color (#00FFFF). - - - - - Red Color (#FF0000). - - - - - Magenta Color (#FF00FF). - - - - - Yellow Color (#FFFF00). - - - - - White Color (#FFFFFF). - - - - - Don't change the color. - - - - - The row-highlighting condition. - - - - - Initializes static members of the ConsoleRowHighlightingRule class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The condition. - Color of the foreground. - Color of the background. - - - - Gets the default highlighting rule. Doesn't change the color. - - - - - Gets or sets the condition that must be met in order to set the specified foreground and background color. - - - - - - Gets or sets the foreground color. - - - - - - Gets or sets the background color. - - - - - - Checks whether the specified log event matches the condition (if any). - - - Log event. - - - A value of if the condition is not defined or - if it matches, otherwise. - - - - - Writes log messages to the console. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Should logging being paused/stopped because of the race condition bug in Console.Writeline? - - - Console.Out.Writeline / Console.Error.Writeline could throw 'IndexOutOfRangeException', which is a bug. - See http://stackoverflow.com/questions/33915790/console-out-and-console-error-race-condition-error-in-a-windows-service-written - and https://connect.microsoft.com/VisualStudio/feedback/details/2057284/console-out-probable-i-o-race-condition-issue-in-multi-threaded-windows-service - - Full error: - Error during session close: System.IndexOutOfRangeException: Probable I/ O race condition detected while copying memory. - The I/ O package is not thread safe by default.In multithreaded applications, - a stream must be accessed in a thread-safe way, such as a thread - safe wrapper returned by TextReader's or - TextWriter's Synchronized methods.This also applies to classes like StreamWriter and StreamReader. - - - - - - Gets or sets a value indicating whether to send the log messages to the standard error instead of the standard output. - - - - - - The encoding for writing messages to the . - - Has side effect - - - - - Gets or sets a value indicating whether to auto-check if the console is available - - Disables console writing if Environment.UserInteractive = False (Windows Service) - - Disables console writing if Console Standard Input is not available (Non-Console-App) - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Initializes the target. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified logging event to the Console.Out or - Console.Error depending on the value of the Error flag. - - The logging event. - - Note that the Error option is not supported on .NET Compact Framework. - - - - - Write to output - - text to be written. - - - - Highlighting rule for Win32 colorful console. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The text to be matched.. - Color of the foreground. - Color of the background. - - - - Gets or sets the regular expression to be matched. You must specify either text or regex. - - - - - - Compile the ? This can improve the performance, but at the costs of more memory usage. If false, the Regex Cache is used. - - - - - - Gets or sets the text to be matched. You must specify either text or regex. - - - - - - Gets or sets a value indicating whether to match whole words only. - - - - - - Gets or sets a value indicating whether to ignore case when comparing texts. - - - - - - Gets or sets the foreground color. - - - - - - Gets or sets the background color. - - - - - - Gets the compiled regular expression that matches either Text or Regex property. Only used when is true. - - Access this property will compile the Regex. - - - - Get regex options. - - Default option to start with. - - - - - Get Expression for a . - - - - - - Replace regex result - - - - - - - Information about database command + parameters. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the type of the command. - - The type of the command. - - - - - Gets or sets the connection string to run the command against. If not provided, connection string from the target is used. - - - - - - Gets or sets the command text. - - - - - - Gets or sets a value indicating whether to ignore failures. - - - - - - Gets the collection of parameters. Each parameter contains a mapping - between NLog layout and a database named or positional parameter. - - - - - - Represents a parameter to a Database target. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the parameter. - The parameter layout. - - - - Gets or sets the database parameter name. - - - - - - Gets or sets the layout that should be use to calcuate the value for the parameter. - - - - - - Gets or sets the database parameter size. - - - - - - Gets or sets the database parameter precision. - - - - - - Gets or sets the database parameter scale. - - - - - - Writes log messages to the database using an ADO.NET provider. - - - - NETSTANDARD cannot load connectionstrings from .config - - Documentation on NLog Wiki - - - The configuration is dependent on the database type, because - there are differnet methods of specifying connection string, SQL - command and command parameters. - - MS SQL Server using System.Data.SqlClient: - - Oracle using System.Data.OracleClient: - - Oracle using System.Data.OleDBClient: - - To set up the log target programmatically use code like this (an equivalent of MSSQL configuration): - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - - - - Gets or sets the name of the database provider. - - - - The parameter name should be a provider invariant name as registered in machine.config or app.config. Common values are: - -
    -
  • System.Data.SqlClient - SQL Sever Client
    • -
  • System.Data.SqlServerCe.3.5 - SQL Sever Compact 3.5
    • -
  • System.Data.OracleClient - Oracle Client from Microsoft (deprecated in .NET Framework 4)
    • -
  • Oracle.DataAccess.Client - ODP.NET provider from Oracle
    • -
  • System.Data.SQLite - System.Data.SQLite driver for SQLite
    • -
  • Npgsql - Npgsql driver for PostgreSQL
    • -
  • MySql.Data.MySqlClient - MySQL Connector/Net
    • -
- (Note that provider invariant names are not supported on .NET Compact Framework). - - Alternatively the parameter value can be be a fully qualified name of the provider - connection type (class implementing ) or one of the following tokens: - -
    -
  • sqlserver, mssql, microsoft or msde - SQL Server Data Provider
    • -
  • oledb - OLEDB Data Provider
    • -
  • odbc - ODBC Data Provider
    • -
- - - - - - Gets or sets the name of the connection string (as specified in <connectionStrings> configuration section. - - - - - - Gets or sets the connection string. When provided, it overrides the values - specified in DBHost, DBUserName, DBPassword, DBDatabase. - - - - - - Gets or sets the connection string using for installation and uninstallation. If not provided, regular ConnectionString is being used. - - - - - - Gets the installation DDL commands. - - - - - - Gets the uninstallation DDL commands. - - - - - - Gets or sets a value indicating whether to keep the - database connection open between the log events. - - - - - - Obsolete - value will be ignored! The logging code always runs outside of transaction. - - Gets or sets a value indicating whether to use database transactions. - Some data providers require this. - - - - This option was removed in NLog 4.0 because the logging code always runs outside of transaction. - This ensures that the log gets written to the database if you rollback the main transaction because of an error and want to log the error. - - - - - Gets or sets the database host name. If the ConnectionString is not provided - this value will be used to construct the "Server=" part of the - connection string. - - - - - - Gets or sets the database user name. If the ConnectionString is not provided - this value will be used to construct the "User ID=" part of the - connection string. - - - - - - Gets or sets the database password. If the ConnectionString is not provided - this value will be used to construct the "Password=" part of the - connection string. - - - - - - Gets or sets the database name. If the ConnectionString is not provided - this value will be used to construct the "Database=" part of the - connection string. - - - - - - Gets or sets the text of the SQL command to be run on each log level. - - - Typically this is a SQL INSERT statement or a stored procedure call. - It should use the database-specific parameters (marked as @parameter - for SQL server or :parameter for Oracle, other data providers - have their own notation) and not the layout renderers, - because the latter is prone to SQL injection attacks. - The layout renderers should be specified as <parameter /> elements instead. - - - - - - Gets or sets the type of the SQL command to be run on each log level. - - - This specifies how the command text is interpreted, as "Text" (default) or as "StoredProcedure". - When using the value StoredProcedure, the commandText-property would - normally be the name of the stored procedure. TableDirect method is not supported in this context. - - - - - - Gets the collection of parameters. Each parameter contains a mapping - between NLog layout and a database named or positional parameter. - - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Initializes the target. Can be used by inheriting classes - to initialize logging. - - - - - Set the to use it for opening connections to the database. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified logging event to the database. It creates - a new database command, prepares parameters for it by calculating - layouts and executes the command. - - The logging event. - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Build the connectionstring from the properties. - - - Using at first, and falls back to the properties , - , and - - Event to render the layout inside the properties. - - - - - Adds the given list of DatabaseParameterInfo to the given IDbCommand after transforming them into IDbDataParameters. - - The IDbCommand to add parameters to - The list of DatabaseParameterInfo to transform into IDbDataParameters and to add to the IDbCommand - The log event to base the parameter's layout rendering on. - - - - A descriptor for an archive created with the DateAndSequence numbering mode. - - - - - The full name of the archive file. - - - - - The parsed date contained in the file name. - - - - - The parsed sequence number contained in the file name. - - - - - Determines whether produces the same string as the current instance's date once formatted with the current instance's date format. - - The date to compare the current object's date to. - True if the formatted dates are equal, otherwise False. - - - - Initializes a new instance of the class. - - - - - Writes log messages to the attached managed debugger. - - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Initializes the target. - - - - - Closes the target and releases any unmanaged resources. - - - - - Writes the specified logging event to the attached debugger. - - The logging event. - - - - Mock target - useful for testing. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets the number of times this target has been called. - - - - - - Gets the last message rendered by this target. - - - - - - Increases the number of messages. - - The logging event. - - - - Default class for serialization of values to JSON format. - - - - - Singleton instance of the serializer. - - - - - Private. Use - - - - - Returns a serialization of an object into JSON format. - - The object to serialize to JSON. - Serialized value. - - - - Returns a serialization of an object into JSON format. - - The object to serialize to JSON. - serialisation options - Serialized value. - - - - Serialization of the object in JSON format to the destination StringBuilder - - The object to serialize to JSON. - Write the resulting JSON to this destination. - Object serialized succesfully (true/false). - - - - Serialization of the object in JSON format to the destination StringBuilder - - The object to serialize to JSON. - Write the resulting JSON to this destination. - serialisation options - Object serialized succesfully (true/false). - - - - Serialization of the object in JSON format to the destination StringBuilder - - The object to serialize to JSON. - Write the resulting JSON to this destination. - serialisation options - The objects in path (Avoid cyclic reference loop). - The current depth (level) of recursion. - Object serialized succesfully (true/false). - - - - No quotes needed for this type? - - - - - - - Checks the object if it is numeric - - TypeCode for the object - Accept fractional types as numeric type. - - - - - Checks input string if it needs JSON escaping, and makes necessary conversion - - Destination Builder - Input string - Should non-ascii characters be encoded - JSON escaped string - - - - Get properties, cached for a type - - - - - - - Writes log message to the Event Log. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - - - - Gets or sets the name of the machine on which Event Log service is running. - - - - - - Gets or sets the layout that renders event ID. - - - - - - Gets or sets the layout that renders event Category. - - - - - - Optional entrytype. When not set, or when not convertable to then determined by - - - - - - Gets or sets the value to be used as the event Source. - - - By default this is the friendly name of the current AppDomain. - - - - - - Gets or sets the name of the Event Log to write to. This can be System, Application or - any user-defined name. - - - - - - Gets or sets the message length limit to write to the Event Log. - - MaxMessageLength cannot be zero or negative - - - - - Gets or sets the maximum Event log size in kilobytes. - - If null, the value won't be set. - - Default is 512 Kilobytes as specified by Eventlog API - - MaxKilobytes cannot be less than 64 or greater than 4194240 or not a multiple of 64. If null, use the default value - - - - - Gets or sets the action to take if the message is larger than the option. - - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Initializes the target. - - - - - Writes the specified logging event to the event log. - - The logging event. - - - - Get the entry type for logging the message. - - The logging event - for rendering the - - - - - Get the source, if and only if the source is fixed. - - null when not - Internal for unit tests - - - - Get the eventlog to write to. - - Event if the source needs to be rendered. - - - - - (re-)create a event source, if it isn't there. Works only with fixed sourcenames. - - sourcenaam. If source is not fixed (see , then pass null or emptystring. - always throw an Exception when there is an error - - - - Action that should be taken if the message is greater than - the max message size allowed by the Event Log. - - - - - Truncate the message before writing to the Event Log. - - - - - Split the message and write multiple entries to the Event Log. - - - - - Discard of the message. It will not be written to the Event Log. - - - - - Check if cleanup should be performed on initialize new file - - Skip cleanup when initializing new file, just after having performed archive operation - - Base archive file pattern - Maximum number of archive files that should be kept - True, when archive cleanup is needed - - - - Characters determining the start of the . - - - - - Characters determining the end of the . - - - - - File name which is used as template for matching and replacements. - It is expected to contain a pattern to match. - - - - - The begging position of the - within the . -1 is returned - when no pattern can be found. - - - - - The ending position of the - within the . -1 is returned - when no pattern can be found. - - - - - Replace the pattern with the specified String. - - - - - - - Archives the log-files using a date style numbering. Archives will be stamped with the - prior period (Year, Month, Day, Hour, Minute) datetime. When the number of archive files exceed the obsolete archives are deleted. - - - - - - Archives the log-files using a date and sequence style numbering. Archives will be stamped - with the prior period (Year, Month, Day) datetime. The most recent archive has the highest number (in - combination with the date). - - - When the number of archive files exceed the obsolete archives are deleted. - - - - - - Parse filename with date and sequence pattern - - - dateformat for archive - - the found pattern. When failed, then default - the found pattern. When failed, then default - - - - - Archives the log-files using the provided base-archive-filename. If the base-archive-filename causes - duplicate archive filenames, then sequence-style is automatically enforced. - - Example: - Base Filename trace.log - Next Filename trace.0.log - - The most recent archive has the highest number. When the number of archive files - exceed the obsolete archives are deleted. - - - - - Dynamically converts a non-template archiveFilePath into a correct archiveFilePattern. - Before called the original IFileArchiveMode, that has been wrapped by this - - - - - Determines if the file name as contains a numeric pattern i.e. {#} in it. - - Example: - trace{#}.log Contains the numeric pattern. - trace{###}.log Contains the numeric pattern. - trace{#X#}.log Contains the numeric pattern (See remarks). - trace.log Does not contain the pattern. - - Occasionally, this method can identify the existence of the {#} pattern incorrectly. - File name to be checked. - when the pattern is found; otherwise. - - - - Determine if old archive files should be deleted. - - Maximum number of archive files that should be kept - when old archives should be deleted; otherwise. - - - - Archives the log-files using a rolling style numbering (the most recent is always #0 then - #1, ..., #N. When the number of archive files exceed the obsolete archives - are deleted. - - - - - Replaces the numeric pattern i.e. {#} in a file name with the parameter value. - - File name which contains the numeric pattern. - Value which will replace the numeric pattern. - File name with the value of in the position of the numeric pattern. - - - - Archives the log-files using a sequence style numbering. The most recent archive has the - highest number. When the number of archive files exceed the obsolete - archives are deleted. - - - - - Modes of archiving files based on time. - - - - - Don't archive based on time. - - - - - AddToArchive every year. - - - - - AddToArchive every month. - - - - - AddToArchive daily. - - - - - AddToArchive every hour. - - - - - AddToArchive every minute. - - - - - AddToArchive every Sunday. - - - - - AddToArchive every Monday. - - - - - AddToArchive every Tuesday. - - - - - AddToArchive every Wednesday. - - - - - AddToArchive every Thursday. - - - - - AddToArchive every Friday. - - - - - AddToArchive every Saturday. - - - - - Type of filepath - - - - - Detect of relative or absolute - - - - - Relative path - - - - - Absolute path - - Best for performance - - - - Writes log messages to one or more files. - - Documentation on NLog Wiki - - - - Default clean up period of the initilized files. When a file exceeds the clean up period is removed from the list. - - Clean up period is defined in days. - - - - The maximum number of initialised files before clean up procedures are initiated, - to keep the number of initialised files to a minimum. Chose 25 to cater for monthly rolling of log-files. - - - - - This value disables file archiving based on the size. - - - - - Holds the initialised files each given time by the instance. Against each file, the last write time is stored. - - Last write time is store in local time (no UTC). - - - - List of the associated file appenders with the instance. - - - - - The number of initialised files at any one time. - - - - - The maximum number of archive files that should be kept. - - - - - The filename as target - - - - - The archive file name as target - - - - - The date of the previous log event. - - - - - The file name of the previous log event. - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets or sets the name of the file to write to. - - - This FileName string is a layout which may include instances of layout renderers. - This lets you use a single target to write to multiple files. - - - The following value makes NLog write logging events to files based on the log level in the directory where - the application runs. - ${basedir}/${level}.log - All Debug messages will go to Debug.log, all Info messages will go to Info.log and so on. - You can combine as many of the layout renderers as you want to produce an arbitrary log file name. - - - - - - Cleanup invalid values in a filename, e.g. slashes in a filename. If set to true, this can impact the performance of massive writes. - If set to false, nothing gets written when the filename is wrong. - - - - - - Is the an absolute or relative path? - - - - - - Gets or sets a value indicating whether to create directories if they do not exist. - - - Setting this to false may improve performance a bit, but you'll receive an error - when attempting to write to a directory that's not present. - - - - - - Gets or sets a value indicating whether to delete old log file on startup. - - - This option works only when the "FileName" parameter denotes a single file. - - - - - - Gets or sets a value indicating whether to replace file contents on each write instead of appending log message at the end. - - - - - - Gets or sets a value indicating whether to keep log file open instead of opening and closing it on each logging event. - - - Setting this property to True helps improve performance. - - - - - - Gets or sets the maximum number of log filenames that should be stored as existing. - - - The bigger this number is the longer it will take to write each log record. The smaller the number is - the higher the chance that the clean function will be run when no new files have been opened. - - - - - Gets or sets a value indicating whether to enable log file(s) to be deleted. - - - - - - Gets or sets the file attributes (Windows only). - - - - - - Should we capture the last write time of a file? - - - - - Gets or sets the line ending mode. - - - - - - Gets or sets a value indicating whether to automatically flush the file buffers after each log message. - - - - - - Gets or sets the number of files to be kept open. Setting this to a higher value may improve performance - in a situation where a single File target is writing to many files - (such as splitting by level or by logger). - - - The files are managed on a LRU (least recently used) basis, which flushes - the files that have not been used for the longest period of time should the - cache become full. As a rule of thumb, you shouldn't set this parameter to - a very high value. A number like 10-15 shouldn't be exceeded, because you'd - be keeping a large number of files open which consumes system resources. - - - - - - Gets or sets the maximum number of seconds that files are kept open. If this number is negative the files are - not automatically closed after a period of inactivity. - - - - - - Gets or sets the log file buffer size in bytes. - - - - - - Gets or sets the file encoding. - - - - - - Gets or sets whether or not this target should just discard all data that its asked to write. - Mostly used for when testing NLog Stack except final write - - - - - - Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on the same host. - - - This makes multi-process logging possible. NLog uses a special technique - that lets it keep the files open for writing. - - - - - - Gets or sets a value indicating whether concurrent writes to the log file by multiple processes on different network hosts. - - - This effectively prevents files from being kept open. - - - - - - Gets or sets a value indicating whether to write BOM (byte order mark) in created files - - - - - - Gets or sets the number of times the write is appended on the file before NLog - discards the log message. - - - - - - Gets or sets the delay in milliseconds to wait before attempting to write to the file again. - - - The actual delay is a random value between 0 and the value specified - in this parameter. On each failed attempt the delay base is doubled - up to times. - - - Assuming that ConcurrentWriteAttemptDelay is 10 the time to wait will be:

- a random value between 0 and 10 milliseconds - 1st attempt
- a random value between 0 and 20 milliseconds - 2nd attempt
- a random value between 0 and 40 milliseconds - 3rd attempt
- a random value between 0 and 80 milliseconds - 4th attempt
- ...

- and so on. - - - - -

- Gets or sets a value indicating whether to archive old log file on startup. - - - This option works only when the "FileName" parameter denotes a single file. - After archiving the old file, the current log file will be empty. - - - - - - Gets or sets a value specifying the date format to use when archiving files. - - - This option works only when the "ArchiveNumbering" parameter is set either to Date or DateAndSequence. - - - - - - Gets or sets the size in bytes above which log files will be automatically archived. - - Warning: combining this with isn't supported. We cannot create multiple archive files, if they should have the same name. - Choose: - - - Caution: Enabling this option can considerably slow down your file - logging in multi-process scenarios. If only one process is going to - be writing to the file, consider setting ConcurrentWrites - to false for maximum performance. - - - - - - Gets or sets a value indicating whether to automatically archive log files every time the specified time passes. - - - Files are moved to the archive as part of the write operation if the current period of time changes. For example - if the current hour changes from 10 to 11, the first write that will occur - on or after 11:00 will trigger the archiving. -

- Caution: Enabling this option can considerably slow down your file - logging in multi-process scenarios. If only one process is going to - be writing to the file, consider setting ConcurrentWrites - to false for maximum performance. -

- - - - - - Is the an absolute or relative path? - - - - - - Gets or sets the name of the file to be used for an archive. - - - It may contain a special placeholder {#####} - that will be replaced with a sequence of numbers depending on - the archiving strategy. The number of hash characters used determines - the number of numerical digits to be used for numbering files. - - - - - - Gets or sets the maximum number of archive files that should be kept. - - - - - - Gets or sets the way file archives are numbered. - - - - - - Used to compress log files during archiving. - This may be used to provide your own implementation of a zip file compressor, - on platforms other than .Net4.5. - Defaults to ZipArchiveFileCompressor on .Net4.5 and to null otherwise. - - - - - - Gets or sets a value indicating whether to compress archive files into the zip archive format. - - - - - - Gets or set a value indicating whether a managed file stream is forced, instead of using the native implementation. - - - - - - Gets or sets a value indicationg whether file creation calls should be synchronized by a system global mutex. - - - - - - Gets or sets a value indicating whether the footer should be written only when the file is archived. - - - - - - Gets the characters that are appended after each line. - - - - - Refresh the ArchiveFilePatternToWatch option of the . - The log file must be watched for archiving when multiple processes are writing to the same - open file. - - - - - Removes records of initialized files that have not been - accessed in the last two days. - - - Files are marked 'initialized' for the purpose of writing footers when the logging finishes. - - - - - Removes records of initialized files that have not been - accessed after the specified date. - - The cleanup threshold. - - Files are marked 'initialized' for the purpose of writing footers when the logging finishes. - - - - - Flushes all pending file operations. - - The asynchronous continuation. - - The timeout parameter is ignored, because file APIs don't provide - the needed functionality. - - - - - Returns the suitable appender factory ( ) to be used to generate the file - appenders associated with the instance. - - The type of the file appender factory returned depends on the values of various properties. - - suitable for this instance. - - - - Initializes file logging by creating data structures that - enable efficient multi-file logging. - - - - - Closes the file(s) opened for writing. - - - - - Can be used if has been enabled. - - - - - Can be used if has been enabled. - - - - - Can be used if has been enabled. - - - - - Writes the specified logging event to a file specified in the FileName - parameter. - - The logging event. - - - - Get full filename (=absolute) and cleaned if needed. - - - - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Writes the specified array of logging events to a file specified in the FileName - parameter. - - An array of objects. - - This function makes use of the fact that the events are batched by sorting - the requests by filename. This optimizes the number of open/close calls - and can help improve performance. - - - - - Returns estimated size for memory stream, based on events count and first event size in bytes. - - Count of events - Bytes count of first event - - - - Formats the log event for write. - - The log event to be formatted. - A string representation of the log event. - - - - Gets the bytes to be written to the file. - - Log event. - Array of bytes that are ready to be written. - - - - Modifies the specified byte array before it gets sent to a file. - - The byte array. - The modified byte array. The function can do the modification in-place. - - - - Gets the bytes to be written to the file. - - The log event to be formatted. - to help format log event. - Optional temporary char-array to help format log event. - Destination for the encoded result. - - - - Formats the log event for write. - - The log event to be formatted. - for the result. - - - - Modifies the specified byte array before it gets sent to a file. - - The LogEvent being written - The byte array. - - - - Archives fileName to archiveFileName. - - File name to be archived. - Name of the archive file. - - - - Gets the correct formatting to be used based on the value of for converting values which will be inserting into file - names during archiving. - - This value will be computed only when a empty value or is passed into - - Date format to used irrespectively of value. - Formatting for dates. - - - - Calculate the DateTime of the requested day of the week. - - The DateTime of the previous log event. - The next occuring day of the week to return a DateTime for. - The DateTime of the next occuring dayOfWeek. - For example: if previousLogEventTimestamp is Thursday 2017-03-02 and dayOfWeek is Sunday, this will return - Sunday 2017-03-05. If dayOfWeek is Thursday, this will return *next* Thursday 2017-03-09. - - - - Invokes the archiving process after determining when and which type of archiving is required. - - File name to be checked and archived. - Log event that the instance is currently processing. - The DateTime of the previous log event for this file. - File has just been opened. - - - - Gets the pattern that archive files will match - - Filename of the log file - Log event that the instance is currently processing. - A string with a pattern that will match the archive filenames - - - - Archives the file if it should be archived. - - The file name to check for. - Log event that the instance is currently processing. - The size in bytes of the next chunk of data to be written in the file. - The DateTime of the previous log event for this file. - File has just been opened. - True when archive operation of the file was completed (by this target or a concurrent target) - - - - Indicates if the automatic archiving process should be executed. - - File name to be written. - Log event that the instance is currently processing. - The size in bytes of the next chunk of data to be written in the file. - The DateTime of the previous log event for this file. - Filename to archive. If null, then nothing to archive. - - - - Returns the correct filename to archive - - - - - - Gets the file name for archiving, or null if archiving should not occur based on file size. - - File name to be written. - The size in bytes of the next chunk of data to be written in the file. - Filename to archive. If null, then nothing to archive. - - - - Returns the file name for archiving, or null if archiving should not occur based on date/time. - - File name to be written. - Log event that the instance is currently processing. - The DateTime of the previous log event for this file. - Filename to archive. If null, then nothing to archive. - - - - Truncates the input-time, so comparison of low resolution times (like dates) are not affected by ticks - - High resolution Time - Time Resolution Level - Truncated Low Resolution Time - - - - Evaluates which parts of a file should be written (header, content, footer) based on various properties of - instance and writes them. - - File name to be written. - Raw sequence of to be written into the content part of the file. - File has just been opened. - - - - Initialise a file to be used by the instance. Based on the number of initialised - files and the values of various instance properties clean up and/or archiving processes can be invoked. - - File name to be written. - Log event that the instance is currently processing. - The DateTime of the previous log event for this file (DateTime.MinValue if just initialized). - - - - Writes the file footer and finalizes the file in instance internal structures. - - File name to close. - Indicates if the file is being finalized for archiving. - - - - Writes the footer information to a file. - - The file path to write to. - - - - Invokes the archiving and clean up of older archive file based on the values of and properties respectively. - - File name to be written. - Log event that the instance is currently processing. - - - - Creates the file specified in and writes the file content in each entirety i.e. - Header, Content and Footer. - - The name of the file to be written. - Sequence of to be written in the content section of the file. - First attempt to write? - This method is used when the content of the log file is re-written on every write. - - - - Writes the header information and byte order mark to a file. - - File appender associated with the file. - - - - The sequence of to be written in a file after applying any formating and any - transformations required from the . - - The layout used to render output message. - Sequence of to be written. - Usually it is used to render the header and hooter of the files. - - - - Check if cleanup should be performed on initialize new file - - Base archive file pattern - Maximum number of archive files that should be kept - True, when archive cleanup is needed - - - - Create a wildcard file-mask that allows one to find all files belonging to the same archive. - - Base archive file pattern - Wildcard file-mask - - - - Search directory for all existing files that are part of the same archive. - - Base archive file pattern - - - - - Generate the next archive filename for the archive. - - Base archive file pattern - File date of archive - Existing files in the same archive - - - - - Return all files that should be removed from the provided archive. - - Base archive file pattern - Existing files in the same archive - Maximum number of archive files that should be kept - - - - - may be configured to compress archived files in a custom way - by setting before logging your first event. - - - - - Create archiveFileName by compressing fileName. - - Absolute path to the log file to compress. - Absolute path to the compressed archive file to create. - - - - Interface for serialization of values, maybe even objects to JSON format. - Useful for wrappers for existing serializers. - - - - - Returns a serialization of an object - into JSON format. - - The object to serialize to JSON. - Serialized value (null = Serialize failed). - - - - Options for JSON serialisation - - - - - Add quotes arround object keys? - - - - - Formatprovider for value - - - - - Format string for value - - - - - Should non-ascii characters be encoded - - - - - Serialize enum as string value - - - - - Should dictionary keys be sanitized. All characters must either be letters, numbers or underscore character (_). - - Any other characters will be converted to underscore character (_) - - - - - How far down the rabbit hole should the Json Serializer go with object-reflection before stopping - - - - Initializes a new instance of the class. - - - - Line ending mode. - - - - - Insert platform-dependent end-of-line sequence after each line. - - - - - Insert CR LF sequence (ASCII 13, ASCII 10) after each line. - - - - - Insert CR character (ASCII 13) after each line. - - - - - Insert LF character (ASCII 10) after each line. - - - - - Do not insert any line ending. - - - - - Gets the name of the LineEndingMode instance. - - - - - Gets the new line characters (value) of the LineEndingMode instance. - - - - - Initializes a new instance of . - - The mode name. - The new line characters to be used. - - - - Returns the that corresponds to the supplied . - - - The textual representation of the line ending mode, such as CRLF, LF, Default etc. - Name is not case sensitive. - - The value, that corresponds to the . - There is no line ending mode with the specified name. - - - - Compares two objects and returns a - value indicating whether the first one is equal to the second one. - - The first level. - The second level. - The value of mode1.NewLineCharacters == mode2.NewLineCharacters. - - - - Compares two objects and returns a - value indicating whether the first one is not equal to the second one. - - The first mode - The second mode - The value of mode1.NewLineCharacters != mode2.NewLineCharacters. - - - - Returns a string representation of the log level. - - Log level name. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms - and data structures like a hash table. - - - - - Determines whether the specified is - equal to this instance. - - The to compare with - this instance. - - Value of true if the specified - is equal to this instance; otherwise, false. - - - The parameter is null. - - - - Indicates whether the current object is equal to another object of the same type. - true if the current object is equal to the parameter; otherwise, false. - An object to compare with this object. - - - - Provides a type converter to convert objects to and from other representations. - - - - - Returns whether this converter can convert an object of the given type to the type of this converter, using the specified context. - - - true if this converter can perform the conversion; otherwise, false. - - An that provides a format context. A that represents the type you want to convert from. - - - - Converts the given object to the type of this converter, using the specified context and culture information. - - - An that represents the converted value. - - An that provides a format context. The to use as the current culture. The to convert. The conversion cannot be performed. - - - - Sends log messages to a NLog Receiver Service (using WCF or Web Services). - - Documentation on NLog Wiki - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - - - - Gets or sets the endpoint address. - - The endpoint address. - - - - - Gets or sets the name of the endpoint configuration in WCF configuration file. - - The name of the endpoint configuration. - - - - - Gets or sets a value indicating whether to use binary message encoding. - - - - - - Gets or sets a value indicating whether to use a WCF service contract that is one way (fire and forget) or two way (request-reply) - - - - - - Gets or sets the client ID. - - The client ID. - - - - - Gets the list of parameters. - - The parameters. - - - - - Gets or sets a value indicating whether to include per-event properties in the payload sent to the server. - - - - - - Called when log events are being sent (test hook). - - The events. - The async continuations. - True if events should be sent, false to stop processing them. - - - - Writes logging event to the log target. Must be overridden in inheriting - classes. - - Logging event to be written out. - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Append" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Add value to the , returns ordinal in - - - lookup so only unique items will be added to - value to add - - - - - Creating a new instance of WcfLogReceiverClient - - Inheritors can override this method and provide their own - service configuration - binding and endpoint address - - This method marked as obsolete before NLog 4.3.11 and it may be removed in a future release. - - - - Creating a new instance of IWcfLogReceiverClient - - Inheritors can override this method and provide their own - service configuration - binding and endpoint address - - - virtual is used by endusers - - - - Sends log messages by email using SMTP protocol. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- Mail target works best when used with BufferingWrapper target - which lets you send multiple log messages in single mail -

-

- To set up the buffered mail target in the configuration file, - use the following syntax: -

- -

- To set up the buffered mail target programmatically use code like this: -

- - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Gets the mailSettings/smtp configuration from app.config in cases when we need those configuration. - E.g when UseSystemNetMailSettings is enabled and we need to read the From attribute from system.net/mailSettings/smtp - - Internal for mocking - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets or sets sender's email address (e.g. joe@domain.com). - - - - - - Gets or sets recipients' email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). - - - - - - Gets or sets CC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). - - - - - - Gets or sets BCC email addresses separated by semicolons (e.g. john@domain.com;jane@domain.com). - - - - - - Gets or sets a value indicating whether to add new lines between log entries. - - A value of true if new lines should be added; otherwise, false. - - - - - Gets or sets the mail subject. - - - - - - Gets or sets mail message body (repeated for each log message send in one mail). - - Alias for the Layout property. - - - - - Gets or sets encoding to be used for sending e-mail. - - - - - - Gets or sets a value indicating whether to send message as HTML instead of plain text. - - - - - - Gets or sets SMTP Server to be used for sending. - - - - - - Gets or sets SMTP Authentication mode. - - - - - - Gets or sets the username used to connect to SMTP server (used when SmtpAuthentication is set to "basic"). - - - - - - Gets or sets the password used to authenticate against SMTP server (used when SmtpAuthentication is set to "basic"). - - - - - - Gets or sets a value indicating whether SSL (secure sockets layer) should be used when communicating with SMTP server. - - . - - - - Gets or sets the port number that SMTP Server is listening on. - - - - - - Gets or sets a value indicating whether the default Settings from System.Net.MailSettings should be used. - - - - - - Specifies how outgoing email messages will be handled. - - - - - - Gets or sets the folder where applications save mail messages to be processed by the local SMTP server. - - - - - - Gets or sets the priority used for sending mails. - - - - - - Gets or sets a value indicating whether NewLine characters in the body should be replaced with
tags. - - Only happens when is set to true. - - - - - Gets or sets a value indicating the SMTP client timeout. - - Warning: zero is not infinit waiting - - - - - Renders the logging event message and adds it to the internal ArrayList of log messages. - - The logging event. - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Renders an array logging events. - - Array of logging events. - - - - Initializes the target. Can be used by inheriting classes - to initialize logging. - - - - - Create mail and send with SMTP - - event printed in the body of the event - - - - Create buffer for body - - all events - first event for header - last event for footer - - - - - Set properties of - - last event for username/password - client to set properties on - Configure not at , as the properties could have layout renderers. - - - - Handle if it is a virtual directory. - - - - - - - Create key for grouping. Needed for multiple events in one mailmessage - - event for rendering layouts - string to group on - - - - Append rendered layout to the stringbuilder - - append to this - event for rendering - append if not null - - - - Create the mailmessage with the addresses, properties and body. - - - - - Render and add the addresses to - - Addresses appended to this list - layout with addresses, ; separated - event for rendering the - added a address? - - - - Writes log messages to an ArrayList in memory for programmatic retrieval. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets the list of logs gathered in the . - - - - - Renders the logging event message and adds it to the internal ArrayList of log messages. - - The logging event. - - - - A parameter to MethodCall. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The layout to use for parameter value. - - - - Initializes a new instance of the class. - - Name of the parameter. - The layout. - - - - Initializes a new instance of the class. - - The name of the parameter. - The layout. - The type of the parameter. - - - - Gets or sets the name of the parameter. - - - - - - Gets or sets the type of the parameter. Obsolete alias for - - - - - - Gets or sets the type of the parameter. - - - - - - Gets or sets the layout that should be use to calculate the value for the parameter. - - - - - - Calls the specified static method on each log message and passes contextual parameters to it. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Gets or sets the class name. - - - - - - Gets or sets the method name. The method must be public and static. - - Use the AssemblyQualifiedName , https://msdn.microsoft.com/en-us/library/system.type.assemblyqualifiedname(v=vs.110).aspx - e.g. - - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - - - - Initializes the target. - - - - - Calls the specified Method. - - Method parameters. - - - - The base class for all targets which call methods (local or remote). - Manages parameters and type coercion. - - - - - Initializes a new instance of the class. - - - - - Gets the array of parameters to be passed. - - - - - - Prepares an array of parameters to be passed based on the logging event and calls DoInvoke(). - - The logging event. - - - - Calls the target DoInvoke method, and handles AsyncContinuation callback - - Method call parameters. - The logging event. - - - - Calls the target DoInvoke method, and handles AsyncContinuation callback - - Method call parameters. - The continuation. - - - - Calls the target method. Must be implemented in concrete classes. - - Method call parameters. - - - - Sends log messages over the network. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- To print the results, use any application that's able to receive messages over - TCP or UDP. NetCat is - a simple but very powerful command-line tool that can be used for that. This image - demonstrates the NetCat tool receiving log messages from Network target. -

- -

- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will be very slow. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -

-

- There are two specialized versions of the Network target: Chainsaw - and NLogViewer which write to instances of Chainsaw log4j viewer - or NLogViewer application respectively. -

- - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets or sets the network address. - - - The network address can be: -
    -
  • tcp://host:port - TCP (auto select IPv4/IPv6) (not supported on Windows Phone 7.0)
    • -
  • tcp4://host:port - force TCP/IPv4 (not supported on Windows Phone 7.0)
    • -
  • tcp6://host:port - force TCP/IPv6 (not supported on Windows Phone 7.0)
    • -
  • udp://host:port - UDP (auto select IPv4/IPv6, not supported on Silverlight and on Windows Phone 7.0)
    • -
  • udp4://host:port - force UDP/IPv4 (not supported on Silverlight and on Windows Phone 7.0)
    • -
  • udp6://host:port - force UDP/IPv6 (not supported on Silverlight and on Windows Phone 7.0)
    • -
  • http://host:port/pageName - HTTP using POST verb
    • -
  • https://host:port/pageName - HTTPS using POST verb
    • -
- For SOAP-based webservice support over HTTP use WebService target. - - - - - - Gets or sets a value indicating whether to keep connection open whenever possible. - - - - - - Gets or sets a value indicating whether to append newline at the end of log message. - - - - - - Gets or sets the end of line value if a newline is appended at the end of log message . - - - - - - Gets or sets the maximum message size in bytes. - - - - - - Gets or sets the size of the connection cache (number of connections which are kept alive). - - - - - - Gets or sets the maximum current connections. 0 = no maximum. - - - - - - Gets or sets the action that should be taken if the will be more connections than . - - - - - - Gets or sets the maximum queue size. - - - - - - Gets or sets the action that should be taken if the message is larger than - maxMessageSize. - - - - - - Gets or sets the encoding to be used. - - - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Closes the target. - - - - - Sends the - rendered logging event over the network optionally concatenating it with a newline character. - - The logging event. - - - - Try to remove. - - - - - removed something? - - - - Gets the bytes to be written. - - Log event. - Byte array. - - - - The action to be taken when there are more connections then the max. - - - - - Just allow it. - - - - - Discard the connection item. - - - - - Block until there's more room in the queue. - - - - - Action that should be taken if the message overflows. - - - - - Report an error. - - - - - Split the message into smaller pieces. - - - - - Discard the entire message. - - - - - Represents a parameter to a NLogViewer target. - - - - - Initializes a new instance of the class. - - - - - Gets or sets viewer parameter name. - - - - - - Gets or sets the layout that should be use to calcuate the value for the parameter. - - - - - - Sends log messages to the remote instance of NLog Viewer. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

- NOTE: If your receiver application is ever likely to be off-line, don't use TCP protocol - or you'll get TCP timeouts and your application will crawl. - Either switch to UDP transport or use AsyncWrapper target - so that your application threads will not be blocked by the timing-out connection attempts. -

- - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Gets or sets a value indicating whether to include NLog-specific extensions to log4j schema. - - - - - - Gets or sets the AppInfo field. By default it's the friendly name of the current AppDomain. - - - - - - Gets or sets a value indicating whether to include call site (class and method name) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include source info (file name and line number) in the information sent over the network. - - - - - - Gets or sets a value indicating whether to include dictionary contents. - - - - - - Gets or sets a value indicating whether to include stack contents. - - - - - - Gets or sets a value indicating whether to include dictionary contents. - - - - - - Gets or sets a value indicating whether to include contents of the stack. - - - - - - Gets or sets the NDLC item separator. - - - - - - Gets or sets the option to include all properties from the log events - - - - - - Gets or sets the NDC item separator. - - - - - - Gets or sets the renderer for log4j:event logger-xml-attribute (Default ${logger}) - - - - - - Gets the collection of parameters. Each parameter contains a mapping - between NLog layout and a named parameter. - - - - - - Gets the layout renderer which produces Log4j-compatible XML events. - - - - - Gets or sets the instance of that is used to format log messages. - - - - - - Discards log messages. Used mainly for debugging and benchmarking. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Gets or sets a value indicating whether to perform layout calculation. - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - - Does nothing. Optionally it calculates the layout text but - discards the results. - - The logging event. - - - - Outputs log messages through the OutputDebugString() Win32 API. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Outputs the rendered logging event through the OutputDebugString() Win32 API. - - The logging event. - - - - Increments specified performance counter on each write. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - TODO: - 1. Unable to create a category allowing multiple counter instances (.Net 2.0 API only, probably) - 2. Is there any way of adding new counters without deleting the whole category? - 3. There should be some mechanism of resetting the counter (e.g every day starts from 0), or auto-switching to - another counter instance (with dynamic creation of new instance). This could be done with layouts. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - - - - Gets or sets a value indicating whether performance counter should be automatically created. - - - - - - Gets or sets the name of the performance counter category. - - - - - - Gets or sets the name of the performance counter. - - - - - - Gets or sets the performance counter instance name. - - - - - - Gets or sets the counter help text. - - - - - - Gets or sets the performance counter type. - - - - - - The value by which to increment the counter. - - - - - - Performs installation which requires administrative permissions. - - The installation context. - - - - Performs uninstallation which requires administrative permissions. - - The installation context. - - - - Determines whether the item is installed. - - The installation context. - - Value indicating whether the item is installed or null if it is not possible to determine. - - - - - Increments the configured performance counter. - - Log event. - - - - Closes the target and releases any unmanaged resources. - - - - - Ensures that the performance counter has been initialized. - - True if the performance counter is operational, false otherwise. - - - - SMTP authentication modes. - - - - - No authentication. - - - - - Basic - username and password. - - - - - NTLM Authentication. - - - - - Represents logging target. - - - - Are all layouts in this target thread-agnostic, if so we don't precalculate the layouts - - - - The Max StackTraceUsage of all the in this Target - - - - - Gets or sets the name of the target. - - - - - - Target supports reuse of internal buffers, and doesn't have to constantly allocate new buffers - Required for legacy NLog-targets, that expects buffers to remain stable after Write-method exit - - - - - - Gets the object which can be used to synchronize asynchronous operations that must rely on the . - - - - - Gets the logging configuration this target is part of. - - - - - Gets a value indicating whether the target has been initialized. - - - - - Can be used if has been enabled. - - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Closes the target. - - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Calls the on each volatile layout - used by this target. - This method won't prerender if all layouts in this target are thread-agnostic. - - - The log event. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Writes the log to the target. - - Log event to write. - - - - Writes the array of log events. - - The log events. - - - - Writes the array of log events. - - The log events. - - - - Initializes this instance. - - The configuration. - - - - Closes this instance. - - - - - Releases unmanaged and - optionally - managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Initializes the target. Can be used by inheriting classes - to initialize logging. - - - - - Closes the target and releases any unmanaged resources. - - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Writes logging event to the log target. Must be overridden in inheriting - classes. - - Logging event to be written out. - - - - Writes async log event to the log target. - - Async Log event to be written out. - - - - Writes a log event to the log target, in a thread safe manner. - Any override of this method has to provide their own synchronization mechanism. - - !WARNING! Custom targets should only override this method if able to provide their - own synchronization mechanism. -objects are not guaranteed to be - threadsafe, so using them without a SyncRoot-object can be dangerous. - - Log event to be written out. - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - NOTE! Obsolete, instead override WriteAsyncThreadSafe(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target, in a thread safe manner. - - !WARNING! Custom targets should only override this method if able to provide their - own synchronization mechanism. -objects are not guaranteed to be - threadsafe, so using them without a SyncRoot-object can be dangerous. - - Logging events to be written out. - - - - Writes an array of logging events to the log target, in a thread safe manner. - Any override of this method has to provide their own synchronization mechanism. - - !WARNING! Custom targets should only override this method if able to provide their - own synchronization mechanism. -objects are not guaranteed to be - threadsafe, so using them without a SyncRoot-object can be dangerous. - - Logging events to be written out. - - - - Merges (copies) the event context properties from any event info object stored in - parameters of the given event info object. - - The event info object to perform the merge to. - - - - Renders the event info in layout. - - The layout. - The event info. - String representing log event. - - - - Register a custom Target. - - Short-cut for registing to default - Type of the Target. - Name of the Target. - - - - Register a custom Target. - - Short-cut for registing to default - Type of the Target. - Name of the Target. - - - - Marks class as a logging target and assigns a name to it. - - This attribute is not required when registering the target in the API. - - - - Initializes a new instance of the class. - - Name of the target. - - - - Gets or sets a value indicating whether to the target is a wrapper target (used to generate the target summary documentation page). - - - - - Gets or sets a value indicating whether to the target is a compound target (used to generate the target summary documentation page). - - - - - Attribute details for - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name of the attribute. - The layout of the attribute's value. - - - - Gets or sets the name of the attribute. - - - - - - Gets or sets the layout that will be rendered as the attribute's value. - - - - - - Gets or sets when an empty value should cause the property to be included - - - - - Represents target that supports context capture using MDLC, MDC, NDLC and NDC - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets or sets a value indicating whether to include contents of the dictionary - - - - - - Gets or sets a value indicating whether to include call site (class and method name) in the - - - - - - Gets or sets a value indicating whether to include source info (file name and line number) in the - - - - - - Gets the array of custom attributes to be passed into the logevent context - - - - - - Constructor - - - - - Check if logevent has properties (or context properties) - - - True if properties should be included - - - - Checks if any context properties, and if any returns them as a single dictionary - - - Dictionary with any context properties for the logEvent (Null if none found) - - - - Creates combined dictionary of all configured properties for logEvent - - - Dictionary with all collected properties for logEvent - - - - Returns the captured snapshot of for the - - - Dictionary with MDC context if any, else null - - - - Returns the captured snapshot of for the - - - Dictionary with MDLC context if any, else null - - - - Returns the captured snapshot of for the - - - Dictionary with NDC context if any, else null - - - - Returns the captured snapshot of for the - - - Dictionary with NDLC context if any, else null - - - - Takes snapshot of for the - - - Optional pre-allocated dictionary for the snapshot - Dictionary with GDC context if any, else null - - - - Takes snapshot of for the - - - Optional pre-allocated dictionary for the snapshot - Dictionary with MDC context if any, else null - - - - Take snapshot of a single object value from - - Log event - MDC key - MDC value - Snapshot of MDC value - Include object value in snapshot - - - - Takes snapshot of for the - - - Optional pre-allocated dictionary for the snapshot - Dictionary with MDLC context if any, else null - - - - Take snapshot of a single object value from - - Log event - MDLC key - MDLC value - Snapshot of MDLC value - Include object value in snapshot - - - - Takes snapshot of for the - - - Dictionary with NDC context if any, else null - - - - Take snapshot of a single object value from - - Log event - NDC value - Snapshot of NDC value - Include object value in snapshot - - - - Takes snapshot of for the - - - Dictionary with NDLC context if any, else null - - - - Take snapshot of a single object value from - - Log event - NDLC value - Snapshot of NDLC value - Include object value in snapshot - - - - Take snapshot of a single object value - - Log event - Key Name (null when NDC / NDLC) - Object Value - Snapshot of value - Include object value in snapshot - - - Internal Layout that allows capture of MDC context - - - Internal Layout that allows capture of NDC context - - - Internal Layout that allows capture of MDLC context - - - Internal Layout that allows capture of NDLC context - - - - Represents target that supports string formatting using layouts. - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Gets or sets the layout used to format log messages. - - - - - - Represents target that supports string formatting using layouts. - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Gets or sets the text to be rendered. - - - - - - Gets or sets the footer. - - - - - - Gets or sets the header. - - - - - - Gets or sets the layout with header and footer. - - The layout with header and footer. - - - - Sends log messages through System.Diagnostics.Trace. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- - - - - - Always use independent of - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - Name of the target. - - - - Writes the specified logging event to the facility. - - Redirects the log message depending on and . - When is false: - - writes to - - writes to - - writes to - - writes to - - writes to - - writes to - - The logging event. - - - - Web service protocol. - - - - - Use SOAP 1.1 Protocol. - - - - - Use SOAP 1.2 Protocol. - - - - - Use HTTP POST Protocol. - - - - - Use HTTP GET Protocol. - - - - - Do an HTTP POST of a JSON document. - - - - - Do an HTTP POST of an XML document. - - - - - Web Service Proxy Configuration Type - - - - - Default proxy configuration from app.config (System.Net.WebRequest.DefaultWebProxy) - - - Example of how to configure default proxy using app.config - - <system.net> - <defaultProxy enabled = "true" useDefaultCredentials = "true" > - <proxy usesystemdefault = "True" /> - </defaultProxy> - </system.net> - - - - - - Automatic use of proxy with authentication (cached) - - - - - Disables use of proxy (fast) - - - - - Custom proxy address (cached) - - - - - Calls the specified web service on each log message. - - Documentation on NLog Wiki - - The web service must implement a method that accepts a number of string parameters. - - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- This assumes just one target and a single rule. More configuration - options are described here. -

-

- To set up the log target programmatically use code like this: -

- -

The example web service that works with this example is shown below

- - - - - - dictionary that maps a concrete implementation - to a specific -value. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target - - - - Gets or sets the web service URL. - - - - - - Gets or sets the Web service method name. Only used with Soap. - - - - - - Gets or sets the Web service namespace. Only used with Soap. - - - - - - Gets or sets the protocol to be used when calling web service. - - - - - - Gets or sets the proxy configuration when calling web service - - - - - - Gets or sets the custom proxy address, include port separated by a colon - - - - - - Should we include the BOM (Byte-order-mark) for UTF? Influences the property. - - This will only work for UTF-8. - - - - - - Gets or sets the encoding. - - - - - - Gets or sets a value whether escaping be done according to Rfc3986 (Supports Internationalized Resource Identifiers - IRIs) - - A value of true if Rfc3986; otherwise, false for legacy Rfc2396. - - - - - Gets or sets a value whether escaping be done according to the old NLog style (Very non-standard) - - A value of true if legacy encoding; otherwise, false for standard UTF8 encoding. - - - - - Gets or sets the name of the root XML element, - if POST of XML document chosen. - If so, this property must not be null. - (see and ). - - - - - - Gets or sets the (optional) root namespace of the XML document, - if POST of XML document chosen. - (see and ). - - - - - - Gets the array of parameters to be passed. - - - - - - Indicates whether to pre-authenticate the HttpWebRequest (Requires 'Authorization' in parameters) - - - - - - Calls the target method. Must be implemented in concrete classes. - - Method call parameters. - - - - Calls the target DoInvoke method, and handles AsyncContinuation callback - - Method call parameters. - The continuation. - - - - Invokes the web service method. - - Parameters to be passed. - The logging event. - - - - Flush any pending log messages asynchronously (in case of asynchronous targets). - - The asynchronous continuation. - - - - Closes the target. - - - - - Builds the URL to use when calling the web service for a message, depending on the WebServiceProtocol. - - - - - - - Write from input to output. Fix the UTF-8 bom - - - - - - - - - base class for POST formatters, that - implement former PrepareRequest() method, - that creates the content for - the requested kind of HTTP request - - - - - Win32 file attributes. - - - For more information see http://msdn.microsoft.com/library/default.asp?url=/library/en-us/fileio/fs/createfile.asp. - - - - - Read-only file. - - - - - Hidden file. - - - - - System file. - - - - - File should be archived. - - - - - Device file. - - - - - Normal file. - - - - - File is temporary (should be kept in cache and not - written to disk if possible). - - - - - Sparse file. - - - - - Reparse point. - - - - - Compress file contents. - - - - - File should not be indexed by the content indexing service. - - - - - Encrypted file. - - - - - The system writes through any intermediate cache and goes directly to disk. - - - - - The system opens a file with no system caching. - - - - - Delete file after it is closed. - - - - - A file is accessed according to POSIX rules. - - - - - Asynchronous request queue. - - - - - Initializes a new instance of the AsyncRequestQueue class. - - Request limit. - The overflow action. - - - - Gets or sets the request limit. - - - - - Gets or sets the action to be taken when there's no more room in - the queue and another request is enqueued. - - - - - Gets the number of requests currently in the queue. - - - - - Enqueues another item. If the queue is overflown the appropriate - action is taken as specified by . - - The log event info. - Queue was empty before enqueue - - - - Dequeues a maximum of count items from the queue - and adds returns the list containing them. - - Maximum number of items to be dequeued (-1 means everything). - The array of log events. - - - - Dequeues into a preallocated array, instead of allocating a new one - - Maximum number of items to be dequeued - Preallocated list - - - - Clears the queue. - - - - - Provides asynchronous, buffered execution of target writes. - - Documentation on NLog Wiki - -

- Asynchronous target wrapper allows the logger code to execute more quickly, by queueing - messages and processing them in a separate thread. You should wrap targets - that spend a non-trivial amount of time in their Write() method with asynchronous - target to speed up logging. -

-

- Because asynchronous logging is quite a common scenario, NLog supports a - shorthand notation for wrapping all targets with AsyncWrapper. Just add async="true" to - the <targets/> element in the configuration file. -

- - - ... your targets go here ... - - ]]> - - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - Maximum number of requests in the queue. - The action to be taken when the queue overflows. - - - - Gets or sets the number of log events that should be processed in a batch - by the lazy writer thread. - - - - - - Gets or sets the time in milliseconds to sleep between batches. - - - - - - Gets or sets the action to be taken when the lazy writer thread request queue count - exceeds the set limit. - - - - - - Gets or sets the limit on the number of requests in the lazy writer thread request queue. - - - - - - Gets or sets the limit of full s to write before yielding into - Performance is better when writing many small batches, than writing a single large batch - - - - - - Gets the queue of lazy writer thread requests. - - - - - Schedules a flush of pending events in the queue (if any), followed by flushing the WrappedTarget. - - The asynchronous continuation. - - - - Initializes the target by starting the lazy writer timer. - - - - - Shuts down the lazy writer timer. - - - - - Starts the lazy writer thread which periodically writes - queued log messages. - - - - - Attempts to start an instant timer-worker-thread which can write - queued log messages. - - Returns true when scheduled a timer-worker-thread - - - - Stops the lazy writer thread. - - - - - Adds the log event to asynchronous queue to be processed by - the lazy writer thread. - - The log event. - - The is called - to ensure that the log event can be processed in another thread. - - - - - Write to queue without locking - - - - - - The action to be taken when the queue overflows. - - - - - Grow the queue. - - - - - Discard the overflowing item. - - - - - Block until there's more room in the queue. - - - - - Causes a flush on a wrapped target if LogEvent statisfies the . - If condition isn't set, flushes on each write. - - Documentation on NLog Wiki - -

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Gets or sets the condition expression. Log events who meet this condition will cause - a flush on the wrapped target. - - - - - - Delay the flush until the LogEvent has been confirmed as written - - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - - - - Initializes a new instance of the class. - - - The default value of the layout is: ${longdate}|${level:uppercase=true}|${logger}|${message} - - The wrapped target. - Name of the target - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes the target. - - - - - Forwards the call to the .Write() - and calls on it if LogEvent satisfies - the flush condition or condition is null. - - Logging event to be written out. - - - - Schedules a flush operation, that triggers when all pending flush operations are completed (in case of asynchronous targets). - - The asynchronous continuation. - - - - Closes the target. - - - - - A target that buffers log events and sends them in batches to the wrapped target. - - Documentation on NLog Wiki - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - Size of the buffer. - - - - Initializes a new instance of the class. - - The wrapped target. - Size of the buffer. - The flush timeout. - - - - Initializes a new instance of the class. - - The wrapped target. - Size of the buffer. - The flush timeout. - The aciton to take when the buffer overflows. - - - - Gets or sets the number of log events to be buffered. - - - - - - Gets or sets the timeout (in milliseconds) after which the contents of buffer will be flushed - if there's no write in the specified period of time. Use -1 to disable timed flushes. - - - - - - Gets or sets a value indicating whether to use sliding timeout. - - - This value determines how the inactivity period is determined. If sliding timeout is enabled, - the inactivity timer is reset after each write, if it is disabled - inactivity timer will - count from the first event written to the buffer. - - - - - - Gets or sets the action to take if the buffer overflows. - - - Setting to will replace the - oldest event with new events without sending events down to the wrapped target, and - setting to will flush the - entire buffer to the wrapped target. - - - - - - Flushes pending events in the buffer (if any), followed by flushing the WrappedTarget. - - The asynchronous continuation. - - - - Initializes the target. - - - - - Closes the target by flushing pending events in the buffer (if any). - - - - - Adds the specified log event to the buffer and flushes - the buffer in case the buffer gets full. - - The log event. - - - - The action to be taken when the buffer overflows. - - - - - Flush the content of the buffer. - - - - - Discard the oldest item. - - - - - A base class for targets which wrap other (multiple) targets - and provide various forms of target routing. - - - - - Initializes a new instance of the class. - - The targets. - - - - Gets the collection of targets managed by this compound target. - - - - - Returns the text representation of the object. Used for diagnostics. - - A string that describes the target. - - - - Writes logging event to the log target. - - Logging event to be written out. - - - - Flush any pending log messages for all wrapped targets. - - The asynchronous continuation. - - - - Provides fallback-on-error. - - Documentation on NLog Wiki - -

This example causes the messages to be written to server1, - and if it fails, messages go to server2.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The targets. - - - - Initializes a new instance of the class. - - The targets. - - - - Gets or sets a value indicating whether to return to the first target after any successful write. - - - - - - - - - - - - Forwards the log event to the sub-targets until one of them succeeds. - - The log event. - - The method remembers the last-known-successful target - and starts the iteration from it. - If is set, the method - resets the target to the first target - stored in . - - - - - Filtering rule for . - - - - - Initializes a new instance of the FilteringRule class. - - - - - Initializes a new instance of the FilteringRule class. - - Condition to be tested against all events. - Filter to apply to all log events when the first condition matches any of them. - - - - Gets or sets the condition to be tested. - - - - - - Gets or sets the resulting filter to be applied when the condition matches. - - - - - - Filters log entries based on a condition. - - Documentation on NLog Wiki - -

This example causes the messages not contains the string '1' to be ignored.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - The condition. - - - - Initializes a new instance of the class. - - The wrapped target. - The condition. - - - - Gets or sets the condition expression. Log events who meet this condition will be forwarded - to the wrapped target. - - - - - - Checks the condition against the passed log event. - If the condition is met, the log event is forwarded to - the wrapped target. - - Log event. - - - - Impersonates another user for the duration of the write. - - Documentation on NLog Wiki - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Gets or sets username to change context to. - - - - - - Gets or sets the user account password. - - - - - - Gets or sets Windows domain name to change context to. - - - - - - Gets or sets the Logon Type. - - - - - - Gets or sets the type of the logon provider. - - - - - - Gets or sets the required impersonation level. - - - - - - Gets or sets a value indicating whether to revert to the credentials of the process instead of impersonating another user. - - - - - - Initializes the impersonation context. - - - - - Closes the impersonation context. - - - - - Changes the security context, forwards the call to the .Write() - and switches the context back to original. - - The log event. - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Changes the security context, forwards the call to the .Write() - and switches the context back to original. - - Log events. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Helper class which reverts the given - to its original value as part of . - - - - - Initializes a new instance of the class. - - The windows impersonation context. - - - - Reverts the impersonation context. - - - - - Limits the number of messages written per timespan to the wrapped target. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The name of the target. - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - - - - Initializes a new instance of the class. - - The wrapped target. - Maximum number of messages written per interval. - Interval in which the maximum number of messages can be written. - - - - Gets or sets the maximum allowed number of messages written per . - - - Messages received after has been reached in the current will be discarded. - - - - - - Gets or sets the interval in which messages will be written up to the number of messages. - - - Messages received after has been reached in the current will be discarded. - - - - - - Gets the DateTime when the current will be reset. - - - - - - Gets the number of written in the current . - - - - - - Initializes the target and resets the current Interval and . - - - - - Writes log event to the wrapped target if the current is lower than . - If the is already reached, no log event will be written to the wrapped target. - resets when the current is expired. - - Log event to be written out. - - - - Logon provider. - - - - - Use the standard logon provider for the system. - - - The default security provider is negotiate, unless you pass NULL for the domain name and the user name - is not in UPN format. In this case, the default provider is NTLM. - NOTE: Windows 2000/NT: The default security provider is NTLM. - - - - - Filters buffered log entries based on a set of conditions that are evaluated on a group of events. - - Documentation on NLog Wiki - - PostFilteringWrapper must be used with some type of buffering target or wrapper, such as - AsyncTargetWrapper, BufferingWrapper or ASPNetBufferingWrapper. - - -

- This example works like this. If there are no Warn,Error or Fatal messages in the buffer - only Info messages are written to the file, but if there are any warnings or errors, - the output includes detailed trace (levels >= Debug). You can plug in a different type - of buffering wrapper (such as ASPNetBufferingWrapper) to achieve different - functionality. -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - - - - Gets or sets the default filter to be applied when no specific rule matches. - - - - - - Gets the collection of filtering rules. The rules are processed top-down - and the first rule that matches determines the filtering condition to - be applied to log events. - - - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Evaluates all filtering rules to find the first one that matches. - The matching rule determines the filtering condition to be applied - to all items in a buffer. If no condition matches, default filter - is applied to the array of log events. - - Array of log events to be post-filtered. - - - - Sends log messages to a randomly selected target. - - Documentation on NLog Wiki - -

This example causes the messages to be written to either file1.txt or file2.txt - chosen randomly on a per-message basis. -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The targets. - - - - Initializes a new instance of the class. - - The targets. - - - - Forwards the log event to one of the sub-targets. - The sub-target is randomly chosen. - - The log event. - - - - Repeats each log event the specified number of times. - - Documentation on NLog Wiki - -

This example causes each log message to be repeated 3 times.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - The repeat count. - - - - Initializes a new instance of the class. - - The wrapped target. - The repeat count. - - - - Gets or sets the number of times to repeat each log message. - - - - - - Forwards the log message to the by calling the method times. - - The log event. - - - - Retries in case of write error. - - Documentation on NLog Wiki - -

This example causes each write attempt to be repeated 3 times, - sleeping 1 second between attempts if first one fails.

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The wrapped target. - The retry count. - The retry delay milliseconds. - - - - Initializes a new instance of the class. - - The wrapped target. - The retry count. - The retry delay milliseconds. - - - - Gets or sets the number of retries that should be attempted on the wrapped target in case of a failure. - - - - - - Gets or sets the time to wait between retries in milliseconds. - - - - - - Special SyncObject to allow closing down Target while busy retrying - - - - - Writes the specified log event to the wrapped target, retrying and pausing in case of an error. - - The log event. - - - - Writes the specified log event to the wrapped target in a thread-safe manner. - - The log event. - - - - Writes the specified log event to the wrapped target, retrying and pausing in case of an error. - - The log event. - - - - Distributes log events to targets in a round-robin fashion. - - Documentation on NLog Wiki - -

This example causes the messages to be written to either file1.txt or file2.txt. - Each odd message is written to file2.txt, each even message goes to file1.txt. -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The targets. - - - - Initializes a new instance of the class. - - The targets. - - - - Ensures forwarding happens without holding lock - - - - - - Forwards the write to one of the targets from - the collection. - - The log event. - - The writes are routed in a round-robin fashion. - The first log event goes to the first target, the second - one goes to the second target and so on looping to the - first target when there are no more targets available. - In general request N goes to Targets[N % Targets.Count]. - - - - - Impersonation level. - - - - - Anonymous Level. - - - - - Identification Level. - - - - - Impersonation Level. - - - - - Delegation Level. - - - - - Logon type. - - - - - Interactive Logon. - - - This logon type is intended for users who will be interactively using the computer, such as a user being logged on - by a terminal server, remote shell, or similar process. - This logon type has the additional expense of caching logon information for disconnected operations; - therefore, it is inappropriate for some client/server applications, - such as a mail server. - - - - - Network Logon. - - - This logon type is intended for high performance servers to authenticate plaintext passwords. - The LogonUser function does not cache credentials for this logon type. - - - - - Batch Logon. - - - This logon type is intended for batch servers, where processes may be executing on behalf of a user without - their direct intervention. This type is also for higher performance servers that process many plaintext - authentication attempts at a time, such as mail or Web servers. - The LogonUser function does not cache credentials for this logon type. - - - - - Logon as a Service. - - - Indicates a service-type logon. The account provided must have the service privilege enabled. - - - - - Network Clear Text Logon. - - - This logon type preserves the name and password in the authentication package, which allows the server to make - connections to other network servers while impersonating the client. A server can accept plaintext credentials - from a client, call LogonUser, verify that the user can access the system across the network, and still - communicate with other servers. - NOTE: Windows NT: This value is not supported. - - - - - New Network Credentials. - - - This logon type allows the caller to clone its current token and specify new credentials for outbound connections. - The new logon session has the same local identifier but uses different credentials for other network connections. - NOTE: This logon type is supported only by the LOGON32_PROVIDER_WINNT50 logon provider. - NOTE: Windows NT: This value is not supported. - - - - - Writes log events to all targets. - - Documentation on NLog Wiki - -

This example causes the messages to be written to both file1.txt or file2.txt -

-

- To set up the target in the configuration file, - use the following syntax: -

- -

- The above examples assume just one target and a single rule. See below for - a programmatic configuration that's equivalent to the above config file: -

- - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - Name of the target. - The targets. - - - - Initializes a new instance of the class. - - The targets. - - - - Forwards the specified log event to all sub-targets. - - The log event. - - - - NOTE! Obsolete, instead override Write(IList{AsyncLogEventInfo} logEvents) - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Writes an array of logging events to the log target. By default it iterates on all - events and passes them to "Write" method. Inheriting classes can use this method to - optimize batch writes. - - Logging events to be written out. - - - - Base class for targets wrap other (single) targets. - - - - - Gets or sets the target that is wrapped by this target. - - - - - - Returns the text representation of the object. Used for diagnostics. - - A string that describes the target. - - - - Flush any pending log messages (in case of asynchronous targets). - - The asynchronous continuation. - - - - Writes logging event to the log target. Must be overridden in inheriting - classes. - - Logging event to be written out. - - - - Builtin IFileCompressor implementation utilizing the .Net4.5 specific - and is used as the default value for on .Net4.5. - So log files created via can be zipped when archived - w/o 3rd party zip library when run on .Net4.5 or higher. - - - - - Implements using the .Net4.5 specific - - - - - Current local time retrieved directly from DateTime.Now. - - - - - Gets current local time directly from DateTime.Now. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to local time. - - - - - Current UTC time retrieved directly from DateTime.UtcNow. - - - - - Gets current UTC time directly from DateTime.UtcNow. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to UTC time. - - - - - Fast time source that updates current time only once per tick (15.6 milliseconds). - - - - - Gets raw uncached time from derived time source. - - - - - Gets current time cached for one system tick (15.6 milliseconds). - - - - - Fast local time source that is updated once per tick (15.6 milliseconds). - - - - - Gets uncached local time directly from DateTime.Now. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to local time. - - - - - Fast UTC time source that is updated once per tick (15.6 milliseconds). - - - - - Gets uncached UTC time directly from DateTime.UtcNow. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to UTC time. - - - - - Defines source of current time. - - - - - Gets current time. - - - - - Gets or sets current global time source used in all log events. - - - Default time source is . - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Converts the specified system time to the same form as the time value originated from this time source. - - The system originated time value to convert. - - The value of converted to the same form - as time values originated from this source. - - - - There are situations when NLog have to compare the time originated from TimeSource - to the time originated externally in the system. - To be able to provide meaningful result of such comparisons the system time must be expressed in - the same form as TimeSource time. - - - Examples: - - If the TimeSource provides time values of local time, it should also convert the provided - to the local time. - - If the TimeSource shifts or skews its time values, it should also apply - the same transform to the given . - - - - - - Marks class as a time source and assigns a name to it. - - - - - Initializes a new instance of the class. - - Name of the time source. - - - diff --git a/distribution/Newtonsoft.Json.dll b/distribution/Newtonsoft.Json.dll deleted file mode 100644 index 8069902..0000000 Binary files a/distribution/Newtonsoft.Json.dll and /dev/null differ diff --git a/distribution/Newtonsoft.Json.xml b/distribution/Newtonsoft.Json.xml deleted file mode 100644 index 2ef7a77..0000000 --- a/distribution/Newtonsoft.Json.xml +++ /dev/null @@ -1,10912 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets a value indicating whether integer values are allowed when deserializing. - The default value is true. - - true if integers are allowed when deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a flag to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A flag to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A flag to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the used when serializing the property's collection items. - - The collection's items . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to reader values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to reader values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a the specified name. - - The property name. - A with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - - The JSON line info handling. - - - - Specifies the settings used when merging JSON. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JPath expression. Selects the token that matches the object path. - - - A that contains a JPath expression. - - A , or null. - - - - Selects a using a JPath expression. Selects the token that matches the object path. - - - A that contains a JPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JPath expression. - - - A that contains a JPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JPath expression. - - - A that contains a JPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the member is an indexed property. - - The member. - - true if the member is an indexed property; otherwise, false. - - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - diff --git a/distribution/Sharlayan.dll b/distribution/Sharlayan.dll deleted file mode 100644 index a229896..0000000 Binary files a/distribution/Sharlayan.dll and /dev/null differ diff --git a/distribution/Sharlayan.xml b/distribution/Sharlayan.xml deleted file mode 100644 index e512d50..0000000 --- a/distribution/Sharlayan.xml +++ /dev/null @@ -1,214 +0,0 @@ - - - - Sharlayan - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Allows the user to find out what module an address is in. - - Int32 Address - ProcessModule - - - - - - - - - - Convert a hex string to a binary array while preserving any wildcard characters. - - A hex string "signature" - The byte to treat as the wildcard - The converted binary array. Null if the conversion failed. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/distribution/System.Windows.Interactivity.dll b/distribution/System.Windows.Interactivity.dll deleted file mode 100644 index 931c744..0000000 Binary files a/distribution/System.Windows.Interactivity.dll and /dev/null differ diff --git a/nuget.config b/nuget.config new file mode 100644 index 0000000..ad66721 --- /dev/null +++ b/nuget.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/packages/.gitignore b/packages/.gitignore deleted file mode 100644 index 0acda71..0000000 --- a/packages/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -* -!repositories.config -!.gitignore \ No newline at end of file diff --git a/packages/Avalonia-NuGet-0.6.2-build5756-beta.zip b/packages/Avalonia-NuGet-0.6.2-build5756-beta.zip new file mode 100644 index 0000000..0326603 Binary files /dev/null and b/packages/Avalonia-NuGet-0.6.2-build5756-beta.zip differ diff --git a/packages/Avalonia.0.6.2-build5756-beta.nupkg b/packages/Avalonia.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..216c1f4 Binary files /dev/null and b/packages/Avalonia.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Android.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Android.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..02d5501 Binary files /dev/null and b/packages/Avalonia.Android.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Desktop.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Desktop.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..8c5b11e Binary files /dev/null and b/packages/Avalonia.Desktop.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Direct2D1.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Direct2D1.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..d8cc5ee Binary files /dev/null and b/packages/Avalonia.Direct2D1.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Gtk3.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Gtk3.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..f7002b4 Binary files /dev/null and b/packages/Avalonia.Gtk3.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.LinuxFramebuffer.0.6.2-build5756-beta.nupkg b/packages/Avalonia.LinuxFramebuffer.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..a111a79 Binary files /dev/null and b/packages/Avalonia.LinuxFramebuffer.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.MonoMac.0.6.2-build5756-beta.nupkg b/packages/Avalonia.MonoMac.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..1d6654d Binary files /dev/null and b/packages/Avalonia.MonoMac.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.ReactiveUI.0.6.2-build5756-beta.nupkg b/packages/Avalonia.ReactiveUI.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..1b6878f Binary files /dev/null and b/packages/Avalonia.ReactiveUI.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Remote.Protocol.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Remote.Protocol.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..0861260 Binary files /dev/null and b/packages/Avalonia.Remote.Protocol.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Skia.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Skia.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..4bf8f42 Binary files /dev/null and b/packages/Avalonia.Skia.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Win32.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Win32.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..a679198 Binary files /dev/null and b/packages/Avalonia.Win32.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.Win32.Interoperability.0.6.2-build5756-beta.nupkg b/packages/Avalonia.Win32.Interoperability.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..c452057 Binary files /dev/null and b/packages/Avalonia.Win32.Interoperability.0.6.2-build5756-beta.nupkg differ diff --git a/packages/Avalonia.iOS.0.6.2-build5756-beta.nupkg b/packages/Avalonia.iOS.0.6.2-build5756-beta.nupkg new file mode 100644 index 0000000..b6ec25b Binary files /dev/null and b/packages/Avalonia.iOS.0.6.2-build5756-beta.nupkg differ diff --git a/packages/repositories.config b/packages/repositories.config deleted file mode 100644 index e6d2280..0000000 --- a/packages/repositories.config +++ /dev/null @@ -1,4 +0,0 @@ - - - - \ No newline at end of file