PageRenderTime 56ms CodeModel.GetById 27ms RepoModel.GetById 1ms app.codeStats 0ms

/docs/_vnext/api/ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.html

http://github.com/CSF-Software-Development/ZPT-Sharp
HTML | 294 lines | 278 code | 15 blank | 1 comment | 0 complexity | c1255f7b102a6969ce3d83702e608293 MD5 | raw file
    

  1. <!DOCTYPE html>
    2. 

  2. <!--[if IE]><![endif]-->
    3. 

  3. <html>
    4. 

  4.   
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8">
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    8. 

  8.     <title>Class GlobalVariablesOnlyTalesValueForExpressionContextAdapter
    9. 

  9.    </title>
    10. 

  10.     <meta name="viewport" content="width=device-width">
    11. 

  11.     <meta name="title" content="Class GlobalVariablesOnlyTalesValueForExpressionContextAdapter
    12. 

  12.    ">
    13. 

  13.     <meta name="generator" content="docfx 2.56.6.0">
    14. 

  14.     
    15. 

  15.     <link rel="shortcut icon" href="../favicon.ico">
    16. 

  16.     <link rel="stylesheet" href="../styles/docfx.vendor.css">
    17. 

  17.     <link rel="stylesheet" href="../styles/docfx.css">
    18. 

  18.     <link rel="stylesheet" href="../styles/main.css">
    19. 

  19.     <meta property="docfx:navrel" content="../toc.html">
    20. 

  20.     <meta property="docfx:tocrel" content="toc.html">
    21. 

  21.     
    22. 

  22.     
    23. 

  23.     
    24. 

  24.   </head>
    25. 

  25.   <body data-spy="scroll" data-target="#affix" data-offset="120">
    26. 

  26.     <div id="wrapper">
    27. 

  27.       <header>
    28. 

  28.         
    29. 

  29.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
    30. 

  30.           <div class="container">
    31. 

  31.             <div class="navbar-header">
    32. 

  32.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
    33. 

  33.                 <span class="sr-only">Toggle navigation</span>
    34. 

  34.                 <span class="icon-bar"></span>
    35. 

  35.                 <span class="icon-bar"></span>
    36. 

  36.                 <span class="icon-bar"></span>
    37. 

  37.               </button>
    38. 

  38.               
    39. 

  39.               <a class="navbar-brand" href="../index.html">
    40. 

  40.                 <img id="logo" class="svg" src="../logo.svg" alt="">
    41. 

  41.               </a>
    42. 

  42.             </div>
    43. 

  43.             <div class="collapse navbar-collapse" id="navbar">
    44. 

  44.               <form class="navbar-form navbar-right" role="search" id="search">
    45. 

  45.                 <div class="form-group">
    46. 

  46.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
    47. 

  47.                 </div>
    48. 

  48.               </form>
    49. 

  49.             </div>
    50. 

  50.           </div>
    51. 

  51.         </nav>
    52. 

  52.         
    53. 

  53.         <div class="subnav navbar navbar-default">
    54. 

  54.           <div class="container hide-when-search" id="breadcrumb">
    55. 

  55.             <ul class="breadcrumb">
    56. 

  56.               <li></li>
    57. 

  57.             </ul>
    58. 

  58.           </div>
    59. 

  59.         </div>
    60. 

  60.       </header>
    61. 

  61.       <div role="main" class="container body-content hide-when-search">
    62. 

  62.         
    63. 

  63.         <div class="sidenav hide-when-search">
    64. 

  64.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
    65. 

  65.           <div class="sidetoggle collapse" id="sidetoggle">
    66. 

  66.             <div id="sidetoc"></div>
    67. 

  67.           </div>
    68. 

  68.         </div>
    69. 

  69.         <div class="article row grid-right">
    70. 

  70.           <div class="col-md-10">
    71. 

  71.             <article class="content wrap" id="_content" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter">
    72. 

  72.   
    73. 

  73.   
    74. 

  74.   <h1 id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter" class="text-break">Class GlobalVariablesOnlyTalesValueForExpressionContextAdapter
    75. 

  75.   </h1>
    76. 

  76.   <div class="markdown level0 summary"><p>Implementation of <a class="xref" href="ZptSharp.Expressions.IGetsNamedTalesValue.html">IGetsNamedTalesValue</a> which exposes global variables from the
    77. 

  77. wrapped <a class="xref" href="ZptSharp.Expressions.ExpressionContext.html">ExpressionContext</a>.</p>
    78. 

  78. </div>
    79. 

  79.   <div class="markdown level0 conceptual"></div>
    80. 

  80.   <div class="inheritance">
    81. 

  81.     <h5>Inheritance</h5>
    82. 

  82.     <div class="level0"><span class="xref">System.Object</span></div>
    83. 

  83.     <div class="level1"><span class="xref">GlobalVariablesOnlyTalesValueForExpressionContextAdapter</span></div>
    84. 

  84.   </div>
    85. 

  85.   <div classs="implements">
    86. 

  86.     <h5>Implements</h5>
    87. 

  87.     <div><a class="xref" href="ZptSharp.Expressions.IGetsNamedTalesValue.html">IGetsNamedTalesValue</a></div>
    88. 

  88.   </div>
    89. 

  89.   <div class="inheritedMembers">
    90. 

  90.     <h5>Inherited Members</h5>
    91. 

  91.     <div>
    92. 

  92.       <span class="xref">System.Object.Equals(System.Object)</span>
    93. 

  93.     </div>
    94. 

  94.     <div>
    95. 

  95.       <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    96. 

  96.     </div>
    97. 

  97.     <div>
    98. 

  98.       <span class="xref">System.Object.GetHashCode()</span>
    99. 

  99.     </div>
    100. 

  100.     <div>
    101. 

  101.       <span class="xref">System.Object.GetType()</span>
    102. 

  102.     </div>
    103. 

  103.     <div>
    104. 

  104.       <span class="xref">System.Object.MemberwiseClone()</span>
    105. 

  105.     </div>
    106. 

  106.     <div>
    107. 

  107.       <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    108. 

  108.     </div>
    109. 

  109.     <div>
    110. 

  110.       <span class="xref">System.Object.ToString()</span>
    111. 

  111.     </div>
    112. 

  112.   </div>
    113. 

  113.   <h6><strong>Namespace</strong>: <a class="xref" href="ZptSharp.Expressions.html">ZptSharp.Expressions</a></h6>
    114. 

  114.   <h6><strong>Assembly</strong>: ZptSharp.dll</h6>
    115. 

  115.   <h5 id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_syntax">Syntax</h5>
    116. 

  116.   <div class="codewrapper">
    117. 

  117.     <pre><code class="lang-csharp hljs">public class GlobalVariablesOnlyTalesValueForExpressionContextAdapter : IGetsNamedTalesValue</code></pre>
    118. 

  118.   </div>
    119. 

  119.   <h3 id="constructors">Constructors
    120. 

  120.   </h3>
    121. 

  121.   <span class="small pull-right mobile-hide">
    122. 

  122.     <span class="divider">|</span>
    123. 

  123.     <a href="https://github.com/csf-dev/ZPT-Sharp/new/master/apiSpec/new?filename=ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter__ctor_ZptSharp_Expressions_ExpressionContext_.md&amp;value=---%0Auid%3A%20ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.%23ctor(ZptSharp.Expressions.ExpressionContext)%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>
    124. 

  124.   </span>
    125. 

  125.   <span class="small pull-right mobile-hide">
    126. 

  126.     <a href="https://github.com/csf-dev/ZPT-Sharp/blob/master/ZptSharp/Expressions/GlobalVariablesOnlyTalesValueForExpressionContextAdapter.cs/#L38">View Source</a>
    127. 

  127.   </span>
    128. 

  128.   <a id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter__ctor_" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.#ctor*"></a>
    129. 

  129.   <h4 id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter__ctor_ZptSharp_Expressions_ExpressionContext_" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.#ctor(ZptSharp.Expressions.ExpressionContext)">GlobalVariablesOnlyTalesValueForExpressionContextAdapter(ExpressionContext)</h4>
    130. 

  130.   <div class="markdown level1 summary"><p>Initializes a new instance of the
    131. 

  131. <a class="xref" href="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.html">GlobalVariablesOnlyTalesValueForExpressionContextAdapter</a> class.</p>
    132. 

  132. </div>
    133. 

  133.   <div class="markdown level1 conceptual"></div>
    134. 

  134.   <h5 class="decalaration">Declaration</h5>
    135. 

  135.   <div class="codewrapper">
    136. 

  136.     <pre><code class="lang-csharp hljs">public GlobalVariablesOnlyTalesValueForExpressionContextAdapter(ExpressionContext context)</code></pre>
    137. 

  137.   </div>
    138. 

  138.   <h5 class="parameters">Parameters</h5>
    139. 

  139.   <table class="table table-bordered table-striped table-condensed">
    140. 

  140.     <thead>
    141. 

  141.       <tr>
    142. 

  142.         <th>Type</th>
    143. 

  143.         <th>Name</th>
    144. 

  144.         <th>Description</th>
    145. 

  145.       </tr>
    146. 

  146.     </thead>
    147. 

  147.     <tbody>
    148. 

  148.       <tr>
    149. 

  149.         <td><a class="xref" href="ZptSharp.Expressions.ExpressionContext.html">ExpressionContext</a></td>
    150. 

  150.         <td><span class="parametername">context</span></td>
    151. 

  151.         <td><p>Context.</p>
    152. 

  152. </td>
    153. 

  153.       </tr>
    154. 

  154.     </tbody>
    155. 

  155.   </table>
    156. 

  156.   <h3 id="properties">Properties
    157. 

  157.   </h3>
    158. 

  158.   <span class="small pull-right mobile-hide">
    159. 

  159.     <span class="divider">|</span>
    160. 

  160.     <a href="https://github.com/csf-dev/ZPT-Sharp/new/master/apiSpec/new?filename=ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_Context.md&amp;value=---%0Auid%3A%20ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.Context%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. 

  161.   </span>
    162. 

  162.   <span class="small pull-right mobile-hide">
    163. 

  163.     <a href="https://github.com/csf-dev/ZPT-Sharp/blob/master/ZptSharp/Expressions/GlobalVariablesOnlyTalesValueForExpressionContextAdapter.cs/#L17">View Source</a>
    164. 

  164.   </span>
    165. 

  165.   <a id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_Context_" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.Context*"></a>
    166. 

  166.   <h4 id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_Context" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.Context">Context</h4>
    167. 

  167.   <div class="markdown level1 summary"><p>Gets the expression context wrapped by the current instance.</p>
    168. 

  168. </div>
    169. 

  169.   <div class="markdown level1 conceptual"></div>
    170. 

  170.   <h5 class="decalaration">Declaration</h5>
    171. 

  171.   <div class="codewrapper">
    172. 

  172.     <pre><code class="lang-csharp hljs">public ExpressionContext Context { get; }</code></pre>
    173. 

  173.   </div>
    174. 

  174.   <h5 class="propertyValue">Property Value</h5>
    175. 

  175.   <table class="table table-bordered table-striped table-condensed">
    176. 

  176.     <thead>
    177. 

  177.       <tr>
    178. 

  178.         <th>Type</th>
    179. 

  179.         <th>Description</th>
    180. 

  180.       </tr>
    181. 

  181.     </thead>
    182. 

  182.     <tbody>
    183. 

  183.       <tr>
    184. 

  184.         <td><a class="xref" href="ZptSharp.Expressions.ExpressionContext.html">ExpressionContext</a></td>
    185. 

  185.         <td><p>The expression context.</p>
    186. 

  186. </td>
    187. 

  187.       </tr>
    188. 

  188.     </tbody>
    189. 

  189.   </table>
    190. 

  190.   <h3 id="methods">Methods
    191. 

  191.   </h3>
    192. 

  192.   <span class="small pull-right mobile-hide">
    193. 

  193.     <span class="divider">|</span>
    194. 

  194.     <a href="https://github.com/csf-dev/ZPT-Sharp/new/master/apiSpec/new?filename=ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_TryGetValueAsync_System_String_System_Threading_CancellationToken_.md&amp;value=---%0Auid%3A%20ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.TryGetValueAsync(System.String%2CSystem.Threading.CancellationToken)%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>
    195. 

  195.   </span>
    196. 

  196.   <span class="small pull-right mobile-hide">
    197. 

  197.     <a href="https://github.com/csf-dev/ZPT-Sharp/blob/master/ZptSharp/Expressions/GlobalVariablesOnlyTalesValueForExpressionContextAdapter.cs/#L25">View Source</a>
    198. 

  198.   </span>
    199. 

  199.   <a id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_TryGetValueAsync_" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.TryGetValueAsync*"></a>
    200. 

  200.   <h4 id="ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter_TryGetValueAsync_System_String_System_Threading_CancellationToken_" data-uid="ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter.TryGetValueAsync(System.String,System.Threading.CancellationToken)">TryGetValueAsync(String, CancellationToken)</h4>
    201. 

  201.   <div class="markdown level1 summary"><p>Attempts to get a value for a named reference, relative to the current instance.</p>
    202. 

  202. </div>
    203. 

  203.   <div class="markdown level1 conceptual"></div>
    204. 

  204.   <h5 class="decalaration">Declaration</h5>
    205. 

  205.   <div class="codewrapper">
    206. 

  206.     <pre><code class="lang-csharp hljs">public Task&lt;GetValueResult&gt; TryGetValueAsync(string name, CancellationToken cancellationToken = default(CancellationToken))</code></pre>
    207. 

  207.   </div>
    208. 

  208.   <h5 class="parameters">Parameters</h5>
    209. 

  209.   <table class="table table-bordered table-striped table-condensed">
    210. 

  210.     <thead>
    211. 

  211.       <tr>
    212. 

  212.         <th>Type</th>
    213. 

  213.         <th>Name</th>
    214. 

  214.         <th>Description</th>
    215. 

  215.       </tr>
    216. 

  216.     </thead>
    217. 

  217.     <tbody>
    218. 

  218.       <tr>
    219. 

  219.         <td><span class="xref">System.String</span></td>
    220. 

  220.         <td><span class="parametername">name</span></td>
    221. 

  221.         <td><p>The name of the value to retrieve.</p>
    222. 

  222. </td>
    223. 

  223.       </tr>
    224. 

  224.       <tr>
    225. 

  225.         <td><span class="xref">System.Threading.CancellationToken</span></td>
    226. 

  226.         <td><span class="parametername">cancellationToken</span></td>
    227. 

  227.         <td><p>An optional cancellation token.</p>
    228. 

  228. </td>
    229. 

  229.       </tr>
    230. 

  230.     </tbody>
    231. 

  231.   </table>
    232. 

  232.   <h5 class="returns">Returns</h5>
    233. 

  233.   <table class="table table-bordered table-striped table-condensed">
    234. 

  234.     <thead>
    235. 

  235.       <tr>
    236. 

  236.         <th>Type</th>
    237. 

  237.         <th>Description</th>
    238. 

  238.       </tr>
    239. 

  239.     </thead>
    240. 

  240.     <tbody>
    241. 

  241.       <tr>
    242. 

  242.         <td><span class="xref">System.Threading.Tasks.Task</span>&lt;<a class="xref" href="ZptSharp.Expressions.GetValueResult.html">GetValueResult</a>&gt;</td>
    243. 

  243.         <td><p>An object indicating whether a value was successfully retrieved or not, along with the retrieved value (if applicable).</p>
    244. 

  244. </td>
    245. 

  245.       </tr>
    246. 

  246.     </tbody>
    247. 

  247.   </table>
    248. 

  248.   <h3 id="implements">Implements</h3>
    249. 

  249.   <div>
    250. 

  250.       <a class="xref" href="ZptSharp.Expressions.IGetsNamedTalesValue.html">IGetsNamedTalesValue</a>
    251. 

  251.   </div>
    252. 

  252. </article>
    253. 

  253.           </div>
    254. 

  254.           
    255. 

  255.           <div class="hidden-sm col-md-2" role="complementary">
    256. 

  256.             <div class="sideaffix">
    257. 

  257.               <div class="contribution">
    258. 

  258.                 <ul class="nav">
    259. 

  259.                   <li>
    260. 

  260.                     <a href="https://github.com/csf-dev/ZPT-Sharp/new/master/apiSpec/new?filename=ZptSharp_Expressions_GlobalVariablesOnlyTalesValueForExpressionContextAdapter.md&amp;value=---%0Auid%3A%20ZptSharp.Expressions.GlobalVariablesOnlyTalesValueForExpressionContextAdapter%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>
    261. 

  261.                   </li>
    262. 

  262.                   <li>
    263. 

  263.                     <a href="https://github.com/csf-dev/ZPT-Sharp/blob/master/ZptSharp/Expressions/GlobalVariablesOnlyTalesValueForExpressionContextAdapter.cs/#L11" class="contribution-link">View Source</a>
    264. 

  264.                   </li>
    265. 

  265.                 </ul>
    266. 

  266.               </div>
    267. 

  267.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
    268. 

  268.                 <h5>In This Article</h5>
    269. 

  269.                 <div></div>
    270. 

  270.               </nav>
    271. 

  271.             </div>
    272. 

  272.           </div>
    273. 

  273.         </div>
    274. 

  274.       </div>
    275. 

  275.       
    276. 

  276.       <footer>
    277. 

  277.         <div class="grad-bottom"></div>
    278. 

  278.         <div class="footer">
    279. 

  279.           <div class="container">
    280. 

  280.             <span class="pull-right">
    281. 

  281.               <a href="#top">Back to top</a>
    282. 

  282.             </span>
    283. 

  283.             
    284. 

  284.             <span>Generated by <strong>DocFX</strong></span>
    285. 

  285.           </div>
    286. 

  286.         </div>
    287. 

  287.       </footer>
    288. 

  288.     </div>
    289. 

  289.     
    290. 

  290.     <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    291. 

  291.     <script type="text/javascript" src="../styles/docfx.js"></script>
    292. 

  292.     <script type="text/javascript" src="../styles/main.js"></script>
    293. 

  293.   </body>
    294. 

  294. </html>
    295. 

  295.