FormControlCollection.AddListBox(CellRange) Method

Creates a list box form control at the specified cell range.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v24.1.Core.dll

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

ListBoxFormControl AddListBox(
    CellRange targetRange
)

VB.NET

Function AddListBox(
    targetRange As CellRange
) As ListBoxFormControl

Parameters

Name	Type	Description
targetRange	CellRange	The cell range where the form control should be located.

Returns

Type	Description
ListBoxFormControl	The list box form control.

Remarks

Example

The code sample below creates a list box control:

C#

using DevExpress.Spreadsheet;

Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var cellRange = workbook.Worksheets[0].Range["B2:D2"];
var listBoxControl = formControls.AddListBox(cellRange);

listBoxControl.SourceRange = workbook.Worksheets[0].Range["E2:E6"];
listBoxControl.SelectedIndex = 1;

VB.NET

Imports DevExpress.Spreadsheet

Dim workbook As New Workbook()
workbook.LoadDocument("Document.xlsx")
Dim cellRange = workbook.Worksheets(0).Range("B2:D2")
Dim listBoxControl = formControls.AddListBox(cellRange)

listBoxControl.SourceRange = workbook.Worksheets(0).Range("E2:E6")
listBoxControl.SelectedIndex = 1

Note

The FormControlCollection.AddListBox method call adds a new item to both FormControlCollection and ShapeCollection.