Item (Stringlist function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
 
(27 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Template:Stringlist:Item subtitle}}
{{Template:Stringlist:Item subtitle}}
This method returns the current contents of a specified Stringlist item. The Item method accepts one argument and returns a string result.
Item is a member of the [[Stringlist class]].


==Syntax==
==Syntax==
{{Template:Stringlist:Item syntax}}
{{Template:Stringlist:Item syntax}}
===Syntax terms===
===Syntax terms===
<dl>
<table class="syntaxTable">
<dt>%string
<tr><th>%string</th>
<dd>This longstring is to contain the contents of the '''%sl''' item.
<td>This longstring is to contain the contents of the <var class="term">sl</var> item. </td></tr>
<dt>%sl
<tr><th>sl</th>
<dd>A Stringlist object.
<td>A <var>Stringlist</var> object. </td></tr>
<dt>itemnum
<tr><th>itemNum</th>
<dd>The number of the item in the '''%sl''' Stringlist.  
<td>The number of the item in the <var class="term">sl</var> <var>Stringlist</var>.</td></tr>
</dl>
</table>


==Usage notes==
==Usage notes==
<ul>
<ul>
<li>All errors in Item result in request cancellation.
<li>All errors in <var>Item</var> result in request cancellation.
<li>Unlike the Item method for collections (see [[Item (ArrayList property)]]), the Item method for Stringlists is not settable. To set a new value for a Stringlist item, use the [[Replace (Stringlist function)]].
<li>Unlike the <var>[[Item (Arraylist property)|Item]]</var> method for <var>[[Collections]]</var>, the <var>Item</var> method for <var>stringlists</var> is not settable. To set a new value for a <var>stringlist</var> item, use <var>[[Replace (Stringlist function)|Replace]]</var>.</ul>
<li>The following loop uses the Item method to display the contents of a Stringlist:
 
==Examples==
<ol><li>The following loop uses the <var>Item</var> method to display the contents of a <var>Stringlist</var>:


<pre>
<p class="code">for %i from 1 to %list:count
for %i from 1 to %list:count
print %list:item(%i)
print %list:item(%i)
end for
end for
</pre>
</p>


This could be accomplished much more easily with:
This could be accomplished much more easily with:


<pre>
<p class="code">%list:print
%list:print
</p>
</pre>


<li>Under ''[[Sirius Mods]]'' Version 6.8 and later, the method name, <tt>.Item</tt>, is not necessary on a Stringlist Item reference. For example, the previous program with Item references could be written as:
<Li>Under <var class="product">Sirius Mods</var> Version 6.8 and later, the method name, <var>Item</var>, is not necessary on a <var>Stringlist</var> <var>Item</var> reference. For example, the previous program with <var>Item</var> references could be written as:


<pre>
<p class="code">for %i from 1 to %list:count
for %i from 1 to %list:count
  print %list(%i)
print %list(%i)
end for
end for
</pre>
</p></ol>


<li>Methods are available to retrieve just the first or just the last item in a Stringlist. See [[FirstItem (Stringlist function)]] and [[LastItem (Stringlist function)]].
==See also==
There are optimized methods available to retrieve just the first or just the last item in a <var>Stringlist</var>:
<ul>
<li><var>[[FirstItem (Stringlist function)|FirstItem]]</var>
<li><var>[[LastItem (Stringlist function)|LastItem]]</var>
</ul>
</ul>
 
{{Template:Stringlist:Item footer}}
[[Category:Stringlist methods|Item function]]

Latest revision as of 17:43, 1 June 2012

Retrieve value of Stringlist item (Stringlist class)


Syntax

%string = sl:Item( itemNum)

Syntax terms

%string This longstring is to contain the contents of the sl item.
sl A Stringlist object.
itemNum The number of the item in the sl Stringlist.

Usage notes

  • All errors in Item result in request cancellation.
  • Unlike the Item method for Collections, the Item method for stringlists is not settable. To set a new value for a stringlist item, use Replace.

Examples

  1. The following loop uses the Item method to display the contents of a Stringlist:

    for %i from 1 to %list:count print %list:item(%i) end for

    This could be accomplished much more easily with:

    %list:print

  2. Under Sirius Mods Version 6.8 and later, the method name, Item, is not necessary on a Stringlist Item reference. For example, the previous program with Item references could be written as:

    for %i from 1 to %list:count print %list(%i) end for

See also

There are optimized methods available to retrieve just the first or just the last item in a Stringlist: