Item (NamedArraylist property) - Revision history

Dme at 16:41, 5 August 2012

2012-08-05T16:41:30Z

← Older revision		Revision as of 16:41, 5 August 2012
Line 59:		Line 59:
	</p>		</p>
	<li>As shown in the first of the <var>NamedArraylist</var> [[NamedArraylist class#Examples\|"Examples"]],		<li>As shown in the first of the <var>NamedArraylist</var> [[NamedArraylist class#Examples\|"Examples"]],
	<var>NamedArraylist</var> items are ordered alphabetically by their names~~. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>~~.		<var>NamedArraylist</var> items are ordered alphabetically by their names.
	</ul>		</ul>

Dme at 16:40, 5 August 2012

2012-08-05T16:40:32Z

← Older revision		Revision as of 16:40, 5 August 2012
Line 1:		Line 1:
	{{Template:NamedArraylist:Item subtitle}}		{{Template:NamedArraylist:Item subtitle}}

			<!-- This is very close to the same method's page for these classes:
			FloatNamedArraylist
			UnicodeNamedArraylist
			Many changes should be reflected to all three method's pages -->

	<var>Item</var> is a ReadWrite property which returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.		<var>Item</var> is a ReadWrite property which returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.
Line 8:		Line 13:
	{{Template:NamedArraylist:Item syntax}}		{{Template:NamedArraylist:Item syntax}}
	===Syntax terms===		===Syntax terms===

			<!-- This is very close to the same method's page for these classes:
			FloatNamedArraylist
			UnicodeNamedArraylist
			Many changes should be reflected to all three method's pages -->

	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%currentItem</th>		<tr><th>%currentItem</th>
Line 16:		Line 27:
	<td>A string that serves as a subscript to identify a <var class="term">nal</var> item.</td></tr>		<td>A string that serves as a subscript to identify a <var class="term">nal</var> item.</td></tr>
	<tr><th>newItem</th>		<tr><th>newItem</th>
	<td>A ~~variable or~~ value of the same type as specified on the <var class="term">nal</var> declaration to be assigned to the specified <var class="term">nal</var> item. </td></tr>		<td>A value of the same type as specified on the <var class="term">nal</var> declaration to be assigned to the specified <var class="term">nal</var> item. </td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==

			<!-- This is very close to the same method's page for these classes:
			FloatNamedArraylist
			UnicodeNamedArraylist
			Many changes should be reflected to all three method's pages -->

	<ul>		<ul>
	<li>If the <var>Item</var> property is being set and there is already an item on the <var>NamedArraylist</var> that has the specified name, that item is replaced. If the <var>Item</var> property is being set and there is no item on the <var>NamedArraylist</var> that has the indicated name, the item is added. If the <var>Item</var> property is being retrieved and there is no item on the <var>NamedArraylist</var> that has the ~~indicated~~ name, the result is one of the following actions:		<li>The <var>Item</var> keyword is not required. For example, in the first of the [[NamedArraylist class#Examples\|"Examples"]] on the <var>NamedArraylist</var> class page, the following statement:
			<p class="code">%alist('Idle') = 'Eric'</p>
			is equivalent to:
			<p class="code">%alist:Item('Idle') = 'Eric'
			</p>
			<li>If the <var>Item</var> property is being set and there is already an item on the <var>NamedArraylist</var> that has the specified name, that item is replaced. If the <var>Item</var> property is being set and there is no item on the <var>NamedArraylist</var> that has the indicated name, the item is added.
			<li>If the <var>Item</var> property is being retrieved and there is no item on the <var>NamedArraylist</var> that has the indicat ed name, the result is one of the following actions:
	<ul>		<ul>
	<li>If the <var>[[UseDefault (NamedArraylist property)\|UseDefault]]</var> property value is <code>False</code>:		<li>If the <var>[[UseDefault (NamedArraylist property)\|UseDefault]]</var> property value is <code>False</code>:
	<ul>		<ul>
	<li>Under <var>Sirius Mods</var> version 8.0 and later an [[ItemNotPresent class\|ItemNotPresent exception]] is thrown.		<li>Under <var>Sirius Mods</var> version 8.0 and later an <var>[[ItemNotPresent class\|ItemNotPresent exception]]</var> is thrown.
	<li>Under <var>Sirius Mods</var> version 7.9 and earlier the request is cancelled.		<li>Under <var>Sirius Mods</var> version 7.9 and earlier the request is cancelled.
	</ul>		</ul>
Line 35:		Line 58:
	...		...
	</p>		</p>
	<li>~~The <code>Item</code> keyword is not required. For example,~~ in the ~~request at the start~~ of ~~the <var>[[NamedArraylist class]]</var>, <code>%alist('Idle') = 'Eric'</code>, for instance, is equivalent to:~~		<li>As shown in the first of the <var>NamedArraylist</var> [[NamedArraylist class#Examples\|"Examples"]],
	~~<p class="code">%alist:Item('Idle') = 'Eric'~~		<var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.
	~~</p>~~
	~~<li>As shown in~~ the <var>NamedArraylist</var> [[NamedArraylist class#Examples\|"Examples"]], <var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.
	</ul>		</ul>

	==See also==		==See also==
	<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> ~~method~~ lets you retrieve or set an item using ~~its~~ item number.
			<!-- This is very close to the same method's page for these classes:
			FloatNamedArraylist
			UnicodeNamedArraylist
			Many changes should be reflected to all three method's pages -->

			<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> property lets you retrieve or set an item using the item's ordinal number.
			<li>The <var>[[NameByNumber (NamedArraylist function)\|NameByNumber]]</var> function lets you retrieve an item's name using the item's ordinal number.
			<li>The <var>[[Number (NamedArraylist function)\|Number]]</var> function lets you retrieve an item's ordinal number using the item's name; it can be useful for determining whether an item exists for a specified name.
	</ul>		</ul>
	{{Template:NamedArraylist:Item footer}}		{{Template:NamedArraylist:Item footer}}

Dme at 00:07, 4 August 2012

2012-08-04T00:07:40Z

← Older revision		Revision as of 00:07, 4 August 2012
Line 1:		Line 1:
	{{Template:NamedArraylist:Item subtitle}}		{{Template:NamedArraylist:Item subtitle}}

	<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.		<var>Item</var> is a ReadWrite property which returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.

	For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections\|"Coding considerations for collections"]].		For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections\|"Coding considerations for collections"]].

Dme at 17:40, 3 August 2012

2012-08-03T17:40:34Z

← Older revision		Revision as of 17:40, 3 August 2012
Line 1:		Line 1:
	{{Template:NamedArraylist:Item subtitle}}		{{Template:NamedArraylist:Item subtitle}}

	<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.		<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.

	For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections\|"Coding considerations for collections"]].		For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections\|"Coding considerations for collections"]].

	==Syntax==		==Syntax==
	{{Template:NamedArraylist:Item syntax}}		{{Template:NamedArraylist:Item syntax}}
