Class OverlayWindow

Namespace

SharpConsoleUI.Windows

Assembly

SharpConsoleUI.dll

Specialized full-screen overlay window for menus, popups, and modal overlays. Automatically handles click-outside-to-dismiss and background dimming.

public class OverlayWindow : Window, IContainer

Inheritance

object

Window

OverlayWindow

Implements

IContainer

Inherited Members

Window.Renderer

Window.Activated

Window.Deactivated

Window.KeyPressed

Window.OnClosed

Window.OnClosing

Window.OnResize

Window.OnShown

Window.StateChanged

Window.UnhandledMouseClick

Window.ActiveBorderForegroundColor

Window.ActiveTitleForegroundColor

Window.BackgroundColor

Window.ForegroundColor

Window.GetConsoleWindowSystem

Window.Guid

Window.Height

Window.InactiveBorderForegroundColor

Window.InactiveTitleForegroundColor

Window.IsClosable

Window.ShowCloseButton

Window.IsMaximizable

Window.IsMinimizable

Window.IsContentVisible

Window.IsDirty

Window.IsDragging

Window.IsMovable

Window.IsResizable

Window.IsScrollable

Window.AlwaysOnTop

Window.RenderLock

Window.Left

Window.Mode

Window.OriginalHeight

Window.OriginalLeft

Window.OriginalTop

Window.OriginalWidth

Window.ParentWindow

Window.ScrollOffset

Window.State

Window.Tag

Window.Title

Window.Name

Window.AsyncThreadCleanupTimeout

Window.Top

Window.TotalLines

Window.Width

Window.ZIndex

Window.BorderStyle

Window.ShowTitle

Window.AddControl(IWindowControl)

Window.ClearControls()

Window.TryClose(bool)

Window.Close(bool)

Window.ContainsControl(IWindowControl)

Window.GetContentFromDesktopCoordinates(Point?)

Window.GetControlByIndex(int)

Window.GetControlByTag<T>(string)

Window.FindControl<T>(string)

Window.FindControl(string)

Window.GetNamedControls()

Window.GetControls()

Window.GetControlsByType<T>()

Window.GetControlsCount()

Window.GetIsActive()

Window.GoToBottom()

Window.GoToTop()

Window.ScrollToControl(IWindowControl)

Window.Invalidate(bool, IWindowControl)

Window.ForceRebuildLayout()

Window.GetVisibleHeightForControl(IWindowControl)

Window.NotifyControlFocusLost(IInteractiveControl)

Window.NotifyControlGainedFocus(IInteractiveControl)

Window.NotifyControlLostFocus(IInteractiveControl)

Window.FocusControl(IInteractiveControl)

Window.RemoveContent(IWindowControl)

Window.RenderAndGetVisibleContent(List<Rectangle>)

Window.GetLayoutNode(IWindowControl)

Window.CreatePortal(IWindowControl, IWindowControl)

Window.RemovePortal(IWindowControl, LayoutNode)

Window.RootLayoutNode

Window.UseDOMLayout

Window.Maximize(bool)

Window.Minimize(bool)

Window.Restore()

Window.SetIsActive(bool)

Window.SetPosition(Point)

Window.SetSize(int, int)

Window.SwitchFocus(bool)

Window.UnfocusCurrentControl()

Window.UpdateContentOrder(IWindowControl, int)

Window.WindowIsAdded()

Window.OnKeyPressed(ConsoleKeyInfo, bool)

Window.OnStateChanged(WindowState)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OverlayWindow(ConsoleWindowSystem)

Initializes a new OverlayWindow that covers the desktop area (but not status bars).

public OverlayWindow(ConsoleWindowSystem windowSystem)

Parameters

windowSystem ConsoleWindowSystem

The console window system.

Methods

CloseAndInvalidate()

Closes the overlay and forces full screen redraw.

public void CloseAndInvalidate()

Dismiss()

Dismisses the overlay by invoking callbacks and closing with invalidation.

public void Dismiss()

SetDismissOnClickOutside(bool, Action?)

Enables/disables click-outside-to-dismiss behavior.

public void SetDismissOnClickOutside(bool enable, Action? onDismiss = null)

Parameters

enable bool

True to enable dismissal on outside clicks.

onDismiss Action

Optional callback invoked when overlay is dismissed.

SetOverlayBackground(Color)

Sets the background color for the overlay (typically dark/dimmed).

public void SetOverlayBackground(Color color)

Parameters

color Color

The background color.