s&box docs
API ReferenceSandbox.UI

Buttonclass

A simple button `Sandbox.UI.Panel`.

object→Panel→Button
Namespace
Sandbox.UI
Assembly
Base Library
Declaration
public class Sandbox.UI.Button : Sandbox.UI.Panel

Constructors10

Showing 10 constructors

Methods25

Showing 25 methods

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

ParameterTypeDescription
eButtonEvent—
Returns:void—

Properties17

Showing 17 properties

public Sandbox.Texture Sandbox.UI.Button.IconTexture { get; set; }PUBLICGETSET

Texture displayed in place of the icon glyph. Set to null to show `Sandbox.UI.Button.Icon` again. The texture is owned by the caller, and is not disposed when this button is deleted.

Returns:Texture—

Related Guides

→Custom Editors→Editor Tools→Editor Widgets→Events→Input→Razor Components

Box.ctor()

Previous Page

Active

Next Page

On this page

Constructorspublic Button()public Button()public Button(System.String text, System.Action action = null)public Button(System.String text, System.Action action = null)public Button(System.String text, System.String icon, System.Action onClick)public Button(System.String text, System.String icon, System.Action onClick)public Button(System.String text, System.String icon, System.String className, System.Action onClick)public Button(System.String text, System.String icon, System.String className, System.Action onClick)public Button(System.String text, System.String icon)public Button(System.String text, System.String icon)Methodsprotected virtual System.Int32 BuildHash()protected virtual System.Int32 BuildHash()protected virtual System.Void BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder tree)protected virtual System.Void BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder tree)public System.Void Click()public System.Void Click()public System.Void DeleteIcon()public System.Void DeleteIcon()public System.Void DeleteText()public System.Void DeleteText()protected virtual System.String GetRenderTreeChecksum()protected virtual System.String GetRenderTreeChecksum()public virtual System.Void OnButtonTyped(Sandbox.UI.ButtonEvent e)protected virtual System.Void OnMouseDown(Sandbox.UI.MousePanelEvent e)protected virtual System.Void OnMouseDown(Sandbox.UI.MousePanelEvent e)public virtual System.Void SetContent(System.String value)public virtual System.Void SetContent(System.String value)public virtual System.Void SetProperty(System.String name, System.String value)public virtual System.Void SetProperty(System.String name, System.String value)public virtual System.Void SetText(System.String text)public virtual System.Void SetText(System.String text)public virtual System.Void Tick()public virtual System.Void Tick()protected System.Void UpdateActiveState()protected System.Void UpdateActiveState()Propertiespublic System.Boolean Sandbox.UI.Button.Active { get; set; }public System.Boolean Sandbox.UI.Button.Active { get; set; }public System.Boolean Sandbox.UI.Button.Disabled { get; set; }public System.Boolean Sandbox.UI.Button.Disabled { get; set; }public System.String Sandbox.UI.Button.Help { get; set; }public System.String Sandbox.UI.Button.Help { get; set; }public Microsoft.AspNetCore.Components.RenderFragment Sandbox.UI.Button.HoverMenu { get; set; }public Microsoft.AspNetCore.Components.RenderFragment Sandbox.UI.Button.HoverMenu { get; set; }public System.String Sandbox.UI.Button.Href { get; set; }public System.String Sandbox.UI.Button.Href { get; set; }public System.String Sandbox.UI.Button.Icon { get; set; }public System.String Sandbox.UI.Button.Icon { get; set; }public Sandbox.Texture Sandbox.UI.Button.IconTexture { get; set; }public System.String Sandbox.UI.Button.Text { get; set; }public System.String Sandbox.UI.Button.Text { get; set; }public virtual System.Object Sandbox.UI.Button.Value { get; set; }public virtual System.Object Sandbox.UI.Button.Value { get; set; }Metadata