createListBox

await crafttechApi.createListBox(
  array,
  sheetStr,
  start,
  (defName = ""),
  (oColor = Api.CreateColorFromRGB(0, 128, 0)),
  (isMultiple = false)
);

Описание

Формирует поле списка на листе на основе переданного диапазона. Для создания выпадающего списка используйте createDropdownCell

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

Макрос, использующий данный метод, должен работать в режиме автозапуска (А).

Параметры

• array (string) — массив строк с опциями поля списка;
• sheetStr (string) — название листа, в который будет добавлено поле списка;
• start (string) — адрес ячейки, с которой начинается формирование поля списка;
• defName (string) — необязательный параметр; название поля списка как именованного диапазона (это необходимо, чтобы потом мы могли удобно получить выбранные опции из поля списка через метод getListBox); если название именованного диапазона не задано, макрос установит ему стандартное название listBox{i};
• oColor (ApiColor) — необязательный параметр; цвет ячейки, в которую она окрасится после клика на её при выборе опции; по умолчанию цвет #008000;
• isMultiple (boolean) — необязательный параметр; возможность множественного выбора опций в поле списка; по умолчанию отключено.

Возвращает

Метод ничего не возвращает.

Пример

const array = [
  "Hello",
  "World",
  "1",
  "2",
  "3",
  "Amogus",
  "Abobus",
  "Bus",
  "Sus",
  "Are you scared? Do not be scared!",
];
const defName = "testBox";

function checkArrayType(input) {
  const isArray = Array.isArray(input);
  const isArrayOfArrays = isArray && input.every((item) => Array.isArray(item));

  return { isArray, isArrayOfArrays };
}

await crafttechApi.createListBox(array, "Лист2", "B2", defName, "", true);

Код выше создаст поле списка, обведённое границами чёрного цвета. Каждый элемент массива, переданного первым аргументом, записывается в соответствующую ячейку как опция поля списка. Список в данном случае носит название «testBox».

В поле выбраны опции со значениями «Amogus» и «Are you scared? Do not be scared!» — они окрашены в зелёный цвет. Чтобы отменить опцию, необходимо ещё раз нажать на неё, чтобы ячейка стала бесцветной. Данное поле будет видно только на листе «Лист2».