DaNike
/
BeatSaber-IPA-Reloaded
mirror of https://github.com/bsmg/BeatSaber-IPA-Reloaded.git

﻿<!DOCTYPE html><!--[if IE]><![endif]--><html>    <head>    <meta charset="utf-8">    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">    <title>Class DictionaryConverter&lt;TValue&gt;   </title>    <meta name="viewport" content="width=device-width">    <meta name="title" content="Class DictionaryConverter&lt;TValue&gt;   ">    <meta name="generator" content="docfx 2.59.3.0">        <link rel="shortcut icon" href="../favicon.ico">    <link rel="stylesheet" href="../styles/docfx.vendor.css">    <link rel="stylesheet" href="../styles/docfx.css">    <link rel="stylesheet" href="../styles/main.css">    <link rel="stylesheet" href="../styles/fix.css">    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">     <meta property="docfx:navrel" content="../toc.html">    <meta property="docfx:tocrel" content="toc.html">        <meta property="docfx:rel" content="../">    <meta property="docfx:newtab" content="true">  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">    <div id="wrapper">      <header>                <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">          <div class="container">            <div class="navbar-header">              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">                <span class="sr-only">Toggle navigation</span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>                <span class="icon-bar"></span>              </button>                            <a class="navbar-brand" href="../index.html">                <img id="logo" class="svg" src="../logo.svg" alt="">              </a>            </div>            <div class="collapse navbar-collapse" id="navbar">              <form class="navbar-form navbar-right" role="search" id="search">                <div class="form-group">                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">                </div>              </form>            </div>          </div>        </nav>                <div class="subnav navbar navbar-default">          <div class="container hide-when-search" id="breadcrumb">            <ul class="breadcrumb">              <li></li>            </ul>          </div>        </div>      </header>      <div class="container body-content">                <div id="search-results">          <div class="search-list">Search Results for <span></span></div>          <div class="sr-items">            <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>          </div>          <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>        </div>      </div>      <div role="main" class="container body-content hide-when-search">                <div class="sidenav hide-when-search">          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>          <div class="sidetoggle collapse" id="sidetoggle">            <div id="sidetoc"></div>          </div>        </div>        <div class="article row grid-right">          <div class="col-md-10">            <article class="content wrap" id="_content" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1">      <h1 id="IPA_Config_Stores_Converters_DictionaryConverter_1" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1" class="text-break">Class DictionaryConverter&lt;TValue&gt;  </h1>  <div class="markdown level0 summary"><p>A converter for instances of <see cref="!:Dictionary&lt;TKey, TValue>"></see>.</p></div>  <div class="markdown level0 conceptual"></div>  <div class="inheritance">    <h5>Inheritance</h5>    <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>    <div class="level1"><a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter</a>&lt;<span class="xref">Dictionary</span>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, TValue&gt;&gt;</div>    <div class="level2"><span class="xref">DictionaryConverter&lt;TValue&gt;</span></div>      <div class="level3"><a class="xref" href="IPA.Config.Stores.Converters.DictionaryConverter-2.html">DictionaryConverter&lt;TValue, TConverter&gt;</a></div>  </div>  <div class="implements">    <h5>Implements</h5>    <div><a class="xref" href="IPA.Config.Stores.IValueConverter.html">IValueConverter</a></div>  </div>  <div class="inheritedMembers">    <h5>Inherited Members</h5>    <div>      <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_ToValue__0_System_Object_">ValueConverter&lt;Dictionary&lt;String, TValue&gt;&gt;.ToValue(Dictionary&lt;String, TValue&gt;, Object)</a>    </div>    <div>      <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_FromValue_IPA_Config_Data_Value_System_Object_">ValueConverter&lt;Dictionary&lt;String, TValue&gt;&gt;.FromValue(Value, Object)</a>    </div>    <div>      <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_IPA_Config_Stores_IValueConverter_ToValue_System_Nullable_System_Object__System_Object_">ValueConverter&lt;Dictionary&lt;String, TValue&gt;&gt;.IValueConverter.ToValue(Nullable&lt;Object&gt;, Object)</a>    </div>    <div>      <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_IPA_Config_Stores_IValueConverter_FromValue_IPA_Config_Data_Value_System_Object_">ValueConverter&lt;Dictionary&lt;String, TValue&gt;&gt;.IValueConverter.FromValue(Value, Object)</a>    </div>    <div>      <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_IPA_Config_Stores_IValueConverter_Type">ValueConverter&lt;Dictionary&lt;String, TValue&gt;&gt;.IValueConverter.Type</a>    </div>  </div>  <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.Converters.html">IPA.Config.Stores.Converters</a></h6>  <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>  <h5 id="IPA_Config_Stores_Converters_DictionaryConverter_1_syntax">Syntax</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public class DictionaryConverter&lt;TValue&gt; : ValueConverter&lt;Dictionary&lt;string, TValue&gt;&gt;, IValueConverter</code></pre>  </div>  <h5 class="typeParameters">Type Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="parametername">TValue</span></td>        <td><p>the value type of the dictionary</p></td>      </tr>    </tbody>  </table>  <h3 id="constructors">Constructors  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_DictionaryConverter_1__ctor.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.DictionaryConverter%601.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Stores/Converters.cs/#L387">View Source</a>  </span>  <a id="IPA_Config_Stores_Converters_DictionaryConverter_1__ctor_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.#ctor*"></a>  <h4 id="IPA_Config_Stores_Converters_DictionaryConverter_1__ctor" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.#ctor">DictionaryConverter()</h4>  <div class="markdown level1 summary"><p>Constructs an <a class="xref" href="IPA.Config.Stores.Converters.IDictionaryConverter-1.html">IDictionaryConverter&lt;TValue&gt;</a> using the default converter for the value type.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public DictionaryConverter()</code></pre>  </div>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_DictionaryConverter_1__ctor_IPA_Config_Stores_ValueConverter__0__.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.DictionaryConverter%601.%23ctor(IPA.Config.Stores.ValueConverter%7B%600%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Stores/Converters.cs/#L392">View Source</a>  </span>  <a id="IPA_Config_Stores_Converters_DictionaryConverter_1__ctor_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.#ctor*"></a>  <h4 id="IPA_Config_Stores_Converters_DictionaryConverter_1__ctor_IPA_Config_Stores_ValueConverter__0__" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.#ctor(IPA.Config.Stores.ValueConverter{`0})">DictionaryConverter(ValueConverter&lt;TValue&gt;)</h4>  <div class="markdown level1 summary"><p>Constructs an <a class="xref" href="IPA.Config.Stores.Converters.IDictionaryConverter-1.html">IDictionaryConverter&lt;TValue&gt;</a> using the specified converter for the value.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public DictionaryConverter(ValueConverter&lt;TValue&gt; converter)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter</a>&lt;TValue&gt;</td>        <td><span class="parametername">converter</span></td>        <td><p>the converter for the value</p></td>      </tr>    </tbody>  </table>  <h3 id="properties">Properties  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_DictionaryConverter_1_BaseConverter.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.DictionaryConverter%601.BaseConverter%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Stores/Converters.cs/#L382">View Source</a>  </span>  <a id="IPA_Config_Stores_Converters_DictionaryConverter_1_BaseConverter_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.BaseConverter*"></a>  <h4 id="IPA_Config_Stores_Converters_DictionaryConverter_1_BaseConverter" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.BaseConverter">BaseConverter</h4>  <div class="markdown level1 summary"><p>Gets the converter for the dictionary&apos;s value type.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">protected ValueConverter&lt;TValue&gt; BaseConverter { get; }</code></pre>  </div>  <h5 class="propertyValue">Property Value</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter</a>&lt;TValue&gt;</td>        <td></td>      </tr>    </tbody>  </table>  <h3 id="methods">Methods  </h3>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_DictionaryConverter_1_FromValue_IPA_Config_Data_Value_System_Object_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.DictionaryConverter%601.FromValue(IPA.Config.Data.Value%2CSystem.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Stores/Converters.cs/#L401">View Source</a>  </span>  <a id="IPA_Config_Stores_Converters_DictionaryConverter_1_FromValue_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.FromValue*"></a>  <h4 id="IPA_Config_Stores_Converters_DictionaryConverter_1_FromValue_IPA_Config_Data_Value_System_Object_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.FromValue(IPA.Config.Data.Value,System.Object)">FromValue(Value, Object)</h4>  <div class="markdown level1 summary"><p>Converts a <a class="xref" href="IPA.Config.Data.Map.html">Map</a> to a <see cref="!:Dictionary&lt;TKey, TValue>"></see> that is represented by it.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public override Dictionary&lt;string, TValue&gt; FromValue(Value value, object parent)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>        <td><span class="parametername">value</span></td>        <td><p>the <a class="xref" href="IPA.Config.Data.Map.html">Map</a> to convert</p></td>      </tr>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>        <td><span class="parametername">parent</span></td>        <td><p>the parent that will own the resulting object</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><span class="xref">Dictionary</span>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, TValue&gt;</td>        <td><p>the deserialized dictionary</p></td>      </tr>    </tbody>  </table>  <h5 class="overrides">Overrides</h5>  <div><span class="xref">IPA.Config.Stores.ValueConverter&lt;Dictionary&lt;System.String, TValue&gt;&gt;.FromValue(IPA.Config.Data.Value, System.Object)</span></div>  <span class="small pull-right mobile-hide">    <span class="divider">|</span>    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_DictionaryConverter_1_ToValue_System_Nullable_Dictionary_System_String__0___System_Object_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.DictionaryConverter%601.ToValue(System.Nullable%7BDictionary%7BSystem.String%2C%600%7D%7D%2CSystem.Object)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>  </span>  <span class="small pull-right mobile-hide">    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Stores/Converters.cs/#L412">View Source</a>  </span>  <a id="IPA_Config_Stores_Converters_DictionaryConverter_1_ToValue_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.ToValue*"></a>  <h4 id="IPA_Config_Stores_Converters_DictionaryConverter_1_ToValue_System_Nullable_Dictionary_System_String__0___System_Object_" data-uid="IPA.Config.Stores.Converters.DictionaryConverter`1.ToValue(System.Nullable{Dictionary{System.String,`0}},System.Object)">ToValue(Nullable&lt;Dictionary&lt;String, TValue&gt;&gt;, Object)</h4>  <div class="markdown level1 summary"><p>Serializes a <see cref="!:Dictionary&lt;TKey, TValue>"></see> into a <a class="xref" href="IPA.Config.Data.Map.html">Map</a> containing its values.</p></div>  <div class="markdown level1 conceptual"></div>  <h5 class="decalaration">Declaration</h5>  <div class="codewrapper">    <pre><code class="lang-csharp hljs">public override Value ToValue(Dictionary&lt;string, TValue&gt;? obj, object parent)</code></pre>  </div>  <h5 class="parameters">Parameters</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Name</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">Dictionary</span>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, TValue&gt;&gt;</td>        <td><span class="parametername">obj</span></td>        <td><p>the dictionary to serialize</p></td>      </tr>      <tr>        <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>        <td><span class="parametername">parent</span></td>        <td><p>the object that owns the dictionary</p></td>      </tr>    </tbody>  </table>  <h5 class="returns">Returns</h5>  <table class="table table-bordered table-striped table-condensed">    <thead>      <tr>        <th>Type</th>        <th>Description</th>      </tr>    </thead>    <tbody>      <tr>        <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>        <td><p>the dictionary serialized as a <a class="xref" href="IPA.Config.Data.Map.html">Map</a></p></td>      </tr>    </tbody>  </table>  <h3 id="implements">Implements</h3>  <div>      <a class="xref" href="IPA.Config.Stores.IValueConverter.html">IValueConverter</a>  </div>  <h3 id="extensionmethods">Extension Methods</h3>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetField__2___0_System_String___1_">ReflectionUtil.SetField&lt;T, U&gt;(T, String, U)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetField__2___1_System_String_">ReflectionUtil.GetField&lt;U, T&gt;(T, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_SetProperty__2___0_System_String___1_">ReflectionUtil.SetProperty&lt;T, U&gt;(T, String, U)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_GetProperty__2___1_System_String_">ReflectionUtil.GetProperty&lt;U, T&gt;(T, String)</a>  </div>  <div>      <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_InvokeMethod__2___1_System_String_System_Object___">ReflectionUtil.InvokeMethod&lt;U, T&gt;(T, String, Object[])</a>  </div></article>          </div>                    <div class="hidden-sm col-md-2" role="complementary">            <div class="sideaffix">              <div class="contribution">                <ul class="nav">                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_DictionaryConverter_1.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.DictionaryConverter%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>                  </li>                  <li>                    <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Stores/Converters.cs/#L377" class="contribution-link">View Source</a>                  </li>                </ul>              </div>              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">                <h5>In This Article</h5>                <div></div>              </nav>            </div>          </div>        </div>      </div>            <footer>        <div class="grad-bottom"></div>        <div class="footer">          <div class="container">            <span class="pull-right">              <a href="#top">Back to top</a>            </span>                        <span>Generated by <strong>DocFX</strong></span>          </div>        </div>      </footer>    </div>        <script type="text/javascript" src="../styles/docfx.vendor.js"></script>    <script type="text/javascript" src="../styles/docfx.js"></script>    <script type="text/javascript" src="../styles/main.js"></script>  </body></html>