collection.tmpl.partial 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234
  1. {{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
  2. <h1 id="{{id}}" data-uid="{{uid}}">{{>partials/title}}</h1>
  3. <div class="markdown level0 summary">{{{summary}}}</div>
  4. <div class="markdown level0 conceptual">{{{conceptual}}}</div>
  5. {{#children}}
  6. {{#children}}
  7. {{^_disableContribution}}
  8. {{#docurl}}
  9. <span class="small pull-right mobile-hide">
  10. <span class="divider">|</span>
  11. <a href="{{docurl}}">{{__global.improveThisDoc}}</a>
  12. </span>{{/docurl}}
  13. {{#sourceurl}}
  14. <span class="small pull-right mobile-hide">
  15. <a href="{{sourceurl}}">{{__global.viewSource}}</a>
  16. </span>{{/sourceurl}}
  17. {{/_disableContribution}}
  18. {{#overload}}
  19. <a id="{{id}}" data-uid="{{uid}}"></a>
  20. {{/overload}}
  21. <h4 id="{{id}}" data-uid="{{uid}}">{{name.0.value}}</h4>
  22. <div class="markdown level1 summary">{{{summary}}}</div>
  23. <div class="markdown level1 conceptual">{{{conceptual}}}</div>
  24. <h5 class="decalaration">{{__global.declaration}}</h5>
  25. {{#syntax}}
  26. <div class="codewrapper">
  27. <pre><code class="lang-{{_lang}} hljs">{{syntax.content.0.value}}</code></pre>
  28. </div>
  29. {{#parameters.0}}
  30. <h5 class="parameters">{{__global.parameters}}</h5>
  31. <table class="table table-bordered table-striped table-condensed">
  32. <thead>
  33. <tr>
  34. <th>{{__global.type}}</th>
  35. <th>{{__global.name}}</th>
  36. <th>{{__global.description}}</th>
  37. </tr>
  38. </thead>
  39. <tbody>
  40. {{/parameters.0}}
  41. {{#parameters}}
  42. <tr>
  43. <td>{{{type.specName.0.value}}}</td>
  44. <td><span class="parametername">{{{id}}}</span></td>
  45. <td>{{{description}}}</td>
  46. </tr>
  47. {{/parameters}}
  48. {{#parameters.0}}
  49. </tbody>
  50. </table>
  51. {{/parameters.0}}
  52. {{#return}}
  53. <h5 class="returns">{{__global.returns}}</h5>
  54. <table class="table table-bordered table-striped table-condensed">
  55. <thead>
  56. <tr>
  57. <th>{{__global.type}}</th>
  58. <th>{{__global.description}}</th>
  59. </tr>
  60. </thead>
  61. <tbody>
  62. <tr>
  63. <td>{{{type.specName.0.value}}}</td>
  64. <td>{{{description}}}</td>
  65. </tr>
  66. </tbody>
  67. </table>
  68. {{/return}}
  69. {{#typeParameters.0}}
  70. <h5 class="typeParameters">{{__global.typeParameters}}</h5>
  71. <table class="table table-bordered table-striped table-condensed">
  72. <thead>
  73. <tr>
  74. <th>{{__global.name}}</th>
  75. <th>{{__global.description}}</th>
  76. </tr>
  77. </thead>
  78. <tbody>
  79. {{/typeParameters.0}}
  80. {{#typeParameters}}
  81. <tr>
  82. <td><span class="parametername">{{{id}}}</span></td>
  83. <td>{{{description}}}</td>
  84. </tr>
  85. {{/typeParameters}}
  86. {{#typeParameters.0}}
  87. </tbody>
  88. </table>
  89. {{/typeParameters.0}}
  90. {{#fieldValue}}
  91. <h5 class="fieldValue">{{__global.fieldValue}}</h5>
  92. <table class="table table-bordered table-striped table-condensed">
  93. <thead>
  94. <tr>
  95. <th>{{__global.type}}</th>
  96. <th>{{__global.description}}</th>
  97. </tr>
  98. </thead>
  99. <tbody>
  100. <tr>
  101. <td>{{{type.specName.0.value}}}</td>
  102. <td>{{{description}}}</td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. {{/fieldValue}}
  107. {{#propertyValue}}
  108. <h5 class="propertyValue">{{__global.propertyValue}}</h5>
  109. <table class="table table-bordered table-striped table-condensed">
  110. <thead>
  111. <tr>
  112. <th>{{__global.type}}</th>
  113. <th>{{__global.description}}</th>
  114. </tr>
  115. </thead>
  116. <tbody>
  117. <tr>
  118. <td>{{{type.specName.0.value}}}</td>
  119. <td>{{{description}}}</td>
  120. </tr>
  121. </tbody>
  122. </table>
  123. {{/propertyValue}}
  124. {{#eventType}}
  125. <h5 class="eventType">{{__global.eventType}}</h5>
  126. <table class="table table-bordered table-striped table-condensed">
  127. <thead>
  128. <tr>
  129. <th>{{__global.type}}</th>
  130. <th>{{__global.description}}</th>
  131. </tr>
  132. </thead>
  133. <tbody>
  134. <tr>
  135. <td>{{{type.specName.0.value}}}</td>
  136. <td>{{{description}}}</td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. {{/eventType}}
  141. {{/syntax}}
  142. {{#overridden}}
  143. <h5 class="overrides">{{__global.overrides}}</h5>
  144. <div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
  145. {{/overridden}}
  146. {{#implements.0}}
  147. <h5 class="implements">{{__global.implements}}</h5>
  148. {{/implements.0}}
  149. {{#implements}}
  150. {{#definition}}
  151. <div><xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/></div>
  152. {{/definition}}
  153. {{^definition}}
  154. <div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
  155. {{/definition}}
  156. {{/implements}}
  157. {{#remarks}}
  158. <h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
  159. <div class="markdown level1 remarks">{{{remarks}}}</div>
  160. {{/remarks}}
  161. {{#example.0}}
  162. <h5 id="{{id}}_examples">{{__global.examples}}</h5>
  163. {{/example.0}}
  164. {{#example}}
  165. {{{.}}}
  166. {{/example}}
  167. {{#exceptions.0}}
  168. <h5 class="exceptions">{{__global.exceptions}}</h5>
  169. <table class="table table-bordered table-striped table-condensed">
  170. <thead>
  171. <tr>
  172. <th>{{__global.type}}</th>
  173. <th>{{__global.condition}}</th>
  174. </tr>
  175. </thead>
  176. <tbody>
  177. {{/exceptions.0}}
  178. {{#exceptions}}
  179. <tr>
  180. <td>{{{type.specName.0.value}}}</td>
  181. <td>{{{description}}}</td>
  182. </tr>
  183. {{/exceptions}}
  184. {{#exceptions.0}}
  185. </tbody>
  186. </table>
  187. {{/exceptions.0}}
  188. {{#seealso.0}}
  189. <h5 id="{{id}}_seealso">{{__global.seealso}}</h5>
  190. <div class="seealso">
  191. {{/seealso.0}}
  192. {{#seealso}}
  193. {{#isCref}}
  194. <div>{{{type.specName.0.value}}}</div>
  195. {{/isCref}}
  196. {{^isCref}}
  197. <div>{{{url}}}</div>
  198. {{/isCref}}
  199. {{/seealso}}
  200. {{#seealso.0}}
  201. </div>
  202. {{/seealso.0}}
  203. {{/children}}
  204. {{/children}}
  205. {{#extensionMethods.0}}
  206. <h3 id="extensionmethods">{{__global.extensionMethods}}</h3>
  207. {{/extensionMethods.0}}
  208. {{#extensionMethods}}
  209. <div>
  210. {{#definition}}
  211. <xref uid="{{definition}}" altProperty="fullName" displayProperty="nameWithType"/>
  212. {{/definition}}
  213. {{^definition}}
  214. <xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/>
  215. {{/definition}}
  216. </div>
  217. {{/extensionMethods}}
  218. {{#seealso.0}}
  219. <h3 id="seealso">{{__global.seealso}}</h3>
  220. <div class="seealso">
  221. {{/seealso.0}}
  222. {{#seealso}}
  223. {{#isCref}}
  224. <div>{{{type.specName.0.value}}}</div>
  225. {{/isCref}}
  226. {{^isCref}}
  227. <div>{{{url}}}</div>
  228. {{/isCref}}
  229. {{/seealso}}
  230. {{#seealso.0}}
  231. </div>
  232. {{/seealso.0}}