Table of Contents

Class ScrollButton

Namespace
Terminal.Gui.Views
Assembly
Terminal.Gui.dll

A Button used to scroll content forward or backward. It enables mouse hold-repeat for continuous scrolling when the mouse button is held down. The button displays an arrow glyph determined by the combination of Direction and Orientation:

OrientationDirectionGlyph
HorizontalBackward LeftArrow
HorizontalForward RightArrow
VerticalBackward UpArrow
VerticalForward DownArrow
public class ScrollButton : Button, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable, IAcceptTarget, IOrientation
Inheritance
ScrollButton
Implements
Inherited Members
Extension Methods

Remarks

By default, ScrollButton cannot receive focus and does not participate in keyboard navigation; override this by setting CanFocus to true if desired.

Constructors

ScrollButton()

Initializes a new instance of the ScrollButton class.

Properties

Direction

Gets or sets the direction this ScrollButton scrolls.

Orientation

Gets or sets the Orientation for this ScrollButton. The default is Horizontal.

Methods

OnInitializingShadowStyle(ValueChangingEventArgs<ShadowStyles?>)

Called before the Button's initial ShadowStyle is applied during construction. Override to change or suppress the default shadow — set NewValue to the desired style, or set Handled to true to skip applying any shadow.

OnOrientationChanged(Orientation)

Called when Orientation has changed.

Events

OrientationChanged

Raised when Orientation has changed.

OrientationChanging

Raised when Orientation is changing. Can be cancelled.