Listbox vba excel свойства и методы

Обновлено: 06.01.2025

На этом шаге мы рассмотрим назначение, основные свойства и методы этого элемента .

Элемент управления ListBox (Список) создается с помощью кнопки Список (ListBox) (рисунок 1).

Рис.1. Список в форме

Элемент управления ListBox применяется для хранения списка значений. Из списка пользователь может выбрать одно или несколько значений, которые в последующем будут использоваться в тексте программы.

Приведем наиболее часто используемые свойства элемента управления ListBox .

Таблица 1. Основные свойства ListBox Свойство Назначение ListIndex Возвращает номер текущего элемента списка. Нумерация элементов списка начинается с нуля ListCount Возвращает число элементов списка TopIndex Возвращает элемент списка с наибольшим номером ColumnCount Устанавливает число столбцов в списке TextColumn Устанавливает столбец в списке, элемент которого возвращается свойством Text Enabled Допустимые значения: True (запрещен выбор значения из списка пользователем) и False (в противном случае) Text Возвращает выбранный в списке элемент List Возвращает элемент списка, стоящий на пересечении указанных строки и столбца. Синтаксис:

fmMultiSelectSingle (выбор только одного элемента);
fmMultiSelectMulti (разрешен выбор нескольких элементов посредством либо щелчка, либо нажатием клавиши Пробел );
fmMultiSelectExtended (разрешено использование клавиши Shift при выборе ряда последовательных элементов списка).

String — строка, устанавливающая ширину столбцов. В следующем примере устанавливается ширина каждого из трех столбцов списка:

fmListStylePlain (выбранный элемент из списка выделяется цветом);
fmListStyleOption (перед каждым элементом в списке располагается флажок и выбор элемента из списка соответствует установке этого флажка).

fmMatchEntryNone (режим вывода подходящего элемента в списке отключен);
fmMatchEntryFirstLetter (вводит подходящий элемент по набранной первой букве. В этом случае, предпочтительно, чтобы элементы списка были бы упорядочены в алфавитном порядке)
fmMatchEntryComplete (вводит подходящий элемент по полному набранному имени).

если свойство BoundColumn равно 0, то свойство Value возвращает индекс выбранной строки, т.е. в этом случае оно действует как свойство ListIndex ;
если свойство BoundColumn принимает значение из диапазона от 1 до количества столбцов в списке, то свойство Value возвращает элемент из выбранной строки, стоящий в столбце, определенном свойством BoundColumn .

Приведем наиболее часто используемые методы элемента управления 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 для загрузки элементов в список по одному:

ComboBox представляет из себя комбинацию двух элементов управления: текстового поля (TextBox) и списка (ListBox), поэтому его еще называют «комбинированным списком» или «полем со списком». Также ComboBox сочетает в себе свойства этих двух элементов управления.

Изначально комбинированный список прорисовывается на форме в виде текстового поля с кнопкой для отображения раскрывающегося списка. Далее по тексту будем использовать слово «поле» в значении текстового поля в составе элемента управления ComboBox, а словосочетание «раскрывающийся список» – в значении списка в составе элемента управления ComboBox.

Поле со списком используется в тех случаях, когда необходимо добавить в форму информацию, которая заранее известна, а ее отдельные позиции можно сгруппировать в список, а также для ручного ввода с клавиатуры или вставки из буфера обмена, если необходимое значение в списке отсутствует.

Элемент управления ComboBox незаменим при больших списках. При списках из нескольких позиций его можно заменить на ListBox, который отображает позиции для выбора сразу после загрузки формы, не требуя дополнительных действий от пользователя.

Свойства поля со списком

