UICatalog.Scenario.ScenarioMetadata.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  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 Scenario.ScenarioMetadata
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Scenario.ScenarioMetadata
  11. ">
  12. <meta name="generator" content="docfx 2.54.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 href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="../../toc.html">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="UICatalog.Scenario.ScenarioMetadata">
  73. <h1 id="UICatalog_Scenario_ScenarioMetadata" data-uid="UICatalog.Scenario.ScenarioMetadata" class="text-break">Class Scenario.ScenarioMetadata
  74. </h1>
  75. <div class="markdown level0 summary"><p>Defines the metadata (Name and Description) for a <a class="xref" href="UICatalog.Scenario.html">Scenario</a></p>
  76. </div>
  77. <div class="markdown level0 conceptual"></div>
  78. <div class="inheritance">
  79. <h5>Inheritance</h5>
  80. <div class="level0"><span class="xref">System.Object</span></div>
  81. <div class="level1"><span class="xref">System.Attribute</span></div>
  82. <div class="level2"><span class="xref">Scenario.ScenarioMetadata</span></div>
  83. </div>
  84. <div class="inheritedMembers">
  85. <h5>Inherited Members</h5>
  86. <div>
  87. <span class="xref">System.Attribute.Equals(System.Object)</span>
  88. </div>
  89. <div>
  90. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type)</span>
  91. </div>
  92. <div>
  93. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  94. </div>
  95. <div>
  96. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type)</span>
  97. </div>
  98. <div>
  99. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  100. </div>
  101. <div>
  102. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type)</span>
  103. </div>
  104. <div>
  105. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.Module, System.Type, System.Boolean)</span>
  106. </div>
  107. <div>
  108. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type)</span>
  109. </div>
  110. <div>
  111. <span class="xref">System.Attribute.GetCustomAttribute(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  112. </div>
  113. <div>
  114. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly)</span>
  115. </div>
  116. <div>
  117. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Boolean)</span>
  118. </div>
  119. <div>
  120. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type)</span>
  121. </div>
  122. <div>
  123. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  124. </div>
  125. <div>
  126. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo)</span>
  127. </div>
  128. <div>
  129. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Boolean)</span>
  130. </div>
  131. <div>
  132. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type)</span>
  133. </div>
  134. <div>
  135. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  136. </div>
  137. <div>
  138. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module)</span>
  139. </div>
  140. <div>
  141. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Boolean)</span>
  142. </div>
  143. <div>
  144. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type)</span>
  145. </div>
  146. <div>
  147. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.Module, System.Type, System.Boolean)</span>
  148. </div>
  149. <div>
  150. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo)</span>
  151. </div>
  152. <div>
  153. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Boolean)</span>
  154. </div>
  155. <div>
  156. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type)</span>
  157. </div>
  158. <div>
  159. <span class="xref">System.Attribute.GetCustomAttributes(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  160. </div>
  161. <div>
  162. <span class="xref">System.Attribute.GetHashCode()</span>
  163. </div>
  164. <div>
  165. <span class="xref">System.Attribute.IsDefaultAttribute()</span>
  166. </div>
  167. <div>
  168. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type)</span>
  169. </div>
  170. <div>
  171. <span class="xref">System.Attribute.IsDefined(System.Reflection.Assembly, System.Type, System.Boolean)</span>
  172. </div>
  173. <div>
  174. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type)</span>
  175. </div>
  176. <div>
  177. <span class="xref">System.Attribute.IsDefined(System.Reflection.MemberInfo, System.Type, System.Boolean)</span>
  178. </div>
  179. <div>
  180. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type)</span>
  181. </div>
  182. <div>
  183. <span class="xref">System.Attribute.IsDefined(System.Reflection.Module, System.Type, System.Boolean)</span>
  184. </div>
  185. <div>
  186. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type)</span>
  187. </div>
  188. <div>
  189. <span class="xref">System.Attribute.IsDefined(System.Reflection.ParameterInfo, System.Type, System.Boolean)</span>
  190. </div>
  191. <div>
  192. <span class="xref">System.Attribute.Match(System.Object)</span>
  193. </div>
  194. <div>
  195. <span class="xref">System.Attribute.TypeId</span>
  196. </div>
  197. <div>
  198. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  199. </div>
  200. <div>
  201. <span class="xref">System.Object.GetType()</span>
  202. </div>
  203. <div>
  204. <span class="xref">System.Object.MemberwiseClone()</span>
  205. </div>
  206. <div>
  207. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  208. </div>
  209. <div>
  210. <span class="xref">System.Object.ToString()</span>
  211. </div>
  212. </div>
  213. <h6><strong>Namespace</strong>: <a class="xref" href="UICatalog.html">UICatalog</a></h6>
  214. <h6><strong>Assembly</strong>: UICatalog.dll</h6>
  215. <h5 id="UICatalog_Scenario_ScenarioMetadata_syntax">Syntax</h5>
  216. <div class="codewrapper">
  217. <pre><code class="lang-csharp hljs">[AttributeUsage(AttributeTargets.Class)]
  218. public class ScenarioMetadata : Attribute</code></pre>
  219. </div>
  220. <h3 id="constructors">Constructors
  221. </h3>
  222. <a id="UICatalog_Scenario_ScenarioMetadata__ctor_" data-uid="UICatalog.Scenario.ScenarioMetadata.#ctor*"></a>
  223. <h4 id="UICatalog_Scenario_ScenarioMetadata__ctor_System_String_System_String_" data-uid="UICatalog.Scenario.ScenarioMetadata.#ctor(System.String,System.String)">ScenarioMetadata(String, String)</h4>
  224. <div class="markdown level1 summary"></div>
  225. <div class="markdown level1 conceptual"></div>
  226. <h5 class="decalaration">Declaration</h5>
  227. <div class="codewrapper">
  228. <pre><code class="lang-csharp hljs">public ScenarioMetadata(string Name, string Description)</code></pre>
  229. </div>
  230. <h5 class="parameters">Parameters</h5>
  231. <table class="table table-bordered table-striped table-condensed">
  232. <thead>
  233. <tr>
  234. <th>Type</th>
  235. <th>Name</th>
  236. <th>Description</th>
  237. </tr>
  238. </thead>
  239. <tbody>
  240. <tr>
  241. <td><span class="xref">System.String</span></td>
  242. <td><span class="parametername">Name</span></td>
  243. <td></td>
  244. </tr>
  245. <tr>
  246. <td><span class="xref">System.String</span></td>
  247. <td><span class="parametername">Description</span></td>
  248. <td></td>
  249. </tr>
  250. </tbody>
  251. </table>
  252. <h3 id="properties">Properties
  253. </h3>
  254. <a id="UICatalog_Scenario_ScenarioMetadata_Description_" data-uid="UICatalog.Scenario.ScenarioMetadata.Description*"></a>
  255. <h4 id="UICatalog_Scenario_ScenarioMetadata_Description" data-uid="UICatalog.Scenario.ScenarioMetadata.Description">Description</h4>
  256. <div class="markdown level1 summary"><p><a class="xref" href="UICatalog.Scenario.html">Scenario</a> Description</p>
  257. </div>
  258. <div class="markdown level1 conceptual"></div>
  259. <h5 class="decalaration">Declaration</h5>
  260. <div class="codewrapper">
  261. <pre><code class="lang-csharp hljs">public string Description { get; set; }</code></pre>
  262. </div>
  263. <h5 class="propertyValue">Property Value</h5>
  264. <table class="table table-bordered table-striped table-condensed">
  265. <thead>
  266. <tr>
  267. <th>Type</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><span class="xref">System.String</span></td>
  274. <td></td>
  275. </tr>
  276. </tbody>
  277. </table>
  278. <a id="UICatalog_Scenario_ScenarioMetadata_Name_" data-uid="UICatalog.Scenario.ScenarioMetadata.Name*"></a>
  279. <h4 id="UICatalog_Scenario_ScenarioMetadata_Name" data-uid="UICatalog.Scenario.ScenarioMetadata.Name">Name</h4>
  280. <div class="markdown level1 summary"><p><a class="xref" href="UICatalog.Scenario.html">Scenario</a> Name</p>
  281. </div>
  282. <div class="markdown level1 conceptual"></div>
  283. <h5 class="decalaration">Declaration</h5>
  284. <div class="codewrapper">
  285. <pre><code class="lang-csharp hljs">public string Name { get; set; }</code></pre>
  286. </div>
  287. <h5 class="propertyValue">Property Value</h5>
  288. <table class="table table-bordered table-striped table-condensed">
  289. <thead>
  290. <tr>
  291. <th>Type</th>
  292. <th>Description</th>
  293. </tr>
  294. </thead>
  295. <tbody>
  296. <tr>
  297. <td><span class="xref">System.String</span></td>
  298. <td></td>
  299. </tr>
  300. </tbody>
  301. </table>
  302. <h3 id="methods">Methods
  303. </h3>
  304. <a id="UICatalog_Scenario_ScenarioMetadata_GetDescription_" data-uid="UICatalog.Scenario.ScenarioMetadata.GetDescription*"></a>
  305. <h4 id="UICatalog_Scenario_ScenarioMetadata_GetDescription_System_Type_" data-uid="UICatalog.Scenario.ScenarioMetadata.GetDescription(System.Type)">GetDescription(Type)</h4>
  306. <div class="markdown level1 summary"><p>Static helper function to get the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> Description given a Type</p>
  307. </div>
  308. <div class="markdown level1 conceptual"></div>
  309. <h5 class="decalaration">Declaration</h5>
  310. <div class="codewrapper">
  311. <pre><code class="lang-csharp hljs">public static string GetDescription(Type t)</code></pre>
  312. </div>
  313. <h5 class="parameters">Parameters</h5>
  314. <table class="table table-bordered table-striped table-condensed">
  315. <thead>
  316. <tr>
  317. <th>Type</th>
  318. <th>Name</th>
  319. <th>Description</th>
  320. </tr>
  321. </thead>
  322. <tbody>
  323. <tr>
  324. <td><span class="xref">System.Type</span></td>
  325. <td><span class="parametername">t</span></td>
  326. <td></td>
  327. </tr>
  328. </tbody>
  329. </table>
  330. <h5 class="returns">Returns</h5>
  331. <table class="table table-bordered table-striped table-condensed">
  332. <thead>
  333. <tr>
  334. <th>Type</th>
  335. <th>Description</th>
  336. </tr>
  337. </thead>
  338. <tbody>
  339. <tr>
  340. <td><span class="xref">System.String</span></td>
  341. <td></td>
  342. </tr>
  343. </tbody>
  344. </table>
  345. <a id="UICatalog_Scenario_ScenarioMetadata_GetName_" data-uid="UICatalog.Scenario.ScenarioMetadata.GetName*"></a>
  346. <h4 id="UICatalog_Scenario_ScenarioMetadata_GetName_System_Type_" data-uid="UICatalog.Scenario.ScenarioMetadata.GetName(System.Type)">GetName(Type)</h4>
  347. <div class="markdown level1 summary"><p>Static helper function to get the <a class="xref" href="UICatalog.Scenario.html">Scenario</a> Name given a Type</p>
  348. </div>
  349. <div class="markdown level1 conceptual"></div>
  350. <h5 class="decalaration">Declaration</h5>
  351. <div class="codewrapper">
  352. <pre><code class="lang-csharp hljs">public static string GetName(Type t)</code></pre>
  353. </div>
  354. <h5 class="parameters">Parameters</h5>
  355. <table class="table table-bordered table-striped table-condensed">
  356. <thead>
  357. <tr>
  358. <th>Type</th>
  359. <th>Name</th>
  360. <th>Description</th>
  361. </tr>
  362. </thead>
  363. <tbody>
  364. <tr>
  365. <td><span class="xref">System.Type</span></td>
  366. <td><span class="parametername">t</span></td>
  367. <td></td>
  368. </tr>
  369. </tbody>
  370. </table>
  371. <h5 class="returns">Returns</h5>
  372. <table class="table table-bordered table-striped table-condensed">
  373. <thead>
  374. <tr>
  375. <th>Type</th>
  376. <th>Description</th>
  377. </tr>
  378. </thead>
  379. <tbody>
  380. <tr>
  381. <td><span class="xref">System.String</span></td>
  382. <td></td>
  383. </tr>
  384. </tbody>
  385. </table>
  386. </article>
  387. </div>
  388. <div class="hidden-sm col-md-2" role="complementary">
  389. <div class="sideaffix">
  390. <div class="contribution">
  391. <ul class="nav">
  392. </ul>
  393. </div>
  394. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  395. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  396. </nav>
  397. </div>
  398. </div>
  399. </div>
  400. </div>
  401. <footer>
  402. <div class="grad-bottom"></div>
  403. <div class="footer">
  404. <div class="container">
  405. <span class="pull-right">
  406. <a href="#top">Back to top</a>
  407. </span>
  408. <span>Generated by <strong>DocFX</strong></span>
  409. </div>
  410. </div>
  411. </footer>
  412. </div>
  413. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  414. <script type="text/javascript" src="../../styles/docfx.js"></script>
  415. <script type="text/javascript" src="../../styles/main.js"></script>
  416. </body>
  417. </html>