Back to Devexpress

FormControlCollection.AddComboBox(CellRange) Method

officefileapi-devexpress-dot-spreadsheet-dot-formcontrolcollection-dot-addcombobox-x28-devexpress-dot-spreadsheet-dot-cellrange-x29.md

latest5.5 KB
Original Source

FormControlCollection.AddComboBox(CellRange) Method

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

Namespace : DevExpress.Spreadsheet

Assembly : DevExpress.Spreadsheet.v25.2.Core.dll

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

csharp
ComboBoxFormControl AddComboBox(
    CellRange targetRange
)
vb
Function AddComboBox(
    targetRange As CellRange
) As ComboBoxFormControl

Parameters

NameTypeDescription
targetRangeCellRange

The cell range where the form control should be located.

|

Returns

TypeDescription
ComboBoxFormControl

The combo box form control.

|

Remarks

Example

The code sample below creates a combo box control:

csharp
using DevExpress.Spreadsheet;

Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");
var cellRange = workbook.Worksheets[0].Range["B2:D2"];
var comboBoxControl = formControls.AddComboBox(cellRange);
comboBoxControl.DropDownLines = 3;
comboBoxControl.SourceRange = workbook.Worksheets[0].Range["E2:E6"];
comboBoxControl.SelectedIndex = 1;
vb
Imports DevExpress.Spreadsheet

Dim workbook As New Workbook()
workbook.LoadDocument("Document.xlsx")
Dim cellRange = workbook.Worksheets(0).Range("B2:D2")
Dim comboBoxControl = formControls.AddComboBox(cellRange)
comboBoxControl.DropDownLines = 3
comboBoxControl.SourceRange = workbook.Worksheets(0).Range("E2:E6")
comboBoxControl.SelectedIndex = 1

Note

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

The following code snippets (auto-collected from DevExpress Examples) contain references to the AddComboBox(CellRange) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

winforms-spreadsheetcontrol-api-part-3/CS/SpreadsheetControl_API_Part03/CodeExamples/FormControlActions.cs#L24

csharp
var comboCellRange = workbook.Worksheets[0].Range["B4:C4"];
var comboBoxControl = formControls.AddComboBox(comboCellRange);
comboBoxControl.DropDownLines = 3;

wpf-spreadsheetcontrol-api-part-2/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/FormControlActions.cs#L27

csharp
var comboCellRange = workbook.Worksheets[0].Range["B4:C4"];
var comboBoxControl = formControls.AddComboBox(comboCellRange);
comboBoxControl.DropDownLines = 3;

spreadsheet-document-api-examples-part2/CS/SpreadsheetDocServerAPIPart2/CodeExamples/FormControlActions.cs#L27

csharp
var comboCellRange = workbook.Worksheets[0].Range["B4:C4"];
var comboBoxControl = formControls.AddComboBox(comboCellRange);
comboBoxControl.DropDownLines = 3;

winforms-spreadsheetcontrol-api-part-3/VB/SpreadsheetControl_API_Part03/CodeExamples/FormControlActions.vb#L21

vb
Dim comboCellRange = workbook.Worksheets(CInt((0))).Range("B4:C4")
Dim comboBoxControl = formControls.AddComboBox(comboCellRange)
comboBoxControl.DropDownLines = 3

spreadsheet-document-api-examples-part2/VB/SpreadsheetDocServerAPIPart2/CodeExamples/FormControlActions.vb#L24

vb
Dim comboCellRange = workbook.Worksheets(0).Range("B4:C4")
Dim comboBoxControl = formControls.AddComboBox(comboCellRange)
comboBoxControl.DropDownLines = 3

See Also

FormControlCollection Interface

FormControlCollection Members

DevExpress.Spreadsheet Namespace