Свойство	Описание
AutoSize	Автоподбор размера комбинированного поля. True – размер автоматически подстраивается под длину выбранной или введенной строки. False – размер элемента управления определяется свойствами Width и Height.
AutoTab	Включение автоматической табуляции – передачи фокуса следующему элементу управления при достижении максимального числа символов при значениях свойства MaxLenght > 0. True – автоматическая табуляция включена, False – выключена.
ColumnCount	Указывает количество столбцов в раскрывающемся списке. Значение по умолчанию = 1.
ColumnHeads	Добавляет строку заголовков в раскрывающийся список. True – заголовки столбцов включены, False – заголовки столбцов выключены. Значение по умолчанию = False.
ColumnWidths	Ширина столбцов в раскрывающемся списке. Значения для нескольких столбцов указываются в одну строку через точку с запятой (;).
ControlSource	Ссылка на ячейку для ее привязки к элементу управления ComboBox.
ControlTipText	Текст всплывающей подсказки при наведении курсора на элемент управления.
Enabled	Доступ пользователя к полю и раскрывающемуся списку. True – доступ разрешен, False – доступ запрещен*. Значение по умолчанию = True.
Font	Шрифт, начертание и размер текста в поле.
Height	Высота элемента управления ComboBox.
Left	Расстояние от левого края внутренней границы пользовательской формы до левого края комбинированного списка.
List	Позволяет заполнить ComboBox данными из одномерного или двухмерного массива, а также обращаться к отдельным элементам раскрывающегося списка по индексам для записи и чтения.
ListIndex	Номер выбранной пользователем строки в раскрывающемся списке. Нумерация начинается с нуля. Если ничего не выбрано, ListIndex = -1.
ListRows	Количество видимых строк в раскрытом списке. Если общее количество строк больше ListRows, появляется полоса прокрутки. Значение по умолчанию = 8.
Locked	Запрет на отображение раскрывающегося списка, ввод и редактирование данных в поле. True – ввод и редактирование запрещены**, False – ввод и редактирование разрешены. Значение по умолчанию = False.
MatchRequired	Задает проверку вводимых в поле строк с элементами списка. True – проверка включена (допускается ввод только строк, совпадающих с элементами списка), False – проверка выключена (допускается ввод любых строк). Значение по умолчанию = False.
MaxLenght	Максимальная длина строки в поле. Значение по умолчанию = 0, что означает – ограничений нет.
RowSource	Источник строк для раскрывающегося списка (адрес диапазона на рабочем листе Excel).
TabIndex	Целое число, определяющее позицию элемента управления в очереди на получение фокуса при табуляции. Отсчет начинается с 0.
Text	Текстовое содержимое (значение) поля (=Value).
TextAlign	Выравнивание текста в поле: 1 (fmTextAlignLeft) – по левому краю, 2 (fmTextAlignCenter) – по центру, 3 (fmTextAlignRight) – по правому краю.
Top	Расстояние от верхнего края внутренней границы пользовательской формы до верхнего края комбинированного списка.
Value	Текстовое содержимое (значение) поля (=Text).
Visible	Видимость поля со списком. True – ComboBox отображается на пользовательской форме, False – ComboBox скрыт.
Width	Ширина элемента управления.

* При Enabled в значении False пользователь не может раскрывать список, а также вводить или редактировать данные в поле.
** Для элемента управления ComboBox действие свойства Locked в значении True аналогично действию свойства Enabled в значении False.

В таблице перечислены только основные, часто используемые свойства поля со списком. Еще больше доступных свойств отображено в окне Properties элемента управления ComboBox, а все методы, события и свойства – в окне Object Browser.

Вызывается Object Browser нажатием клавиши «F2». Слева выберите объект ComboBox, а справа смотрите его методы, события и свойства.

Свойства BackColor, BackStyle, BorderColor, BorderStyle отвечают за внешнее оформление комбинированного списка и его границ. Попробуйте выбирать доступные значения этих свойств в окне Properties, наблюдая за изменениями внешнего вида элемента управления ComboBox на проекте пользовательской формы.

Способы заполнения ComboBox

Используйте метод AddItem для загрузки элементов в поле со списком по одному:

Создайте в редакторе VBA Excel пользовательскую форму с любым именем и разместите на ней список с именем ListBox1. Вставляйте в модуль формы код примера, запускайте код или форму и смотрите результат.

