Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

String List

Object List GrooperReview.Controls

Displays a list of strings.

Remarks

Overview

The String List control presents a collection of strings in a tabular, interactive format within the Grooper web client. Each row represents a string value, and the control is designed for reviewing, selecting, and managing lists of text items such as filenames, labels, or identifiers. It supports both single and multi-selection, custom column configuration, and interactive features for efficient navigation and manipulation.

UI Components

  • Results Table:
    • Displays each string as a row in a single-column table.
    • The column header is configurable via the description parameter.
    • Column width can be set for optimal readability.
  • Row Attributes:
    • Each row includes a data-value attribute containing the string value for integration with scripts and UI logic.
    • Selected and focused rows are visually highlighted.
    • Optionally, the file extension can be hidden from display for filename lists.

Interactive Features

  • Selection Controls:
    • Click to select a row; use Ctrl + click for multi-select, Shift + click for range selection.
    • Supports batch operations on selected items.
  • Keyboard Navigation:
    • Up/Down: Move between rows.
    • Home/End: Jump to the first or last string.
    • Shift + Up/Down: Multi-select.
  • Focused Value:
    • The control can highlight a specific string value as focused, even if it is not the currently selected row.
  • Customizable Display:
    • Optionally hide file extensions for lists of filenames to improve clarity.
    • Column description and width are configurable for different use cases.

Usage Guidance

Use String List to review and interact with lists of strings, such as filenames, labels, or identifiers. Configure the column description and width to match your workflow. Leverage multi-select and keyboard shortcuts for efficient batch operations and navigation.

  • For filename lists, use the hide extension option to display only the base name.
  • Integrate with client-side scripts using the data-value row attribute for advanced workflows.
  • Use the focused value feature to highlight important items in the list.

Example

// Example: String List for filenames | Filename | |------------------| | Invoice.pdf | | Contract.docx | | Readme.txt |

Accessibility

  • Fully navigable by keyboard and mouse.
  • Screen reader support for row and column data.
  • Visual highlighting for selection and focus.

Used By

Notification