FormControlCollection.AddLabel(Single, Single, Single, Single) Method

Creates a label form control in the specified worksheet area.

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

LabelFormControl AddLabel(
    float x,
    float y,
    float width,
    float height
)

VB.NET

Function AddLabel(
    x As Single,
    y As Single,
    width As Single,
    height As Single
) As LabelFormControl

Parameters

Name	Type	Description
x	Single	The distance from the left of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.
y	Single	The distance from the top of the worksheet. The ISpreadsheetComponent.Unit property specifies the unit of measurement.
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 labelFormControl = formControls.AddLabel(20, 20, 200, 100);
labelFormControl.PlainText = "Label";

VB.NET

Imports DevExpress.Spreadsheet

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

Dim labelFormControl = formControls.AddLabel(20, 20, 200, 100)
labelFormControl.PlainText = "Label"

Note

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