Item (Arraylist property): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (→Usage notes) |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Arraylist:Item subtitle}} | {{Template:Arraylist:Item subtitle}} | ||
<var>Item</var> is a <var>ReadWrite</var> property that 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}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th | <tr><th>%currentItem</th> | ||
<td>A variable of the same type as specified on the | <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.</td></tr> | ||
<tr><th | <tr><th>al</th> | ||
<td>An <var>Arraylist</var> object. </td></tr> | <td>An <var>Arraylist</var> object. </td></tr> | ||
<tr><th | <tr><th>number</th> | ||
<td>A whole number greater than 0 to identify an | <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> | ||
<tr><th>newItem</th> | |||
<td>A 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> | |||
</table> | </table> | ||
==Usage notes== | ==Usage notes== | ||
<ul> | <ul> | ||
<li>The < | <li>The <code><var>Item</var></code> keyword is not required. For instance, in the <var>For</var> loop in the [[Arraylist class]] example, <code>print %alist(%i)</code> is equivalent to: | ||
For instance, in the For loop in the | |||
[[Arraylist class]] example, < | |||
<p class="code">print %alist:<var>Item</var>(%i) | <p class="code">print %alist:<var>Item</var>(%i) | ||
</p> | </p> | ||
<li> | <li>Explicitly references to retrieve or set just the first or last item in an <var>Arraylist</var> can be done via <var>[[FirstItem (Arraylist property)|FirstItem]]</var> or <var>[[LastItem (Arraylist property)|LastItem]]</var> respectively.</ul> | ||
an <var>Arraylist</var> | |||
</ul> | |||
==See also== | ==See also== | ||
{{Template:Arraylist:Item footer}} | {{Template:Arraylist:Item footer}} | ||
Latest revision as of 15:44, 1 November 2012
Return or set Arraylist item value (Arraylist class)
Item is a ReadWrite property that 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
| %currentItem | A variable of the same type as specified on the al declaration to contain the value of 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. |
| newItem | A value of the same type as specified on the al declaration to be assigned to the specified al item. |
Usage notes
- The
Itemkeyword is not required. For instance, in the For loop in the Arraylist class example,print %alist(%i)is equivalent to:print %alist:Item(%i)
- Explicitly references to retrieve or set just the first or last item in an Arraylist can be done via FirstItem or LastItem respectively.