s&box docs
API ReferenceSandbox.UI

Popupclass

object→BasePopup→Popup
Namespace
Sandbox.UI
Assembly
Base Library
Declaration
public class Sandbox.UI.Popup : Sandbox.UI.BasePopup

Constructors4

Showing 4 constructors

Methods18

Showing 18 methods

public virtual void Delete(bool immediate = False)PUBLICVIRTUAL

ParameterTypeDescription
immediate = Falsebool—
Returns:void—

public virtual void OnButtonTyped(Sandbox.UI.ButtonEvent e)PUBLICVIRTUAL

Keys the popup doesn't use go to the panel that opened it, and up its tree from there - a popup floats in the root, or in a window of its own, so its parent chain isn't its owner's.

ParameterTypeDescription
eButtonEvent—
Returns:void—

Properties17

Showing 17 properties

public System.Nullable`1<Sandbox.Rect> Sandbox.UI.Popup.AnchorRect { get; set; }PUBLICGETSET

Optional anchor in the source surface's pixels, for a caret or other part of a panel. Anchored popups flip above or below this rectangle to fit the available space.

Returns:Nullable<Rect>—

public bool Sandbox.UI.Popup.IgnoresInput { get; set; }PUBLICGETSETINGEST

Whether a popup window lets mouse and keyboard input pass through, like a tooltip. Set before opening the popup.

Returns:bool—

public bool Sandbox.UI.Popup.TakesKeyboardFocus { get; set; }PUBLICGETSET

Whether a popup window receives keyboard input instead of its source window. Disable this for suggestions that should leave typing in the original text entry.

Returns:bool—

PointerEvents

Previous Page

AnchorRect

Next Page

On this page

Constructorspublic Popup()public Popup()public Popup(Sandbox.UI.Panel sourcePanel, Sandbox.UI.Popup.PositionMode position, System.Single offset)public Popup(Sandbox.UI.Panel sourcePanel, Sandbox.UI.Popup.PositionMode position, System.Single offset)Methodspublic Sandbox.UI.Panel AddOption(System.String text, System.Action action = null)public Sandbox.UI.Panel AddOption(System.String text, System.Action action = null)public Sandbox.UI.Panel AddOption(System.String text, System.String icon, System.Action action = null)public Sandbox.UI.Panel AddOption(System.String text, System.String icon, System.Action action = null)public virtual System.Void Delete(System.Boolean immediate = False)public System.Void Failure()public System.Void Failure()public System.Void MoveSelection(System.Int32 dir)public System.Void MoveSelection(System.Int32 dir)public virtual System.Void OnButtonTyped(Sandbox.UI.ButtonEvent e)public virtual System.Void OnLayout(Sandbox.Rect layoutRect)public virtual System.Void OnLayout(Sandbox.Rect layoutRect)public System.Void SetPositioning(Sandbox.UI.Panel sourcePanel, Sandbox.UI.Popup.PositionMode position, System.Single offset)public System.Void SetPositioning(Sandbox.UI.Panel sourcePanel, Sandbox.UI.Popup.PositionMode position, System.Single offset)public System.Void Success()public System.Void Success()public virtual System.Void Tick()public virtual System.Void Tick()Propertiespublic System.Nullable`1<Sandbox.Rect> Sandbox.UI.Popup.AnchorRect { get; set; }public System.Boolean Sandbox.UI.Popup.CloseWhenParentIsHidden { get; set; }public System.Boolean Sandbox.UI.Popup.CloseWhenParentIsHidden { get; set; }public System.String Sandbox.UI.Popup.Icon { get; set; }public System.String Sandbox.UI.Popup.Icon { get; set; }public System.Boolean Sandbox.UI.Popup.IgnoresInput { get; set; }public Sandbox.UI.Panel Sandbox.UI.Popup.PopupSource { get; set; }public Sandbox.UI.Panel Sandbox.UI.Popup.PopupSource { get; set; }public System.Single Sandbox.UI.Popup.PopupSourceOffset { get; set; }public System.Single Sandbox.UI.Popup.PopupSourceOffset { get; set; }public Sandbox.UI.Popup.PositionMode Sandbox.UI.Popup.Position { get; set; }public Sandbox.UI.Popup.PositionMode Sandbox.UI.Popup.Position { get; set; }public Sandbox.UI.Panel Sandbox.UI.Popup.SelectedChild { get; set; }public Sandbox.UI.Panel Sandbox.UI.Popup.SelectedChild { get; set; }public System.Boolean Sandbox.UI.Popup.TakesKeyboardFocus { get; set; }public System.String Sandbox.UI.Popup.Title { get; set; }public System.String Sandbox.UI.Popup.Title { get; set; }Metadata