View source for CurrentQuoted (StringTokenizer function)

<span style="font-size:120%; color:black"><b>Is current token a quoted token?</b></span>
[[Category:StringTokenizer methods|CurrentQuoted function]]
<!--DPL?? Category:StringTokenizer methods|CurrentQuoted function: Is current token a quoted token?-->
<!--DPL?? Category:System methods|CurrentQuoted (StringTokenizer function): Is current token a quoted token?-->
<p>
CurrentQuoted is a member of the [[StringTokenizer class]].
</p>

This method returns a Boolean value that indicates whether
the current token is a quoted token.
A quoted token contains all the characters between a pair of identical
quotation characters.

The CurrentQuoted value is <tt>True</tt> if the current token is quoted;
otherwise it is <tt>False</tt>.
===Syntax===
   %bool = %tok:CurrentQuoted
===Syntax terms===
<dl>
<dt><i>%bool</i>
<dd>An enumeration object of type Boolean to contain the returned value
of CurrentQuoted.

For more information about Boolean enumerations, see [[Using Boolean enumerations]].
<dt><i>%tok</i>
<dd>A StringTokenizer object variable.

</dl>
===Usage Notes===
<ul>
<li>The Quotes characters are initially settable in the [[New (StringTokenizer constructor)|New]]) call that creates the tokenizer instance.
<li>A quotation character may participate in only one quoted region.
The first quotation character from the beginning of the tokenization string is
paired with the following identical quotation character in the string.
An unpaired quotation character causes a request cancellation.
<li>A quoted region is not affected by the [[TokensToLower (StringTokenizer property)|TokensToLower]]
and [[TokensToUpper (StringTokenizer property)|TokensToUpper]] properties.
<li>The [[RemoveQuotes (StringTokenizer property)|RemoveQuotes]] property controls whether
quotes are removed from the returned values of quoted tokens.
</ul>

===Examples===

In the following request fragment, the selection of a quoted token
is verified by a CurrentQuoted call:
<pre>
    %tok = new(quotes='"')
    %tok:string = 'simple "quoted tokens" example'
    PrintText {~} is {%tok:nextToken}
    PrintText {~} is {%tok:nextToken}
    PrintText {~} is {%tok:currentToken}
    PrintText {~} is {%tok:currentQuoted}
</pre>

The result is:
<pre>
    %tok:nextToken is simple
    %tok:nextToken is quoted tokens
    %tok:currentToken is quoted tokens
    %tok:currentQuoted is True
</pre>
'''Note:'''
Using the PrintText statement is described in [[Targeted Text statements|PrintText]].
Using PrintText to print an enumeration value is described in the first &ldquo;Note&rdquo;
in [[??]] refid=crenums..