Example and usage
The Item List web extension has parameters for its core functionality, and additional parameters to customize its content.
These are the primary parameters:
- Item keys: A reference to
a range of cells that contain the unique names of items and actions for further
processing. When an action is triggered,
Actions.Input.Text
sends one of these values:Actions.Input.Text="Row"
: The item is selected.Actions.Input.Text="Edit"
: The button was clicked.Actions.Input.Text="Delete"
: The button was clicked.
- Item data: A reference to a range of cells containing item data, or to a cell containing XML of the same data. The first column of the data range is reserved for these optional properties of item keys:
- Title (string)
- Description 1(string)
- Description 2 (string)
- Timestamp (string)
- Visible (boolean): If False, the item is hidden. True is the default.
- Enabled (boolean): If False, the item is disabled. True is the default.
- Selected (boolean): If True, the item is selected. False is the default.
- Edit (boolean): If True, inline edit and delete icons are displayed. False is the default.
These additional parameters enable customization of the content. Specify
=""
to use defaults where available.Note: Where you can specify
text, such as for the error message, use the TRANSLATEUNIQUESTRING function to
ensure that the text is translated if the language of the user interface is
changed.
- Multiselect: If True, multiselection is enabled. False is the default.
- Search Box Placeholder: By default, the search box is visible and empty. Specify False to disable the check box.
- Error Message: By default, if there are no list items, the error message is No items available.
- Main Title: The title of the list. By default, no title is displayed.
- Main Title Color: The default color of the title is
#368ac0
. - Title Color: The default color of the title's font is
#1a1a1a
. - Selected Color: The color in which the selected row is
highlighted. The default is
#c8e9f4
. - Selected Items Text: By default, the text is Selected. This parameter is applicable only if multiselection is enabled.
- Remove Action: Define an action on a cell, which is triggered when the button is clicked. The default text is Remove. This parameter is applicable only if multiselection is enabled.
- Hide Side Borders: Specify True to hide the left and right borders of the row. By default, the borders are visible.
- Border Color: By default, the color of borders is
#d8d8d8
.