FormControlCollection.AddLabel(Cell, Single, Single) Method

Creates a label form control so that the top left corner of the label is located at the specified cell.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

LabelFormControl AddLabel(
    Cell topLeftCell,
    float width,
    float height
)

VB.NET

Function AddLabel(
    topLeftCell As Cell,
    width As Single,
    height As Single
) As LabelFormControl

Parameters

Name	Type	Description
topLeftCell	Cell	A cell where the top left corner of the form control is located.
width	Single	The form control width.
height	Single	The form control height.

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 topLeftCell = workbook.Worksheets[0].Cells["B2"];
var labelFormControl = formControls.AddLabel(topLeftCell, 200, 100);
labelFormControl.PlainText = "Label";

VB.NET

Imports DevExpress.Spreadsheet

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

Dim topLeftCell = workbook.Worksheets(0).Cells("B2")
Dim labelFormControl = formControls.AddLabel(topLeftCell, 200,100)
labelFormControl.PlainText = "Label"

Note

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