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.

292 lines
14 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.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.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 <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>.</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_String_">Value.From(String)</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_Text_System_String_">Value.Text(String)</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_Collections_Generic_IEnumerable_IPA_Config_Data_Value__">Value.From(IEnumerable&lt;Value&gt;)</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_From_System_Collections_Generic_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_Collections_Generic_IEnumerable_System_Collections_Generic_KeyValuePair_System_String_IPA_Config_Data_Value___">Value.From(IEnumerable&lt;KeyValuePair&lt;String, Value&gt;&gt;)</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.equals#System_Object_Equals_System_Object_">Object.Equals(Object)</a>
  133. </div>
  134. <div>
  135. <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>
  136. </div>
  137. <div>
  138. <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>
  139. </div>
  140. <div>
  141. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gethashcode#System_Object_GetHashCode">Object.GetHashCode()</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  148. </div>
  149. </div>
  150. <h6><strong>Namespace</strong>: <a class="xref" href="IPA.Config.Data.html">IPA.Config.Data</a></h6>
  151. <h6><strong>Assembly</strong>: IPA.Loader.dll</h6>
  152. <h5 id="IPA_Config_Data_Text_syntax">Syntax</h5>
  153. <div class="codewrapper">
  154. <pre><code class="lang-csharp hljs">public sealed class Text : Value</code></pre>
  155. </div>
  156. <h3 id="properties">Properties
  157. </h3>
  158. <span class="small pull-right mobile-hide">
  159. <span class="divider">|</span>
  160. <a href="https://github.com/bsmg/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>
  161. </span>
  162. <span class="small pull-right mobile-hide">
  163. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/93bf9b3399e44577653228dc2940a948439387b3/IPA.Loader/Config/Data/Primitives.cs/#L18">View Source</a>
  164. </span>
  165. <a id="IPA_Config_Data_Text_Value_" data-uid="IPA.Config.Data.Text.Value*"></a>
  166. <h4 id="IPA_Config_Data_Text_Value" data-uid="IPA.Config.Data.Text.Value">Value</h4>
  167. <div class="markdown level1 summary"><p>The actual value of this <a class="xref" href="IPA.Config.Data.Text.html">Text</a> object.</p>
  168. </div>
  169. <div class="markdown level1 conceptual"></div>
  170. <h5 class="decalaration">Declaration</h5>
  171. <div class="codewrapper">
  172. <pre><code class="lang-csharp hljs">public string Value { get; set; }</code></pre>
  173. </div>
  174. <h5 class="propertyValue">Property Value</h5>
  175. <table class="table table-bordered table-striped table-condensed">
  176. <thead>
  177. <tr>
  178. <th>Type</th>
  179. <th>Description</th>
  180. </tr>
  181. </thead>
  182. <tbody>
  183. <tr>
  184. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  185. <td></td>
  186. </tr>
  187. </tbody>
  188. </table>
  189. <h3 id="methods">Methods
  190. </h3>
  191. <span class="small pull-right mobile-hide">
  192. <span class="divider">|</span>
  193. <a href="https://github.com/bsmg/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>
  194. </span>
  195. <span class="small pull-right mobile-hide">
  196. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/93bf9b3399e44577653228dc2940a948439387b3/IPA.Loader/Config/Data/Primitives.cs/#L24">View Source</a>
  197. </span>
  198. <a id="IPA_Config_Data_Text_ToString_" data-uid="IPA.Config.Data.Text.ToString*"></a>
  199. <h4 id="IPA_Config_Data_Text_ToString" data-uid="IPA.Config.Data.Text.ToString">ToString()</h4>
  200. <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>
  201. </div>
  202. <div class="markdown level1 conceptual"></div>
  203. <h5 class="decalaration">Declaration</h5>
  204. <div class="codewrapper">
  205. <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  206. </div>
  207. <h5 class="returns">Returns</h5>
  208. <table class="table table-bordered table-striped table-condensed">
  209. <thead>
  210. <tr>
  211. <th>Type</th>
  212. <th>Description</th>
  213. </tr>
  214. </thead>
  215. <tbody>
  216. <tr>
  217. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  218. <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>
  219. </td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <h5 class="overrides">Overrides</h5>
  224. <div><a class="xref" href="IPA.Config.Data.Value.html#IPA_Config_Data_Value_ToString">Value.ToString()</a></div>
  225. <h3 id="extensionmethods">Extension Methods</h3>
  226. <div>
  227. <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>
  228. </div>
  229. <div>
  230. <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>
  231. </div>
  232. <div>
  233. <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>
  234. </div>
  235. <div>
  236. <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>
  237. </div>
  238. <div>
  239. <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>
  240. </div>
  241. </article>
  242. </div>
  243. <div class="hidden-sm col-md-2" role="complementary">
  244. <div class="sideaffix">
  245. <div class="contribution">
  246. <ul class="nav">
  247. <li>
  248. <a href="https://github.com/bsmg/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>
  249. </li>
  250. <li>
  251. <a href="https://github.com/bsmg/BeatSaber-IPA-Reloaded/blob/93bf9b3399e44577653228dc2940a948439387b3/IPA.Loader/Config/Data/Primitives.cs/#L13" class="contribution-link">View Source</a>
  252. </li>
  253. </ul>
  254. </div>
  255. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  256. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  257. </nav>
  258. </div>
  259. </div>
  260. </div>
  261. </div>
  262. <footer>
  263. <div class="grad-bottom"></div>
  264. <div class="footer">
  265. <div class="container">
  266. <span class="pull-right">
  267. <a href="#top">Back to top</a>
  268. </span>
  269. <span>Generated by <strong>DocFX</strong></span>
  270. </div>
  271. </div>
  272. </footer>
  273. </div>
  274. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  275. <script type="text/javascript" src="../styles/docfx.js"></script>
  276. <script type="text/javascript" src="../styles/main.js"></script>
  277. </body>
  278. </html>