Line 18:		Line 18:
	<td>A variable or value of the same type as specified on the <var class="term">nal</var> declaration to be assigned to the specified <var class="term">nal</var> item. </td></tr>		<td>A variable or value of the same type as specified on the <var class="term">nal</var> declaration to be assigned to the specified <var class="term">nal</var> item. </td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
Line 38:		Line 38:
	<p class="code">%alist:Item('Idle') = 'Eric'		<p class="code">%alist:Item('Idle') = 'Eric'
	</p>		</p>
	<li>As shown in [[NamedArraylist class#~~NamedArraylist examples~~\|"~~NamedArraylist examples~~"]], <var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.		<li>As shown in the <var>NamedArraylist</var> [[NamedArraylist class#Examples\|"Examples"]], <var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.
	</ul>		</ul>

	==See also==		==See also==
	<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> method lets you retrieve or set an item using its item number.		<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> method lets you retrieve or set an item using its item number.
	</ul>		</ul>
	{{Template:NamedArraylist:Item footer}}		{{Template:NamedArraylist:Item footer}}

Dme: /* See also */

2012-08-03T16:52:45Z

Dme: /* Usage notes */

2012-08-03T16:52:28Z

Usage notes

← Older revision		Revision as of 16:52, 3 August 2012
Line 38:		Line 38:
	<p class="code">%alist:Item('Idle') = 'Eric'		<p class="code">%alist:Item('Idle') = 'Eric'
	</p>		</p>
	<li>As shown in ~~the example at the start of the~~ [[NamedArraylist class]], <var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.		<li>As shown in [[NamedArraylist class#NamedArraylist examples\|"NamedArraylist examples"]], <var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.
	</ul>		</ul>

Alex: /* Usage notes */

2011-10-20T00:52:55Z

Usage notes

← Older revision		Revision as of 00:52, 20 October 2011
Line 23:		Line 23:
	<li>If the <var>Item</var> property is being set and there is already an item on the <var>NamedArraylist</var> that has the specified name, that item is replaced. If the <var>Item</var> property is being set and there is no item on the <var>NamedArraylist</var> that has the indicated name, the item is added. If the <var>Item</var> property is being retrieved and there is no item on the <var>NamedArraylist</var> that has the indicated name, the result is one of the following actions:		<li>If the <var>Item</var> property is being set and there is already an item on the <var>NamedArraylist</var> that has the specified name, that item is replaced. If the <var>Item</var> property is being set and there is no item on the <var>NamedArraylist</var> that has the indicated name, the item is added. If the <var>Item</var> property is being retrieved and there is no item on the <var>NamedArraylist</var> that has the indicated name, the result is one of the following actions:
	<ul>		<ul>
	<li>~~The request is cancelled if~~ the <var>[[UseDefault (NamedArraylist property)\|UseDefault]]</var> property value is <code>False</code>.		<li>If the <var>[[UseDefault (NamedArraylist property)\|UseDefault]]</var> property value is <code>False</code>:
			<ul>
			<li>Under <var>Sirius Mods</var> version 8.0 and later an [[ItemNotPresent class\|ItemNotPresent exception]] is thrown.
			<li>Under <var>Sirius Mods</var> version 7.9 and earlier the request is cancelled.
			</ul>
	<li>The <var>[[Default (NamedArraylist property)\|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.		<li>The <var>[[Default (NamedArraylist property)\|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.
	</ul>		</ul>

JAL2: /* Usage notes */

2011-07-21T20:02:16Z

Usage notes

← Older revision		Revision as of 20:02, 21 July 2011
Line 26:		Line 26:
	<li>The <var>[[Default (NamedArraylist property)\|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.		<li>The <var>[[Default (NamedArraylist property)\|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.
	</ul>		</ul>
			Regardless of the value of <var>UseDefault</var>, the presence of the item with the indicated name can be checked using the <var>[[Number (NamedArraylist function)\|Number]]</var> function, for example:
			<p class="code">%num = %myLis:number(%key)
			if %num then %name = %myLis:[[ItemByNumber (NamedArraylist property)\|itemByNumber]](%num)
			...
			</p>
	<li>The <code>Item</code> keyword is not required. For example, in the request at the start of the <var>[[NamedArraylist class]]</var>, <code>%alist('Idle') = 'Eric'</code>, for instance, is equivalent to:		<li>The <code>Item</code> keyword is not required. For example, in the request at the start of the <var>[[NamedArraylist class]]</var>, <code>%alist('Idle') = 'Eric'</code>, for instance, is equivalent to:
	<p class="code">%alist:Item('Idle') = 'Eric'		<p class="code">%alist:Item('Idle') = 'Eric'

Goff: match syntax table to diagram, lots of tags, some edits

2011-03-04T09:07:52Z

match syntax table to diagram, lots of tags, some edits

← Older revision		Revision as of 09:07, 4 March 2011
Line 1:		Line 1:
	{{Template:NamedArraylist:Item subtitle}}		{{Template:NamedArraylist:Item subtitle}}

	~~This~~ ReadWrite property returns or sets the value of the item that has the		<var>Item</var> is a ReadWrite property returns or sets the value of the item that has the given name in the <var>NamedArraylist</var>.
	given name in the NamedArraylist.
			For additional comments about the <var>Item</var> method in collections, see [[Collections#Coding considerations for collections\|"Coding considerations for collections"]].

	~~For additional comments about the Item method in collections,~~
	~~see [[Collections#Coding considerations for collections\|Coding considerations for collections]].~~
	==Syntax==		==Syntax==
	{{Template:NamedArraylist:Item syntax}}		{{Template:NamedArraylist:Item syntax}}
	===Syntax terms===		===Syntax terms===
	<table class="syntaxTable">		<table class="syntaxTable">
	<tr><th>%~~item~~</th>		<tr><th>%currentItem</th>
	<td>A variable of the same type as specified on the ~~''%namrayl''~~ declaration to contain the value of the specified ~~''%namrayl'' item. Or a variable or value of the same type as specified on the ''%namrayl'' declaration to be assigned to the specified ''%namrayl''~~ item. </td></tr>		<td>A variable of the same type as specified on the <var class="term">nal</var> declaration to contain the value of the specified <var class="term">nal</var> item.</td></tr>
	<tr><th>~~%namrayl~~</th>		<tr><th>nal</th>
	<td>A NamedArraylist object. </td></tr>		<td>A <var>NamedArraylist</var> object.</td></tr>
	<tr><th>~~name~~</th>		<tr><th>string</th>
	<td>A string that serves as a subscript to identify a ~~''%namrayl''~~ item.</td></tr>		<td>A string that serves as a subscript to identify a <var class="term">nal</var> item.</td></tr>
			<tr><th>newItem</th>
			<td>A variable or value of the same type as specified on the <var class="term">nal</var> declaration to be assigned to the specified <var class="term">nal</var> item. </td></tr>
	</table>		</table>

	==Usage notes==		==Usage notes==
	<ul>		<ul>
	<li>If the Item property is being set and there is already an item		<li>If the <var>Item</var> property is being set and there is already an item on the <var>NamedArraylist</var> that has the specified name, that item is replaced. If the <var>Item</var> property is being set and there is no item on the <var>NamedArraylist</var> that has the indicated name, the item is added. If the <var>Item</var> property is being retrieved and there is no item on the <var>NamedArraylist</var> that has the indicated name, the result is one of the following actions:
	on the NamedArraylist that has the specified name, that item is replaced.

	If the Item property is being set and there is no item on the NamedArraylist
	that has the indicated name, the item is added.

	If the Item property is being retrieved and there is no item on the NamedArraylist
	that has the indicated name, the result is one of the following actions:
	<ul>		<ul>
	<li>The request is cancelled if the [[UseDefault (NamedArraylist property)\|UseDefault]]		<li>The request is cancelled if the <var>[[UseDefault (NamedArraylist property)\|UseDefault]]</var> property value is <code>False</code>.
	property value is <tt>False</tt>.		<li>The <var>[[Default (NamedArraylist property)\|Default]]</var> value is returned if the <var>UseDefault</var> property is <code>True</code>.
	<li>The [[Default (NamedArraylist property)\|Default]] value is returned if the
	UseDefault property is <tt>True</tt>.
	</ul>		</ul>
	<li>The <tt>Item</tt> keyword is not required.		<li>The <code>Item</code> keyword is not required. For example, in the request at the start of the <var>[[NamedArraylist class]]</var>, <code>%alist('Idle') = 'Eric'</code>, for instance, is equivalent to:
	For example, in the request at the start of the
	[[NamedArraylist class]], <tt>%alist('Idle') = 'Eric'</tt>, for instance,
	is equivalent to:
	<p class="code">%alist:Item('Idle') = 'Eric'		<p class="code">%alist:Item('Idle') = 'Eric'
	</p>		</p>
	<li>As shown in the example at the start of the [[NamedArraylist class]],		<li>As shown in the example at the start of the [[NamedArraylist class]], <var>NamedArraylist</var> items are ordered alphabetically by their names. Accordingly, the <var>Item</var> method takes a name argument <var class="term">string</var>.
	NamedArraylist items are ordered alphabetically by their names.
	Accordingly, the Item method takes a ''name'' argument.
	~~The ItemByNumber method, described below,~~
	~~lets you retrieve or set an item using its item number~~.
	</ul>		</ul>

	==See also==		==See also==
			<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> method, lets you retrieve or set an item using its item number.
			</ul>
	{{Template:NamedArraylist:Item footer}}		{{Template:NamedArraylist:Item footer}}

Wiccan: 1 revision

2011-02-07T04:19:21Z

1 revision

← Older revision	Revision as of 04:19, 7 February 2011
(No difference)

← Older revision		Revision as of 16:52, 3 August 2012
Line 42:		Line 42:

	==See also==		==See also==
	<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> method, lets you retrieve or set an item using its item number.		<ul><li>The <var>[[ItemByNumber_(GenericNamedArraylist_property)\|ItemByNumber]]</var> method lets you retrieve or set an item using its item number.
	</ul>		</ul>
	{{Template:NamedArraylist:Item footer}}		{{Template:NamedArraylist:Item footer}}