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.

339 lines
19 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 UseConverterAttribute
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class UseConverterAttribute
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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">Search Results for <span></span></div>
  59. <div class="sr-items">
  60. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  61. </div>
  62. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.Attributes.UseConverterAttribute">
  75. <h1 id="IPA_Config_Stores_Attributes_UseConverterAttribute" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute" class="text-break">Class UseConverterAttribute
  76. </h1>
  77. <div class="markdown level0 summary"><p>Indicates that a given field or property in an object being wrapped by <a class="xref" href="IPA.Config.Stores.GeneratedStore.html#IPA_Config_Stores_GeneratedStore_Generated__1_IPA_Config_Config_System_Boolean_">Generated&lt;T&gt;(Config, Boolean)</a>
  78. should be serialized and deserialized using the provided converter instead of the default mechanism.</p>
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object">Object</a></div>
  84. <div class="level1"><span class="xref">UseConverterAttribute</span></div>
  85. </div>
  86. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Stores.Attributes.html">IPA.Config.Stores.Attributes</a></h6>
  87. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  88. <h5 id="IPA_Config_Stores_Attributes_UseConverterAttribute_syntax">Syntax</h5>
  89. <div class="codewrapper">
  90. <pre><code class="lang-csharp hljs">public sealed class UseConverterAttribute : Attribute</code></pre>
  91. </div>
  92. <h3 id="constructors">Constructors
  93. </h3>
  94. <span class="small pull-right mobile-hide">
  95. <span class="divider">|</span>
  96. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute__ctor.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute.%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>
  97. </span>
  98. <span class="small pull-right mobile-hide">
  99. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L65">View Source</a>
  100. </span>
  101. <a id="IPA_Config_Stores_Attributes_UseConverterAttribute__ctor_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.#ctor*"></a>
  102. <h4 id="IPA_Config_Stores_Attributes_UseConverterAttribute__ctor" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.#ctor">UseConverterAttribute()</h4>
  103. <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="IPA.Config.Stores.Attributes.UseConverterAttribute.html">UseConverterAttribute</a> specifying to use the default converter type for the target member.</p>
  104. </div>
  105. <div class="markdown level1 conceptual"></div>
  106. <h5 class="decalaration">Declaration</h5>
  107. <div class="codewrapper">
  108. <pre><code class="lang-csharp hljs">public UseConverterAttribute()</code></pre>
  109. </div>
  110. <span class="small pull-right mobile-hide">
  111. <span class="divider">|</span>
  112. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute__ctor_Type_.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute.%23ctor(Type)%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>
  113. </span>
  114. <span class="small pull-right mobile-hide">
  115. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L72">View Source</a>
  116. </span>
  117. <a id="IPA_Config_Stores_Attributes_UseConverterAttribute__ctor_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.#ctor*"></a>
  118. <h4 id="IPA_Config_Stores_Attributes_UseConverterAttribute__ctor_Type_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.#ctor(Type)">UseConverterAttribute(Type)</h4>
  119. <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="IPA.Config.Stores.Attributes.UseConverterAttribute.html">UseConverterAttribute</a> with a given <a class="xref" href="IPA.Config.Stores.Attributes.UseConverterAttribute.html#IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterType">ConverterType</a>.</p>
  120. </div>
  121. <div class="markdown level1 conceptual"></div>
  122. <h5 class="decalaration">Declaration</h5>
  123. <div class="codewrapper">
  124. <pre><code class="lang-csharp hljs">public UseConverterAttribute(Type converterType)</code></pre>
  125. </div>
  126. <h5 class="parameters">Parameters</h5>
  127. <table class="table table-bordered table-striped table-condensed">
  128. <thead>
  129. <tr>
  130. <th>Type</th>
  131. <th>Name</th>
  132. <th>Description</th>
  133. </tr>
  134. </thead>
  135. <tbody>
  136. <tr>
  137. <td><span class="xref">Type</span></td>
  138. <td><span class="parametername">converterType</span></td>
  139. <td><p>the type to assign to <a class="xref" href="IPA.Config.Stores.Attributes.UseConverterAttribute.html#IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterType">ConverterType</a></p>
  140. </td>
  141. </tr>
  142. </tbody>
  143. </table>
  144. <h3 id="properties">Properties
  145. </h3>
  146. <span class="small pull-right mobile-hide">
  147. <span class="divider">|</span>
  148. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterTargetType.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute.ConverterTargetType%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>
  149. </span>
  150. <span class="small pull-right mobile-hide">
  151. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L54">View Source</a>
  152. </span>
  153. <a id="IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterTargetType_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.ConverterTargetType*"></a>
  154. <h4 id="IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterTargetType" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.ConverterTargetType">ConverterTargetType</h4>
  155. <div class="markdown level1 summary"><p>Gets the target type of the converter if it is avaliable at instantiation time, otherwise
  156. <span class="xref">null</span>.</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 Type? ConverterTargetType { get; }</code></pre>
  162. </div>
  163. <h5 class="propertyValue">Property Value</h5>
  164. <table class="table table-bordered table-striped table-condensed">
  165. <thead>
  166. <tr>
  167. <th>Type</th>
  168. <th>Description</th>
  169. </tr>
  170. </thead>
  171. <tbody>
  172. <tr>
  173. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">Type</span>&gt;</td>
  174. <td></td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <span class="small pull-right mobile-hide">
  179. <span class="divider">|</span>
  180. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterType.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute.ConverterType%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>
  181. </span>
  182. <span class="small pull-right mobile-hide">
  183. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L48">View Source</a>
  184. </span>
  185. <a id="IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterType_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.ConverterType*"></a>
  186. <h4 id="IPA_Config_Stores_Attributes_UseConverterAttribute_ConverterType" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.ConverterType">ConverterType</h4>
  187. <div class="markdown level1 summary"><p>Gets the type of the converter to use.</p>
  188. </div>
  189. <div class="markdown level1 conceptual"></div>
  190. <h5 class="decalaration">Declaration</h5>
  191. <div class="codewrapper">
  192. <pre><code class="lang-csharp hljs">public Type? ConverterType { get; }</code></pre>
  193. </div>
  194. <h5 class="propertyValue">Property Value</h5>
  195. <table class="table table-bordered table-striped table-condensed">
  196. <thead>
  197. <tr>
  198. <th>Type</th>
  199. <th>Description</th>
  200. </tr>
  201. </thead>
  202. <tbody>
  203. <tr>
  204. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.nullable-1">Nullable</a>&lt;<span class="xref">Type</span>&gt;</td>
  205. <td></td>
  206. </tr>
  207. </tbody>
  208. </table>
  209. <span class="small pull-right mobile-hide">
  210. <span class="divider">|</span>
  211. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute_IsGenericConverter.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute.IsGenericConverter%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>
  212. </span>
  213. <span class="small pull-right mobile-hide">
  214. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L59">View Source</a>
  215. </span>
  216. <a id="IPA_Config_Stores_Attributes_UseConverterAttribute_IsGenericConverter_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.IsGenericConverter*"></a>
  217. <h4 id="IPA_Config_Stores_Attributes_UseConverterAttribute_IsGenericConverter" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.IsGenericConverter">IsGenericConverter</h4>
  218. <div class="markdown level1 summary"><p>Gets whether or not this converter is a generic <a class="xref" href="IPA.Config.Stores.ValueConverter-1.html">ValueConverter&lt;T&gt;</a>.</p>
  219. </div>
  220. <div class="markdown level1 conceptual"></div>
  221. <h5 class="decalaration">Declaration</h5>
  222. <div class="codewrapper">
  223. <pre><code class="lang-csharp hljs">public bool IsGenericConverter { get; }</code></pre>
  224. </div>
  225. <h5 class="propertyValue">Property Value</h5>
  226. <table class="table table-bordered table-striped table-condensed">
  227. <thead>
  228. <tr>
  229. <th>Type</th>
  230. <th>Description</th>
  231. </tr>
  232. </thead>
  233. <tbody>
  234. <tr>
  235. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  236. <td></td>
  237. </tr>
  238. </tbody>
  239. </table>
  240. <span class="small pull-right mobile-hide">
  241. <span class="divider">|</span>
  242. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute_UseDefaultConverterForType.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute.UseDefaultConverterForType%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>
  243. </span>
  244. <span class="small pull-right mobile-hide">
  245. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L42">View Source</a>
  246. </span>
  247. <a id="IPA_Config_Stores_Attributes_UseConverterAttribute_UseDefaultConverterForType_" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.UseDefaultConverterForType*"></a>
  248. <h4 id="IPA_Config_Stores_Attributes_UseConverterAttribute_UseDefaultConverterForType" data-uid="IPA.Config.Stores.Attributes.UseConverterAttribute.UseDefaultConverterForType">UseDefaultConverterForType</h4>
  249. <div class="markdown level1 summary"><p>Gets whether or not to use the default converter for the member type instead of the specified type.</p>
  250. </div>
  251. <div class="markdown level1 conceptual"></div>
  252. <h5 class="decalaration">Declaration</h5>
  253. <div class="codewrapper">
  254. <pre><code class="lang-csharp hljs">public bool UseDefaultConverterForType { get; }</code></pre>
  255. </div>
  256. <h5 class="propertyValue">Property Value</h5>
  257. <table class="table table-bordered table-striped table-condensed">
  258. <thead>
  259. <tr>
  260. <th>Type</th>
  261. <th>Description</th>
  262. </tr>
  263. </thead>
  264. <tbody>
  265. <tr>
  266. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
  267. <td></td>
  268. </tr>
  269. </tbody>
  270. </table>
  271. <h3 id="extensionmethods">Extension Methods</h3>
  272. <div>
  273. <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>
  274. </div>
  275. <div>
  276. <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>
  277. </div>
  278. <div>
  279. <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>
  280. </div>
  281. <div>
  282. <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>
  283. </div>
  284. <div>
  285. <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>
  286. </div>
  287. </article>
  288. </div>
  289. <div class="hidden-sm col-md-2" role="complementary">
  290. <div class="sideaffix">
  291. <div class="contribution">
  292. <ul class="nav">
  293. <li>
  294. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Stores_Attributes_UseConverterAttribute.md&amp;value=---%0Auid%3A%20IPA.Config.Stores.Attributes.UseConverterAttribute%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>
  295. </li>
  296. <li>
  297. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/c326c0dc0fbb51050db23b7b892a9528f5ef3ef0/IPA.Loader/Config/Stores/Attributes.cs/#L36" class="contribution-link">View Source</a>
  298. </li>
  299. </ul>
  300. </div>
  301. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  302. <h5>In This Article</h5>
  303. <div></div>
  304. </nav>
  305. </div>
  306. </div>
  307. </div>
  308. </div>
  309. <footer>
  310. <div class="grad-bottom"></div>
  311. <div class="footer">
  312. <div class="container">
  313. <span class="pull-right">
  314. <a href="#top">Back to top</a>
  315. </span>
  316. <span>Generated by <strong>DocFX</strong></span>
  317. </div>
  318. </div>
  319. </footer>
  320. </div>
  321. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  322. <script type="text/javascript" src="../styles/docfx.js"></script>
  323. <script type="text/javascript" src="../styles/main.js"></script>
  324. </body>
  325. </html>