Чтобы запустить форму, фокус должен быть на ее проекте или на одном из ее элементов управления. Чтобы запустить код, курсор должен быть в одной из его строк. Запускается код или форма нажатием клавиши «F5» или треугольной кнопки «Run Sub/UserForm»:

Заполнение ListBox методом AddItem

Метод AddItem используется для загрузки отдельного элемента в ListBox. Он создает в списке новую строку и записывает в нее значение. Используя цикл, можно загрузить в ListBox одномерный массив.

Пример 1
Загрузка элементов в ListBox по отдельности:

Результат работы кода:

Пример 2
Загрузка данных в ListBox из одномерного массива при помощи цикла VBA Excel:

Заполнение ListBox с помощью свойства List

Свойство List позволяет в коде VBA Excel скопировать целиком одномерный или двухмерный массив значений в элемент управления ListBox. А также добавлять данные в элементы двухмерного списка по их индексам в строки, созданные методом AddItem.

Пример 3
Заполнение списка данными из одномерного массива.

Загрузка значений, возвращенных функцией Array:

Me . ListBox1 . List = Array ( "Зима" , "Весна" , "Лето" , "Осень" )

Загрузка значений из переменной одномерного массива:

myArray = Array ( "Январь" , "Февраль" , "Март" , "Апрель" , "Май" )

Пример 4
Заполнение списка данными из двухмерного массива.

Результат получается следующий:

Пример 5
Заполнение списка с тремя столбцами по каждому элементу отдельно. Создаем строку и записываем значение в первый столбец методом AddItem. Значения во второй и третий столбцы записываем с помощью свойства List по индексам:

Результат работы кода будет таким же, как в Примере 4.

Заполнение ListBox с помощью свойства RowSource

Свойство RowSource позволяет загрузить в элемент управления ListBox значения из диапазона ячеек на рабочем листе Excel. Задать адрес диапазона свойству RowSource можно как в ходе выполнения кода VBA, так и в окне Properties элемента управления ListBox.

Адрес диапазона ячеек для свойства RowSource указывается по следующей формуле: "Имя_листа!Адрес_диапазона" . Имя_листа соответствует имени листа по ярлыку. Адрес в окне Properties вводится без парных кавычек.

Если адрес диапазона указать без имени рабочего листа, то данные будут загружаться в список из соответствующего диапазона активного листа. Если имя рабочего листа содержит пробелы, то его следует заключить в одинарные кавычки: "'Данные для списка'!A1:A10" .

Пример 6
Импорт данных в одностолбцовый список из диапазона «A1:A7» рабочего листа «Лист1»:

Отображает список значений и позволяет выбирать одно или несколько значений.

Примечания

Если ListBox привязан к источнику данных, ListBox сохраняет выбранное значение в этом источнике данных.

ListBox может отображаться как список, так и как группа элементов управления OptionButton или CheckBox.

Свойство по умолчанию для ListBox — это свойство Value.

Событие по умолчанию для ListBox — событие Click.

В раскрывающийся элемент ListBox невозможно поместить текст.

Стили элемента ListBox

Вы можете выбрать любой из двух стилей представления элемента ListBox. Это выражается свойством ListStyle. Каждый из них реализует собственный способ выбора элементов в списке.

Если стиль 0, каждый элемент находится в отдельной строке; пользователь выбирает элемент, выделяя одну или несколько строк.

Если стиль 1, в начале каждой строки появляется OptionButton или CheckBox. В этом случае для выбора элемента пользователь нажимает кнопку или устанавливает флажок. Флажки отображаются только тогда, когда свойство MultiSelect является True.

События

Имя	Описание
Click	Возникает, когда пользователь окончательно выбирает значение для управления, которое имеет несколько возможных значений.

Методы

