2022 April Release

Control FSCAGGRLIST@1.1001:CTRLAggrList Permanent link for this heading

This control is used to display an aggregated list of objects.
You may use an instance of type AggregatedListData to provide the data for this Control. Just use the action GetAggrListOptions to calculate the control options from an structure of type FSCAGGRLIST@1.1001AggregatedListData.

FSCAGGRLIST@1.1001:CTRLAggrList(
  object Symbol,
  boolean EmptySymbol,
  string HeaderText,
  string FooterText,
  string ListLabel,
  string ObjectsLabel,
  string ErrorsLabel,
  dictionary Objects,
  dictionary Errors,
  string HasMoreText,
  integer MaxItems)

Name

Description

Symbol

A symbol object shown on the left side of the control.

EmptySymbol

Preserve an empty space (instead of a symbol) on the left side of the control.

HeaderText

A header text shown above the list of objects.

FooterText

A footer text shown below the list of objects.

ListLabel

The label for the list.

ObjectsLabel

A second, more generic label shown above the ListLabel.

ErrorsLabel

A label shown above the Errors list.

Objects

A dictionary containing an aggregated list of objects (list of dictionaries). The key of each list entry should be the COO address of the object. Aggregate members are:
  • objname
    The name of the list entry.
  • objmicon
    COO address of an icon shown in front of the name.
  • errmsg
    Error message text for the entry (optional).

Errors

A dictionary containing an aggregate list of errors. Aggregate member is string errmsg.

HasMoreText

If there are more than MaxItems items available, collapse these items and show the HasMoreText instead.

MaxItems

If there are more items than MaxItems available, do collapse these items and show the HasMoreText.

Additional Information