GrapeCity.Documents.Excel.Forms.IScrollBar

IScrollBar Interface

Represents a scrollbar form control.

An IScrollBar lets users select an integer value within a range on a worksheet. It extends IRangeBase, so it supports minimum and maximum bounds, the current value, and small and large change increments. The control can be displayed horizontally or vertically.

Namespace: GrapeCity.Documents.Excel.Forms

Assembly: DS.Documents.Excel.dll

Syntax

public interface IScrollBar : IControl<IScrollBar>, IRangeBase, ICellLinkControl<int>, ICellLinkControl, IControl

Public Interface IScrollBar
    Inherits IControl(Of IScrollBar), IRangeBase, ICellLinkControl(Of Integer), ICellLinkControl, IControl

Examples

IScrollBar scrollBar = worksheet.Controls.AddScrollBar(50, 20, 120, 20);
scrollBar.Min = 0;
scrollBar.Max = 100;
scrollBar.LargeChange = 10;
scrollBar.Orientation = FormControlOrientation.Horizontal;

Properties

Name Description

Name	Description
LargeChange	Gets or sets the amount that is added to or subtracted from the value of a range-based control. When the user clicks the track of a `ScrollBar`, the value of the control increases or decreases by the value of LargeChange.
Orientation	Gets or sets whether the `IScrollBar` is displayed horizontally or vertically. The returned value indicates the current orientation of the scroll bar. The default value depends on the initial width and height that is used to create this control. If width `>` height, the default value is `FormControlOrientation.Horizontal`. Otherwise, the default value is `FormControlOrientation.Vertical`.

LargeChange

Gets or sets the amount that is added to or subtracted from the value of a range-based control.

When the user clicks the track of a ScrollBar, the value of the control increases or decreases by the value of LargeChange.

Orientation

Gets or sets whether the IScrollBar is displayed horizontally or vertically.

The returned value indicates the current orientation of the scroll bar. The default value depends on the initial width and height that is used to create this control. If width > height, the default value is FormControlOrientation.Horizontal. Otherwise, the default value is FormControlOrientation.Vertical.