FloatingWindowclass
Animates the window between its normal bounds and its icon at the bottom of the screen.
Constructors1
Showing 1 constructors
public FloatingWindow()
Create a window without taking keyboard focus away from its contents.
No results match this filter.
Methods12
Showing 12 methods
public void BringToFront()
Raise this window among its siblings without changing keyboard focus or its UI layer.
void—protected virtual int BuildHash()
int—protected virtual void BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder tree)
| Parameter | Type | Description |
|---|---|---|
| tree | RenderTreeBuilder | — |
void—protected virtual string GetRenderTreeChecksum()
string—public void Minimize()
Animate the window into a restore button at the screen edge, keeping its contents alive.
void—public void MoveTo(Vector2 screenPosition)
Move the window to a position in screen pixels, preserving it when its parent changes.
| Parameter | Type | Description |
|---|---|---|
| screenPosition | Vector2 | — |
void—public virtual void OnDeleted()
Remove this window from the minimized row when it is deleted.
void—public virtual void OnLayout(Sandbox.Rect layoutRect)
Apply the saved position and keep the window inside the viewport using its measured size.
| Parameter | Type | Description |
|---|---|---|
| layoutRect | Rect | — |
void—protected virtual void OnMouseDown(Sandbox.UI.MousePanelEvent e)
| Parameter | Type | Description |
|---|---|---|
| e | MousePanelEvent | — |
void—public void RequestClose()
Ask the owner to close the window, or delete it when no handler is supplied.
void—public void Restore()
Animate back to the window's size and position and bring it to the front.
void—public virtual void Tick()
Update viewport limits and raise the window when a child consumes a mouse press.
void—No results match this filter.
Properties11
Showing 11 properties
public bool Sandbox.UI.FloatingWindow.HasBeenDragged { get; set; }
Whether the user has moved this window from its initial placement.
bool—public string Sandbox.UI.FloatingWindow.Icon { get; set; }
The emoji displayed in the titlebar and when this window is minimized.
string—public bool Sandbox.UI.FloatingWindow.IsAnimating { get; set; }
Whether the window is travelling between its expanded position and the minimized row.
bool—public bool Sandbox.UI.FloatingWindow.IsDragging { get; set; }
Whether a titlebar drag is in progress.
bool—public bool Sandbox.UI.FloatingWindow.IsMinimized { get; set; }
Whether this window is showing as an icon at the bottom of the screen.
bool—public bool Sandbox.UI.FloatingWindow.IsThrowing { get; set; }
Whether a thrown window is still moving after the mouse was released.
bool—public bool Sandbox.UI.FloatingWindow.KeepOnScreen { get; set; }
Keep the expanded window within its root panel, including after the viewport or contents resize.
bool—public System.Action Sandbox.UI.FloatingWindow.OnCloseRequested { get; set; }
Handles a close request. When unset, closing deletes the window.
Action—public bool Sandbox.UI.FloatingWindow.ShowCloseButton { get; set; }
Whether the default titlebar includes a close button.
bool—public bool Sandbox.UI.FloatingWindow.ShowMinimizeButton { get; set; }
Whether the titlebar includes a minimize button.
bool—public string Sandbox.UI.FloatingWindow.Title { get; set; }
The text displayed in the default titlebar.
string—No results match this filter.