Элемент управления пользовательской формы ListBox для выбора и ввода информации в VBA Excel. Свойства списка, его заполнение, извлечение данных, примеры кода.
Элемент управления ListBox
Список используется в тех случаях, когда необходимо добавить в форму информацию, которая заранее известна, а ее отдельные позиции можно сгруппировать в список. Элемент управления ListBox оправдывает себя при небольших списках, так как большой список будет занимать много места на форме.
Использование полос прокрутки уменьшает преимущество ListBox перед элементом управления ComboBox, которое заключается в том, что при открытии формы все позиции для выбора на виду без дополнительных действий со стороны пользователя. При выборе информации из большого списка удобнее использовать ComboBox.
Элемент управления ListBox позволяет выбрать несколько позиций из списка, но эта возможность не имеет практического смысла. Ввести информацию в ListBox с помощью клавиатуры или вставить из буфера обмена невозможно.
Свойства списка
| Свойство | Описание |
|---|---|
| ColumnCount | Указывает количество столбцов в списке. Значение по умолчанию = 1. |
| ColumnHeads | Добавляет строку заголовков в ListBox. True – заголовки столбцов включены, False – заголовки столбцов выключены. Значение по умолчанию = False. |
| ColumnWidths | Ширина столбцов. Значения для нескольких столбцов указываются в одну строку через точку с запятой (;). |
| ControlSource | Ссылка на ячейку для ее привязки к элементу управления ListBox. |
| ControlTipText | Текст всплывающей подсказки при наведении курсора на ListBox. |
| Enabled | Возможность выбора элементов списка. True – выбор включен, False – выключен*. Значение по умолчанию = True. |
| Font | Шрифт, начертание и размер текста в списке. |
| Height | Высота элемента управления ListBox. |
| Left | Расстояние от левого края внутренней границы пользовательской формы до левого края элемента управления ListBox. |
| List | Позволяет заполнить список данными из одномерного или двухмерного массива, а также обращаться к отдельным элементам списка по индексам для записи и чтения. |
| ListIndex | Номер выбранной пользователем строки. Нумерация начинается с нуля. Если ничего не выбрано, ListIndex = -1. |
| Locked | Запрет возможности выбора элементов списка. True – выбор запрещен**, False – выбор разрешен. Значение по умолчанию = False. |
| MultiSelect*** | Определяет возможность однострочного или многострочного выбора. 0 (fmMultiSelectSingle) – однострочный выбор, 1 (fmMultiSelectMulti) и 2 (fmMultiSelectExtended) – многострочный выбор. |
| RowSource | Источник строк для элемента управления ListBox (адрес диапазона на рабочем листе Excel). |
| TabIndex | Целое число, определяющее позицию элемента управления в очереди на получение фокуса при табуляции. Отсчет начинается с 0. |
| Text | Текстовое содержимое выбранной строки списка (из первого столбца при ColumnCount > 1). Тип данных String, значение по умолчанию = пустая строка. |
| TextAlign | Выравнивание текста: 1 (fmTextAlignLeft) – по левому краю, 2 (fmTextAlignCenter) – по центру, 3 (fmTextAlignRight) – по правому краю. |
| Top | Расстояние от верхнего края внутренней границы пользовательской формы до верхнего края элемента управления ListBox. |
| Value | Значение выбранной строки списка (из первого столбца при ColumnCount > 1). Value – свойство списка по умолчанию. Тип данных Variant, значение по умолчанию = Null. |
| Visible | Видимость списка. True – ListBox отображается на пользовательской форме, False – ListBox скрыт. |
| Width | Ширина элемента управления. |
* При Enabled в значении False возможен только вывод информации в список для просмотра.
** Для элемента управления ListBox действие свойства Locked в значении True аналогично действию свойства Enabled в значении False.
*** Если включен многострочный выбор, свойства Text и Value всегда возвращают значения по умолчанию (пустая строка и Null).
В таблице перечислены только основные, часто используемые свойства списка. Еще больше доступных свойств отображено в окне Properties элемента управления ListBox, а все методы, события и свойства – в окне Object Browser.
Вызывается Object Browser нажатием клавиши «F2». Слева выберите объект ListBox, а справа смотрите его методы, события и свойства.
Свойства BackColor, BorderColor, BorderStyle отвечают за внешнее оформление списка и его границ. Попробуйте выбирать доступные значения этих свойств в окне Properties, наблюдая за изменениями внешнего вида элемента управления ListBox на проекте пользовательской формы.
Способы заполнения ListBox
Используйте метод AddItem для загрузки элементов в список по одному:
|
1 2 3 4 5 |
With UserForm1.ListBox1 .AddItem "Значение 1" .AddItem "Значение 2" .AddItem "Значение 3" End With |
Используйте свойство List, чтобы скопировать одномерный массив значений в элемент управления ListBox.
|
1 2 |
UserForm1.ListBox1.List = Array("Текст 1", _ "Текст 2", "Текст 3", "Текст 4", "Текст 5") |
Вместо функции Array можно использовать переменные одномерных и двухмерных массивов. При загрузке значений из двухмерного массива, требуется предварительно указать количество столбцов в списке.
Используйте свойство RowSource, чтобы загрузить в список значения из диапазона ячеек рабочего листа:
|
1 |
UserForm1.ListBox1.RowSource = "Лист1!A1:A6" |
При загрузке данных из диапазона, содержащего более одного столбца, требуется предварительно указать количество столбцов в списке:
|
1 2 3 4 5 |
With UserForm1.ListBox1 'Указываем количество столбцов .ColumnCount = 5 .RowSource = "'Лист со списком'!A1:E10" End With |
В качестве имени листа используется имя ярлыка. Если имя листа содержит пробелы, оно заключается в одинарные кавычки.
Подробнее о заполнении элемента управления ListBox вы можете ознакомиться в отдельной статье с наглядными примерами.
Привязка списка к ячейке
Для привязки списка к ячейке на рабочем листе используется свойство ControlSource. Суть привязки заключается в том, что при выборе строки в элементе управления, значение свойства Value копируется в привязанную ячейку.
Если привязанная к списку ячейка содержит значение одной из строк элемента управления ListBox, то при запуске пользовательской формы список откроется с выделенной строкой, содержащей это значение. Если привязанная ячейка при загрузке формы пустая, то список откроется без выделения какой-либо строки.
В случае, когда при открытии формы в привязанной к списку ячейке содержится значение, которого нет ни в одной из строк элемента управления ListBox, будет сгенерирована ошибка.
Привязать ячейку к списку можно, указав адрес ячейки в поле свойства ControlSource в окне Properties элемента управления ListBox. Или присвоить адрес ячейки свойству ControlSource в коде VBA Excel:
|
1 |
UserForm1.ListBox1.ControlSource = "Лист1!A2" |
Теперь значение выбранной строки в списке автоматически копируется в ячейку «A2» на листе «Лист1»:
В окне Properties адрес указывается без двойных кавычек. Если имя листа содержит пробелы, оно заключается в одинарные кавычки.
Извлечение информации из списка
Первоначально элемент управления ListBox открывается со строками, ни одна из которых не выбрана. При выборе (выделении) строки, ее значение записывается в свойства Value и Text.
Из этих свойств мы с помощью кода VBA Excel извлекаем информацию, выбранную в списке пользователем:
|
1 2 3 4 |
Dim myVar as Variant, myTxt As String myVar = UserForm1.ListBox1.Value 'или myTxt = UserForm1.ListBox1.Text |
Вторую строку кода можно записать myVar = UserForm1.ListBox1, так как Value является свойством списка по умолчанию.
Если ни одна позиция в списке не выбрана, свойство Value возвращает значение Null, а свойство Text – пустую строку. Если выбрана строка в многостолбцовом списке, в свойства Value и Text будет записана информация из первого столбца.
Что делать, если понадобятся данные из других столбцов многостолбцового списка, кроме первого?
Для получения данных из любого столбца элемента управления ListBox используется свойство List, а для определения выбранной пользователем строки – ListIndex.
Для тестирования приведенного ниже кода скопируйте таблицу и вставьте ее в диапазон «A1:D4» на листе с ярлыком «Лист1»:
| Звери | Лев | Тапир | Вивера |
| Птицы | Грач | Сорока | Филин |
| Рыбы | Карась | Налим | Парусник |
| Насекомые | Оса | Жук | Муравей |
Создайте в редакторе VBA Excel пользовательскую форму и добавьте на нее список с именем ListBox1. Откройте модуль формы и вставьте в него следующие процедуры:
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
Private Sub UserForm_Initialize() With Me.ListBox1 'Указываем, что у нас 4 столбца .ColumnCount = 4 'Задаем размеры столбцов .ColumnWidths = "50;50;50;50" 'Импортируем данные .RowSource = "Лист1!A1:D4" 'Привязываем список к ячейке "F1" .ControlSource = "F1" End With End Sub Private Sub UserForm_Click() MsgBox Me.ListBox1.List(Me.ListBox1.ListIndex, 2) End Sub |
В процедуре UserForm_Initialize() присваиваем значения некоторым свойствам элемента управления ListBox1 перед открытием пользовательской формы. Процедура UserForm_Click() при однократном клике по форме выводит в MsgBox значение из третьего столбца выделенной пользователем строки.
Теперь при выборе строки в списке, значение свойства Value будет записываться в ячейку «F1», а при клике по форме функция MsgBox выведет значение третьего столбца выделенной строки.
Обратите внимание, что при первом запуске формы, когда ячейка «F1» пуста и ни одна строка в ListBox не выбрана, клик по форме приведет к ошибке. Это произойдет из-за того, что свойство ListIndex возвратит значение -1, а это недопустимый номер строки для свойства List.
Если для списка разрешен многострочный выбор (MultiSelect = fmMultiSelectMulti или MultiSelect = fmMultiSelectExtended), тогда, независимо от количества выбранных строк, свойство Value будет возвращать значение Null, а свойство Text – пустую строку. Свойство ListIndex будет возвращать номер строки, которую кликнули последней, независимо от того, что это было – выбор или отмена выбора.
Иногда перед загрузкой в ListBox требуется отобрать уникальные элементы из имеющегося списка. Смотрите, как это сделать с помощью объектов Collection и Dictionary.