Interface IGetsNamedTalesValue
An object which provides its own logic for getting named values when resolving a TALES expression.
Namespace: ZptSharp.Expressions
Assembly: ZptSharp.Abstractions.dll
Syntax
public interface IGetsNamedTalesValue
Remarks
General objects are traversed using common rules defined within ZPT. However, objects implementing this interface declare that they provide their own specific logic for traversal. The TryGetValueAsync(String, CancellationToken) method will be used instead of the usual traversal rules in order to get the value of a named reference, relative to the current object.
Methods
| Improve this Doc View SourceTryGetValueAsync(String, CancellationToken)
Attempts to get a value for a named reference, relative to the current instance.
Declaration
Task<GetValueResult> TryGetValueAsync(string name, CancellationToken cancellationToken = default(CancellationToken))
Parameters
Type | Name | Description |
---|---|---|
System.String | name | The name of the value to retrieve. |
System.Threading.CancellationToken | cancellationToken | An optional cancellation token. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task<GetValueResult> | An object indicating whether a value was successfully retrieved or not, along with the retrieved value (if applicable). |