FormControlCollection.AddScrollbar(Cell, Single, Single) Method

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

Namespace: DevExpress.Spreadsheet

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

NuGet Package: DevExpress.Spreadsheet.Core

Declaration

C#

ScrollbarFormControl AddScrollbar(
    Cell topLeftCell,
    float width,
    float height
)

VB.NET

Function AddScrollbar(
    topLeftCell As Cell,
    width As Single,
    height As Single
) As ScrollbarFormControl

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
ScrollbarFormControl	The scrollbar form control.

Remarks

Example

The code sample below creates a scrollbar form control:

C#

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

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

var topLeftCell = workbook.Worksheets[0].Cells["B2"];
var scrollbarFormControl = formControls.AddScrollbar(topLeftCell, 600, (float)topLeftCell.RowHeight);
scrollbarFormControl.Min = 2;
scrollbarFormControl.Max = 15;
scrollbarFormControl.LargeChange = 10;
scrollbarFormControl.SmallChange = 1;

VB.NET

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

Dim formControls = workbook.Worksheets(0).FormControls

Dim topLeftCell = workbook.Worksheets(0).Cells("B2")
Dim scrollbarFormControl = formControls.AddScrollbar(topLeftCell, 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.