Item (Arraylist property): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (match syntax diagram to template and fix tags)
Line 1: Line 1:
{{Template:Arraylist:Item subtitle}}
{{Template:Arraylist:Item subtitle}}


This ReadWrite property
This ReadWrite property returns or sets the indicated item in the <var>Arraylist</var>.  For additional description of this method, see [[Collections#Coding considerations for collections|Coding considerations for collections]].
returns or sets the indicated item in the <var>Arraylist</var>.


For additional description of this method, see [[Collections#Coding considerations for collections|Coding considerations for collections]].
==Syntax==
==Syntax==
{{Template:Arraylist:Item syntax}}
{{Template:Arraylist:Item syntax}}
Line 10: Line 8:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th><i>%item</i></th>
<tr><th><i>%item</i></th>
<td>A variable of the same type as specified on the ''<var class="term">al</var>'' declaration to contain the value of the specified ''<var class="term">al</var>'' item. Or a variable or value of the same type as specified on the ''<var class="term">al</var>'' declaration to be assigned to the specified ''<var class="term">al</var>'' item. </td></tr>
<td>A variable of the same type as specified on the <var class="term">al</var> declaration to contain the value of the specified <var class="term">al</var> item. Or a variable or value of the same type as specified on the <var class="term">al</var> declaration to be assigned to the specified <var class="term">al</var> item. </td></tr>
<tr><th><i><var class="term">al</var></i></th>
<tr><th><i>al</i></th>
<td>An <var>Arraylist</var> object. </td></tr>
<td>An <var>Arraylist</var> object. </td></tr>
<tr><th><i>number</i></th>
<tr><th><i>number</i></th>
<td>A whole number greater than 0 to identify an ''<var class="term">al</var>'' item by its position in the arraylist. If ''number'' is greater than the number of items in the ''<var class="term">al</var>'', or if it is less than or equal to zero, the request is cancelled.</td></tr>
<td>A whole number greater than 0 to identify an <var class="term">al</var> item by its position within the arraylist. If <var class="term">number</var> is greater than the number of items in the <var class="term">al</var>, or if it is less than or equal to zero, the request is cancelled.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
<ul>
<ul><li>The <code><var>Item</var></code>  keyword is not required. For instance, in the For loop in the [[Arraylist class]] example, <code>print %alist(%i)</code> is equivalent to:
<li>The <tt><var>Item</var></tt>  keyword is not required.
For instance, in the For loop in the
[[Arraylist class]] example, <tt>print %alist(%i)</tt> is equivalent to:
<p class="code">print %alist:<var>Item</var>(%i)
<p class="code">print %alist:<var>Item</var>(%i)
</p>
</p>
<li>Methods are available to retrieve or seet the first or just the last item in
<li>Methods are available to retrieve or set the first or just the last item in an <var>Arraylist</var>; see [[FirstItem (Arraylist property)|FirstItem]] and [[LastItem (Arraylist property)|LastItem]] repectivly.
an <var>Arraylist</var>.
See [[FirstItem (Arraylist property)|FirstItem]] and [[LastItem (Arraylist property)|LastItem]].
</ul>
</ul>
==See also==
==See also==
{{Template:Arraylist:Item footer}}
{{Template:Arraylist:Item footer}}

Revision as of 04:53, 30 January 2011

Return or set Arraylist item value (Arraylist class)


This ReadWrite property returns or sets the indicated item in the Arraylist. For additional description of this method, see Coding considerations for collections.

Syntax

%currentItem = al:Item( number) al:Item( number) = newItem

Syntax terms

%item A variable of the same type as specified on the al declaration to contain the value of the specified al item. Or a variable or value of the same type as specified on the al declaration to be assigned to the specified al item.
al An Arraylist object.
number A whole number greater than 0 to identify an al item by its position within the arraylist. If number is greater than the number of items in the al, or if it is less than or equal to zero, the request is cancelled.

Usage notes

  • The Item keyword is not required. For instance, in the For loop in the Arraylist class example, print %alist(%i) is equivalent to:

    print %alist:Item(%i)

  • Methods are available to retrieve or set the first or just the last item in an Arraylist; see FirstItem and LastItem repectivly.

See also