UnicodeRight (Unicode function) - Revision history

JAL at 17:40, 6 November 2012

2012-11-06T17:40:04Z

← Older revision		Revision as of 17:40, 6 November 2012
Line 4:		Line 4:
	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeRight syntax}}		{{Template:Unicode:UnicodeRight syntax}}

	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%outUnicode</th>		<tr><th>%outUnicode</th>
	<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeRight</var> method. </td></tr>		<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeRight</var> method. </td></tr>

	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>

	<tr><th>number</th>		<tr><th>number</th>
	<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>		<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>

	<tr><th><var>Pad</var></th>		<tr><th><var>Pad</var></th>
	<td>Specifies the character used to pad the method object string, on the left, if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<~~code~~><nowiki>''</nowiki></~~code~~>), which means no padding is done. <var>Pad</var> is a ~~<var>~~[[~~Methods~~#Named parameters\|~~NameRequired~~]]~~</var>~~ parameter.</td></tr>		<td>Specifies the character used to pad the method object string, on the left, if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<tt><nowiki>''</nowiki></tt>), which means no padding is done. <var>Pad</var> is a [[Notation conventions for methods#Named parameters\|name required]] parameter.</td></tr>
	</table>		</table>

Line 19:		Line 23:
	<ul>		<ul>
	<li>The output length specified in <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.		<li>The output length specified in <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.
	<li>The <var ~~class="term"~~>~~pad~~</var> parameter value must be either null or a single character. A longer value results in a compilation error.		<li>The <var>Pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.		<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.
	<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods~~\|Sirius Mods]]~~</var> Version 7.5.		<li><var>UnicodeRight</var> function is available as of <var class="product">Sirius Mods</var> Version 7.5.
	</ul>		</ul>

	==Examples==		==Examples==
	<ol><li>		<ol>
	The following statement places the right-most 5 characters of %x into %y. If %x is shorter than 6 characters, ~~then~~ all of %x is copied into %y:		<li>The following statement places the right-most 5 characters of <code>%x</code> into <code>%y</code>. If <code>%x</code> is shorter than 6 characters, all of <code>%x</code> is copied into <code>%y</code>:
	<p class="code">%y = %x:unicodeRight(5)		<p class="code">%y = %x:unicodeRight(5)
	</p>		</p>
	<li>The following request right-aligns a text string and a number, padding each on the left with a different character. This example also shows that the argument for the method's Pad parameter may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>).
			<li>The following request right-aligns a text string and a number, padding each on the left with a different character. This example also shows that the argument for the method's <var>Pad</var> parameter may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>).
	<p class="code">begin		<p class="code">begin
	%u2 unicode initial('inaugural')		%u2 unicode initial('inaugural')
Line 44:		Line 49:

	==See also==		==See also==
	<ul><li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.		<ul>
			<li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.
	</ul>		</ul>

	{{Template:Unicode:UnicodeRight footer}}		{{Template:Unicode:UnicodeRight footer}}

JALWiccan: 1 revision

2012-11-06T17:32:26Z

1 revision

← Older revision	Revision as of 17:32, 6 November 2012
(No difference)

JALWiccan: 1 revision

2012-11-06T17:32:25Z

1 revision

← Older revision		Revision as of 17:32, 6 November 2012
Line 35:		Line 35:
	%len is float		%len is float
	[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}		[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}
	printText {123:unicodeRight(10, pad='&~~amp;amp;~~amp;#x40;':[[U (String function)\|U]])}		printText {123:unicodeRight(10, pad='&#x40;':[[U (String function)\|U]])}
	end		end
	</p>		</p>

JALWiccan: 1 revision

2011-05-04T17:46:37Z

1 revision

← Older revision	Revision as of 17:46, 4 May 2011
(No difference)

JALWiccan: 1 revision

2011-05-04T17:46:35Z

1 revision

← Older revision		Revision as of 17:46, 4 May 2011
Line 21:		Line 21:
	<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.		<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.
	<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.		<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods\|Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

Line 35:		Line 35:
	%len is float		%len is float
	[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}		[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}
	printText {123:unicodeRight(10, pad='&amp;#x40;':[[U (String function)\|U]])}		printText {123:unicodeRight(10, pad='&amp;amp;#x40;':[[U (String function)\|U]])}
	end		end
	</p>		</p>

JALWiccan: 1 revision

2011-04-13T00:55:36Z

1 revision

← Older revision	Revision as of 00:55, 13 April 2011
(No difference)

Goff: what was I thinking with those blank lines

