Table of Contents

Property IsMouseDisabled

Namespace
Terminal.Gui.App
Assembly
Terminal.Gui.dll

IsMouseDisabled

Gets or sets whether the mouse is disabled. The mouse is enabled by default.

bool IsMouseDisabled { get; set; }

Property Value

bool

Remarks

With the built-in ANSI driver, this also disables terminal mouse reporting so native text selection is available. Other drivers only suppress event delivery. To avoid enabling reporting at startup, set this property before Init(string?), or set Application.IsMouseDisabled in configuration applied before the application is created.

Disabling force-releases any mouse grab without raising the cancelable UnGrabbingMouse event (UnGrabbedMouse is still raised), stops hold repetition, clears hover state, and ends dispatch of the current mouse event. GrabMouse(View?) is ignored while the mouse is disabled.

To change this during a session, use the UI thread or Invoke(Action). When set from another thread, the terminal mode changes immediately and the view-state release is queued to the UI thread.

Edit this page