You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

350 lines
17 KiB

  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class EnumConverter&lt;T&gt;
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class EnumConverter&lt;T&gt;
  11. ">
  12. <meta name="generator" content="docfx 2.48.0.0">
  13. <link rel="shortcut icon" href="../favicon.ico">
  14. <link rel="stylesheet" href="../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../styles/docfx.css">
  16. <link rel="stylesheet" href="../styles/main.css">
  17. <link rel="stylesheet" href="../styles/fix.css">
  18. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../">
  22. <meta property="docfx:newtab" content="true">
  23. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  24. <div id="wrapper">
  25. <header>
  26. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  27. <div class="container">
  28. <div class="navbar-header">
  29. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  30. <span class="sr-only">Toggle navigation</span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. <span class="icon-bar"></span>
  34. </button>
  35. <a class="navbar-brand" href="../index.html">
  36. <img id="logo" class="svg" src="../logo.svg" alt="">
  37. </a>
  38. </div>
  39. <div class="collapse navbar-collapse" id="navbar">
  40. <form class="navbar-form navbar-right" role="search" id="search">
  41. <div class="form-group">
  42. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  43. </div>
  44. </form>
  45. </div>
  46. </div>
  47. </nav>
  48. <div class="subnav navbar navbar-default">
  49. <div class="container hide-when-search" id="breadcrumb">
  50. <ul class="breadcrumb">
  51. <li></li>
  52. </ul>
  53. </div>
  54. </div>
  55. </header>
  56. <div class="container body-content">
  57. <div id="search-results">
  58. <div class="search-list"></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination"></ul>
  63. </div>
  64. </div>
  65. <div role="main" class="container body-content hide-when-search">
  66. <div class="sidenav hide-when-search">
  67. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  68. <div class="sidetoggle collapse" id="sidetoggle">
  69. <div id="sidetoc"></div>
  70. </div>
  71. </div>
  72. <div class="article row grid-right">
  73. <div class="col-md-10">
  74. <article class="content wrap" id="_content" data-uid="IPA.Config.Stores.Converters.EnumConverter`1">
  75. <h1 id="IPA_Config_Stores_Converters_EnumConverter_1" data-uid="IPA.Config.Stores.Converters.EnumConverter`1" class="text-break">Class EnumConverter&lt;T&gt;
  76. </h1>
  77. <div class="markdown level0 summary"><p>A converter for an enum of type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code>, that converts the enum to its string representation and back.</p>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  83. <div class="level1"><a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter</a>&lt;T&gt;</div>
  84. <div class="level2"><span class="xref">EnumConverter&lt;T&gt;</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><a class="xref" href="IPA.Config.Stores.IValueConverter.html">IValueConverter</a></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_IPA_Config_Stores_IValueConverter_ToValue_System_Object_System_Object_">ValueConverter&lt;T&gt;.IValueConverter.ToValue(Object, Object)</a>
  94. </div>
  95. <div>
  96. <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;T&gt;.IValueConverter.FromValue(Value, Object)</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html#IPA_Config_Stores_ValueConverter_1_IPA_Config_Stores_IValueConverter_Type">ValueConverter&lt;T&gt;.IValueConverter.Type</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.tostring#System_Object_ToString">Object.ToString()</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_System_Object_">Object.Equals(Object, Object)</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.referenceequals#System_Object_ReferenceEquals_System_Object_System_Object_">Object.ReferenceEquals(Object, Object)</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  121. </div>
  122. </div>
  123. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.Converters.html">IPA.Config.Stores.Converters</a></h6>
  124. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  125. <h5 id="IPA_Config_Stores_Converters_EnumConverter_1_syntax">Syntax</h5>
  126. <div class="codewrapper">
  127. <pre><code class="lang-csharp hljs">public sealed class EnumConverter&lt;T&gt; : ValueConverter&lt;T&gt;, IValueConverter where T : Enum</code></pre>
  128. </div>
  129. <h5 class="typeParameters">Type Parameters</h5>
  130. <table class="table table-bordered table-striped table-condensed">
  131. <thead>
  132. <tr>
  133. <th>Name</th>
  134. <th>Description</th>
  135. </tr>
  136. </thead>
  137. <tbody>
  138. <tr>
  139. <td><span class="parametername">T</span></td>
  140. <td><p>the enum type</p>
  141. </td>
  142. </tr>
  143. </tbody>
  144. </table>
  145. <h3 id="methods">Methods
  146. </h3>
  147. <span class="small pull-right mobile-hide">
  148. <span class="divider">|</span>
  149. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_EnumConverter_1_FromValue_IPA_Config_Data_Value_System_Object_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.EnumConverter%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>
  150. </span>
  151. <span class="small pull-right mobile-hide">
  152. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/529e8de4640820c96cb63d772a78a2a06573f94e/IPA.Loader/Config/Stores/Converters.cs/#L195">View Source</a>
  153. </span>
  154. <a id="IPA_Config_Stores_Converters_EnumConverter_1_FromValue_" data-uid="IPA.Config.Stores.Converters.EnumConverter`1.FromValue*"></a>
  155. <h4 id="IPA_Config_Stores_Converters_EnumConverter_1_FromValue_IPA_Config_Data_Value_System_Object_" data-uid="IPA.Config.Stores.Converters.EnumConverter`1.FromValue(IPA.Config.Data.Value,System.Object)">FromValue(Value, Object)</h4>
  156. <div class="markdown level1 summary"><p>Converts a <a class="xref" href="IPA.Config.Data.Value.html">Value</a> that is a <a class="xref" href="IPA.Config.Data.Text.html">Text</a> node to the corresponding enum value.</p>
  157. </div>
  158. <div class="markdown level1 conceptual"></div>
  159. <h5 class="decalaration">Declaration</h5>
  160. <div class="codewrapper">
  161. <pre><code class="lang-csharp hljs">public override T FromValue(Value value, object parent)</code></pre>
  162. </div>
  163. <h5 class="parameters">Parameters</h5>
  164. <table class="table table-bordered table-striped table-condensed">
  165. <thead>
  166. <tr>
  167. <th>Type</th>
  168. <th>Name</th>
  169. <th>Description</th>
  170. </tr>
  171. </thead>
  172. <tbody>
  173. <tr>
  174. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  175. <td><span class="parametername">value</span></td>
  176. <td><p>the <a class="xref" href="IPA.Config.Data.Value.html">Value</a> to convert</p>
  177. </td>
  178. </tr>
  179. <tr>
  180. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
  181. <td><span class="parametername">parent</span></td>
  182. <td><p>the object which will own the created object</p>
  183. </td>
  184. </tr>
  185. </tbody>
  186. </table>
  187. <h5 class="returns">Returns</h5>
  188. <table class="table table-bordered table-striped table-condensed">
  189. <thead>
  190. <tr>
  191. <th>Type</th>
  192. <th>Description</th>
  193. </tr>
  194. </thead>
  195. <tbody>
  196. <tr>
  197. <td><span class="xref">T</span></td>
  198. <td><p>the deserialized enum value</p>
  199. </td>
  200. </tr>
  201. </tbody>
  202. </table>
  203. <h5 class="overrides">Overrides</h5>
  204. <div><span class="xref">IPA.Config.Stores.ValueConverter&lt;T&gt;.FromValue(IPA.Config.Data.Value, System.Object)</span></div>
  205. <h5 class="exceptions">Exceptions</h5>
  206. <table class="table table-bordered table-striped table-condensed">
  207. <thead>
  208. <tr>
  209. <th>Type</th>
  210. <th>Condition</th>
  211. </tr>
  212. </thead>
  213. <tbody>
  214. <tr>
  215. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
  216. <td><p>if <code data-dev-comment-type="paramref" class="paramref">value</code> is not a <a class="xref" href="IPA.Config.Data.Text.html">Text</a> node</p>
  217. </td>
  218. </tr>
  219. </tbody>
  220. </table>
  221. <span class="small pull-right mobile-hide">
  222. <span class="divider">|</span>
  223. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_EnumConverter_1_ToValue__0_System_Object_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.EnumConverter%601.ToValue(%600%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>
  224. </span>
  225. <span class="small pull-right mobile-hide">
  226. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/529e8de4640820c96cb63d772a78a2a06573f94e/IPA.Loader/Config/Stores/Converters.cs/#L206">View Source</a>
  227. </span>
  228. <a id="IPA_Config_Stores_Converters_EnumConverter_1_ToValue_" data-uid="IPA.Config.Stores.Converters.EnumConverter`1.ToValue*"></a>
  229. <h4 id="IPA_Config_Stores_Converters_EnumConverter_1_ToValue__0_System_Object_" data-uid="IPA.Config.Stores.Converters.EnumConverter`1.ToValue(`0,System.Object)">ToValue(T, Object)</h4>
  230. <div class="markdown level1 summary"><p>Converts an enum of type <code data-dev-comment-type="typeparamref" class="typeparamref">T</code> to a <a class="xref" href="IPA.Config.Data.Value.html">Value</a> node corresponding to its value.</p>
  231. </div>
  232. <div class="markdown level1 conceptual"></div>
  233. <h5 class="decalaration">Declaration</h5>
  234. <div class="codewrapper">
  235. <pre><code class="lang-csharp hljs">public override Value ToValue(T obj, object parent)</code></pre>
  236. </div>
  237. <h5 class="parameters">Parameters</h5>
  238. <table class="table table-bordered table-striped table-condensed">
  239. <thead>
  240. <tr>
  241. <th>Type</th>
  242. <th>Name</th>
  243. <th>Description</th>
  244. </tr>
  245. </thead>
  246. <tbody>
  247. <tr>
  248. <td><span class="xref">T</span></td>
  249. <td><span class="parametername">obj</span></td>
  250. <td><p>the value to serialize</p>
  251. </td>
  252. </tr>
  253. <tr>
  254. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></td>
  255. <td><span class="parametername">parent</span></td>
  256. <td><p>the object which owns <code data-dev-comment-type="paramref" class="paramref">obj</code></p>
  257. </td>
  258. </tr>
  259. </tbody>
  260. </table>
  261. <h5 class="returns">Returns</h5>
  262. <table class="table table-bordered table-striped table-condensed">
  263. <thead>
  264. <tr>
  265. <th>Type</th>
  266. <th>Description</th>
  267. </tr>
  268. </thead>
  269. <tbody>
  270. <tr>
  271. <td><a class="xref" href="IPA.Config.Data.Value.html">Value</a></td>
  272. <td><p>a <a class="xref" href="IPA.Config.Data.Text.html">Text</a> node representing <code data-dev-comment-type="paramref" class="paramref">obj</code></p>
  273. </td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <h5 class="overrides">Overrides</h5>
  278. <div><span class="xref">IPA.Config.Stores.ValueConverter&lt;T&gt;.ToValue(T, System.Object)</span></div>
  279. <h3 id="implements">Implements</h3>
  280. <div>
  281. <a class="xref" href="IPA.Config.Stores.IValueConverter.html">IValueConverter</a>
  282. </div>
  283. <h3 id="extensionmethods">Extension Methods</h3>
  284. <div>
  285. <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>
  286. </div>
  287. <div>
  288. <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>
  289. </div>
  290. <div>
  291. <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>
  292. </div>
  293. <div>
  294. <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>
  295. </div>
  296. <div>
  297. <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>
  298. </div>
  299. </article>
  300. </div>
  301. <div class="hidden-sm col-md-2" role="complementary">
  302. <div class="sideaffix">
  303. <div class="contribution">
  304. <ul class="nav">
  305. <li>
  306. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Converters_EnumConverter_1.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Converters.EnumConverter%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>
  307. </li>
  308. <li>
  309. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/529e8de4640820c96cb63d772a78a2a06573f94e/IPA.Loader/Config/Stores/Converters.cs/#L185" class="contribution-link">View Source</a>
  310. </li>
  311. </ul>
  312. </div>
  313. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  314. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  315. </nav>
  316. </div>
  317. </div>
  318. </div>
  319. </div>
  320. <footer>
  321. <div class="grad-bottom"></div>
  322. <div class="footer">
  323. <div class="container">
  324. <span class="pull-right">
  325. <a href="#top">Back to top</a>
  326. </span>
  327. <span>Generated by <strong>DocFX</strong></span>
  328. </div>
  329. </div>
  330. </footer>
  331. </div>
  332. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  333. <script type="text/javascript" src="../styles/docfx.js"></script>
  334. <script type="text/javascript" src="../styles/main.js"></script>
  335. </body>
  336. </html>