Имя	Описание
AddItem	Для одного столбца ListBoxметод AddItem добавляет элемент в список. Для многоуровневого ListBox этот метод добавляет строку в список.
Clear	Удаляет все записи в списке в ListBox.
RemoveItem	Удаляет строку из списка в ListBox.

Свойства

Имя	Описание
BackColor	Возвращает или задает длинный, который указывает фоновый цвет объекта. Для чтения и записи.
BorderColor	Возвращает или задает long, который указывает пограничный цвет объекта. Для чтения и записи.
BorderStyle	Возвращает или задает набор integer, который указывает тип границы управления. Для чтения и записи.
BoundColumn	Возвращает или задает вариант, определяя источник данных в многоуровневом ListBox. Для чтения и записи.
Column	Возвращает или задает вариант, представляющие одно значение, столбец значений или двухмерный массив для загрузки в ListBox. Для чтения и записи.
ColumnCount	Возвращает или задает long, представляют число столбцов, отображаемого в поле списка. Для чтения и записи.
ColumnHeads	Возвращает или задает boolean, который указывает, отображается ли одна строка заголовков столбцов. Для чтения и записи.
ColumnWidths	Возвращает или задает строку, которая указывает ширину каждого столбца в многослойном ListBox. Для чтения и записи.
Enabled	Возвращает или задает boolean, который указывает, может ли управление получать фокус и реагировать на события, созданные пользователем. Для чтения и записи.
ForeColor	Возвращает или задает длинный, который указывает цвет переднего плана объекта. Для чтения и записи.
IMEMode	Возвращает или задает integer, который указывает режим времени работы по умолчанию редактора метода ввода (IME) для управления. Для чтения и записи.
IntegralHeight	Возвращает или задает boolean, который указывает, отображает ли ListBox полные строки текста в списке или частичные строки. Для чтения и записи.
Список	Возвращает или задает вариант, представляющие указанную запись в ListBox. Для чтения и записи.
ListCount	Возвращает длинный, который представляет количество записей списка в области управления. Только для чтения.
ListIndex	Возвращает или задает вариант, представляющие выбранный в настоящее время элемент в ListBox. Для чтения и записи.
ListStyle	Возвращает или задает набор integer, который указывает визуальное появление списка в ListBox. Для чтения и записи.
Locked	Возвращает или задает boolean, который указывает, можно ли изменить управление. Для чтения и записи.
MatchEntry	Возвращает или задает набор integer, который указывает, как ListBox выполняет поиск своего списка в качестве типов пользователей. Для чтения и записи.
MouseIcon	Возвращает строку, которая представляет полное имя пути настраиваемого значка, назначенного для управления. Только для чтения.
MousePointer	Возвращает или задает набор integer, который указывает тип указателя, отображаемого при позиционировании пользователя мыши над определенным объектом. Для чтения и записи.
MultiSelect	Возвращает или задает набор integer, который указывает, разрешает ли объект несколько выборов. Для чтения и записи.
Selected	Возвращает или задает boolean, который указывает состояние выбора элементов в ListBox. Для чтения и записи.
SpecialEffect	Возвращает или задает набор integer, который указывает внешний вид объекта. Для чтения и записи.
Text	Возвращает или задает строку, которая указывает текст в ListBox, изменяя выбранную строку в области управления. Для чтения и записи.
TextAlign	Возвращает или задает набор integer, который указывает, как текст выравнивается в области управления. Для чтения и записи.
TextColumn	Возвращает или задает вариант, который идентифицирует столбец в ListBox для отображения пользователю. Для чтения и записи.
TopIndex	Возвращает или задает длинный, представляютельный индекс элемента списка, отображаемого в верхней позиции в списке. Для чтения и записи.
Значение	Возвращает или задает вариант, который указывает значение в BoundColumn выбранных в настоящее время строк. Для чтения и записи.

Поддержка и обратная связь

Есть вопросы или отзывы, касающиеся Office VBA или этой статьи? Руководство по другим способам получения поддержки и отправки отзывов см. в статье Поддержка Office VBA и обратная связь.

Читайте также: