Package com.grapecity.documents.excel.forms

Interface IScrollBar

All Superinterfaces:

ICellLinkControl, ICellLinkControlT<Integer>, IControl, IControlT<IScrollBar>, IRangeBase

public interface IScrollBar
extends IControlT<IScrollBar>, IRangeBase

The scrollbar control.

Method Summary

Modifier and Type	Method	Description
int	getLargeChange()	Gets a value to be added to or subtracted from the value of a RangeBase control.
FormControlOrientation	getOrientation()	Gets whether the IScrollBar is displayed horizontally or vertically.
void	setLargeChange(int value)	Sets a value to be added to or subtracted from the value of a RangeBase control.
void	setOrientation(FormControlOrientation value)	Sets whether the IScrollBar is displayed horizontally or vertically.

Methods inherited from interface com.grapecity.documents.excel.forms.ICellLinkControl

getDisplay3DShading, getLinkedCell, setDisplay3DShading, setLinkedCell

Methods inherited from interface com.grapecity.documents.excel.forms.ICellLinkControlT

getValue, setValue

Methods inherited from interface com.grapecity.documents.excel.forms.IControl

bringToFront, delete, getBottomRightCell, getEnabled, getFormControlType, getHeight, getLeft, getLocked, getName, getParent, getPlacement, getPrintObject, getShapeRange, getTop, getTopLeftCell, getVisible, getWidth, getZOrder, sendToBack, setEnabled, setHeight, setLeft, setLocked, setName, setPlacement, setPrintObject, setTop, setVisible, setWidth

Methods inherited from interface com.grapecity.documents.excel.forms.IControlT

copy, cut, duplicate

Methods inherited from interface com.grapecity.documents.excel.forms.IRangeBase

getMax, getMin, getSmallChange, setMax, setMin, setSmallChange

Method Details

getLargeChange

int getLargeChange()

Gets a value to be added to or subtracted from the value of a RangeBase control. When the user clicks the Track of a ScrollBar, the Value property increases or decreases by the value of LargeChange.

Returns:

[0, 30000]

setLargeChange

void setLargeChange(int value)

Sets a value to be added to or subtracted from the value of a RangeBase control. When the user clicks the Track of a ScrollBar, the Value property increases or decreases by the value of LargeChange.

Parameters:

value - [0,30000]

getOrientation

FormControlOrientation getOrientation()

Gets whether the IScrollBar is displayed horizontally or vertically.

Returns:

The default value depends on the initial width and height that is used to create this control.If width > height then the default value is FormControlOrientation.Horizontal. Otherwise, FormControlOrientation.Vertical .

setOrientation

void setOrientation(FormControlOrientation value)

Sets whether the IScrollBar is displayed horizontally or vertically.