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.

568 lines
26 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 MarkdownView
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MarkdownView
  11. ">
  12. <meta name="generator" content="docfx 2.48.1.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="BSIPA_ModList.UI.ViewControllers.MarkdownView">
  75. <h1 id="BSIPA_ModList_UI_ViewControllers_MarkdownView" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView" class="text-break">Class MarkdownView
  76. </h1>
  77. <div class="markdown level0 summary"><p>A UI component that renders CommonMark Markdown in-game.</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"><span class="xref">UnityEngine.Object</span></div>
  84. <div class="level2"><span class="xref">UnityEngine.Component</span></div>
  85. <div class="level3"><span class="xref">UnityEngine.Behaviour</span></div>
  86. <div class="level4"><span class="xref">UnityEngine.MonoBehaviour</span></div>
  87. <div class="level5"><span class="xref">MarkdownView</span></div>
  88. </div>
  89. <div class="inheritedMembers">
  90. <h5>Inherited Members</h5>
  91. <div>
  92. <span class="xref">UnityEngine.MonoBehaviour.IsInvoking()</span>
  93. </div>
  94. <div>
  95. <span class="xref">UnityEngine.MonoBehaviour.CancelInvoke()</span>
  96. </div>
  97. <div>
  98. <span class="xref">UnityEngine.MonoBehaviour.Invoke(System.String, System.Single)</span>
  99. </div>
  100. <div>
  101. <span class="xref">UnityEngine.MonoBehaviour.InvokeRepeating(System.String, System.Single, System.Single)</span>
  102. </div>
  103. <div>
  104. <span class="xref">UnityEngine.MonoBehaviour.CancelInvoke(System.String)</span>
  105. </div>
  106. <div>
  107. <span class="xref">UnityEngine.MonoBehaviour.IsInvoking(System.String)</span>
  108. </div>
  109. <div>
  110. <span class="xref">UnityEngine.MonoBehaviour.StartCoroutine(System.String)</span>
  111. </div>
  112. <div>
  113. <span class="xref">UnityEngine.MonoBehaviour.StartCoroutine(System.String, System.Object)</span>
  114. </div>
  115. <div>
  116. <span class="xref">UnityEngine.MonoBehaviour.StartCoroutine(System.Collections.IEnumerator)</span>
  117. </div>
  118. <div>
  119. <span class="xref">UnityEngine.MonoBehaviour.StartCoroutine_Auto(System.Collections.IEnumerator)</span>
  120. </div>
  121. <div>
  122. <span class="xref">UnityEngine.MonoBehaviour.StopCoroutine(System.Collections.IEnumerator)</span>
  123. </div>
  124. <div>
  125. <span class="xref">UnityEngine.MonoBehaviour.StopCoroutine(UnityEngine.Coroutine)</span>
  126. </div>
  127. <div>
  128. <span class="xref">UnityEngine.MonoBehaviour.StopCoroutine(System.String)</span>
  129. </div>
  130. <div>
  131. <span class="xref">UnityEngine.MonoBehaviour.StopAllCoroutines()</span>
  132. </div>
  133. <div>
  134. <span class="xref">UnityEngine.MonoBehaviour.print(System.Object)</span>
  135. </div>
  136. <div>
  137. <span class="xref">UnityEngine.MonoBehaviour.useGUILayout</span>
  138. </div>
  139. <div>
  140. <span class="xref">UnityEngine.Behaviour.enabled</span>
  141. </div>
  142. <div>
  143. <span class="xref">UnityEngine.Behaviour.isActiveAndEnabled</span>
  144. </div>
  145. <div>
  146. <span class="xref">UnityEngine.Component.GetComponent(System.Type)</span>
  147. </div>
  148. <div>
  149. <span class="xref">UnityEngine.Component.GetComponent&lt;T&gt;()</span>
  150. </div>
  151. <div>
  152. <span class="xref">UnityEngine.Component.GetComponent(System.String)</span>
  153. </div>
  154. <div>
  155. <span class="xref">UnityEngine.Component.GetComponentInChildren(System.Type, System.Boolean)</span>
  156. </div>
  157. <div>
  158. <span class="xref">UnityEngine.Component.GetComponentInChildren(System.Type)</span>
  159. </div>
  160. <div>
  161. <span class="xref">UnityEngine.Component.GetComponentInChildren&lt;T&gt;(System.Boolean)</span>
  162. </div>
  163. <div>
  164. <span class="xref">UnityEngine.Component.GetComponentInChildren&lt;T&gt;()</span>
  165. </div>
  166. <div>
  167. <span class="xref">UnityEngine.Component.GetComponentsInChildren(System.Type, System.Boolean)</span>
  168. </div>
  169. <div>
  170. <span class="xref">UnityEngine.Component.GetComponentsInChildren(System.Type)</span>
  171. </div>
  172. <div>
  173. <span class="xref">UnityEngine.Component.GetComponentsInChildren&lt;T&gt;(System.Boolean)</span>
  174. </div>
  175. <div>
  176. <span class="xref">UnityEngine.Component.GetComponentsInChildren&lt;T&gt;(System.Boolean, System.Collections.Generic.List&lt;T&gt;)</span>
  177. </div>
  178. <div>
  179. <span class="xref">UnityEngine.Component.GetComponentsInChildren&lt;T&gt;()</span>
  180. </div>
  181. <div>
  182. <span class="xref">UnityEngine.Component.GetComponentsInChildren&lt;T&gt;(System.Collections.Generic.List&lt;T&gt;)</span>
  183. </div>
  184. <div>
  185. <span class="xref">UnityEngine.Component.GetComponentInParent(System.Type)</span>
  186. </div>
  187. <div>
  188. <span class="xref">UnityEngine.Component.GetComponentInParent&lt;T&gt;()</span>
  189. </div>
  190. <div>
  191. <span class="xref">UnityEngine.Component.GetComponentsInParent(System.Type, System.Boolean)</span>
  192. </div>
  193. <div>
  194. <span class="xref">UnityEngine.Component.GetComponentsInParent(System.Type)</span>
  195. </div>
  196. <div>
  197. <span class="xref">UnityEngine.Component.GetComponentsInParent&lt;T&gt;(System.Boolean)</span>
  198. </div>
  199. <div>
  200. <span class="xref">UnityEngine.Component.GetComponentsInParent&lt;T&gt;(System.Boolean, System.Collections.Generic.List&lt;T&gt;)</span>
  201. </div>
  202. <div>
  203. <span class="xref">UnityEngine.Component.GetComponentsInParent&lt;T&gt;()</span>
  204. </div>
  205. <div>
  206. <span class="xref">UnityEngine.Component.GetComponents(System.Type)</span>
  207. </div>
  208. <div>
  209. <span class="xref">UnityEngine.Component.GetComponents(System.Type, System.Collections.Generic.List&lt;UnityEngine.Component&gt;)</span>
  210. </div>
  211. <div>
  212. <span class="xref">UnityEngine.Component.GetComponents&lt;T&gt;(System.Collections.Generic.List&lt;T&gt;)</span>
  213. </div>
  214. <div>
  215. <span class="xref">UnityEngine.Component.GetComponents&lt;T&gt;()</span>
  216. </div>
  217. <div>
  218. <span class="xref">UnityEngine.Component.CompareTag(System.String)</span>
  219. </div>
  220. <div>
  221. <span class="xref">UnityEngine.Component.SendMessageUpwards(System.String, System.Object, UnityEngine.SendMessageOptions)</span>
  222. </div>
  223. <div>
  224. <span class="xref">UnityEngine.Component.SendMessageUpwards(System.String, System.Object)</span>
  225. </div>
  226. <div>
  227. <span class="xref">UnityEngine.Component.SendMessageUpwards(System.String)</span>
  228. </div>
  229. <div>
  230. <span class="xref">UnityEngine.Component.SendMessageUpwards(System.String, UnityEngine.SendMessageOptions)</span>
  231. </div>
  232. <div>
  233. <span class="xref">UnityEngine.Component.SendMessage(System.String, System.Object)</span>
  234. </div>
  235. <div>
  236. <span class="xref">UnityEngine.Component.SendMessage(System.String)</span>
  237. </div>
  238. <div>
  239. <span class="xref">UnityEngine.Component.SendMessage(System.String, System.Object, UnityEngine.SendMessageOptions)</span>
  240. </div>
  241. <div>
  242. <span class="xref">UnityEngine.Component.SendMessage(System.String, UnityEngine.SendMessageOptions)</span>
  243. </div>
  244. <div>
  245. <span class="xref">UnityEngine.Component.BroadcastMessage(System.String, System.Object, UnityEngine.SendMessageOptions)</span>
  246. </div>
  247. <div>
  248. <span class="xref">UnityEngine.Component.BroadcastMessage(System.String, System.Object)</span>
  249. </div>
  250. <div>
  251. <span class="xref">UnityEngine.Component.BroadcastMessage(System.String)</span>
  252. </div>
  253. <div>
  254. <span class="xref">UnityEngine.Component.BroadcastMessage(System.String, UnityEngine.SendMessageOptions)</span>
  255. </div>
  256. <div>
  257. <span class="xref">UnityEngine.Component.transform</span>
  258. </div>
  259. <div>
  260. <span class="xref">UnityEngine.Component.gameObject</span>
  261. </div>
  262. <div>
  263. <span class="xref">UnityEngine.Component.tag</span>
  264. </div>
  265. <div>
  266. <span class="xref">UnityEngine.Object.GetInstanceID()</span>
  267. </div>
  268. <div>
  269. <span class="xref">UnityEngine.Object.GetHashCode()</span>
  270. </div>
  271. <div>
  272. <span class="xref">UnityEngine.Object.Equals(System.Object)</span>
  273. </div>
  274. <div>
  275. <span class="xref">UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion)</span>
  276. </div>
  277. <div>
  278. <span class="xref">UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)</span>
  279. </div>
  280. <div>
  281. <span class="xref">UnityEngine.Object.Instantiate(UnityEngine.Object)</span>
  282. </div>
  283. <div>
  284. <span class="xref">UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform)</span>
  285. </div>
  286. <div>
  287. <span class="xref">UnityEngine.Object.Instantiate(UnityEngine.Object, UnityEngine.Transform, System.Boolean)</span>
  288. </div>
  289. <div>
  290. <span class="xref">UnityEngine.Object.Instantiate&lt;T&gt;(T)</span>
  291. </div>
  292. <div>
  293. <span class="xref">UnityEngine.Object.Instantiate&lt;T&gt;(T, UnityEngine.Vector3, UnityEngine.Quaternion)</span>
  294. </div>
  295. <div>
  296. <span class="xref">UnityEngine.Object.Instantiate&lt;T&gt;(T, UnityEngine.Vector3, UnityEngine.Quaternion, UnityEngine.Transform)</span>
  297. </div>
  298. <div>
  299. <span class="xref">UnityEngine.Object.Instantiate&lt;T&gt;(T, UnityEngine.Transform)</span>
  300. </div>
  301. <div>
  302. <span class="xref">UnityEngine.Object.Instantiate&lt;T&gt;(T, UnityEngine.Transform, System.Boolean)</span>
  303. </div>
  304. <div>
  305. <span class="xref">UnityEngine.Object.Destroy(UnityEngine.Object, System.Single)</span>
  306. </div>
  307. <div>
  308. <span class="xref">UnityEngine.Object.Destroy(UnityEngine.Object)</span>
  309. </div>
  310. <div>
  311. <span class="xref">UnityEngine.Object.DestroyImmediate(UnityEngine.Object, System.Boolean)</span>
  312. </div>
  313. <div>
  314. <span class="xref">UnityEngine.Object.DestroyImmediate(UnityEngine.Object)</span>
  315. </div>
  316. <div>
  317. <span class="xref">UnityEngine.Object.FindObjectsOfType(System.Type)</span>
  318. </div>
  319. <div>
  320. <span class="xref">UnityEngine.Object.DontDestroyOnLoad(UnityEngine.Object)</span>
  321. </div>
  322. <div>
  323. <span class="xref">UnityEngine.Object.DestroyObject(UnityEngine.Object, System.Single)</span>
  324. </div>
  325. <div>
  326. <span class="xref">UnityEngine.Object.DestroyObject(UnityEngine.Object)</span>
  327. </div>
  328. <div>
  329. <span class="xref">UnityEngine.Object.FindSceneObjectsOfType(System.Type)</span>
  330. </div>
  331. <div>
  332. <span class="xref">UnityEngine.Object.FindObjectsOfTypeIncludingAssets(System.Type)</span>
  333. </div>
  334. <div>
  335. <span class="xref">UnityEngine.Object.FindObjectsOfType&lt;T&gt;()</span>
  336. </div>
  337. <div>
  338. <span class="xref">UnityEngine.Object.FindObjectOfType&lt;T&gt;()</span>
  339. </div>
  340. <div>
  341. <span class="xref">UnityEngine.Object.FindObjectsOfTypeAll(System.Type)</span>
  342. </div>
  343. <div>
  344. <span class="xref">UnityEngine.Object.FindObjectOfType(System.Type)</span>
  345. </div>
  346. <div>
  347. <span class="xref">UnityEngine.Object.ToString()</span>
  348. </div>
  349. <div>
  350. <span class="xref">UnityEngine.Object.name</span>
  351. </div>
  352. <div>
  353. <span class="xref">UnityEngine.Object.hideFlags</span>
  354. </div>
  355. <div>
  356. <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>
  357. </div>
  358. <div>
  359. <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>
  360. </div>
  361. <div>
  362. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.gettype#System_Object_GetType">Object.GetType()</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.object.memberwiseclone#System_Object_MemberwiseClone">Object.MemberwiseClone()</a>
  366. </div>
  367. </div>
  368. <h6><strong>Namespace</strong>: <a class="xref" href="BSIPA_ModList.UI.ViewControllers.html">BSIPA_ModList.UI.ViewControllers</a></h6>
  369. <h6><strong>Assembly</strong>: BSIPA-ModList.dll</h6>
  370. <h5 id="BSIPA_ModList_UI_ViewControllers_MarkdownView_syntax">Syntax</h5>
  371. <div class="codewrapper">
  372. <pre><code class="lang-csharp hljs">[RequireComponent(typeof(RectTransform))]
  373. public class MarkdownView : MonoBehaviour</code></pre>
  374. </div>
  375. <h3 id="constructors">Constructors
  376. </h3>
  377. <span class="small pull-right mobile-hide">
  378. <span class="divider">|</span>
  379. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=BSIPA_ModList_UI_ViewControllers_MarkdownView__ctor.md&amp;value=---%0Auid%3A%20BSIPA_ModList.UI.ViewControllers.MarkdownView.%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>
  380. </span>
  381. <span class="small pull-right mobile-hide">
  382. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7e4c460c005ef6f164bc6704241674f427647294/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs/#L71">View Source</a>
  383. </span>
  384. <a id="BSIPA_ModList_UI_ViewControllers_MarkdownView__ctor_" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.#ctor*"></a>
  385. <h4 id="BSIPA_ModList_UI_ViewControllers_MarkdownView__ctor" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.#ctor">MarkdownView()</h4>
  386. <div class="markdown level1 summary"><p>Creates a new <a class="xref" href="BSIPA_ModList.UI.ViewControllers.MarkdownView.html">MarkdownView</a>. Should never be called directly. Instead, use <span class="xref">UnityEngine.GameObject.AddComponent``1</span>.</p>
  387. </div>
  388. <div class="markdown level1 conceptual"></div>
  389. <h5 class="decalaration">Declaration</h5>
  390. <div class="codewrapper">
  391. <pre><code class="lang-csharp hljs">public MarkdownView()</code></pre>
  392. </div>
  393. <h3 id="fields">Fields
  394. </h3>
  395. <span class="small pull-right mobile-hide">
  396. <span class="divider">|</span>
  397. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=BSIPA_ModList_UI_ViewControllers_MarkdownView_HasEmbeddedImage.md&amp;value=---%0Auid%3A%20BSIPA_ModList.UI.ViewControllers.MarkdownView.HasEmbeddedImage%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>
  398. </span>
  399. <span class="small pull-right mobile-hide">
  400. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7e4c460c005ef6f164bc6704241674f427647294/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs/#L83">View Source</a>
  401. </span>
  402. <h4 id="BSIPA_ModList_UI_ViewControllers_MarkdownView_HasEmbeddedImage" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.HasEmbeddedImage">HasEmbeddedImage</h4>
  403. <div class="markdown level1 summary"><p>This function will be called whenever attempting to resolve an image URI, to ensure that the image exists in the embedded assembly.</p>
  404. </div>
  405. <div class="markdown level1 conceptual"></div>
  406. <h5 class="decalaration">Declaration</h5>
  407. <div class="codewrapper">
  408. <pre><code class="lang-csharp hljs">public Func&lt;string, bool&gt; HasEmbeddedImage</code></pre>
  409. </div>
  410. <h5 class="fieldValue">Field Value</h5>
  411. <table class="table table-bordered table-striped table-condensed">
  412. <thead>
  413. <tr>
  414. <th>Type</th>
  415. <th>Description</th>
  416. </tr>
  417. </thead>
  418. <tbody>
  419. <tr>
  420. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.func-2">Func</a>&lt;<a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a>, <a class="xref" href="https://docs.microsoft.com/dotnet/api/system.boolean">Boolean</a>&gt;</td>
  421. <td><p>a delegate for the function to call</p>
  422. </td>
  423. </tr>
  424. </tbody>
  425. </table>
  426. <h3 id="properties">Properties
  427. </h3>
  428. <span class="small pull-right mobile-hide">
  429. <span class="divider">|</span>
  430. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=BSIPA_ModList_UI_ViewControllers_MarkdownView_Markdown.md&amp;value=---%0Auid%3A%20BSIPA_ModList.UI.ViewControllers.MarkdownView.Markdown%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>
  431. </span>
  432. <span class="small pull-right mobile-hide">
  433. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7e4c460c005ef6f164bc6704241674f427647294/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs/#L46">View Source</a>
  434. </span>
  435. <a id="BSIPA_ModList_UI_ViewControllers_MarkdownView_Markdown_" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.Markdown*"></a>
  436. <h4 id="BSIPA_ModList_UI_ViewControllers_MarkdownView_Markdown" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.Markdown">Markdown</h4>
  437. <div class="markdown level1 summary"><p>The text to be rendered.</p>
  438. </div>
  439. <div class="markdown level1 conceptual"></div>
  440. <h5 class="decalaration">Declaration</h5>
  441. <div class="codewrapper">
  442. <pre><code class="lang-csharp hljs">public string Markdown { get; set; }</code></pre>
  443. </div>
  444. <h5 class="propertyValue">Property Value</h5>
  445. <table class="table table-bordered table-striped table-condensed">
  446. <thead>
  447. <tr>
  448. <th>Type</th>
  449. <th>Description</th>
  450. </tr>
  451. </thead>
  452. <tbody>
  453. <tr>
  454. <td><a class="xref" href="https://docs.microsoft.com/dotnet/api/system.string">String</a></td>
  455. <td><p>the text to render as Markdown</p>
  456. </td>
  457. </tr>
  458. </tbody>
  459. </table>
  460. <h5 id="BSIPA_ModList_UI_ViewControllers_MarkdownView_Markdown_remarks">Remarks</h5>
  461. <div class="markdown level1 remarks"><p>When this is assigned, the object is marked dirty. It will re-render on the next Update tick.</p>
  462. </div>
  463. <span class="small pull-right mobile-hide">
  464. <span class="divider">|</span>
  465. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=BSIPA_ModList_UI_ViewControllers_MarkdownView_rectTransform.md&amp;value=---%0Auid%3A%20BSIPA_ModList.UI.ViewControllers.MarkdownView.rectTransform%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>
  466. </span>
  467. <span class="small pull-right mobile-hide">
  468. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7e4c460c005ef6f164bc6704241674f427647294/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs/#L60">View Source</a>
  469. </span>
  470. <a id="BSIPA_ModList_UI_ViewControllers_MarkdownView_rectTransform_" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.rectTransform*"></a>
  471. <h4 id="BSIPA_ModList_UI_ViewControllers_MarkdownView_rectTransform" data-uid="BSIPA_ModList.UI.ViewControllers.MarkdownView.rectTransform">rectTransform</h4>
  472. <div class="markdown level1 summary"><p>A convenience property to access the <span class="xref">UnityEngine.RectTransform</span> on the <span class="xref">UnityEngine.GameObject</span> this is on.</p>
  473. </div>
  474. <div class="markdown level1 conceptual"></div>
  475. <h5 class="decalaration">Declaration</h5>
  476. <div class="codewrapper">
  477. <pre><code class="lang-csharp hljs">public RectTransform rectTransform { get; }</code></pre>
  478. </div>
  479. <h5 class="propertyValue">Property Value</h5>
  480. <table class="table table-bordered table-striped table-condensed">
  481. <thead>
  482. <tr>
  483. <th>Type</th>
  484. <th>Description</th>
  485. </tr>
  486. </thead>
  487. <tbody>
  488. <tr>
  489. <td><span class="xref">UnityEngine.RectTransform</span></td>
  490. <td><p>the <span class="xref">UnityEngine.RectTransform</span> associated with this component</p>
  491. </td>
  492. </tr>
  493. </tbody>
  494. </table>
  495. <h3 id="extensionmethods">Extension Methods</h3>
  496. <div>
  497. <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>
  498. </div>
  499. <div>
  500. <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>
  501. </div>
  502. <div>
  503. <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>
  504. </div>
  505. <div>
  506. <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>
  507. </div>
  508. <div>
  509. <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>
  510. </div>
  511. <div>
  512. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_CopyComponent_UnityEngine_Component_System_Type_UnityEngine_GameObject_System_Type_">ReflectionUtil.CopyComponent(Component, Type, GameObject, Type)</a>
  513. </div>
  514. <div>
  515. <a class="xref" href="IPA.Utilities.ReflectionUtil.html#IPA_Utilities_ReflectionUtil_CopyComponent__1_UnityEngine_Component_UnityEngine_GameObject_System_Type_">ReflectionUtil.CopyComponent&lt;T&gt;(Component, GameObject, Type)</a>
  516. </div>
  517. </article>
  518. </div>
  519. <div class="hidden-sm col-md-2" role="complementary">
  520. <div class="sideaffix">
  521. <div class="contribution">
  522. <ul class="nav">
  523. <li>
  524. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/new/4.0.0-beta/docs/override/new?filename=BSIPA_ModList_UI_ViewControllers_MarkdownView.md&amp;value=---%0Auid%3A%20BSIPA_ModList.UI.ViewControllers.MarkdownView%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>
  525. </li>
  526. <li>
  527. <a href="https://github.com/beat-saber-modding-group/BeatSaber-IPA-Reloaded/blob/7e4c460c005ef6f164bc6704241674f427647294/BSIPA-ModList/UI/ViewControllers/MarkdownView.cs/#L24" class="contribution-link">View Source</a>
  528. </li>
  529. </ul>
  530. </div>
  531. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  532. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  533. </nav>
  534. </div>
  535. </div>
  536. </div>
  537. </div>
  538. <footer>
  539. <div class="grad-bottom"></div>
  540. <div class="footer">
  541. <div class="container">
  542. <span class="pull-right">
  543. <a href="#top">Back to top</a>
  544. </span>
  545. <span>Generated by <strong>DocFX</strong></span>
  546. </div>
  547. </div>
  548. </footer>
  549. </div>
  550. <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
  551. <script type="text/javascript" src="../styles/docfx.js"></script>
  552. <script type="text/javascript" src="../styles/main.js"></script>
  553. </body>
  554. </html>