List

This topic describes the options and limitations available when using a List component.

Content settings

Header

These settings provide the text for only the header (or title) of the list. The actual contents of the list come from whatever data service is used as the data source for the list.

Options

This setting provides only one option: Keep Selection

When selected, this option indicates that any record that is selected when the collection is refreshed, remains selected after the collection is refreshed.

When this option is cleared, after the collection is refreshed, the focus returns to the first record in the collection.

Interactions

Trigger Event

The List component can trigger these events:

• On Selection Changed

  This event is triggered when the selection of an item in the list changes.

• On Load

  This event might display as one of these values:

  • Data Service has run (On Load), where Data Service is the name of a data service assigned to the component
  • On Load (No Data Service), where no data service has been assigned to the component

Target Action

Depending on the target, the List component can perform a Get operation, a Run operation, or a Clear operation on the target component.

Style settings

Template

This setting has one option, Cell Template, with these choices:

• One Label

  When this option is selected, only one value displays for each item in the list.

  To specify what property value is to be used, use the Content > Label setting for the OneLabelList subcomponent.

  Note: This subcomponent is selected by clicking on the value for a single record of the list. That makes the subcomponent available for modification the same as any basic component.
• Two Labels Vertical

  When this option is selected, two values display for each item in the list. The "primary" value displays on top, in a slightly larger font. The "secondary" value displays underneath, in a slight smaller font.

  To specify what values are to be used, use the Content > Label settings for the TopLabelList and BottomLabelList subcomponents.

  Note: These subcomponents are selected by clicking on the top or bottom value for a single record of the list. That makes the subcomponents available for modification the same as any basic component.
• Image & Labels

  When this option is selected, one value displays, similar to the Two Labels Vertical choice, and an image displays directly below it .

  Note: The images must be accessed by means of a data service, similar to the use of an Image component.
• One Hyperlink

  When this option is selected, each list item consists of a Hyperlink component. The Hyperlink component must be configured the same as any other Hyperlink component.

• Label & Hyperlink

  When this option is selected, each list item contains a Label component, followed by a Hyperlink component. Both components must be configured according to their types.

• Image, Label and Hyperlink

  When this option is selected, each list item contains an Image component on the left, and both a Label component and a Hyperlink component on the right. Each of these components must be configured separately.

  Note: The images must be accessed by means of a data service, similar to the use of an Image component.

Style

This section has one option: Show Header

When selected, this option displays the list header. When cleared, the header is not displayed.