FormControlCollection.AddLabel(CellRange) Method

Creates a label form control at the specified cell range.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

LabelFormControl AddLabel(
    CellRange targetRange
)

VB.NET

Function AddLabel(
    targetRange As CellRange
) As LabelFormControl

Parameters

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

Returns

Type	Description
LabelFormControl	The label form control.

Remarks

Example

The code sample below creates a label form control:

C#

using DevExpress.Spreadsheet;

Workbook workbook = new Workbook();
workbook.LoadDocument("Document.xlsx");

var cellRange = workbook.Worksheets[0].Range["B2:C2"];
var labelFormControl = formControls.AddLabel(cellRange);
labelFormControl.PlainText = "Label";

VB.NET

Imports DevExpress.Spreadsheet

Dim workbook As New Workbook()
workbook.LoadDocument("Document.xlsx")

Dim cellRange = workbook.Worksheets(0).Range("B2:C2")
Dim labelFormControl = formControls.AddLabel(cellRange)
labelFormControl.PlainText = "Label"

Note

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