getListBox

await crafttechApi.getListBox(sheetStr, defName);

Описание

Возвращает данные, выбранные пользователем из поля списка.

Данный метод был разработан ввиду ограничений Р7-Офис Таблицы, не предусматривающих создание и взаимодействие с пользовательскими формами и элементами управления. Макрос, использующий данный метод, должен работать в режиме автозапуска (А).

Параметры

• sheetStr (string) — название листа, в котором находится поле списка;
• defName (string) — название поля списка как именованного диапазона.

Возвращает

• listBoxData (object) — объект с выбранными ячейками:
  • counter (number) — количество выбранных ячеек;
  • total (number) — общее количество ячеек в поле списка;
  • data (object[]) — массив объектов с информацией о выбранных ячейках:
    • address (string) — адрес выбранной ячейки;
    • cell (ApiRange) — объект ApiRange выбранной ячейки;
    • index (number) — индекс (порядок) выбранной ячейки в поле списка;
    • value (string) — строковое значение выбранной ячейки.

Пример

const result = await crafttechApi.getListBox("Лист2", "testBox");
console.log(result);

Код выше получит информацию о выбранных ячейках поля списка, ранее созданного на странице, посвящённой методу createListBox().

Метод вернёт следующий результат:

{
  "counter": 2,
  "total": 10,
  "data": [
    {
      "address": "B7",
      "cell": ApiRange,
      "index": 5,
      "value": "testValue"
    },
    {
      "address": "B11",
      "cell": ApiRange,
      "index": 9,
      "value": "Are you scared? Do not be scared!"
    }
  ]
}