FormControlCollection.AddScrollbar(Single, Single, Single, Single) Method

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

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

NuGet Package : DevExpress.Spreadsheet.Core

Declaration

C#
VB.NET

csharp

ScrollbarFormControl AddScrollbar(
    float x,
    float y,
    float width,
    float height
)

Function AddScrollbar(
    x As Single,
    y As Single,
    width As Single,
    height As Single
) As ScrollbarFormControl

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
ScrollbarFormControl

The scrollbar form control.

Remarks

Example

The code sample below creates a scrollbar form control:

C#
VB.NET

csharp

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

var formControls = workbook.Worksheets[0].FormControls;

var scrollbarFormControl = formControls.AddScrollbar(20, 20, 600, (float)topLeftCell.RowHeight);
scrollbarFormControl.Min = 2;
scrollbarFormControl.Max = 15;
scrollbarFormControl.LargeChange = 10;
scrollbarFormControl.SmallChange = 1;

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

Dim formControls = workbook.Worksheets(0).FormControls

Dim scrollbarFormControl = formControls.AddScrollbar(20, 20, 600, CSng(topLeftCell.RowHeight))
scrollbarFormControl.Min = 2
scrollbarFormControl.Max = 15
scrollbarFormControl.LargeChange = 10
scrollbarFormControl.SmallChange = 1

Note

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