ControlExtensions.AddListBox - метод (ControlCollection, Range, String)
Добавляет новый элемент управления ListBox в указанный диапазон листа.
Пространство имен: Microsoft.Office.Tools.Excel
Сборка: Microsoft.Office.Tools.Excel.v4.0.Utilities (в Microsoft.Office.Tools.Excel.v4.0.Utilities.dll)
Синтаксис
'Декларация
<ExtensionAttribute> _
Public Shared Function AddListBox ( _
controls As ControlCollection, _
range As Range, _
name As String _
) As ListBox
public static ListBox AddListBox(
this ControlCollection controls,
Range range,
string name
)
Параметры
- controls
Тип: Microsoft.Office.Tools.Excel.ControlCollection
Коллекция, в которую добавляется элемент управления.Не формируйте значение этого параметра самостоятельно.При вызове этого метода для коллекции, возвращаемой свойством Worksheet.Controls (в проекте уровня приложения) или свойством WorksheetBase.Controls (в проекте уровня документа), данный параметр предоставляется автоматически.
- range
Тип: Microsoft.Office.Interop.Excel.Range
Объект Range, предоставляющий границы элемента управления.
- name
Тип: System.String
Имя элемента управления, которое можно использовать для индексации элемента управления в экземпляре ControlCollection.
Возвращаемое значение
Тип: Microsoft.Office.Tools.Excel.Controls.ListBox
Элемент управления ListBox, добавленный в экземпляр ControlCollection.
Примечание об использовании
В Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа ControlCollection. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе Методы расширения (Visual Basic) или Методы расширения (Руководство по программированию в C#).
Исключения
| Исключение | Условие |
|---|---|
| ArgumentNullException | Аргумент имени или диапазона равен nullпустая ссылка (Nothing в Visual Basic), или аргумент имени имеет нулевую длину. |
| ControlNameAlreadyExistsException | Элемент управления с таким именем уже имеется в данном экземпляре ControlCollection. |
| InvalidRangeException | Указанный диапазон не существует. Невозможно использовать диапазоны с несколькими областями. Диапазон должен находиться на том же листе, что и экземпляр ControlCollection. |
Заметки
Метод AddListBox используется для добавления объектов ListBox в конец ControlCollection. Чтобы удалить добавленный программно объект ListBox, воспользуйтесь методом Remove.
Размер элемента управления автоматически изменяется при изменении размера диапазона.
Примеры
В следующем примере кода добавляется элемент управления ListBox в ячейки A1 до B6, добавляет два пункта в поле списка и затем выбирает первый пункт. Чтобы использовать этот пример, запустите его из класса Sheet1 в проекте уровня документа.
Private Sub ExcelRangeAddListBox()
Dim ListBox1 As Microsoft.Office.Tools.Excel. _
Controls.ListBox = Me.Controls.AddListBox( _
Me.Range("A1", "B6"), "ListBox1")
ListBox1.Items.Add("First Item")
ListBox1.Items.Add("Second Item")
ListBox1.SelectedIndex = 0
End Sub
private void ExcelRangeAddListBox()
{
Microsoft.Office.Tools.Excel.Controls.ListBox
listBox1 = this.Controls.AddListBox(
this.Range["A1", "B6"], "lisBox1");
listBox1.Items.Add("First Item");
listBox1.Items.Add("Second Item");
listBox1.SelectedIndex = 0;
}
Безопасность платформы .NET Framework
- Полное доверие для непосредственно вызывающего метода. Этот член не может быть использован частично доверенным кодом. Дополнительные сведения см. в разделе Использование библиотек из не вполне надежного кода.