TokensToLower (StringTokenizer property): Difference between revisions
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:StringTokenizer:TokensToLower subtitle}} | {{Template:StringTokenizer:TokensToLower subtitle}} | ||
This readWrite property returns or sets the Boolean value that indicates | This readWrite property returns or sets the <var>[[Boolean enumeration|Boolean]]</var> value that indicates | ||
whether to convert returned, non-quoted, tokens to all-lowercase characters. | whether to convert returned, non-quoted, tokens to all-lowercase characters. | ||
The default value for a new tokenizer is <var>False</var>. | The default value for a new tokenizer is <var>False</var>. | ||
| Line 7: | Line 7: | ||
==Syntax== | ==Syntax== | ||
{{Template:StringTokenizer:TokensToLower syntax}} | {{Template:StringTokenizer:TokensToLower syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%currentBoolean</th> | <tr><th>%currentBoolean</th> | ||
<td>A <var>Boolean</var> enumeration object to contain the returned value of <var>TokensToLower</var>. | <td>A <var>Boolean</var> enumeration object to contain the returned value of <var>TokensToLower</var>. </td></tr> | ||
<tr><th>stringTokenizer</th> | <tr><th>stringTokenizer</th> | ||
<td>A <var>StringTokenizer</var> object | <td>A <var>StringTokenizer</var> object.</td></tr> | ||
<tr><th>newBoolean</th> | <tr><th>newBoolean</th> | ||
<td>The <var>Boolean</var> value to assign to <var class="term">stringTokenizer</var>'s <var> | <td>The <var>Boolean</var> value to assign to <var class="term">stringTokenizer</var>'s <var>TokensToLower</var> property.</td></tr> | ||
</table> | </table> | ||
| Line 20: | Line 23: | ||
<ul> | <ul> | ||
<li><var>TokensToLower</var> has no effect on non-alphabetic characters. | <li><var>TokensToLower</var> has no effect on non-alphabetic characters. | ||
<li>The [[TokensToUpper (StringTokenizer property)|TokensToUpper]] property specifies or reports whether | <li>The <var>[[TokensToUpper (StringTokenizer property)|TokensToUpper]]</var> property specifies or reports whether | ||
returned tokens are to be converted to uppercase characters. | returned tokens are to be converted to uppercase characters. | ||
</ul> | </ul> | ||
==Examples== | ==Examples== | ||
In the following example, the input string's tokens are returned in sequence | |||
In the following example, | |||
the input string's tokens are returned in sequence | |||
under the default (<code>False</code>) setting of <var>TokensToLower</var>: | under the default (<code>False</code>) setting of <var>TokensToLower</var>: | ||
<p class="code">%tok is object stringtokenizer | <p class="code">%tok is object stringtokenizer | ||
| Line 43: | Line 45: | ||
</p> | </p> | ||
If < | If <code>%tok:TokensToLower = True</code> is specified for the instantiated object, | ||
the resulting tokens are: | the resulting tokens are: | ||
<p class="code">%tok:nextToken is bad,f | <p class="code">%tok:nextToken is bad,f | ||
Revision as of 01:35, 6 July 2012
Convert returned tokens to all-lowercase (StringTokenizer class)
This readWrite property returns or sets the Boolean value that indicates
whether to convert returned, non-quoted, tokens to all-lowercase characters.
The default value for a new tokenizer is False.
Syntax
%currentBoolean = stringTokenizer:TokensToLower stringTokenizer:TokensToLower = newBoolean
Syntax terms
| %currentBoolean | A Boolean enumeration object to contain the returned value of TokensToLower. |
|---|---|
| stringTokenizer | A StringTokenizer object. |
| newBoolean | The Boolean value to assign to stringTokenizer's TokensToLower property. |
Usage notes
- TokensToLower has no effect on non-alphabetic characters.
- The TokensToUpper property specifies or reports whether returned tokens are to be converted to uppercase characters.
Examples
In the following example, the input string's tokens are returned in sequence
under the default (False) setting of TokensToLower:
%tok is object stringtokenizer %tok = new %tok:string = 'Bad,F ?3mO ,7,{x Z}' repeat while not %tok:atEnd printText {~} is {%tok:nextToken} end repeat
The resulting tokens are:
%tok:nextToken is Bad,F %tok:nextToken is ?3mO %tok:nextToken is ,7,{x %tok:nextToken is Z}
If %tok:TokensToLower = True is specified for the instantiated object,
the resulting tokens are:
%tok:nextToken is bad,f %tok:nextToken is ?3mo %tok:nextToken is ,7,{x %tok:nextToken is z}