2011-04-13T00:55:35Z

what was I thinking with those blank lines

← Older revision		Revision as of 00:55, 13 April 2011
Line 12:		Line 12:
	<tr><th>number</th>		<tr><th>number</th>
	<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>		<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>
	<tr><th>Pad</th>		<tr><th><var>Pad</var></th>
	<td>Specifies the character used to pad the method object string, on the left, if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>		<td>Specifies the character used to pad the method object string, on the left, if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>
	</table>		</table>
Line 35:		Line 35:
	%len is float		%len is float
	[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}		[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}
	printText {123:unicodeRight(10, pad='&#x40;':[[U (String function)\|U]])}		printText {123:unicodeRight(10, pad='&amp;#x40;':[[U (String function)\|U]])}
	end		end
	</p>		</p>

Goff: what was I thinking with those blank lines

2011-03-14T00:35:00Z

what was I thinking with those blank lines

← Older revision		Revision as of 00:35, 14 March 2011
Line 1:		Line 1:
	{{Template:Unicode:UnicodeRight subtitle}}		{{Template:Unicode:UnicodeRight subtitle}}
			<var>UnicodeRight</var> returns the specified number of the right-most characters of the method object string, possibly padding them on the left.
	<var>UnicodeRight</var> returns a specified number of the right-most characters of the method object string, possibly padding them on the left.

	==Syntax==		==Syntax==
Line 14:		Line 13:
	<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>		<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>
	<tr><th>Pad</th>		<tr><th>Pad</th>
	<td>Specifies the character used to pad the method object string on the left if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>		<td>Specifies the character used to pad the method object string, on the left, if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>
	</table>		</table>

Line 22:		Line 21:
	<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.		<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.		<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.
	~~<li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.~~		<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.
	<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

Line 31:		Line 29:
	<p class="code">%y = %x:unicodeRight(5)		<p class="code">%y = %x:unicodeRight(5)
	</p>		</p>

	<li>The following request right-aligns a text string and a number, padding each on the left with a different character. This example also shows that the argument for the method's Pad parameter may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>).		<li>The following request right-aligns a text string and a number, padding each on the left with a different character. This example also shows that the argument for the method's Pad parameter may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>).
	<p class="code">begin		<p class="code">begin
Line 41:		Line 38:
	end		end
	</p>		</p>

	The result is:		The result is:
	<p class="output">inaugural		<p class="output">inaugural
Line 48:		Line 44:

	==See also==		==See also==
			<ul><li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.
			</ul>
	{{Template:Unicode:UnicodeRight footer}}		{{Template:Unicode:UnicodeRight footer}}

JAL at 22:57, 28 February 2011

2011-02-28T22:57:15Z

← Older revision		Revision as of 22:57, 28 February 2011
Line 12:		Line 12:
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>
	<tr><th>number</th>		<tr><th>number</th>
	<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var ~~class="term"~~>~~pad~~</var> parameter. </td></tr>		<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var>Pad</var> parameter. </td></tr>
	<tr><th>~~pad~~</th>		<tr><th>Pad</th>
	<td>Specifies the character used to pad the method object string on the left if it is shorter than the requested length. <var ~~class="term"~~>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var ~~class="term"~~>Pad</var> is a <var>[[Methods#Named parameters\|~~Name-Required~~]]</var> parameter.</td></tr>		<td>Specifies the character used to pad the method object string on the left if it is shorter than the requested length. <var>Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var>Pad</var> is a <var>[[Methods#Named parameters\|NameRequired]]</var> parameter.</td></tr>
	</table>		</table>

Line 23:		Line 23:
	<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.		<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.
	<li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.		<li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.
	<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods~~\|"Sirius Mods"~~]]</var> Version 7.5.		<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods]]</var> Version 7.5.
	</ul>		</ul>

Goff: syntax terms and tags

2011-02-25T04:46:43Z

syntax terms and tags

