Item (FloatNamedArraylist property)

From m204wiki
Revision as of 08:56, 4 March 2011 by Goff (talk | contribs) (match syntax table to diagram, lots of tags, some edits)
Jump to navigation Jump to search

Value of named item (FloatNamedArraylist class)


Item is a ReadWrite property returns or sets the value of the item that has the specified subscript number in the FloatNamedArraylist.

For additional comments about the Item method in collections, see "Coding considerations for collections".

Syntax

%currentItem = fltNal:Item( number) fltNal:Item( number) = newItem Throws ItemNotPresent

Syntax terms

%currentItem A variable of the same type as specified on the fltNal declaration to contain the value of the specified fltNal item. Or a variable or value of the same type as specified on the fltNal declaration to be assigned to the specified fltNal item.
fltNal A FloatNamedArraylist object.
number A number that serves as a subscript to identify a fltNal item.

Usage notes

  • The Item keyword is not required. For example, in the request in the FloatNamedArraylist class example, %y(7) = 'seven', for instance, is equivalent to:

    %y:item(7) = 'seven'

  • If the Item property is being set and there is already an item on the FloatNamedArraylist that has the specified subscript, that item is replaced. If the Item property is being set and there is no item on the FloatNamedArraylist that has the indicated subscript, the item is added. If the Item property is being retrieved and there is no item on the FloatNamedArraylist that has the indicated subscript, the result is one of the following actions:
    • The request is cancelled if the UseDefault property value is False.
    • The Default value is returned if the UseDefault property is True.
  • As shown in the example in the FloatNamedArraylist class article, FloatNamedArraylist items are ordered numerically by their subscript numbers. Accordingly, the Item method takes a numerical subscript argument.

See also

  • The ItemByNumber method, lets you retrieve or set an item using the item's ordinal number.
  • The NameByNumber property lets you retrieve the "name" (numerical subscript) of the item that has the specified item number (position) .