List

Owned by Charles Evans
Jul 03, 2020
3 min read

Properties of List

  1. Id - unique identifier of the control
  2. Model – model to be used
  3. Entity Set/Bound Field – entity set to be used based from the model assigned
  4. Definition – opens up the Definition Dialog Screen
  5. No Auto Load – setting to prevent loading the data into the list
  6. Visible - set a boolean value or a variable with type boolean from the Model to control the visibility property

  7. Advanced - properties of the control not available in the above list can be added here. 

    Setting Additional Properties provides further information about the Advanced property

Definition Dialog Screen - List

  1. Header text – list heading/description
  2. Show no data – activates the text assigned in the “No data text” definition when the list is empty
  3. No data text – text to be displayed when the list is empty
  4. Growing – activates the Growing property of the list
  5. Growing Threshold – defines the number of entries to be requested from the model for each grow (e.g. setting it to 100 will request and show the first 100 entries)
  6. Mode – selection for the list mode sap.m.ListMode
  7. Filters – set the filters to be passed into the model
  8. OnItemPress – executes the javascript function assigned for this event
  9. OnUpdateFinished - executes the javascript function assigned for this event


Properties of List Item Template

  1. Id - unique identifier of the control
  2. Type - possible options are StandardListItem, ObjectListItem and CustomListItem
  3. Definition - opens up the Definition Dialog Screen that corresponds to the selected Type
  4. Actions on Press - executes the javascript function assigned for this event

  5. Advanced - properties of the control not available in the above list can be added here. 

    Setting Additional Properties provides further information about the Advanced property

Definition Dialog Screen - List Item Template - StandardListItem

  1. Title - select the title to be displayed from the available fields of the entity set
  2. Description - select the description to be displayed from the available fields of the entity set
  3. Icon - select the field from the entity set that holds the URL of the Icon/image
  4. Type - choose from the available options in sap.m.ListType

Definition Dialog Screen - List Item Template - ObjectListItem

  1. Title - select the title to be displayed from the available fields of the entity set
  2. Intro - select the introductory text to be displayed from the available fields of the entity set
  3. Number - select the number to be displayed from the available fields of the entity set (e.g. 100)
  4. Number Unit - select the number units qualifier displayed from the available fields of the entity set (e.g. AUD)
  5. Attribute - select the attribute from the available fields of the entity set. This field uses sap.m.ObjectAttribute
  6. First and Second Status - select the status from the available fields of the entity set. This field uses sap.m.ObjectStatus
  7. Type - choose from the available options in sap.m.ListType

Definition Dialog Screen - List Item Template - CustomListItem

This allows for any content to be added into the list. Please refer to sap.m.CustomListItem for the detailed documentation and this link for the sample.

Step-by-step guide

How to add a List

  1. Right click on a Page, Form Element or from any elements under Add Layout and select Add List

  2. A List Control has been added
  3. Right click on the List Control and choose Add List Item Template
  4. A list item template control has been added