ItemByNumber (FloatNamedArraylist property)

<section begin=dpl_desc/>Value of item selected by item<section end=dpl_desc/>

ItemByNumber is a member of the FloatNamedArraylist class.

This ReadWrite property returns or sets the FloatNamedArraylist item that has the specified item number. Item number is ordinal, so ItemByNumber(3), for example, identifies the third item in the numerically ordered FloatNamedArraylist.

Syntax

  %item = %fnamrayl:ItemByNumber(number)

  %fnamrayl:ItemByNumber(number) = %item

Syntax Terms

%item

A variable of the same type as specified on the %fnamrayl declaration to contain the value of the specified %fnamrayl item. Or a variable or value of the same type as specified on the %fnamrayl declaration to be assigned to the specified %fnamrayl item.

%fnamrayl

A FloatNamedArraylist object.

number

A whole number greater than 0 to identify a %fnamrayl item by its position in the FloatNamedArraylist. If number is greater than the number of items in %fnamrayl, or if it is less than or equal to zero, the request is cancelled.

Usage Notes

• If the ItemByNumber property is being set and there is already an item on the FloatNamedArraylist that has the specified item number (position), that item is replaced. If the ItemByNumber property is being set and there is no item on the FloatNamedArraylist that has the indicated item number, the item is added. If the ItemByNumber property is being retrieved and there is no item on the FloatNamedArraylist that has the indicated item number, the result is one of the following actions:
  • The request is cancelled if the UseDefault value is False.
  • The Default value is returned if the UseDefault property is True.
• Item lets you retrieve or set an item using its item subscript number.