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.
 
 
 

233 lines
5.8 KiB

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