Table of Contents

Class SpinnerView

Namespace
Terminal.Gui
Assembly
Terminal.Gui.dll

A View which displays (by default) a spinning line character.

public class SpinnerView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize, IDesignable
Inheritance
SpinnerView
Implements
Inherited Members

Remarks

By default animation only occurs when you call AdvanceAnimation(bool). Use AutoSpin to make the automate calls to AdvanceAnimation(bool).

Constructors

SpinnerView()

Creates a new instance of the SpinnerView class.

Properties

AutoSpin

Gets or sets whether spinning should occur automatically or be manually triggered (e.g. from a background task).

HasSpecialCharacters

Gets whether the current spinner style contains emoji or other special characters. Does not check Custom sequences.

IsAsciiOnly

Gets whether the current spinner style contains only ASCII characters. Also checks Custom sequences.

Sequence

Gets or sets the animation frames used to animate the spinner.

SpinBounce

Gets or sets whether spinner should go back and forth through the frames rather than going to the end and starting again at the beginning.

SpinDelay

Gets or sets the number of milliseconds to wait between characters in the animation.

SpinReverse

Gets or sets whether spinner should go through the frames in reverse order. If SpinBounce is true, this sets the starting order.

Style

Gets or sets the Style used to animate the spinner.

Methods

AdvanceAnimation(bool)

Advances the animation frame and notifies main loop that repainting needs to happen. Repeated calls are ignored based on SpinDelay.

Dispose(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

OnClearingViewport()

Called when the Viewport is to be cleared.

OnDrawingContent()

Called when the View's content is to be drawn. The default implementation does nothing.

Render()

Renders the current frame of the spinner.