Table of Contents

Property MouseHoldRepeat

Namespace
Terminal.Gui.ViewBase
Assembly
Terminal.Gui.dll

MouseHoldRepeat

Gets or sets which mouse event triggers command invocation during continuous button press. When set to a non-null value and the user presses and holds the mouse button, NewMouseEvent(Mouse) will be repeatedly called, enabling repeating button behavior.

public MouseFlags? MouseHoldRepeat { get; set; }

Property Value

MouseFlags?

Remarks

Valid values are:

<ul><li><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> - Disabled (default)</li><li><xref href="Terminal.Gui.Input.MouseFlags.LeftButtonPressed" data-throw-if-not-resolved="false"></xref> - Commands invoked on Press during hold</li><li><xref href="Terminal.Gui.Input.MouseFlags.LeftButtonReleased" data-throw-if-not-resolved="false"></xref> - Commands invoked on Released during hold</li><li><xref href="Terminal.Gui.Input.MouseFlags.LeftButtonClicked" data-throw-if-not-resolved="false"></xref> - Commands invoked on Click after hold</li><li>Other xxxReleased or xxxClicked flags for other mouse buttons</li></ul>

When enabled, pressing the mouse button starts a timer that periodically invokes the Activate command bound to the specified mouse event, enabling auto-repeat behavior (e.g., scrollbar arrows, spin buttons).