ItemByNumber (GenericNamedArraylist property)

<section begin=dpl_desc/>Value of numbered item<section end=dpl_desc/>

ItemByNumber is a member of the NamedArraylist class.

This ReadWrite property returns or sets the NamedArraylist item that has the specified item number.

Syntax

  %item = %namrayl:ItemByNumber(number)

  %namrayl:ItemByNumber(number) = %item

Syntax Terms

%item

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.

%namrayl

A NamedArraylist object.

number

A whole number greater than 0 to identify a %namrayl item by its position in the alphabetically ordered NamedArraylist. If number is greater than the number of items in %namrayl, 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 NamedArraylist that has the specified number, that item is replaced. If the ItemByNumber property is being set and there is no item on the NamedArraylist that has the indicated number, the item is added. If the ItemByNumber property is being retrieved and there is no item on the NamedArraylist that has the indicated number, 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.
• The Item property lets you retrieve or set an item using its item name.