← Older revision		Revision as of 04:46, 25 February 2011
Line 1:		Line 1:
	{{Template:Unicode:UnicodeRight subtitle}}		{{Template:Unicode:UnicodeRight subtitle}}

	~~This function~~ returns a specified number of the right-most characters		<var>UnicodeRight</var> returns a specified number of the right-most characters of the method object string, possibly padding them on the left.
	of the method object string, possibly padding them on the left.

	~~The <var>UnicodeRight</var> function is available as of version 7.5 of the <var class=product>Sirius Mods</var>.~~
	==Syntax==		==Syntax==
	{{Template:Unicode:UnicodeRight syntax}}		{{Template:Unicode:UnicodeRight syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~outUni~~</th>		<tr><th>%outUnicode</th>
	<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeRight</var> method. </td></tr>		<td>A <var>Unicode</var> variable to receive the result of the <var>UnicodeRight</var> method. </td></tr>
	<tr><th>unicode</th>		<tr><th>unicode</th>
	<td>A <var>Unicode</var> string. </td></tr>		<td>A <var>Unicode</var> string. </td></tr>
	<tr><th>~~length~~</th>		<tr><th>number</th>
	<td>The number of the right-most characters to return. If the method object is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the ~~Pad~~ parameter. </td></tr>		<td>The number of the right-most characters to return. If the method object, <var class="term">unicode</var>, is shorter than the requested number of characters, it is either padded to the requested length or the entire method object string is returned with no padding, depending on the value of the <var class="term">pad</var> parameter. </td></tr>
	<tr><th>~~Pad=char~~</th>		<tr><th>pad</th>
	<td>~~The~~ character used to pad the method object string on the left if it is shorter than the requested length. ~~''char''~~ defaults to a null, which means no padding is done. Pad is a ~~name~~-~~required~~ parameter.</td></tr>		<td>Specifies the character used to pad the method object string on the left if it is shorter than the requested length. <var class="term">Pad</var> defaults to the null string (<code><nowiki>''</nowiki></code>), which means no padding is done. <var class="term">Pad</var> is a <var>[[Methods#Named parameters\|Name-Required]]</var> parameter.</td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>The ''length'' value must be a non-negative number.		<li>The output length specified in <var class="term">number</var> value must be a non-negative number. A negative number results in request cancellation.
	A negative number results in request cancellation.		<li>The <var class="term">pad</var> parameter value must be either null or a single character. A longer value results in a compilation error.
	<li>The pad parameter value must be either null or a single character.		<li><var>UnicodeRight</var> can be useful for right-justifying a value in a string, most typically by using a blank as pad character.
	A longer value results in a compilation error.		<li><var>UnicodeRight</var> is analogous to the <var>String</var> intrinsic <var>[[Right (String function)\|Right]]</var> method.
	<li>~~The Right method~~ can be useful for right-justifying a value in a string,		<li><var>UnicodeRight</var> function is available as of <var class="product">[[Sirius Mods\|"Sirius Mods"]]</var> Version 7.5.
	most typically by using a blank as pad character.
	<li>~~The~~ <var>UnicodeRight</var> ~~method~~ is analogous to
	the <var>String</var> intrinsic [[Right (String function)\|Right]] method.
	</ul>		</ul>

	==Examples==		==Examples==
			<ol><li>
	The following statement places the right-most 5 characters of %x into %y.		The following statement places the right-most 5 characters of %x into %y. If %x is shorter than 6 characters, then all of %x is copied into %y:
	If %x is shorter than 6 characters, then all of %x is copied into %y:
	<p class="code">%y = %x:unicodeRight(5)		<p class="code">%y = %x:unicodeRight(5)
	</p>		</p>

	The following request right-aligns a text string and a number, padding each		<li>The following request right-aligns a text string and a number, padding each on the left with a different character. This example also shows that the argument for the method's Pad parameter may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>).
	on the left with a different character.		<p class="code">begin
	This example also shows that the argument for the method's Pad parameter		%u2 unicode initial('inaugural')
	may be a <var>Unicode</var> string (which gets converted implicitly to <var>String</var>).		%pad is string len 4
	<p class="code">~~Begin~~		%len is float
	%u2 unicode initial('inaugural')		[[PrintText statement\|printText]] {%u2:unicodeRight(10, pad=' ')}
	%pad is string len 4		printText {123:unicodeRight(10, pad='&#x40;':[[U (String function)\|U]])}
	%len is float		end
	printText {%u2:unicodeRight(10, pad=' ')}
	printText {123:unicodeRight(10, pad='&#x40;':U)}
	~~End~~
	</p>		</p>

Line 53:		Line 45:
	<p class="output">inaugural		<p class="output">inaugural
	@@@@@@@123		@@@@@@@123
	</p>		</p></ol>

	~~The U constant function used in the example is described ??[[U (String function)\|U]].~~
	~~For information about the PrintText statement, see the list~~
	~~item [[??]] refid=intprnt..~~
	==See also==		==See also==
	{{Template:Unicode:UnicodeRight footer}}		{{Template:Unicode:UnicodeRight footer}}