s&box docs
API ReferenceSandbox.UI

Buttonclass

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

Constructors5

Showing 5 constructors

Methods12

Showing 12 methods

protected virtual int BuildHash()PROTECTEDVIRTUAL

Returns:int—

protected virtual void BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder tree)PROTECTEDVIRTUAL

ParameterTypeDescription
treeRenderTreeBuilder—
Returns:void—

public void Click()PUBLIC

Returns:void—

public void DeleteIcon()PUBLIC

Returns:void—

public void DeleteText()PUBLIC

Returns:void—

protected virtual string GetRenderTreeChecksum()PROTECTEDVIRTUAL

Returns:string—

public virtual void SetContent(string value)PUBLICVIRTUAL

ParameterTypeDescription
valuestring—
Returns:void—

public virtual void SetProperty(string name, string value)PUBLICVIRTUAL

ParameterTypeDescription
namestring—
valuestring—
Returns:void—

public virtual void SetText(string text)PUBLICVIRTUAL

ParameterTypeDescription
textstring—
Returns:void—

public virtual void Tick()PUBLICVIRTUAL

Returns:void—

protected void UpdateActiveState()PROTECTEDPER-FRAME

Returns:void—

Properties8

Showing 8 properties

public bool Sandbox.UI.Button.Active { get; set; }PUBLICGETSET

Returns:bool—

public bool Sandbox.UI.Button.Disabled { get; set; }PUBLICGETSET

Returns:bool—

public string Sandbox.UI.Button.Help { get; set; }PUBLICGETSET

Returns:string—

public Microsoft.AspNetCore.Components.RenderFragment Sandbox.UI.Button.HoverMenu { get; set; }PUBLICGETSET

Returns:RenderFragment—

public string Sandbox.UI.Button.Href { get; set; }PUBLICGETSET

Returns:string—

public string Sandbox.UI.Button.Icon { get; set; }PUBLICGETSET

Returns:string—

public string Sandbox.UI.Button.Text { get; set; }PUBLICGETSET

Returns:string—

public virtual object Sandbox.UI.Button.Value { get; set; }PUBLICVIRTUALGETSET

Returns:object—

Related Guides

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

Deconstruct()

Previous Page

Active

Next Page

On this page

Constructorspublic Button()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.String className, System.Action onClick)public Button(System.String text, System.String icon)Methodsprotected virtual System.Int32 BuildHash()protected virtual System.Void BuildRenderTree(Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder tree)public System.Void Click()public System.Void DeleteIcon()public System.Void DeleteText()protected virtual System.String GetRenderTreeChecksum()protected virtual System.Void OnMouseDown(Sandbox.UI.MousePanelEvent e)public virtual System.Void SetContent(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 Tick()protected System.Void UpdateActiveState()Propertiespublic System.Boolean Sandbox.UI.Button.Active { get; set; }public System.Boolean Sandbox.UI.Button.Disabled { get; set; }public System.String Sandbox.UI.Button.Help { 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.Icon { get; set; }public System.String Sandbox.UI.Button.Text { get; set; }public virtual System.Object Sandbox.UI.Button.Value { get; set; }Metadata