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.

327 lines
16 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 Text
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Text
  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.Data.Text">
  75. <h1 id="IPA_Config_Data_Text" data-uid="IPA.Config.Data.Text" class="text-break">Class Text
  76. </h1>
  77. <div class="markdown level0 summary"><p>A <a class="xref" href="IPA.Config.Data.Text.html#IPA_Config_Data_Text_Value">Value</a> representing a piece of text. The only reason this is not named
  78. String is so that it doesn&apos;t conflict with <see cref="!:System.String"></see>.</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"><a class="xref" href="IPA.Config.Data.Value.html">Value</a></div>
  85. <div class="level2"><span class="xref">Text</span></div>
  86. </div>
  87. <div class="inheritedMembers">
  88. <h5>Inherited Members</h5>
  89. <div>
  90. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Null">Value.Null()</a>
  91. </div>
  92. <div>
  93. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_List">Value.List()</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Map">Value.Map()</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Nullable_System_String__">Value.From(Nullable&lt;String&gt;)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Text_System_Nullable_System_String__">Value.Text(Nullable&lt;String&gt;)</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Int64_">Value.From(Int64)</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Integer_System_Int64_">Value.Integer(Int64)</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Decimal_">Value.From(Decimal)</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Float_System_Decimal_">Value.Float(Decimal)</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Boolean_">Value.From(Boolean)</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Bool_System_Boolean_">Value.Bool(Boolean)</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Nullable_IEnumerable_IPA_Config_Data_Value___">Value.From(Nullable&lt;IEnumerable&lt;Value&gt;&gt;)</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_IDictionary_System_String_IPA_Config_Data_Value__">Value.From(IDictionary&lt;String, Value&gt;)</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Nullable_IEnumerable_KeyValuePair_System_String_IPA_Config_Data_Value____">Value.From(Nullable&lt;IEnumerable&lt;KeyValuePair&lt;String, Value&gt;&gt;&gt;)</a>
  130. </div>
  131. </div>
  132. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Data.html">IPA.Config.Data</a></h6>
  133. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  134. <h5 id="IPA_Config_Data_Text_syntax">Syntax</h5>
  135. <div class="codewrapper">
  136. <pre><code class="lang-csharp hljs">public sealed class Text : Value</code></pre>
  137. </div>
  138. <h3 id="constructors">Constructors
  139. </h3>
  140. <span class="small pull-right mobile-hide">
  141. <span class="divider">|</span>
  142. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Text__ctor.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Text.%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>
  143. </span>
  144. <span class="small pull-right mobile-hide">
  145. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Primitives.cs/#L19">View Source</a>
  146. </span>
  147. <a id="IPA_Config_Data_Text__ctor_" data-uid="IPA.Config.Data.Text.#ctor*"></a>
  148. <h4 id="IPA_Config_Data_Text__ctor" data-uid="IPA.Config.Data.Text.#ctor">Text()</h4>
  149. <div class="markdown level1 summary"><p>Constructs an empty <a class="xref" href="IPA.Config.Data.Text.html">Text</a> object.</p>
  150. </div>
  151. <div class="markdown level1 conceptual"></div>
  152. <h5 class="decalaration">Declaration</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public Text()</code></pre>
  155. </div>
  156. <span class="small pull-right mobile-hide">
  157. <span class="divider">|</span>
  158. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Text__ctor_System_String_.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Text.%23ctor(System.String)%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>
  159. </span>
  160. <span class="small pull-right mobile-hide">
  161. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Primitives.cs/#L29">View Source</a>
  162. </span>
  163. <a id="IPA_Config_Data_Text__ctor_" data-uid="IPA.Config.Data.Text.#ctor*"></a>
  164. <h4 id="IPA_Config_Data_Text__ctor_System_String_" data-uid="IPA.Config.Data.Text.#ctor(System.String)">Text(String)</h4>
  165. <div class="markdown level1 summary"><p>Constructs a <a class="xref" href="IPA.Config.Data.Text.html">Text</a> object containing the provided value.</p>
  166. </div>
  167. <div class="markdown level1 conceptual"></div>
  168. <h5 class="decalaration">Declaration</h5>
  169. <div class="codewrapper">
  170. <pre><code class="lang-csharp hljs">public Text(string value)</code></pre>
  171. </div>
  172. <h5 class="parameters">Parameters</h5>
  173. <table class="table table-bordered table-striped table-condensed">
  174. <thead>
  175. <tr>
  176. <th>Type</th>
  177. <th>Name</th>
  178. <th>Description</th>
  179. </tr>
  180. </thead>
  181. <tbody>
  182. <tr>
  183. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  184. <td><span class="parametername">value</span></td>
  185. <td><p>The value to construct with.</p>
  186. </td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. <h3 id="properties">Properties
  191. </h3>
  192. <span class="small pull-right mobile-hide">
  193. <span class="divider">|</span>
  194. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Text_Value.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Text.Value%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>
  195. </span>
  196. <span class="small pull-right mobile-hide">
  197. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Primitives.cs/#L37">View Source</a>
  198. </span>
  199. <a id="IPA_Config_Data_Text_Value_" data-uid="IPA.Config.Data.Text.Value*"></a>
  200. <h4 id="IPA_Config_Data_Text_Value" data-uid="IPA.Config.Data.Text.Value">Value</h4>
  201. <div class="markdown level1 summary"><p>The actual value of this <a class="xref" href="IPA.Config.Data.Text.html">Text</a> object.</p>
  202. </div>
  203. <div class="markdown level1 conceptual"></div>
  204. <h5 class="decalaration">Declaration</h5>
  205. <div class="codewrapper">
  206. <pre><code class="lang-csharp hljs">public string Value { get; set; }</code></pre>
  207. </div>
  208. <h5 class="propertyValue">Property Value</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Description</th>
  214. </tr>
  215. </thead>
  216. <tbody>
  217. <tr>
  218. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  219. <td></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <h3 id="methods">Methods
  224. </h3>
  225. <span class="small pull-right mobile-hide">
  226. <span class="divider">|</span>
  227. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Text_ToString.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Text.ToString%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>
  228. </span>
  229. <span class="small pull-right mobile-hide">
  230. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Primitives.cs/#L43">View Source</a>
  231. </span>
  232. <a id="IPA_Config_Data_Text_ToString_" data-uid="IPA.Config.Data.Text.ToString*"></a>
  233. <h4 id="IPA_Config_Data_Text_ToString" data-uid="IPA.Config.Data.Text.ToString">ToString()</h4>
  234. <div class="markdown level1 summary"><p>Converts this <a class="xref" href="IPA.Config.Data.Value.html">Value</a> into a human-readable format.</p>
  235. </div>
  236. <div class="markdown level1 conceptual"></div>
  237. <h5 class="decalaration">Declaration</h5>
  238. <div class="codewrapper">
  239. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  240. </div>
  241. <h5 class="returns">Returns</h5>
  242. <table class="table table-bordered table-striped table-condensed">
  243. <thead>
  244. <tr>
  245. <th>Type</th>
  246. <th>Description</th>
  247. </tr>
  248. </thead>
  249. <tbody>
  250. <tr>
  251. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  252. <td><p>a quoted, unescaped string form of <a class="xref" href="IPA.Config.Data.Text.html#IPA_Config_Data_Text_Value">Value</a></p>
  253. </td>
  254. </tr>
  255. </tbody>
  256. </table>
  257. <h5 class="overrides">Overrides</h5>
  258. <div><a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_ToString">Value.ToString()</a></div>
  259. <h3 id="extensionmethods">Extension Methods</h3>
  260. <div>
  261. <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>
  262. </div>
  263. <div>
  264. <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>
  265. </div>
  266. <div>
  267. <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>
  268. </div>
  269. <div>
  270. <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>
  271. </div>
  272. <div>
  273. <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>
  274. </div>
  275. </article>
  276. </div>
  277. <div class="hidden-sm col-md-2" role="complementary">
  278. <div class="sideaffix">
  279. <div class="contribution">
  280. <ul class="nav">
  281. <li>
  282. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/new/master/docs/override/new?filename=IPA_Config_Data_Text.md&amp;value=---%0Auid%3A%20IPA.Config.Data.Text%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>
  283. </li>
  284. <li>
  285. <a href="https://github.com/nike4613/BeatSaber-IPA-Reloaded/blob/3fa908a557fb00196c5729237ae859a2e3804623/IPA.Loader/Config/Data/Primitives.cs/#L14" class="contribution-link">View Source</a>
  286. </li>
  287. </ul>
  288. </div>
  289. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  290. <h5>In This Article</h5>
  291. <div></div>
  292. </nav>
  293. </div>
  294. </div>
  295. </div>
  296. </div>
  297. <footer>
  298. <div class="grad-bottom"></div>
  299. <div class="footer">
  300. <div class="container">
  301. <span class="pull-right">
  302. <a href="#top">Back to top</a>
  303. </span>
  304. <span>Generated by <strong>DocFX</strong></span>
  305. </div>
  306. </div>
  307. </footer>
  308. </div>
  309. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  310. <script type="text/javascript" src="../styles/docfx.js"></script>
  311. <script type="text/javascript" src="../styles/main.js"></script>
  312. </body>
  313. </html>