diff options
| author | sr55 <[email protected]> | 2017-02-11 15:11:06 +0000 |
|---|---|---|
| committer | sr55 <[email protected]> | 2017-02-11 15:11:06 +0000 |
| commit | 2552909ef26bbcebaa89a68b27e7a14bdd1569b0 (patch) | |
| tree | 1a02594f2f68b2d06a4e7f9bd3c9ad509cd213bd | |
| parent | f58a2a8625f9da98bb2acdd2a0a57481935451fb (diff) | |
WinGui: Change the following libraries to use NuGet sources.
- Gong-WPF-DragDrop (Upgraded to 0.1.4.3 -> 1.1.0)
- NewtonSoft.Json (Upgraded to 7.0.0 -> 9.0.1)
- Ookii.Dialogs 1.0
- Caliburn Micro (Upgraded to 2.0.2 -> 3.0.3)
22 files changed, 29 insertions, 16959 deletions
diff --git a/win/CS/HandBrake.ApplicationServices/HandBrake.ApplicationServices.csproj b/win/CS/HandBrake.ApplicationServices/HandBrake.ApplicationServices.csproj index d4a03fe35..636663704 100644 --- a/win/CS/HandBrake.ApplicationServices/HandBrake.ApplicationServices.csproj +++ b/win/CS/HandBrake.ApplicationServices/HandBrake.ApplicationServices.csproj @@ -49,9 +49,9 @@ </PropertyGroup>
<ItemGroup>
<Reference Include="Microsoft.CSharp" />
- <Reference Include="Newtonsoft.Json, Version=4.5.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
- <SpecificVersion>False</SpecificVersion>
- <HintPath>..\libraries\json\Newtonsoft.Json.dll</HintPath>
+ <Reference Include="Newtonsoft.Json, Version=9.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+ <HintPath>..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
+ <Private>True</Private>
</Reference>
<Reference Include="System" />
<Reference Include="System.ComponentModel.DataAnnotations" />
diff --git a/win/CS/HandBrake.ApplicationServices/packages.config b/win/CS/HandBrake.ApplicationServices/packages.config index f8377218f..812777199 100644 --- a/win/CS/HandBrake.ApplicationServices/packages.config +++ b/win/CS/HandBrake.ApplicationServices/packages.config @@ -1,4 +1,5 @@ <?xml version="1.0" encoding="utf-8"?> <packages> + <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net46" /> <package id="StyleCop.Analyzers" version="1.1.0-beta001" targetFramework="net46" developmentDependency="true" /> </packages>
\ No newline at end of file diff --git a/win/CS/HandBrakeWPF/HandBrakeWPF.csproj b/win/CS/HandBrakeWPF/HandBrakeWPF.csproj index a20854234..99f07ea19 100644 --- a/win/CS/HandBrakeWPF/HandBrakeWPF.csproj +++ b/win/CS/HandBrakeWPF/HandBrakeWPF.csproj @@ -84,24 +84,31 @@ <SignAssembly>false</SignAssembly>
</PropertyGroup>
<ItemGroup>
- <Reference Include="Caliburn.Micro">
- <HintPath>..\libraries\caliburn\Caliburn.Micro.dll</HintPath>
+ <Reference Include="Caliburn.Micro, Version=3.0.3.0, Culture=neutral, PublicKeyToken=8e5891231f2ed21f, processorArchitecture=MSIL">
+ <HintPath>..\packages\Caliburn.Micro.Core.3.0.3\lib\net45\Caliburn.Micro.dll</HintPath>
+ <Private>True</Private>
</Reference>
- <Reference Include="Caliburn.Micro.Platform">
- <HintPath>..\libraries\caliburn\Caliburn.Micro.Platform.dll</HintPath>
+ <Reference Include="Caliburn.Micro.Platform, Version=3.0.3.0, Culture=neutral, PublicKeyToken=8e5891231f2ed21f, processorArchitecture=MSIL">
+ <HintPath>..\packages\Caliburn.Micro.3.0.3\lib\net45\Caliburn.Micro.Platform.dll</HintPath>
+ <Private>True</Private>
</Reference>
- <Reference Include="GongSolutions.Wpf.DragDrop">
- <HintPath>..\libraries\WPFDragDrop\GongSolutions.Wpf.DragDrop.dll</HintPath>
+ <Reference Include="Caliburn.Micro.Platform.Core, Version=3.0.3.0, Culture=neutral, PublicKeyToken=8e5891231f2ed21f, processorArchitecture=MSIL">
+ <HintPath>..\packages\Caliburn.Micro.3.0.3\lib\net45\Caliburn.Micro.Platform.Core.dll</HintPath>
+ <Private>True</Private>
+ </Reference>
+ <Reference Include="GongSolutions.Wpf.DragDrop, Version=1.1.0.0, Culture=neutral, processorArchitecture=MSIL">
+ <HintPath>..\packages\gong-wpf-dragdrop.1.1.0\lib\net46\GongSolutions.Wpf.DragDrop.dll</HintPath>
+ <Private>True</Private>
</Reference>
<Reference Include="Microsoft.CSharp" />
<Reference Include="Microsoft.VisualBasic" />
- <Reference Include="Newtonsoft.Json, Version=4.5.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
- <SpecificVersion>False</SpecificVersion>
- <HintPath>..\libraries\json\Newtonsoft.Json.dll</HintPath>
+ <Reference Include="Newtonsoft.Json, Version=9.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
+ <HintPath>..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath>
+ <Private>True</Private>
</Reference>
<Reference Include="Ookii.Dialogs.Wpf, Version=1.0.0.0, Culture=neutral, PublicKeyToken=0c15020868fd6249, processorArchitecture=MSIL">
- <SpecificVersion>False</SpecificVersion>
- <HintPath>..\libraries\OokiiDialogs\Ookii.Dialogs.Wpf.dll</HintPath>
+ <HintPath>..\packages\Ookii.Dialogs.1.0\lib\net35\Ookii.Dialogs.Wpf.dll</HintPath>
+ <Private>True</Private>
</Reference>
<Reference Include="PresentationFramework" />
<Reference Include="PresentationFramework.Aero" />
@@ -114,7 +121,8 @@ <Reference Include="System.ServiceModel" />
<Reference Include="System.Windows.Forms" />
<Reference Include="System.Windows.Interactivity, Version=4.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35, processorArchitecture=MSIL">
- <HintPath>..\libraries\caliburn\System.Windows.Interactivity.dll</HintPath>
+ <HintPath>..\packages\Caliburn.Micro.3.0.3\lib\net45\System.Windows.Interactivity.dll</HintPath>
+ <Private>True</Private>
</Reference>
<Reference Include="System.Xml" />
<Reference Include="System.Core" />
diff --git a/win/CS/HandBrakeWPF/packages.config b/win/CS/HandBrakeWPF/packages.config index f8377218f..31451c3a0 100644 --- a/win/CS/HandBrakeWPF/packages.config +++ b/win/CS/HandBrakeWPF/packages.config @@ -1,4 +1,9 @@ <?xml version="1.0" encoding="utf-8"?> <packages> + <package id="Caliburn.Micro" version="3.0.3" targetFramework="net46" /> + <package id="Caliburn.Micro.Core" version="3.0.3" targetFramework="net46" /> + <package id="gong-wpf-dragdrop" version="1.1.0" targetFramework="net46" /> + <package id="Newtonsoft.Json" version="9.0.1" targetFramework="net46" /> + <package id="Ookii.Dialogs" version="1.0" targetFramework="net46" /> <package id="StyleCop.Analyzers" version="1.1.0-beta001" targetFramework="net46" developmentDependency="true" /> </packages>
\ No newline at end of file diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll Binary files differdeleted file mode 100644 index 55cc4f3ef..000000000 --- a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.Wpf.dll +++ /dev/null diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML deleted file mode 100644 index 99e45451f..000000000 --- a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.XML +++ /dev/null @@ -1,3471 +0,0 @@ -<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Ookii.Dialogs</name>
- </assembly>
- <members>
- <member name="T:Ookii.Dialogs.ShellAnimation">
- <summary>
- Resource identifiers for default animations from shell32.dll.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.FileMove">
- <summary>
- An animation representing a file move.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.FileCopy">
- <summary>
- An animation representing a file copy.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.FlyingPapers">
- <summary>
- An animation showing flying papers.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.SearchGlobe">
- <summary>
- An animation showing a magnifying glass over a globe.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.PermanentDelete">
- <summary>
- An animation representing a permament delete.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.FromRecycleBinDelete">
- <summary>
- An animation representing deleting an item from the recycle bin.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.ToRecycleBinDelete">
- <summary>
- An animation representing a file move to the recycle bin.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.SearchComputer">
- <summary>
- An animation representing a search spanning the local computer.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.SearchDocument">
- <summary>
- An animation representing a search in a document..
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ShellAnimation.SearchFlashlight">
- <summary>
- An animation representing a search using a flashlight animation.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.DownlevelTextMode">
- <summary>
- An enumeration that displays how the text in the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/>
- properties is displayed on a credential dialog in Windows XP.
- </summary>
- <remarks>
- <para>
- Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the
- text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties. Depending
- on the scenario, you may wish to hide either the main instruction or the content text.
- </para>
- </remarks>
- </member>
- <member name="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionAndContent">
- <summary>
- The text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties is
- concatenated together, separated by an empty line.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionOnly">
- <summary>
- Only the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> property is shown.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.DownlevelTextMode.ContentOnly">
- <summary>
- Only the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> property is shown.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.AnimationResource">
- <summary>
- Represents an animation for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> loaded from a Win32 resource.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.AnimationResource.#ctor(System.String,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.AnimationResource"/> class.
- </summary>
- <param name="resourceFile">The file containing the animation resource.</param>
- <param name="resourceId">The resource ID of the animation resource.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="resourceFile"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Ookii.Dialogs.AnimationResource.GetShellAnimation(Ookii.Dialogs.ShellAnimation)">
- <summary>
- Gets a default animation from shell32.dll.
- </summary>
- <param name="animation">The animation to get.</param>
- <returns>An instance of the <see cref="T:Ookii.Dialogs.AnimationResource"/> class representing the specified animation.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="animation"/> parameter was not a value defined in the
- <see cref="T:Ookii.Dialogs.ShellAnimation"/> enumeration.</exception>
- </member>
- <member name="P:Ookii.Dialogs.AnimationResource.ResourceFile">
- <summary>
- Gets the name of the file containing the animation resource.
- </summary>
- <value>
- The name of the file containing the animation resource. This is typically a DLL or EXE file.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.AnimationResource.ResourceId">
- <summary>
- Gets the ID of the animation resource.
- </summary>
- <value>
- The ID of the animation resource.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialog">
- <summary>
- Displays a Task Dialog.
- </summary>
- <remarks>
- The task dialog contains an application-defined message text and title, icons, and any combination of predefined push buttons.
- Task Dialogs are supported only on Windows Vista and above. No fallback is provided; if you wish to use task dialogs
- and support operating systems older than Windows Vista, you must provide a fallback yourself. Check the <see cref="P:Ookii.Dialogs.TaskDialog.OSSupportsTaskDialogs"/>
- property to see if task dialogs are supported. It is safe to instantiate the <see cref="T:Ookii.Dialogs.TaskDialog"/> class on an older
- OS, but calling <see cref="M:Ookii.Dialogs.TaskDialog.Show"/> or <see cref="M:Ookii.Dialogs.TaskDialog.ShowDialog"/> will throw an exception.
- </remarks>
- <threadsafety static="true" instance="false"/>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialog"/> class with the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialog"/> to.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.Show">
- <summary>
- Shows the task dialog as a modeless dialog.
- </summary>
- <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
- title bar close button.</returns>
- <remarks>
- <note>
- Although the dialog is modeless, this method does not return until the task dialog is closed.
- </note>
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- <para>
- One of the properties or a combination of properties is not valid.
- </para>
- <para>
- -or-
- </para>
- <para>
- The dialog is already running.
- </para>
- </exception>
- <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.ShowDialog">
- <summary>
- Shows the task dialog as a modal dialog.
- </summary>
- <returns>The button that the user clicked. Can be <see langword="null"/> if the user cancelled the dialog using the
- title bar close button.</returns>
- <remarks>
- The dialog will use the active window as its owner. If the current process has no active window,
- the dialog will be displayed as a modeless dialog (identical to calling <see cref="M:Ookii.Dialogs.TaskDialog.Show"/>).
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- <para>
- One of the properties or a combination of properties is not valid.
- </para>
- <para>
- -or-
- </para>
- <para>
- The dialog is already running.
- </para>
- </exception>
- <exception cref="T:System.NotSupportedException">Task dialogs are not supported on the current operating system.</exception>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
- <summary>
- This method is for internal Ookii.Dialogs use and should not be called from your code.
- </summary>
- <param name="owner"></param>
- <returns></returns>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.ClickVerification(System.Boolean,System.Boolean)">
- <summary>
- Simulates a click on the verification checkbox of the <see cref="T:Ookii.Dialogs.TaskDialog"/>, if it exists.
- </summary>
- <param name="checkState"><see langword="true"/> to set the state of the checkbox to be checked; <see langword="false"/> to set it to be unchecked.</param>
- <param name="setFocus"><see langword="true"/> to set the keyboard focus to the checkbox; otherwise <see langword="false"/>.</param>
- <exception cref="T:System.InvalidOperationException">The task dialog is not being displayed.</exception>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnHyperlinkClicked(Ookii.Dialogs.HyperlinkClickedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.
- </summary>
- <param name="e">The <see cref="T:Ookii.Dialogs.HyperlinkClickedEventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnButtonClicked(Ookii.Dialogs.TaskDialogItemClickedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.ButtonClicked"/> event.
- </summary>
- <param name="e">The <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnRadioButtonClicked(Ookii.Dialogs.TaskDialogItemClickedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.RadioButtonClicked"/> event.
- </summary>
- <param name="e">The <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnVerificationClicked(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.VerificationClicked"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnCreated(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Created"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnTimer(Ookii.Dialogs.TimerEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.
- </summary>
- <param name="e">The <see cref="T:Ookii.Dialogs.TimerEventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnDestroyed(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.Destroyed"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnExpandButtonClicked(Ookii.Dialogs.ExpandButtonClickedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked"/> event.
- </summary>
- <param name="e">The <see cref="T:Ookii.Dialogs.ExpandButtonClickedEventArgs"/> containing the data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialog.OnHelpRequested(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.TaskDialog.HelpRequested"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing the data for the event.</param>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.Created">
- <summary>
- Event raised when the task dialog has been created.
- </summary>
- <remarks>
- This event is raised once after calling <see cref="M:Ookii.Dialogs.TaskDialog.ShowDialog(System.Windows.Forms.IWin32Window)"/>, after the dialog
- is created and before it is displayed.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.Destroyed">
- <summary>
- Event raised when the task dialog has been destroyed.
- </summary>
- <remarks>
- The task dialog window no longer exists when this event is raised.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.ButtonClicked">
- <summary>
- Event raised when the user clicks a button on the task dialog.
- </summary>
- <remarks>
- Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from being closed.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.RadioButtonClicked">
- <summary>
- Event raised when the user clicks a radio button on the task dialog.
- </summary>
- <remarks>
- The <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property is ignored for this event.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked">
- <summary>
- Event raised when the user clicks a hyperlink.
- </summary>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.VerificationClicked">
- <summary>
- Event raised when the user clicks the verification check box.
- </summary>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.Timer">
- <summary>
- Event raised periodically while the dialog is displayed.
- </summary>
- <remarks>
- <para>
- This event is raised only when the <see cref="P:Ookii.Dialogs.TaskDialog.RaiseTimerEvent"/> property is set to <see langword="true"/>. The event is
- raised approximately every 200 milliseconds.
- </para>
- <para>
- To reset the tick count, set the <see cref="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount"/>
- property to <see langword="true"/>.
- </para>
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked">
- <summary>
- Event raised when the user clicks the expand button on the task dialog.
- </summary>
- <remarks>
- The <see cref="P:Ookii.Dialogs.ExpandButtonClickedEventArgs.Expanded"/> property indicates if the expanded information is visible
- or not after the click.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.TaskDialog.HelpRequested">
- <summary>
- Event raised when the user presses F1 while the dialog has focus.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.OSSupportsTaskDialogs">
- <summary>
- Gets a value that indicates whether the current operating system supports task dialogs.
- </summary>
- <value>
- Returns <see langword="true" /> for Windows Vista or later; otherwise <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.Buttons">
- <summary>
- Gets a list of the buttons on the Task Dialog.
- </summary>
- <value>
- A list of the buttons on the Task Dialog.
- </value>
- <remarks>
- Custom buttons are displayed in the order they have in the collection. Standard buttons will always be displayed
- in the Windows-defined order, regardless of the order of the buttons in the collection.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.RadioButtons">
- <summary>
- Gets a list of the radio buttons on the Task Dialog.
- </summary>
- <value>
- A list of the radio buttons on the Task Dialog.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.WindowTitle">
- <summary>
- Gets or sets the window title of the task dialog.
- </summary>
- <value>
- The window title of the task dialog. The default is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.MainInstruction">
- <summary>
- Gets or sets the dialog's main instruction.
- </summary>
- <value>
- The dialog's main instruction. The default is an empty string ("").
- </value>
- <remarks>
- The main instruction of a task dialog will be displayed in a larger font and a different color than
- the other text of the task dialog.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.Content">
- <summary>
- Gets or sets the dialog's primary content.
- </summary>
- <value>
- The dialog's primary content. The default is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.WindowIcon">
- <summary>
- Gets or sets the icon to be used in the title bar of the dialog.
- </summary>
- <value>
- An <see cref="T:System.Drawing.Icon"/> that represents the icon of the task dialog's window.
- </value>
- <remarks>
- This property is used only when the dialog is shown as a modeless dialog; if the dialog
- is modal, it will have no icon.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.MainIcon">
- <summary>
- Gets or sets the icon to display in the task dialog.
- </summary>
- <value>
- A <see cref="T:Ookii.Dialogs.TaskDialogIcon"/> that indicates the icon to display in the main content area of the task dialog.
- The default is <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
- </value>
- <remarks>
- When this property is set to <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.TaskDialog.CustomMainIcon"/> property to
- specify the icon to use.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.CustomMainIcon">
- <summary>
- Gets or sets a custom icon to display in the dialog.
- </summary>
- <value>
- An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the main content area of the task dialog,
- or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.
- </value>
- <remarks>
- This property is ignored if the <see cref="P:Ookii.Dialogs.TaskDialog.MainIcon"/> property has a value other than <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.FooterIcon">
- <summary>
- Gets or sets the icon to display in the footer area of the task dialog.
- </summary>
- <value>
- A <see cref="T:Ookii.Dialogs.TaskDialogIcon"/> that indicates the icon to display in the footer area of the task dialog.
- The default is <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
- </value>
- <remarks>
- <para>
- When this property is set to <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>, use the <see cref="P:Ookii.Dialogs.TaskDialog.CustomFooterIcon"/> property to
- specify the icon to use.
- </para>
- <para>
- The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> property is not an empty string ("").
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.CustomFooterIcon">
- <summary>
- Gets or sets a custom icon to display in the footer area of the task dialog.
- </summary>
- <value>
- An <see cref="T:System.Drawing.Icon"/> that represents the icon to display in the footer area of the task dialog,
- or <see langword="null"/> if no custom icon is used. The default value is <see langword="null"/>.
- </value>
- <remarks>
- <para>
- This property is ignored if the <see cref="P:Ookii.Dialogs.TaskDialog.FooterIcon"/> property has a value other than <see cref="F:Ookii.Dialogs.TaskDialogIcon.Custom"/>.
- </para>
- <para>
- The footer icon is displayed only if the <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> property is not an empty string ("").
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ButtonStyle">
- <summary>
- Gets or sets a value that indicates whether custom buttons should be displayed as normal buttons or command links.
- </summary>
- <value>
- A <see cref="T:Ookii.Dialogs.TaskDialogButtonStyle"/> that indicates the display style of custom buttons on the dialog.
- The default value is <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.Standard"/>.
- </value>
- <remarks>
- <para>
- This property affects only custom buttons, not standard ones.
- </para>
- <para>
- If a custom button is being displayed on a task dialog
- with <see cref="P:Ookii.Dialogs.TaskDialog.ButtonStyle"/> set to <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks"/>
- or <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon"/>, you delineate the command from the
- note by placing a line break in the string specified by <see cref="P:Ookii.Dialogs.TaskDialogItem.Text"/> property.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.VerificationText">
- <summary>
- Gets or sets the label for the verification checkbox.
- </summary>
- <value>
- The label for the verification checkbox, or an empty string ("") if no verification checkbox
- is shown. The default value is an empty string ("").
- </value>
- <remarks>
- If no text is set, the verification checkbox will not be shown.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.IsVerificationChecked">
- <summary>
- Gets or sets a value that indicates whether the verification checkbox is checked ot not.
- </summary>
- <value>
- <see langword="true"/> if the verficiation checkbox is checked; otherwise, <see langword="false"/>.
- </value>
- <remarks>
- <para>
- Set this property before displaying the dialog to determine the initial state of the check box.
- Use this property after displaying the dialog to determine whether the check box was checked when
- the user closed the dialog.
- </para>
- <note>
- This property is only used if <see cref="P:Ookii.Dialogs.TaskDialog.VerificationText"/> is not an empty string ("").
- </note>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ExpandedInformation">
- <summary>
- Gets or sets additional information to be displayed on the dialog.
- </summary>
- <value>
- Additional information to be displayed on the dialog. The default value is an empty string ("").
- </value>
- <remarks>
- <para>
- When this property is not an empty string (""), a control is shown on the task dialog that
- allows the user to expand and collapse the text specified in this property.
- </para>
- <para>
- The text is collapsed by default unless <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedByDefault"/> is set to <see langword="true"/>.
- </para>
- <para>
- The expanded text is shown in the main content area of the dialog, unless <see cref="P:Ookii.Dialogs.TaskDialog.ExpandFooterArea"/>
- is set to <see langword="true"/>, in which case it is shown in the footer area.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ExpandedControlText">
- <summary>
- Gets or sets the text to use for the control for collapsing the expandable information specified in <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>.
- </summary>
- <value>
- The text to use for the control for collapsing the expandable information, or an empty string ("") if the
- operating system's default text is to be used. The default is an empty string ("")
- </value>
- <remarks>
- <para>
- If this text is not specified and <see cref="P:Ookii.Dialogs.TaskDialog.CollapsedControlText"/> is specified, the value of <see cref="P:Ookii.Dialogs.TaskDialog.CollapsedControlText"/>
- will be used for this property as well. If neither is specified, the operating system's default text is used.
- </para>
- <note>
- The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> is not
- an empty string ("")
- </note>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.CollapsedControlText">
- <summary>
- Gets or sets the text to use for the control for expading the expandable information specified in <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>.
- </summary>
- <value>
- The text to use for the control for expanding the expandable information, or an empty string ("") if the
- operating system's default text is to be used. The default is an empty string ("")
- </value>
- <remarks>
- <para>
- If this text is not specified and <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedControlText"/> is specified, the value of <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedControlText"/>
- will be used for this property as well. If neither is specified, the operating system's default text is used.
- </para>
- <note>
- The control for collapsing or expanding the expandable information is displayed only if <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> is not
- an empty string ("")
- </note>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.Footer">
- <summary>
- Gets or sets the text to be used in the footer area of the task dialog.
- </summary>
- <value>
- The text to be used in the footer area of the task dialog, or an empty string ("")
- if the footer area is not displayed. The default value is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.Width">
- <summary>
- Specifies the width of the task dialog's client area in DLU's.
- </summary>
- <value>
- The width of the task dialog's client area in DLU's, or 0 to have the task dialog calculate the ideal width.
- The default value is 0.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.EnableHyperlinks">
- <summary>
- Gets or sets a value that indicates whether hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>
- and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties.
- </summary>
- <value>
- <see langword="true"/> when hyperlinks are allowed for the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>
- and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- <remarks>
- <para>
- When this property is <see langword="true"/>, the <see cref="P:Ookii.Dialogs.TaskDialog.Content"/>, <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/>
- and <see cref="P:Ookii.Dialogs.TaskDialog.Footer"/> properties can use hyperlinks in the following form: <c><A HREF="executablestring">Hyperlink Text</A></c>
- </para>
- <note>
- Enabling hyperlinks when using content from an unsafe source may cause security vulnerabilities.
- </note>
- <para>
- Task dialogs will not actually execute hyperlinks. To take action when the user presses a hyperlink, handle the
- <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.AllowDialogCancellation">
- <summary>
- Gets or sets a value that indicates that the dialog should be able to be closed using Alt-F4, Escape and the title
- bar's close button even if no cancel button is specified.
- </summary>
- <value>
- <see langword="true" /> if the dialog can be closed using Alt-F4, Escape and the title
- bar's close button even if no cancel button is specified; otherwise, <see langword="false" />.
- The default value is <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ExpandFooterArea">
- <summary>
- Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
- should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content.
- </summary>
- <value>
- <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
- should be displayed at the bottom of the dialog's footer area instead of immediately after the dialog's content;
- otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ExpandedByDefault">
- <summary>
- Gets or sets a value that indicates that the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
- should be displayed by default.
- </summary>
- <value>
- <see langword="true"/> if the string specified by the <see cref="P:Ookii.Dialogs.TaskDialog.ExpandedInformation"/> property
- should be displayed by default; <see langword="false"/> if it is hidden by default. The default value is
- <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.RaiseTimerEvent">
- <summary>
- Gets or sets a value that indicates whether the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event is raised periodically while the dialog
- is visible.
- </summary>
- <value>
- <see langword="true"/> when the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event is raised periodically while the dialog is visible; otherwise,
- <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- <remarks>
- The <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event will be raised approximately every 200 milliseconds if this property is <see langword="true"/>.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.CenterParent">
- <summary>
- Gets or sets a value that indicates whether the dialog is centered in the parent window instead of the screen.
- </summary>
- <value>
- <see langword="true" /> when the dialog is centered relative to the parent window; <see langword="false" /> when it is centered on the screen.
- The default value is <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.RightToLeft">
- <summary>
- Gets or sets a value that indicates whether text is displayed right to left.
- </summary>
- <value>
- <see langword="true" /> when the content of the dialog is displayed right to left; otherwise, <see langword="false" />.
- The default value is <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.MinimizeBox">
- <summary>
- Gets or sets a value that indicates whether the dialog has a minimize box on its caption bar.
- </summary>
- <value>
- <see langword="true" /> if the dialog has a minimize box on its caption bar when modeless; otherwise,
- <see langword="false" />. The default is <see langword="false" />.
- </value>
- <remarks>
- A task dialog can only have a minimize box if it is displayed as a modeless dialog. The minimize box
- will never appear when using the designer "Preview" option, since that displays the dialog modally.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle">
- <summary>
- Gets or sets the type of progress bar displayed on the dialog.
- </summary>
- <value>
- A <see cref="T:Ookii.Dialogs.ProgressBarStyle"/> that indicates the type of progress bar shown on the task dialog.
- </value>
- <remarks>
- <para>
- If this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>, the marquee will
- scroll as long as the dialog is visible.
- </para>
- <para>
- If this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>, the value of the
- <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarValue"/> property must be updated to advance the progress bar. This can be done e.g. by
- an asynchronous operation or from the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.
- </para>
- <note>
- Updating the value of the progress bar using the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarValue"/> while the dialog is visible property may only be done from
- the thread on which the task dialog was created.
- </note>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMarqueeAnimationSpeed">
- <summary>
- Gets or sets the marquee animation speed of the progress bar in milliseconds.
- </summary>
- <value>
- The marquee animation speed of the progress bar in milliseconds. The default value is 100.
- </value>
- <remarks>
- This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
- <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum">
- <summary>
- Gets or sets the lower bound of the range of the task dialog's progress bar.
- </summary>
- <value>
- The lower bound of the range of the task dialog's progress bar. The default value is 0.
- </value>
- <remarks>
- This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
- <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not smaller than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum"/>.</exception>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum">
- <summary>
- Gets or sets the upper bound of the range of the task dialog's progress bar.
- </summary>
- <value>
- The upper bound of the range of the task dialog's progress bar. The default value is 100.
- </value>
- <remarks>
- This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
- <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The new property value is not larger than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum"/>.</exception>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarValue">
- <summary>
- Gets or sets the current value of the task dialog's progress bar.
- </summary>
- <value>
- The current value of the task dialog's progress bar. The default value is 0.
- </value>
- <remarks>
- This property is only used if the <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarStyle"/> property is
- <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
- <note>
- Updating the value of the progress bar while the dialog is visible may only be done from
- the thread on which the task dialog was created.
- </note>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException">The new property value is smaller than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMinimum"/> or larger than <see cref="P:Ookii.Dialogs.TaskDialog.ProgressBarMaximum"/>.</exception>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.ProgressBarState">
- <summary>
- Gets or sets the state of the task dialog's progress bar.
- </summary>
- <value>
- A <see cref="T:Ookii.Dialogs.ProgressBarState"/> indicating the state of the task dialog's progress bar.
- The default value is <see cref="F:Ookii.Dialogs.ProgressBarState.Normal"/>.
- </value>
- <remarks>
- This property is only used if the <see cref="T:Ookii.Dialogs.ProgressBarStyle"/> property is
- <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.Tag">
- <summary>
- Gets or sets an object that contains data about the dialog.
- </summary>
- <value>
- An object that contains data about the dialog. The default value is <see langword="null" />.
- </value>
- <remarks>
- Use this property to store arbitrary information about the dialog.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialog.Handle">
- <summary>
- Gets the window handle of the task dialog.
- </summary>
- <value>
- The window handle of the task dialog when it is being displayed, or <see cref="F:System.IntPtr.Zero"/> when the dialog
- is not being displayed.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogItemCollection`1">
- <summary>
- Represents a list of <see cref="T:Ookii.Dialogs.TaskDialogItem"/> objects.
- </summary>
- <typeparam name="T">The type of the task dialog item.</typeparam>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.ClearItems">
- <summary>
- Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.ClearItems"/> method.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.InsertItem(System.Int32,`0)">
- <summary>
- Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.InsertItem(System.Int32,`0)"/> method.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The object to insert. May not be <see langword="null"/>.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> is already associated with a different task dialog.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> has a duplicate id or button type.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para>
- <paramref name="index"/> is less than zero.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
- </para>
- </exception>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.RemoveItem(System.Int32)">
- <summary>
- Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.RemoveItem(System.Int32)"/> method.
- </summary>
- <param name="index">The zero-based index of the element to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para>
- <paramref name="index"/> is less than zero.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
- </para>
- </exception>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItemCollection`1.SetItem(System.Int32,`0)">
- <summary>
- Overrides the <see cref="M:System.Collections.ObjectModel.Collection`1.SetItem(System.Int32,`0)"/> method.
- </summary>
- <param name="index">The zero-based index of the element to replace.</param>
- <param name="item">The new value for the element at the specified index. May not be <see langword="null"/>.</param>
- <exception cref="T:System.ArgumentNullException"><paramref name="item"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> is already associated with a different task dialog.</exception>
- <exception cref="T:System.InvalidOperationException">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> specified in <paramref name="item"/> has a duplicate id or button type.</exception>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <para>
- <paramref name="index"/> is less than zero.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="index"/> is equal to or greater than <see cref="P:System.Collections.ObjectModel.Collection`1.Count"/>.
- </para>
- </exception>
- </member>
- <member name="T:Ookii.Dialogs.ProgressBarState">
- <summary>
- Represents the state of the progress bar on the task dialog.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ProgressBarState.Normal">
- <summary>
- Normal state.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ProgressBarState.Error">
- <summary>
- Error state
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ProgressBarState.Paused">
- <summary>
- Paused state
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.ExtendedForm">
- <summary>
- Base class for windows forms with extended functionality.
- </summary>
- <remarks>
- <para>
- In order to use this class, create a new Form in Visual Studio, then modify the base
- class in the .cs (or in Visual Basic, the .Designer.vb) file for the form to this class.
- </para>
- <para>
- This class provides two main pieces of functionality: the ability to use the system font
- and the ability to use client area glass in Windows Vista.
- </para>
- <para>
- Windows Forms applications will normally always use MS Sans Serif 8pt, even when the
- system font is something else. For example, on Windows XP (English), the system font
- is Tahoma 8pt. On Windows XP Japanese, the system font is MS UI Gothic 8pt. On Windows
- Vista it is Segoe UI 9pt. By setting the <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> property to <see langword="true"/> for a form,
- that form will automatically use the proper system font.
- </para>
- <para>
- Because the font metrics of these different fonts can be vary greatly
- (especially on Vista which uses a larger font), please make sure the
- <see cref="P:System.Windows.Forms.ContainerControl.AutoScaleMode"/> property is set to
- <see cref="F:System.Windows.Forms.AutoScaleMode.Font"/>, and make special provisions for resizing
- graphics and other elements.
- Please note that some system fonts (such as MS UI Gothic) can also be smaller than MS Sans Serif
- which means the form will be scaled down, not up.
- </para>
- <note>
- If you set <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> to <see langword="true"/>, it is strongly recommended you
- test your application with various different font and DPI settings.
- </note>
- <para>
- To use glass with your form, use the <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property. You can also
- specify whether it's possible to drag the form by its glass areas using the <see cref="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging"/>
- property. Glass requires Windows Vista with the Desktop Window Manager enabled. The glass related
- properties have no effect on other operating systems.
- </para>
- <note>
- Many Windows Forms controls will not display correctly when placed over a glass area. Use the
- <see cref="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)"/> method to display text on a glass area.
- </note>
- <para>
- This class will automatically handle changes in the system font or DWM settings (including enabling/disabling
- of the DWM) while the application is running.
- </para>
- </remarks>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.#ctor">
- <summary>
- Creates a new instance of the <see cref="T:Ookii.Dialogs.ExtendedForm"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.OnDwmCompositionChanged(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.ExtendedForm.DwmCompositionChanged"/> event.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> containing the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.OnLoad(System.EventArgs)">
- <summary>
- Overrides the <see cref="M:System.Windows.Forms.Form.OnLoad(System.EventArgs)"/> method.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.OnFormClosed(System.Windows.Forms.FormClosedEventArgs)">
- <summary>
- Overrides the <see cref="M:System.Windows.Forms.Form.OnFormClosed(System.Windows.Forms.FormClosedEventArgs)"/> method.
- </summary>
- <param name="e">A <see cref="T:System.Windows.Forms.FormClosedEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.OnPaintBackground(System.Windows.Forms.PaintEventArgs)">
- <summary>
- Paints the background of the control.
- </summary>
- <param name="pevent">A <see cref="T:System.Windows.Forms.PaintEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.OnResize(System.EventArgs)">
- <summary>
- This member overrides <see cref="M:System.Windows.Forms.Form.OnResize(System.EventArgs)"/>.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.OnHandleCreated(System.EventArgs)">
- <summary>
- This member overrides <see cref="M:System.Windows.Forms.Form.OnHandleCreated(System.EventArgs)"/>.
- </summary>
- <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.WndProc(System.Windows.Forms.Message@)">
- <summary>
- This member overrides <see cref="M:System.Windows.Forms.Form.WndProc(System.Windows.Forms.Message@)"/>.
- </summary>
- <param name="m">The Windows <see cref="T:System.Windows.Forms.Message"/> to process.</param>
- </member>
- <member name="M:Ookii.Dialogs.ExtendedForm.ScaleControl(System.Drawing.SizeF,System.Windows.Forms.BoundsSpecified)">
- <summary>
- Overrides <see cref="M:System.Windows.Forms.Form.ScaleControl(System.Drawing.SizeF,System.Windows.Forms.BoundsSpecified)"/>.
- </summary>
- <param name="factor">The height and width of the control's bounds.</param>
- <param name="specified">A <see cref="T:System.Windows.Forms.BoundsSpecified"/> value that specifies the bounds of the control to use when defining its size and position.</param>
- </member>
- <member name="E:Ookii.Dialogs.ExtendedForm.DwmCompositionChanged">
- <summary>
- Raised when Desktop Window Manager (DWM) composition has been enabled or disabled.
- </summary>
- <remarks>
- <note>
- This event is only raised on Windows Vista or later.
- </note>
- <para>
- Use the <see cref="P:Ookii.Dialogs.Glass.IsDwmCompositionEnabled"/> property to determine the
- current composition state.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ExtendedForm.UseSystemFont">
- <summary>
- Gets or sets a value that indicates whether or not the form automatically uses the system default font.
- </summary>
- <value>
- <see langword="true"/> when the form's font is automatically adjusted to the system font;
- otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- <remarks>
- <para>
- This property has no effect at design time; the font settings will only be applied at
- run time.
- </para>
- <para>
- When this property is set to <see langword="true"/>, the form will use the configured
- system font and font size automatically, e.g. it will use Segoe UI on Windows Vista and
- Tahoma on Windows XP. Please make sure the <see cref="P:System.Windows.Forms.ContainerControl.AutoScaleMode"/>
- property is set to <see cref="F:System.Windows.Forms.AutoScaleMode.Font"/>
- to account for the different metrics of the various fonts, and make special provisions
- to scale graphics and other element. Note that the system font can also be smaller than
- the font you used at design time, causing the form to be scaled down. For example the font
- MS Gothic UI, used on Japanese versions of Windows (pre-Vista), has smaller metrics than
- MS Sans Serif.
- </para>
- <note>
- It is strongly recommended to test your application with different font and DPI settings if you set this property
- to <see langword="true"/>.
- </note>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ExtendedForm.GlassMargin">
- <summary>
- Gets or sets the glass margins of the form.
- </summary>
- <value>
- A <see cref="T:System.Windows.Forms.Padding"/> that indicates the glass margins of the form. The default value is
- <see cref="F:System.Windows.Forms.Padding.Empty"/>.
- </value>
- <remarks>
- <note>
- Client-area glass requires Windows Vista or later with the Desktop Window Manager enabled. If the Desktop
- Window Manager is not enabled, or an older version of Windows is used, this property is ignored.
- </note>
- <para>
- Client-area glass extends the glass frame used by the Windows Vista Aero user interface into the client
- area of your window.
- </para>
- <para>
- Use negative margins to create the "sheet of glass" effect where the client area is rendered
- as a completely glass surface.
- </para>
- <para>
- Text rendered with the <see cref="T:System.Windows.Forms.TextRenderer"/> will not display correctly on the glass area (this includes
- text drawn by most controls). To draw text on the glass area, use <see cref="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)"/>.
- </para>
- <para>
- If the form is scaled, which can happen for instance if <see cref="P:Ookii.Dialogs.ExtendedForm.UseSystemFont"/> is <see langword="true"/>,
- the glass margin will also be scaled.
- </para>
- <para>
- At design time, the glass area will be indicated by a pattern drawn onto the form. This pattern will not
- be visible at runtime regardless of whether the glass is enabled or not.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging">
- <summary>
- Gets or sets a value that indicates whether the form can be dragged by the glass areas inside the client area.
- </summary>
- <value>
- <see langword="true"/> when the form can be dragged using the client area glass; otherwise, <see langword="false"/>.
- The default value is <see langword="false"/>.
- </value>
- <remarks>
- This property has no effect on operating systems older than Windows Vista, when the Desktop Window Manager is disabled
- or when the <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property is set to zero.
- </remarks>
- </member>
- <member name="F:Ookii.Dialogs.InputDialogForm.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.InputDialogForm.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
- </member>
- <member name="M:Ookii.Dialogs.InputDialogForm.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogIcon">
- <summary>
- Indicates the icon to use for a task dialog.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogIcon.Custom">
- <summary>
- A custom icon or no icon if no custom icon is specified.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogIcon.Warning">
- <summary>
- System warning icon.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogIcon.Error">
- <summary>
- System Error icon.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogIcon.Information">
- <summary>
- System Information icon.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogIcon.Shield">
- <summary>
- Shield icon.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.ProgressDialog">
- <summary>
- Represents a dialog that can be used to report progress to the user.
- </summary>
- <remarks>
- <para>
- This class provides a wrapper for the native Windows IProgressDialog API.
- </para>
- <para>
- The <see cref="T:Ookii.Dialogs.ProgressDialog"/> class requires Windows 2000, Windows Me, or newer versions of Windows.
- </para>
- </remarks>
- <threadsafety static="true" instance="false"/>
- </member>
- <member name="F:Ookii.Dialogs.ProgressDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class, adding it to the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to which the component should be added.</param>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.Show">
- <summary>
- Displays the progress dialog as a modeless dialog.
- </summary>
- <remarks>
- <para>
- This function will not block the parent window and will return immediately.
- </para>
- <para>
- Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
- will not function correctly unless the UI thread continues to handle window messages, so that thread may
- not be blocked by some other activity. All processing related to the progress dialog must be done in
- the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
- could not be loaded.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.Show(System.Object)">
- <summary>
- Displays the progress dialog as a modeless dialog.
- </summary>
- <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.</param>
- <remarks>
- <para>
- This function will not block the parent window and return immediately.
- </para>
- <para>
- Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
- will not function correctly unless the UI thread continues to handle window messages, so that thread may
- not be blocked by some other activity. All processing related to the progress dialog must be done in
- the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
- could not be loaded.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog">
- <summary>
- Displays the progress dialog as a modal dialog.
- </summary>
- <remarks>
- <para>
- The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
- the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.
- The parent window will be disabled as with all modal dialogs.
- </para>
- <para>
- Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
- will not function correctly unless the UI thread continues to handle window messages, so that thread may
- not be blocked by some other activity. All processing related to the progress dialog must be done in
- the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
- </para>
- <para>
- The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
- but is part of the underlying native progress dialog API so cannot be avoided.
- </para>
- <para>
- When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
- could not be loaded.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
- <summary>
- Displays the progress dialog as a modal dialog.
- </summary>
- <param name="owner">The window that owns the dialog.</param>
- <remarks>
- <para>
- The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
- the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.
- The parent window will be disabled as with all modal dialogs.
- </para>
- <para>
- Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
- will not function correctly unless the UI thread continues to handle window messages, so that thread may
- not be blocked by some other activity. All processing related to the progress dialog must be done in
- the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
- </para>
- <para>
- The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
- but is part of the underlying native progress dialog API so cannot be avoided.
- </para>
- <para>
- When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
- could not be loaded, or the operation is already running.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.ShowDialog(System.Windows.Forms.IWin32Window,System.Object)">
- <summary>
- Displays the progress dialog as a modal dialog.
- </summary>
- <param name="owner">The window that owns the dialog.</param>
- <param name="argument">A parameter for use by the background operation to be executed in the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.</param>
- <remarks>
- <para>
- The ShowDialog function for most .Net dialogs will not return until the dialog is closed. However,
- the <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> function for the <see cref="T:Ookii.Dialogs.ProgressDialog"/> class will return immediately.
- The parent window will be disabled as with all modal dialogs.
- </para>
- <para>
- Although this function returns immediately, you cannot use the UI thread to do any processing. The dialog
- will not function correctly unless the UI thread continues to handle window messages, so that thread may
- not be blocked by some other activity. All processing related to the progress dialog must be done in
- the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler.
- </para>
- <para>
- The progress dialog's window will appear in the taskbar. This behaviour is also contrary to most .Net dialogs,
- but is part of the underlying native progress dialog API so cannot be avoided.
- </para>
- <para>
- When possible, it is recommended that you use a modeless dialog using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> function.
- </para>
- </remarks>
- <exception cref="T:System.InvalidOperationException">The animation specified in the <see cref="P:Ookii.Dialogs.ProgressDialog.Animation"/> property
- could not be loaded, or the operation is already running.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32)">
- <summary>
- Updates the dialog's progress bar.
- </summary>
- <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
- <remarks>
- <para>
- Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.
- </para>
- <para>
- This method has no effect is <see cref="P:Ookii.Dialogs.ProgressDialog.ProgressBarStyle"/> is <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>
- or <see cref="F:Ookii.Dialogs.ProgressBarStyle.None"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
- <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)">
- <summary>
- Updates the dialog's progress bar.
- </summary>
- <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
- <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>
- <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>
- <remarks>Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
- <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)">
- <summary>
- Updates the dialog's progress bar.
- </summary>
- <param name="percentProgress">The percentage, from 0 to 100, of the operation that is complete.</param>
- <param name="text">The new value of the progress dialog's primary text message, or <see langword="null"/> to leave the value unchanged.</param>
- <param name="description">The new value of the progress dialog's additional description message, or <see langword="null"/> to leave the value unchanged.</param>
- <param name="userState">A state object that will be passed to the <see cref="E:Ookii.Dialogs.ProgressDialog.ProgressChanged"/> event handler.</param>
- <remarks>Call this method from the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event handler if you want to report progress.</remarks>
- <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="percentProgress"/> is out of range.</exception>
- <exception cref="T:System.InvalidOperationException">The progress dialog is not currently being displayed.</exception>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.OnDoWork(System.ComponentModel.DoWorkEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event.
- </summary>
- <param name="e">The <see cref="T:System.ComponentModel.DoWorkEventArgs"/> containing data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.OnRunWorkerCompleted(System.ComponentModel.RunWorkerCompletedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.RunWorkerCompleted"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.ProgressDialog.OnProgressChanged(System.ComponentModel.ProgressChangedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.ProgressDialog.ProgressChanged"/> event.
- </summary>
- <param name="e">The <see cref="T:System.ComponentModel.ProgressChangedEventArgs"/> containing data for the event.</param>
- </member>
- <member name="E:Ookii.Dialogs.ProgressDialog.DoWork">
- <summary>
- Event raised when the dialog is displayed.
- </summary>
- <remarks>
- Use this event to perform the operation that the dialog is showing the progress for.
- This event will be raised on a different thread than the UI thread.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.ProgressDialog.RunWorkerCompleted">
- <summary>
- Event raised when the operation completes.
- </summary>
- </member>
- <member name="E:Ookii.Dialogs.ProgressDialog.ProgressChanged">
- <summary>
- Event raised when <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String,System.Object)"/> is called.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.WindowTitle">
- <summary>
- Gets or sets the text in the progress dialog's title bar.
- </summary>
- <value>
- The text in the progress dialog's title bar. The default value is an empty string.
- </value>
- <remarks>
- <para>
- This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
- no effect while the dialog is being displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.Text">
- <summary>
- Gets or sets a short description of the operation being carried out.
- </summary>
- <value>
- A short description of the operation being carried. The default value is an empty string.
- </value>
- <remarks>
- <para>
- This is the primary message to the user.
- </para>
- <para>
- This property can be changed while the dialog is running, but may only be changed from the thread which
- created the progress dialog. The recommended method to change this value while the dialog is running
- is to use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.UseCompactPathsForText">
- <summary>
- Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.ProgressDialog.Text"/> property should be compacted if
- they are too large to fit on one line.
- </summary>
- <value>
- <see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,
- <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- <remarks>
- <note>
- This property requires Windows Vista or later. On older versions of Windows, it has no effect.
- </note>
- <para>
- This property can be changed while the dialog is running, but may only be changed from the thread which
- created the progress dialog.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.Description">
- <summary>
- Gets or sets additional details about the operation being carried out.
- </summary>
- <value>
- Additional details about the operation being carried out. The default value is an empty string.
- </value>
- <remarks>
- This text is used to provide additional details beyond the <see cref="P:Ookii.Dialogs.ProgressDialog.Text"/> property.
- </remarks>
- <remarks>
- <para>
- This property can be changed while the dialog is running, but may only be changed from the thread which
- created the progress dialog. The recommended method to change this value while the dialog is running
- is to use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.UseCompactPathsForDescription">
- <summary>
- Gets or sets a value that indicates whether path strings in the <see cref="P:Ookii.Dialogs.ProgressDialog.Description"/> property should be compacted if
- they are too large to fit on one line.
- </summary>
- <value>
- <see langword="true"/> to compact path strings if they are too large to fit on one line; otherwise,
- <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- <remarks>
- <note>
- This property requires Windows Vista or later. On older versions of Windows, it has no effect.
- </note>
- <para>
- This property can be changed while the dialog is running, but may only be changed from the thread which
- created the progress dialog.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.CancellationText">
- <summary>
- Gets or sets the text that will be shown after the Cancel button is pressed.
- </summary>
- <value>
- The text that will be shown after the Cancel button is pressed.
- </value>
- <remarks>
- <para>
- This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
- no effect while the dialog is being displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.ShowTimeRemaining">
- <summary>
- Gets or sets a value that indicates whether an estimate of the remaining time will be shown.
- </summary>
- <value>
- <see langword="true"/> if an estimate of remaining time will be shown; otherwise, <see langword="false"/>. The
- default value is <see langword="false"/>.
- </value>
- <remarks>
- <para>
- This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
- no effect while the dialog is being displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.ShowCancelButton">
- <summary>
- Gets or sets a value that indicates whether the dialog has a cancel button.
- </summary>
- <value>
- <see langword="true"/> if the dialog has a cancel button; otherwise, <see langword="false"/>. The default
- value is <see langword="true"/>.
- </value>
- <remarks>
- <note>
- This property requires Windows Vista or later; on older versions of Windows, the cancel button will always
- be displayed.
- </note>
- <para>
- The event handler for the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event must periodically check the value of the
- <see cref="P:Ookii.Dialogs.ProgressDialog.CancellationPending"/> property to see if the operation has been cancelled if this
- property is <see langword="true"/>.
- </para>
- <para>
- Setting this property to <see langword="false"/> is not recommended unless absolutely necessary.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.MinimizeBox">
- <summary>
- Gets or sets a value that indicates whether the progress dialog has a minimize button.
- </summary>
- <value>
- <see langword="true"/> if the dialog has a minimize button; otherwise, <see langword="false"/>. The default
- value is <see langword="true"/>.
- </value>
- <remarks>
- <note>
- This property has no effect on modal dialogs (which do not have a minimize button). It only applies
- to modeless dialogs shown by using the <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> method.
- </note>
- <para>
- This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
- no effect while the dialog is being displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.CancellationPending">
- <summary>
- Gets a value indicating whether the user has requested cancellation of the operation.
- </summary>
- <value>
- <see langword="true"/> if the user has cancelled the progress dialog; otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- <remarks>
- The event handler for the <see cref="E:Ookii.Dialogs.ProgressDialog.DoWork"/> event must periodically check this property and abort the operation
- if it returns <see langword="true"/>.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.Animation">
- <summary>
- Gets or sets the animation to show on the progress dialog.
- </summary>
- <value>
- An instance of <see cref="T:Ookii.Dialogs.AnimationResource"/> which specifies the animation to show, or <see langword="null"/>
- to show no animation. The default value is <see langword="null"/>.
- </value>
- <remarks>
- <para>
- This property has no effect on Windows Vista or later. On Windows XP, this property will default to
- a flying papers animation.
- </para>
- <para>
- This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
- no effect while the dialog is being displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.ProgressBarStyle">
- <summary>
- Gets or sets a value that indicates whether a regular or marquee style progress bar should be used.
- </summary>
- <value>
- One of the values of <see cref="T:Ookii.Dialogs.ProgressBarStyle"/>.
- The default value is <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>.
- </value>
- <remarks>
- <note>
- Operating systems older than Windows Vista do not support marquee progress bars on the progress dialog. On those operating systems, the
- progress bar will be hidden completely if this property is <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>.
- </note>
- <para>
- When this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar"/>, use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32)"/> method to set
- the value of the progress bar. When this property is set to <see cref="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar"/>
- you can still use the <see cref="M:Ookii.Dialogs.ProgressDialog.ReportProgress(System.Int32,System.String,System.String)"/> method to update the text of the dialog,
- but the percentage will be ignored.
- </para>
- <para>
- This property must be set before <see cref="M:Ookii.Dialogs.ProgressDialog.ShowDialog"/> or <see cref="M:Ookii.Dialogs.ProgressDialog.Show"/> is called. Changing property has
- no effect while the dialog is being displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.ProgressDialog.IsBusy">
- <summary>
- Gets a value that indicates whether the <see cref="T:Ookii.Dialogs.ProgressDialog"/> is running an asynchronous operation.
- </summary>
- <value>
- <see langword="true"/> if the <see cref="T:Ookii.Dialogs.ProgressDialog"/> is running an asynchronous operation;
- otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements">
- <summary>
- Contains classes that provide additional visual style elements not available through the regular
- <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> class.
- </summary>
- <threadsafety instance="false" static="false"/>
- </member>
- <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle">
- <summary>
- Provides <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> objects for
- text styles.
- </summary>
- <remarks>
- <note>
- Use of these styles requires Windows Vista or a newer version of Windows.
- </note>
- </remarks>
- <threadsafety instance="false" static="false"/>
- </member>
- <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle.MainInstruction">
- <summary>
- Gets a visual style element that represents the main instruction in a dialog box.
- </summary>
- <value>
- A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the main instruction.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TextStyle.BodyText">
- <summary>
- Gets a visual style element that represents the body text in a dialog box.
- </summary>
- <value>
- A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the body text.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog">
- <summary>
- Provides <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> objects
- for task dialog related elements.
- </summary>
- <remarks>
- <note>
- Use of these styles requires Windows Vista or a newer version of Windows.
- </note>
- </remarks>
- <threadsafety instance="false" static="false"/>
- </member>
- <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog.PrimaryPanel">
- <summary>
- Gets a visual style element that represents the primary panel of a task dialog.
- </summary>
- <value>
- A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the primary panel.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.AdditionalVisualStyleElements.TaskDialog.SecondaryPanel">
- <summary>
- Gets a visual style element that represents the secondary panel of a task dialog.
- </summary>
- <value>
- A <see cref="T:System.Windows.Forms.VisualStyles.VisualStyleElement"/> representing the style for the secondary panel.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogItem">
- <summary>
- Represents a button or radio button on a task dialog.
- </summary>
- <threadsafety instance="false" static="true" />
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogItem.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItem.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItem.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItem.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItem.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> class with the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> to.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItem.Click">
- <summary>
- Simulates a click on the task dialog item.
- </summary>
- <remarks>
- This method is available only while the task dialog is being displayed. You would typically call
- it from one of the events fired by the <see cref="T:Ookii.Dialogs.TaskDialog"/> class while the dialog is visible.
- </remarks>
- <exception cref="T:System.InvalidOperationException">
- <para>The task dialog is not being displayed</para>
- <para>-or-</para>
- <para>The item has no associated task dialog.</para>
- </exception>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItem.UpdateOwner">
- <summary>
- Causes a full update of the owner dialog.
- </summary>
- <remarks>
- <para>
- When this method is called, the owner dialog will be updated to reflect the
- current state of the object.
- </para>
- <para>
- When the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> has no owner, or the owner is not being
- displayed, this method has no effect.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogItem.Owner">
- <summary>
- Gets the <see cref="T:Ookii.Dialogs.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.TaskDialogItem"/>.
- </summary>
- <value>
- The <see cref="T:Ookii.Dialogs.TaskDialog"/> that owns this <see cref="T:Ookii.Dialogs.TaskDialogItem"/>.
- </value>
- <remarks>
- This property is set automatically when the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is added
- to the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> or <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/>
- collection of a <see cref="T:Ookii.Dialogs.TaskDialog"/>.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogItem.Text">
- <summary>
- Gets or sets the text of the item.
- </summary>
- <value>
- The text of the item. The default value is an empty string ("").
- </value>
- <remarks>
- <para>
- For buttons, this property is ignored if <see cref="P:Ookii.Dialogs.TaskDialogButton.ButtonType"/> is any value other
- than <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogItem.Enabled">
- <summary>
- Gets or sets a value that indicates whether the item is enabled.
- </summary>
- <value>
- <see langword="true" /> if this item is enabled; otherwise, <see langword="false" />.
- </value>
- <remarks>
- If a button or radio button is not enabled, it will be grayed out and cannot be
- selected or clicked.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogItem.Id">
- <summary>
- Gets or sets the ID of the item.
- </summary>
- <value>
- The unique identifier of the item.
- </value>
- <remarks>
- <para>
- The identifier of an item must be unique for the type of item on the task dialog (i.e. no two
- buttons can have the same id, no two radio buttons can have the same id, but a radio button
- can have the same id as a button).
- </para>
- <para>
- If this property is zero when the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is added to the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/>
- or <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/> collection of a task dialog, it will automatically be set
- to the next available id value.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogItem.ItemCollection">
- <summary>
- When implemented in a derived class, gets the item collection on a task dialog that this type of item is
- part of.
- </summary>
- <value>
- For <see cref="T:Ookii.Dialogs.TaskDialogButton"/> items, the <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/>
- collection of the <see cref="T:Ookii.Dialogs.TaskDialog"/> instance this item is part of. For <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> items, the <see cref="P:Ookii.Dialogs.TaskDialog.RadioButtons"/>
- collection of the <see cref="T:Ookii.Dialogs.TaskDialog"/> instance this item is part of. If the <see cref="T:Ookii.Dialogs.TaskDialogItem"/> is not
- currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, <see langword="null"/>.
- </value>
- <remarks>
- The collection returned by this property is used to determine if there are any items with duplicate IDs.
- </remarks>
- </member>
- <member name="T:Ookii.Dialogs.ProgressBarStyle">
- <summary>
- Indicates the type of progress on a task dialog.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ProgressBarStyle.None">
- <summary>
- No progress bar is displayed on the dialog.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ProgressBarStyle.ProgressBar">
- <summary>
- A regular progress bar is displayed on the dialog.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ProgressBarStyle.MarqueeProgressBar">
- <summary>
- A marquee progress bar is displayed on the dialog. Use this value for operations
- that cannot report concrete progress information.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.OkButtonClickedEventArgs">
- <summary>
- Provides data for the <see cref="E:Ookii.Dialogs.InputDialog.OkButtonClicked"/> event.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.OkButtonClickedEventArgs.#ctor(System.String,System.Windows.Forms.IWin32Window)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.OkButtonClickedEventArgs"/> class with the specified input text
- and input box window.
- </summary>
- <param name="input">The current value of the input field on the dialog.</param>
- <param name="inputBoxWindow">The input box window.</param>
- </member>
- <member name="P:Ookii.Dialogs.OkButtonClickedEventArgs.Input">
- <summary>
- Gets the current value of the input field on the dialog.
- </summary>
- <value>
- The current value of the input field on the dialog.
- </value>
- <remarks>
- The <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property will not be updated until the dialog has been closed,
- so this property can be used to determine the value entered by the user when this event is raised.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.OkButtonClickedEventArgs.InputBoxWindow">
- <summary>
- Gets the input box window.
- </summary>
- <value>
- The <see cref="T:System.Windows.Forms.IWin32Window"/> for the input box window.
- </value>
- <remarks>
- You can use this property if you need to display a modal dialog (for example to alert the user if the current input value
- is invalid) and you want the input box to be the parent of that dialog.
- </remarks>
- </member>
- <member name="T:Ookii.Dialogs.InputDialog">
- <summary>
- Represents a dialog that allows the user to input a single text value.
- </summary>
- <remarks>
- Using a modal dialog to ask the user for input is not often the best design decision. Carefully
- evaluate alternative methods, such as in-place editing, if applicable, before using this dialog.
- </remarks>
- <threadsafety instance="false" static="true" />
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.InputDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.InputDialog"/> class, adding it to the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.OnInputChanged(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.InputDialog.InputChanged"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.OnOkButtonClicked(Ookii.Dialogs.OkButtonClickedEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.InputDialog.OkButtonClicked"/> event.
- </summary>
- <param name="e">The <see cref="T:Ookii.Dialogs.OkButtonClickedEventArgs"/> containing data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.ShowDialog">
- <summary>
- Displays the input box as a modal dialog box.
- </summary>
- <returns>The <see cref="T:System.Windows.Forms.DialogResult"/> value that corresponds to the button the user clicked.</returns>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
- <summary>
- Displays the input box as a modal dialog box with the specified owner.
- </summary>
- <param name="owner">The <see cref="T:System.Windows.Forms.IWin32Window"/> that will be the owner of the dialog box.</param>
- <returns>The <see cref="T:System.Windows.Forms.DialogResult"/></returns>
- </member>
- <member name="F:Ookii.Dialogs.InputDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing"><see langword="true" /> if managed resources should be disposed; otherwise, <see langword="false" />.</param>
- </member>
- <member name="M:Ookii.Dialogs.InputDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="E:Ookii.Dialogs.InputDialog.InputChanged">
- <summary>
- Event raised when the value of the <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property changes.
- </summary>
- <remarks>
- The value of the <see cref="P:Ookii.Dialogs.InputDialog.Input"/> property is updated only when the user clicks OK and the dialog is closed, not while
- the user is using the dialog.
- </remarks>
- </member>
- <member name="E:Ookii.Dialogs.InputDialog.OkButtonClicked">
- <summary>
- Event raised when the user clicks the OK button on the dialog.
- </summary>
- <remarks>
- Set the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> property to <see langword="true"/> to prevent the dialog from closing.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.MainInstruction">
- <summary>
- Gets or sets the dialog's main instruction.
- </summary>
- <value>
- The dialog's main instruction. The default value is an empty string ("").
- </value>
- <remarks>
- When running on Windows Vista or newer, the main instruction of the input dialog will be displayed in a larger font and a different color than
- the other text of the input dialog. Otherwise, it will be shown in bold.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.Content">
- <summary>
- Gets or sets the dialog's primary content.
- </summary>
- <value>
- The dialog's primary content. The default value is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.WindowTitle">
- <summary>
- Gets or sets the window title of the dialog.
- </summary>
- <value>
- The window title of the dialog. The default is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.Input">
- <summary>
- Gets or sets the text specified by the user.
- </summary>
- <value>
- The initial text of the input field, or the text specified by the user. The default vaue is an empty string ("").
- </value>
- <remarks>
- Setting this property before calling <see cref="M:Ookii.Dialogs.InputDialog.ShowDialog"/> determines the initial text in the input field. Retrieving
- the property after the user has clicked OK will return the text entered by the user.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.MaxLength">
- <summary>
- Gets or sets the maximum number of characters that can be entered into the input field of the dialog.
- </summary>
- <value>
- The number of characters that can be entered into the input field. The default value is 32767.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.UsePasswordMasking">
- <summary>
- Gets or sets a value that indicates whether the input will be masked using the system password character.
- </summary>
- <value>
- <see langword="true" /> if the input is masked; otherwise, <see langword="false" />. The default value is <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.BindingContext">
- <summary>
- Gets or sets the collection of currency managers for the <see cref="T:Ookii.Dialogs.InputDialog"/>.
- </summary>
- <value>
- The collection of currency managers for the <see cref="T:Ookii.Dialogs.TaskDialog"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.InputDialog.DataBindings">
- <summary>
- Gets the collection of data-binding objects for this <see cref="T:Ookii.Dialogs.InputDialog"/>.
- </summary>
- <value>
- The collection of data-binding objects for this <see cref="T:Ookii.Dialogs.TaskDialog"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.CredentialException">
- <summary>
- The exception that is thrown when an error occurs getting credentials.
- </summary>
- <threadsafety instance="false" static="true" />
- </member>
- <member name="M:Ookii.Dialogs.CredentialException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with the specified error.
- </summary>
- <param name="error">The Win32 error code associated with this exception.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with a specified error message.
- </summary>
- <param name="message">The message that describes the error.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Int32,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with the specified error and the specified detailed description.
- </summary>
- <param name="error">The Win32 error code associated with this exception.</param>
- <param name="message">A detailed description of the error.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">A reference to the inner exception that is the cause of the current exception.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialException"/> class with serialized data.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Ookii.Dialogs.VistaOpenFileDialog">
- <summary>
- Prompts the user to open a file.
- </summary>
- <remarks>
- <para>
- This class will use the Vista style file dialog if possible, and automatically fall back to the old-style
- dialog on versions of Windows older than Vista.
- </para>
- <para>
- As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.OpenFileDialog"/> class will also use
- the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,
- still cause that class to revert to the old style dialogs. For this reason, this class is still provided.
- It is recommended that you use the <see cref="T:System.Windows.Forms.FileDialog"/> class whenever possible.
- </para>
- </remarks>
- <threadsafety static="true" instance="false"/>
- </member>
- <member name="T:Ookii.Dialogs.VistaFileDialog">
- <summary>
- Displays a dialog box from which the user can select a file.
- </summary>
- <remarks>
- <para>
- This class will use the Vista style file dialog if possible, and automatically fall back to the old-style
- dialog on versions of Windows older than Vista.
- </para>
- <para>
- As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.FileDialog"/> class will also use
- the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,
- still cause that class to revert to the old style dialogs. For this reason, this class is still provided.
- It is recommended that you use the <see cref="T:System.Windows.Forms.FileDialog"/> class whenever possible.
- </para>
- </remarks>
- <threadsafety static="true" instance="false"/>
- </member>
- <member name="M:Ookii.Dialogs.VistaFileDialog.#ctor">
- <summary>
- Creates a new insatnce of <see cref="T:Ookii.Dialogs.VistaFileDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaFileDialog.Reset">
- <summary>
- Resets all properties to their default values.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaFileDialog.RunDialog(System.IntPtr)">
- <summary>
- Specifies a common dialog box.
- </summary>
- <param name="hwndOwner">A value that represents the window handle of the owner window for the common dialog box.</param>
- <returns><see langword="true"/> if the file could be opened; otherwise, <see langword="false"/>.</returns>
- </member>
- <member name="M:Ookii.Dialogs.VistaFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.VistaFileDialog.FileOk"/> event.
- </summary>
- <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>
- </member>
- <member name="M:Ookii.Dialogs.VistaFileDialog.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:Ookii.Dialogs.VistaFileDialog"/> and optionally releases the managed resources.
- </summary>
- <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
- </member>
- <member name="E:Ookii.Dialogs.VistaFileDialog.FileOk">
- <summary>
- Occurs when the user clicks on the Open or Save button on a file dialog box.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.IsVistaFileDialogSupported">
- <summary>
- Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
- </summary>
- <value>
- <see langword="true"/> on Windows Vista or newer operating systems; otherwise, <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.AddExtension">
- <summary>
- Gets or sets a value indicating whether the dialog box automatically adds an extension to a file name
- if the user omits the extension.
- </summary>
- <value>
- <see langword="true"/> if the dialog box adds an extension to a file name if the user omits the extension; otherwise, <see langword="false"/>.
- The default value is <see langword="true"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.CheckFileExists">
- <summary>
- Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
- </summary>
- <value>
- <see langword="true"/> if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.CheckPathExists">
- <summary>
- Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a path that does not exist.
- </summary>
- <value>
- <see langword="true"/> if the dialog box displays a warning when the user specifies a path that does not exist; otherwise, <see langword="false"/>.
- The default value is <see langword="true"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.DefaultExt">
- <summary>
- Gets or sets the default file name extension.
- </summary>
- <value>
- The default file name extension. The returned string does not include the period. The default value is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.DereferenceLinks">
- <summary>
- Gets or sets a value indicating whether the dialog box returns the location of the file referenced by the shortcut
- or whether it returns the location of the shortcut (.lnk).
- </summary>
- <value>
- <see langword="true"/> if the dialog box returns the location of the file referenced by the shortcut; otherwise, <see langword="false"/>.
- The default value is <see langword="true"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.FileName">
- <summary>
- Gets or sets a string containing the file name selected in the file dialog box.
- </summary>
- <value>
- The file name selected in the file dialog box. The default value is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.FileNames">
- <summary>
- Gets the file names of all selected files in the dialog box.
- </summary>
- <value>
- An array of type String, containing the file names of all selected files in the dialog box.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.Filter">
- <summary>
- Gets or sets the current file name filter string, which determines the choices that appear in the
- "Save as file type" or "Files of type" box in the dialog box.
- </summary>
- <value>
- The file filtering options available in the dialog box.
- </value>
- <exception cref="T:System.ArgumentException">Filter format is invalid.</exception>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.FilterIndex">
- <summary>
- Gets or sets the index of the filter currently selected in the file dialog box.
- </summary>
- <value>
- A value containing the index of the filter currently selected in the file dialog box. The default value is 1.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.InitialDirectory">
- <summary>
- Gets or sets the initial directory displayed by the file dialog box.
- </summary>
- <value>
- The initial directory displayed by the file dialog box. The default is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.RestoreDirectory">
- <summary>
- Gets or sets a value indicating whether the dialog box restores the current directory before closing.
- </summary>
- <value>
- <see langword="true"/> if the dialog box restores the current directory to its original value if the user changed the
- directory while searching for files; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.ShowHelp">
- <summary>
- Gets or sets a value indicating whether the Help button is displayed in the file dialog box.
- </summary>
- <value>
- <see langword="true"/> if the dialog box includes a help button; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.Title">
- <summary>
- Gets or sets the file dialog box title.
- </summary>
- <value>
- The file dialog box title. The default value is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.SupportMultiDottedExtensions">
- <summary>
- Gets or sets whether the dialog box supports displaying and saving files that have multiple file name extensions.
- </summary>
- <value>
- <see langword="true"/> if the dialog box supports multiple file name extensions; otherwise, <see langword="false"/>. The default is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.ValidateNames">
- <summary>
- Gets or sets a value indicating whether the dialog box accepts only valid Win32 file names.
- </summary>
- <value>
- <see langword="true"/> if the dialog box accepts only valid Win32 file names; otherwise, <see langword="false"/>. The default value is <see langword="true"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFileDialog.DownlevelDialog">
- <summary>
- Gets or sets the downlevel file dialog which is to be used if the Vista-style
- dialog is not supported.
- </summary>
- <value>
- The downlevel file dialog which is to be used if the Vista-style
- dialog is not supported.
- </value>
- </member>
- <member name="M:Ookii.Dialogs.VistaOpenFileDialog.#ctor">
- <summary>
- Creates a new instance of <see cref="T:Ookii.Dialogs.VistaOpenFileDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaOpenFileDialog.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of <see cref="T:Ookii.Dialogs.VistaOpenFileDialog"/> class.
- </summary>
- <param name="forceDownlevel">When <see langword="true"/>, the old style common file dialog will always be used even if the OS supports the Vista style.</param>
- </member>
- <member name="M:Ookii.Dialogs.VistaOpenFileDialog.Reset">
- <summary>
- Resets all properties to their default values.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaOpenFileDialog.OpenFile">
- <summary>
- Opens the file selected by the user, with read-only permission. The file is specified by the FileName property.
- </summary>
- <returns>A Stream that specifies the read-only file selected by the user.</returns>
- <exception cref="T:System.ArgumentNullException">The file name is <see langword="null"/>.</exception>
- </member>
- <member name="P:Ookii.Dialogs.VistaOpenFileDialog.CheckFileExists">
- <summary>
- Gets or sets a value indicating whether the dialog box displays a warning if the user specifies a file name that does not exist.
- </summary>
- <value>
- <see langword="true"/> if the dialog box displays a warning if the user specifies a file name that does not exist; otherwise, <see langword="false"/>. The default value is <see langword="true"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaOpenFileDialog.Multiselect">
- <summary>
- Gets or sets a value indicating whether the dialog box allows multiple files to be selected.
- </summary>
- <value>
- <see langword="true"/> if the dialog box allows multiple files to be selected together or concurrently; otherwise, <see langword="false"/>.
- The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaOpenFileDialog.ShowReadOnly">
- <summary>
- Gets or sets a value indicating whether the dialog box contains a read-only check box.
- </summary>
- <value>
- <see langword="true"/> if the dialog box contains a read-only check box; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- <remarks>
- If the Vista style dialog is used, this property can only be used to determine whether the user chose
- Open as read-only on the dialog; setting it in code will have no effect.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.VistaOpenFileDialog.ReadOnlyChecked">
- <summary>
- Gets or sets a value indicating whether the read-only check box is selected.
- </summary>
- <value>
- <see langword="true"/> if the read-only check box is selected; otherwise, <see langword="false"/>. The default value is <see langword="false"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.TimerEventArgs">
- <summary>
- Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.Timer"/> event.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.TimerEventArgs.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TimerEventArgs"/> class with the specified tick count.
- </summary>
- <param name="tickCount">The tick count.</param>
- </member>
- <member name="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount">
- <summary>
- Gets or sets a value that indicates whether the tick count should be reset.
- </summary>
- <value>
- <see langword="true" /> to reset the tick count after the event handler returns; otherwise, <see langword="false" />.
- The default value is <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TimerEventArgs.TickCount">
- <summary>
- Gets the current tick count of the timer.
- </summary>
- <value>
- The number of milliseconds that has elapsed since the dialog was created or since the last time the event handler returned
- with the <see cref="P:Ookii.Dialogs.TimerEventArgs.ResetTickCount"/> property set to <see langword="true"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs">
- <summary>
- Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.ButtonClicked"/> event.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogItemClickedEventArgs.#ctor(Ookii.Dialogs.TaskDialogItem)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogItemClickedEventArgs"/> class with the specified item.
- </summary>
- <param name="item">The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> that was clicked.</param>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogItemClickedEventArgs.Item">
- <summary>
- Gets the item that was clicked.
- </summary>
- <value>
- The <see cref="T:Ookii.Dialogs.TaskDialogItem"/> that was clicked.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogButton">
- <summary>
- A button on a <see cref="T:Ookii.Dialogs.TaskDialog"/>.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(Ookii.Dialogs.ButtonType)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified button type.
- </summary>
- <param name="type">The type of the button.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> to.</param>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogButton.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> class with the specified text.
- </summary>
- <param name="text">The text of the button.</param>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogButton.ButtonType">
- <summary>
- Gets or sets the type of the button.
- </summary>
- <value>
- One of the <see cref="T:Ookii.Dialogs.ButtonType"/> values that indicates the type of the button. The default value
- is <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogButton.CommandLinkNote">
- <summary>
- Gets or sets the text of the note associated with a command link button.
- </summary>
- <value>
- The text of the note associated with a command link button.
- </value>
- <remarks>
- <para>
- This property applies only to buttons where the <see cref="T:System.Type"/> property
- is <see cref="F:Ookii.Dialogs.ButtonType.Custom"/>. For other button types, it is ignored.
- </para>
- <para>
- In addition, it is used only if the <see cref="P:Ookii.Dialogs.TaskDialog.ButtonStyle"/> property is set to
- <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks"/> or <see cref="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon"/>;
- otherwise, it is ignored.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogButton.Default">
- <summary>
- Gets or sets a value that indicates if the button is the default button on the dialog.
- </summary>
- <value><see langword="true" /> if the button is the default button; otherwise, <see langword="false" />.
- The default value is <see langword="false" />.</value>
- <remarks>
- If no button has this property set to <see langword="true" />, the first button on the dialog will be the default button.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogButton.ElevationRequired">
- <summary>
- Gets or sets a value that indicates whether the Task Dialog button or command link should have a
- User Account Control (UAC) shield icon (in other words, whether the action invoked by the
- button requires elevation).
- </summary>
- <value>
- <see langword="true" /> if the button contains a UAC shield icon; otherwise, <see langword="false" />.
- </value>
- <remarks>
- Elevation is not performed by the task dialog; the code implementing the operation that results from
- the button being clicked is responsible for performing elevation if required.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogButton.ItemCollection">
- <summary>
- Gets the collection that items of this type are part of.
- </summary>
- <value>
- If the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, the
- <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.TaskDialog"/>; otherwise, <see langword="null"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.Properties.Resources">
- <summary>
- A strongly-typed resource class, for looking up localized strings, etc.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.ResourceManager">
- <summary>
- Returns the cached ResourceManager instance used by this class.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.Culture">
- <summary>
- Overrides the current thread's CurrentUICulture property for all
- resource lookups using this strongly typed resource class.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.AnimationLoadErrorFormat">
- <summary>
- Looks up a localized string similar to Unable to load the progress dialog animation: {0}.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.CredentialEmptyTargetError">
- <summary>
- Looks up a localized string similar to The credential target may not be an empty string..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.CredentialError">
- <summary>
- Looks up a localized string similar to An error occurred acquiring credentials..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.CredentialPromptNotCalled">
- <summary>
- Looks up a localized string similar to PromptForCredentialsWithSave has not been called or the credentials were modified after the call..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.DuplicateButtonTypeError">
- <summary>
- Looks up a localized string similar to The task dialog already has a non-custom button with the same type..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.DuplicateItemIdError">
- <summary>
- Looks up a localized string similar to The task dialog already has an item with the same id..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.FileNotFoundFormat">
- <summary>
- Looks up a localized string similar to The file "{0}" could not be found..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.GlassNotSupportedError">
- <summary>
- Looks up a localized string similar to The current operating system does not support glass, or the Desktop Window Manager is not enabled..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.Help">
- <summary>
- Looks up a localized string similar to Help.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.InvalidFilterString">
- <summary>
- Looks up a localized string similar to Invalid filter string,.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.InvalidTaskDialogItemIdError">
- <summary>
- Looks up a localized string similar to The id of a task dialog item must be higher than 0..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.NoAssociatedTaskDialogError">
- <summary>
- Looks up a localized string similar to The item is not associated with a task dialog..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.NonCustomTaskDialogButtonIdError">
- <summary>
- Looks up a localized string similar to Cannot change the id for a standard button..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.Preview">
- <summary>
- Looks up a localized string similar to Preview.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.ProgressDialogNotRunningError">
- <summary>
- Looks up a localized string similar to The progress dialog is not shown..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.ProgressDialogRunning">
- <summary>
- Looks up a localized string similar to The progress dialog is already running..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogEmptyButtonLabelError">
- <summary>
- Looks up a localized string similar to A custom button or radio button cannot have an empty label..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogIllegalCrossThreadCallError">
- <summary>
- Looks up a localized string similar to Cross-thread operation not valid: Task dialog accessed from a thread other than the thread it was created on while it is visible..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogItemHasOwnerError">
- <summary>
- Looks up a localized string similar to The task dialog item already belongs to another task dialog..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogNoButtonsError">
- <summary>
- Looks up a localized string similar to The task dialog must have buttons..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogNotRunningError">
- <summary>
- Looks up a localized string similar to The task dialog is not current displayed..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogRunningError">
- <summary>
- Looks up a localized string similar to The task dialog is already being displayed..
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.Properties.Resources.TaskDialogsNotSupportedError">
- <summary>
- Looks up a localized string similar to The operating system does not support task dialogs..
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.Glass">
- <summary>
- Provides functionality to use Aero Glass.
- </summary>
- <remarks>
- <para>
- This class provides functionality to extend the Windows Vista Aero glass window frame into a window's
- client area, and to draw text on the glass area.
- </para>
- <para>
- The <see cref="T:Ookii.Dialogs.ExtendedForm"/> class provides more comprehensive support for client area glass than
- using <see cref="M:Ookii.Dialogs.Glass.ExtendFrameIntoClientArea(System.Windows.Forms.IWin32Window,System.Windows.Forms.Padding)"/> by using its <see cref="P:Ookii.Dialogs.ExtendedForm.GlassMargin"/> property.
- In addition to the basic client area glass support, <see cref="T:Ookii.Dialogs.ExtendedForm"/> will also
- respond to changes in the Desktop Window Manager state and enable/disable client area glass as necessary. It also
- allows the window to be dragged using the client area glass areas using the <see cref="P:Ookii.Dialogs.ExtendedForm.AllowGlassDragging"/>
- property.
- </para>
- <note>
- Use of glass requires Windows Vista or later with the Desktop Window Manager enabled.
- </note>
- </remarks>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.Glass.ExtendFrameIntoClientArea(System.Windows.Forms.IWin32Window,System.Windows.Forms.Padding)">
- <summary>
- Extends the glass window frame into the client area of the specified window.
- </summary>
- <param name="window">The <see cref="T:System.Windows.Forms.IWin32Window"/> on which to enable client area glass.</param>
- <param name="glassMargin">The the margins to use when extending the frame into the client area.</param>
- <remarks>
- <para>
- Use negative margins to create the "sheet of glass" effect where the client area is rendered
- as a completely glass surface.
- </para>
- <para>
- The glass area must be filled with either a black brush or the <see cref="P:System.Windows.Forms.Form.TransparencyKey"/> color
- in order to display correctly. If the <see cref="P:System.Windows.Forms.Form.TransparencyKey"/> method is used, clicks in the
- glass area will "fall through" the window to the window below it. If the black brush method is used, text
- rendered with the <see cref="T:System.Windows.Forms.TextRenderer"/> will not display correctly on the glass area (this includes
- text drawn by most controls). To draw text on the glass area, use <see cref="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)"/>.
- </para>
- <para>
- This method needs to be called again if the state of the Desktop Window Manager is toggled.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="window"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>
- </member>
- <member name="M:Ookii.Dialogs.Glass.DrawCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Drawing.Rectangle,System.Windows.Forms.Padding,System.Drawing.Color,System.Int32,System.Windows.Forms.TextFormatFlags)">
- <summary>
- Draws composited text onto the glass area of a form.
- </summary>
- <param name="dc">The <see cref="T:System.Drawing.IDeviceContext"/> onto which the composited text should be drawn.</param>
- <param name="text">The text to draw.</param>
- <param name="font">The <see cref="T:System.Drawing.Font"/> to apply to the drawn text.</param>
- <param name="bounds">The <see cref="T:System.Drawing.Rectangle"/> that represents the bounds of the text.</param>
- <param name="padding">The <see cref="T:System.Windows.Forms.Padding"/> around the text; necessary to allow space for the glow effect.</param>
- <param name="foreColor">The <see cref="T:System.Drawing.Color"/> to apply to the drawn text.</param>
- <param name="textFormat">A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags"/> values.</param>
- <param name="glowSize">Specifies the size of a glow that will be drawn on the background prior to any text being drawn.</param>
- <remarks>
- <para>
- Do not use this method to draw text on non-glass areas of a form.
- </para>
- </remarks>
- <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="dc"/>, <paramref name="text"/> or <paramref name="font"/> is <see langword="null"/>.</exception>
- </member>
- <member name="M:Ookii.Dialogs.Glass.MeasureCompositedText(System.Drawing.IDeviceContext,System.String,System.Drawing.Font,System.Windows.Forms.TextFormatFlags)">
- <summary>
- Provides the size, in pixels, of the specified text.
- </summary>
- <param name="dc">The device context in which to measure the text.</param>
- <param name="text">The text to measure.</param>
- <param name="font">The <see cref="T:System.Drawing.Font"/> to apply to the measured text.</param>
- <param name="textFormat">A bitwise combination of the <see cref="T:System.Windows.Forms.TextFormatFlags"/> values.</param>
- <returns>The <see cref="T:System.Drawing.Size"/>, in pixels, of <paramref name="text"/> drawn with the specified <paramref name="font"/> and format.</returns>
- <exception cref="T:System.NotSupportedException">The current operating system does not support glass, or the Desktop Window Manager is not enabled.</exception>
- <exception cref="T:System.ArgumentNullException"><paramref name="dc"/>, <paramref name="text"/> or <paramref name="font"/> is <see langword="null"/>.</exception>
- </member>
- <member name="P:Ookii.Dialogs.Glass.OSSupportsDwmComposition">
- <summary>
- Gets a value that indicates whether the operating system supports composition through the Desktop Window Manager.
- </summary>
- <value>
- <see langword="true" /> on operating systems that support the Desktop Window Manager (Windows Vista and higher); otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.Glass.IsDwmCompositionEnabled">
- <summary>
- Gets a value that indicates whether desktop composition is enabled.
- </summary>
- <value>
- <see langword="true" /> when desktop composition is supported and enabled; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.CredentialDialog">
- <summary>
- Represents a dialog box that allows the user to enter generic credentials.
- </summary>
- <remarks>
- <para>
- This class is meant for generic credentials; it does not provide access to all the functionality
- of the Windows CredUI API. Features such as Windows domain credentials or alternative security
- providers (e.g. smartcards or biometric devices) are not supported.
- </para>
- <para>
- The <see cref="T:Ookii.Dialogs.CredentialDialog"/> class provides methods for storing and retrieving credentials,
- and also manages automatic persistence of credentials by using the "Save password" checkbox on
- the credentials dialog. To specify the target for which the credentials should be saved, set the
- <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> property.
- </para>
- <note>
- This class requires Windows XP or later.
- </note>
- </remarks>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="F:Ookii.Dialogs.CredentialDialog.components">
- <summary>
- Required designer variable.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.Dispose(System.Boolean)">
- <summary>
- Clean up any resources being used.
- </summary>
- <param name="disposing"><see langword="true"/> if managed resources should be disposed; otherwise, <see langword="false"/>.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.InitializeComponent">
- <summary>
- Required method for Designer support - do not modify
- the contents of this method with the code editor.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class with the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the component to.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.ShowDialog">
- <summary>
- Shows the credentials dialog as a modal dialog.
- </summary>
- <returns><see cref="F:System.Windows.Forms.DialogResult.OK"/> if the user clicked OK; otherwise, <see cref="F:System.Windows.Forms.DialogResult.Cancel"/>.</returns>
- <remarks>
- <para>
- The credentials dialog will not be shown if one of the following conditions holds:
- </para>
- <list type="bullet">
- <item>
- <description>
- <see cref="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
- credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>
- is <see langword="true"/>.
- </description>
- </item>
- <item>
- <description>
- <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="false"/>, and the operating system credential store
- for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>.
- </description>
- </item>
- </list>
- <para>
- In these cases, the <see cref="P:Ookii.Dialogs.CredentialDialog.Credentials"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> properties will
- be set to the saved credentials and this function returns immediately, returning <see cref="F:System.Windows.Forms.DialogResult.OK"/>.
- </para>
- <para>
- If the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>, you should call <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/>
- after validating if the provided credentials are correct.
- </para>
- </remarks>
- <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred while showing the credentials dialog.</exception>
- <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> is an empty string ("").</exception>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.ShowDialog(System.Windows.Forms.IWin32Window)">
- <summary>
- Shows the credentials dialog as a modal dialog with the specified owner.
- </summary>
- <param name="owner">The <see cref="T:System.Windows.Forms.IWin32Window"/> that owns the credentials dialog.</param>
- <returns><see cref="F:System.Windows.Forms.DialogResult.OK"/> if the user clicked OK; otherwise, <see cref="F:System.Windows.Forms.DialogResult.Cancel"/>.</returns>
- <remarks>
- <para>
- The credentials dialog will not be shown if one of the following conditions holds:
- </para>
- <list type="bullet">
- <item>
- <description>
- <see cref="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache"/> is <see langword="true"/> and the application instance
- credential cache contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>, even if <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>
- is <see langword="true"/>.
- </description>
- </item>
- <item>
- <description>
- <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="false"/>, and the operating system credential store
- for the current user contains credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/>.
- </description>
- </item>
- </list>
- <para>
- In these cases, the <see cref="P:Ookii.Dialogs.CredentialDialog.Credentials"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> properties will
- be set to the saved credentials and this function returns immediately, returning <see cref="F:System.Windows.Forms.DialogResult.OK"/>.
- </para>
- <para>
- If the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>, you should call <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/>
- after validating if the provided credentials are correct.
- </para>
- </remarks>
- <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred while showing the credentials dialog.</exception>
- <exception cref="T:System.InvalidOperationException"><see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> is an empty string ("").</exception>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)">
- <summary>
- Confirms the validity of the credential provided by the user.
- </summary>
- <param name="confirm"><see langword="true"/> if the credentials that were specified on the dialog are valid; otherwise, <see langword="false"/>.</param>
- <remarks>
- Call this function after calling <see cref="M:Ookii.Dialogs.CredentialDialog.ShowDialog"/> when <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> is <see langword="true"/>.
- Only when this function is called with <paramref name="confirm"/> set to <see langword="true"/> will the credentials be
- saved in the credentials store and/or the application instance credential cache.
- </remarks>
- <exception cref="T:System.InvalidOperationException"><see cref="M:Ookii.Dialogs.CredentialDialog.ShowDialog"/> was not called, or the user did not click OK, or <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> was <see langword="false"/>
- at the call, or the value of <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> or <see cref="P:Ookii.Dialogs.CredentialDialog.IsSaveChecked"/>
- was changed after the call.</exception>
- <exception cref="T:Ookii.Dialogs.CredentialException">There was an error saving the credentials.</exception>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.StoreCredential(System.String,System.Net.NetworkCredential)">
- <summary>
- Stores the specified credentials in the operating system's credential store for the currently logged on user.
- </summary>
- <param name="target">The target name for the credentials.</param>
- <param name="credential">The credentials to store.</param>
- <exception cref="T:System.ArgumentNullException">
- <para>
- <paramref name="target"/> is <see langword="null"/>.
- </para>
- <para>
- -or-
- </para>
- <para>
- <paramref name="credential"/> is <see langword="null"/>.
- </para>
- </exception>
- <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
- <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred storing the credentials.</exception>
- <remarks>
- <note>
- The <see cref="P:System.Net.NetworkCredential.Domain"/> property is ignored and will not be stored, even if it is
- not <see langword="null"/>.
- </note>
- <para>
- If the credential manager already contains credentials for the specified <paramref name="target"/>, they
- will be overwritten; this can even overwrite credentials that were stored by another application. Therefore
- it is strongly recommended that you prefix the target name to ensure uniqueness, e.g. using the
- form "Company_ApplicationName_www.example.com".
- </para>
- </remarks>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.RetrieveCredential(System.String)">
- <summary>
- Retrieves credentials for the specified target from the operating system's credential store for the current user.
- </summary>
- <param name="target">The target name for the credentials.</param>
- <returns>The credentials if they were found; otherwise, <see langword="null"/>.</returns>
- <remarks>
- <para>
- If the requested credential was not originally stored using the <see cref="T:Ookii.Dialogs.CredentialDialog"/> class (but e.g. by
- another application), the password may not be decoded correctly.
- </para>
- <para>
- This function does not check the application instance credential cache for the credentials; for that you can use
- the <see cref="M:Ookii.Dialogs.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)"/> function.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
- <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred retrieving the credentials.</exception>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.RetrieveCredentialFromApplicationInstanceCache(System.String)">
- <summary>
- Tries to get the credentials for the specified target from the application instance credential cache.
- </summary>
- <param name="target">The target for the credentials, typically a server name.</param>
- <returns>The credentials that were found in the application instance cache; otherwise, <see langword="null"/>.</returns>
- <remarks>
- <para>
- This function will only check the the application instance credential cache; the operating system's credential store
- is not checked. To retrieve credentials from the operating system's store, use <see cref="M:Ookii.Dialogs.CredentialDialog.RetrieveCredential(System.String)"/>.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.DeleteCredential(System.String)">
- <summary>
- Deletes the credentials for the specified target.
- </summary>
- <param name="target">The name of the target for which to delete the credentials.</param>
- <returns><see langword="true"/> if the credential was deleted from either the application instance cache or
- the operating system's store; <see langword="false"/> if no credentials for the specified target could be found
- in either store.</returns>
- <remarks>
- <para>
- The credentials for the specified target will be removed from the application instance credential cache
- and the operating system's credential store.
- </para>
- </remarks>
- <exception cref="T:System.ArgumentNullException"><paramref name="target"/> is <see langword="null"/>.</exception>
- <exception cref="T:System.ArgumentException"><paramref name="target"/> is an empty string ("").</exception>
- <exception cref="T:Ookii.Dialogs.CredentialException">An error occurred deleting the credentials from the operating system's credential store.</exception>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.OnUserNameChanged(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.CredentialDialog.UserNameChanged"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
- </member>
- <member name="M:Ookii.Dialogs.CredentialDialog.OnPasswordChanged(System.EventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.CredentialDialog.PasswordChanged"/> event.
- </summary>
- <param name="e">The <see cref="T:System.EventArgs"/> containing data for the event.</param>
- </member>
- <member name="E:Ookii.Dialogs.CredentialDialog.UserNameChanged">
- <summary>
- Event raised when the <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/> property changes.
- </summary>
- </member>
- <member name="E:Ookii.Dialogs.CredentialDialog.PasswordChanged">
- <summary>
- Event raised when the <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/> property changes.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache">
- <summary>
- Gets or sets whether to use the application instance credential cache.
- </summary>
- <value>
- <see langword="true"/> when credentials are saved in the application instance cache; <see langref="false"/> if they are not.
- The default value is <see langword="false"/>.
- </value>
- <remarks>
- <para>
- The application instance credential cache stores credentials in memory while an application is running. When the
- application exits, this cache is not persisted.
- </para>
- <para>
- When the <see cref="P:Ookii.Dialogs.CredentialDialog.UseApplicationInstanceCredentialCache"/> property is set to <see langword="true"/>, credentials that
- are confirmed with <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/> when the user checked the "save password" option will be stored
- in the application instance cache as well as the operating system credential store.
- </para>
- <para>
- When <see cref="M:Ookii.Dialogs.CredentialDialog.ShowDialog"/> is called, and credentials for the specified <see cref="P:Ookii.Dialogs.CredentialDialog.Target"/> are already present in
- the application instance cache, the dialog will not be shown and the cached credentials are returned, even if
- <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/> is <see langword="true"/>.
- </para>
- <para>
- The application instance credential cache allows you to prevent prompting the user again for the lifetime of the
- application if the "save password" checkbox was checked, but when the application is restarted you can prompt again
- (initializing the dialog with the saved credentials). To get this behaviour, the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/>
- property must be set to <see langword="true"/>.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.IsSaveChecked">
- <summary>
- Gets or sets whether the "save password" checkbox is checked.
- </summary>
- <value>
- <see langword="true" /> if the "save password" is checked; otherwise, <see langword="false" />.
- The default value is <see langword="false" />.
- </value>
- <remarks>
- The value of this property is only valid if the dialog box is displayed with a save checkbox.
- Set this property before showing the dialog to determine the initial checked value of the save checkbox.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.Password">
- <summary>
- Gets the password the user entered in the dialog.
- </summary>
- <value>
- The password entered in the password field of the credentials dialog.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.Credentials">
- <summary>
- Gets the user-specified user name and password in a <see cref="T:System.Net.NetworkCredential"/> object.
- </summary>
- <value>
- A <see cref="T:System.Net.NetworkCredential"/> instance containing the user name and password specified on the dialog.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.UserName">
- <summary>
- Gets the user name the user entered in the dialog.
- </summary>
- <value>
- The user name entered in the user name field of the credentials dialog.
- The default value is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.Target">
- <summary>
- Gets or sets the target for the credentials, typically a server name.
- </summary>
- <value>
- The target for the credentials. The default value is an empty string ("").
- </value>
- <remarks>
- Credentials are stored on a per user, not on a per application basis. To ensure that credentials stored by different
- applications do not conflict, you should prefix the target with an application-specific identifer, e.g.
- "Company_Application_target".
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.WindowTitle">
- <summary>
- Gets or sets the title of the credentials dialog.
- </summary>
- <value>
- The title of the credentials dialog. The default value is an empty string ("").
- </value>
- <remarks>
- <para>
- This property is not used on Windows Vista and newer versions of windows; the window title will always be "Windows Security"
- in that case.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.MainInstruction">
- <summary>
- Gets or sets a brief message to display in the dialog box.
- </summary>
- <value>
- A brief message that will be displayed in the dialog box. The default value is an empty string ("").
- </value>
- <remarks>
- <para>
- On Windows Vista and newer versions of Windows, this text is displayed using a different style to set it apart
- from the other text. In the default style, this text is a slightly larger and colored blue. The style is identical
- to the main instruction of a task dialog.
- </para>
- <para>
- On Windows XP, this text is not distinguished from other text. It's display mode depends on the <see cref="P:Ookii.Dialogs.CredentialDialog.DownlevelTextMode"/>
- property.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.Content">
- <summary>
- Gets or sets additional text to display in the dialog.
- </summary>
- <value>
- Additional text to display in the dialog. The default value is an empty string ("").
- </value>
- <remarks>
- <para>
- On Windows Vista and newer versions of Windows, this text is placed below the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> text.
- </para>
- <para>
- On Windows XP, how and if this text is displayed depends on the value of the <see cref="P:Ookii.Dialogs.CredentialDialog.DownlevelTextMode"/>
- property.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.DownlevelTextMode">
- <summary>
- Gets or sets a value that indicates how the text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties
- is displayed on Windows XP.
- </summary>
- <value>
- One of the values of the <see cref="T:Ookii.Dialogs.DownlevelTextMode"/> enumeration. The default value is
- <see cref="F:Ookii.Dialogs.DownlevelTextMode.MainInstructionAndContent"/>.
- </value>
- <remarks>
- <para>
- Windows XP does not support the distinct visual style of the main instruction, so there is no visual difference between the
- text of the <see cref="P:Ookii.Dialogs.CredentialDialog.MainInstruction"/> and <see cref="P:Ookii.Dialogs.CredentialDialog.Content"/> properties. Depending
- on your requirements, you may wish to hide either the main instruction or the content text.
- </para>
- <para>
- This property has no effect on Windows Vista and newer versions of Windows.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox">
- <summary>
- Gets or sets a value that indicates whether a check box is shown on the dialog that allows the user to choose whether to save
- the credentials or not.
- </summary>
- <value>
- <see langword="true"/> when the "save password" checkbox is shown on the credentials dialog; otherwise, <see langword="false"/>.
- The default value is <see langword="false"/>.
- </value>
- <remarks>
- When this property is set to <see langword="true"/>, you must call the <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method to save the
- credentials. When this property is set to <see langword="false"/>, the credentials will never be saved, and you should not call
- the <see cref="M:Ookii.Dialogs.CredentialDialog.ConfirmCredentials(System.Boolean)"/> method.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials">
- <summary>
- Gets or sets a value that indicates whether the dialog should be displayed even when saved credentials exist for the
- specified target.
- </summary>
- <value>
- <see langword="true"/> if the dialog is displayed even when saved credentials exist; otherwise, <see langword="false"/>.
- The default value is <see langword="false"/>.
- </value>
- <remarks>
- <para>
- This property applies only when the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowSaveCheckBox"/> property is <see langword="true"/>.
- </para>
- <para>
- Note that even if this property is <see langword="true"/>, if the proper credentials exist in the
- application instance credentials cache the dialog will not be displayed.
- </para>
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.CredentialDialog.IsStoredCredential">
- <summary>
- Gets a value that indicates whether the current credentials were retrieved from a credential store.
- </summary>
- <value>
- <see langword="true"/> if the current credentials returned by the <see cref="P:Ookii.Dialogs.CredentialDialog.UserName"/>, <see cref="P:Ookii.Dialogs.CredentialDialog.Password"/>,
- and <see cref="P:Ookii.Dialogs.CredentialDialog.Credentials"/> properties were retrieved from either the application instance credential cache
- or the operating system's credential store; otherwise, <see langword="false"/>.
- </value>
- <remarks>
- <para>
- You can use this property to determine if the credentials dialog was shown after a call to <see cref="M:Ookii.Dialogs.CredentialDialog.ShowDialog"/>.
- If the dialog was shown, this property will be <see langword="false"/>; if the credentials were retrieved from the
- application instance cache or the credential store and the dialog was not shown it will be <see langword="true"/>.
- </para>
- <para>
- If the <see cref="P:Ookii.Dialogs.CredentialDialog.ShowUIForSavedCredentials"/> property is set to <see langword="true"/>, and the dialog is shown
- but populated with stored credentials, this property will still return <see langword="false"/>.
- </para>
- </remarks>
- </member>
- <member name="T:Ookii.Dialogs.VistaSaveFileDialog">
- <summary>
- Prompts the user to select a location for saving a file.
- </summary>
- <remarks>
- <para>
- This class will use the Vista style file dialog if possible, and automatically fall back to the old-style
- dialog on versions of Windows older than Vista.
- </para>
- <para>
- As of .Net 3.5 and .Net 2.0 SP1, the regular <see cref="T:System.Windows.Forms.FileDialog"/> class will also use
- the new Vista style dialogs. However, certain options, such as settings <see cref="P:System.Windows.Forms.OpenFileDialog.ShowReadOnly"/>,
- still cause that class to revert to the old style dialogs. For this reason, this class is still provided.
- It is recommended that you use the <see cref="T:System.Windows.Forms.SaveFileDialog"/> class whenever possible.
- </para>
- </remarks>
- <threadsafety static="true" instance="false"/>
- </member>
- <member name="M:Ookii.Dialogs.VistaSaveFileDialog.#ctor">
- <summary>
- Creates a new instance of <see cref="T:Ookii.Dialogs.VistaSaveFileDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaSaveFileDialog.#ctor(System.Boolean)">
- <summary>
- Creates a new instance of <see cref="T:Ookii.Dialogs.VistaSaveFileDialog"/> class.
- </summary>
- <param name="forceDownlevel">When <see langword="true"/>, the old style common file dialog will always be used even if the OS supports the Vista style.</param>
- </member>
- <member name="M:Ookii.Dialogs.VistaSaveFileDialog.Reset">
- <summary>
- Resets all properties to their default values.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaSaveFileDialog.OpenFile">
- <summary>
- Opens the file with read/write permission selected by the user.
- </summary>
- <returns>The read/write file selected by the user.</returns>
- <exception cref="T:System.ArgumentNullException"><see cref="P:Ookii.Dialogs.VistaFileDialog.FileName"/> is <see langword="null"/> or an empty string.</exception>
- </member>
- <member name="M:Ookii.Dialogs.VistaSaveFileDialog.OnFileOk(System.ComponentModel.CancelEventArgs)">
- <summary>
- Raises the <see cref="E:Ookii.Dialogs.VistaFileDialog.FileOk"/> event.
- </summary>
- <param name="e">A <see cref="T:System.ComponentModel.CancelEventArgs"/> that contains the event data.</param>
- </member>
- <member name="P:Ookii.Dialogs.VistaSaveFileDialog.CreatePrompt">
- <summary>
- Gets or sets a value indicating whether the dialog box prompts the user for permission to create a file if the
- user specifies a file that does not exist.
- </summary>
- <value>
- <see langword="true"/> if the dialog box prompts the user before creating a file if the user specifies a file name that does not exist;
- <see langword="false"/> if the dialog box automatically creates the new file without prompting the user for permission. The default
- value is <see langword="false"/>.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaSaveFileDialog.OverwritePrompt">
- <summary>
- Gets or sets a value indicating whether the Save As dialog box displays a warning if the user
- specifies a file name that already exists.
- </summary>
- <value>
- <see langword="true"/> if the dialog box prompts the user before overwriting an existing file if the user specifies a file
- name that already exists; <see langword="false"/> if the dialog box automatically overwrites the existing file without
- prompting the user for permission. The default value is <see langword="true"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.ButtonType">
- <summary>
- Represents the type of a task dialog button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.Custom">
- <summary>
- The button is a custom button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.Ok">
- <summary>
- The button is the common OK button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.Yes">
- <summary>
- The button is the common Yes button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.No">
- <summary>
- The button is the common No button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.Cancel">
- <summary>
- The button is the common Cancel button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.Retry">
- <summary>
- The button is the common Retry button.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.ButtonType.Close">
- <summary>
- The button is the common Close button.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.VistaFolderBrowserDialog">
- <summary>
- Prompts the user to select a folder.
- </summary>
- <remarks>
- This class will use the Vista style Select Folder dialog if possible, or the regular FolderBrowserDialog
- if it is not. Note that the Vista style dialog is very different, so using this class without testing
- in both Vista and older Windows versions is not recommended.
- </remarks>
- <threadsafety instance="false" static="true" />
- </member>
- <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.#ctor">
- <summary>
- Creates a new instance of the <see cref="T:Ookii.Dialogs.VistaFolderBrowserDialog"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.Reset">
- <summary>
- Resets all properties to their default values.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.RunDialog(System.IntPtr)">
- <summary>
- Specifies a common dialog box.
- </summary>
- <param name="hwndOwner">A value that represents the window handle of the owner window for the common dialog box.</param>
- <returns><see langword="true" /> if the file could be opened; otherwise, <see langword="false" />.</returns>
- </member>
- <member name="M:Ookii.Dialogs.VistaFolderBrowserDialog.Dispose(System.Boolean)">
- <summary>
- Releases the unmanaged resources used by the <see cref="T:Ookii.Dialogs.VistaFolderBrowserDialog"/> and optionally releases the managed resources.
- </summary>
- <param name="disposing"><see langword="true"/> to release both managed and unmanaged resources; <see langword="false"/> to release only unmanaged resources.</param>
- </member>
- <member name="E:Ookii.Dialogs.VistaFolderBrowserDialog.HelpRequest">
- <summary>
- Occurs when the user clicks the Help button on the dialog box.
- </summary>
- </member>
- <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.IsVistaFolderDialogSupported">
- <summary>
- Gets a value that indicates whether the current OS supports Vista-style common file dialogs.
- </summary>
- <value>
- <see langword="true" /> on Windows Vista or newer operating systems; otherwise, <see langword="false" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description">
- <summary>
- Gets or sets the descriptive text displayed above the tree view control in the dialog box, or below the list view control
- in the Vista style dialog.
- </summary>
- <value>
- The description to display. The default is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.RootFolder">
- <summary>
- Gets or sets the root folder where the browsing starts from. This property has no effect if the Vista style
- dialog is used.
- </summary>
- <value>
- One of the <see cref="T:System.Environment.SpecialFolder"/> values. The default is Desktop.
- </value>
- <exception cref="T:System.ComponentModel.InvalidEnumArgumentException">The value assigned is not one of the <see cref="T:System.Environment.SpecialFolder"/> values.</exception>
- </member>
- <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.SelectedPath">
- <summary>
- Gets or sets the path selected by the user.
- </summary>
- <value>
- The path of the folder first selected in the dialog box or the last folder selected by the user. The default is an empty string ("").
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.ShowNewFolderButton">
- <summary>
- Gets or sets a value indicating whether the New Folder button appears in the folder browser dialog box. This
- property has no effect if the Vista style dialog is used; in that case, the New Folder button is always shown.
- </summary>
- <value>
- <see langword="true" /> if the New Folder button is shown in the dialog box; otherwise, <see langword="false" />. The default is <see langword="true" />.
- </value>
- </member>
- <member name="P:Ookii.Dialogs.VistaFolderBrowserDialog.UseDescriptionForTitle">
- <summary>
- Gets or sets a value that indicates whether to use the value of the <see cref="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description"/> property
- as the dialog title for Vista style dialogs. This property has no effect on old style dialogs.
- </summary>
- <value><see langword="true"/> to indicate that the value of the <see cref="P:Ookii.Dialogs.VistaFolderBrowserDialog.Description"/> property is used as dialog title; <see langword="false"/>
- to indicate the value is added as additional text to the dialog. The default is <see langword="false"/>.</value>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogButtonStyle">
- <summary>
- Indicates the display style of custom buttons on a task dialog.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.Standard">
- <summary>
- Custom buttons are displayed as regular buttons.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinks">
- <summary>
- Custom buttons are displayed as command links using a standard task dialog glyph.
- </summary>
- </member>
- <member name="F:Ookii.Dialogs.TaskDialogButtonStyle.CommandLinksNoIcon">
- <summary>
- Custom buttons are displayed as command links without a glyph.
- </summary>
- </member>
- <member name="T:Ookii.Dialogs.TaskDialogRadioButton">
- <summary>
- A radio button on a task dialog.
- </summary>
- <threadsafety static="true" instance="false" />
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogRadioButton.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> class.
- </summary>
- </member>
- <member name="M:Ookii.Dialogs.TaskDialogRadioButton.#ctor(System.ComponentModel.IContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> class with the specified container.
- </summary>
- <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> to add the <see cref="T:Ookii.Dialogs.TaskDialogRadioButton"/> to.</param>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogRadioButton.Checked">
- <summary>
- Gets or sets a value that indicates whether the radio button is checked.
- </summary>
- <value>
- <see langword="true"/> if the radio button is checked; otherwise, <see langword="false"/>.
- The default value is <see langword="false"/>.
- </value>
- <remarks>
- Setting this property while the dialog is being displayed has no effect. Instead, use the <see cref="M:Ookii.Dialogs.TaskDialogItem.Click"/>
- method to check a particular radio button.
- </remarks>
- </member>
- <member name="P:Ookii.Dialogs.TaskDialogRadioButton.ItemCollection">
- <summary>
- Gets the collection that items of this type are part of.
- </summary>
- <value>
- If the <see cref="T:Ookii.Dialogs.TaskDialogButton"/> is currently associated with a <see cref="T:Ookii.Dialogs.TaskDialog"/>, the
- <see cref="P:Ookii.Dialogs.TaskDialog.Buttons"/> collection of that <see cref="T:Ookii.Dialogs.TaskDialog"/>; otherwise, <see langword="null"/>.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.HyperlinkClickedEventArgs">
- <summary>
- Class that provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.HyperlinkClicked"/> event.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.HyperlinkClickedEventArgs.#ctor(System.String)">
- <summary>
- Creates a new instance of the <see cref="T:Ookii.Dialogs.HyperlinkClickedEventArgs"/> class with the specified URL.
- </summary>
- <param name="href">The URL of the hyperlink.</param>
- </member>
- <member name="P:Ookii.Dialogs.HyperlinkClickedEventArgs.Href">
- <summary>
- Gets the URL of the hyperlink that was clicked.
- </summary>
- <value>
- The value of the href attribute of the hyperlink.
- </value>
- </member>
- <member name="T:Ookii.Dialogs.ExpandButtonClickedEventArgs">
- <summary>
- Provides data for the <see cref="E:Ookii.Dialogs.TaskDialog.ExpandButtonClicked"/> event.
- </summary>
- <threadsafety instance="false" static="true"/>
- </member>
- <member name="M:Ookii.Dialogs.ExpandButtonClickedEventArgs.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Ookii.Dialogs.ExpandButtonClickedEventArgs"/> class with the specified expanded state.
- </summary>
- <param name="expanded"><see langword="true"/> if the the expanded content on the dialog is shown; otherwise, <see langword="false"/>.</param>
- </member>
- <member name="P:Ookii.Dialogs.ExpandButtonClickedEventArgs.Expanded">
- <summary>
- Gets a value that indicates if the expanded content on the dialog is shown.
- </summary>
- <value><see langword="true" /> if the expanded content on the dialog is shown; otherwise, <see langword="false" />.</value>
- </member>
- </members>
-</doc>
diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll Binary files differdeleted file mode 100644 index 5c6bcfa1d..000000000 --- a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll +++ /dev/null diff --git a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config b/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config deleted file mode 100644 index 73859b00e..000000000 --- a/win/CS/libraries/OokiiDialogs/Ookii.Dialogs.dll.config +++ /dev/null @@ -1,3 +0,0 @@ -<?xml version="1.0"?>
-<configuration>
- <startup/></configuration>
diff --git a/win/CS/libraries/OokiiDialogs/license.txt b/win/CS/libraries/OokiiDialogs/license.txt deleted file mode 100644 index e46230167..000000000 --- a/win/CS/libraries/OokiiDialogs/license.txt +++ /dev/null @@ -1,29 +0,0 @@ -License agreement for Ookii.Dialogs.
-
-Copyright � Sven Groot (Ookii.org) 2009
-All rights reserved.
-
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-1) Redistributions of source code must retain the above copyright notice,
- this list of conditions and the following disclaimer.
-2) Redistributions in binary form must reproduce the above copyright notice,
- this list of conditions and the following disclaimer in the documentation
- and/or other materials provided with the distribution.
-3) Neither the name of the ORGANIZATION nor the names of its contributors
- may be used to endorse or promote products derived from this software
- without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
-SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
-INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
-CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
-ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
-THE POSSIBILITY OF SUCH DAMAGE.
\ No newline at end of file diff --git a/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.XML b/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.XML deleted file mode 100644 index c05cddd5c..000000000 --- a/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.XML +++ /dev/null @@ -1,594 +0,0 @@ -<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>GongSolutions.Wpf.DragDrop</name>
- </assembly>
- <members>
- <member name="T:GongSolutions.Wpf.DragDrop.IDragSource">
- <summary>
- Interface implemented by Drag Handlers.
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.IDragSource.StartDrag(GongSolutions.Wpf.DragDrop.IDragInfo)">
- <summary>
- Queries whether a drag can be started.
- </summary>
-
- <param name="dragInfo">
- Information about the drag.
- </param>
-
- <remarks>
- To allow a drag to be started, the <see cref="P:GongSolutions.Wpf.DragDrop.DragInfo.Effects"/> property on <paramref name="dragInfo"/>
- should be set to a value other than <see cref="F:System.Windows.DragDropEffects.None"/>.
- </remarks>
- </member>
- <!-- Badly formed XML comment ignored for member "M:GongSolutions.Wpf.DragDrop.IDragSource.CanStartDrag(GongSolutions.Wpf.DragDrop.IDragInfo)" -->
- <member name="M:GongSolutions.Wpf.DragDrop.IDragSource.Dropped(GongSolutions.Wpf.DragDrop.IDropInfo)">
- <summary>
- Notifies the drag handler that a drop has occurred.
- </summary>
-
- <param name="dropInfo">
- Information about the drop.
- </param>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.IDragSource.DragCancelled">
- <summary>
- Notifies the drag handler that a drag has been aborted.
- </summary>
- </member>
- <member name="T:GongSolutions.Wpf.DragDrop.IDropTarget">
- <summary>
- Interface implemented by Drop Handlers.
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.IDropTarget.DragOver(GongSolutions.Wpf.DragDrop.IDropInfo)">
- <summary>
- Updates the current drag state.
- </summary>
-
- <param name="dropInfo">
- Information about the drag.
- </param>
-
- <remarks>
- To allow a drop at the current drag position, the <see cref="P:GongSolutions.Wpf.DragDrop.DropInfo.Effects"/> property on
- <paramref name="dropInfo"/> should be set to a value other than <see cref="F:System.Windows.DragDropEffects.None"/>
- and <see cref="P:GongSolutions.Wpf.DragDrop.DropInfo.Data"/> should be set to a non-null value.
- </remarks>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.IDropTarget.Drop(GongSolutions.Wpf.DragDrop.IDropInfo)">
- <summary>
- Performs a drop.
- </summary>
-
- <param name="dropInfo">
- Information about the drop.
- </param>
- </member>
- <member name="F:GongSolutions.Wpf.DragDrop.DragDrop.DragMouseAnchorPointProperty">
- <summary>
- DragMouseAnchorPoint defines the horizontal and vertical proportion at which the pointer will anchor on the DragAdorner.
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.DragDrop.TryGetDragHandler(GongSolutions.Wpf.DragDrop.DragInfo,System.Windows.UIElement)">
- <summary>
- Gets the drag handler from the drag info or from the sender, if the drag info is null
- </summary>
- <param name="dragInfo">the drag info object</param>
- <param name="sender">the sender from an event, e.g. mouse down, mouse move</param>
- <returns></returns>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.DragDrop.TryGetDropHandler(GongSolutions.Wpf.DragDrop.DropInfo,System.Windows.UIElement)">
- <summary>
- Gets the drop handler from the drop info or from the sender, if the drop info is null
- </summary>
- <param name="dropInfo">the drop info object</param>
- <param name="sender">the sender from an event, e.g. drag over</param>
- <returns></returns>
- </member>
- <member name="T:GongSolutions.Wpf.DragDrop.DragInfo">
- <summary>
- Holds information about a the source of a drag drop operation.
- </summary>
-
- <remarks>
- The <see cref="T:GongSolutions.Wpf.DragDrop.DragInfo"/> class holds all of the framework's information about the source
- of a drag. It is used by <see cref="M:GongSolutions.Wpf.DragDrop.IDragSource.StartDrag(GongSolutions.Wpf.DragDrop.IDragInfo)"/> to determine whether a drag
- can start, and what the dragged data should be.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.Data">
- <summary>
- Gets or sets the drag data.
- </summary>
-
- <remarks>
- This must be set by a drag handler in order for a drag to start.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.DragStartPosition">
- <summary>
- Gets the position of the click that initiated the drag, relative to <see cref="P:GongSolutions.Wpf.DragDrop.IDragInfo.VisualSource"/>.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.PositionInDraggedItem">
- <summary>
- Gets the point where the cursor was relative to the item being dragged when the drag was started.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.Effects">
- <summary>
- Gets or sets the allowed effects for the drag.
- </summary>
-
- <remarks>
- This must be set to a value other than <see cref="F:System.Windows.DragDropEffects.None"/> by a drag handler in order
- for a drag to start.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.MouseButton">
- <summary>
- Gets the mouse button that initiated the drag.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.SourceCollection">
- <summary>
- Gets the collection that the source ItemsControl is bound to.
- </summary>
-
- <remarks>
- If the control that initated the drag is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.SourceIndex">
- <summary>
- Gets the position from where the item was dragged.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.SourceItem">
- <summary>
- Gets the object that a dragged item is bound to.
- </summary>
-
- <remarks>
- If the control that initated the drag is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.SourceItems">
- <summary>
- Gets a collection of objects that the selected items in an ItemsControl are bound to.
- </summary>
-
- <remarks>
- If the control that initated the drag is unbound or not an ItemsControl, this will be empty.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.VisualSource">
- <summary>
- Gets the control that initiated the drag.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.VisualSourceItem">
- <summary>
- Gets the item in an ItemsControl that started the drag.
- </summary>
-
- <remarks>
- If the control that initiated the drag is an ItemsControl, this property will hold the item
- container of the clicked item. For example, if <see cref="P:GongSolutions.Wpf.DragDrop.IDragInfo.VisualSource"/> is a ListBox this
- will hold a ListBoxItem.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.VisualSourceFlowDirection">
- <summary>
- Gets the FlowDirection of the current drag source.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDragInfo.DataObject">
- <summary>
- Gets the <see cref="T:System.Windows.IDataObject"/> which is used by the drag and drop operation. Set it to
- a custom instance if custom drag and drop behavior is needed.
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.DragInfo.#ctor(System.Object,System.Windows.Input.MouseButtonEventArgs)">
- <summary>
- Initializes a new instance of the DragInfo class.
- </summary>
-
- <param name="sender">
- The sender of the mouse event that initiated the drag.
- </param>
-
- <param name="e">
- The mouse event that initiated the drag.
- </param>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.Data">
- <summary>
- Gets or sets the drag data.
- </summary>
-
- <remarks>
- This must be set by a drag handler in order for a drag to start.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.DragStartPosition">
- <summary>
- Gets the position of the click that initiated the drag, relative to <see cref="P:GongSolutions.Wpf.DragDrop.DragInfo.VisualSource"/>.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.PositionInDraggedItem">
- <summary>
- Gets the point where the cursor was relative to the item being dragged when the drag was started.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.Effects">
- <summary>
- Gets or sets the allowed effects for the drag.
- </summary>
-
- <remarks>
- This must be set to a value other than <see cref="F:System.Windows.DragDropEffects.None"/> by a drag handler in order
- for a drag to start.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.MouseButton">
- <summary>
- Gets the mouse button that initiated the drag.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.SourceCollection">
- <summary>
- Gets the collection that the source ItemsControl is bound to.
- </summary>
-
- <remarks>
- If the control that initated the drag is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.SourceIndex">
- <summary>
- Gets the position from where the item was dragged.
- </summary>
- <value>The index of the source.</value>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.SourceItem">
- <summary>
- Gets the object that a dragged item is bound to.
- </summary>
-
- <remarks>
- If the control that initated the drag is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.SourceItems">
- <summary>
- Gets a collection of objects that the selected items in an ItemsControl are bound to.
- </summary>
-
- <remarks>
- If the control that initated the drag is unbound or not an ItemsControl, this will be empty.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.VisualSource">
- <summary>
- Gets the control that initiated the drag.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.VisualSourceItem">
- <summary>
- Gets the item in an ItemsControl that started the drag.
- </summary>
-
- <remarks>
- If the control that initiated the drag is an ItemsControl, this property will hold the item
- container of the clicked item. For example, if <see cref="P:GongSolutions.Wpf.DragDrop.DragInfo.VisualSource"/> is a ListBox this
- will hold a ListBoxItem.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.VisualSourceFlowDirection">
- <summary>
- Gets the FlowDirection of the current drag source.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DragInfo.DataObject">
- <summary>
- Gets the <see cref="T:System.Windows.IDataObject"/> which is used by the drag and drop operation. Set it to
- a custom instance if custom drag and drop behavior is needed.
- </summary>
- </member>
- <member name="T:GongSolutions.Wpf.DragDrop.DropInfo">
- <summary>
- Holds information about a the target of a drag drop operation.
- </summary>
-
- <remarks>
- The <see cref="T:GongSolutions.Wpf.DragDrop.DropInfo"/> class holds all of the framework's information about the current
- target of a drag. It is used by <see cref="M:GongSolutions.Wpf.DragDrop.IDropTarget.DragOver(GongSolutions.Wpf.DragDrop.IDropInfo)"/> method to determine whether
- the current drop target is valid, and by <see cref="M:GongSolutions.Wpf.DragDrop.IDropTarget.Drop(GongSolutions.Wpf.DragDrop.IDropInfo)"/> to perform the drop.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.Data">
- <summary>
- Gets the drag data.
- </summary>
-
- <remarks>
- If the drag came from within the framework, this will hold:
-
- - The dragged data if a single item was dragged.
- - A typed IEnumerable if multiple items were dragged.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.DragInfo">
- <summary>
- Gets a <see cref="P:GongSolutions.Wpf.DragDrop.IDropInfo.DragInfo"/> object holding information about the source of the drag,
- if the drag came from within the framework.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.DropPosition">
- <summary>
- Gets the mouse position relative to the VisualTarget
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.DropTargetAdorner">
- <summary>
- Gets or sets the class of drop target to display.
- </summary>
-
- <remarks>
- The standard drop target adorner classes are held in the <see cref="T:GongSolutions.Wpf.DragDrop.DropTargetAdorners"/>
- class.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.Effects">
- <summary>
- Gets or sets the allowed effects for the drop.
- </summary>
-
- <remarks>
- This must be set to a value other than <see cref="F:System.Windows.DragDropEffects.None"/> by a drop handler in order
- for a drop to be possible.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.InsertIndex">
- <summary>
- Gets the current insert position within <see cref="P:GongSolutions.Wpf.DragDrop.IDropInfo.TargetCollection"/>.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.TargetCollection">
- <summary>
- Gets the collection that the target ItemsControl is bound to.
- </summary>
-
- <remarks>
- If the current drop target is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.TargetItem">
- <summary>
- Gets the object that the current drop target is bound to.
- </summary>
-
- <remarks>
- If the current drop target is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.TargetGroup">
- <summary>
- Gets the current group target.
- </summary>
-
- <remarks>
- If the drag is currently over an ItemsControl with groups, describes the group that
- the drag is currently over.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.VisualTarget">
- <summary>
- Gets the control that is the current drop target.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.VisualTargetItem">
- <summary>
- Gets the item in an ItemsControl that is the current drop target.
- </summary>
-
- <remarks>
- If the current drop target is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.VisualTargetOrientation">
- <summary>
- Gets the orientation of the current drop target.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.VisualTargetFlowDirection">
- <summary>
- Gets the FlowDirection of the current drop target.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.DestinationText">
- <summary>
- Gets and sets the text displayed in the DropDropEffects adorner.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.InsertPosition">
- <summary>
- Gets the relative position the item will be inserted to compared to the TargetItem
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.KeyStates">
- <summary>
- Gets a flag enumeration indicating the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.IDropInfo.NotHandled">
- <summary>
- Indicates if the drop info should be handled by itself (useful for child elements)
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.DropInfo.#ctor(System.Object,System.Windows.DragEventArgs,GongSolutions.Wpf.DragDrop.DragInfo)">
- <summary>
- Initializes a new instance of the DropInfo class.
- </summary>
-
- <param name="sender">
- The sender of the drag event.
- </param>
-
- <param name="e">
- The drag event.
- </param>
-
- <param name="dragInfo">
- Information about the source of the drag, if the drag came from within the framework.
- </param>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.Data">
- <summary>
- Gets the drag data.
- </summary>
-
- <remarks>
- If the drag came from within the framework, this will hold:
-
- - The dragged data if a single item was dragged.
- - A typed IEnumerable if multiple items were dragged.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.DragInfo">
- <summary>
- Gets a <see cref="P:GongSolutions.Wpf.DragDrop.DropInfo.DragInfo"/> object holding information about the source of the drag,
- if the drag came from within the framework.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.DropPosition">
- <summary>
- Gets the mouse position relative to the VisualTarget
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.DropTargetAdorner">
- <summary>
- Gets or sets the class of drop target to display.
- </summary>
-
- <remarks>
- The standard drop target adorner classes are held in the <see cref="T:GongSolutions.Wpf.DragDrop.DropTargetAdorners"/>
- class.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.Effects">
- <summary>
- Gets or sets the allowed effects for the drop.
- </summary>
-
- <remarks>
- This must be set to a value other than <see cref="F:System.Windows.DragDropEffects.None"/> by a drop handler in order
- for a drop to be possible.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.InsertIndex">
- <summary>
- Gets the current insert position within <see cref="P:GongSolutions.Wpf.DragDrop.DropInfo.TargetCollection"/>.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.TargetCollection">
- <summary>
- Gets the collection that the target ItemsControl is bound to.
- </summary>
-
- <remarks>
- If the current drop target is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.TargetItem">
- <summary>
- Gets the object that the current drop target is bound to.
- </summary>
-
- <remarks>
- If the current drop target is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.TargetGroup">
- <summary>
- Gets the current group target.
- </summary>
-
- <remarks>
- If the drag is currently over an ItemsControl with groups, describes the group that
- the drag is currently over.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.VisualTarget">
- <summary>
- Gets the control that is the current drop target.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.VisualTargetItem">
- <summary>
- Gets the item in an ItemsControl that is the current drop target.
- </summary>
-
- <remarks>
- If the current drop target is unbound or not an ItemsControl, this will be null.
- </remarks>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.VisualTargetOrientation">
- <summary>
- Gets the orientation of the current drop target.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.VisualTargetFlowDirection">
- <summary>
- Gets the orientation of the current drop target.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.DestinationText">
- <summary>
- Gets and sets the text displayed in the DropDropEffects adorner.
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.InsertPosition">
- <summary>
- Gets the relative position the item will be inserted to compared to the TargetItem
- </summary>
- </member>
- <member name="P:GongSolutions.Wpf.DragDrop.DropInfo.KeyStates">
- <summary>
- Gets a flag enumeration indicating the current state of the SHIFT, CTRL, and ALT keys, as well as the state of the mouse buttons.
- </summary>
- </member>
- <member name="T:GongSolutions.Wpf.DragDrop.Icons.IconFactory">
- <summary>
- Static class to provide access to standard application images
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.Icons.IconFactory.GetImage(System.String,System.Int32)">
- <summary>
- Loads an image based on the name and size required.
- Images need to be marked as 'Resource' in the project for them be loaded.
- </summary>
- <param name="iconName">Name of the icon</param>
- <param name="size">The size of the icon</param>
- <returns>The image to be displayed</returns>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.Utilities.HitTestUtilities.IsNotPartOfSender(System.Object,System.Windows.Input.MouseButtonEventArgs)">
- <summary>
- thx to @osicka from issue #84
-
- e.g. original source is part of a popup (e.g. ComboBox drop down), the hit test needs to be done on the original source.
- Because the popup is not attached to the visual tree of the sender.
- This function test this by looping back from the original source to the sender and if it didn't end up at the sender stopped the drag.
- </summary>
- </member>
- <member name="M:GongSolutions.Wpf.DragDrop.Utilities.VisualTreeExtensions.GetVisualAncestor(System.Windows.DependencyObject,System.Type,System.Windows.Controls.ItemsControl)">
- <summary>
- find the visual ancestor by type and go through the visual tree until the given itemsControl will be found
- </summary>
- </member>
- </members>
-</doc>
diff --git a/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.dll b/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.dll Binary files differdeleted file mode 100644 index bf2d85e9f..000000000 --- a/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.dll +++ /dev/null diff --git a/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.pdb b/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.pdb Binary files differdeleted file mode 100644 index 121c34de7..000000000 --- a/win/CS/libraries/WPFDragDrop/GongSolutions.Wpf.DragDrop.pdb +++ /dev/null diff --git a/win/CS/libraries/WPFDragDrop/notes.txt b/win/CS/libraries/WPFDragDrop/notes.txt deleted file mode 100644 index a40a2f0c6..000000000 --- a/win/CS/libraries/WPFDragDrop/notes.txt +++ /dev/null @@ -1,3 +0,0 @@ -https://github.com/punker76/gong-wpf-dragdrop
-
-[New BSD License](http://opensource.org/licenses/BSD-3-Clause) diff --git a/win/CS/libraries/caliburn/Caliburn.Micro.Platform.dll b/win/CS/libraries/caliburn/Caliburn.Micro.Platform.dll Binary files differdeleted file mode 100644 index 6ef8735be..000000000 --- a/win/CS/libraries/caliburn/Caliburn.Micro.Platform.dll +++ /dev/null diff --git a/win/CS/libraries/caliburn/Caliburn.Micro.Platform.xml b/win/CS/libraries/caliburn/Caliburn.Micro.Platform.xml deleted file mode 100644 index a8dfb08dc..000000000 --- a/win/CS/libraries/caliburn/Caliburn.Micro.Platform.xml +++ /dev/null @@ -1,1755 +0,0 @@ -<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Caliburn.Micro.Platform</name>
- </assembly>
- <members>
- <member name="T:Caliburn.Micro.Action">
- <summary>
- A host for action related attached properties.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Action.TargetProperty">
- <summary>
- A property definition representing the target of an <see cref="T:Caliburn.Micro.ActionMessage" /> . The DataContext of the element will be set to this instance.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Action.TargetWithoutContextProperty">
- <summary>
- A property definition representing the target of an <see cref="T:Caliburn.Micro.ActionMessage" /> . The DataContext of the element is not set to this instance.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Action.SetTarget(System.Windows.DependencyObject,System.Object)">
- <summary>
- Sets the target of the <see cref="T:Caliburn.Micro.ActionMessage" /> .
- </summary>
- <param name="d"> The element to attach the target to. </param>
- <param name="target"> The target for instances of <see cref="T:Caliburn.Micro.ActionMessage" /> . </param>
- </member>
- <member name="M:Caliburn.Micro.Action.GetTarget(System.Windows.DependencyObject)">
- <summary>
- Gets the target for instances of <see cref="T:Caliburn.Micro.ActionMessage" /> .
- </summary>
- <param name="d"> The element to which the target is attached. </param>
- <returns> The target for instances of <see cref="T:Caliburn.Micro.ActionMessage" /> </returns>
- </member>
- <member name="M:Caliburn.Micro.Action.SetTargetWithoutContext(System.Windows.DependencyObject,System.Object)">
- <summary>
- Sets the target of the <see cref="T:Caliburn.Micro.ActionMessage" /> .
- </summary>
- <param name="d"> The element to attach the target to. </param>
- <param name="target"> The target for instances of <see cref="T:Caliburn.Micro.ActionMessage" /> . </param>
- <remarks>
- The DataContext will not be set.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.Action.GetTargetWithoutContext(System.Windows.DependencyObject)">
- <summary>
- Gets the target for instances of <see cref="T:Caliburn.Micro.ActionMessage" /> .
- </summary>
- <param name="d"> The element to which the target is attached. </param>
- <returns> The target for instances of <see cref="T:Caliburn.Micro.ActionMessage" /> </returns>
- </member>
- <member name="M:Caliburn.Micro.Action.HasTargetSet(System.Windows.DependencyObject)">
- <summary>
- Checks if the <see cref="T:Caliburn.Micro.ActionMessage" /> -Target was set.
- </summary>
- <param name="element"> DependencyObject to check </param>
- <returns> True if Target or TargetWithoutContext was set on <paramref name="element" /> </returns>
- </member>
- <member name="M:Caliburn.Micro.Action.Invoke(System.Object,System.String,System.Windows.DependencyObject,System.Windows.FrameworkElement,System.Object,System.Object[])">
- <summary>
- Uses the action pipeline to invoke the method.
- </summary>
- <param name="target"> The object instance to invoke the method on. </param>
- <param name="methodName"> The name of the method to invoke. </param>
- <param name="view"> The view. </param>
- <param name="source"> The source of the invocation. </param>
- <param name="eventArgs"> The event args. </param>
- <param name="parameters"> The method parameters. </param>
- </member>
- <member name="T:Caliburn.Micro.ActionExecutionContext">
- <summary>
- The context used during the execution of an Action or its guard.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActionExecutionContext.CanExecute">
- <summary>
- Determines whether the action can execute.
- </summary>
- <remarks>Returns true if the action can execute, false otherwise.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ActionExecutionContext.EventArgs">
- <summary>
- Any event arguments associated with the action's invocation.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActionExecutionContext.Method">
- <summary>
- The actual method info to be invoked.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ActionExecutionContext.Message">
- <summary>
- The message being executed.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ActionExecutionContext.Source">
- <summary>
- The source from which the message originates.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ActionExecutionContext.Target">
- <summary>
- The instance on which the action is invoked.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ActionExecutionContext.View">
- <summary>
- The view associated with the target.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ActionExecutionContext.Item(System.String)">
- <summary>
- Gets or sets additional data needed to invoke the action.
- </summary>
- <param name="key">The data key.</param>
- <returns>Custom data associated with the context.</returns>
- </member>
- <member name="M:Caliburn.Micro.ActionExecutionContext.Dispose">
- <summary>
- Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.ActionExecutionContext.Disposing">
- <summary>
- Called when the execution context is disposed
- </summary>
- </member>
- <member name="T:Caliburn.Micro.ActionMessage">
- <summary>
- Used to send a message from the UI to a presentation model class, indicating that a particular Action should be invoked.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.EnforceGuardsDuringInvocation">
- <summary>
- Causes the action invocation to "double check" if the action should be invoked by executing the guard immediately before hand.
- </summary>
- <remarks>This is disabled by default. If multiple actions are attached to the same element, you may want to enable this so that each individaul action checks its guard regardless of how the UI state appears.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.ThrowsExceptions">
- <summary>
- Causes the action to throw if it cannot locate the target or the method at invocation time.
- </summary>
- <remarks>True by default.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.MethodNameProperty">
- <summary>
- Represents the method name of an action message.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.ParametersProperty">
- <summary>
- Represents the parameters of an action message.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.#ctor">
- <summary>
- Creates an instance of <see cref="T:Caliburn.Micro.ActionMessage"/>.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ActionMessage.MethodName">
- <summary>
- Gets or sets the name of the method to be invoked on the presentation model class.
- </summary>
- <value>The name of the method.</value>
- </member>
- <member name="P:Caliburn.Micro.ActionMessage.Parameters">
- <summary>
- Gets the parameters to pass as part of the method invocation.
- </summary>
- <value>The parameters.</value>
- </member>
- <member name="E:Caliburn.Micro.ActionMessage.Detaching">
- <summary>
- Occurs before the message detaches from the associated object.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.OnAttached">
- <summary>
- Called after the action is attached to an AssociatedObject.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.OnDetaching">
- <summary>
- Called when the action is being detached from its AssociatedObject, but before it has actually occurred.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.Invoke(System.Object)">
- <summary>
- Invokes the action.
- </summary>
- <param name="eventArgs">The parameter to the action. If the action does not require a parameter, the parameter may be set to a null reference.</param>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.UpdateAvailability">
- <summary>
- Forces an update of the UI's Enabled/Disabled state based on the the preconditions associated with the method.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
- </returns>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.InvokeAction">
- <summary>
- Invokes the action using the specified <see cref="T:Caliburn.Micro.ActionExecutionContext"/>
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.ApplyAvailabilityEffect">
- <summary>
- Applies an availability effect, such as IsEnabled, to an element.
- </summary>
- <remarks>Returns a value indicating whether or not the action is available.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.GetTargetMethod">
- <summary>
- Finds the method on the target matching the specified message.
- </summary>
- <param name="target">The target.</param>
- <param name="message">The message.</param>
- <returns>The matching method, if available.</returns>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.SetMethodBinding">
- <summary>
- Sets the target, method and view on the context. Uses a bubbling strategy by default.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActionMessage.PrepareContext">
- <summary>
- Prepares the action execution context for use.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ActionMessage.TryFindGuardMethod(Caliburn.Micro.ActionExecutionContext)">
- <summary>
- Try to find a candidate for guard function, having:
- - a name in the form "CanXXX"
- - no generic parameters
- - a bool return type
- - no parameters or a set of parameters corresponding to the action method
- </summary>
- <param name="context">The execution context</param>
- <returns>A MethodInfo, if found; null otherwise</returns>
- </member>
- <member name="T:Caliburn.Micro.AssemblySource">
- <summary>
- A source of assemblies that are inspectable by the framework.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.AssemblySource.Instance">
- <summary>
- The singleton instance of the AssemblySource used by the framework.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.AssemblySource.FindTypeByNames">
- <summary>
- Finds a type which matches one of the elements in the sequence of names.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.AssemblySourceCache">
- <summary>
- A caching subsystem for <see cref="T:Caliburn.Micro.AssemblySource"/>.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.AssemblySourceCache.ExtractTypes">
- <summary>
- Extracts the types from the spezified assembly for storing in the cache.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.AssemblySourceCache.Install">
- <summary>
- Installs the caching subsystem.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.Bind">
- <summary>
- Hosts dependency properties for binding.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Bind.ModelProperty">
- <summary>
- Allows binding on an existing view. Use this on root UserControls, Pages and Windows; not in a DataTemplate.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Bind.ModelWithoutContextProperty">
- <summary>
- Allows binding on an existing view without setting the data context. Use this from within a DataTemplate.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Bind.GetModelWithoutContext(System.Windows.DependencyObject)">
- <summary>
- Gets the model to bind to.
- </summary>
- <param name = "dependencyObject">The dependency object to bind to.</param>
- <returns>The model.</returns>
- </member>
- <member name="M:Caliburn.Micro.Bind.SetModelWithoutContext(System.Windows.DependencyObject,System.Object)">
- <summary>
- Sets the model to bind to.
- </summary>
- <param name = "dependencyObject">The dependency object to bind to.</param>
- <param name = "value">The model.</param>
- </member>
- <member name="M:Caliburn.Micro.Bind.GetModel(System.Windows.DependencyObject)">
- <summary>
- Gets the model to bind to.
- </summary>
- <param name = "dependencyObject">The dependency object to bind to.</param>
- <returns>The model.</returns>
- </member>
- <member name="M:Caliburn.Micro.Bind.SetModel(System.Windows.DependencyObject,System.Object)">
- <summary>
- Sets the model to bind to.
- </summary>
- <param name = "dependencyObject">The dependency object to bind to.</param>
- <param name = "value">The model.</param>
- </member>
- <member name="F:Caliburn.Micro.Bind.AtDesignTimeProperty">
- <summary>
- Allows application of conventions at design-time.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Bind.GetAtDesignTime(System.Windows.DependencyObject)">
- <summary>
- Gets whether or not conventions are being applied at design-time.
- </summary>
- <param name="dependencyObject">The ui to apply conventions to.</param>
- <returns>Whether or not conventions are applied.</returns>
- </member>
- <member name="M:Caliburn.Micro.Bind.SetAtDesignTime(System.Windows.DependencyObject,System.Boolean)">
- <summary>
- Sets whether or not do bind conventions at design-time.
- </summary>
- <param name="dependencyObject">The ui to apply conventions to.</param>
- <param name="value">Whether or not to apply conventions.</param>
- </member>
- <member name="T:Caliburn.Micro.BindingScope">
- <summary>
- Provides methods for searching a given scope for named elements.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BindingScope.FindName(System.Collections.Generic.IEnumerable{System.Windows.FrameworkElement},System.String)">
- <summary>
- Searches through the list of named elements looking for a case-insensitive match.
- </summary>
- <param name="elementsToSearch">The named elements to search through.</param>
- <param name="name">The name to search for.</param>
- <returns>The named element or null if not found.</returns>
- </member>
- <member name="M:Caliburn.Micro.BindingScope.AddChildResolver(System.Func{System.Type,System.Boolean},System.Func{System.Windows.DependencyObject,System.Collections.Generic.IEnumerable{System.Windows.DependencyObject}})">
- <summary>
- Adds a child resolver.
- </summary>
- <param name="filter">The type filter.</param>
- <param name="resolver">The resolver.</param>
- </member>
- <member name="M:Caliburn.Micro.BindingScope.RemoveChildResolver(System.Func{System.Windows.DependencyObject,System.Collections.Generic.IEnumerable{System.Windows.DependencyObject}})">
- <summary>
- Removes a child resolver.
- </summary>
- <param name="resolver">The resolver to remove.</param>
- <returns>true, when the resolver was (found and) removed.</returns>
- </member>
- <member name="F:Caliburn.Micro.BindingScope.GetNamedElements">
- <summary>
- Gets all the <see cref="T:System.Windows.FrameworkElement"/> instances with names in the scope.
- </summary>
- <returns>Named <see cref="T:System.Windows.FrameworkElement"/> instances in the provided scope.</returns>
- <remarks>Pass in a <see cref="T:System.Windows.DependencyObject"/> and receive a list of named <see cref="T:System.Windows.FrameworkElement"/> instances in the same scope.</remarks>
- </member>
- <member name="F:Caliburn.Micro.BindingScope.FindNamedDescendants">
- <summary>
- Finds a set of named <see cref="T:System.Windows.FrameworkElement"/> instances in each hop in a <see cref="T:Caliburn.Micro.BindingScope.ScopeNamingRoute"/>.
- </summary>
- <remarks>
- Searches all the elements in the <see cref="T:Caliburn.Micro.BindingScope.ScopeNamingRoute"/> parameter as well as the visual children of
- each of these elements, the <see cref="P:System.Windows.Controls.ContentControl.Content"/>, the <c>HeaderedContentControl.Header</c>,
- the <see cref="P:System.Windows.Controls.ItemsControl.Items"/>, or the <c>HeaderedItemsControl.Header</c>, if any are found.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.BindingScope.FindScopeNamingRoute">
- <summary>
- Finds a path of dependency objects which traces through visual anscestry until a root which is <see langword="null"/>,
- a <see cref="T:System.Windows.Controls.UserControl"/>, a <c>Page</c> with a dependency object <c>Page.ContentProperty</c> value,
- a dependency object with <see cref="F:Caliburn.Micro.View.IsScopeRootProperty"/> set to <see langword="true"/>. <see cref="T:System.Windows.Controls.ContentPresenter"/>
- and <see cref="T:System.Windows.Controls.ItemsPresenter"/> are included in the resulting <see cref="T:Caliburn.Micro.BindingScope.ScopeNamingRoute"/> in order to track which item
- in an items control we are scoped to.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.BindingScope.ScopeNamingRoute">
- <summary>
- Maintains a connection in the visual tree of dependency objects in order to record a route through it.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.BindingScope.ScopeNamingRoute.Root">
- <summary>
- Gets or sets the starting point of the route.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BindingScope.ScopeNamingRoute.AddHop(System.Windows.DependencyObject,System.Windows.DependencyObject)">
- <summary>
- Adds a segment to the route.
- </summary>
- <param name="from">The source dependency object.</param>
- <param name="to">The target dependency object.</param>
- </member>
- <member name="M:Caliburn.Micro.BindingScope.ScopeNamingRoute.TryGetHop(System.Windows.DependencyObject,System.Windows.DependencyObject@)">
- <summary>
- Tries to get a target dependency object given a source.
- </summary>
- <param name="hopSource">The possible beginning of a route segment (hop).</param>
- <param name="hopTarget">The target of a route segment (hop).</param>
- <returns><see langword="true"/> if <paramref name="hopSource"/> had a target recorded; <see langword="false"/> otherwise.</returns>
- </member>
- <member name="T:Caliburn.Micro.BootstrapperBase">
- <summary>
- Inherit from this class in order to customize the configuration of the framework.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.BootstrapperBase.Application">
- <summary>
- The application.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.#ctor(System.Boolean)">
- <summary>
- Creates an instance of the bootstrapper.
- </summary>
- <param name="useApplication">Set this to false when hosting Caliburn.Micro inside and Office or WinForms application. The default is true.</param>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.Initialize">
- <summary>
- Initialize the framework.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.StartDesignTime">
- <summary>
- Called by the bootstrapper's constructor at design time to start the framework.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.StartRuntime">
- <summary>
- Called by the bootstrapper's constructor at runtime to start the framework.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.PrepareApplication">
- <summary>
- Provides an opportunity to hook into the application object.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.Configure">
- <summary>
- Override to configure the framework and setup your IoC container.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.SelectAssemblies">
- <summary>
- Override to tell the framework where to find assemblies to inspect for views, etc.
- </summary>
- <returns>A list of assemblies to inspect.</returns>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.GetInstance(System.Type,System.String)">
- <summary>
- Override this to provide an IoC specific implementation.
- </summary>
- <param name="service">The service to locate.</param>
- <param name="key">The key to locate.</param>
- <returns>The located service.</returns>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.GetAllInstances(System.Type)">
- <summary>
- Override this to provide an IoC specific implementation
- </summary>
- <param name="service">The service to locate.</param>
- <returns>The located services.</returns>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.BuildUp(System.Object)">
- <summary>
- Override this to provide an IoC specific implementation.
- </summary>
- <param name="instance">The instance to perform injection on.</param>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.OnStartup(System.Object,System.Windows.StartupEventArgs)">
- <summary>
- Override this to add custom behavior to execute after the application starts.
- </summary>
- <param name="sender">The sender.</param>
- <param name="e">The args.</param>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.OnExit(System.Object,System.EventArgs)">
- <summary>
- Override this to add custom behavior on exit.
- </summary>
- <param name="sender">The sender.</param>
- <param name="e">The event args.</param>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.OnUnhandledException(System.Object,System.Windows.Threading.DispatcherUnhandledExceptionEventArgs)">
- <summary>
- Override this to add custom behavior for unhandled exceptions.
- </summary>
- <param name="sender">The sender.</param>
- <param name="e">The event args.</param>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.DisplayRootViewFor(System.Type,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Locates the view model, locates the associate view, binds them and shows it as the root view.
- </summary>
- <param name="viewModelType">The view model type.</param>
- <param name="settings">The optional window settings.</param>
- </member>
- <member name="M:Caliburn.Micro.BootstrapperBase.DisplayRootViewFor``1(System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Locates the view model, locates the associate view, binds them and shows it as the root view.
- </summary>
- <typeparam name="TViewModel">The view model type.</typeparam>
- <param name="settings">The optional window settings.</param>
- </member>
- <member name="T:Caliburn.Micro.ConventionManager">
- <summary>
- Used to configure the conventions used by the framework to apply bindings and create actions.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.BooleanToVisibilityConverter">
- <summary>
- Converters <see cref="T:System.Boolean"/> to/from <see cref="T:System.Windows.Visibility"/>.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.IncludeStaticProperties">
- <summary>
- Indicates whether or not static properties should be included during convention name matching.
- </summary>
- <remarks>False by default.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.OverwriteContent">
- <summary>
- Indicates whether or not the Content of ContentControls should be overwritten by conventional bindings.
- </summary>
- <remarks>False by default.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.DefaultItemTemplate">
- <summary>
- The default DataTemplate used for ItemsControls when required.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.DefaultHeaderTemplate">
- <summary>
- The default DataTemplate used for Headered controls when required.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.Singularize">
- <summary>
- Changes the provided word from a plural form to a singular form.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.DerivePotentialSelectionNames">
- <summary>
- Derives the SelectedItem property name.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.SetBinding">
- <summary>
- Creates a binding and sets it on the element, applying the appropriate conventions.
- </summary>
- <param name="viewModelType"></param>
- <param name="path"></param>
- <param name="property"></param>
- <param name="element"></param>
- <param name="convention"></param>
- <param name="bindableProperty"></param>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ApplyBindingMode">
- <summary>
- Applies the appropriate binding mode to the binding.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ApplyValidation">
- <summary>
- Determines whether or not and what type of validation to enable on the binding.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ApplyValueConverter">
- <summary>
- Determines whether a value converter is is needed and applies one to the binding.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ApplyStringFormat">
- <summary>
- Determines whether a custom string format is needed and applies it to the binding.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ApplyUpdateSourceTrigger">
- <summary>
- Determines whether a custom update source trigger should be applied to the binding.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.AddElementConvention``1(System.Windows.DependencyProperty,System.String,System.String)">
- <summary>
- Adds an element convention.
- </summary>
- <typeparam name="T">The type of element.</typeparam>
- <param name="bindableProperty">The default property for binding conventions.</param>
- <param name="parameterProperty">The default property for action parameters.</param>
- <param name="eventName">The default event to trigger actions.</param>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.AddElementConvention(Caliburn.Micro.ElementConvention)">
- <summary>
- Adds an element convention.
- </summary>
- <param name="convention"></param>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.GetElementConvention(System.Type)">
- <summary>
- Gets an element convention for the provided element type.
- </summary>
- <param name="elementType">The type of element to locate the convention for.</param>
- <returns>The convention if found, null otherwise.</returns>
- <remarks>Searches the class hierarchy for conventions.</remarks>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.HasBinding(System.Windows.FrameworkElement,System.Windows.DependencyProperty)">
- <summary>
- Determines whether a particular dependency property already has a binding on the provided element.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.SetBindingWithoutBindingOverwrite(System.Type,System.String,System.Reflection.PropertyInfo,System.Windows.FrameworkElement,Caliburn.Micro.ElementConvention,System.Windows.DependencyProperty)">
- <summary>
- Creates a binding and sets it on the element, guarding against pre-existing bindings.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.SetBindingWithoutBindingOrValueOverwrite(System.Type,System.String,System.Reflection.PropertyInfo,System.Windows.FrameworkElement,Caliburn.Micro.ElementConvention,System.Windows.DependencyProperty)">
- <summary>
- Creates a binding and set it on the element, guarding against pre-existing bindings and pre-existing values.
- </summary>
- <param name="viewModelType"></param>
- <param name="path"></param>
- <param name="property"></param>
- <param name="element"></param>
- <param name="convention"></param>
- <param name="bindableProperty"> </param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.ApplyItemTemplate(System.Windows.Controls.ItemsControl,System.Reflection.PropertyInfo)">
- <summary>
- Attempts to apply the default item template to the items control.
- </summary>
- <param name="itemsControl">The items control.</param>
- <param name="property">The collection property.</param>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ConfigureSelectedItem">
- <summary>
- Configures the selected item convention.
- </summary>
- <param name="selector">The element that has a SelectedItem property.</param>
- <param name="selectedItemProperty">The SelectedItem property.</param>
- <param name="viewModelType">The view model type.</param>
- <param name="path">The property path.</param>
- </member>
- <member name="F:Caliburn.Micro.ConventionManager.ConfigureSelectedItemBinding">
- <summary>
- Configures the SelectedItem binding for matched selection path.
- </summary>
- <param name="selector">The element that has a SelectedItem property.</param>
- <param name="selectedItemProperty">The SelectedItem property.</param>
- <param name="viewModelType">The view model type.</param>
- <param name="selectionPath">The property path.</param>
- <param name="binding">The binding to configure.</param>
- <returns>A bool indicating whether to apply binding</returns>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.ApplyHeaderTemplate(System.Windows.FrameworkElement,System.Windows.DependencyProperty,System.Windows.DependencyProperty,System.Type)">
- <summary>
- Applies a header template based on <see cref="T:Caliburn.Micro.IHaveDisplayName"/>
- </summary>
- <param name="element"></param>
- <param name="headerTemplateProperty"></param>
- <param name="headerTemplateSelectorProperty"> </param>
- <param name="viewModelType"></param>
- </member>
- <member name="M:Caliburn.Micro.ConventionManager.GetPropertyCaseInsensitive(System.Type,System.String)">
- <summary>
- Gets a property by name, ignoring case and searching all interfaces.
- </summary>
- <param name="type">The type to inspect.</param>
- <param name="propertyName">The property to search for.</param>
- <returns>The property or null if not found.</returns>
- </member>
- <member name="T:Caliburn.Micro.ElementConvention">
- <summary>
- Represents the conventions for a particular element type.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ElementConvention.ElementType">
- <summary>
- The type of element to which the conventions apply.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ElementConvention.GetBindableProperty">
- <summary>
- Gets the default property to be used in binding conventions.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ElementConvention.CreateTrigger">
- <summary>
- The default trigger to be used when wiring actions on this element.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ElementConvention.ParameterProperty">
- <summary>
- The default property to be used for parameters of this type in actions.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ElementConvention.ApplyBinding">
- <summary>
- Applies custom conventions for elements of this type.
- </summary>
- <remarks>Pass the view model type, property path, property instance, framework element and its convention.</remarks>
- </member>
- <member name="T:Caliburn.Micro.ExtensionMethods">
- <summary>
- Generic extension methods used by the framework.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ExtensionMethods.GetAssemblyName(System.Reflection.Assembly)">
- <summary>
- Get's the name of the assembly.
- </summary>
- <param name="assembly">The assembly.</param>
- <returns>The assembly's name.</returns>
- </member>
- <member name="M:Caliburn.Micro.ExtensionMethods.GetAttributes``1(System.Reflection.MemberInfo,System.Boolean)">
- <summary>
- Gets all the attributes of a particular type.
- </summary>
- <typeparam name="T">The type of attributes to get.</typeparam>
- <param name="member">The member to inspect for attributes.</param>
- <param name="inherit">Whether or not to search for inherited attributes.</param>
- <returns>The list of attributes found.</returns>
- </member>
- <member name="M:Caliburn.Micro.ExtensionMethods.GetValueOrDefault``2(System.Collections.Generic.IDictionary{``0,``1},``0)">
- <summary>
- Gets the value for a key. If the key does not exist, return default(TValue);
- </summary>
- <typeparam name="TKey">The type of the keys in the dictionary.</typeparam>
- <typeparam name="TValue">The type of the values in the dictionary.</typeparam>
- <param name="dictionary">The dictionary to call this method on.</param>
- <param name="key">The key to look up.</param>
- <returns>The key value. default(TValue) if this key is not in the dictionary.</returns>
- </member>
- <member name="T:Caliburn.Micro.IHaveParameters">
- <summary>
- Indicates that a message is parameterized.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.IHaveParameters.Parameters">
- <summary>
- Represents the parameters of a message.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.Message">
- <summary>
- Host's attached properties related to routed UI messaging.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Message.SetHandler(System.Windows.DependencyObject,System.Object)">
- <summary>
- Places a message handler on this element.
- </summary>
- <param name="d"> The element. </param>
- <param name="value"> The message handler. </param>
- </member>
- <member name="M:Caliburn.Micro.Message.GetHandler(System.Windows.DependencyObject)">
- <summary>
- Gets the message handler for this element.
- </summary>
- <param name="d"> The element. </param>
- <returns> The message handler. </returns>
- </member>
- <member name="F:Caliburn.Micro.Message.AttachProperty">
- <summary>
- A property definition representing attached triggers and messages.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Message.SetAttach(System.Windows.DependencyObject,System.String)">
- <summary>
- Sets the attached triggers and messages.
- </summary>
- <param name="d"> The element to attach to. </param>
- <param name="attachText"> The parsable attachment text. </param>
- </member>
- <member name="M:Caliburn.Micro.Message.GetAttach(System.Windows.DependencyObject)">
- <summary>
- Gets the attached triggers and messages.
- </summary>
- <param name="d"> The element that was attached to. </param>
- <returns> The parsable attachment text. </returns>
- </member>
- <member name="T:Caliburn.Micro.MessageBinder">
- <summary>
- A service that is capable of properly binding values to a method's parameters and creating instances of <see cref="T:Caliburn.Micro.IResult"/>.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.MessageBinder.SpecialValues">
- <summary>
- The special parameter values recognized by the message binder along with their resolvers.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.MessageBinder.CustomConverters">
- <summary>
- Custom converters used by the framework registered by destination type for which they will be selected.
- The converter is passed the existing value to convert and a "context" object.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.MessageBinder.DetermineParameters(Caliburn.Micro.ActionExecutionContext,System.Reflection.ParameterInfo[])">
- <summary>
- Determines the parameters that a method should be invoked with.
- </summary>
- <param name="context">The action execution context.</param>
- <param name="requiredParameters">The parameters required to complete the invocation.</param>
- <returns>The actual parameter values.</returns>
- </member>
- <member name="F:Caliburn.Micro.MessageBinder.EvaluateParameter">
- <summary>
- Transforms the textual parameter into the actual parameter.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.MessageBinder.CoerceValue(System.Type,System.Object,System.Object)">
- <summary>
- Coerces the provided value to the destination type.
- </summary>
- <param name="destinationType">The destination type.</param>
- <param name="providedValue">The provided value.</param>
- <param name="context">An optional context value which can be used during conversion.</param>
- <returns>The coerced value.</returns>
- </member>
- <member name="M:Caliburn.Micro.MessageBinder.GetDefaultValue(System.Type)">
- <summary>
- Gets the default value for a type.
- </summary>
- <param name="type">The type.</param>
- <returns>The default value.</returns>
- </member>
- <member name="T:Caliburn.Micro.NameTransformer">
- <summary>
- Class for managing the list of rules for doing name transformation.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.NameTransformer.UseEagerRuleSelection">
- <summary>
- Flag to indicate if transformations from all matched rules are returned. Otherwise, transformations from only the first matched rule are returned.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.NameTransformer.AddRule(System.String,System.String,System.String)">
- <summary>
- Adds a transform using a single replacement value and a global filter pattern.
- </summary>
- <param name = "replacePattern">Regular expression pattern for replacing text</param>
- <param name = "replaceValue">The replacement value.</param>
- <param name = "globalFilterPattern">Regular expression pattern for global filtering</param>
- </member>
- <member name="M:Caliburn.Micro.NameTransformer.AddRule(System.String,System.Collections.Generic.IEnumerable{System.String},System.String)">
- <summary>
- Adds a transform using a list of replacement values and a global filter pattern.
- </summary>
- <param name = "replacePattern">Regular expression pattern for replacing text</param>
- <param name = "replaceValueList">The list of replacement values</param>
- <param name = "globalFilterPattern">Regular expression pattern for global filtering</param>
- </member>
- <member name="M:Caliburn.Micro.NameTransformer.Transform(System.String)">
- <summary>
- Gets the list of transformations for a given name.
- </summary>
- <param name = "source">The name to transform into the resolved name list</param>
- <returns>The transformed names.</returns>
- </member>
- <member name="M:Caliburn.Micro.NameTransformer.Transform(System.String,System.Func{System.String,System.String})">
- <summary>
- Gets the list of transformations for a given name.
- </summary>
- <param name = "source">The name to transform into the resolved name list</param>
- <param name = "getReplaceString">A function to do a transform on each item in the ReplaceValueList prior to applying the regular expression transform</param>
- <returns>The transformed names.</returns>
- </member>
- <member name="T:Caliburn.Micro.NameTransformer.Rule">
- <summary>
- A rule that describes a name transform.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.NameTransformer.Rule.GlobalFilterPattern">
- <summary>
- Regular expression pattern for global filtering
- </summary>
- </member>
- <member name="F:Caliburn.Micro.NameTransformer.Rule.ReplacePattern">
- <summary>
- Regular expression pattern for replacing text
- </summary>
- </member>
- <member name="F:Caliburn.Micro.NameTransformer.Rule.ReplacementValues">
- <summary>
- The list of replacement values
- </summary>
- </member>
- <member name="T:Caliburn.Micro.AttachedCollection`1">
- <summary>
- A collection that can exist as part of a behavior.
- </summary>
- <typeparam name="T">The type of item in the attached collection.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.AttachedCollection`1.#ctor">
- <summary>
- Creates an instance of <see cref="T:Caliburn.Micro.AttachedCollection`1"/>
- </summary>
- </member>
- <member name="M:Caliburn.Micro.AttachedCollection`1.Attach(System.Windows.DependencyObject)">
- <summary>
- Attached the collection.
- </summary>
- <param name="dependencyObject">The dependency object to attach the collection to.</param>
- </member>
- <member name="M:Caliburn.Micro.AttachedCollection`1.Detach">
- <summary>
- Detaches the collection.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.AttachedCollection`1.OnItemAdded(`0)">
- <summary>
- Called when an item is added from the collection.
- </summary>
- <param name="item">The item that was added.</param>
- </member>
- <member name="M:Caliburn.Micro.AttachedCollection`1.OnItemRemoved(`0)">
- <summary>
- Called when an item is removed from the collection.
- </summary>
- <param name="item">The item that was removed.</param>
- </member>
- <member name="T:Caliburn.Micro.Parameter">
- <summary>
- Represents a parameter of an <see cref="T:Caliburn.Micro.ActionMessage"/>.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Parameter.ValueProperty">
- <summary>
- A dependency property representing the parameter's value.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Parameter.Value">
- <summary>
- Gets or sets the value of the parameter.
- </summary>
- <value>The value.</value>
- </member>
- <member name="P:Caliburn.Micro.Parameter.Owner">
- <summary>
- Gets or sets the owner.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Parameter.CreateInstanceCore">
- <summary>
- When implemented in a derived class, creates a new instance of the <see cref="T:System.Windows.Freezable"/> derived class.
- </summary>
- <returns>The new instance.</returns>
- </member>
- <member name="M:Caliburn.Micro.Parameter.MakeAwareOf(Caliburn.Micro.ActionMessage)">
- <summary>
- Makes the parameter aware of the <see cref="T:Caliburn.Micro.ActionMessage"/> that it's attached to.
- </summary>
- <param name="owner">The action message.</param>
- </member>
- <member name="T:Caliburn.Micro.IWindowManager">
- <summary>
- A service that manages windows.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IWindowManager.ShowDialog(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Shows a modal dialog for the specified model.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The context.</param>
- <param name="settings">The optional dialog settings.</param>
- <returns>The dialog result.</returns>
- </member>
- <member name="M:Caliburn.Micro.IWindowManager.ShowWindow(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Shows a non-modal window for the specified model.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The context.</param>
- <param name="settings">The optional window settings.</param>
- </member>
- <member name="M:Caliburn.Micro.IWindowManager.ShowPopup(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Shows a popup at the current mouse position.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The view context.</param>
- <param name="settings">The optional popup settings.</param>
- </member>
- <member name="T:Caliburn.Micro.WindowManager">
- <summary>
- A service that manages windows.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.ShowDialog(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Shows a modal dialog for the specified model.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The context.</param>
- <param name="settings">The dialog popup settings.</param>
- <returns>The dialog result.</returns>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.ShowWindow(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Shows a window for the specified model.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The context.</param>
- <param name="settings">The optional window settings.</param>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.ShowPopup(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Shows a popup at the current mouse position.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The view context.</param>
- <param name="settings">The optional popup settings.</param>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.CreatePopup(System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Creates a popup for hosting a popup window.
- </summary>
- <param name="rootModel">The model.</param>
- <param name="settings">The optional popup settings.</param>
- <returns>The popup.</returns>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.CreateWindow(System.Object,System.Boolean,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Creates a window.
- </summary>
- <param name="rootModel">The view model.</param>
- <param name="isDialog">Whethor or not the window is being shown as a dialog.</param>
- <param name="context">The view context.</param>
- <param name="settings">The optional popup settings.</param>
- <returns>The window.</returns>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.EnsureWindow(System.Object,System.Object,System.Boolean)">
- <summary>
- Makes sure the view is a window is is wrapped by one.
- </summary>
- <param name="model">The view model.</param>
- <param name="view">The view.</param>
- <param name="isDialog">Whethor or not the window is being shown as a dialog.</param>
- <returns>The window.</returns>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.InferOwnerOf(System.Windows.Window)">
- <summary>
- Infers the owner of the window.
- </summary>
- <param name="window">The window to whose owner needs to be determined.</param>
- <returns>The owner.</returns>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.CreatePage(System.Object,System.Object,System.Collections.Generic.IDictionary{System.String,System.Object})">
- <summary>
- Creates the page.
- </summary>
- <param name="rootModel">The root model.</param>
- <param name="context">The context.</param>
- <param name="settings">The optional popup settings.</param>
- <returns>The page.</returns>
- </member>
- <member name="M:Caliburn.Micro.WindowManager.EnsurePage(System.Object,System.Object)">
- <summary>
- Ensures the view is a page or provides one.
- </summary>
- <param name="model">The model.</param>
- <param name="view">The view.</param>
- <returns>The page.</returns>
- </member>
- <member name="T:Caliburn.Micro.Parser">
- <summary>
- Parses text into a fully functional set of <see cref="T:System.Windows.Interactivity.TriggerBase"/> instances with <see cref="T:Caliburn.Micro.ActionMessage"/>.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Parser.Parse(System.Windows.DependencyObject,System.String)">
- <summary>
- Parses the specified message text.
- </summary>
- <param name="target">The target.</param>
- <param name="text">The message text.</param>
- <returns>The triggers parsed from the text.</returns>
- </member>
- <member name="F:Caliburn.Micro.Parser.CreateTrigger">
- <summary>
- The function used to generate a trigger.
- </summary>
- <remarks>The parameters passed to the method are the the target of the trigger and string representing the trigger.</remarks>
- </member>
- <member name="M:Caliburn.Micro.Parser.CreateMessage(System.Windows.DependencyObject,System.String)">
- <summary>
- Creates an instance of <see cref="T:Caliburn.Micro.ActionMessage"/> by parsing out the textual dsl.
- </summary>
- <param name="target">The target of the message.</param>
- <param name="messageText">The textual message dsl.</param>
- <returns>The created message.</returns>
- </member>
- <member name="F:Caliburn.Micro.Parser.InterpretMessageText">
- <summary>
- Function used to parse a string identified as a message.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Parser.CreateParameter">
- <summary>
- Function used to parse a string identified as a message parameter.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Parser.BindParameter(System.Windows.FrameworkElement,Caliburn.Micro.Parameter,System.String,System.String,System.Windows.Data.BindingMode)">
- <summary>
- Creates a binding on a <see cref="T:Caliburn.Micro.Parameter"/>.
- </summary>
- <param name="target">The target to which the message is applied.</param>
- <param name="parameter">The parameter object.</param>
- <param name="elementName">The name of the element to bind to.</param>
- <param name="path">The path of the element to bind to.</param>
- <param name="bindingMode">The binding mode to use.</param>
- </member>
- <member name="T:Caliburn.Micro.RegExHelper">
- <summary>
- Helper class for encoding strings to regular expression patterns
- </summary>
- </member>
- <member name="F:Caliburn.Micro.RegExHelper.NameRegEx">
- <summary>
- Regular expression pattern for valid name
- </summary>
- </member>
- <member name="F:Caliburn.Micro.RegExHelper.SubNamespaceRegEx">
- <summary>
- Regular expression pattern for subnamespace (including dot)
- </summary>
- </member>
- <member name="F:Caliburn.Micro.RegExHelper.NamespaceRegEx">
- <summary>
- Regular expression pattern for namespace or namespace fragment
- </summary>
- </member>
- <member name="M:Caliburn.Micro.RegExHelper.GetCaptureGroup(System.String,System.String)">
- <summary>
- Creates a named capture group with the specified regular expression
- </summary>
- <param name="groupName">Name of capture group to create</param>
- <param name="regEx">Regular expression pattern to capture</param>
- <returns>Regular expression capture group with the specified group name</returns>
- </member>
- <member name="M:Caliburn.Micro.RegExHelper.NamespaceToRegEx(System.String)">
- <summary>
- Converts a namespace (including wildcards) to a regular expression string
- </summary>
- <param name="srcNamespace">Source namespace to convert to regular expression</param>
- <returns>Namespace converted to a regular expression</returns>
- </member>
- <member name="M:Caliburn.Micro.RegExHelper.GetNameCaptureGroup(System.String)">
- <summary>
- Creates a capture group for a valid name regular expression pattern
- </summary>
- <param name="groupName">Name of capture group to create</param>
- <returns>Regular expression capture group with the specified group name</returns>
- </member>
- <member name="M:Caliburn.Micro.RegExHelper.GetNamespaceCaptureGroup(System.String)">
- <summary>
- Creates a capture group for a namespace regular expression pattern
- </summary>
- <param name="groupName">Name of capture group to create</param>
- <returns>Regular expression capture group with the specified group name</returns>
- </member>
- <member name="T:Caliburn.Micro.StringSplitter">
- <summary>
- Helper class when splitting strings
- </summary>
- </member>
- <member name="M:Caliburn.Micro.StringSplitter.Split(System.String,System.Char)">
- <summary>
- Splits a string with a chosen separator.
- If a substring is contained in [...] it will not be splitted.
- </summary>
- <param name="message">The message to split</param>
- <param name="separator">The separator to use when splitting</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.StringSplitter.SplitParameters(System.String)">
- <summary>
- Splits a string with , as separator.
- Does not split within {},[],()
- </summary>
- <param name="parameters">The string to split</param>
- <returns></returns>
- </member>
- <member name="T:Caliburn.Micro.TypeMappingConfiguration">
- <summary>
- Class to specify settings for configuring type mappings by the ViewLocator or ViewModelLocator
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.DefaultSubNamespaceForViews">
- <summary>
- The default subnamespace for Views. Used for creating default subnamespace mappings. Defaults to "Views".
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.DefaultSubNamespaceForViewModels">
- <summary>
- The default subnamespace for ViewModels. Used for creating default subnamespace mappings. Defaults to "ViewModels".
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.UseNameSuffixesInMappings">
- <summary>
- Flag to indicate whether or not the name of the Type should be transformed when adding a type mapping. Defaults to true.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.NameFormat">
- <summary>
- The format string used to compose the name of a type from base name and name suffix
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.IncludeViewSuffixInViewModelNames">
- <summary>
- Flag to indicate if ViewModel names should include View suffixes (i.e. CustomerPageViewModel vs. CustomerViewModel)
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.ViewSuffixList">
- <summary>
- List of View suffixes for which default type mappings should be created. Applies only when UseNameSuffixesInMappings = true.
- Default values are "View", "Page"
- </summary>
- </member>
- <member name="F:Caliburn.Micro.TypeMappingConfiguration.ViewModelSuffix">
- <summary>
- The name suffix for ViewModels. Applies only when UseNameSuffixesInMappings = true. The default is "ViewModel".
- </summary>
- </member>
- <member name="T:Caliburn.Micro.View">
- <summary>
- Hosts attached properties related to view models.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.View.IsLoadedProperty">
- <summary>
- A dependency property which allows the framework to track whether a certain element has already been loaded in certain scenarios.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.View.IsScopeRootProperty">
- <summary>
- A dependency property which marks an element as a name scope root.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.View.ApplyConventionsProperty">
- <summary>
- A dependency property which allows the override of convention application behavior.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.View.ContextProperty">
- <summary>
- A dependency property for assigning a context to a particular portion of the UI.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.View.ModelProperty">
- <summary>
- A dependency property for attaching a model to the UI.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.View.IsGeneratedProperty">
- <summary>
- Used by the framework to indicate that this element was generated.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.View.ExecuteOnLoad(System.Windows.FrameworkElement,System.Windows.RoutedEventHandler)">
- <summary>
- Executes the handler immediately if the element is loaded, otherwise wires it to the Loaded event.
- </summary>
- <param name="element">The element.</param>
- <param name="handler">The handler.</param>
- <returns>true if the handler was executed immediately; false otherwise</returns>
- </member>
- <member name="M:Caliburn.Micro.View.ExecuteOnUnload(System.Windows.FrameworkElement,System.Windows.RoutedEventHandler)">
- <summary>
- Executes the handler when the element is unloaded.
- </summary>
- <param name="element">The element.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.View.ExecuteOnLayoutUpdated(System.Windows.FrameworkElement,System.EventHandler)">
- <summary>
- Executes the handler the next time the elements's LayoutUpdated event fires.
- </summary>
- <param name="element">The element.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="F:Caliburn.Micro.View.GetFirstNonGeneratedView">
- <summary>
- Used to retrieve the root, non-framework-created view.
- </summary>
- <param name="view">The view to search.</param>
- <returns>The root element that was not created by the framework.</returns>
- <remarks>In certain instances the services create UI elements.
- For example, if you ask the window manager to show a UserControl as a dialog, it creates a window to host the UserControl in.
- The WindowManager marks that element as a framework-created element so that it can determine what it created vs. what was intended by the developer.
- Calling GetFirstNonGeneratedView allows the framework to discover what the original element was.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.View.GetApplyConventions(System.Windows.DependencyObject)">
- <summary>
- Gets the convention application behavior.
- </summary>
- <param name="d">The element the property is attached to.</param>
- <returns>Whether or not to apply conventions.</returns>
- </member>
- <member name="M:Caliburn.Micro.View.SetApplyConventions(System.Windows.DependencyObject,System.Nullable{System.Boolean})">
- <summary>
- Sets the convention application behavior.
- </summary>
- <param name="d">The element to attach the property to.</param>
- <param name="value">Whether or not to apply conventions.</param>
- </member>
- <member name="M:Caliburn.Micro.View.SetModel(System.Windows.DependencyObject,System.Object)">
- <summary>
- Sets the model.
- </summary>
- <param name="d">The element to attach the model to.</param>
- <param name="value">The model.</param>
- </member>
- <member name="M:Caliburn.Micro.View.GetModel(System.Windows.DependencyObject)">
- <summary>
- Gets the model.
- </summary>
- <param name="d">The element the model is attached to.</param>
- <returns>The model.</returns>
- </member>
- <member name="M:Caliburn.Micro.View.GetContext(System.Windows.DependencyObject)">
- <summary>
- Gets the context.
- </summary>
- <param name="d">The element the context is attached to.</param>
- <returns>The context.</returns>
- </member>
- <member name="M:Caliburn.Micro.View.SetContext(System.Windows.DependencyObject,System.Object)">
- <summary>
- Sets the context.
- </summary>
- <param name="d">The element to attach the context to.</param>
- <param name="value">The context.</param>
- </member>
- <member name="P:Caliburn.Micro.View.InDesignMode">
- <summary>
- Gets a value that indicates whether the process is running in design mode.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.ViewLocator">
- <summary>
- A strategy for determining which view to use for a given model.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.NameTransformer">
- <summary>
- Used to transform names.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.ContextSeparator">
- <summary>
- Separator used when resolving View names for context instances.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.ConfigureTypeMappings(Caliburn.Micro.TypeMappingConfiguration)">
- <summary>
- Specifies how type mappings are created, including default type mappings. Calling this method will
- clear all existing name transformation rules and create new default type mappings according to the
- configuration.
- </summary>
- <param name="config">An instance of TypeMappingConfiguration that provides the settings for configuration</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddDefaultTypeMapping(System.String)">
- <summary>
- Adds a default type mapping using the standard namespace mapping convention
- </summary>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.RegisterViewSuffix(System.String)">
- <summary>
- This method registers a View suffix or synonym so that View Context resolution works properly.
- It is automatically called internally when calling AddNamespaceMapping(), AddDefaultTypeMapping(),
- or AddTypeMapping(). It should not need to be called explicitly unless a rule that handles synonyms
- is added directly through the NameTransformer.
- </summary>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View".</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddTypeMapping(System.String,System.String,System.String[],System.String)">
- <summary>
- Adds a standard type mapping based on namespace RegEx replace and filter patterns
- </summary>
- <param name="nsSourceReplaceRegEx">RegEx replace pattern for source namespace</param>
- <param name="nsSourceFilterRegEx">RegEx filter pattern for source namespace</param>
- <param name="nsTargetsRegEx">Array of RegEx replace values for target namespaces</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddTypeMapping(System.String,System.String,System.String,System.String)">
- <summary>
- Adds a standard type mapping based on namespace RegEx replace and filter patterns
- </summary>
- <param name="nsSourceReplaceRegEx">RegEx replace pattern for source namespace</param>
- <param name="nsSourceFilterRegEx">RegEx filter pattern for source namespace</param>
- <param name="nsTargetRegEx">RegEx replace value for target namespace</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddNamespaceMapping(System.String,System.String[],System.String)">
- <summary>
- Adds a standard type mapping based on simple namespace mapping
- </summary>
- <param name="nsSource">Namespace of source type</param>
- <param name="nsTargets">Namespaces of target type as an array</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddNamespaceMapping(System.String,System.String,System.String)">
- <summary>
- Adds a standard type mapping based on simple namespace mapping
- </summary>
- <param name="nsSource">Namespace of source type</param>
- <param name="nsTarget">Namespace of target type</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddSubNamespaceMapping(System.String,System.String[],System.String)">
- <summary>
- Adds a standard type mapping by substituting one subnamespace for another
- </summary>
- <param name="nsSource">Subnamespace of source type</param>
- <param name="nsTargets">Subnamespaces of target type as an array</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.AddSubNamespaceMapping(System.String,System.String,System.String)">
- <summary>
- Adds a standard type mapping by substituting one subnamespace for another
- </summary>
- <param name="nsSource">Subnamespace of source type</param>
- <param name="nsTarget">Subnamespace of target type</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.GetOrCreateViewType">
- <summary>
- Retrieves the view from the IoC container or tries to create it if not found.
- </summary>
- <remarks>
- Pass the type of view as a parameter and recieve an instance of the view.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.ModifyModelTypeAtDesignTime">
- <summary>
- Modifies the name of the type to be used at design time.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.TransformName">
- <summary>
- Transforms a ViewModel type name into all of its possible View type names. Optionally accepts an instance
- of context object
- </summary>
- <returns>Enumeration of transformed names</returns>
- <remarks>Arguments:
- typeName = The name of the ViewModel type being resolved to its companion View.
- context = An instance of the context or null.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.LocateTypeForModelType">
- <summary>
- Locates the view type based on the specified model type.
- </summary>
- <returns>The view.</returns>
- <remarks>
- Pass the model type, display location (or null) and the context instance (or null) as parameters and receive a view type.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.LocateForModelType">
- <summary>
- Locates the view for the specified model type.
- </summary>
- <returns>The view.</returns>
- <remarks>
- Pass the model type, display location (or null) and the context instance (or null) as parameters and receive a view instance.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.LocateForModel">
- <summary>
- Locates the view for the specified model instance.
- </summary>
- <returns>The view.</returns>
- <remarks>
- Pass the model instance, display location (or null) and the context (or null) as parameters and receive a view instance.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewLocator.DeterminePackUriFromType">
- <summary>
- Transforms a view type into a pack uri.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ViewLocator.InitializeComponent(System.Object)">
- <summary>
- When a view does not contain a code-behind file, we need to automatically call InitializeCompoent.
- </summary>
- <param name = "element">The element to initialize</param>
- </member>
- <member name="T:Caliburn.Micro.ViewModelBinder">
- <summary>
- Binds a view to a view model.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewModelBinder.ApplyConventionsByDefault">
- <summary>
- Gets or sets a value indicating whether to apply conventions by default.
- </summary>
- <value>
- <c>true</c> if conventions should be applied by default; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="F:Caliburn.Micro.ViewModelBinder.ConventionsAppliedProperty">
- <summary>
- Indicates whether or not the conventions have already been applied to the view.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ViewModelBinder.ShouldApplyConventions(System.Windows.FrameworkElement)">
- <summary>
- Determines whether a view should have conventions applied to it.
- </summary>
- <param name="view">The view to check.</param>
- <returns>Whether or not conventions should be applied to the view.</returns>
- </member>
- <member name="F:Caliburn.Micro.ViewModelBinder.BindProperties">
- <summary>
- Creates data bindings on the view's controls based on the provided properties.
- </summary>
- <remarks>Parameters include named Elements to search through and the type of view model to determine conventions for. Returns unmatched elements.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewModelBinder.BindActions">
- <summary>
- Attaches instances of <see cref="T:Caliburn.Micro.ActionMessage"/> to the view's controls based on the provided methods.
- </summary>
- <remarks>Parameters include the named elements to search through and the type of view model to determine conventions for. Returns unmatched elements.</remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewModelBinder.HandleUnmatchedElements">
- <summary>
- Allows the developer to add custom handling of named elements which were not matched by any default conventions.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewModelBinder.Bind">
- <summary>
- Binds the specified viewModel to the view.
- </summary>
- <remarks>Passes the the view model, view and creation context (or null for default) to use in applying binding.</remarks>
- </member>
- <member name="T:Caliburn.Micro.ViewModelLocator">
- <summary>
- A strategy for determining which view model to use for a given view.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewModelLocator.NameTransformer">
- <summary>
- Used to transform names.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewModelLocator.InterfaceCaptureGroupName">
- <summary>
- The name of the capture group used as a marker for rules that return interface types
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.ConfigureTypeMappings(Caliburn.Micro.TypeMappingConfiguration)">
- <summary>
- Specifies how type mappings are created, including default type mappings. Calling this method will
- clear all existing name transformation rules and create new default type mappings according to the
- configuration.
- </summary>
- <param name="config">An instance of TypeMappingConfiguration that provides the settings for configuration</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddDefaultTypeMapping(System.String)">
- <summary>
- Adds a default type mapping using the standard namespace mapping convention
- </summary>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddTypeMapping(System.String,System.String,System.String[],System.String)">
- <summary>
- Adds a standard type mapping based on namespace RegEx replace and filter patterns
- </summary>
- <param name="nsSourceReplaceRegEx">RegEx replace pattern for source namespace</param>
- <param name="nsSourceFilterRegEx">RegEx filter pattern for source namespace</param>
- <param name="nsTargetsRegEx">Array of RegEx replace values for target namespaces</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddTypeMapping(System.String,System.String,System.String,System.String)">
- <summary>
- Adds a standard type mapping based on namespace RegEx replace and filter patterns
- </summary>
- <param name="nsSourceReplaceRegEx">RegEx replace pattern for source namespace</param>
- <param name="nsSourceFilterRegEx">RegEx filter pattern for source namespace</param>
- <param name="nsTargetRegEx">RegEx replace value for target namespace</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddNamespaceMapping(System.String,System.String[],System.String)">
- <summary>
- Adds a standard type mapping based on simple namespace mapping
- </summary>
- <param name="nsSource">Namespace of source type</param>
- <param name="nsTargets">Namespaces of target type as an array</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddNamespaceMapping(System.String,System.String,System.String)">
- <summary>
- Adds a standard type mapping based on simple namespace mapping
- </summary>
- <param name="nsSource">Namespace of source type</param>
- <param name="nsTarget">Namespace of target type</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddSubNamespaceMapping(System.String,System.String[],System.String)">
- <summary>
- Adds a standard type mapping by substituting one subnamespace for another
- </summary>
- <param name="nsSource">Subnamespace of source type</param>
- <param name="nsTargets">Subnamespaces of target type as an array</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.AddSubNamespaceMapping(System.String,System.String,System.String)">
- <summary>
- Adds a standard type mapping by substituting one subnamespace for another
- </summary>
- <param name="nsSource">Subnamespace of source type</param>
- <param name="nsTarget">Subnamespace of target type</param>
- <param name="viewSuffix">Suffix for type name. Should be "View" or synonym of "View". (Optional)</param>
- </member>
- <member name="M:Caliburn.Micro.ViewModelLocator.MakeInterface(System.String)">
- <summary>
- Makes a type name into an interface name.
- </summary>
- <param name = "typeName">The part.</param>
- <returns></returns>
- </member>
- <member name="F:Caliburn.Micro.ViewModelLocator.TransformName">
- <summary>
- Transforms a View type name into all of its possible ViewModel type names. Accepts a flag
- to include or exclude interface types.
- </summary>
- <returns>Enumeration of transformed names</returns>
- <remarks>Arguments:
- typeName = The name of the View type being resolved to its companion ViewModel.
- includeInterfaces = Flag to indicate if interface types are included
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewModelLocator.LocateTypeForViewType">
- <summary>
- Determines the view model type based on the specified view type.
- </summary>
- <returns>The view model type.</returns>
- <remarks>
- Pass the view type and receive a view model type. Pass true for the second parameter to search for interfaces.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewModelLocator.LocateForViewType">
- <summary>
- Locates the view model for the specified view type.
- </summary>
- <returns>The view model.</returns>
- <remarks>
- Pass the view type as a parameter and receive a view model instance.
- </remarks>
- </member>
- <member name="F:Caliburn.Micro.ViewModelLocator.LocateForView">
- <summary>
- Locates the view model for the specified view instance.
- </summary>
- <returns>The view model.</returns>
- <remarks>
- Pass the view instance as a parameters and receive a view model instance.
- </remarks>
- </member>
- <member name="T:Caliburn.Micro.XamlPlatformProvider">
- <summary>
- A <see cref="T:Caliburn.Micro.IPlatformProvider"/> implementation for the XAML platfrom.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.XamlPlatformProvider"/> class.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.XamlPlatformProvider.InDesignMode">
- <summary>
- Indicates whether or not the framework is in design-time mode.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.BeginOnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name="action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.OnUIThreadAsync(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name="action">The action to execute.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.OnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread.
- </summary>
- <param name="action">The action to execute.</param>
- <exception cref="T:System.NotImplementedException"></exception>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.GetFirstNonGeneratedView(System.Object)">
- <summary>
- Used to retrieve the root, non-framework-created view.
- </summary>
- <param name="view">The view to search.</param>
- <returns>
- The root element that was not created by the framework.
- </returns>
- <remarks>
- In certain instances the services create UI elements.
- For example, if you ask the window manager to show a UserControl as a dialog, it creates a window to host the UserControl in.
- The WindowManager marks that element as a framework-created element so that it can determine what it created vs. what was intended by the developer.
- Calling GetFirstNonGeneratedView allows the framework to discover what the original element was.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.ExecuteOnFirstLoad(System.Object,System.Action{System.Object})">
- <summary>
- Executes the handler the fist time the view is loaded.
- </summary>
- <param name="view">The view.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.ExecuteOnLayoutUpdated(System.Object,System.Action{System.Object})">
- <summary>
- Executes the handler the next time the view's LayoutUpdated event fires.
- </summary>
- <param name="view">The view.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.XamlPlatformProvider.GetViewCloseAction(System.Object,System.Collections.Generic.ICollection{System.Object},System.Nullable{System.Boolean})">
- <summary>
- Get the close action for the specified view model.
- </summary>
- <param name="viewModel">The view model to close.</param>
- <param name="views">The associated views.</param>
- <param name="dialogResult">The dialog result.</param>
- <returns>
- An <see cref="T:Caliburn.Micro.Action" /> to close the view model.
- </returns>
- <exception cref="T:System.NotImplementedException"></exception>
- </member>
- </members>
-</doc>
diff --git a/win/CS/libraries/caliburn/Caliburn.Micro.dll b/win/CS/libraries/caliburn/Caliburn.Micro.dll Binary files differdeleted file mode 100644 index 5d3274650..000000000 --- a/win/CS/libraries/caliburn/Caliburn.Micro.dll +++ /dev/null diff --git a/win/CS/libraries/caliburn/Caliburn.Micro.xml b/win/CS/libraries/caliburn/Caliburn.Micro.xml deleted file mode 100644 index 6061fdf1b..000000000 --- a/win/CS/libraries/caliburn/Caliburn.Micro.xml +++ /dev/null @@ -1,2107 +0,0 @@ -<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Caliburn.Micro</name>
- </assembly>
- <members>
- <member name="T:Caliburn.Micro.ActivationEventArgs">
- <summary>
- EventArgs sent during activation.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActivationEventArgs.WasInitialized">
- <summary>
- Indicates whether the sender was initialized in addition to being activated.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.ActivationProcessedEventArgs">
- <summary>
- Contains details about the success or failure of an item's activation through an <see cref="T:Caliburn.Micro.IConductor"/>.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActivationProcessedEventArgs.Item">
- <summary>
- The item whose activation was processed.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ActivationProcessedEventArgs.Success">
- <summary>
- Gets or sets a value indicating whether the activation was a success.
- </summary>
- <value><c>true</c> if success; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:Caliburn.Micro.BindableCollection`1">
- <summary>
- A base collection class that supports automatic UI thread marshalling.
- </summary>
- <typeparam name="T">The type of elements contained in the collection.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.#ctor">
- <summary>
- Initializes a new instance of the <see cref = "T:Caliburn.Micro.BindableCollection`1" /> class.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Initializes a new instance of the <see cref = "T:Caliburn.Micro.BindableCollection`1" /> class.
- </summary>
- <param name = "collection">The collection from which the elements are copied.</param>
- </member>
- <member name="P:Caliburn.Micro.BindableCollection`1.IsNotifying">
- <summary>
- Enables/Disables property change notification.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.NotifyOfPropertyChange(System.String)">
- <summary>
- Notifies subscribers of the property change.
- </summary>
- <param name = "propertyName">Name of the property.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.Refresh">
- <summary>
- Raises a change notification indicating that all bindings should be refreshed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.InsertItem(System.Int32,`0)">
- <summary>
- Inserts the item to the specified position.
- </summary>
- <param name = "index">The index to insert at.</param>
- <param name = "item">The item to be inserted.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.InsertItemBase(System.Int32,`0)">
- <summary>
- Exposes the base implementation of the <see cref = "M:Caliburn.Micro.BindableCollection`1.InsertItem(System.Int32,`0)" /> function.
- </summary>
- <param name = "index">The index.</param>
- <param name = "item">The item.</param>
- <remarks>
- Used to avoid compiler warning regarding unverifiable code.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.SetItem(System.Int32,`0)">
- <summary>
- Sets the item at the specified position.
- </summary>
- <param name = "index">The index to set the item at.</param>
- <param name = "item">The item to set.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.SetItemBase(System.Int32,`0)">
- <summary>
- Exposes the base implementation of the <see cref = "M:Caliburn.Micro.BindableCollection`1.SetItem(System.Int32,`0)" /> function.
- </summary>
- <param name = "index">The index.</param>
- <param name = "item">The item.</param>
- <remarks>
- Used to avoid compiler warning regarding unverifiable code.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.RemoveItem(System.Int32)">
- <summary>
- Removes the item at the specified position.
- </summary>
- <param name = "index">The position used to identify the item to remove.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.RemoveItemBase(System.Int32)">
- <summary>
- Exposes the base implementation of the <see cref = "M:Caliburn.Micro.BindableCollection`1.RemoveItem(System.Int32)" /> function.
- </summary>
- <param name = "index">The index.</param>
- <remarks>
- Used to avoid compiler warning regarding unverifiable code.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.ClearItems">
- <summary>
- Clears the items contained by the collection.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.ClearItemsBase">
- <summary>
- Exposes the base implementation of the <see cref = "M:Caliburn.Micro.BindableCollection`1.ClearItems" /> function.
- </summary>
- <remarks>
- Used to avoid compiler warning regarding unverifiable code.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.OnCollectionChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
- <summary>
- Raises the <see cref = "E:System.Collections.ObjectModel.ObservableCollection`1.CollectionChanged" /> event with the provided arguments.
- </summary>
- <param name = "e">Arguments of the event being raised.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.OnPropertyChanged(System.ComponentModel.PropertyChangedEventArgs)">
- <summary>
- Raises the PropertyChanged event with the provided arguments.
- </summary>
- <param name = "e">The event data to report in the event.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the range.
- </summary>
- <param name = "items">The items.</param>
- </member>
- <member name="M:Caliburn.Micro.BindableCollection`1.RemoveRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Removes the range.
- </summary>
- <param name = "items">The items.</param>
- </member>
- <member name="T:Caliburn.Micro.Conductor`1">
- <summary>
- An implementation of <see cref="T:Caliburn.Micro.IConductor"/> that holds on to and activates only one item at a time.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.ActivateItem(`0)">
- <summary>
- Activates the specified item.
- </summary>
- <param name="item">The item to activate.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.DeactivateItem(`0,System.Boolean)">
- <summary>
- Deactivates the specified item.
- </summary>
- <param name="item">The item to close.</param>
- <param name="close">Indicates whether or not to close the item after deactivating it.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.CanClose(System.Action{System.Boolean})">
- <summary>
- Called to check whether or not this instance can close.
- </summary>
- <param name="callback">The implementor calls this action with the result of the close check.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.OnActivate">
- <summary>
- Called when activating.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.OnDeactivate(System.Boolean)">
- <summary>
- Called when deactivating.
- </summary>
- <param name="close">Inidicates whether this instance will be closed.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.GetChildren">
- <summary>
- Gets the children.
- </summary>
- <returns>The collection of children.</returns>
- </member>
- <member name="T:Caliburn.Micro.Conductor`1.Collection">
- <summary>
- An implementation of <see cref="T:Caliburn.Micro.IConductor"/> that holds on many items.
- </summary>
- <summary>
- An implementation of <see cref="T:Caliburn.Micro.IConductor"/> that holds on many items.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.Conductor`1.Collection.AllActive">
- <summary>
- An implementation of <see cref="T:Caliburn.Micro.IConductor"/> that holds on to many items wich are all activated.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.Conductor`1.Collection.AllActive"/> class.
- </summary>
- <param name="openPublicItems">if set to <c>true</c> opens public items that are properties of this class.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.Conductor`1.Collection.AllActive"/> class.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Conductor`1.Collection.AllActive.Items">
- <summary>
- Gets the items that are currently being conducted.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.OnActivate">
- <summary>
- Called when activating.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.OnDeactivate(System.Boolean)">
- <summary>
- Called when deactivating.
- </summary>
- <param name="close">Inidicates whether this instance will be closed.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.CanClose(System.Action{System.Boolean})">
- <summary>
- Called to check whether or not this instance can close.
- </summary>
- <param name="callback">The implementor calls this action with the result of the close check.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.OnInitialize">
- <summary>
- Called when initializing.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.ActivateItem(`0)">
- <summary>
- Activates the specified item.
- </summary>
- <param name="item">The item to activate.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.DeactivateItem(`0,System.Boolean)">
- <summary>
- Deactivates the specified item.
- </summary>
- <param name="item">The item to close.</param>
- <param name="close">Indicates whether or not to close the item after deactivating it.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.GetChildren">
- <summary>
- Gets the children.
- </summary>
- <returns>The collection of children.</returns>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.AllActive.EnsureItem(`0)">
- <summary>
- Ensures that an item is ready to be activated.
- </summary>
- <param name="newItem"></param>
- <returns>The item to be activated.</returns>
- </member>
- <member name="T:Caliburn.Micro.Conductor`1.Collection.OneActive">
- <summary>
- An implementation of <see cref="T:Caliburn.Micro.IConductor"/> that holds on many items but only activates one at a time.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.Conductor`1.Collection.OneActive"/> class.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Conductor`1.Collection.OneActive.Items">
- <summary>
- Gets the items that are currently being conducted.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.GetChildren">
- <summary>
- Gets the children.
- </summary>
- <returns>The collection of children.</returns>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.ActivateItem(`0)">
- <summary>
- Activates the specified item.
- </summary>
- <param name="item">The item to activate.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.DeactivateItem(`0,System.Boolean)">
- <summary>
- Deactivates the specified item.
- </summary>
- <param name="item">The item to close.</param>
- <param name="close">Indicates whether or not to close the item after deactivating it.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.DetermineNextItemToActivate(System.Collections.Generic.IList{`0},System.Int32)">
- <summary>
- Determines the next item to activate based on the last active index.
- </summary>
- <param name="list">The list of possible active items.</param>
- <param name="lastIndex">The index of the last active item.</param>
- <returns>The next item to activate.</returns>
- <remarks>Called after an active item is closed.</remarks>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.CanClose(System.Action{System.Boolean})">
- <summary>
- Called to check whether or not this instance can close.
- </summary>
- <param name="callback">The implementor calls this action with the result of the close check.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.OnActivate">
- <summary>
- Called when activating.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.OnDeactivate(System.Boolean)">
- <summary>
- Called when deactivating.
- </summary>
- <param name="close">Inidicates whether this instance will be closed.</param>
- </member>
- <member name="M:Caliburn.Micro.Conductor`1.Collection.OneActive.EnsureItem(`0)">
- <summary>
- Ensures that an item is ready to be activated.
- </summary>
- <param name="newItem"></param>
- <returns>The item to be activated.</returns>
- </member>
- <member name="T:Caliburn.Micro.ConductorBase`1">
- <summary>
- A base class for various implementations of <see cref="T:Caliburn.Micro.IConductor"/>.
- </summary>
- <typeparam name="T">The type that is being conducted.</typeparam>
- </member>
- <member name="P:Caliburn.Micro.ConductorBase`1.CloseStrategy">
- <summary>
- Gets or sets the close strategy.
- </summary>
- <value>The close strategy.</value>
- </member>
- <member name="E:Caliburn.Micro.ConductorBase`1.ActivationProcessed">
- <summary>
- Occurs when an activation request is processed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ConductorBase`1.GetChildren">
- <summary>
- Gets the children.
- </summary>
- <returns>The collection of children.</returns>
- </member>
- <member name="M:Caliburn.Micro.ConductorBase`1.ActivateItem(`0)">
- <summary>
- Activates the specified item.
- </summary>
- <param name="item">The item to activate.</param>
- </member>
- <member name="M:Caliburn.Micro.ConductorBase`1.DeactivateItem(`0,System.Boolean)">
- <summary>
- Deactivates the specified item.
- </summary>
- <param name="item">The item to close.</param>
- <param name="close">Indicates whether or not to close the item after deactivating it.</param>
- </member>
- <member name="M:Caliburn.Micro.ConductorBase`1.OnActivationProcessed(`0,System.Boolean)">
- <summary>
- Called by a subclass when an activation needs processing.
- </summary>
- <param name="item">The item on which activation was attempted.</param>
- <param name="success">if set to <c>true</c> activation was successful.</param>
- </member>
- <member name="M:Caliburn.Micro.ConductorBase`1.EnsureItem(`0)">
- <summary>
- Ensures that an item is ready to be activated.
- </summary>
- <param name="newItem"></param>
- <returns>The item to be activated.</returns>
- </member>
- <member name="T:Caliburn.Micro.ConductorBaseWithActiveItem`1">
- <summary>
- A base class for various implementations of <see cref="T:Caliburn.Micro.IConductor"/> that maintain an active item.
- </summary>
- <typeparam name="T">The type that is being conducted.</typeparam>
- </member>
- <member name="P:Caliburn.Micro.ConductorBaseWithActiveItem`1.ActiveItem">
- <summary>
- The currently active item.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ConductorBaseWithActiveItem`1.Caliburn#Micro#IHaveActiveItem#ActiveItem">
- <summary>
- The currently active item.
- </summary>
- <value></value>
- </member>
- <member name="M:Caliburn.Micro.ConductorBaseWithActiveItem`1.ChangeActiveItem(`0,System.Boolean)">
- <summary>
- Changes the active item.
- </summary>
- <param name="newItem">The new item to activate.</param>
- <param name="closePrevious">Indicates whether or not to close the previous active item.</param>
- </member>
- <member name="T:Caliburn.Micro.ContainerExtensions">
- <summary>
- Extension methods for the <see cref="T:Caliburn.Micro.SimpleContainer"/>.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.Singleton``1(Caliburn.Micro.SimpleContainer,System.String)">
- <summary>
- Registers a singleton.
- </summary>
- <typeparam name="TImplementation">The type of the implementation.</typeparam>
- <param name="container">The container.</param>
- <param name="key">The key.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.Singleton``2(Caliburn.Micro.SimpleContainer,System.String)">
- <summary>
- Registers a singleton.
- </summary>
- <typeparam name="TService">The type of the service.</typeparam>
- <typeparam name="TImplementation">The type of the implementation.</typeparam>
- <param name="container">The container.</param>
- <param name="key">The key.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.PerRequest``1(Caliburn.Micro.SimpleContainer,System.String)">
- <summary>
- Registers an service to be created on each request.
- </summary>
- <typeparam name="TImplementation">The type of the implementation.</typeparam>
- <param name="container">The container.</param>
- <param name="key">The key.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.PerRequest``2(Caliburn.Micro.SimpleContainer,System.String)">
- <summary>
- Registers an service to be created on each request.
- </summary>
- <typeparam name="TService">The type of the service.</typeparam>
- <typeparam name="TImplementation">The type of the implementation.</typeparam>
- <param name="container">The container.</param>
- <param name="key">The key.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.Instance``1(Caliburn.Micro.SimpleContainer,``0)">
- <summary>
- Registers an instance with the container.
- </summary>
- <typeparam name="TService">The type of the service.</typeparam>
- <param name="container">The container.</param>
- <param name="instance">The instance.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.Handler``1(Caliburn.Micro.SimpleContainer,System.Func{Caliburn.Micro.SimpleContainer,System.Object})">
- <summary>
- Registers a custom service handler with the container.
- </summary>
- <typeparam name="TService">The type of the service.</typeparam>
- <param name="container">The container.</param>
- <param name="handler">The handler.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.AllTypesOf``1(Caliburn.Micro.SimpleContainer,System.Reflection.Assembly,System.Func{System.Type,System.Boolean})">
- <summary>
- Registers all specified types in an assembly as singleton in the container.
- </summary>
- <typeparam name="TService">The type of the service.</typeparam>
- <param name="container">The container.</param>
- <param name="assembly">The assembly.</param>
- <param name="filter">The type filter.</param>
- <returns>The container.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.GetInstance``1(Caliburn.Micro.SimpleContainer,System.String)">
- <summary>
- Requests an instance.
- </summary>
- <typeparam name="TService">The type of the service.</typeparam>
- <param name="container">The container.</param>
- <param name="key">The key.</param>
- <returns>The instance.</returns>
- </member>
- <member name="M:Caliburn.Micro.ContainerExtensions.GetAllInstances``1(Caliburn.Micro.SimpleContainer)">
- <summary>
- Gets all instances of a particular type.
- </summary>
- <typeparam name="TService">The type to resolve.</typeparam>
- <param name="container">The container.</param>
- <returns>The resolved instances.</returns>
- </member>
- <member name="T:Caliburn.Micro.ContinueResultDecorator">
- <summary>
- A result decorator which executes a coroutine when the wrapped result was cancelled.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ContinueResultDecorator.#ctor(Caliburn.Micro.IResult,System.Func{Caliburn.Micro.IResult})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.ContinueResultDecorator"/> class.
- </summary>
- <param name="result">The result to decorate.</param>
- <param name="coroutine">The coroutine to execute when <paramref name="result"/> was canceled.</param>
- </member>
- <member name="M:Caliburn.Micro.ContinueResultDecorator.OnInnerResultCompleted(Caliburn.Micro.CoroutineExecutionContext,Caliburn.Micro.IResult,Caliburn.Micro.ResultCompletionEventArgs)">
- <summary>
- Called when the execution of the decorated result has completed.
- </summary>
- <param name="context">The context.</param>
- <param name="innerResult">The decorated result.</param>
- <param name="args">The <see cref="T:Caliburn.Micro.ResultCompletionEventArgs" /> instance containing the event data.</param>
- </member>
- <member name="T:Caliburn.Micro.Coroutine">
- <summary>
- Manages coroutine execution.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.Coroutine.CreateParentEnumerator">
- <summary>
- Creates the parent enumerator.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Coroutine.BeginExecute(System.Collections.Generic.IEnumerator{Caliburn.Micro.IResult},Caliburn.Micro.CoroutineExecutionContext,System.EventHandler{Caliburn.Micro.ResultCompletionEventArgs})">
- <summary>
- Executes a coroutine.
- </summary>
- <param name="coroutine">The coroutine to execute.</param>
- <param name="context">The context to execute the coroutine within.</param>
- /// <param name="callback">The completion callback for the coroutine.</param>
- </member>
- <member name="M:Caliburn.Micro.Coroutine.ExecuteAsync(System.Collections.Generic.IEnumerator{Caliburn.Micro.IResult},Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes a coroutine asynchronous.
- </summary>
- <param name="coroutine">The coroutine to execute.</param>
- <param name="context">The context to execute the coroutine within.</param>
- <returns>A task that represents the asynchronous coroutine.</returns>
- </member>
- <member name="E:Caliburn.Micro.Coroutine.Completed">
- <summary>
- Called upon completion of a coroutine.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.CoroutineExecutionContext">
- <summary>
- The context used during the execution of a Coroutine.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.CoroutineExecutionContext.Source">
- <summary>
- The source from which the message originates.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.CoroutineExecutionContext.View">
- <summary>
- The view associated with the target.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.CoroutineExecutionContext.Target">
- <summary>
- The instance on which the action is invoked.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.DeactivationEventArgs">
- <summary>
- EventArgs sent during deactivation.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.DeactivationEventArgs.WasClosed">
- <summary>
- Indicates whether the sender was closed in addition to being deactivated.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.DebugLog">
- <summary>
- A simple logger thats logs everything to the debugger.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.DebugLog.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.DebugLog"/> class.
- </summary>
- <param name="type">The type.</param>
- </member>
- <member name="M:Caliburn.Micro.DebugLog.Info(System.String,System.Object[])">
- <summary>
- Logs the message as info.
- </summary>
- <param name="format">A formatted message.</param>
- <param name="args">Parameters to be injected into the formatted message.</param>
- </member>
- <member name="M:Caliburn.Micro.DebugLog.Warn(System.String,System.Object[])">
- <summary>
- Logs the message as a warning.
- </summary>
- <param name="format">A formatted message.</param>
- <param name="args">Parameters to be injected into the formatted message.</param>
- </member>
- <member name="M:Caliburn.Micro.DebugLog.Error(System.Exception)">
- <summary>
- Logs the exception.
- </summary>
- <param name="exception">The exception.</param>
- </member>
- <member name="T:Caliburn.Micro.DefaultCloseStrategy`1">
- <summary>
- Used to gather the results from multiple child elements which may or may not prevent closing.
- </summary>
- <typeparam name="T">The type of child element.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.DefaultCloseStrategy`1.#ctor(System.Boolean)">
- <summary>
- Creates an instance of the class.
- </summary>
- <param name="closeConductedItemsWhenConductorCannotClose">Indicates that even if all conducted items are not closable, those that are should be closed. The default is FALSE.</param>
- </member>
- <member name="M:Caliburn.Micro.DefaultCloseStrategy`1.Execute(System.Collections.Generic.IEnumerable{`0},System.Action{System.Boolean,System.Collections.Generic.IEnumerable{`0}})">
- <summary>
- Executes the strategy.
- </summary>
- <param name="toClose">Items that are requesting close.</param>
- <param name="callback">The action to call when all enumeration is complete and the close results are aggregated.
- The bool indicates whether close can occur. The enumerable indicates which children should close if the parent cannot.</param>
- </member>
- <member name="T:Caliburn.Micro.DefaultPlatformProvider">
- <summary>
- Default implementation for <see cref="T:Caliburn.Micro.IPlatformProvider"/> that does no platform enlightenment.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.DefaultPlatformProvider.InDesignMode">
- <summary>
- Indicates whether or not the framework is in design-time mode.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.BeginOnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name="action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.OnUIThreadAsync(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name="action">The action to execute.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.OnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread.
- </summary>
- <param name="action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.GetFirstNonGeneratedView(System.Object)">
- <summary>
- Used to retrieve the root, non-framework-created view.
- </summary>
- <param name="view">The view to search.</param>
- <returns>
- The root element that was not created by the framework.
- </returns>
- <remarks>
- In certain instances the services create UI elements.
- For example, if you ask the window manager to show a UserControl as a dialog, it creates a window to host the UserControl in.
- The WindowManager marks that element as a framework-created element so that it can determine what it created vs. what was intended by the developer.
- Calling GetFirstNonGeneratedView allows the framework to discover what the original element was.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.ExecuteOnFirstLoad(System.Object,System.Action{System.Object})">
- <summary>
- Executes the handler the fist time the view is loaded.
- </summary>
- <param name="view">The view.</param>
- <param name="handler">The handler.</param>
- <returns>true if the handler was executed immediately; false otherwise</returns>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.ExecuteOnLayoutUpdated(System.Object,System.Action{System.Object})">
- <summary>
- Executes the handler the next time the view's LayoutUpdated event fires.
- </summary>
- <param name="view">The view.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.DefaultPlatformProvider.GetViewCloseAction(System.Object,System.Collections.Generic.ICollection{System.Object},System.Nullable{System.Boolean})">
- <summary>
- Get the close action for the specified view model.
- </summary>
- <param name="viewModel">The view model to close.</param>
- <param name="views">The associated views.</param>
- <param name="dialogResult">The dialog result.</param>
- <returns>
- An <see cref="T:System.Action" /> to close the view model.
- </returns>
- </member>
- <member name="T:Caliburn.Micro.DelegateResult">
- <summary>
- A result that executes an <see cref="T:System.Action"/>.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.DelegateResult.#ctor(System.Action)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.DelegateResult"/> class.
- </summary>
- <param name="action">The action.</param>
- </member>
- <member name="M:Caliburn.Micro.DelegateResult.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name="context">The context.</param>
- </member>
- <member name="E:Caliburn.Micro.DelegateResult.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.DelegateResult`1">
- <summary>
- A result that executes a <see cref="T:System.Func`1"/>
- </summary>
- <typeparam name="TResult">The type of the result.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.DelegateResult`1.#ctor(System.Func{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.DelegateResult`1"/> class.
- </summary>
- <param name="action">The action.</param>
- </member>
- <member name="M:Caliburn.Micro.DelegateResult`1.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name="context">The context.</param>
- </member>
- <member name="P:Caliburn.Micro.DelegateResult`1.Result">
- <summary>
- Gets the result.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.DelegateResult`1.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.EnumerableExtensions">
- <summary>
- Extension methods for <see cref="T:System.Collections.Generic.IEnumerable`1"/>
- </summary>
- </member>
- <member name="M:Caliburn.Micro.EnumerableExtensions.Apply``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})">
- <summary>
- Applies the action to each element in the list.
- </summary>
- <typeparam name="T">The enumerable item's type.</typeparam>
- <param name="enumerable">The elements to enumerate.</param>
- <param name="action">The action to apply to each item in the list.</param>
- </member>
- <member name="T:Caliburn.Micro.EventAggregator">
- <summary>
- Enables loosely-coupled publication of and subscription to events.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.EventAggregator.HandlerResultProcessing">
- <summary>
- Processing of handler results on publication thread.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.EventAggregator.HandlerExistsFor(System.Type)">
- <summary>
- Searches the subscribed handlers to check if we have a handler for
- the message type supplied.
- </summary>
- <param name="messageType">The message type to check with</param>
- <returns>True if any handler is found, false if not.</returns>
- </member>
- <member name="M:Caliburn.Micro.EventAggregator.Subscribe(System.Object)">
- <summary>
- Subscribes an instance to all events declared through implementations of <see cref = "T:Caliburn.Micro.IHandle`1" />
- </summary>
- <param name = "subscriber">The instance to subscribe for event publication.</param>
- </member>
- <member name="M:Caliburn.Micro.EventAggregator.Unsubscribe(System.Object)">
- <summary>
- Unsubscribes the instance from all events.
- </summary>
- <param name = "subscriber">The instance to unsubscribe.</param>
- </member>
- <member name="M:Caliburn.Micro.EventAggregator.Publish(System.Object,System.Action{System.Action})">
- <summary>
- Publishes a message.
- </summary>
- <param name = "message">The message instance.</param>
- <param name = "marshal">Allows the publisher to provide a custom thread marshaller for the message publication.</param>
- </member>
- <member name="T:Caliburn.Micro.EventAggregatorExtensions">
- <summary>
- Extensions for <see cref="T:Caliburn.Micro.IEventAggregator"/>.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.EventAggregatorExtensions.PublishOnCurrentThread(Caliburn.Micro.IEventAggregator,System.Object)">
- <summary>
- Publishes a message on the current thread (synchrone).
- </summary>
- <param name="eventAggregator">The event aggregator.</param>
- <param name = "message">The message instance.</param>
- </member>
- <member name="M:Caliburn.Micro.EventAggregatorExtensions.PublishOnBackgroundThread(Caliburn.Micro.IEventAggregator,System.Object)">
- <summary>
- Publishes a message on a background thread (async).
- </summary>
- <param name="eventAggregator">The event aggregator.</param>
- <param name = "message">The message instance.</param>
- </member>
- <member name="M:Caliburn.Micro.EventAggregatorExtensions.PublishOnUIThread(Caliburn.Micro.IEventAggregator,System.Object)">
- <summary>
- Publishes a message on the UI thread.
- </summary>
- <param name="eventAggregator">The event aggregator.</param>
- <param name = "message">The message instance.</param>
- </member>
- <member name="M:Caliburn.Micro.EventAggregatorExtensions.BeginPublishOnUIThread(Caliburn.Micro.IEventAggregator,System.Object)">
- <summary>
- Publishes a message on the UI thread asynchrone.
- </summary>
- <param name="eventAggregator">The event aggregator.</param>
- <param name = "message">The message instance.</param>
- </member>
- <member name="M:Caliburn.Micro.EventAggregatorExtensions.PublishOnUIThreadAsync(Caliburn.Micro.IEventAggregator,System.Object)">
- <summary>
- Publishes a message on the UI thread asynchrone.
- </summary>
- <param name="eventAggregator">The event aggregator.</param>
- <param name="message">The message instance.</param>
- </member>
- <member name="T:Caliburn.Micro.Execute">
- <summary>
- Enables easy marshalling of code to the UI thread.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Execute.InDesignMode">
- <summary>
- Indicates whether or not the framework is in design-time mode.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Execute.BeginOnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name="action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.Execute.OnUIThreadAsync(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name = "action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.Execute.OnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread.
- </summary>
- <param name = "action">The action to execute.</param>
- </member>
- <member name="T:Caliburn.Micro.ExpressionExtensions">
- <summary>
- Extension for <see cref="T:System.Linq.Expressions.Expression"/>.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ExpressionExtensions.GetMemberInfo(System.Linq.Expressions.Expression)">
- <summary>
- Converts an expression into a <see cref="T:System.Reflection.MemberInfo"/>.
- </summary>
- <param name="expression">The expression to convert.</param>
- <returns>The member info.</returns>
- </member>
- <member name="T:Caliburn.Micro.IActivate">
- <summary>
- Denotes an instance which requires activation.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.IActivate.IsActive">
- <summary>
- Indicates whether or not this instance is active.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IActivate.Activate">
- <summary>
- Activates this instance.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.IActivate.Activated">
- <summary>
- Raised after activation occurs.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IChild">
- <summary>
- Denotes a node within a parent/child hierarchy.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.IChild.Parent">
- <summary>
- Gets or Sets the Parent
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IChild`1">
- <summary>
- Denotes a node within a parent/child hierarchy.
- </summary>
- <typeparam name="TParent">The type of parent.</typeparam>
- </member>
- <member name="P:Caliburn.Micro.IChild`1.Parent">
- <summary>
- Gets or Sets the Parent
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IClose">
- <summary>
- Denotes an object that can be closed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IClose.TryClose(System.Nullable{System.Boolean})">
- <summary>
- Tries to close this instance.
- Also provides an opportunity to pass a dialog result to it's corresponding view.
- </summary>
- <param name="dialogResult">The dialog result.</param>
- </member>
- <member name="T:Caliburn.Micro.ICloseStrategy`1">
- <summary>
- Used to gather the results from multiple child elements which may or may not prevent closing.
- </summary>
- <typeparam name="T">The type of child element.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.ICloseStrategy`1.Execute(System.Collections.Generic.IEnumerable{`0},System.Action{System.Boolean,System.Collections.Generic.IEnumerable{`0}})">
- <summary>
- Executes the strategy.
- </summary>
- <param name="toClose">Items that are requesting close.</param>
- <param name="callback">The action to call when all enumeration is complete and the close results are aggregated.
- The bool indicates whether close can occur. The enumerable indicates which children should close if the parent cannot.</param>
- </member>
- <member name="T:Caliburn.Micro.IConductor">
- <summary>
- Denotes an instance which conducts other objects by managing an ActiveItem and maintaining a strict lifecycle.
- </summary>
- <remarks>Conducted instances can optin to the lifecycle by impelenting any of the follosing <see cref="T:Caliburn.Micro.IActivate"/>, <see cref="T:Caliburn.Micro.IDeactivate"/>, <see cref="T:Caliburn.Micro.IGuardClose"/>.</remarks>
- </member>
- <member name="M:Caliburn.Micro.IConductor.ActivateItem(System.Object)">
- <summary>
- Activates the specified item.
- </summary>
- <param name="item">The item to activate.</param>
- </member>
- <member name="M:Caliburn.Micro.IConductor.DeactivateItem(System.Object,System.Boolean)">
- <summary>
- Deactivates the specified item.
- </summary>
- <param name="item">The item to close.</param>
- <param name="close">Indicates whether or not to close the item after deactivating it.</param>
- </member>
- <member name="E:Caliburn.Micro.IConductor.ActivationProcessed">
- <summary>
- Occurs when an activation request is processed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IConductActiveItem">
- <summary>
- An <see cref="T:Caliburn.Micro.IConductor"/> that also implements <see cref="T:Caliburn.Micro.IHaveActiveItem"/>.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IDeactivate">
- <summary>
- Denotes an instance which requires deactivation.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.IDeactivate.AttemptingDeactivation">
- <summary>
- Raised before deactivation.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IDeactivate.Deactivate(System.Boolean)">
- <summary>
- Deactivates this instance.
- </summary>
- <param name="close">Indicates whether or not this instance is being closed.</param>
- </member>
- <member name="E:Caliburn.Micro.IDeactivate.Deactivated">
- <summary>
- Raised after deactivation.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IEventAggregator">
- <summary>
- Enables loosely-coupled publication of and subscription to events.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IEventAggregator.HandlerExistsFor(System.Type)">
- <summary>
- Searches the subscribed handlers to check if we have a handler for
- the message type supplied.
- </summary>
- <param name="messageType">The message type to check with</param>
- <returns>True if any handler is found, false if not.</returns>
- </member>
- <member name="M:Caliburn.Micro.IEventAggregator.Subscribe(System.Object)">
- <summary>
- Subscribes an instance to all events declared through implementations of <see cref = "T:Caliburn.Micro.IHandle`1" />
- </summary>
- <param name = "subscriber">The instance to subscribe for event publication.</param>
- </member>
- <member name="M:Caliburn.Micro.IEventAggregator.Unsubscribe(System.Object)">
- <summary>
- Unsubscribes the instance from all events.
- </summary>
- <param name = "subscriber">The instance to unsubscribe.</param>
- </member>
- <member name="M:Caliburn.Micro.IEventAggregator.Publish(System.Object,System.Action{System.Action})">
- <summary>
- Publishes a message.
- </summary>
- <param name = "message">The message instance.</param>
- <param name = "marshal">Allows the publisher to provide a custom thread marshaller for the message publication.</param>
- </member>
- <member name="T:Caliburn.Micro.IGuardClose">
- <summary>
- Denotes an instance which may prevent closing.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IGuardClose.CanClose(System.Action{System.Boolean})">
- <summary>
- Called to check whether or not this instance can close.
- </summary>
- <param name="callback">The implementer calls this action with the result of the close check.</param>
- </member>
- <member name="T:Caliburn.Micro.IHandle">
- <summary>
- A marker interface for classes that subscribe to messages.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IHandle`1">
- <summary>
- Denotes a class which can handle a particular type of message.
- </summary>
- <typeparam name = "TMessage">The type of message to handle.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.IHandle`1.Handle(`0)">
- <summary>
- Handles the message.
- </summary>
- <param name = "message">The message.</param>
- </member>
- <member name="T:Caliburn.Micro.IHandleWithCoroutine`1">
- <summary>
- Denotes a class which can handle a particular type of message and uses a Coroutine to do so.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IHandleWithCoroutine`1.Handle(`0)">
- <summary>
- Handle the message with a Coroutine.
- </summary>
- <param name="message">The message.</param>
- <returns>The coroutine to execute.</returns>
- </member>
- <member name="T:Caliburn.Micro.IHandleWithTask`1">
- <summary>
- Denotes a class which can handle a particular type of message and uses a Task to do so.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IHandleWithTask`1.Handle(`0)">
- <summary>
- Handle the message with a Task.
- </summary>
- <param name="message">The message.</param>
- <returns>The Task that represents the operation.</returns>
- </member>
- <member name="T:Caliburn.Micro.IHaveActiveItem">
- <summary>
- Denotes an instance which maintains an active item.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.IHaveActiveItem.ActiveItem">
- <summary>
- The currently active item.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IHaveDisplayName">
- <summary>
- Denotes an instance which has a display name.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.IHaveDisplayName.DisplayName">
- <summary>
- Gets or Sets the Display Name
- </summary>
- </member>
- <member name="T:Caliburn.Micro.ILog">
- <summary>
- A logger.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ILog.Info(System.String,System.Object[])">
- <summary>
- Logs the message as info.
- </summary>
- <param name="format">A formatted message.</param>
- <param name="args">Parameters to be injected into the formatted message.</param>
- </member>
- <member name="M:Caliburn.Micro.ILog.Warn(System.String,System.Object[])">
- <summary>
- Logs the message as a warning.
- </summary>
- <param name="format">A formatted message.</param>
- <param name="args">Parameters to be injected into the formatted message.</param>
- </member>
- <member name="M:Caliburn.Micro.ILog.Error(System.Exception)">
- <summary>
- Logs the exception.
- </summary>
- <param name="exception">The exception.</param>
- </member>
- <member name="T:Caliburn.Micro.INotifyPropertyChangedEx">
- <summary>
- Extends <see cref = "T:System.ComponentModel.INotifyPropertyChanged" /> such that the change event can be raised by external parties.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.INotifyPropertyChangedEx.IsNotifying">
- <summary>
- Enables/Disables property change notification.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.INotifyPropertyChangedEx.NotifyOfPropertyChange(System.String)">
- <summary>
- Notifies subscribers of the property change.
- </summary>
- <param name = "propertyName">Name of the property.</param>
- </member>
- <member name="M:Caliburn.Micro.INotifyPropertyChangedEx.Refresh">
- <summary>
- Raises a change notification indicating that all bindings should be refreshed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IObservableCollection`1">
- <summary>
- Represents a collection that is observable.
- </summary>
- <typeparam name = "T">The type of elements contained in the collection.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.IObservableCollection`1.AddRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Adds the range.
- </summary>
- <param name = "items">The items.</param>
- </member>
- <member name="M:Caliburn.Micro.IObservableCollection`1.RemoveRange(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Removes the range.
- </summary>
- <param name = "items">The items.</param>
- </member>
- <member name="T:Caliburn.Micro.IoC">
- <summary>
- Used by the framework to pull instances from an IoC container and to inject dependencies into certain existing classes.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.IoC.GetInstance">
- <summary>
- Gets an instance by type and key.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.IoC.GetAllInstances">
- <summary>
- Gets all instances of a particular type.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.IoC.BuildUp">
- <summary>
- Passes an existing instance to the IoC container to enable dependencies to be injected.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IoC.Get``1(System.String)">
- <summary>
- Gets an instance from the container.
- </summary>
- <typeparam name="T">The type to resolve.</typeparam>
- <param name="key">The key to look up.</param>
- <returns>The resolved instance.</returns>
- </member>
- <member name="M:Caliburn.Micro.IoC.GetAll``1">
- <summary>
- Gets all instances of a particular type.
- </summary>
- <typeparam name="T">The type to resolve.</typeparam>
- <returns>The resolved instances.</returns>
- </member>
- <member name="T:Caliburn.Micro.IParent">
- <summary>
- Interface used to define an object associated to a collection of children.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IParent.GetChildren">
- <summary>
- Gets the children.
- </summary>
- <returns>
- The collection of children.
- </returns>
- </member>
- <member name="T:Caliburn.Micro.IParent`1">
- <summary>
- Interface used to define a specialized parent.
- </summary>
- <typeparam name="T">The type of children.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.IParent`1.GetChildren">
- <summary>
- Gets the children.
- </summary>
- <returns>
- The collection of children.
- </returns>
- </member>
- <member name="T:Caliburn.Micro.IPlatformProvider">
- <summary>
- Interface for platform specific operations that need enlightenment.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.IPlatformProvider.InDesignMode">
- <summary>
- Indicates whether or not the framework is in design-time mode.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.BeginOnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name="action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.OnUIThreadAsync(System.Action)">
- <summary>
- Executes the action on the UI thread asynchronously.
- </summary>
- <param name = "action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.OnUIThread(System.Action)">
- <summary>
- Executes the action on the UI thread.
- </summary>
- <param name = "action">The action to execute.</param>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.GetFirstNonGeneratedView(System.Object)">
- <summary>
- Used to retrieve the root, non-framework-created view.
- </summary>
- <param name="view">The view to search.</param>
- <returns>The root element that was not created by the framework.</returns>
- <remarks>In certain instances the services create UI elements.
- For example, if you ask the window manager to show a UserControl as a dialog, it creates a window to host the UserControl in.
- The WindowManager marks that element as a framework-created element so that it can determine what it created vs. what was intended by the developer.
- Calling GetFirstNonGeneratedView allows the framework to discover what the original element was.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.ExecuteOnFirstLoad(System.Object,System.Action{System.Object})">
- <summary>
- Executes the handler the fist time the view is loaded.
- </summary>
- <param name="view">The view.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.ExecuteOnLayoutUpdated(System.Object,System.Action{System.Object})">
- <summary>
- Executes the handler the next time the view's LayoutUpdated event fires.
- </summary>
- <param name="view">The view.</param>
- <param name="handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.IPlatformProvider.GetViewCloseAction(System.Object,System.Collections.Generic.ICollection{System.Object},System.Nullable{System.Boolean})">
- <summary>
- Get the close action for the specified view model.
- </summary>
- <param name="viewModel">The view model to close.</param>
- <param name="views">The associated views.</param>
- <param name="dialogResult">The dialog result.</param>
- <returns>An <see cref="T:System.Action"/> to close the view model.</returns>
- </member>
- <member name="T:Caliburn.Micro.IResult">
- <summary>
- Allows custom code to execute after the return of a action.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IResult.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name="context">The context.</param>
- </member>
- <member name="E:Caliburn.Micro.IResult.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IResult`1">
- <summary>
- Allows custom code to execute after the return of a action.
- </summary>
- <typeparam name="TResult">The type of the result.</typeparam>
- </member>
- <member name="P:Caliburn.Micro.IResult`1.Result">
- <summary>
- Gets the result of the asynchronous operation.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IScreen">
- <summary>
- Denotes an instance which implements <see cref="T:Caliburn.Micro.IHaveDisplayName"/>, <see cref="T:Caliburn.Micro.IActivate"/>,
- <see cref="T:Caliburn.Micro.IDeactivate"/>, <see cref="T:Caliburn.Micro.IGuardClose"/> and <see cref="T:Caliburn.Micro.INotifyPropertyChangedEx"/>
- </summary>
- </member>
- <member name="T:Caliburn.Micro.IViewAware">
- <summary>
- Denotes a class which is aware of its view(s).
- </summary>
- </member>
- <member name="M:Caliburn.Micro.IViewAware.AttachView(System.Object,System.Object)">
- <summary>
- Attaches a view to this instance.
- </summary>
- <param name="view">The view.</param>
- <param name="context">The context in which the view appears.</param>
- </member>
- <member name="M:Caliburn.Micro.IViewAware.GetView(System.Object)">
- <summary>
- Gets a view previously attached to this instance.
- </summary>
- <param name="context">The context denoting which view to retrieve.</param>
- <returns>The view.</returns>
- </member>
- <member name="E:Caliburn.Micro.IViewAware.ViewAttached">
- <summary>
- Raised when a view is attached.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.LogManager">
- <summary>
- Used to manage logging.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.LogManager.GetLog">
- <summary>
- Creates an <see cref="T:Caliburn.Micro.ILog"/> for the provided type.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.OverrideCancelResultDecorator">
- <summary>
- A result decorator that overrides <see cref="F:Caliburn.Micro.ResultCompletionEventArgs.WasCancelled"/> of the decorated <see cref="T:Caliburn.Micro.IResult"/> instance.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.OverrideCancelResultDecorator.#ctor(Caliburn.Micro.IResult)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.OverrideCancelResultDecorator"/> class.
- </summary>
- <param name="result">The result to decorate.</param>
- </member>
- <member name="M:Caliburn.Micro.OverrideCancelResultDecorator.OnInnerResultCompleted(Caliburn.Micro.CoroutineExecutionContext,Caliburn.Micro.IResult,Caliburn.Micro.ResultCompletionEventArgs)">
- <summary>
- Called when the execution of the decorated result has completed.
- </summary>
- <param name="context">The context.</param>
- <param name="innerResult">The decorated result.</param>
- <param name="args">The <see cref="T:Caliburn.Micro.ResultCompletionEventArgs" /> instance containing the event data.</param>
- </member>
- <member name="T:Caliburn.Micro.PlatformProvider">
- <summary>
- Access the current <see cref="T:Caliburn.Micro.IPlatformProvider"/>.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.PlatformProvider.Current">
- <summary>
- Gets or sets the current <see cref="T:Caliburn.Micro.IPlatformProvider"/>.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.PropertyChangedBase">
- <summary>
- A base class that implements the infrastructure for property change notification and automatically performs UI thread marshalling.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.PropertyChangedBase.#ctor">
- <summary>
- Creates an instance of <see cref = "T:Caliburn.Micro.PropertyChangedBase" />.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.PropertyChangedBase.PropertyChanged">
- <summary>
- Occurs when a property value changes.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.PropertyChangedBase.IsNotifying">
- <summary>
- Enables/Disables property change notification.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.PropertyChangedBase.Refresh">
- <summary>
- Raises a change notification indicating that all bindings should be refreshed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.PropertyChangedBase.NotifyOfPropertyChange(System.String)">
- <summary>
- Notifies subscribers of the property change.
- </summary>
- <param name = "propertyName">Name of the property.</param>
- </member>
- <member name="M:Caliburn.Micro.PropertyChangedBase.NotifyOfPropertyChange``1(System.Linq.Expressions.Expression{System.Func{``0}})">
- <summary>
- Notifies subscribers of the property change.
- </summary>
- <typeparam name = "TProperty">The type of the property.</typeparam>
- <param name = "property">The property expression.</param>
- </member>
- <member name="M:Caliburn.Micro.PropertyChangedBase.OnPropertyChanged(System.ComponentModel.PropertyChangedEventArgs)">
- <summary>
- Raises the <see cref="E:Caliburn.Micro.PropertyChangedBase.PropertyChanged" /> event directly.
- </summary>
- <param name="e">The <see cref="T:System.ComponentModel.PropertyChangedEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="T:Caliburn.Micro.PortableReflectionExtensions">
- <summary>
- A collection of extension methods to help with differing reflection between the portable library and SL5
- </summary>
- </member>
- <member name="T:Caliburn.Micro.RescueResultDecorator`1">
- <summary>
- A result decorator which rescues errors from the decorated result by executing a rescue coroutine.
- </summary>
- <typeparam name="TException">The type of the exception we want to perform the rescue on</typeparam>
- </member>
- <member name="M:Caliburn.Micro.RescueResultDecorator`1.#ctor(Caliburn.Micro.IResult,System.Func{`0,Caliburn.Micro.IResult},System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.RescueResultDecorator`1"/> class.
- </summary>
- <param name="result">The result to decorate.</param>
- <param name="coroutine">The rescue coroutine.</param>
- <param name="cancelResult">Set to true to cancel the result after executing rescue.</param>
- </member>
- <member name="M:Caliburn.Micro.RescueResultDecorator`1.OnInnerResultCompleted(Caliburn.Micro.CoroutineExecutionContext,Caliburn.Micro.IResult,Caliburn.Micro.ResultCompletionEventArgs)">
- <summary>
- Called when the execution of the decorated result has completed.
- </summary>
- <param name="context">The context.</param>
- <param name="innerResult">The decorated result.</param>
- <param name="args">The <see cref="T:Caliburn.Micro.ResultCompletionEventArgs" /> instance containing the event data.</param>
- </member>
- <member name="T:Caliburn.Micro.SimpleResult">
- <summary>
- A simple result.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SimpleResult.Succeeded">
- <summary>
- A result that is always succeeded.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SimpleResult.Cancelled">
- <summary>
- A result that is always canceled.
- </summary>
- <returns>The result.</returns>
- </member>
- <member name="M:Caliburn.Micro.SimpleResult.Failed(System.Exception)">
- <summary>
- A result that is always failed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SimpleResult.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name="context">The context.</param>
- </member>
- <member name="E:Caliburn.Micro.SimpleResult.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.ResultCompletionEventArgs">
- <summary>
- The event args for the Completed event of an <see cref="T:Caliburn.Micro.IResult"/>.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ResultCompletionEventArgs.Error">
- <summary>
- Gets or sets the error if one occurred.
- </summary>
- <value>The error.</value>
- </member>
- <member name="F:Caliburn.Micro.ResultCompletionEventArgs.WasCancelled">
- <summary>
- Gets or sets a value indicating whether the result was cancelled.
- </summary>
- <value><c>true</c> if cancelled; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:Caliburn.Micro.ResultDecoratorBase">
- <summary>
- Base class for all <see cref="T:Caliburn.Micro.IResult"/> decorators.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ResultDecoratorBase.#ctor(Caliburn.Micro.IResult)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.ResultDecoratorBase"/> class.
- </summary>
- <param name="result">The result to decorate.</param>
- </member>
- <member name="M:Caliburn.Micro.ResultDecoratorBase.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name="context">The context.</param>
- </member>
- <member name="M:Caliburn.Micro.ResultDecoratorBase.OnInnerResultCompleted(Caliburn.Micro.CoroutineExecutionContext,Caliburn.Micro.IResult,Caliburn.Micro.ResultCompletionEventArgs)">
- <summary>
- Called when the execution of the decorated result has completed.
- </summary>
- <param name="context">The context.</param>
- <param name="innerResult">The decorated result.</param>
- <param name="args">The <see cref="T:Caliburn.Micro.ResultCompletionEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="E:Caliburn.Micro.ResultDecoratorBase.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ResultDecoratorBase.OnCompleted(Caliburn.Micro.ResultCompletionEventArgs)">
- <summary>
- Raises the <see cref="E:Caliburn.Micro.ResultDecoratorBase.Completed" /> event.
- </summary>
- <param name="args">The <see cref="T:Caliburn.Micro.ResultCompletionEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="T:Caliburn.Micro.ResultExtensions">
- <summary>
- Extension methods for <see cref="T:Caliburn.Micro.IResult"/> instances.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ResultExtensions.WhenCancelled(Caliburn.Micro.IResult,System.Func{Caliburn.Micro.IResult})">
- <summary>
- Adds behavior to the result which is executed when the <paramref name ="result"/> was cancelled.
- </summary>
- <param name="result">The result to decorate.</param>
- <param name="coroutine">The coroutine to execute when <paramref name="result"/> was canceled.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.ResultExtensions.OverrideCancel(Caliburn.Micro.IResult)">
- <summary>
- Overrides <see cref="F:Caliburn.Micro.ResultCompletionEventArgs.WasCancelled"/> of the decorated <paramref name="result"/> instance.
- </summary>
- <param name="result">The result to decorate.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.ResultExtensions.Rescue``1(Caliburn.Micro.IResult,System.Func{``0,Caliburn.Micro.IResult},System.Boolean)">
- <summary>
- Rescues <typeparamref name="TException"/> from the decorated <paramref name="result"/> by executing a <paramref name="rescue"/> coroutine.
- </summary>
- <typeparam name = "TException">The type of the exception we want to perform the rescue on.</typeparam>
- <param name="result">The result to decorate.</param>
- <param name="rescue">The rescue coroutine.</param>
- <param name="cancelResult">Set to true to cancel the result after executing rescue.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.ResultExtensions.Rescue(Caliburn.Micro.IResult,System.Func{System.Exception,Caliburn.Micro.IResult},System.Boolean)">
- <summary>
- Rescues any exception from the decorated <paramref name="result"/> by executing a <paramref name="rescue"/> coroutine.
- </summary>
- <param name="result">The result to decorate.</param>
- <param name="rescue">The rescue coroutine.</param>
- <param name="cancelResult">Set to true to cancel the result after executing rescue.</param>
- <returns></returns>
- </member>
- <member name="T:Caliburn.Micro.Screen">
- <summary>
- A base implementation of <see cref = "T:Caliburn.Micro.IScreen" />.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Screen.#ctor">
- <summary>
- Creates an instance of the screen.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Screen.Parent">
- <summary>
- Gets or Sets the Parent <see cref = "T:Caliburn.Micro.IConductor" />
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Screen.DisplayName">
- <summary>
- Gets or Sets the Display Name
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Screen.IsActive">
- <summary>
- Indicates whether or not this instance is currently active.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.Screen.IsInitialized">
- <summary>
- Indicates whether or not this instance is currently initialized.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.Screen.Activated">
- <summary>
- Raised after activation occurs.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.Screen.AttemptingDeactivation">
- <summary>
- Raised before deactivation.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.Screen.Deactivated">
- <summary>
- Raised after deactivation.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Screen.OnInitialize">
- <summary>
- Called when initializing.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Screen.OnActivate">
- <summary>
- Called when activating.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.Screen.OnDeactivate(System.Boolean)">
- <summary>
- Called when deactivating.
- </summary>
- <param name = "close">Inidicates whether this instance will be closed.</param>
- </member>
- <member name="M:Caliburn.Micro.Screen.CanClose(System.Action{System.Boolean})">
- <summary>
- Called to check whether or not this instance can close.
- </summary>
- <param name = "callback">The implementor calls this action with the result of the close check.</param>
- </member>
- <member name="M:Caliburn.Micro.Screen.TryClose(System.Nullable{System.Boolean})">
- <summary>
- Tries to close this instance by asking its Parent to initiate shutdown or by asking its corresponding view to close.
- Also provides an opportunity to pass a dialog result to it's corresponding view.
- </summary>
- <param name="dialogResult">The dialog result.</param>
- </member>
- <member name="T:Caliburn.Micro.ScreenExtensions">
- <summary>
- Hosts extension methods for <see cref="T:Caliburn.Micro.IScreen"/> classes.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.TryActivate(System.Object)">
- <summary>
- Activates the item if it implements <see cref="T:Caliburn.Micro.IActivate"/>, otherwise does nothing.
- </summary>
- <param name="potentialActivatable">The potential activatable.</param>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.TryDeactivate(System.Object,System.Boolean)">
- <summary>
- Deactivates the item if it implements <see cref="T:Caliburn.Micro.IDeactivate"/>, otherwise does nothing.
- </summary>
- <param name="potentialDeactivatable">The potential deactivatable.</param>
- <param name="close">Indicates whether or not to close the item after deactivating it.</param>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.CloseItem(Caliburn.Micro.IConductor,System.Object)">
- <summary>
- Closes the specified item.
- </summary>
- <param name="conductor">The conductor.</param>
- <param name="item">The item to close.</param>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.CloseItem``1(Caliburn.Micro.ConductorBase{``0},``0)">
- <summary>
- Closes the specified item.
- </summary>
- <param name="conductor">The conductor.</param>
- <param name="item">The item to close.</param>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.ActivateWith(Caliburn.Micro.IActivate,Caliburn.Micro.IActivate)">
- <summary>
- Activates a child whenever the specified parent is activated.
- </summary>
- <param name="child">The child to activate.</param>
- <param name="parent">The parent whose activation triggers the child's activation.</param>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.DeactivateWith(Caliburn.Micro.IDeactivate,Caliburn.Micro.IDeactivate)">
- <summary>
- Deactivates a child whenever the specified parent is deactivated.
- </summary>
- <param name="child">The child to deactivate.</param>
- <param name="parent">The parent whose deactivation triggers the child's deactivation.</param>
- </member>
- <member name="M:Caliburn.Micro.ScreenExtensions.ConductWith``2(``0,``1)">
- <summary>
- Activates and Deactivates a child whenever the specified parent is Activated or Deactivated.
- </summary>
- <param name="child">The child to activate/deactivate.</param>
- <param name="parent">The parent whose activation/deactivation triggers the child's activation/deactivation.</param>
- </member>
- <member name="T:Caliburn.Micro.SequentialResult">
- <summary>
- An implementation of <see cref = "T:Caliburn.Micro.IResult" /> that enables sequential execution of multiple results.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SequentialResult.#ctor(System.Collections.Generic.IEnumerator{Caliburn.Micro.IResult})">
- <summary>
- Initializes a new instance of the <see cref = "T:Caliburn.Micro.SequentialResult" /> class.
- </summary>
- <param name = "enumerator">The enumerator.</param>
- </member>
- <member name="E:Caliburn.Micro.SequentialResult.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SequentialResult.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name = "context">The context.</param>
- </member>
- <member name="T:Caliburn.Micro.SimpleContainer">
- <summary>
- A simple IoC container.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.#ctor">
- <summary>
- Initializes a new instance of the <see cref = "T:Caliburn.Micro.SimpleContainer" /> class.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.RegisterInstance(System.Type,System.String,System.Object)">
- <summary>
- Registers the instance.
- </summary>
- <param name = "service">The service.</param>
- <param name = "key">The key.</param>
- <param name = "implementation">The implementation.</param>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.RegisterPerRequest(System.Type,System.String,System.Type)">
- <summary>
- Registers the class so that a new instance is created on every request.
- </summary>
- <param name = "service">The service.</param>
- <param name = "key">The key.</param>
- <param name = "implementation">The implementation.</param>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.RegisterSingleton(System.Type,System.String,System.Type)">
- <summary>
- Registers the class so that it is created once, on first request, and the same instance is returned to all requestors thereafter.
- </summary>
- <param name = "service">The service.</param>
- <param name = "key">The key.</param>
- <param name = "implementation">The implementation.</param>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.RegisterHandler(System.Type,System.String,System.Func{Caliburn.Micro.SimpleContainer,System.Object})">
- <summary>
- Registers a custom handler for serving requests from the container.
- </summary>
- <param name = "service">The service.</param>
- <param name = "key">The key.</param>
- <param name = "handler">The handler.</param>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.UnregisterHandler(System.Type,System.String)">
- <summary>
- Unregisters any handlers for the service/key that have previously been registered.
- </summary>
- <param name = "service">The service.</param>
- <param name = "key">The key.</param>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.GetInstance(System.Type,System.String)">
- <summary>
- Requests an instance.
- </summary>
- <param name = "service">The service.</param>
- <param name = "key">The key.</param>
- <returns>The instance, or null if a handler is not found.</returns>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.HasHandler(System.Type,System.String)">
- <summary>
- Determines if a handler for the service/key has previously been registered.
- </summary>
- <param name="service">The service.</param>
- <param name="key">The key.</param>
- <returns>True if a handler is registere; false otherwise.</returns>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.GetAllInstances(System.Type)">
- <summary>
- Requests all instances of a given type.
- </summary>
- <param name = "service">The service.</param>
- <returns>All the instances or an empty enumerable if none are found.</returns>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.BuildUp(System.Object)">
- <summary>
- Pushes dependencies into an existing instance based on interface properties with setters.
- </summary>
- <param name = "instance">The instance.</param>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.CreateChildContainer">
- <summary>
- Creates a child container.
- </summary>
- <returns>A new container.</returns>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.BuildInstance(System.Type)">
- <summary>
- Actually does the work of creating the instance and satisfying it's constructor dependencies.
- </summary>
- <param name = "type">The type.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.SimpleContainer.ActivateInstance(System.Type,System.Object[])">
- <summary>
- Creates an instance of the type with the specified constructor arguments.
- </summary>
- <param name = "type">The type.</param>
- <param name = "args">The constructor args.</param>
- <returns>The created instance.</returns>
- </member>
- <member name="E:Caliburn.Micro.SimpleContainer.Activated">
- <summary>
- Occurs when a new instance is created.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.TaskExtensions">
- <summary>
- Extension methods to bring <see cref="T:System.Threading.Tasks.Task"/> and <see cref="T:Caliburn.Micro.IResult"/> together.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.TaskExtensions.ExecuteAsync(Caliburn.Micro.IResult,Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes an <see cref="T:Caliburn.Micro.IResult"/> asynchronous.
- </summary>
- <param name="result">The coroutine to execute.</param>
- <param name="context">The context to execute the coroutine within.</param>
- <returns>A task that represents the asynchronous coroutine.</returns>
- </member>
- <member name="M:Caliburn.Micro.TaskExtensions.ExecuteAsync``1(Caliburn.Micro.IResult{``0},Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes an <see cref="T:Caliburn.Micro.IResult`1"/> asynchronous.
- </summary>
- <typeparam name="TResult">The type of the result.</typeparam>
- <param name="result">The coroutine to execute.</param>
- <param name="context">The context to execute the coroutine within.</param>
- <returns>A task that represents the asynchronous coroutine.</returns>
- </member>
- <member name="M:Caliburn.Micro.TaskExtensions.AsResult(System.Threading.Tasks.Task)">
- <summary>
- Encapsulates a task inside a couroutine.
- </summary>
- <param name="task">The task.</param>
- <returns>The coroutine that encapsulates the task.</returns>
- </member>
- <member name="M:Caliburn.Micro.TaskExtensions.AsResult``1(System.Threading.Tasks.Task{``0})">
- <summary>
- Encapsulates a task inside a couroutine.
- </summary>
- <typeparam name="TResult">The type of the result.</typeparam>
- <param name="task">The task.</param>
- <returns>The coroutine that encapsulates the task.</returns>
- </member>
- <member name="T:Caliburn.Micro.TaskResult">
- <summary>
- A couroutine that encapsulates an <see cref="T:System.Threading.Tasks.Task"/>.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.TaskResult.#ctor(System.Threading.Tasks.Task)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.TaskResult"/> class.
- </summary>
- <param name="task">The task.</param>
- </member>
- <member name="M:Caliburn.Micro.TaskResult.Execute(Caliburn.Micro.CoroutineExecutionContext)">
- <summary>
- Executes the result using the specified context.
- </summary>
- <param name="context">The context.</param>
- </member>
- <member name="M:Caliburn.Micro.TaskResult.OnCompleted(System.Threading.Tasks.Task)">
- <summary>
- Called when the asynchronous task has completed.
- </summary>
- <param name="task">The completed task.</param>
- </member>
- <member name="E:Caliburn.Micro.TaskResult.Completed">
- <summary>
- Occurs when execution has completed.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.TaskResult`1">
- <summary>
- A couroutine that encapsulates an <see cref="T:System.Threading.Tasks.Task`1"/>.
- </summary>
- <typeparam name="TResult">The type of the result.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.TaskResult`1.#ctor(System.Threading.Tasks.Task{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.TaskResult`1"/> class.
- </summary>
- <param name="task">The task.</param>
- </member>
- <member name="P:Caliburn.Micro.TaskResult`1.Result">
- <summary>
- Gets the result of the asynchronous operation.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.TaskResult`1.OnCompleted(System.Threading.Tasks.Task)">
- <summary>
- Called when the asynchronous task has completed.
- </summary>
- <param name="task">The completed task.</param>
- </member>
- <member name="T:Caliburn.Micro.ViewAttachedEventArgs">
- <summary>
- The event args for the <see cref="E:Caliburn.Micro.IViewAware.ViewAttached"/> event.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewAttachedEventArgs.View">
- <summary>
- The view.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewAttachedEventArgs.Context">
- <summary>
- The context.
- </summary>
- </member>
- <member name="T:Caliburn.Micro.ViewAware">
- <summary>
- A base implementation of <see cref = "T:Caliburn.Micro.IViewAware" /> which is capable of caching views by context.
- </summary>
- </member>
- <member name="F:Caliburn.Micro.ViewAware.DefaultContext">
- <summary>
- The default view context.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.ViewAware.Views">
- <summary>
- The view chache for this instance.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ViewAware.#ctor">
- <summary>
- Creates an instance of <see cref="T:Caliburn.Micro.ViewAware"/>.
- </summary>
- </member>
- <member name="E:Caliburn.Micro.ViewAware.ViewAttached">
- <summary>
- Raised when a view is attached.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.ViewAware.OnViewAttached(System.Object,System.Object)">
- <summary>
- Called when a view is attached.
- </summary>
- <param name="view">The view.</param>
- <param name="context">The context in which the view appears.</param>
- </member>
- <member name="M:Caliburn.Micro.ViewAware.OnViewLoaded(System.Object)">
- <summary>
- Called when an attached view's Loaded event fires.
- </summary>
- <param name = "view"></param>
- </member>
- <member name="M:Caliburn.Micro.ViewAware.OnViewReady(System.Object)">
- <summary>
- Called the first time the page's LayoutUpdated event fires after it is navigated to.
- </summary>
- <param name = "view"></param>
- </member>
- <member name="M:Caliburn.Micro.ViewAware.GetView(System.Object)">
- <summary>
- Gets a view previously attached to this instance.
- </summary>
- <param name = "context">The context denoting which view to retrieve.</param>
- <returns>The view.</returns>
- </member>
- <member name="T:Caliburn.Micro.WeakValueDictionary`2">
- <summary>
- A dictionary in which the values are weak references.
- </summary>
- <typeparam name="TKey">The type of keys in the dictionary.</typeparam>
- <typeparam name="TValue">The type of values in the dictionary.</typeparam>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> class that is empty, has the default initial capacity, and uses the default equality comparer for the key type.
- </summary>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.#ctor(System.Collections.Generic.IDictionary{`0,`1})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> class that contains elements copied from the specified <see cref="T:System.Collections.Generic.IDictionary`2"/> and uses the default equality comparer for the key type.
- </summary>
- <param name="dictionary">The <see cref="T:System.Collections.Generic.IDictionary`2"/> whose elements are copied to the new <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.</param>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.#ctor(System.Collections.Generic.IDictionary{`0,`1},System.Collections.Generic.IEqualityComparer{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> class that contains elements copied from the specified <see cref="T:System.Collections.Generic.IDictionary`2"/> and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1"/>.
- </summary>
- <param name="dictionary">The <see cref="T:System.Collections.Generic.IDictionary`2"/> whose elements are copied to the new <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.</param>
- <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> implementation to use when comparing keys, or null to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1"/> for the type of the key.</param>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.#ctor(System.Collections.Generic.IEqualityComparer{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> class that is empty, has the default initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1"/>.
- </summary>
- <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> implementation to use when comparing keys, or null to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1"/> for the type of the key.</param>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> class that is empty, has the specified initial capacity, and uses the default equality comparer for the key type.
- </summary>
- <param name="capacity">The initial number of elements that the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> can contain.</param>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.#ctor(System.Int32,System.Collections.Generic.IEqualityComparer{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> class that is empty, has the specified initial capacity, and uses the specified <see cref="T:System.Collections.Generic.IEqualityComparer`1"/>.
- </summary>
- <param name="capacity">The initial number of elements that the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> can contain.</param>
- <param name="comparer">The <see cref="T:System.Collections.Generic.IEqualityComparer`1"/> implementation to use when comparing keys, or null to use the default <see cref="T:System.Collections.Generic.EqualityComparer`1"/> for the type of the key.</param>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.
- </summary>
- <returns>The enumerator.</returns>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.Clear">
- <summary>
- Removes all keys and values from the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.WeakValueDictionary`2.Count">
- <summary>
- Gets the number of key/value pairs contained in the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.
- </summary>
- <remarks>
- Since the items in the dictionary are held by weak reference, the count value
- cannot be relied upon to guarantee the number of objects that would be discovered via
- enumeration. Treat the Count as an estimate only.
- </remarks>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.Add(`0,`1)">
- <summary>
- Adds the specified key and value to the dictionary.
- </summary>
- <param name="key">The key of the element to add.</param>
- <param name="value">The value of the element to add. The value can be null for reference types.</param>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.ContainsKey(`0)">
- <summary>
- Determines whether the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> contains the specified key.
- </summary>
- <param name="key">The key to locate in the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.</param>
- <returns></returns>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.Remove(`0)">
- <summary>
- Removes the value with the specified key from the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.
- </summary>
- <param name="key">The key of the element to remove.</param>
- <returns>true if the element is successfully found and removed; otherwise, false. This method returns false if key is not found in the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.</returns>
- </member>
- <member name="M:Caliburn.Micro.WeakValueDictionary`2.TryGetValue(`0,`1@)">
- <summary>
- Gets the value associated with the specified key.
- </summary>
- <param name="key">The key of the value to get.</param>
- <param name="value">
- When this method returns, contains the value associated with the specified key,
- if the key is found; otherwise, the default value for the type of the value parameter.
- This parameter is passed uninitialized.</param>
- <returns>true if the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/> contains an element with the specified key; otherwise, false.</returns>
- </member>
- <member name="P:Caliburn.Micro.WeakValueDictionary`2.Item(`0)">
- <summary>
- Gets or sets the value associated with the specified key.
- </summary>
- <param name="key">The key of the value to get or set.</param>
- <returns>
- The value associated with the specified key. If the specified key is not found, a get operation throws a <see cref="T:System.Collections.Generic.KeyNotFoundException"/>,
- and a set operation creates a new element with the specified key.
- </returns>
- </member>
- <member name="P:Caliburn.Micro.WeakValueDictionary`2.Keys">
- <summary>
- Gets a collection containing the keys in the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.
- </summary>
- </member>
- <member name="P:Caliburn.Micro.WeakValueDictionary`2.Values">
- <summary>
- Gets a collection containing the values in the <see cref="T:Caliburn.Micro.WeakValueDictionary`2"/>.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/win/CS/libraries/caliburn/License.txt b/win/CS/libraries/caliburn/License.txt deleted file mode 100644 index c8dad30bd..000000000 --- a/win/CS/libraries/caliburn/License.txt +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License
-
-Copyright (c) 2010 Blue Spire Consulting, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
\ No newline at end of file diff --git a/win/CS/libraries/json/Newtonsoft.Json.dll b/win/CS/libraries/json/Newtonsoft.Json.dll Binary files differdeleted file mode 100644 index eb5082442..000000000 --- a/win/CS/libraries/json/Newtonsoft.Json.dll +++ /dev/null diff --git a/win/CS/libraries/json/Newtonsoft.Json.xml b/win/CS/libraries/json/Newtonsoft.Json.xml deleted file mode 100644 index 7208c9f53..000000000 --- a/win/CS/libraries/json/Newtonsoft.Json.xml +++ /dev/null @@ -1,8889 +0,0 @@ -<?xml version="1.0"?>
-<doc>
- <assembly>
- <name>Newtonsoft.Json</name>
- </assembly>
- <members>
- <member name="T:Newtonsoft.Json.Bson.BsonObjectId">
- <summary>
- Represents a BSON Oid (object id).
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Bson.BsonObjectId.Value">
- <summary>
- Gets or sets the value of the Oid.
- </summary>
- <value>The value of the Oid.</value>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonObjectId.#ctor(System.Byte[])">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/> class.
- </summary>
- <param name="value">The Oid value.</param>
- </member>
- <member name="T:Newtonsoft.Json.Bson.BsonReader">
- <summary>
- Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Bson.BsonReader.JsonNet35BinaryCompatibility">
- <summary>
- Gets or sets a value indicating whether binary data reading should compatible with incorrect Json.NET 3.5 written binary.
- </summary>
- <value>
- <c>true</c> if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Bson.BsonReader.ReadRootValueAsArray">
- <summary>
- Gets or sets a value indicating whether the root object will be read as a JSON array.
- </summary>
- <value>
- <c>true</c> if the root object will be read as a JSON array; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Bson.BsonReader.DateTimeKindHandling">
- <summary>
- Gets or sets the <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.
- </summary>
- <value>The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</value>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
- </summary>
- <param name="stream">The stream.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
- </summary>
- <param name="reader">The reader.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.Stream,System.Boolean,System.DateTimeKind)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
- </summary>
- <param name="stream">The stream.</param>
- <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param>
- <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.#ctor(System.IO.BinaryReader,System.Boolean,System.DateTimeKind)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonReader"/> class.
- </summary>
- <param name="reader">The reader.</param>
- <param name="readRootValueAsArray">if set to <c>true</c> the root object will be read as a JSON array.</param>
- <param name="dateTimeKindHandling">The <see cref="T:System.DateTimeKind" /> used when reading <see cref="T:System.DateTime"/> values from BSON.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsBytes">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Byte"/>[].
- </summary>
- <returns>
- A <see cref="T:System.Byte"/>[] or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsDecimal">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsInt32">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsString">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.String"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsDateTime">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.ReadAsDateTimeOffset">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>
- A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.Read">
- <summary>
- Reads the next JSON token from the stream.
- </summary>
- <returns>
- true if the next token was read successfully; false if there are no more tokens to read.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonReader.Close">
- <summary>
- Changes the <see cref="T:Newtonsoft.Json.JsonReader.State"/> to Closed.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Bson.BsonWriter">
- <summary>
- Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Bson.BsonWriter.DateTimeKindHandling">
- <summary>
- Gets or sets the <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.
- When set to <see cref="F:System.DateTimeKind.Unspecified" /> no conversion will occur.
- </summary>
- <value>The <see cref="T:System.DateTimeKind" /> used when writing <see cref="T:System.DateTime"/> values to BSON.</value>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonWriter"/> class.
- </summary>
- <param name="stream">The stream.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.#ctor(System.IO.BinaryWriter)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Bson.BsonWriter"/> class.
- </summary>
- <param name="writer">The writer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.Flush">
- <summary>
- Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
- <summary>
- Writes the end.
- </summary>
- <param name="token">The token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteComment(System.String)">
- <summary>
- Writes out a comment <code>/*...*/</code> containing the specified text.
- </summary>
- <param name="text">Text to place inside the comment.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartConstructor(System.String)">
- <summary>
- Writes the start of a constructor with the given name.
- </summary>
- <param name="name">The name of the constructor.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRaw(System.String)">
- <summary>
- Writes raw JSON.
- </summary>
- <param name="json">The raw JSON to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRawValue(System.String)">
- <summary>
- Writes raw JSON where a value is expected and updates the writer's state.
- </summary>
- <param name="json">The raw JSON to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartArray">
- <summary>
- Writes the beginning of a JSON array.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteStartObject">
- <summary>
- Writes the beginning of a JSON object.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WritePropertyName(System.String)">
- <summary>
- Writes the property name of a name/value pair on a JSON object.
- </summary>
- <param name="name">The name of the property.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.Close">
- <summary>
- Closes this stream and the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Object)">
- <summary>
- Writes a <see cref="T:System.Object"/> value.
- An error will raised if the value cannot be written as a single JSON token.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteNull">
- <summary>
- Writes a null value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteUndefined">
- <summary>
- Writes an undefined value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.String)">
- <summary>
- Writes a <see cref="T:System.String"/> value.
- </summary>
- <param name="value">The <see cref="T:System.String"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int32)">
- <summary>
- Writes a <see cref="T:System.Int32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt32)">
- <summary>
- Writes a <see cref="T:System.UInt32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int64)">
- <summary>
- Writes a <see cref="T:System.Int64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt64)">
- <summary>
- Writes a <see cref="T:System.UInt64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Single)">
- <summary>
- Writes a <see cref="T:System.Single"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Single"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Double)">
- <summary>
- Writes a <see cref="T:System.Double"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Double"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Boolean)">
- <summary>
- Writes a <see cref="T:System.Boolean"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Int16)">
- <summary>
- Writes a <see cref="T:System.Int16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.UInt16)">
- <summary>
- Writes a <see cref="T:System.UInt16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Char)">
- <summary>
- Writes a <see cref="T:System.Char"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Char"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte)">
- <summary>
- Writes a <see cref="T:System.Byte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.SByte)">
- <summary>
- Writes a <see cref="T:System.SByte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.SByte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Decimal)">
- <summary>
- Writes a <see cref="T:System.Decimal"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTime)">
- <summary>
- Writes a <see cref="T:System.DateTime"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.DateTimeOffset)">
- <summary>
- Writes a <see cref="T:System.DateTimeOffset"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Byte[])">
- <summary>
- Writes a <see cref="T:System.Byte"/>[] value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Guid)">
- <summary>
- Writes a <see cref="T:System.Guid"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Guid"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.TimeSpan)">
- <summary>
- Writes a <see cref="T:System.TimeSpan"/> value.
- </summary>
- <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteValue(System.Uri)">
- <summary>
- Writes a <see cref="T:System.Uri"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Uri"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteObjectId(System.Byte[])">
- <summary>
- Writes a <see cref="T:System.Byte"/>[] value that represents a BSON object id.
- </summary>
- <param name="value">The Object ID value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Bson.BsonWriter.WriteRegex(System.String,System.String)">
- <summary>
- Writes a BSON regex.
- </summary>
- <param name="pattern">The regex pattern.</param>
- <param name="options">The regex options.</param>
- </member>
- <member name="T:Newtonsoft.Json.ConstructorHandling">
- <summary>
- Specifies how constructors are used when initializing objects during deserialization by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ConstructorHandling.Default">
- <summary>
- First attempt to use the public default constructor, then fall back to single paramatized constructor, then the non-public default constructor.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ConstructorHandling.AllowNonPublicDefaultConstructor">
- <summary>
- Json.NET will use a non-public default constructor before falling back to a paramatized constructor.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Converters.BinaryConverter">
- <summary>
- Converts a binary value to and from a base 64 string value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.BinaryConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.BinaryConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.BinaryConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.BsonObjectIdConverter">
- <summary>
- Converts a <see cref="T:Newtonsoft.Json.Bson.BsonObjectId"/> to and from JSON and BSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.BsonObjectIdConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.CustomCreationConverter`1">
- <summary>
- Create a custom object
- </summary>
- <typeparam name="T">The object type to convert.</typeparam>
- </member>
- <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.Create(System.Type)">
- <summary>
- Creates an object which will then be populated by the serializer.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>The created object.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Converters.CustomCreationConverter`1.CanWrite">
- <summary>
- Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
- </summary>
- <value>
- <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:Newtonsoft.Json.Converters.DataSetConverter">
- <summary>
- Converts a <see cref="T:System.Data.DataSet"/> to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DataSetConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DataSetConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DataSetConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified value type.
- </summary>
- <param name="valueType">Type of the value.</param>
- <returns>
- <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.DataTableConverter">
- <summary>
- Converts a <see cref="T:System.Data.DataTable"/> to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DataTableConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DataTableConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DataTableConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified value type.
- </summary>
- <param name="valueType">Type of the value.</param>
- <returns>
- <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.DateTimeConverterBase">
- <summary>
- Provides a base class for converting a <see cref="T:System.DateTime"/> to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DateTimeConverterBase.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.DiscriminatedUnionConverter">
- <summary>
- Converts a F# discriminated union type to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.DiscriminatedUnionConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.EntityKeyMemberConverter">
- <summary>
- Converts an Entity Framework EntityKey to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.EntityKeyMemberConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.ExpandoObjectConverter">
- <summary>
- Converts an ExpandoObject to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Converters.ExpandoObjectConverter.CanWrite">
- <summary>
- Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
- </summary>
- <value>
- <c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="T:Newtonsoft.Json.Converters.IsoDateTimeConverter">
- <summary>
- Converts a <see cref="T:System.DateTime"/> to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z).
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeStyles">
- <summary>
- Gets or sets the date time styles used when converting a date to and from JSON.
- </summary>
- <value>The date time styles used when converting a date to and from JSON.</value>
- </member>
- <member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.DateTimeFormat">
- <summary>
- Gets or sets the date time format used when converting a date to and from JSON.
- </summary>
- <value>The date time format used when converting a date to and from JSON.</value>
- </member>
- <member name="P:Newtonsoft.Json.Converters.IsoDateTimeConverter.Culture">
- <summary>
- Gets or sets the culture used when converting a date to and from JSON.
- </summary>
- <value>The culture used when converting a date to and from JSON.</value>
- </member>
- <member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.IsoDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter">
- <summary>
- Converts a <see cref="T:System.DateTime"/> to and from a JavaScript date constructor (e.g. new Date(52231943)).
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.JavaScriptDateTimeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing property value of the JSON that is being converted.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.KeyValuePairConverter">
- <summary>
- Converts a <see cref="T:System.Collections.Generic.KeyValuePair`2"/> to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.KeyValuePairConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.RegexConverter">
- <summary>
- Converts a <see cref="T:System.Text.RegularExpressions.Regex"/> to and from JSON and BSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.RegexConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.RegexConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.RegexConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.StringEnumConverter">
- <summary>
- Converts an <see cref="T:System.Enum"/> to and from its name string value.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Converters.StringEnumConverter.CamelCaseText">
- <summary>
- Gets or sets a value indicating whether the written enum text should be camel case.
- </summary>
- <value><c>true</c> if the written enum text will be camel case; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Converters.StringEnumConverter.AllowIntegerValues">
- <summary>
- Gets or sets a value indicating whether integer values are allowed.
- </summary>
- <value><c>true</c> if integers are allowed; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Converters.StringEnumConverter"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.StringEnumConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.VersionConverter">
- <summary>
- Converts a <see cref="T:System.Version"/> to and from a string (e.g. "1.2.3.4").
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Converters.VersionConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.VersionConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing property value of the JSON that is being converted.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.VersionConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Converters.XmlNodeConverter">
- <summary>
- Converts XML to and from JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.DeserializeRootElementName">
- <summary>
- Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produces multiple root elements.
- </summary>
- <value>The name of the deserialize root element.</value>
- </member>
- <member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.WriteArrayAttribute">
- <summary>
- 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.
- </summary>
- <value><c>true</c> if the array attibute is written to the XML; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Converters.XmlNodeConverter.OmitRootObject">
- <summary>
- Gets or sets a value indicating whether to write the root JSON object.
- </summary>
- <value><c>true</c> if the JSON root object is omitted; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="serializer">The calling serializer.</param>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.IsNamespaceAttribute(System.String,System.String@)">
- <summary>
- Checks if the attributeName is a namespace attribute.
- </summary>
- <param name="attributeName">Attribute name to test.</param>
- <param name="prefix">The attribute name prefix if it has one, otherwise an empty string.</param>
- <returns>True if attribute name is for a namespace attribute, otherwise false.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Converters.XmlNodeConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified value type.
- </summary>
- <param name="valueType">Type of the value.</param>
- <returns>
- <c>true</c> if this instance can convert the specified value type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.FloatParseHandling">
- <summary>
- Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.FloatParseHandling.Double">
- <summary>
- Floating point numbers are parsed to <see cref="F:Newtonsoft.Json.FloatParseHandling.Double"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.FloatParseHandling.Decimal">
- <summary>
- Floating point numbers are parsed to <see cref="F:Newtonsoft.Json.FloatParseHandling.Decimal"/>.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.DateFormatHandling">
- <summary>
- Specifies how dates are formatted when writing JSON text.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateFormatHandling.IsoDateFormat">
- <summary>
- Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z".
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateFormatHandling.MicrosoftDateFormat">
- <summary>
- Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/".
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.DateParseHandling">
- <summary>
- Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateParseHandling.None">
- <summary>
- Date formatted strings are not parsed to a date type and are read as strings.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateParseHandling.DateTime">
- <summary>
- Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTime"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset">
- <summary>
- Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to <see cref="F:Newtonsoft.Json.DateParseHandling.DateTimeOffset"/>.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.DateTimeZoneHandling">
- <summary>
- Specifies how to treat the time value when converting between string and <see cref="T:System.DateTime"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateTimeZoneHandling.Local">
- <summary>
- Treat as local time. If the <see cref="T:System.DateTime"/> object represents a Coordinated Universal Time (UTC), it is converted to the local time.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateTimeZoneHandling.Utc">
- <summary>
- Treat as a UTC. If the <see cref="T:System.DateTime"/> object represents a local time, it is converted to a UTC.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateTimeZoneHandling.Unspecified">
- <summary>
- Treat as a local time if a <see cref="T:System.DateTime"/> is being converted to a string.
- If a string is being converted to <see cref="T:System.DateTime"/>, convert to a local time if a time zone is specified.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DateTimeZoneHandling.RoundtripKind">
- <summary>
- Time zone information should be preserved when converting.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.DefaultValueHandling">
- <summary>
- Specifies default value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingObject" title="DefaultValueHandling Class" />
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeDefaultValueHandlingExample" title="DefaultValueHandling Ignore Example" />
- </example>
- </member>
- <member name="F:Newtonsoft.Json.DefaultValueHandling.Include">
- <summary>
- 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.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DefaultValueHandling.Ignore">
- <summary>
- Ignore members where the member value is the same as the member's default value when serializing objects
- so that is is not written to JSON.
- This option will ignore all default values (e.g. <c>null</c> for objects and nullable types; <c>0</c> for integers,
- decimals and floating point numbers; and <c>false</c> for booleans). The default value ignored can be changed by
- placing the <see cref="T:System.ComponentModel.DefaultValueAttribute"/> on the property.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DefaultValueHandling.Populate">
- <summary>
- Members with a default value but no JSON will be set to their default value when deserializing.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.DefaultValueHandling.IgnoreAndPopulate">
- <summary>
- Ignore members where the member value is the same as the member's default value when serializing objects
- and sets members to their default value when deserializing.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.FloatFormatHandling">
- <summary>
- Specifies float format handling options when writing special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
- <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/> with <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.FloatFormatHandling.String">
- <summary>
- Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity".
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.FloatFormatHandling.Symbol">
- <summary>
- Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity.
- Note that this will produce non-valid JSON.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.FloatFormatHandling.DefaultValue">
- <summary>
- Write special floating point values as the property's default value in JSON, e.g. 0.0 for a <see cref="T:System.Double"/> property, null for a <see cref="T:System.Nullable`1"/> property.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Formatting">
- <summary>
- Specifies formatting options for the <see cref="T:Newtonsoft.Json.JsonTextWriter"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Formatting.None">
- <summary>
- No special formatting is applied. This is the default.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Formatting.Indented">
- <summary>
- Causes child objects to be indented according to the <see cref="P:Newtonsoft.Json.JsonTextWriter.Indentation"/> and <see cref="P:Newtonsoft.Json.JsonTextWriter.IndentChar"/> settings.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.IJsonLineInfo">
- <summary>
- Provides an interface to enable a class to return line and position information.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.IJsonLineInfo.HasLineInfo">
- <summary>
- Gets a value indicating whether the class can return line information.
- </summary>
- <returns>
- <c>true</c> if LineNumber and LinePosition can be provided; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.IJsonLineInfo.LineNumber">
- <summary>
- Gets the current line number.
- </summary>
- <value>The current line number or 0 if no line information is available (for example, HasLineInfo returns false).</value>
- </member>
- <member name="P:Newtonsoft.Json.IJsonLineInfo.LinePosition">
- <summary>
- Gets the current line position.
- </summary>
- <value>The current line position or 0 if no line information is available (for example, HasLineInfo returns false).</value>
- </member>
- <member name="T:Newtonsoft.Json.JsonArrayAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the collection.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonArrayAttribute.AllowNullItems">
- <summary>
- Gets or sets a value indicating whether null items are allowed in the collection.
- </summary>
- <value><c>true</c> if null items are allowed in the collection; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonArrayAttribute"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with a flag indicating whether the array can contain null items
- </summary>
- <param name="allowNullItems">A flag indicating whether the array can contain null items.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonArrayAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonArrayAttribute"/> class with the specified container Id.
- </summary>
- <param name="id">The container Id.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonConstructorAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to use the specified constructor when deserializing that object.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonContainerAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.Id">
- <summary>
- Gets or sets the id.
- </summary>
- <value>The id.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.Title">
- <summary>
- Gets or sets the title.
- </summary>
- <value>The title.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.Description">
- <summary>
- Gets or sets the description.
- </summary>
- <value>The description.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterType">
- <summary>
- Gets the collection's items converter.
- </summary>
- <value>The collection's items converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemConverterParameters">
- <summary>
- The parameter list to use when constructing the JsonConverter described by ItemConverterType.
- If null, the default constructor is used.
- When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number,
- order, and type of these parameters.
- </summary>
- <example>
- [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
- </example>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.IsReference">
- <summary>
- Gets or sets a value that indicates whether to preserve object references.
- </summary>
- <value>
- <c>true</c> to keep object reference; otherwise, <c>false</c>. The default is <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemIsReference">
- <summary>
- Gets or sets a value that indicates whether to preserve collection's items references.
- </summary>
- <value>
- <c>true</c> to keep collection's items object references; otherwise, <c>false</c>. The default is <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemReferenceLoopHandling">
- <summary>
- Gets or sets the reference loop handling used when serializing the collection's items.
- </summary>
- <value>The reference loop handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonContainerAttribute.ItemTypeNameHandling">
- <summary>
- Gets or sets the type name handling used when serializing the collection's items.
- </summary>
- <value>The type name handling.</value>
- </member>
- <member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonContainerAttribute"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonContainerAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonContainerAttribute"/> class with the specified container Id.
- </summary>
- <param name="id">The container Id.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonConvert">
- <summary>
- Provides methods for converting between common language runtime types and JSON types.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="SerializeObject" title="Serializing and Deserializing JSON with JsonConvert" />
- </example>
- </member>
- <member name="P:Newtonsoft.Json.JsonConvert.DefaultSettings">
- <summary>
- Gets or sets a function that creates default <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- Default settings are automatically used by serialization methods on <see cref="T:Newtonsoft.Json.JsonConvert"/>,
- and <see cref="M:Newtonsoft.Json.Linq.JToken.ToObject``1"/> and <see cref="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)"/> on <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- To serialize without using any default settings create a <see cref="T:Newtonsoft.Json.JsonSerializer"/> with
- <see cref="M:Newtonsoft.Json.JsonSerializer.Create"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.True">
- <summary>
- Represents JavaScript's boolean value true as a string. This field is read-only.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.False">
- <summary>
- Represents JavaScript's boolean value false as a string. This field is read-only.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.Null">
- <summary>
- Represents JavaScript's null as a string. This field is read-only.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.Undefined">
- <summary>
- Represents JavaScript's undefined as a string. This field is read-only.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.PositiveInfinity">
- <summary>
- Represents JavaScript's positive infinity as a string. This field is read-only.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.NegativeInfinity">
- <summary>
- Represents JavaScript's negative infinity as a string. This field is read-only.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonConvert.NaN">
- <summary>
- Represents JavaScript's NaN as a string. This field is read-only.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime)">
- <summary>
- Converts the <see cref="T:System.DateTime"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTime,Newtonsoft.Json.DateFormatHandling,Newtonsoft.Json.DateTimeZoneHandling)">
- <summary>
- Converts the <see cref="T:System.DateTime"/> to its JSON string representation using the <see cref="T:Newtonsoft.Json.DateFormatHandling"/> specified.
- </summary>
- <param name="value">The value to convert.</param>
- <param name="format">The format the date will be converted to.</param>
- <param name="timeZoneHandling">The time zone handling when the date is converted to a string.</param>
- <returns>A JSON string representation of the <see cref="T:System.DateTime"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset)">
- <summary>
- Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.DateTimeOffset,Newtonsoft.Json.DateFormatHandling)">
- <summary>
- Converts the <see cref="T:System.DateTimeOffset"/> to its JSON string representation using the <see cref="T:Newtonsoft.Json.DateFormatHandling"/> specified.
- </summary>
- <param name="value">The value to convert.</param>
- <param name="format">The format the date will be converted to.</param>
- <returns>A JSON string representation of the <see cref="T:System.DateTimeOffset"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Boolean)">
- <summary>
- Converts the <see cref="T:System.Boolean"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Boolean"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Char)">
- <summary>
- Converts the <see cref="T:System.Char"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Char"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Enum)">
- <summary>
- Converts the <see cref="T:System.Enum"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Enum"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int32)">
- <summary>
- Converts the <see cref="T:System.Int32"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Int32"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int16)">
- <summary>
- Converts the <see cref="T:System.Int16"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Int16"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt16)">
- <summary>
- Converts the <see cref="T:System.UInt16"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.UInt16"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt32)">
- <summary>
- Converts the <see cref="T:System.UInt32"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.UInt32"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Int64)">
- <summary>
- Converts the <see cref="T:System.Int64"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Int64"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.UInt64)">
- <summary>
- Converts the <see cref="T:System.UInt64"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.UInt64"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Single)">
- <summary>
- Converts the <see cref="T:System.Single"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Single"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Double)">
- <summary>
- Converts the <see cref="T:System.Double"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Double"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Byte)">
- <summary>
- Converts the <see cref="T:System.Byte"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Byte"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.SByte)">
- <summary>
- Converts the <see cref="T:System.SByte"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Decimal)">
- <summary>
- Converts the <see cref="T:System.Decimal"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.SByte"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Guid)">
- <summary>
- Converts the <see cref="T:System.Guid"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Guid"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.TimeSpan)">
- <summary>
- Converts the <see cref="T:System.TimeSpan"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.TimeSpan"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Uri)">
- <summary>
- Converts the <see cref="T:System.Uri"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Uri"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String)">
- <summary>
- Converts the <see cref="T:System.String"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char)">
- <summary>
- Converts the <see cref="T:System.String"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <param name="delimiter">The string delimiter character.</param>
- <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.String,System.Char,Newtonsoft.Json.StringEscapeHandling)">
- <summary>
- Converts the <see cref="T:System.String"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <param name="delimiter">The string delimiter character.</param>
- <param name="stringEscapeHandling">The string escape handling.</param>
- <returns>A JSON string representation of the <see cref="T:System.String"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.ToString(System.Object)">
- <summary>
- Converts the <see cref="T:System.Object"/> to its JSON string representation.
- </summary>
- <param name="value">The value to convert.</param>
- <returns>A JSON string representation of the <see cref="T:System.Object"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object)">
- <summary>
- Serializes the specified object to a JSON string.
- </summary>
- <param name="value">The object to serialize.</param>
- <returns>A JSON string representation of the object.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting)">
- <summary>
- Serializes the specified object to a JSON string using formatting.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <returns>
- A JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Serializes the specified object to a JSON string using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="converters">A collection converters used while serializing.</param>
- <returns>A JSON string representation of the object.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Serializes the specified object to a JSON string using formatting and a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="converters">A collection converters used while serializing.</param>
- <returns>A JSON string representation of the object.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Serializes the specified object to a JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
- If this is null, default serialization settings will be used.</param>
- <returns>
- A JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
- If this is null, default serialization settings will be used.</param>
- <param name="type">
- The type of the value being serialized.
- This parameter is used when <see cref="T:Newtonsoft.Json.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match.
- Specifing the type is optional.
- </param>
- <returns>
- A JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Serializes the specified object to a JSON string using formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
- If this is null, default serialization settings will be used.</param>
- <returns>
- A JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObject(System.Object,System.Type,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Serializes the specified object to a JSON string using a type, formatting and <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
- If this is null, default serialization settings will be used.</param>
- <param name="type">
- The type of the value being serialized.
- This parameter is used when <see cref="T:Newtonsoft.Json.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match.
- Specifing the type is optional.
- </param>
- <returns>
- A JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObjectAsync(System.Object)">
- <summary>
- Asynchronously serializes the specified object to a JSON string.
- Serialization will happen on a new thread.
- </summary>
- <param name="value">The object to serialize.</param>
- <returns>
- A task that represents the asynchronous serialize operation. The value of the <c>TResult</c> parameter contains a JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObjectAsync(System.Object,Newtonsoft.Json.Formatting)">
- <summary>
- Asynchronously serializes the specified object to a JSON string using formatting.
- Serialization will happen on a new thread.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <returns>
- A task that represents the asynchronous serialize operation. The value of the <c>TResult</c> parameter contains a JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeObjectAsync(System.Object,Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Asynchronously serializes the specified object to a JSON string using formatting and a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
- Serialization will happen on a new thread.
- </summary>
- <param name="value">The object to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="settings">The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to serialize the object.
- If this is null, default serialization settings will be used.</param>
- <returns>
- A task that represents the asynchronous serialize operation. The value of the <c>TResult</c> parameter contains a JSON string representation of the object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String)">
- <summary>
- Deserializes the JSON to a .NET object.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Deserializes the JSON to a .NET object using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type)">
- <summary>
- Deserializes the JSON to the specified .NET type.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <param name="type">The <see cref="T:System.Type"/> of object being deserialized.</param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String)">
- <summary>
- Deserializes the JSON to the specified .NET type.
- </summary>
- <typeparam name="T">The type of the object to deserialize to.</typeparam>
- <param name="value">The JSON to deserialize.</param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0)">
- <summary>
- Deserializes the JSON to the given anonymous type.
- </summary>
- <typeparam name="T">
- The anonymous type to deserialize to. This can't be specified
- traditionally and must be infered from the anonymous type passed
- as a parameter.
- </typeparam>
- <param name="value">The JSON to deserialize.</param>
- <param name="anonymousTypeObject">The anonymous type object.</param>
- <returns>The deserialized anonymous type from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeAnonymousType``1(System.String,``0,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Deserializes the JSON to the given anonymous type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <typeparam name="T">
- The anonymous type to deserialize to. This can't be specified
- traditionally and must be infered from the anonymous type passed
- as a parameter.
- </typeparam>
- <param name="value">The JSON to deserialize.</param>
- <param name="anonymousTypeObject">The anonymous type object.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>The deserialized anonymous type from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
- </summary>
- <typeparam name="T">The type of the object to deserialize to.</typeparam>
- <param name="value">The JSON to deserialize.</param>
- <param name="converters">Converters to use while deserializing.</param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject``1(System.String,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <typeparam name="T">The type of the object to deserialize to.</typeparam>
- <param name="value">The object to deserialize.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Deserializes the JSON to the specified .NET type using a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <param name="type">The type of the object to deserialize.</param>
- <param name="converters">Converters to use while deserializing.</param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObject(System.String,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <param name="type">The type of the object to deserialize to.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>The deserialized object from the JSON string.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync``1(System.String)">
- <summary>
- Asynchronously deserializes the JSON to the specified .NET type.
- Deserialization will happen on a new thread.
- </summary>
- <typeparam name="T">The type of the object to deserialize to.</typeparam>
- <param name="value">The JSON to deserialize.</param>
- <returns>
- A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync``1(System.String,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Asynchronously deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- Deserialization will happen on a new thread.
- </summary>
- <typeparam name="T">The type of the object to deserialize to.</typeparam>
- <param name="value">The JSON to deserialize.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>
- A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync(System.String)">
- <summary>
- Asynchronously deserializes the JSON to the specified .NET type.
- Deserialization will happen on a new thread.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <returns>
- A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeObjectAsync(System.String,System.Type,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Asynchronously deserializes the JSON to the specified .NET type using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- Deserialization will happen on a new thread.
- </summary>
- <param name="value">The JSON to deserialize.</param>
- <param name="type">The type of the object to deserialize to.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>
- A task that represents the asynchronous deserialize operation. The value of the <c>TResult</c> parameter contains the deserialized object from the JSON string.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object)">
- <summary>
- Populates the object with values from the JSON string.
- </summary>
- <param name="value">The JSON to populate values from.</param>
- <param name="target">The target object to populate values onto.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.PopulateObject(System.String,System.Object,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Populates the object with values from the JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The JSON to populate values from.</param>
- <param name="target">The target object to populate values onto.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.PopulateObjectAsync(System.String,System.Object,Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Asynchronously populates the object with values from the JSON string using <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- </summary>
- <param name="value">The JSON to populate values from.</param>
- <param name="target">The target object to populate values onto.</param>
- <param name="settings">
- The <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> used to deserialize the object.
- If this is null, default serialization settings will be used.
- </param>
- <returns>
- A task that represents the asynchronous populate operation.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode)">
- <summary>
- Serializes the XML node to a JSON string.
- </summary>
- <param name="node">The node to serialize.</param>
- <returns>A JSON string of the XmlNode.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting)">
- <summary>
- Serializes the XML node to a JSON string using formatting.
- </summary>
- <param name="node">The node to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <returns>A JSON string of the XmlNode.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeXmlNode(System.Xml.XmlNode,Newtonsoft.Json.Formatting,System.Boolean)">
- <summary>
- Serializes the XML node to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>.
- </summary>
- <param name="node">The node to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="omitRootObject">Omits writing the root object.</param>
- <returns>A JSON string of the XmlNode.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String)">
- <summary>
- Deserializes the XmlNode from a JSON string.
- </summary>
- <param name="value">The JSON string.</param>
- <returns>The deserialized XmlNode</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String)">
- <summary>
- Deserializes the XmlNode from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/>.
- </summary>
- <param name="value">The JSON string.</param>
- <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
- <returns>The deserialized XmlNode</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXmlNode(System.String,System.String,System.Boolean)">
- <summary>
- Deserializes the XmlNode from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/>
- and writes a .NET array attribute for collections.
- </summary>
- <param name="value">The JSON string.</param>
- <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
- <param name="writeArrayAttribute">
- 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.
- </param>
- <returns>The deserialized XmlNode</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject)">
- <summary>
- Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string.
- </summary>
- <param name="node">The node to convert to JSON.</param>
- <returns>A JSON string of the XNode.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting)">
- <summary>
- Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting.
- </summary>
- <param name="node">The node to convert to JSON.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <returns>A JSON string of the XNode.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.SerializeXNode(System.Xml.Linq.XObject,Newtonsoft.Json.Formatting,System.Boolean)">
- <summary>
- Serializes the <see cref="T:System.Xml.Linq.XNode"/> to a JSON string using formatting and omits the root object if <paramref name="omitRootObject"/> is <c>true</c>.
- </summary>
- <param name="node">The node to serialize.</param>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="omitRootObject">Omits writing the root object.</param>
- <returns>A JSON string of the XNode.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String)">
- <summary>
- Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string.
- </summary>
- <param name="value">The JSON string.</param>
- <returns>The deserialized XNode</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String)">
- <summary>
- Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/>.
- </summary>
- <param name="value">The JSON string.</param>
- <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
- <returns>The deserialized XNode</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConvert.DeserializeXNode(System.String,System.String,System.Boolean)">
- <summary>
- Deserializes the <see cref="T:System.Xml.Linq.XNode"/> from a JSON string nested in a root elment specified by <paramref name="deserializeRootElementName"/>
- and writes a .NET array attribute for collections.
- </summary>
- <param name="value">The JSON string.</param>
- <param name="deserializeRootElementName">The name of the root element to append when deserializing.</param>
- <param name="writeArrayAttribute">
- 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.
- </param>
- <returns>The deserialized XNode</returns>
- </member>
- <member name="T:Newtonsoft.Json.JsonConverter">
- <summary>
- Converts an object to and from JSON.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonConverter.WriteJson(Newtonsoft.Json.JsonWriter,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Writes the JSON representation of the object.
- </summary>
- <param name="writer">The <see cref="T:Newtonsoft.Json.JsonWriter"/> to write to.</param>
- <param name="value">The value.</param>
- <param name="serializer">The calling serializer.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonConverter.ReadJson(Newtonsoft.Json.JsonReader,System.Type,System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Reads the JSON representation of the object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from.</param>
- <param name="objectType">Type of the object.</param>
- <param name="existingValue">The existing value of object being read.</param>
- <param name="serializer">The calling serializer.</param>
- <returns>The object value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConverter.CanConvert(System.Type)">
- <summary>
- Determines whether this instance can convert the specified object type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>
- <c>true</c> if this instance can convert the specified object type; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonConverter.GetSchema">
- <summary>
- <para>
- Gets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of the JSON produced by the JsonConverter.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- <returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of the JSON produced by the JsonConverter.</returns>
- </member>
- <member name="P:Newtonsoft.Json.JsonConverter.CanRead">
- <summary>
- Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON.
- </summary>
- <value><c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can read JSON; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonConverter.CanWrite">
- <summary>
- Gets a value indicating whether this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON.
- </summary>
- <value><c>true</c> if this <see cref="T:Newtonsoft.Json.JsonConverter"/> can write JSON; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:Newtonsoft.Json.JsonConverterAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to use the specified <see cref="T:Newtonsoft.Json.JsonConverter"/> when serializing the member or class.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the converter.
- </summary>
- <value>The <see cref="T:System.Type"/> of the converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonConverterAttribute.ConverterParameters">
- <summary>
- The parameter list to use when constructing the JsonConverter described by ConverterType.
- If null, the default constructor is used.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonConverterAttribute"/> class.
- </summary>
- <param name="converterType">Type of the converter.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonConverterAttribute.#ctor(System.Type,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonConverterAttribute"/> class.
- </summary>
- <param name="converterType">Type of the converter.</param>
- <param name="converterParameters">Parameter list to use when constructing the JsonConverter. Can be null.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonConverterCollection">
- <summary>
- Represents a collection of <see cref="T:Newtonsoft.Json.JsonConverter"/>.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonDictionaryAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the collection.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonDictionaryAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonDictionaryAttribute"/> class with the specified container Id.
- </summary>
- <param name="id">The container Id.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonException">
- <summary>
- The exception thrown when an error occurs during JSON serialization or deserialization.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class
- with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class
- with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Newtonsoft.Json.JsonExtensionDataAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to deserialize properties with no matching class member into the specified collection
- and write values during serialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.WriteData">
- <summary>
- Gets or sets a value that indicates whether to write extension data when serializing the object.
- </summary>
- <value>
- <c>true</c> to write extension data when serializing the object; otherwise, <c>false</c>. The default is <c>true</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonExtensionDataAttribute.ReadData">
- <summary>
- Gets or sets a value that indicates whether to read extension data when deserializing the object.
- </summary>
- <value>
- <c>true</c> to read extension data when deserializing the object; otherwise, <c>false</c>. The default is <c>true</c>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.JsonExtensionDataAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonExtensionDataAttribute"/> class.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonIgnoreAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> not to serialize the public field or public read/write property value.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonObjectAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> how to serialize the object.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonObjectAttribute.MemberSerialization">
- <summary>
- Gets or sets the member serialization.
- </summary>
- <value>The member serialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonObjectAttribute.ItemRequired">
- <summary>
- Gets or sets a value that indicates whether the object's properties are required.
- </summary>
- <value>
- A value indicating whether the object's properties are required.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(Newtonsoft.Json.MemberSerialization)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with the specified member serialization.
- </summary>
- <param name="memberSerialization">The member serialization.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonObjectAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonObjectAttribute"/> class with the specified container Id.
- </summary>
- <param name="id">The container Id.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonPropertyAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to always serialize the member with the specified name.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterType">
- <summary>
- Gets or sets the converter used when serializing the property's collection items.
- </summary>
- <value>The collection's items converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemConverterParameters">
- <summary>
- The parameter list to use when constructing the JsonConverter described by ItemConverterType.
- If null, the default constructor is used.
- When non-null, there must be a constructor defined in the JsonConverter that exactly matches the number,
- order, and type of these parameters.
- </summary>
- <example>
- [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })]
- </example>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.NullValueHandling">
- <summary>
- Gets or sets the null value handling used when serializing this property.
- </summary>
- <value>The null value handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.DefaultValueHandling">
- <summary>
- Gets or sets the default value handling used when serializing this property.
- </summary>
- <value>The default value handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ReferenceLoopHandling">
- <summary>
- Gets or sets the reference loop handling used when serializing this property.
- </summary>
- <value>The reference loop handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ObjectCreationHandling">
- <summary>
- Gets or sets the object creation handling used when deserializing this property.
- </summary>
- <value>The object creation handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.TypeNameHandling">
- <summary>
- Gets or sets the type name handling used when serializing this property.
- </summary>
- <value>The type name handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.IsReference">
- <summary>
- Gets or sets whether this property's value is serialized as a reference.
- </summary>
- <value>Whether this property's value is serialized as a reference.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.Order">
- <summary>
- Gets or sets the order of serialization and deserialization of a member.
- </summary>
- <value>The numeric order of serialization or deserialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.Required">
- <summary>
- Gets or sets a value indicating whether this property is required.
- </summary>
- <value>
- A value indicating whether this property is required.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.PropertyName">
- <summary>
- Gets or sets the name of the property.
- </summary>
- <value>The name of the property.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemReferenceLoopHandling">
- <summary>
- Gets or sets the the reference loop handling used when serializing the property's collection items.
- </summary>
- <value>The collection's items reference loop handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemTypeNameHandling">
- <summary>
- Gets or sets the the type name handling used when serializing the property's collection items.
- </summary>
- <value>The collection's items type name handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonPropertyAttribute.ItemIsReference">
- <summary>
- Gets or sets whether this property's collection items are serialized as a reference.
- </summary>
- <value>Whether this property's collection items are serialized as a reference.</value>
- </member>
- <member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonPropertyAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> class with the specified name.
- </summary>
- <param name="propertyName">Name of the property.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonReader">
- <summary>
- Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonReader.State">
- <summary>
- Specifies the state of the reader.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Start">
- <summary>
- The Read method has not been called.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Complete">
- <summary>
- The end of the file has been reached successfully.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Property">
- <summary>
- Reader is at a property.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.ObjectStart">
- <summary>
- Reader is at the start of an object.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Object">
- <summary>
- Reader is in an object.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.ArrayStart">
- <summary>
- Reader is at the start of an array.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Array">
- <summary>
- Reader is in an array.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Closed">
- <summary>
- The Close method has been called.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.PostValue">
- <summary>
- Reader has just read a value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.ConstructorStart">
- <summary>
- Reader is at the start of a constructor.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Constructor">
- <summary>
- Reader in a constructor.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Error">
- <summary>
- An error occurred that prevents the read operation from continuing.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonReader.State.Finished">
- <summary>
- The end of the file has been reached successfully.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.CurrentState">
- <summary>
- Gets the current reader state.
- </summary>
- <value>The current reader state.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.CloseInput">
- <summary>
- Gets or sets a value indicating whether the underlying stream or
- <see cref="T:System.IO.TextReader"/> should be closed when the reader is closed.
- </summary>
- <value>
- true to close the underlying stream or <see cref="T:System.IO.TextReader"/> when
- the reader is closed; otherwise false. The default is true.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.SupportMultipleContent">
- <summary>
- Gets or sets a value indicating whether multiple pieces of JSON content can
- be read from a continuous stream without erroring.
- </summary>
- <value>
- true to support reading multiple pieces of JSON content; otherwise false. The default is false.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.QuoteChar">
- <summary>
- Gets the quotation mark character used to enclose the value of a string.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.DateTimeZoneHandling">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> time zones are handling when reading JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.DateParseHandling">
- <summary>
- Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.FloatParseHandling">
- <summary>
- Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.DateFormatString">
- <summary>
- Get or set how custom date formatted strings are parsed when reading JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.MaxDepth">
- <summary>
- Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.TokenType">
- <summary>
- Gets the type of the current JSON token.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.Value">
- <summary>
- Gets the text value of the current JSON token.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.ValueType">
- <summary>
- Gets The Common Language Runtime (CLR) type for the current JSON token.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.Depth">
- <summary>
- Gets the depth of the current token in the JSON document.
- </summary>
- <value>The depth of the current token in the JSON document.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.Path">
- <summary>
- Gets the path of the current JSON token.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReader.Culture">
- <summary>
- Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReader"/> class with the specified <see cref="T:System.IO.TextReader"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.Read">
- <summary>
- Reads the next JSON token from the stream.
- </summary>
- <returns>true if the next token was read successfully; false if there are no more tokens to read.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.ReadAsInt32">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.ReadAsString">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.String"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.ReadAsBytes">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Byte"/>[].
- </summary>
- <returns>A <see cref="T:System.Byte"/>[] or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.ReadAsDecimal">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTime">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.ReadAsDateTimeOffset">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.Skip">
- <summary>
- Skips the children of the current token.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken)">
- <summary>
- Sets the current token.
- </summary>
- <param name="newToken">The new token.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.SetToken(Newtonsoft.Json.JsonToken,System.Object)">
- <summary>
- Sets the current token and value.
- </summary>
- <param name="newToken">The new token.</param>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.SetStateBasedOnCurrent">
- <summary>
- Sets the state based on current token type.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.System#IDisposable#Dispose">
- <summary>
- Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.Dispose(System.Boolean)">
- <summary>
- Releases unmanaged and - optionally - managed resources
- </summary>
- <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonReader.Close">
- <summary>
- Changes the <see cref="T:Newtonsoft.Json.JsonReader.State"/> to Closed.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonReaderException">
- <summary>
- The exception thrown when an error occurs while reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonReaderException.LineNumber">
- <summary>
- Gets the line number indicating where the error occurred.
- </summary>
- <value>The line number indicating where the error occurred.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonReaderException.LinePosition">
- <summary>
- Gets the line position indicating where the error occurred.
- </summary>
- <value>The line position indicating where the error occurred.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonReaderException.Path">
- <summary>
- Gets the path to the JSON where the error occurred.
- </summary>
- <value>The path to the JSON where the error occurred.</value>
- </member>
- <member name="M:Newtonsoft.Json.JsonReaderException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class
- with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class
- with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonReaderException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReaderException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Newtonsoft.Json.JsonRequiredAttribute">
- <summary>
- Instructs the <see cref="T:Newtonsoft.Json.JsonSerializer"/> to always serialize the member, and require the member has a value.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonSerializationException">
- <summary>
- The exception thrown when an error occurs during JSON serialization or deserialization.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
- with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class
- with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializationException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializationException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Newtonsoft.Json.JsonSerializer">
- <summary>
- Serializes and deserializes objects into and from the JSON format.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> enables you to control how objects are encoded into JSON.
- </summary>
- </member>
- <member name="E:Newtonsoft.Json.JsonSerializer.Error">
- <summary>
- Occurs when the <see cref="T:Newtonsoft.Json.JsonSerializer"/> errors during serialization and deserialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.ReferenceResolver">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.Binder">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.Serialization.SerializationBinder"/> used by the serializer when resolving type names.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.TraceWriter">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages.
- </summary>
- <value>The trace writer.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.EqualityComparer">
- <summary>
- Gets or sets the equality comparer used by the serializer when comparing references.
- </summary>
- <value>The equality comparer.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling">
- <summary>
- Gets or sets how type name writing and reading is handled by the serializer.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.TypeNameAssemblyFormat">
- <summary>
- Gets or sets how a type name assembly is written and resolved by the serializer.
- </summary>
- <value>The type name assembly format.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.PreserveReferencesHandling">
- <summary>
- Gets or sets how object references are preserved by the serializer.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.ReferenceLoopHandling">
- <summary>
- Get or set how reference loops (e.g. a class referencing itself) is handled.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.MissingMemberHandling">
- <summary>
- Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.NullValueHandling">
- <summary>
- Get or set how null values are handled during serialization and deserialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.DefaultValueHandling">
- <summary>
- Get or set how null default are handled during serialization and deserialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.ObjectCreationHandling">
- <summary>
- Gets or sets how objects are created during deserialization.
- </summary>
- <value>The object creation handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.ConstructorHandling">
- <summary>
- Gets or sets how constructors are used during deserialization.
- </summary>
- <value>The constructor handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.MetadataPropertyHandling">
- <summary>
- Gets or sets how metadata properties are used during deserialization.
- </summary>
- <value>The metadata properties handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.Converters">
- <summary>
- Gets a collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization.
- </summary>
- <value>Collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.ContractResolver">
- <summary>
- Gets or sets the contract resolver used by the serializer when
- serializing .NET objects to JSON and vice versa.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.Context">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods.
- </summary>
- <value>The context.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.Formatting">
- <summary>
- Indicates how JSON text output is formatted.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.DateFormatHandling">
- <summary>
- Get or set how dates are written to JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.DateTimeZoneHandling">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> time zones are handling during serialization and deserialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.DateParseHandling">
- <summary>
- Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.FloatParseHandling">
- <summary>
- Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.FloatFormatHandling">
- <summary>
- Get or set how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
- <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
- are written as JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.StringEscapeHandling">
- <summary>
- Get or set how strings are escaped when writing JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.DateFormatString">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text, and the expected date format when reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.Culture">
- <summary>
- Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.MaxDepth">
- <summary>
- Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializer.CheckAdditionalContent">
- <summary>
- Gets a value indicating whether there will be a check for additional JSON content after deserializing an object.
- </summary>
- <value>
- <c>true</c> if there will be a check for additional JSON content after deserializing an object; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializer"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Create">
- <summary>
- Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings.
- </summary>
- <returns>
- A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Create(Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings.
- </summary>
- <param name="settings">The settings to be applied to the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.</param>
- <returns>
- A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will not use default settings.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault">
- <summary>
- Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings.
- </summary>
- <returns>
- A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.CreateDefault(Newtonsoft.Json.JsonSerializerSettings)">
- <summary>
- Creates a new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings.
- </summary>
- <param name="settings">The settings to be applied to the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.</param>
- <returns>
- A new <see cref="T:Newtonsoft.Json.JsonSerializer"/> instance using the specified <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/>.
- The <see cref="T:Newtonsoft.Json.JsonSerializer"/> will use default settings.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Populate(System.IO.TextReader,System.Object)">
- <summary>
- Populates the JSON values onto the target object.
- </summary>
- <param name="reader">The <see cref="T:System.IO.TextReader"/> that contains the JSON structure to reader values from.</param>
- <param name="target">The target object to populate values onto.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Populate(Newtonsoft.Json.JsonReader,System.Object)">
- <summary>
- Populates the JSON values onto the target object.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to reader values from.</param>
- <param name="target">The target object to populate values onto.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader)">
- <summary>
- Deserializes the JSON structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> that contains the JSON structure to deserialize.</param>
- <returns>The <see cref="T:System.Object"/> being deserialized.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(System.IO.TextReader,System.Type)">
- <summary>
- Deserializes the JSON structure contained by the specified <see cref="T:System.IO.StringReader"/>
- into an instance of the specified type.
- </summary>
- <param name="reader">The <see cref="T:System.IO.TextReader"/> containing the object.</param>
- <param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param>
- <returns>The instance of <paramref name="objectType"/> being deserialized.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize``1(Newtonsoft.Json.JsonReader)">
- <summary>
- Deserializes the JSON structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>
- into an instance of the specified type.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the object.</param>
- <typeparam name="T">The type of the object to deserialize.</typeparam>
- <returns>The instance of <typeparamref name="T"/> being deserialized.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Deserialize(Newtonsoft.Json.JsonReader,System.Type)">
- <summary>
- Deserializes the JSON structure contained by the specified <see cref="T:Newtonsoft.Json.JsonReader"/>
- into an instance of the specified type.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the object.</param>
- <param name="objectType">The <see cref="T:System.Type"/> of object being deserialized.</param>
- <returns>The instance of <paramref name="objectType"/> being deserialized.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object)">
- <summary>
- Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
- to a <c>Stream</c> using the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the JSON structure.</param>
- <param name="value">The <see cref="T:System.Object"/> to serialize.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object,System.Type)">
- <summary>
- Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
- to a <c>Stream</c> using the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="jsonWriter">The <see cref="T:Newtonsoft.Json.JsonWriter"/> used to write the JSON structure.</param>
- <param name="value">The <see cref="T:System.Object"/> to serialize.</param>
- <param name="objectType">
- The type of the value being serialized.
- This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match.
- Specifing the type is optional.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(System.IO.TextWriter,System.Object,System.Type)">
- <summary>
- Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
- to a <c>Stream</c> using the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="textWriter">The <see cref="T:System.IO.TextWriter"/> used to write the JSON structure.</param>
- <param name="value">The <see cref="T:System.Object"/> to serialize.</param>
- <param name="objectType">
- The type of the value being serialized.
- This parameter is used when <see cref="P:Newtonsoft.Json.JsonSerializer.TypeNameHandling"/> is Auto to write out the type name if the type of the value does not match.
- Specifing the type is optional.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializer.Serialize(Newtonsoft.Json.JsonWriter,System.Object)">
- <summary>
- Serializes the specified <see cref="T:System.Object"/> and writes the JSON structure
- to a <c>Stream</c> using the specified <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="jsonWriter">The <see cref="T:Newtonsoft.Json.JsonWriter"/> used to write the JSON structure.</param>
- <param name="value">The <see cref="T:System.Object"/> to serialize.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonSerializerSettings">
- <summary>
- Specifies the settings on a <see cref="T:Newtonsoft.Json.JsonSerializer"/> object.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceLoopHandling">
- <summary>
- Gets or sets how reference loops (e.g. a class referencing itself) is handled.
- </summary>
- <value>Reference loop handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.MissingMemberHandling">
- <summary>
- Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization.
- </summary>
- <value>Missing member handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.ObjectCreationHandling">
- <summary>
- Gets or sets how objects are created during deserialization.
- </summary>
- <value>The object creation handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.NullValueHandling">
- <summary>
- Gets or sets how null values are handled during serialization and deserialization.
- </summary>
- <value>Null value handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.DefaultValueHandling">
- <summary>
- Gets or sets how null default are handled during serialization and deserialization.
- </summary>
- <value>The default value handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.Converters">
- <summary>
- Gets or sets a collection <see cref="T:Newtonsoft.Json.JsonConverter"/> that will be used during serialization.
- </summary>
- <value>The converters.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.PreserveReferencesHandling">
- <summary>
- Gets or sets how object references are preserved by the serializer.
- </summary>
- <value>The preserve references handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameHandling">
- <summary>
- Gets or sets how type name writing and reading is handled by the serializer.
- </summary>
- <value>The type name handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.MetadataPropertyHandling">
- <summary>
- Gets or sets how metadata properties are used during deserialization.
- </summary>
- <value>The metadata properties handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.TypeNameAssemblyFormat">
- <summary>
- Gets or sets how a type name assembly is written and resolved by the serializer.
- </summary>
- <value>The type name assembly format.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.ConstructorHandling">
- <summary>
- Gets or sets how constructors are used during deserialization.
- </summary>
- <value>The constructor handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.ContractResolver">
- <summary>
- Gets or sets the contract resolver used by the serializer when
- serializing .NET objects to JSON and vice versa.
- </summary>
- <value>The contract resolver.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.EqualityComparer">
- <summary>
- Gets or sets the equality comparer used by the serializer when comparing references.
- </summary>
- <value>The equality comparer.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolver">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.
- </summary>
- <value>The reference resolver.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.ReferenceResolverProvider">
- <summary>
- Gets or sets a function that creates the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.
- </summary>
- <value>A function that creates the <see cref="T:Newtonsoft.Json.Serialization.IReferenceResolver"/> used by the serializer when resolving references.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.TraceWriter">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.ITraceWriter"/> used by the serializer when writing trace messages.
- </summary>
- <value>The trace writer.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.Binder">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.Serialization.SerializationBinder"/> used by the serializer when resolving type names.
- </summary>
- <value>The binder.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.Error">
- <summary>
- Gets or sets the error handler called during serialization and deserialization.
- </summary>
- <value>The error handler called during serialization and deserialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.Context">
- <summary>
- Gets or sets the <see cref="T:System.Runtime.Serialization.StreamingContext"/> used by the serializer when invoking serialization callback methods.
- </summary>
- <value>The context.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatString">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatted when writing JSON text, and the expected date format when reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.MaxDepth">
- <summary>
- Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a <see cref="T:Newtonsoft.Json.JsonReaderException"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.Formatting">
- <summary>
- Indicates how JSON text output is formatted.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateFormatHandling">
- <summary>
- Get or set how dates are written to JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateTimeZoneHandling">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> time zones are handling during serialization and deserialization.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.DateParseHandling">
- <summary>
- Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatFormatHandling">
- <summary>
- Get or set how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
- <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
- are written as JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.FloatParseHandling">
- <summary>
- Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.StringEscapeHandling">
- <summary>
- Get or set how strings are escaped when writing JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.Culture">
- <summary>
- Gets or sets the culture used when reading JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonSerializerSettings.CheckAdditionalContent">
- <summary>
- Gets a value indicating whether there will be a check for additional content after deserializing an object.
- </summary>
- <value>
- <c>true</c> if there will be a check for additional content after deserializing an object; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.JsonSerializerSettings.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonSerializerSettings"/> class.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonTextReader">
- <summary>
- Represents a reader that provides fast, non-cached, forward-only access to JSON text data.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.#ctor(System.IO.TextReader)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonReader"/> class with the specified <see cref="T:System.IO.TextReader"/>.
- </summary>
- <param name="reader">The <c>TextReader</c> containing the XML data to read.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.Read">
- <summary>
- Reads the next JSON token from the stream.
- </summary>
- <returns>
- true if the next token was read successfully; false if there are no more tokens to read.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsBytes">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Byte"/>[].
- </summary>
- <returns>
- A <see cref="T:System.Byte"/>[] or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDecimal">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsInt32">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsString">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.String"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTime">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.ReadAsDateTimeOffset">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.DateTimeOffset"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.Close">
- <summary>
- Changes the state to closed.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextReader.HasLineInfo">
- <summary>
- Gets a value indicating whether the class can return line information.
- </summary>
- <returns>
- <c>true</c> if LineNumber and LinePosition can be provided; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.JsonTextReader.LineNumber">
- <summary>
- Gets the current line number.
- </summary>
- <value>
- The current line number or 0 if no line information is available (for example, HasLineInfo returns false).
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonTextReader.LinePosition">
- <summary>
- Gets the current line position.
- </summary>
- <value>
- The current line position or 0 if no line information is available (for example, HasLineInfo returns false).
- </value>
- </member>
- <member name="T:Newtonsoft.Json.JsonTextWriter">
- <summary>
- Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonTextWriter.Indentation">
- <summary>
- Gets or sets how many IndentChars to write for each level in the hierarchy when <see cref="T:Newtonsoft.Json.Formatting"/> is set to <c>Formatting.Indented</c>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonTextWriter.QuoteChar">
- <summary>
- Gets or sets which character to use to quote attribute values.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonTextWriter.IndentChar">
- <summary>
- Gets or sets which character to use for indenting when <see cref="T:Newtonsoft.Json.Formatting"/> is set to <c>Formatting.Indented</c>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonTextWriter.QuoteName">
- <summary>
- Gets or sets a value indicating whether object names will be surrounded with quotes.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.#ctor(System.IO.TextWriter)">
- <summary>
- Creates an instance of the <c>JsonWriter</c> class using the specified <see cref="T:System.IO.TextWriter"/>.
- </summary>
- <param name="textWriter">The <c>TextWriter</c> to write to.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.Flush">
- <summary>
- Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.Close">
- <summary>
- Closes this stream and the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartObject">
- <summary>
- Writes the beginning of a JSON object.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartArray">
- <summary>
- Writes the beginning of a JSON array.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteStartConstructor(System.String)">
- <summary>
- Writes the start of a constructor with the given name.
- </summary>
- <param name="name">The name of the constructor.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
- <summary>
- Writes the specified end token.
- </summary>
- <param name="token">The end token to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyName(System.String)">
- <summary>
- Writes the property name of a name/value pair on a JSON object.
- </summary>
- <param name="name">The name of the property.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WritePropertyName(System.String,System.Boolean)">
- <summary>
- Writes the property name of a name/value pair on a JSON object.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndent">
- <summary>
- Writes indent characters.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValueDelimiter">
- <summary>
- Writes the JSON value delimiter.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteIndentSpace">
- <summary>
- Writes an indent space.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Object)">
- <summary>
- Writes a <see cref="T:System.Object"/> value.
- An error will raised if the value cannot be written as a single JSON token.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteNull">
- <summary>
- Writes a null value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteUndefined">
- <summary>
- Writes an undefined value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteRaw(System.String)">
- <summary>
- Writes raw JSON.
- </summary>
- <param name="json">The raw JSON to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.String)">
- <summary>
- Writes a <see cref="T:System.String"/> value.
- </summary>
- <param name="value">The <see cref="T:System.String"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int32)">
- <summary>
- Writes a <see cref="T:System.Int32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt32)">
- <summary>
- Writes a <see cref="T:System.UInt32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int64)">
- <summary>
- Writes a <see cref="T:System.Int64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt64)">
- <summary>
- Writes a <see cref="T:System.UInt64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Single)">
- <summary>
- Writes a <see cref="T:System.Single"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Single"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Nullable{System.Single})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Double)">
- <summary>
- Writes a <see cref="T:System.Double"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Double"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Nullable{System.Double})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Boolean)">
- <summary>
- Writes a <see cref="T:System.Boolean"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Int16)">
- <summary>
- Writes a <see cref="T:System.Int16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.UInt16)">
- <summary>
- Writes a <see cref="T:System.UInt16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Char)">
- <summary>
- Writes a <see cref="T:System.Char"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Char"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Byte)">
- <summary>
- Writes a <see cref="T:System.Byte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.SByte)">
- <summary>
- Writes a <see cref="T:System.SByte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.SByte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Decimal)">
- <summary>
- Writes a <see cref="T:System.Decimal"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.DateTime)">
- <summary>
- Writes a <see cref="T:System.DateTime"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Byte[])">
- <summary>
- Writes a <see cref="T:System.Byte"/>[] value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.DateTimeOffset)">
- <summary>
- Writes a <see cref="T:System.DateTimeOffset"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Guid)">
- <summary>
- Writes a <see cref="T:System.Guid"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Guid"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.TimeSpan)">
- <summary>
- Writes a <see cref="T:System.TimeSpan"/> value.
- </summary>
- <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteValue(System.Uri)">
- <summary>
- Writes a <see cref="T:System.Uri"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Uri"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteComment(System.String)">
- <summary>
- Writes out a comment <code>/*...*/</code> containing the specified text.
- </summary>
- <param name="text">Text to place inside the comment.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonTextWriter.WriteWhitespace(System.String)">
- <summary>
- Writes out the given white space.
- </summary>
- <param name="ws">The string of white space characters.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonToken">
- <summary>
- Specifies the type of JSON token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.None">
- <summary>
- This is returned by the <see cref="T:Newtonsoft.Json.JsonReader"/> if a <see cref="M:Newtonsoft.Json.JsonReader.Read"/> method has not been called.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.StartObject">
- <summary>
- An object start token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.StartArray">
- <summary>
- An array start token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.StartConstructor">
- <summary>
- A constructor start token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.PropertyName">
- <summary>
- An object property name.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Comment">
- <summary>
- A comment.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Raw">
- <summary>
- Raw JSON.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Integer">
- <summary>
- An integer.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Float">
- <summary>
- A float.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.String">
- <summary>
- A string.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Boolean">
- <summary>
- A boolean.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Null">
- <summary>
- A null token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Undefined">
- <summary>
- An undefined token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.EndObject">
- <summary>
- An object end token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.EndArray">
- <summary>
- An array end token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.EndConstructor">
- <summary>
- A constructor end token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Date">
- <summary>
- A Date.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.JsonToken.Bytes">
- <summary>
- Byte data.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.JsonValidatingReader">
- <summary>
- <para>
- Represents a reader that provides <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> validation.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="E:Newtonsoft.Json.JsonValidatingReader.ValidationEventHandler">
- <summary>
- Sets an event handler for receiving schema validation errors.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.Value">
- <summary>
- Gets the text value of the current JSON token.
- </summary>
- <value></value>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.Depth">
- <summary>
- Gets the depth of the current token in the JSON document.
- </summary>
- <value>The depth of the current token in the JSON document.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.Path">
- <summary>
- Gets the path of the current JSON token.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.QuoteChar">
- <summary>
- Gets the quotation mark character used to enclose the value of a string.
- </summary>
- <value></value>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.TokenType">
- <summary>
- Gets the type of the current JSON token.
- </summary>
- <value></value>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.ValueType">
- <summary>
- Gets the Common Language Runtime (CLR) type for the current JSON token.
- </summary>
- <value></value>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.#ctor(Newtonsoft.Json.JsonReader)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonValidatingReader"/> class that
- validates the content returned from the given <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read from while validating.</param>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.Schema">
- <summary>
- Gets or sets the schema.
- </summary>
- <value>The schema.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonValidatingReader.Reader">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.JsonReader"/> used to construct this <see cref="T:Newtonsoft.Json.JsonValidatingReader"/>.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.JsonReader"/> specified in the constructor.</value>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsInt32">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsBytes">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Byte"/>[].
- </summary>
- <returns>
- A <see cref="T:System.Byte"/>[] or a null reference if the next JSON token is null.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDecimal">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsString">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.String"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDateTime">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.ReadAsDateTimeOffset">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.JsonValidatingReader.Read">
- <summary>
- Reads the next JSON token from the stream.
- </summary>
- <returns>
- true if the next token was read successfully; false if there are no more tokens to read.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.JsonWriter">
- <summary>
- Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.CloseOutput">
- <summary>
- Gets or sets a value indicating whether the underlying stream or
- <see cref="T:System.IO.TextReader"/> should be closed when the writer is closed.
- </summary>
- <value>
- true to close the underlying stream or <see cref="T:System.IO.TextReader"/> when
- the writer is closed; otherwise false. The default is true.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.Top">
- <summary>
- Gets the top.
- </summary>
- <value>The top.</value>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.WriteState">
- <summary>
- Gets the state of the writer.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.Path">
- <summary>
- Gets the path of the writer.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.Formatting">
- <summary>
- Indicates how JSON text output is formatted.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.DateFormatHandling">
- <summary>
- Get or set how dates are written to JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.DateTimeZoneHandling">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> time zones are handling when writing JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.StringEscapeHandling">
- <summary>
- Get or set how strings are escaped when writing JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.FloatFormatHandling">
- <summary>
- Get or set how special floating point numbers, e.g. <see cref="F:System.Double.NaN"/>,
- <see cref="F:System.Double.PositiveInfinity"/> and <see cref="F:System.Double.NegativeInfinity"/>,
- are written to JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.DateFormatString">
- <summary>
- Get or set how <see cref="T:System.DateTime"/> and <see cref="T:System.DateTimeOffset"/> values are formatting when writing JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriter.Culture">
- <summary>
- Gets or sets the culture used when writing JSON. Defaults to <see cref="P:System.Globalization.CultureInfo.InvariantCulture"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.#ctor">
- <summary>
- Creates an instance of the <c>JsonWriter</c> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.Flush">
- <summary>
- Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.Close">
- <summary>
- Closes this stream and the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteStartObject">
- <summary>
- Writes the beginning of a JSON object.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteEndObject">
- <summary>
- Writes the end of a JSON object.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteStartArray">
- <summary>
- Writes the beginning of a JSON array.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteEndArray">
- <summary>
- Writes the end of an array.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteStartConstructor(System.String)">
- <summary>
- Writes the start of a constructor with the given name.
- </summary>
- <param name="name">The name of the constructor.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteEndConstructor">
- <summary>
- Writes the end constructor.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WritePropertyName(System.String)">
- <summary>
- Writes the property name of a name/value pair on a JSON object.
- </summary>
- <param name="name">The name of the property.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WritePropertyName(System.String,System.Boolean)">
- <summary>
- Writes the property name of a name/value pair on a JSON object.
- </summary>
- <param name="name">The name of the property.</param>
- <param name="escape">A flag to indicate whether the text should be escaped when it is written as a JSON property name.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteEnd">
- <summary>
- Writes the end of the current JSON object or array.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonReader)">
- <summary>
- Writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token and its children.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonReader,System.Boolean)">
- <summary>
- Writes the current <see cref="T:Newtonsoft.Json.JsonReader"/> token.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> to read the token from.</param>
- <param name="writeChildren">A flag indicating whether the current token's children should be written.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonToken,System.Object)">
- <summary>
- Writes the <see cref="T:Newtonsoft.Json.JsonToken"/> token and its value.
- </summary>
- <param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> to write.</param>
- <param name="value">
- The value to write.
- A value is only required for tokens that have an associated value, e.g. the <see cref="T:System.String"/> property name for <see cref="F:Newtonsoft.Json.JsonToken.PropertyName"/>.
- A null value can be passed to the method for token's that don't have a value, e.g. <see cref="F:Newtonsoft.Json.JsonToken.StartObject"/>.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteToken(Newtonsoft.Json.JsonToken)">
- <summary>
- Writes the <see cref="T:Newtonsoft.Json.JsonToken"/> token.
- </summary>
- <param name="token">The <see cref="T:Newtonsoft.Json.JsonToken"/> to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
- <summary>
- Writes the specified end token.
- </summary>
- <param name="token">The end token to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteIndent">
- <summary>
- Writes indent characters.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValueDelimiter">
- <summary>
- Writes the JSON value delimiter.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteIndentSpace">
- <summary>
- Writes an indent space.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteNull">
- <summary>
- Writes a null value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteUndefined">
- <summary>
- Writes an undefined value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteRaw(System.String)">
- <summary>
- Writes raw JSON without changing the writer's state.
- </summary>
- <param name="json">The raw JSON to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteRawValue(System.String)">
- <summary>
- Writes raw JSON where a value is expected and updates the writer's state.
- </summary>
- <param name="json">The raw JSON to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.String)">
- <summary>
- Writes a <see cref="T:System.String"/> value.
- </summary>
- <param name="value">The <see cref="T:System.String"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int32)">
- <summary>
- Writes a <see cref="T:System.Int32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt32)">
- <summary>
- Writes a <see cref="T:System.UInt32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int64)">
- <summary>
- Writes a <see cref="T:System.Int64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt64)">
- <summary>
- Writes a <see cref="T:System.UInt64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Single)">
- <summary>
- Writes a <see cref="T:System.Single"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Single"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Double)">
- <summary>
- Writes a <see cref="T:System.Double"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Double"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Boolean)">
- <summary>
- Writes a <see cref="T:System.Boolean"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Int16)">
- <summary>
- Writes a <see cref="T:System.Int16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.UInt16)">
- <summary>
- Writes a <see cref="T:System.UInt16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Char)">
- <summary>
- Writes a <see cref="T:System.Char"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Char"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Byte)">
- <summary>
- Writes a <see cref="T:System.Byte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.SByte)">
- <summary>
- Writes a <see cref="T:System.SByte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.SByte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Decimal)">
- <summary>
- Writes a <see cref="T:System.Decimal"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.DateTime)">
- <summary>
- Writes a <see cref="T:System.DateTime"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.DateTimeOffset)">
- <summary>
- Writes a <see cref="T:System.DateTimeOffset"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Guid)">
- <summary>
- Writes a <see cref="T:System.Guid"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Guid"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.TimeSpan)">
- <summary>
- Writes a <see cref="T:System.TimeSpan"/> value.
- </summary>
- <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int32})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt32})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int64})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt64})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Single})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Double})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Boolean})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Int16})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.UInt16})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Char})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Byte})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.SByte})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Decimal})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.DateTime})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.DateTimeOffset})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.Guid})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Nullable{System.TimeSpan})">
- <summary>
- Writes a <see cref="T:System.Nullable`1"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Nullable`1"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Byte[])">
- <summary>
- Writes a <see cref="T:System.Byte"/>[] value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Uri)">
- <summary>
- Writes a <see cref="T:System.Uri"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Uri"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteValue(System.Object)">
- <summary>
- Writes a <see cref="T:System.Object"/> value.
- An error will raised if the value cannot be written as a single JSON token.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteComment(System.String)">
- <summary>
- Writes out a comment <code>/*...*/</code> containing the specified text.
- </summary>
- <param name="text">Text to place inside the comment.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.WriteWhitespace(System.String)">
- <summary>
- Writes out the given white space.
- </summary>
- <param name="ws">The string of white space characters.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriter.SetWriteState(Newtonsoft.Json.JsonToken,System.Object)">
- <summary>
- Sets the state of the JsonWriter,
- </summary>
- <param name="token">The JsonToken being written.</param>
- <param name="value">The value being written.</param>
- </member>
- <member name="T:Newtonsoft.Json.JsonWriterException">
- <summary>
- The exception thrown when an error occurs while reading JSON text.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.JsonWriterException.Path">
- <summary>
- Gets the path to the JSON where the error occurred.
- </summary>
- <value>The path to the JSON where the error occurred.</value>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriterException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class
- with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class
- with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
- </member>
- <member name="M:Newtonsoft.Json.JsonWriterException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.JsonWriterException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Newtonsoft.Json.Linq.Extensions">
- <summary>
- Contains the LINQ to JSON extension methods.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Ancestors``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns a collection of tokens that contains the ancestors of every token in the source collection.
- </summary>
- <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the ancestors of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.AncestorsAndSelf``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection.
- </summary>
- <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains every token in the source collection, the ancestors of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Descendants``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns a collection of tokens that contains the descendants of every token in the source collection.
- </summary>
- <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the descendants of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.DescendantsAndSelf``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection.
- </summary>
- <typeparam name="T">The type of the objects in source, constrained to <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains every token in the source collection, and the descendants of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Properties(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JObject})">
- <summary>
- Returns a collection of child properties of every object in the source collection.
- </summary>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the properties of every object in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken},System.Object)">
- <summary>
- Returns a collection of child values of every object in the source collection with the given key.
- </summary>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <param name="key">The token key.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every token in the source collection with the given key.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Values(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
- <summary>
- Returns a collection of child values of every object in the source collection.
- </summary>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken},System.Object)">
- <summary>
- Returns a collection of converted child values of every object in the source collection with the given key.
- </summary>
- <typeparam name="U">The type to convert the values to.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <param name="key">The token key.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection with the given key.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Values``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
- <summary>
- Returns a collection of converted child values of every object in the source collection.
- </summary>
- <typeparam name="U">The type to convert the values to.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Value``1(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
- <summary>
- Converts the value.
- </summary>
- <typeparam name="U">The type to convert the value to.</typeparam>
- <param name="value">A <see cref="T:Newtonsoft.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
- <returns>A converted value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Value``2(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Converts the value.
- </summary>
- <typeparam name="T">The source collection type.</typeparam>
- <typeparam name="U">The type to convert the value to.</typeparam>
- <param name="value">A <see cref="T:Newtonsoft.Json.Linq.JToken"/> cast as a <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
- <returns>A converted value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Children``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns a collection of child tokens of every array in the source collection.
- </summary>
- <typeparam name="T">The source collection type.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the values of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.Children``2(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns a collection of converted child tokens of every array in the source collection.
- </summary>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <typeparam name="U">The type to convert the values to.</typeparam>
- <typeparam name="T">The source collection type.</typeparam>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the converted values of every token in the source collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.AsJEnumerable(System.Collections.Generic.IEnumerable{Newtonsoft.Json.Linq.JToken})">
- <summary>
- Returns the input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.
- </summary>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>The input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.Extensions.AsJEnumerable``1(System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Returns the input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.
- </summary>
- <typeparam name="T">The source collection type.</typeparam>
- <param name="source">An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the source collection.</param>
- <returns>The input typed as <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/>.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.IJEnumerable`1">
- <summary>
- Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects.
- </summary>
- <typeparam name="T">The type of token</typeparam>
- </member>
- <member name="P:Newtonsoft.Json.Linq.IJEnumerable`1.Item(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/> with the specified key.
- </summary>
- <value></value>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JArray">
- <summary>
- Represents a JSON array.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" />
- </example>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JArray.ChildrenTokens">
- <summary>
- Gets the container's children tokens.
- </summary>
- <value>The container's children tokens.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JArray.Type">
- <summary>
- Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The type.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.#ctor(Newtonsoft.Json.Linq.JArray)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class from another <see cref="T:Newtonsoft.Json.Linq.JArray"/> object.
- </summary>
- <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JArray"/> object to copy from.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.#ctor(System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class with the specified content.
- </summary>
- <param name="content">The contents of the array.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JArray"/> class with the specified content.
- </summary>
- <param name="content">The contents of the array.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Load(Newtonsoft.Json.JsonReader)">
- <summary>
- Loads an <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Parse(System.String)">
- <summary>
- Load a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from a string that contains JSON.
- </summary>
- <param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> populated from the string that contains JSON.</returns>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParseArray" title="Parsing a JSON Array from Text" />
- </example>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.FromObject(System.Object)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from an object.
- </summary>
- <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> with the values of the specified object</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JArray"/> from an object.
- </summary>
- <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JArray"/>.</param>
- <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used to read the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JArray"/> with the values of the specified object</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JArray.Item(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JArray.Item(System.Int32)">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the specified index.
- </summary>
- <value></value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.IndexOf(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>.
- </summary>
- <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
- <returns>
- The index of <paramref name="item"/> if found in the list; otherwise, -1.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Insert(System.Int32,Newtonsoft.Json.Linq.JToken)">
- <summary>
- Inserts an item to the <see cref="T:System.Collections.Generic.IList`1"/> at the specified index.
- </summary>
- <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param>
- <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.RemoveAt(System.Int32)">
- <summary>
- Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index.
- </summary>
- <param name="index">The zero-based index of the item to remove.</param>
- <exception cref="T:System.ArgumentOutOfRangeException">
- <paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>.</exception>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.IList`1"/> is read-only.</exception>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the collection.
- </summary>
- <returns>
- A <see cref="T:System.Collections.Generic.IEnumerator`1" /> that can be used to iterate through the collection.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Add(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Clear">
- <summary>
- Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. </exception>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Contains(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value.
- </summary>
- <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
- <returns>
- true if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.CopyTo(Newtonsoft.Json.Linq.JToken[],System.Int32)">
- <summary>
- Copies to.
- </summary>
- <param name="array">The array.</param>
- <param name="arrayIndex">Index of the array.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JArray.IsReadOnly">
- <summary>
- Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only.
- </summary>
- <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, false.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JArray.Remove(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </summary>
- <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param>
- <returns>
- true if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. This method also returns false if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>.
- </returns>
- <exception cref="T:System.NotSupportedException">The <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only.</exception>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JConstructor">
- <summary>
- Represents a JSON constructor.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JConstructor.ChildrenTokens">
- <summary>
- Gets the container's children tokens.
- </summary>
- <value>The container's children tokens.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JConstructor.Name">
- <summary>
- Gets or sets the name of this constructor.
- </summary>
- <value>The constructor name.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JConstructor.Type">
- <summary>
- Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The type.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(Newtonsoft.Json.Linq.JConstructor)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class from another <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> object.
- </summary>
- <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> object to copy from.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name and content.
- </summary>
- <param name="name">The constructor name.</param>
- <param name="content">The contents of the constructor.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String,System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name and content.
- </summary>
- <param name="name">The constructor name.</param>
- <param name="content">The contents of the constructor.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> class with the specified name.
- </summary>
- <param name="name">The constructor name.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JConstructor.Item(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JConstructor.Load(Newtonsoft.Json.JsonReader)">
- <summary>
- Loads an <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JConstructor"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JConstructor"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JContainer">
- <summary>
- Represents a token that can contain other tokens.
- </summary>
- </member>
- <member name="E:Newtonsoft.Json.Linq.JContainer.ListChanged">
- <summary>
- Occurs when the list changes or an item in the list changes.
- </summary>
- </member>
- <member name="E:Newtonsoft.Json.Linq.JContainer.AddingNew">
- <summary>
- Occurs before an item is added to the collection.
- </summary>
- </member>
- <member name="E:Newtonsoft.Json.Linq.JContainer.CollectionChanged">
- <summary>
- Occurs when the items list of the collection has changed, or the collection is reset.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JContainer.ChildrenTokens">
- <summary>
- Gets the container's children tokens.
- </summary>
- <value>The container's children tokens.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.OnAddingNew(System.ComponentModel.AddingNewEventArgs)">
- <summary>
- Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.AddingNew"/> event.
- </summary>
- <param name="e">The <see cref="T:System.ComponentModel.AddingNewEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.OnListChanged(System.ComponentModel.ListChangedEventArgs)">
- <summary>
- Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.ListChanged"/> event.
- </summary>
- <param name="e">The <see cref="T:System.ComponentModel.ListChangedEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.OnCollectionChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)">
- <summary>
- Raises the <see cref="E:Newtonsoft.Json.Linq.JContainer.CollectionChanged"/> event.
- </summary>
- <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs"/> instance containing the event data.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JContainer.HasValues">
- <summary>
- Gets a value indicating whether this token has child tokens.
- </summary>
- <value>
- <c>true</c> if this token has child values; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JContainer.First">
- <summary>
- Get the first child token of this token.
- </summary>
- <value>
- A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JContainer.Last">
- <summary>
- Get the last child token of this token.
- </summary>
- <value>
- A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.Children">
- <summary>
- Returns a collection of the child tokens of this token, in document order.
- </summary>
- <returns>
- An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.Values``1">
- <summary>
- Returns a collection of the child values of this token, in document order.
- </summary>
- <typeparam name="T">The type to convert the values to.</typeparam>
- <returns>
- A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.Descendants">
- <summary>
- Returns a collection of the descendant tokens for this token in document order.
- </summary>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the descendant tokens of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.DescendantsAndSelf">
- <summary>
- Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order.
- </summary>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing this token, and all the descendant tokens of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.Add(System.Object)">
- <summary>
- Adds the specified content as children of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="content">The content to be added.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.AddFirst(System.Object)">
- <summary>
- Adds the specified content as the first children of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="content">The content to be added.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.CreateWriter">
- <summary>
- Creates an <see cref="T:Newtonsoft.Json.JsonWriter"/> that can be used to add tokens to the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <returns>An <see cref="T:Newtonsoft.Json.JsonWriter"/> that is ready to have content written to it.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.ReplaceAll(System.Object)">
- <summary>
- Replaces the children nodes of this token with the specified content.
- </summary>
- <param name="content">The content.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.RemoveAll">
- <summary>
- Removes the child nodes from this token.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.Merge(System.Object)">
- <summary>
- Merge the specified content into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="content">The content to be merged.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JContainer.Merge(System.Object,Newtonsoft.Json.Linq.JsonMergeSettings)">
- <summary>
- Merge the specified content into this <see cref="T:Newtonsoft.Json.Linq.JToken"/> using <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/>.
- </summary>
- <param name="content">The content to be merged.</param>
- <param name="settings">The <see cref="T:Newtonsoft.Json.Linq.JsonMergeSettings"/> used to merge the content.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JContainer.Count">
- <summary>
- Gets the count of child JSON tokens.
- </summary>
- <value>The count of child JSON tokens</value>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JEnumerable`1">
- <summary>
- Represents a collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects.
- </summary>
- <typeparam name="T">The type of token</typeparam>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JEnumerable`1.Empty">
- <summary>
- An empty collection of <see cref="T:Newtonsoft.Json.Linq.JToken"/> objects.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.#ctor(System.Collections.Generic.IEnumerable{`0})">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> struct.
- </summary>
- <param name="enumerable">The enumerable.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the collection.
- </summary>
- <returns>
- A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.System#Collections#IEnumerable#GetEnumerator">
- <summary>
- Returns an enumerator that iterates through a collection.
- </summary>
- <returns>
- An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JEnumerable`1.Item(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.IJEnumerable`1"/> with the specified key.
- </summary>
- <value></value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.Equals(Newtonsoft.Json.Linq.JEnumerable{`0})">
- <summary>
- Determines whether the specified <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> is equal to this instance.
- </summary>
- <param name="other">The <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to this instance.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with this instance.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:System.Object"/> is equal to this instance; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JEnumerable`1.GetHashCode">
- <summary>
- Returns a hash code for this instance.
- </summary>
- <returns>
- A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JObject">
- <summary>
- Represents a JSON object.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" />
- </example>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JObject.ChildrenTokens">
- <summary>
- Gets the container's children tokens.
- </summary>
- <value>The container's children tokens.</value>
- </member>
- <member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanged">
- <summary>
- Occurs when a property value changes.
- </summary>
- </member>
- <member name="E:Newtonsoft.Json.Linq.JObject.PropertyChanging">
- <summary>
- Occurs when a property value is changing.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.#ctor(Newtonsoft.Json.Linq.JObject)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class from another <see cref="T:Newtonsoft.Json.Linq.JObject"/> object.
- </summary>
- <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JObject"/> object to copy from.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.#ctor(System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class with the specified content.
- </summary>
- <param name="content">The contents of the object.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JObject"/> class with the specified content.
- </summary>
- <param name="content">The contents of the object.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JObject.Type">
- <summary>
- Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The type.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.Properties">
- <summary>
- Gets an <see cref="T:System.Collections.Generic.IEnumerable`1"/> of this object's properties.
- </summary>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of this object's properties.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.Property(System.String)">
- <summary>
- Gets a <see cref="T:Newtonsoft.Json.Linq.JProperty"/> the specified name.
- </summary>
- <param name="name">The property name.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> with the specified name or null.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.PropertyValues">
- <summary>
- Gets an <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of this object's property values.
- </summary>
- <returns>An <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> of this object's property values.</returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JObject.Item(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JObject.Item(System.String)">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
- </summary>
- <value></value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.Load(Newtonsoft.Json.JsonReader)">
- <summary>
- Loads an <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.Parse(System.String)">
- <summary>
- Load a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from a string that contains JSON.
- </summary>
- <param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> populated from the string that contains JSON.</returns>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\LinqToJsonTests.cs" region="LinqToJsonCreateParse" title="Parsing a JSON Object from Text" />
- </example>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.FromObject(System.Object)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from an object.
- </summary>
- <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> with the values of the specified object</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JObject"/> from an object.
- </summary>
- <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JObject"/>.</param>
- <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used to read the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JObject"/> with the values of the specified object</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.GetValue(System.String)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.GetValue(System.String,System.StringComparison)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
- The exact property name will be searched for first and if no matching property is found then
- the <see cref="T:System.StringComparison"/> will be used to match a property.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.TryGetValue(System.String,System.StringComparison,Newtonsoft.Json.Linq.JToken@)">
- <summary>
- Tries to get the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified property name.
- The exact property name will be searched for first and if no matching property is found then
- the <see cref="T:System.StringComparison"/> will be used to match a property.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <param name="value">The value.</param>
- <param name="comparison">One of the enumeration values that specifies how the strings will be compared.</param>
- <returns>true if a value was successfully retrieved; otherwise, false.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.Add(System.String,Newtonsoft.Json.Linq.JToken)">
- <summary>
- Adds the specified property name.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.Remove(System.String)">
- <summary>
- Removes the property with the specified name.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <returns>true if item was successfully removed; otherwise, false.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.TryGetValue(System.String,Newtonsoft.Json.Linq.JToken@)">
- <summary>
- Tries the get value.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <param name="value">The value.</param>
- <returns>true if a value was successfully retrieved; otherwise, false.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.GetEnumerator">
- <summary>
- Returns an enumerator that iterates through the collection.
- </summary>
- <returns>
- A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanged(System.String)">
- <summary>
- Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanged"/> event with the provided arguments.
- </summary>
- <param name="propertyName">Name of the property.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.OnPropertyChanging(System.String)">
- <summary>
- Raises the <see cref="E:Newtonsoft.Json.Linq.JObject.PropertyChanging"/> event with the provided arguments.
- </summary>
- <param name="propertyName">Name of the property.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetProperties">
- <summary>
- Returns the properties for this instance of a component.
- </summary>
- <returns>
- A <see cref="T:System.ComponentModel.PropertyDescriptorCollection"/> that represents the properties for this component instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetProperties(System.Attribute[])">
- <summary>
- Returns the properties for this instance of a component using the attribute array as a filter.
- </summary>
- <param name="attributes">An array of type <see cref="T:System.Attribute"/> that is used as a filter.</param>
- <returns>
- A <see cref="T:System.ComponentModel.PropertyDescriptorCollection"/> that represents the filtered properties for this component instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetAttributes">
- <summary>
- Returns a collection of custom attributes for this instance of a component.
- </summary>
- <returns>
- An <see cref="T:System.ComponentModel.AttributeCollection"/> containing the attributes for this object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetClassName">
- <summary>
- Returns the class name of this instance of a component.
- </summary>
- <returns>
- The class name of the object, or null if the class does not have a name.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetComponentName">
- <summary>
- Returns the name of this instance of a component.
- </summary>
- <returns>
- The name of the object, or null if the object does not have a name.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetConverter">
- <summary>
- Returns a type converter for this instance of a component.
- </summary>
- <returns>
- A <see cref="T:System.ComponentModel.TypeConverter"/> that is the converter for this object, or null if there is no <see cref="T:System.ComponentModel.TypeConverter"/> for this object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetDefaultEvent">
- <summary>
- Returns the default event for this instance of a component.
- </summary>
- <returns>
- An <see cref="T:System.ComponentModel.EventDescriptor"/> that represents the default event for this object, or null if this object does not have events.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetDefaultProperty">
- <summary>
- Returns the default property for this instance of a component.
- </summary>
- <returns>
- A <see cref="T:System.ComponentModel.PropertyDescriptor"/> that represents the default property for this object, or null if this object does not have properties.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetEditor(System.Type)">
- <summary>
- Returns an editor of the specified type for this instance of a component.
- </summary>
- <param name="editorBaseType">A <see cref="T:System.Type"/> that represents the editor for this object.</param>
- <returns>
- An <see cref="T:System.Object"/> of the specified type that is the editor for this object, or null if the editor cannot be found.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetEvents(System.Attribute[])">
- <summary>
- Returns the events for this instance of a component using the specified attribute array as a filter.
- </summary>
- <param name="attributes">An array of type <see cref="T:System.Attribute"/> that is used as a filter.</param>
- <returns>
- An <see cref="T:System.ComponentModel.EventDescriptorCollection"/> that represents the filtered events for this component instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetEvents">
- <summary>
- Returns the events for this instance of a component.
- </summary>
- <returns>
- An <see cref="T:System.ComponentModel.EventDescriptorCollection"/> that represents the events for this component instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.System#ComponentModel#ICustomTypeDescriptor#GetPropertyOwner(System.ComponentModel.PropertyDescriptor)">
- <summary>
- Returns an object that contains the property described by the specified property descriptor.
- </summary>
- <param name="pd">A <see cref="T:System.ComponentModel.PropertyDescriptor"/> that represents the property whose owner is to be found.</param>
- <returns>
- An <see cref="T:System.Object"/> that represents the owner of the specified property.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JObject.GetMetaObject(System.Linq.Expressions.Expression)">
- <summary>
- Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
- </summary>
- <param name="parameter">The expression tree representation of the runtime value.</param>
- <returns>
- The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JsonMergeSettings">
- <summary>
- Specifies the settings used when merging JSON.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JsonMergeSettings.MergeArrayHandling">
- <summary>
- Gets or sets the method used when merging JSON arrays.
- </summary>
- <value>The method used when merging JSON arrays.</value>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JProperty">
- <summary>
- Represents a JSON property.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JProperty.ChildrenTokens">
- <summary>
- Gets the container's children tokens.
- </summary>
- <value>The container's children tokens.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JProperty.Name">
- <summary>
- Gets the property name.
- </summary>
- <value>The property name.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JProperty.Value">
- <summary>
- Gets or sets the property value.
- </summary>
- <value>The property value.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(Newtonsoft.Json.Linq.JProperty)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class from another <see cref="T:Newtonsoft.Json.Linq.JProperty"/> object.
- </summary>
- <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> object to copy from.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JProperty.Type">
- <summary>
- Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The type.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(System.String,System.Object[])">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class.
- </summary>
- <param name="name">The property name.</param>
- <param name="content">The property content.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JProperty.#ctor(System.String,System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/> class.
- </summary>
- <param name="name">The property name.</param>
- <param name="content">The property content.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JProperty.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JProperty.Load(Newtonsoft.Json.JsonReader)">
- <summary>
- Loads an <see cref="T:Newtonsoft.Json.Linq.JProperty"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">A <see cref="T:Newtonsoft.Json.JsonReader"/> that will be read for the content of the <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JProperty"/> that contains the JSON that was read from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JPropertyDescriptor">
- <summary>
- Represents a view of a <see cref="T:Newtonsoft.Json.Linq.JProperty"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JPropertyDescriptor"/> class.
- </summary>
- <param name="name">The name.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.CanResetValue(System.Object)">
- <summary>
- When overridden in a derived class, returns whether resetting an object changes its value.
- </summary>
- <returns>
- true if resetting the component changes its value; otherwise, false.
- </returns>
- <param name="component">The component to test for reset capability.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.GetValue(System.Object)">
- <summary>
- When overridden in a derived class, gets the current value of the property on a component.
- </summary>
- <returns>
- The value of a property for a given component.
- </returns>
- <param name="component">The component with the property for which to retrieve the value.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.ResetValue(System.Object)">
- <summary>
- When overridden in a derived class, resets the value for this property of the component to the default value.
- </summary>
- <param name="component">The component with the property value that is to be reset to the default value.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.SetValue(System.Object,System.Object)">
- <summary>
- When overridden in a derived class, sets the value of the component to a different value.
- </summary>
- <param name="component">The component with the property value that is to be set.
- </param><param name="value">The new value.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JPropertyDescriptor.ShouldSerializeValue(System.Object)">
- <summary>
- When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted.
- </summary>
- <returns>
- true if the property should be persisted; otherwise, false.
- </returns>
- <param name="component">The component with the property to be examined for persistence.
- </param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.ComponentType">
- <summary>
- When overridden in a derived class, gets the type of the component this property is bound to.
- </summary>
- <returns>
- A <see cref="T:System.Type"/> that represents the type of component this property is bound to. When the <see cref="M:System.ComponentModel.PropertyDescriptor.GetValue(System.Object)"/> or <see cref="M:System.ComponentModel.PropertyDescriptor.SetValue(System.Object,System.Object)"/> methods are invoked, the object specified might be an instance of this type.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.IsReadOnly">
- <summary>
- When overridden in a derived class, gets a value indicating whether this property is read-only.
- </summary>
- <returns>
- true if the property is read-only; otherwise, false.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.PropertyType">
- <summary>
- When overridden in a derived class, gets the type of the property.
- </summary>
- <returns>
- A <see cref="T:System.Type"/> that represents the type of the property.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JPropertyDescriptor.NameHashCode">
- <summary>
- Gets the hash code for the name of the member.
- </summary>
- <value></value>
- <returns>
- The hash code for the name of the member.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JRaw">
- <summary>
- Represents a raw JSON string.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JRaw.#ctor(Newtonsoft.Json.Linq.JRaw)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JRaw"/> class from another <see cref="T:Newtonsoft.Json.Linq.JRaw"/> object.
- </summary>
- <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JRaw"/> object to copy from.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JRaw.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JRaw"/> class.
- </summary>
- <param name="rawJson">The raw json.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JRaw.Create(Newtonsoft.Json.JsonReader)">
- <summary>
- Creates an instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.
- </summary>
- <param name="reader">The reader.</param>
- <returns>An instance of <see cref="T:Newtonsoft.Json.Linq.JRaw"/> with the content of the reader's current token.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JToken">
- <summary>
- Represents an abstract JSON token.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.EqualityComparer">
- <summary>
- Gets a comparer that can compare two tokens for value equality.
- </summary>
- <value>A <see cref="T:Newtonsoft.Json.Linq.JTokenEqualityComparer"/> that can compare two nodes for value equality.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Parent">
- <summary>
- Gets or sets the parent.
- </summary>
- <value>The parent.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Root">
- <summary>
- Gets the root <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The root <see cref="T:Newtonsoft.Json.Linq.JToken"/> of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Type">
- <summary>
- Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The type.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.HasValues">
- <summary>
- Gets a value indicating whether this token has child tokens.
- </summary>
- <value>
- <c>true</c> if this token has child values; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.DeepEquals(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)">
- <summary>
- Compares the values of two tokens, including the values of all descendant tokens.
- </summary>
- <param name="t1">The first <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
- <param name="t2">The second <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
- <returns>true if the tokens are equal; otherwise false.</returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Next">
- <summary>
- Gets the next sibling token of this node.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the next sibling token.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Previous">
- <summary>
- Gets the previous sibling token of this node.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> that contains the previous sibling token.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Path">
- <summary>
- Gets the path of the JSON token.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.AddAfterSelf(System.Object)">
- <summary>
- Adds the specified content immediately after this token.
- </summary>
- <param name="content">A content object that contains simple content or a collection of content objects to be added after this token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.AddBeforeSelf(System.Object)">
- <summary>
- Adds the specified content immediately before this token.
- </summary>
- <param name="content">A content object that contains simple content or a collection of content objects to be added before this token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Ancestors">
- <summary>
- Returns a collection of the ancestor tokens of this token.
- </summary>
- <returns>A collection of the ancestor tokens of this token.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.AncestorsAndSelf">
- <summary>
- Returns a collection of tokens that contain this token, and the ancestors of this token.
- </summary>
- <returns>A collection of tokens that contain this token, and the ancestors of this token.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.AfterSelf">
- <summary>
- Returns a collection of the sibling tokens after this token, in document order.
- </summary>
- <returns>A collection of the sibling tokens after this tokens, in document order.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.BeforeSelf">
- <summary>
- Returns a collection of the sibling tokens before this token, in document order.
- </summary>
- <returns>A collection of the sibling tokens before this token, in document order.</returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Item(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Value``1(System.Object)">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the specified key converted to the specified type.
- </summary>
- <typeparam name="T">The type to convert the token to.</typeparam>
- <param name="key">The token key.</param>
- <returns>The converted token value.</returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.First">
- <summary>
- Get the first child token of this token.
- </summary>
- <value>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the first child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JToken.Last">
- <summary>
- Get the last child token of this token.
- </summary>
- <value>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the last child token of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Children">
- <summary>
- Returns a collection of the child tokens of this token, in document order.
- </summary>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:Newtonsoft.Json.Linq.JToken"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Children``1">
- <summary>
- Returns a collection of the child tokens of this token, in document order, filtered by the specified type.
- </summary>
- <typeparam name="T">The type to filter the child tokens on.</typeparam>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JEnumerable`1"/> containing the child tokens of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Values``1">
- <summary>
- Returns a collection of the child values of this token, in document order.
- </summary>
- <typeparam name="T">The type to convert the values to.</typeparam>
- <returns>A <see cref="T:System.Collections.Generic.IEnumerable`1"/> containing the child values of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>, in document order.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Remove">
- <summary>
- Removes this token from its parent.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Replace(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Replaces this token with the specified token.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ToString">
- <summary>
- Returns the indented JSON for this token.
- </summary>
- <returns>
- The indented JSON for this token.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ToString(Newtonsoft.Json.Formatting,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Returns the JSON for this token using the given formatting and converters.
- </summary>
- <param name="formatting">Indicates how the output is formatted.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- <returns>The JSON for this token using the given formatting and converters.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Boolean">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Boolean"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.DateTimeOffset">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.DateTimeOffset"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Boolean}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int64">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int64"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.DateTime}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.DateTimeOffset}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Decimal}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Double}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Char}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int32">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int32"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Int16">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Int16"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt16">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt16"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Char">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Char"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Byte">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.SByte">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.SByte"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int32}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int16}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt16}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Byte}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.SByte}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.DateTime">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.DateTime"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Int64}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Single}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Decimal">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Decimal"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt32}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.UInt64}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Nullable`1"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Double">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Double"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Single">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Single"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.String">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.String"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt32">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt32"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.UInt64">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.UInt64"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Byte[]">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Byte"/>[].
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Guid">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Guid"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.Guid}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Guid"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.TimeSpan">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Nullable{System.TimeSpan}">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.TimeSpan"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Explicit(Newtonsoft.Json.Linq.JToken)~System.Uri">
- <summary>
- Performs an explicit conversion from <see cref="T:Newtonsoft.Json.Linq.JToken"/> to <see cref="T:System.Uri"/>.
- </summary>
- <param name="value">The value.</param>
- <returns>The result of the conversion.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Boolean)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Boolean"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.DateTimeOffset)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.DateTimeOffset"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Byte)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Byte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Byte})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.SByte)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.SByte"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.SByte})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Boolean})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int64)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTime})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.DateTimeOffset})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Decimal})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Double})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int16)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Int16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt16)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.UInt16"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Int32)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Int32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int32})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.DateTime)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.DateTime"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int64})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Single})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Decimal)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Decimal"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Int16})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt16})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt32})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.UInt64})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Double)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Double"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Single)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Single"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.String)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.String"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt32)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.UInt32"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.UInt64)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.UInt64"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Byte[])~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Byte"/>[] to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Uri)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Uri"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.TimeSpan)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.TimeSpan"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.TimeSpan})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Guid)~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Guid"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.op_Implicit(System.Nullable{System.Guid})~Newtonsoft.Json.Linq.JToken">
- <summary>
- Performs an implicit conversion from <see cref="T:System.Nullable`1"/> to <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="value">The value to create a <see cref="T:Newtonsoft.Json.Linq.JValue"/> from.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Linq.JValue"/> initialized with the specified value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.CreateReader">
- <summary>
- Creates an <see cref="T:Newtonsoft.Json.JsonReader"/> for this token.
- </summary>
- <returns>An <see cref="T:Newtonsoft.Json.JsonReader"/> that can be used to read this token and its descendants.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from an object.
- </summary>
- <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the value of the specified object</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.FromObject(System.Object,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from an object using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- <param name="o">The object that will be used to create <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
- <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when reading the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> with the value of the specified object</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ToObject``1">
- <summary>
- Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <typeparam name="T">The object type that the token will be deserialized to.</typeparam>
- <returns>The new object created from the JSON value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ToObject(System.Type)">
- <summary>
- Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="objectType">The object type that the token will be deserialized to.</param>
- <returns>The new object created from the JSON value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ToObject``1(Newtonsoft.Json.JsonSerializer)">
- <summary>
- Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/> using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- <typeparam name="T">The object type that the token will be deserialized to.</typeparam>
- <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when creating the object.</param>
- <returns>The new object created from the JSON value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ToObject(System.Type,Newtonsoft.Json.JsonSerializer)">
- <summary>
- Creates the specified .NET type from the <see cref="T:Newtonsoft.Json.Linq.JToken"/> using the specified <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- <param name="objectType">The object type that the token will be deserialized to.</param>
- <param name="jsonSerializer">The <see cref="T:Newtonsoft.Json.JsonSerializer"/> that will be used when creating the object.</param>
- <returns>The new object created from the JSON value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.ReadFrom(Newtonsoft.Json.JsonReader)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
- <returns>
- An <see cref="T:Newtonsoft.Json.Linq.JToken"/> 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.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Parse(System.String)">
- <summary>
- Load a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a string that contains JSON.
- </summary>
- <param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/> populated from the string that contains JSON.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Load(Newtonsoft.Json.JsonReader)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JToken"/> from a <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">An <see cref="T:Newtonsoft.Json.JsonReader"/> positioned at the token to read into this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</param>
- <returns>
- An <see cref="T:Newtonsoft.Json.Linq.JToken"/> 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.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String)">
- <summary>
- Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
- </summary>
- <param name="path">
- A <see cref="T:System.String"/> that contains a JPath expression.
- </param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>, or null.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.SelectToken(System.String,System.Boolean)">
- <summary>
- Selects a <see cref="T:Newtonsoft.Json.Linq.JToken"/> using a JPath expression. Selects the token that matches the object path.
- </summary>
- <param name="path">
- A <see cref="T:System.String"/> that contains a JPath expression.
- </param>
- <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String)">
- <summary>
- Selects a collection of elements using a JPath expression.
- </summary>
- <param name="path">
- A <see cref="T:System.String"/> that contains a JPath expression.
- </param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the selected elements.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.SelectTokens(System.String,System.Boolean)">
- <summary>
- Selects a collection of elements using a JPath expression.
- </summary>
- <param name="path">
- A <see cref="T:System.String"/> that contains a JPath expression.
- </param>
- <param name="errorWhenNoMatch">A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the selected elements.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.GetMetaObject(System.Linq.Expressions.Expression)">
- <summary>
- Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
- </summary>
- <param name="parameter">The expression tree representation of the runtime value.</param>
- <returns>
- The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.System#Dynamic#IDynamicMetaObjectProvider#GetMetaObject(System.Linq.Expressions.Expression)">
- <summary>
- Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
- </summary>
- <param name="parameter">The expression tree representation of the runtime value.</param>
- <returns>
- The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.DeepClone">
- <summary>
- Creates a new instance of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>. All child tokens are recursively cloned.
- </summary>
- <returns>A new instance of the <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.AddAnnotation(System.Object)">
- <summary>
- Adds an object to the annotation list of this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="annotation">The annotation to add.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Annotation``1">
- <summary>
- Get the first annotation object of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <typeparam name="T">The type of the annotation to retrieve.</typeparam>
- <returns>The first annotation object that matches the specified type, or <c>null</c> if no annotation is of the specified type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Annotation(System.Type)">
- <summary>
- Gets the first annotation object of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="type">The <see cref="P:Newtonsoft.Json.Linq.JToken.Type"/> of the annotation to retrieve.</param>
- <returns>The first annotation object that matches the specified type, or <c>null</c> if no annotation is of the specified type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Annotations``1">
- <summary>
- Gets a collection of annotations of the specified type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <typeparam name="T">The type of the annotations to retrieve.</typeparam>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> that contains the annotations for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.Annotations(System.Type)">
- <summary>
- Gets a collection of annotations of the specified type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="type">The <see cref="P:Newtonsoft.Json.Linq.JToken.Type"/> of the annotations to retrieve.</param>
- <returns>An <see cref="T:System.Collections.Generic.IEnumerable`1"/> of <see cref="T:System.Object"/> that contains the annotations that match the specified type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.RemoveAnnotations``1">
- <summary>
- Removes the annotations of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <typeparam name="T">The type of annotations to remove.</typeparam>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JToken.RemoveAnnotations(System.Type)">
- <summary>
- Removes the annotations of the specified type from this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <param name="type">The <see cref="P:Newtonsoft.Json.Linq.JToken.Type"/> of annotations to remove.</param>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JTokenEqualityComparer">
- <summary>
- Compares tokens to determine whether they are equal.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenEqualityComparer.Equals(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Linq.JToken)">
- <summary>
- Determines whether the specified objects are equal.
- </summary>
- <param name="x">The first object of type <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
- <param name="y">The second object of type <see cref="T:Newtonsoft.Json.Linq.JToken"/> to compare.</param>
- <returns>
- true if the specified objects are equal; otherwise, false.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenEqualityComparer.GetHashCode(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Returns a hash code for the specified object.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> for which a hash code is to be returned.</param>
- <returns>A hash code for the specified object.</returns>
- <exception cref="T:System.ArgumentNullException">The type of <paramref name="obj"/> is a reference type and <paramref name="obj"/> is null.</exception>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JTokenReader">
- <summary>
- Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JTokenReader.CurrentToken">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the reader's current position.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.#ctor(Newtonsoft.Json.Linq.JToken)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenReader"/> class.
- </summary>
- <param name="token">The token to read from.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsBytes">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Byte"/>[].
- </summary>
- <returns>
- A <see cref="T:System.Byte"/>[] or a null reference if the next JSON token is null. This method will return <c>null</c> at the end of an array.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsDecimal">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsInt32">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsString">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.String"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsDateTime">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.String"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.ReadAsDateTimeOffset">
- <summary>
- Reads the next JSON token from the stream as a <see cref="T:System.Nullable`1"/>.
- </summary>
- <returns>A <see cref="T:System.Nullable`1"/>. This method will return <c>null</c> at the end of an array.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenReader.Read">
- <summary>
- Reads the next JSON token from the stream.
- </summary>
- <returns>
- true if the next token was read successfully; false if there are no more tokens to read.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JTokenReader.Path">
- <summary>
- Gets the path of the current JSON token.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JTokenType">
- <summary>
- Specifies the type of token.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.None">
- <summary>
- No token type has been set.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Object">
- <summary>
- A JSON object.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Array">
- <summary>
- A JSON array.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Constructor">
- <summary>
- A JSON constructor.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Property">
- <summary>
- A JSON object property.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Comment">
- <summary>
- A comment.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Integer">
- <summary>
- An integer value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Float">
- <summary>
- A float value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.String">
- <summary>
- A string value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Boolean">
- <summary>
- A boolean value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Null">
- <summary>
- A null value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Undefined">
- <summary>
- An undefined value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Date">
- <summary>
- A date value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Raw">
- <summary>
- A raw JSON value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Bytes">
- <summary>
- A collection of bytes value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Guid">
- <summary>
- A Guid value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.Uri">
- <summary>
- A Uri value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.JTokenType.TimeSpan">
- <summary>
- A TimeSpan value.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JTokenWriter">
- <summary>
- Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JTokenWriter.CurrentToken">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Linq.JToken"/> at the writer's current position.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JTokenWriter.Token">
- <summary>
- Gets the token being writen.
- </summary>
- <value>The token being writen.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.#ctor(Newtonsoft.Json.Linq.JContainer)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenWriter"/> class writing to the given <see cref="T:Newtonsoft.Json.Linq.JContainer"/>.
- </summary>
- <param name="container">The container being written to.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JTokenWriter"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.Flush">
- <summary>
- Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.Close">
- <summary>
- Closes this stream and the underlying stream.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartObject">
- <summary>
- Writes the beginning of a JSON object.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartArray">
- <summary>
- Writes the beginning of a JSON array.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteStartConstructor(System.String)">
- <summary>
- Writes the start of a constructor with the given name.
- </summary>
- <param name="name">The name of the constructor.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteEnd(Newtonsoft.Json.JsonToken)">
- <summary>
- Writes the end.
- </summary>
- <param name="token">The token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WritePropertyName(System.String)">
- <summary>
- Writes the property name of a name/value pair on a JSON object.
- </summary>
- <param name="name">The name of the property.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Object)">
- <summary>
- Writes a <see cref="T:System.Object"/> value.
- An error will raised if the value cannot be written as a single JSON token.
- </summary>
- <param name="value">The <see cref="T:System.Object"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteNull">
- <summary>
- Writes a null value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteUndefined">
- <summary>
- Writes an undefined value.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteRaw(System.String)">
- <summary>
- Writes raw JSON.
- </summary>
- <param name="json">The raw JSON to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteComment(System.String)">
- <summary>
- Writes out a comment <code>/*...*/</code> containing the specified text.
- </summary>
- <param name="text">Text to place inside the comment.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.String)">
- <summary>
- Writes a <see cref="T:System.String"/> value.
- </summary>
- <param name="value">The <see cref="T:System.String"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int32)">
- <summary>
- Writes a <see cref="T:System.Int32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt32)">
- <summary>
- Writes a <see cref="T:System.UInt32"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt32"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int64)">
- <summary>
- Writes a <see cref="T:System.Int64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt64)">
- <summary>
- Writes a <see cref="T:System.UInt64"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt64"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Single)">
- <summary>
- Writes a <see cref="T:System.Single"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Single"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Double)">
- <summary>
- Writes a <see cref="T:System.Double"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Double"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Boolean)">
- <summary>
- Writes a <see cref="T:System.Boolean"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Boolean"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Int16)">
- <summary>
- Writes a <see cref="T:System.Int16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Int16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.UInt16)">
- <summary>
- Writes a <see cref="T:System.UInt16"/> value.
- </summary>
- <param name="value">The <see cref="T:System.UInt16"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Char)">
- <summary>
- Writes a <see cref="T:System.Char"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Char"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Byte)">
- <summary>
- Writes a <see cref="T:System.Byte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.SByte)">
- <summary>
- Writes a <see cref="T:System.SByte"/> value.
- </summary>
- <param name="value">The <see cref="T:System.SByte"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Decimal)">
- <summary>
- Writes a <see cref="T:System.Decimal"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Decimal"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.DateTime)">
- <summary>
- Writes a <see cref="T:System.DateTime"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTime"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.DateTimeOffset)">
- <summary>
- Writes a <see cref="T:System.DateTimeOffset"/> value.
- </summary>
- <param name="value">The <see cref="T:System.DateTimeOffset"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Byte[])">
- <summary>
- Writes a <see cref="T:System.Byte"/>[] value.
- </summary>
- <param name="value">The <see cref="T:System.Byte"/>[] value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.TimeSpan)">
- <summary>
- Writes a <see cref="T:System.TimeSpan"/> value.
- </summary>
- <param name="value">The <see cref="T:System.TimeSpan"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Guid)">
- <summary>
- Writes a <see cref="T:System.Guid"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Guid"/> value to write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JTokenWriter.WriteValue(System.Uri)">
- <summary>
- Writes a <see cref="T:System.Uri"/> value.
- </summary>
- <param name="value">The <see cref="T:System.Uri"/> value to write.</param>
- </member>
- <member name="T:Newtonsoft.Json.Linq.JValue">
- <summary>
- Represents a value in JSON (string, integer, date, etc).
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(Newtonsoft.Json.Linq.JValue)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class from another <see cref="T:Newtonsoft.Json.Linq.JValue"/> object.
- </summary>
- <param name="other">A <see cref="T:Newtonsoft.Json.Linq.JValue"/> object to copy from.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Int64)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Decimal)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Char)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.UInt64)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Double)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Single)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.DateTime)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.DateTimeOffset)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Guid)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Uri)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.TimeSpan)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Linq.JValue"/> class with the given value.
- </summary>
- <param name="value">The value.</param>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JValue.HasValues">
- <summary>
- Gets a value indicating whether this token has child tokens.
- </summary>
- <value>
- <c>true</c> if this token has child values; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.CreateComment(System.String)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> comment with the given value.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> comment with the given value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.CreateString(System.String)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> string with the given value.
- </summary>
- <param name="value">The value.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> string with the given value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.CreateNull">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.
- </summary>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.CreateUndefined">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.
- </summary>
- <returns>A <see cref="T:Newtonsoft.Json.Linq.JValue"/> null value.</returns>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JValue.Type">
- <summary>
- Gets the node type for this <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </summary>
- <value>The type.</value>
- </member>
- <member name="P:Newtonsoft.Json.Linq.JValue.Value">
- <summary>
- Gets or sets the underlying token value.
- </summary>
- <value>The underlying token value.</value>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.JsonConverter[])">
- <summary>
- Writes this token to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="converters">A collection of <see cref="T:Newtonsoft.Json.JsonConverter"/> which will be used when writing the token.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.Equals(Newtonsoft.Json.Linq.JValue)">
- <summary>
- Indicates whether the current object is equal to another object of the same type.
- </summary>
- <returns>
- true if the current object is equal to the <paramref name="other"/> parameter; otherwise, false.
- </returns>
- <param name="other">An object to compare with this object.</param>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.Equals(System.Object)">
- <summary>
- Determines whether the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>.
- </summary>
- <param name="obj">The <see cref="T:System.Object"/> to compare with the current <see cref="T:System.Object"/>.</param>
- <returns>
- true if the specified <see cref="T:System.Object"/> is equal to the current <see cref="T:System.Object"/>; otherwise, false.
- </returns>
- <exception cref="T:System.NullReferenceException">
- The <paramref name="obj"/> parameter is null.
- </exception>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.GetHashCode">
- <summary>
- Serves as a hash function for a particular type.
- </summary>
- <returns>
- A hash code for the current <see cref="T:System.Object"/>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.String)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.ToString(System.String,System.IFormatProvider)">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <param name="format">The format.</param>
- <param name="formatProvider">The format provider.</param>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.GetMetaObject(System.Linq.Expressions.Expression)">
- <summary>
- Returns the <see cref="T:System.Dynamic.DynamicMetaObject"/> responsible for binding operations performed on this object.
- </summary>
- <param name="parameter">The expression tree representation of the runtime value.</param>
- <returns>
- The <see cref="T:System.Dynamic.DynamicMetaObject"/> to bind this object.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Linq.JValue.CompareTo(Newtonsoft.Json.Linq.JValue)">
- <summary>
- 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.
- </summary>
- <param name="obj">An object to compare with this instance.</param>
- <returns>
- 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 <paramref name="obj"/>.
- Zero
- This instance is equal to <paramref name="obj"/>.
- Greater than zero
- This instance is greater than <paramref name="obj"/>.
- </returns>
- <exception cref="T:System.ArgumentException">
- <paramref name="obj"/> is not the same type as this instance.
- </exception>
- </member>
- <member name="T:Newtonsoft.Json.Linq.MergeArrayHandling">
- <summary>
- Specifies how JSON arrays are merged together.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Concat">
- <summary>Concatenate arrays.</summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Union">
- <summary>Union arrays, skipping items that already exist.</summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Replace">
- <summary>Replace all array items.</summary>
- </member>
- <member name="F:Newtonsoft.Json.Linq.MergeArrayHandling.Merge">
- <summary>Merge array items together, matched by index.</summary>
- </member>
- <member name="T:Newtonsoft.Json.MemberSerialization">
- <summary>
- Specifies the member serialization options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MemberSerialization.OptOut">
- <summary>
- All public members are serialized by default. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
- This is the default member serialization mode.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MemberSerialization.OptIn">
- <summary>
- Only members must be marked with <see cref="T:Newtonsoft.Json.JsonPropertyAttribute"/> or <see cref="T:System.Runtime.Serialization.DataMemberAttribute"/> are serialized.
- This member serialization mode can also be set by marking the class with <see cref="T:System.Runtime.Serialization.DataContractAttribute"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MemberSerialization.Fields">
- <summary>
- All public and private fields are serialized. Members can be excluded using <see cref="T:Newtonsoft.Json.JsonIgnoreAttribute"/> or <see cref="T:System.NonSerializedAttribute"/>.
- This member serialization mode can also be set by marking the class with <see cref="T:System.SerializableAttribute"/>
- and setting IgnoreSerializableAttribute on <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> to false.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.MetadataPropertyHandling">
- <summary>
- Specifies metadata property handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MetadataPropertyHandling.Default">
- <summary>
- Read metadata properties located at the start of a JSON object.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MetadataPropertyHandling.ReadAhead">
- <summary>
- Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MetadataPropertyHandling.Ignore">
- <summary>
- Do not try to read metadata properties.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.MissingMemberHandling">
- <summary>
- Specifies missing member handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MissingMemberHandling.Ignore">
- <summary>
- Ignore a missing member and do not attempt to deserialize it.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.MissingMemberHandling.Error">
- <summary>
- Throw a <see cref="T:Newtonsoft.Json.JsonSerializationException"/> when a missing member is encountered during deserialization.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.NullValueHandling">
- <summary>
- Specifies null value handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingObject" title="NullValueHandling Class" />
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeNullValueHandlingExample" title="NullValueHandling Ignore Example" />
- </example>
- </member>
- <member name="F:Newtonsoft.Json.NullValueHandling.Include">
- <summary>
- Include null values when serializing and deserializing objects.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.NullValueHandling.Ignore">
- <summary>
- Ignore null values when serializing and deserializing objects.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.ObjectCreationHandling">
- <summary>
- Specifies how object creation is handled by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ObjectCreationHandling.Auto">
- <summary>
- Reuse existing objects, create new objects when needed.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ObjectCreationHandling.Reuse">
- <summary>
- Only reuse existing objects.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ObjectCreationHandling.Replace">
- <summary>
- Always create new objects.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.PreserveReferencesHandling">
- <summary>
- Specifies reference handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement ISerializable.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="PreservingObjectReferencesOn" title="Preserve Object References" />
- </example>
- </member>
- <member name="F:Newtonsoft.Json.PreserveReferencesHandling.None">
- <summary>
- Do not preserve references when serializing types.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.PreserveReferencesHandling.Objects">
- <summary>
- Preserve references when serializing into a JSON object structure.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.PreserveReferencesHandling.Arrays">
- <summary>
- Preserve references when serializing into a JSON array structure.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.PreserveReferencesHandling.All">
- <summary>
- Preserve references when serializing.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.ReferenceLoopHandling">
- <summary>
- Specifies reference loop handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ReferenceLoopHandling.Error">
- <summary>
- Throw a <see cref="T:Newtonsoft.Json.JsonSerializationException"/> when a loop is encountered.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ReferenceLoopHandling.Ignore">
- <summary>
- Ignore loop references and do not serialize.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.ReferenceLoopHandling.Serialize">
- <summary>
- Serialize loop references.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Required">
- <summary>
- Indicating whether a property is required.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Required.Default">
- <summary>
- The property is not required. The default state.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Required.AllowNull">
- <summary>
- The property must be defined in JSON but can be a null value.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Required.Always">
- <summary>
- The property must be defined in JSON and cannot be a null value.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Schema.Extensions">
- <summary>
- <para>
- Contains the JSON schema extension methods.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Schema.Extensions.IsValid(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema)">
- <summary>
- <para>
- Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
- <param name="schema">The schema to test with.</param>
- <returns>
- <c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.Extensions.IsValid(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema,System.Collections.Generic.IList{System.String}@)">
- <summary>
- <para>
- Determines whether the <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
- <param name="schema">The schema to test with.</param>
- <param name="errorMessages">When this method returns, contains any error messages generated while validating. </param>
- <returns>
- <c>true</c> if the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/> is valid; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.Extensions.Validate(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema)">
- <summary>
- <para>
- Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
- <param name="schema">The schema to test with.</param>
- </member>
- <member name="M:Newtonsoft.Json.Schema.Extensions.Validate(Newtonsoft.Json.Linq.JToken,Newtonsoft.Json.Schema.JsonSchema,Newtonsoft.Json.Schema.ValidationEventHandler)">
- <summary>
- <para>
- Validates the specified <see cref="T:Newtonsoft.Json.Linq.JToken"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- <param name="source">The source <see cref="T:Newtonsoft.Json.Linq.JToken"/> to test.</param>
- <param name="schema">The schema to test with.</param>
- <param name="validationEventHandler">The validation event handler.</param>
- </member>
- <member name="T:Newtonsoft.Json.Schema.JsonSchema">
- <summary>
- <para>
- An in-memory representation of a JSON Schema.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Id">
- <summary>
- Gets or sets the id.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Title">
- <summary>
- Gets or sets the title.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Required">
- <summary>
- Gets or sets whether the object is required.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.ReadOnly">
- <summary>
- Gets or sets whether the object is read only.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Hidden">
- <summary>
- Gets or sets whether the object is visible to users.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Transient">
- <summary>
- Gets or sets whether the object is transient.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Description">
- <summary>
- Gets or sets the description of the object.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Type">
- <summary>
- Gets or sets the types of values allowed by the object.
- </summary>
- <value>The type.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Pattern">
- <summary>
- Gets or sets the pattern.
- </summary>
- <value>The pattern.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.MinimumLength">
- <summary>
- Gets or sets the minimum length.
- </summary>
- <value>The minimum length.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.MaximumLength">
- <summary>
- Gets or sets the maximum length.
- </summary>
- <value>The maximum length.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.DivisibleBy">
- <summary>
- Gets or sets a number that the value should be divisble by.
- </summary>
- <value>A number that the value should be divisble by.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Minimum">
- <summary>
- Gets or sets the minimum.
- </summary>
- <value>The minimum.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Maximum">
- <summary>
- Gets or sets the maximum.
- </summary>
- <value>The maximum.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.ExclusiveMinimum">
- <summary>
- Gets or sets a flag indicating whether the value can not equal the number defined by the "minimum" attribute.
- </summary>
- <value>A flag indicating whether the value can not equal the number defined by the "minimum" attribute.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.ExclusiveMaximum">
- <summary>
- Gets or sets a flag indicating whether the value can not equal the number defined by the "maximum" attribute.
- </summary>
- <value>A flag indicating whether the value can not equal the number defined by the "maximum" attribute.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.MinimumItems">
- <summary>
- Gets or sets the minimum number of items.
- </summary>
- <value>The minimum number of items.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.MaximumItems">
- <summary>
- Gets or sets the maximum number of items.
- </summary>
- <value>The maximum number of items.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Items">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of items.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of items.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.PositionalItemsValidation">
- <summary>
- Gets or sets a value indicating whether items in an array are validated using the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> instance at their array position from <see cref="P:Newtonsoft.Json.Schema.JsonSchema.Items"/>.
- </summary>
- <value>
- <c>true</c> if items are validated using their array position; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.AdditionalItems">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional items.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional items.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.AllowAdditionalItems">
- <summary>
- Gets or sets a value indicating whether additional items are allowed.
- </summary>
- <value>
- <c>true</c> if additional items are allowed; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.UniqueItems">
- <summary>
- Gets or sets whether the array items must be unique.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Properties">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of properties.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of properties.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.AdditionalProperties">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional properties.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> of additional properties.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.PatternProperties">
- <summary>
- Gets or sets the pattern properties.
- </summary>
- <value>The pattern properties.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.AllowAdditionalProperties">
- <summary>
- Gets or sets a value indicating whether additional properties are allowed.
- </summary>
- <value>
- <c>true</c> if additional properties are allowed; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Requires">
- <summary>
- Gets or sets the required property if this property is present.
- </summary>
- <value>The required property if this property is present.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Enum">
- <summary>
- Gets or sets the a collection of valid enum values allowed.
- </summary>
- <value>A collection of valid enum values allowed.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Disallow">
- <summary>
- Gets or sets disallowed types.
- </summary>
- <value>The disallow types.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Default">
- <summary>
- Gets or sets the default value.
- </summary>
- <value>The default value.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Extends">
- <summary>
- Gets or sets the collection of <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> that this schema extends.
- </summary>
- <value>The collection of <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> that this schema extends.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchema.Format">
- <summary>
- Gets or sets the format.
- </summary>
- <value>The format.</value>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.Read(Newtonsoft.Json.JsonReader)">
- <summary>
- Reads a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the JSON Schema to read.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.Read(Newtonsoft.Json.JsonReader,Newtonsoft.Json.Schema.JsonSchemaResolver)">
- <summary>
- Reads a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified <see cref="T:Newtonsoft.Json.JsonReader"/>.
- </summary>
- <param name="reader">The <see cref="T:Newtonsoft.Json.JsonReader"/> containing the JSON Schema to read.</param>
- <param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> to use when resolving schema references.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> object representing the JSON Schema.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.Parse(System.String)">
- <summary>
- Load a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a string that contains schema JSON.
- </summary>
- <param name="json">A <see cref="T:System.String"/> that contains JSON.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> populated from the string that contains JSON.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.Parse(System.String,Newtonsoft.Json.Schema.JsonSchemaResolver)">
- <summary>
- Parses the specified json.
- </summary>
- <param name="json">The json.</param>
- <param name="resolver">The resolver.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> populated from the string that contains JSON.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.WriteTo(Newtonsoft.Json.JsonWriter)">
- <summary>
- Writes this schema to a <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.WriteTo(Newtonsoft.Json.JsonWriter,Newtonsoft.Json.Schema.JsonSchemaResolver)">
- <summary>
- Writes this schema to a <see cref="T:Newtonsoft.Json.JsonWriter"/> using the specified <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/>.
- </summary>
- <param name="writer">A <see cref="T:Newtonsoft.Json.JsonWriter"/> into which this method will write.</param>
- <param name="resolver">The resolver used.</param>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchema.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents the current <see cref="T:System.Object"/>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Schema.JsonSchemaException">
- <summary>
- <para>
- Returns detailed information about the schema exception.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchemaException.LineNumber">
- <summary>
- Gets the line number indicating where the error occurred.
- </summary>
- <value>The line number indicating where the error occurred.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchemaException.LinePosition">
- <summary>
- Gets the line position indicating where the error occurred.
- </summary>
- <value>The line position indicating where the error occurred.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchemaException.Path">
- <summary>
- Gets the path to the JSON where the error occurred.
- </summary>
- <value>The path to the JSON where the error occurred.</value>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class
- with a specified error message.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class
- with a specified error message and a reference to the inner exception that is the cause of this exception.
- </summary>
- <param name="message">The error message that explains the reason for the exception.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified.</param>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> class.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- <exception cref="T:System.ArgumentNullException">The <paramref name="info"/> parameter is null. </exception>
- <exception cref="T:System.Runtime.Serialization.SerializationException">The class name is null or <see cref="P:System.Exception.HResult"/> is zero (0). </exception>
- </member>
- <member name="T:Newtonsoft.Json.Schema.JsonSchemaGenerator">
- <summary>
- <para>
- Generates a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from a specified <see cref="T:System.Type"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchemaGenerator.UndefinedSchemaIdHandling">
- <summary>
- Gets or sets how undefined schemas are handled by the serializer.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchemaGenerator.ContractResolver">
- <summary>
- Gets or sets the contract resolver.
- </summary>
- <value>The contract resolver.</value>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type)">
- <summary>
- Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
- </summary>
- <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Newtonsoft.Json.Schema.JsonSchemaResolver)">
- <summary>
- Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
- </summary>
- <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
- <param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,System.Boolean)">
- <summary>
- Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
- </summary>
- <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
- <param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> will be nullable.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaGenerator.Generate(System.Type,Newtonsoft.Json.Schema.JsonSchemaResolver,System.Boolean)">
- <summary>
- Generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from the specified type.
- </summary>
- <param name="type">The type to generate a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from.</param>
- <param name="resolver">The <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> used to resolve schema references.</param>
- <param name="rootSchemaNullable">Specify whether the generated root <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> will be nullable.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> generated from the specified type.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Schema.JsonSchemaResolver">
- <summary>
- <para>
- Resolves <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> from an id.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.JsonSchemaResolver.LoadedSchemas">
- <summary>
- Gets or sets the loaded schemas.
- </summary>
- <value>The loaded schemas.</value>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaResolver.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaResolver"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Schema.JsonSchemaResolver.GetSchema(System.String)">
- <summary>
- Gets a <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> for the specified reference.
- </summary>
- <param name="reference">The id.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/> for the specified reference.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Schema.JsonSchemaType">
- <summary>
- <para>
- The value types allowed by the <see cref="T:Newtonsoft.Json.Schema.JsonSchema"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.None">
- <summary>
- No type specified.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.String">
- <summary>
- String type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Float">
- <summary>
- Float type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Integer">
- <summary>
- Integer type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Boolean">
- <summary>
- Boolean type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Object">
- <summary>
- Object type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Array">
- <summary>
- Array type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Null">
- <summary>
- Null type.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.JsonSchemaType.Any">
- <summary>
- Any type.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling">
- <summary>
- <para>
- Specifies undefined schema Id handling options for the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaGenerator"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.None">
- <summary>
- Do not infer a schema Id.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.UseTypeName">
- <summary>
- Use the .NET type name as the schema Id.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.Schema.UndefinedSchemaIdHandling.UseAssemblyQualifiedName">
- <summary>
- Use the assembly qualified .NET type name as the schema Id.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Schema.ValidationEventArgs">
- <summary>
- <para>
- Returns detailed information related to the <see cref="T:Newtonsoft.Json.Schema.ValidationEventHandler"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Exception">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Schema.JsonSchemaException"/> associated with the validation error.
- </summary>
- <value>The JsonSchemaException associated with the validation error.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Path">
- <summary>
- Gets the path of the JSON location where the validation error occurred.
- </summary>
- <value>The path of the JSON location where the validation error occurred.</value>
- </member>
- <member name="P:Newtonsoft.Json.Schema.ValidationEventArgs.Message">
- <summary>
- Gets the text description corresponding to the validation error.
- </summary>
- <value>The text description.</value>
- </member>
- <member name="T:Newtonsoft.Json.Schema.ValidationEventHandler">
- <summary>
- <para>
- Represents the callback method that will handle JSON schema validation events and the <see cref="T:Newtonsoft.Json.Schema.ValidationEventArgs"/>.
- </para>
- <note type="caution">
- JSON Schema validation has been moved to its own package. See <see href="http://www.newtonsoft.com/jsonschema">http://www.newtonsoft.com/jsonschema</see> for more details.
- </note>
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver">
- <summary>
- Resolves member mappings for a type, camel casing property names.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.CamelCasePropertyNamesContractResolver.ResolvePropertyName(System.String)">
- <summary>
- Resolves the name of the property.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <returns>The property name camel cased.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.DefaultContractResolver">
- <summary>
- Used by <see cref="T:Newtonsoft.Json.JsonSerializer"/> to resolves a <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.DynamicCodeGeneration">
- <summary>
- Gets a value indicating whether members are being get and set using dynamic code generation.
- This value is determined by the runtime permissions available.
- </summary>
- <value>
- <c>true</c> if using dynamic code generation; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.DefaultMembersSearchFlags">
- <summary>
- Gets or sets the default members search flags.
- </summary>
- <value>The default members search flags.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.SerializeCompilerGeneratedMembers">
- <summary>
- Gets or sets a value indicating whether compiler generated members should be serialized.
- </summary>
- <value>
- <c>true</c> if serialized compiler generated members; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableInterface">
- <summary>
- Gets or sets a value indicating whether to ignore the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface when serializing and deserializing types.
- </summary>
- <value>
- <c>true</c> if the <see cref="T:System.Runtime.Serialization.ISerializable"/> interface will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.DefaultContractResolver.IgnoreSerializableAttribute">
- <summary>
- Gets or sets a value indicating whether to ignore the <see cref="T:System.SerializableAttribute"/> attribute when serializing and deserializing types.
- </summary>
- <value>
- <c>true</c> if the <see cref="T:System.SerializableAttribute"/> attribute will be ignored when serializing and deserializing types; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.#ctor(System.Boolean)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> class.
- </summary>
- <param name="shareCache">
- If set to <c>true</c> the <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> will use a cached shared with other resolvers of the same type.
- Sharing the cache will significantly improve performance with multiple resolver instances because expensive reflection will only
- happen once. This setting can cause unexpected behavior if different instances of the resolver are suppose to produce different
- results. When set to false it is highly recommended to reuse <see cref="T:Newtonsoft.Json.Serialization.DefaultContractResolver"/> instances with the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveContract(System.Type)">
- <summary>
- Resolves the contract for a given type.
- </summary>
- <param name="type">The type to resolve a contract for.</param>
- <returns>The contract for a given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.GetSerializableMembers(System.Type)">
- <summary>
- Gets the serializable members for the type.
- </summary>
- <param name="objectType">The type to get serializable members for.</param>
- <returns>The serializable members for the type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateObjectContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateConstructorParameters(System.Reflection.ConstructorInfo,Newtonsoft.Json.Serialization.JsonPropertyCollection)">
- <summary>
- Creates the constructor parameters.
- </summary>
- <param name="constructor">The constructor to create properties for.</param>
- <param name="memberProperties">The type's member properties.</param>
- <returns>Properties for the given <see cref="T:System.Reflection.ConstructorInfo"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreatePropertyFromConstructorParameter(Newtonsoft.Json.Serialization.JsonProperty,System.Reflection.ParameterInfo)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>.
- </summary>
- <param name="matchingMemberProperty">The matching member property.</param>
- <param name="parameterInfo">The constructor parameter.</param>
- <returns>A created <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.ParameterInfo"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveContractConverter(System.Type)">
- <summary>
- Resolves the default <see cref="T:Newtonsoft.Json.JsonConverter" /> for the contract.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>The contract's default <see cref="T:Newtonsoft.Json.JsonConverter" />.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDictionaryContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateArrayContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreatePrimitiveContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateLinqContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateISerializableContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateDynamicContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateStringContract(System.Type)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateContract(System.Type)">
- <summary>
- Determines which contract type is created for the given type.
- </summary>
- <param name="objectType">Type of the object.</param>
- <returns>A <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for the given type.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateProperties(System.Type,Newtonsoft.Json.MemberSerialization)">
- <summary>
- Creates properties for the given <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/>.
- </summary>
- <param name="type">The type to create properties for.</param>
- /// <param name="memberSerialization">The member serialization mode for the type.</param>
- <returns>Properties for the given <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateMemberValueProvider(System.Reflection.MemberInfo)">
- <summary>
- Creates the <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member.
- </summary>
- <param name="member">The member.</param>
- <returns>The <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> used by the serializer to get and set values from a member.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.CreateProperty(System.Reflection.MemberInfo,Newtonsoft.Json.MemberSerialization)">
- <summary>
- Creates a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>.
- </summary>
- <param name="memberSerialization">The member's parent <see cref="T:Newtonsoft.Json.MemberSerialization"/>.</param>
- <param name="member">The member to create a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for.</param>
- <returns>A created <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> for the given <see cref="T:System.Reflection.MemberInfo"/>.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)">
- <summary>
- Resolves the name of the property.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <returns>Resolved name of the property.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolveDictionaryKey(System.String)">
- <summary>
- Resolves the key of the dictionary. By default <see cref="M:Newtonsoft.Json.Serialization.DefaultContractResolver.ResolvePropertyName(System.String)"/> is used to resolve dictionary keys.
- </summary>
- <param name="dictionaryKey">Key of the dictionary.</param>
- <returns>Resolved key of the dictionary.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultContractResolver.GetResolvedPropertyName(System.String)">
- <summary>
- Gets the resolved name of the property.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <returns>Name of the property.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.DefaultSerializationBinder">
- <summary>
- The default serialization binder used when resolving and loading classes from type names.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.BindToType(System.String,System.String)">
- <summary>
- When overridden in a derived class, controls the binding of a serialized object to a type.
- </summary>
- <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object.</param>
- <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object.</param>
- <returns>
- The type of the object the formatter creates a new instance of.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DefaultSerializationBinder.BindToName(System.Type,System.String@,System.String@)">
- <summary>
- When overridden in a derived class, controls the binding of a serialized object to a type.
- </summary>
- <param name="serializedType">The type of the object the formatter creates a new instance of.</param>
- <param name="assemblyName">Specifies the <see cref="T:System.Reflection.Assembly"/> name of the serialized object. </param>
- <param name="typeName">Specifies the <see cref="T:System.Type"/> name of the serialized object. </param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter">
- <summary>
- Represents a trace writer that writes to the application's <see cref="T:System.Diagnostics.TraceListener"/> instances.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter.LevelFilter">
- <summary>
- Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
- For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>,
- <code>Warning</code> and <code>Error</code> messages.
- </summary>
- <value>
- The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DiagnosticsTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)">
- <summary>
- Writes the specified trace level, message and optional exception.
- </summary>
- <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param>
- <param name="message">The trace message.</param>
- <param name="ex">The trace exception. This parameter is optional.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.DynamicValueProvider">
- <summary>
- Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.#ctor(System.Reflection.MemberInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.DynamicValueProvider"/> class.
- </summary>
- <param name="memberInfo">The member info.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.SetValue(System.Object,System.Object)">
- <summary>
- Sets the value.
- </summary>
- <param name="target">The target to set the value on.</param>
- <param name="value">The value to set on the target.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.DynamicValueProvider.GetValue(System.Object)">
- <summary>
- Gets the value.
- </summary>
- <param name="target">The target to get the value from.</param>
- <returns>The value.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ErrorContext">
- <summary>
- Provides information surrounding an error.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Error">
- <summary>
- Gets the error.
- </summary>
- <value>The error.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorContext.OriginalObject">
- <summary>
- Gets the original object that caused the error.
- </summary>
- <value>The original object that caused the error.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Member">
- <summary>
- Gets the member that caused the error.
- </summary>
- <value>The member that caused the error.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Path">
- <summary>
- Gets the path of the JSON location where the error occurred.
- </summary>
- <value>The path of the JSON location where the error occurred.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorContext.Handled">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.ErrorContext"/> is handled.
- </summary>
- <value><c>true</c> if handled; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ErrorEventArgs">
- <summary>
- Provides data for the Error event.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorEventArgs.CurrentObject">
- <summary>
- Gets the current object the error event is being raised against.
- </summary>
- <value>The current object the error event is being raised against.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ErrorEventArgs.ErrorContext">
- <summary>
- Gets the error context.
- </summary>
- <value>The error context.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ErrorEventArgs.#ctor(System.Object,Newtonsoft.Json.Serialization.ErrorContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ErrorEventArgs"/> class.
- </summary>
- <param name="currentObject">The current object.</param>
- <param name="errorContext">The error context.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ExpressionValueProvider">
- <summary>
- Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using dynamic methods.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.#ctor(System.Reflection.MemberInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ExpressionValueProvider"/> class.
- </summary>
- <param name="memberInfo">The member info.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.SetValue(System.Object,System.Object)">
- <summary>
- Sets the value.
- </summary>
- <param name="target">The target to set the value on.</param>
- <param name="value">The value to set on the target.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ExpressionValueProvider.GetValue(System.Object)">
- <summary>
- Gets the value.
- </summary>
- <param name="target">The target to get the value from.</param>
- <returns>The value.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.IAttributeProvider">
- <summary>
- Provides methods to get attributes.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IAttributeProvider.GetAttributes(System.Boolean)">
- <summary>
- Returns a collection of all of the attributes, or an empty collection if there are no attributes.
- </summary>
- <param name="inherit">When true, look up the hierarchy chain for the inherited custom attribute.</param>
- <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IAttributeProvider.GetAttributes(System.Type,System.Boolean)">
- <summary>
- Returns a collection of attributes, identified by type, or an empty collection if there are no attributes.
- </summary>
- <param name="attributeType">The type of the attributes.</param>
- <param name="inherit">When true, look up the hierarchy chain for the inherited custom attribute.</param>
- <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.IContractResolver">
- <summary>
- Used by <see cref="T:Newtonsoft.Json.JsonSerializer"/> to resolves a <see cref="T:Newtonsoft.Json.Serialization.JsonContract"/> for a given <see cref="T:System.Type"/>.
- </summary>
- <example>
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverObject" title="IContractResolver Class" />
- <code lang="cs" source="..\Src\Newtonsoft.Json.Tests\Documentation\SerializationTests.cs" region="ReducingSerializedJsonSizeContractResolverExample" title="IContractResolver Example" />
- </example>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IContractResolver.ResolveContract(System.Type)">
- <summary>
- Resolves the contract for a given type.
- </summary>
- <param name="type">The type to resolve a contract for.</param>
- <returns>The contract for a given type.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.IReferenceResolver">
- <summary>
- Used to resolve references when serializing and deserializing JSON by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.ResolveReference(System.Object,System.String)">
- <summary>
- Resolves a reference to its object.
- </summary>
- <param name="context">The serialization context.</param>
- <param name="reference">The reference to resolve.</param>
- <returns>The object that</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.GetReference(System.Object,System.Object)">
- <summary>
- Gets the reference for the sepecified object.
- </summary>
- <param name="context">The serialization context.</param>
- <param name="value">The object to get a reference for.</param>
- <returns>The reference to the object.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.IsReferenced(System.Object,System.Object)">
- <summary>
- Determines whether the specified object is referenced.
- </summary>
- <param name="context">The serialization context.</param>
- <param name="value">The object to test for a reference.</param>
- <returns>
- <c>true</c> if the specified object is referenced; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IReferenceResolver.AddReference(System.Object,System.String,System.Object)">
- <summary>
- Adds a reference to the specified object.
- </summary>
- <param name="context">The serialization context.</param>
- <param name="reference">The reference.</param>
- <param name="value">The object to reference.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ITraceWriter">
- <summary>
- Represents a trace writer.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.ITraceWriter.LevelFilter">
- <summary>
- Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
- For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>,
- <code>Warning</code> and <code>Error</code> messages.
- </summary>
- <value>The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ITraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)">
- <summary>
- Writes the specified trace level, message and optional exception.
- </summary>
- <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param>
- <param name="message">The trace message.</param>
- <param name="ex">The trace exception. This parameter is optional.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.IValueProvider">
- <summary>
- Provides methods to get and set values.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IValueProvider.SetValue(System.Object,System.Object)">
- <summary>
- Sets the value.
- </summary>
- <param name="target">The target to set the value on.</param>
- <param name="value">The value to set on the target.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.IValueProvider.GetValue(System.Object)">
- <summary>
- Gets the value.
- </summary>
- <param name="target">The target to get the value from.</param>
- <returns>The value.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonArrayContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.CollectionItemType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the collection items.
- </summary>
- <value>The <see cref="T:System.Type"/> of the collection items.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonArrayContract.IsMultidimensionalArray">
- <summary>
- Gets a value indicating whether the collection type is a multidimensional array.
- </summary>
- <value><c>true</c> if the collection type is a multidimensional array; otherwise, <c>false</c>.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonArrayContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonArrayContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonContainerContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemConverter">
- <summary>
- Gets or sets the default collection items <see cref="T:Newtonsoft.Json.JsonConverter" />.
- </summary>
- <value>The converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemIsReference">
- <summary>
- Gets or sets a value indicating whether the collection items preserve object references.
- </summary>
- <value><c>true</c> if collection items preserve object references; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemReferenceLoopHandling">
- <summary>
- Gets or sets the collection item reference loop handling.
- </summary>
- <value>The reference loop handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContainerContract.ItemTypeNameHandling">
- <summary>
- Gets or sets the collection item type name handling.
- </summary>
- <value>The type name handling.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonContainerContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonContainerContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.SerializationCallback">
- <summary>
- Handles <see cref="T:Newtonsoft.Json.JsonSerializer"/> serialization callback events.
- </summary>
- <param name="o">The object that raised the callback event.</param>
- <param name="context">The streaming context.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.SerializationErrorCallback">
- <summary>
- Handles <see cref="T:Newtonsoft.Json.JsonSerializer"/> serialization error callback events.
- </summary>
- <param name="o">The object that raised the callback event.</param>
- <param name="context">The streaming context.</param>
- <param name="errorContext">The error context.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ExtensionDataSetter">
- <summary>
- Sets extension data for an object during deserialization.
- </summary>
- <param name="o">The object to set extension data on.</param>
- <param name="key">The extension data key.</param>
- <param name="value">The extension data value.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ExtensionDataGetter">
- <summary>
- Gets extension data for an object during serialization.
- </summary>
- <param name="o">The object to set extension data on.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.UnderlyingType">
- <summary>
- Gets the underlying type for the contract.
- </summary>
- <value>The underlying type for the contract.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.CreatedType">
- <summary>
- Gets or sets the type created during deserialization.
- </summary>
- <value>The type created during deserialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.IsReference">
- <summary>
- Gets or sets whether this type contract is serialized as a reference.
- </summary>
- <value>Whether this type contract is serialized as a reference.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.Converter">
- <summary>
- Gets or sets the default <see cref="T:Newtonsoft.Json.JsonConverter" /> for this contract.
- </summary>
- <value>The converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializedCallbacks">
- <summary>
- Gets or sets all methods called immediately after deserialization of the object.
- </summary>
- <value>The methods called immediately after deserialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializingCallbacks">
- <summary>
- Gets or sets all methods called during deserialization of the object.
- </summary>
- <value>The methods called during deserialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializedCallbacks">
- <summary>
- Gets or sets all methods called after serialization of the object graph.
- </summary>
- <value>The methods called after serialization of the object graph.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializingCallbacks">
- <summary>
- Gets or sets all methods called before serialization of the object.
- </summary>
- <value>The methods called before serialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnErrorCallbacks">
- <summary>
- Gets or sets all method called when an error is thrown during the serialization of the object.
- </summary>
- <value>The methods called when an error is thrown during the serialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserialized">
- <summary>
- Gets or sets the method called immediately after deserialization of the object.
- </summary>
- <value>The method called immediately after deserialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnDeserializing">
- <summary>
- Gets or sets the method called during deserialization of the object.
- </summary>
- <value>The method called during deserialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerialized">
- <summary>
- Gets or sets the method called after serialization of the object graph.
- </summary>
- <value>The method called after serialization of the object graph.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnSerializing">
- <summary>
- Gets or sets the method called before serialization of the object.
- </summary>
- <value>The method called before serialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.OnError">
- <summary>
- Gets or sets the method called when an error is thrown during the serialization of the object.
- </summary>
- <value>The method called when an error is thrown during the serialization of the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator">
- <summary>
- Gets or sets the default creator method used to create the object.
- </summary>
- <value>The default creator method used to create the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreatorNonPublic">
- <summary>
- Gets or sets a value indicating whether the default creator is non public.
- </summary>
- <value><c>true</c> if the default object creator is non-public; otherwise, <c>false</c>.</value>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonDictionaryContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.PropertyNameResolver">
- <summary>
- Gets or sets the property name resolver.
- </summary>
- <value>The property name resolver.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryKeyResolver">
- <summary>
- Gets or sets the dictionary key resolver.
- </summary>
- <value>The dictionary key resolver.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryKeyType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the dictionary keys.
- </summary>
- <value>The <see cref="T:System.Type"/> of the dictionary keys.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonDictionaryContract.DictionaryValueType">
- <summary>
- Gets the <see cref="T:System.Type"/> of the dictionary values.
- </summary>
- <value>The <see cref="T:System.Type"/> of the dictionary values.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonDictionaryContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonDictionaryContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonDynamicContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonDynamicContract.Properties">
- <summary>
- Gets the object's properties.
- </summary>
- <value>The object's properties.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonDynamicContract.PropertyNameResolver">
- <summary>
- Gets or sets the property name resolver.
- </summary>
- <value>The property name resolver.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonDynamicContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonDynamicContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonISerializableContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonISerializableContract.ISerializableCreator">
- <summary>
- Gets or sets the ISerializable object constructor.
- </summary>
- <value>The ISerializable object constructor.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonISerializableContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonISerializableContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonLinqContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonLinqContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonLinqContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonObjectContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.MemberSerialization">
- <summary>
- Gets or sets the object member serialization.
- </summary>
- <value>The member object serialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ItemRequired">
- <summary>
- Gets or sets a value that indicates whether the object's properties are required.
- </summary>
- <value>
- A value indicating whether the object's properties are required.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.Properties">
- <summary>
- Gets the object's properties.
- </summary>
- <value>The object's properties.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ConstructorParameters">
- <summary>
- Gets the constructor parameters required for any non-default constructor
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.CreatorParameters">
- <summary>
- Gets a collection of <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> instances that define the parameters used with <see cref="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideCreator"/>.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideConstructor">
- <summary>
- Gets or sets the override constructor used to create the object.
- This is set when a constructor is marked up using the
- JsonConstructor attribute.
- </summary>
- <value>The override constructor.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ParametrizedConstructor">
- <summary>
- Gets or sets the parametrized constructor used to create the object.
- </summary>
- <value>The parametrized constructor.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.OverrideCreator">
- <summary>
- Gets or sets the function used to create the object. When set this function will override <see cref="P:Newtonsoft.Json.Serialization.JsonContract.DefaultCreator"/>.
- This function is called with a collection of arguments which are defined by the <see cref="P:Newtonsoft.Json.Serialization.JsonObjectContract.CreatorParameters"/> collection.
- </summary>
- <value>The function used to create the object.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataSetter">
- <summary>
- Gets or sets the extension data setter.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonObjectContract.ExtensionDataGetter">
- <summary>
- Gets or sets the extension data getter.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonObjectContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonObjectContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonPrimitiveContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonPrimitiveContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonProperty">
- <summary>
- Maps a JSON property to a .NET member or constructor parameter.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.PropertyName">
- <summary>
- Gets or sets the name of the property.
- </summary>
- <value>The name of the property.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.DeclaringType">
- <summary>
- Gets or sets the type that declared this property.
- </summary>
- <value>The type that declared this property.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Order">
- <summary>
- Gets or sets the order of serialization and deserialization of a member.
- </summary>
- <value>The numeric order of serialization or deserialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.UnderlyingName">
- <summary>
- Gets or sets the name of the underlying member or parameter.
- </summary>
- <value>The name of the underlying member or parameter.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ValueProvider">
- <summary>
- Gets the <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> during serialization.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Serialization.IValueProvider"/> that will get and set the <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> during serialization.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.AttributeProvider">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.Serialization.IAttributeProvider"/> for this property.
- </summary>
- <value>The <see cref="T:Newtonsoft.Json.Serialization.IAttributeProvider"/> for this property.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.PropertyType">
- <summary>
- Gets or sets the type of the property.
- </summary>
- <value>The type of the property.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Converter">
- <summary>
- Gets or sets the <see cref="T:Newtonsoft.Json.JsonConverter" /> for the property.
- If set this converter takes presidence over the contract converter for the property type.
- </summary>
- <value>The converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.MemberConverter">
- <summary>
- Gets or sets the member converter.
- </summary>
- <value>The member converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Ignored">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is ignored.
- </summary>
- <value><c>true</c> if ignored; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Readable">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is readable.
- </summary>
- <value><c>true</c> if readable; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Writable">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is writable.
- </summary>
- <value><c>true</c> if writable; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.HasMemberAttribute">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> has a member attribute.
- </summary>
- <value><c>true</c> if has a member attribute; otherwise, <c>false</c>.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.DefaultValue">
- <summary>
- Gets the default value.
- </summary>
- <value>The default value.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.Required">
- <summary>
- Gets or sets a value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.
- </summary>
- <value>A value indicating whether this <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> is required.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.IsReference">
- <summary>
- Gets or sets a value indicating whether this property preserves object references.
- </summary>
- <value>
- <c>true</c> if this instance is reference; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.NullValueHandling">
- <summary>
- Gets or sets the property null value handling.
- </summary>
- <value>The null value handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.DefaultValueHandling">
- <summary>
- Gets or sets the property default value handling.
- </summary>
- <value>The default value handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ReferenceLoopHandling">
- <summary>
- Gets or sets the property reference loop handling.
- </summary>
- <value>The reference loop handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ObjectCreationHandling">
- <summary>
- Gets or sets the property object creation handling.
- </summary>
- <value>The object creation handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.TypeNameHandling">
- <summary>
- Gets or sets or sets the type name handling.
- </summary>
- <value>The type name handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ShouldSerialize">
- <summary>
- Gets or sets a predicate used to determine whether the property should be serialize.
- </summary>
- <value>A predicate used to determine whether the property should be serialize.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.GetIsSpecified">
- <summary>
- Gets or sets a predicate used to determine whether the property should be serialized.
- </summary>
- <value>A predicate used to determine whether the property should be serialized.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.SetIsSpecified">
- <summary>
- Gets or sets an action used to set whether the property has been deserialized.
- </summary>
- <value>An action used to set whether the property has been deserialized.</value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonProperty.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> that represents this instance.
- </summary>
- <returns>
- A <see cref="T:System.String"/> that represents this instance.
- </returns>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemConverter">
- <summary>
- Gets or sets the converter used when serializing the property's collection items.
- </summary>
- <value>The collection's items converter.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemIsReference">
- <summary>
- Gets or sets whether this property's collection items are serialized as a reference.
- </summary>
- <value>Whether this property's collection items are serialized as a reference.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemTypeNameHandling">
- <summary>
- Gets or sets the the type name handling used when serializing the property's collection items.
- </summary>
- <value>The collection's items type name handling.</value>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.JsonProperty.ItemReferenceLoopHandling">
- <summary>
- Gets or sets the the reference loop handling used when serializing the property's collection items.
- </summary>
- <value>The collection's items reference loop handling.</value>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonPropertyCollection">
- <summary>
- A collection of <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> objects.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonPropertyCollection"/> class.
- </summary>
- <param name="type">The type.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetKeyForItem(Newtonsoft.Json.Serialization.JsonProperty)">
- <summary>
- When implemented in a derived class, extracts the key from the specified element.
- </summary>
- <param name="item">The element from which to extract the key.</param>
- <returns>The key for the specified element.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.AddProperty(Newtonsoft.Json.Serialization.JsonProperty)">
- <summary>
- Adds a <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> object.
- </summary>
- <param name="property">The property to add to the collection.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetClosestMatchProperty(System.String)">
- <summary>
- Gets the closest matching <see cref="T:Newtonsoft.Json.Serialization.JsonProperty"/> object.
- First attempts to get an exact case match of propertyName and then
- a case insensitive match.
- </summary>
- <param name="propertyName">Name of the property.</param>
- <returns>A matching property if found.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonPropertyCollection.GetProperty(System.String,System.StringComparison)">
- <summary>
- Gets a property by property name.
- </summary>
- <param name="propertyName">The name of the property to get.</param>
- <param name="comparisonType">Type property name string comparison.</param>
- <returns>A matching property if found.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.JsonStringContract">
- <summary>
- Contract details for a <see cref="T:System.Type"/> used by the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonStringContract.#ctor(System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.JsonStringContract"/> class.
- </summary>
- <param name="underlyingType">The underlying type for the contract.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonTypeReflector.CreateJsonConverterInstance(System.Type,System.Object[])">
- <summary>
- Lookup and create an instance of the JsonConverter type described by the argument.
- </summary>
- <param name="converterType">The JsonConverter type to create.</param>
- <param name="converterArgs">Optional arguments to pass to an initializing constructor of the JsonConverter.
- If null, the default constructor is used.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.JsonTypeReflector.GetJsonConverterCreator(System.Type)">
- <summary>
- Create a factory function that can be used to create instances of a JsonConverter described by the
- argument type. The returned function can then be used to either invoke the converter's default ctor, or any
- parameterized constructors by way of an object array.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.MemoryTraceWriter">
- <summary>
- 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.
- </summary>
- </member>
- <member name="P:Newtonsoft.Json.Serialization.MemoryTraceWriter.LevelFilter">
- <summary>
- Gets the <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
- For example a filter level of <code>Info</code> will exclude <code>Verbose</code> messages and include <code>Info</code>,
- <code>Warning</code> and <code>Error</code> messages.
- </summary>
- <value>
- The <see cref="T:System.Diagnostics.TraceLevel"/> that will be used to filter the trace messages passed to the writer.
- </value>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.MemoryTraceWriter"/> class.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.Trace(System.Diagnostics.TraceLevel,System.String,System.Exception)">
- <summary>
- Writes the specified trace level, message and optional exception.
- </summary>
- <param name="level">The <see cref="T:System.Diagnostics.TraceLevel"/> at which to write this trace.</param>
- <param name="message">The trace message.</param>
- <param name="ex">The trace exception. This parameter is optional.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.GetTraceMessages">
- <summary>
- Returns an enumeration of the most recent trace messages.
- </summary>
- <returns>An enumeration of the most recent trace messages.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.MemoryTraceWriter.ToString">
- <summary>
- Returns a <see cref="T:System.String"/> of the most recent trace messages.
- </summary>
- <returns>
- A <see cref="T:System.String"/> of the most recent trace messages.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ObjectConstructor`1">
- <summary>
- Represents a method that constructs an object.
- </summary>
- <typeparam name="T">The object type to create.</typeparam>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.OnErrorAttribute">
- <summary>
- When applied to a method, specifies that the method is called when an error occurs serializing an object.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ReflectionAttributeProvider">
- <summary>
- Provides methods to get attributes from a <see cref="T:System.Type"/>, <see cref="T:System.Reflection.MemberInfo"/>, <see cref="T:System.Reflection.ParameterInfo"/> or <see cref="T:System.Reflection.Assembly"/>.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ReflectionAttributeProvider.#ctor(System.Object)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ReflectionAttributeProvider"/> class.
- </summary>
- <param name="attributeProvider">The instance to get attributes for. This parameter should be a <see cref="T:System.Type"/>, <see cref="T:System.Reflection.MemberInfo"/>, <see cref="T:System.Reflection.ParameterInfo"/> or <see cref="T:System.Reflection.Assembly"/>.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ReflectionAttributeProvider.GetAttributes(System.Boolean)">
- <summary>
- Returns a collection of all of the attributes, or an empty collection if there are no attributes.
- </summary>
- <param name="inherit">When true, look up the hierarchy chain for the inherited custom attribute.</param>
- <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ReflectionAttributeProvider.GetAttributes(System.Type,System.Boolean)">
- <summary>
- Returns a collection of attributes, identified by type, or an empty collection if there are no attributes.
- </summary>
- <param name="attributeType">The type of the attributes.</param>
- <param name="inherit">When true, look up the hierarchy chain for the inherited custom attribute.</param>
- <returns>A collection of <see cref="T:System.Attribute"/>s, or an empty collection.</returns>
- </member>
- <member name="T:Newtonsoft.Json.Serialization.ReflectionValueProvider">
- <summary>
- Get and set values for a <see cref="T:System.Reflection.MemberInfo"/> using reflection.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.#ctor(System.Reflection.MemberInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:Newtonsoft.Json.Serialization.ReflectionValueProvider"/> class.
- </summary>
- <param name="memberInfo">The member info.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.SetValue(System.Object,System.Object)">
- <summary>
- Sets the value.
- </summary>
- <param name="target">The target to set the value on.</param>
- <param name="value">The value to set on the target.</param>
- </member>
- <member name="M:Newtonsoft.Json.Serialization.ReflectionValueProvider.GetValue(System.Object)">
- <summary>
- Gets the value.
- </summary>
- <param name="target">The target to get the value from.</param>
- <returns>The value.</returns>
- </member>
- <member name="T:Newtonsoft.Json.StringEscapeHandling">
- <summary>
- Specifies how strings are escaped when writing JSON text.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.StringEscapeHandling.Default">
- <summary>
- Only control characters (e.g. newline) are escaped.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.StringEscapeHandling.EscapeNonAscii">
- <summary>
- All non-ASCII and control characters (e.g. newline) are escaped.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.StringEscapeHandling.EscapeHtml">
- <summary>
- HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped.
- </summary>
- </member>
- <member name="T:Newtonsoft.Json.TypeNameHandling">
- <summary>
- Specifies type name handling options for the <see cref="T:Newtonsoft.Json.JsonSerializer"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.TypeNameHandling.None">
- <summary>
- Do not include the .NET type name when serializing types.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.TypeNameHandling.Objects">
- <summary>
- Include the .NET type name when serializing into a JSON object structure.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.TypeNameHandling.Arrays">
- <summary>
- Include the .NET type name when serializing into a JSON array structure.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.TypeNameHandling.All">
- <summary>
- Always include the .NET type name when serializing.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.TypeNameHandling.Auto">
- <summary>
- Include the .NET type name when the type of the object being serialized is not the same as its declared type.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.CollectionUtils.IsNullOrEmpty``1(System.Collections.Generic.ICollection{``0})">
- <summary>
- Determines whether the collection is null or empty.
- </summary>
- <param name="collection">The collection.</param>
- <returns>
- <c>true</c> if the collection is null or empty; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.CollectionUtils.AddRange``1(System.Collections.Generic.IList{``0},System.Collections.Generic.IEnumerable{``0})">
- <summary>
- Adds the elements of the specified collection to the specified generic IList.
- </summary>
- <param name="initial">The list to add to.</param>
- <param name="collection">The collection of elements to add.</param>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.CollectionUtils.IndexOf``1(System.Collections.Generic.IEnumerable{``0},``0,System.Collections.Generic.IEqualityComparer{``0})">
- <summary>
- Returns the index of the first occurrence in a sequence by using a specified IEqualityComparer{TSource}.
- </summary>
- <typeparam name="TSource">The type of the elements of source.</typeparam>
- <param name="list">A sequence in which to locate a value.</param>
- <param name="value">The object to locate in the sequence</param>
- <param name="comparer">An equality comparer to compare values.</param>
- <returns>The zero-based index of the first occurrence of value within the entire sequence, if found; otherwise, –1.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ConvertUtils.ConvertOrCast(System.Object,System.Globalization.CultureInfo,System.Type)">
- <summary>
- 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.
- </summary>
- <param name="initialValue">The value to convert.</param>
- <param name="culture">The culture to use when converting.</param>
- <param name="targetType">The type to convert or cast the value to.</param>
- <returns>
- The converted type. If conversion was unsuccessful, the initial value
- is returned if assignable to the target type.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodWithResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback,Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)">
- <summary>
- Helper method for generating a MetaObject which calls a
- specific method on Dynamic that returns a result
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodReturnLast(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)">
- <summary>
- Helper method for generating a MetaObject which calls a
- specific method on Dynamic, but uses one of the arguments for
- the result.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.CallMethodNoResult(System.String,System.Dynamic.DynamicMetaObjectBinder,System.Linq.Expressions.Expression[],Newtonsoft.Json.Utilities.DynamicProxyMetaObject{`0}.Fallback)">
- <summary>
- Helper method for generating a MetaObject which calls a
- specific method on Dynamic, but uses one of the arguments for
- the result.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.DynamicProxyMetaObject`1.GetRestrictions">
- <summary>
- Returns a Restrictions object which includes our current restrictions merged
- with a restriction limiting our type
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.EnumUtils.GetNamesAndValues``1">
- <summary>
- Gets a dictionary of the names and values of an Enum type.
- </summary>
- <returns></returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.EnumUtils.GetNamesAndValues``1(System.Type)">
- <summary>
- Gets a dictionary of the names and values of an Enum type.
- </summary>
- <param name="enumType">The enum type to get names and values for.</param>
- <returns></returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetCollectionItemType(System.Type)">
- <summary>
- Gets the type of the typed collection's items.
- </summary>
- <param name="type">The type.</param>
- <returns>The type of the typed collection's items.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetMemberUnderlyingType(System.Reflection.MemberInfo)">
- <summary>
- Gets the member's underlying type.
- </summary>
- <param name="member">The member.</param>
- <returns>The underlying type of the member.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.MemberInfo)">
- <summary>
- Determines whether the member is an indexed property.
- </summary>
- <param name="member">The member.</param>
- <returns>
- <c>true</c> if the member is an indexed property; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.IsIndexedProperty(System.Reflection.PropertyInfo)">
- <summary>
- Determines whether the property is an indexed property.
- </summary>
- <param name="property">The property.</param>
- <returns>
- <c>true</c> if the property is an indexed property; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.GetMemberValue(System.Reflection.MemberInfo,System.Object)">
- <summary>
- Gets the member's value on the object.
- </summary>
- <param name="member">The member.</param>
- <param name="target">The target object.</param>
- <returns>The member's value on the object.</returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.SetMemberValue(System.Reflection.MemberInfo,System.Object,System.Object)">
- <summary>
- Sets the member's value on the target object.
- </summary>
- <param name="member">The member.</param>
- <param name="target">The target.</param>
- <param name="value">The value.</param>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.CanReadMemberValue(System.Reflection.MemberInfo,System.Boolean)">
- <summary>
- Determines whether the specified MemberInfo can be read.
- </summary>
- <param name="member">The MemberInfo to determine whether can be read.</param>
- /// <param name="nonPublic">if set to <c>true</c> then allow the member to be gotten non-publicly.</param>
- <returns>
- <c>true</c> if the specified MemberInfo can be read; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.ReflectionUtils.CanSetMemberValue(System.Reflection.MemberInfo,System.Boolean,System.Boolean)">
- <summary>
- Determines whether the specified MemberInfo can be set.
- </summary>
- <param name="member">The MemberInfo to determine whether can be set.</param>
- <param name="nonPublic">if set to <c>true</c> then allow the member to be set non-publicly.</param>
- <param name="canSetReadOnly">if set to <c>true</c> then allow the member to be set if read-only.</param>
- <returns>
- <c>true</c> if the specified MemberInfo can be set; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="T:Newtonsoft.Json.Utilities.StringBuffer">
- <summary>
- Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer.
- </summary>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.StringUtils.IsWhiteSpace(System.String)">
- <summary>
- Determines whether the string is all white space. Empty string will return false.
- </summary>
- <param name="s">The string to test whether it is all white space.</param>
- <returns>
- <c>true</c> if the string is all white space; otherwise, <c>false</c>.
- </returns>
- </member>
- <member name="M:Newtonsoft.Json.Utilities.StringUtils.NullEmptyString(System.String)">
- <summary>
- Nulls an empty string.
- </summary>
- <param name="s">The string.</param>
- <returns>Null if the string was null, otherwise the string unchanged.</returns>
- </member>
- <member name="T:Newtonsoft.Json.WriteState">
- <summary>
- Specifies the state of the <see cref="T:Newtonsoft.Json.JsonWriter"/>.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Error">
- <summary>
- An exception has been thrown, which has left the <see cref="T:Newtonsoft.Json.JsonWriter"/> in an invalid state.
- You may call the <see cref="M:Newtonsoft.Json.JsonWriter.Close"/> method to put the <see cref="T:Newtonsoft.Json.JsonWriter"/> in the <c>Closed</c> state.
- Any other <see cref="T:Newtonsoft.Json.JsonWriter"/> method calls results in an <see cref="T:System.InvalidOperationException"/> being thrown.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Closed">
- <summary>
- The <see cref="M:Newtonsoft.Json.JsonWriter.Close"/> method has been called.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Object">
- <summary>
- An object is being written.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Array">
- <summary>
- A array is being written.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Constructor">
- <summary>
- A constructor is being written.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Property">
- <summary>
- A property is being written.
- </summary>
- </member>
- <member name="F:Newtonsoft.Json.WriteState.Start">
- <summary>
- A write method has not been called.
- </summary>
- </member>
- </members>
-</doc>
diff --git a/win/CS/libraries/json/license.txt b/win/CS/libraries/json/license.txt deleted file mode 100644 index 8842027bc..000000000 --- a/win/CS/libraries/json/license.txt +++ /dev/null @@ -1,18 +0,0 @@ -Copyright (c) 2007 James Newton-King
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this
-software and associated documentation files (the "Software"), to deal in the Software
-without restriction, including without limitation the rights to use, copy, modify,
-merge, publish, distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to the following
-conditions:
-
-The above copyright notice and this permission notice shall be included in all copies
-or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
-INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
-PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
-HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE
-OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
\ No newline at end of file diff --git a/win/CS/libraries/json/readme.txt b/win/CS/libraries/json/readme.txt deleted file mode 100644 index 24c709305..000000000 --- a/win/CS/libraries/json/readme.txt +++ /dev/null @@ -1,54 +0,0 @@ -Json.NET
-
-http://james.newtonking.com/json
-http://www.codeplex.com/json
-https://github.com/JamesNK/Newtonsoft.Json
-
-
-Description:
-
-Json.NET is a popular high-performance JSON framework for .NET
-
--Flexible JSON serializer for converting between .NET objects and JSON
--LINQ to JSON for manually reading and writing JSON
--High performance, faster than .NET's built-in JSON serializers
--Write indented, easy to read JSON
--Convert JSON to and from XML
--Supports .NET 2, .NET 3.5, .NET 4, .NET 4.5, Silverlight, Windows Phone and Windows 8 Store
-
-
-Documentation:
-
-http://james.newtonking.com/json/help/
-
-
-Versions:
-
-Json.NET has different libraries for the various .NET Framework versions.
-
--Net45:
- .NET latest (4.5)
-
--Net40:
- .NET 4.0
-
--Net35:
- .NET 3.5
-
--Net20:
- .NET 2.0
-
--WinRT:
- Windows 8 Store
-
--Portable45:
- .NET 4.5, Windows Phone 8, Windows 8 Store, ASP.NET CoreCLR
-
--Portable40:
- .NET 4.0, Windows Phone 8, Windows 8 Store, Silverlight 5, MonoTouch, MonoDroid
-
-
-Notes:
-
-For a Compact Framework 3.5 and Silverlight 3.0 builds download Json.NET 3.5
-For a Silverlight 4.0 and Windows Phone 7 builds download Json.NET 5
\ No newline at end of file |