s&box docs
API ReferenceEditor

Buttonclass

A simple button widget.

object→Widget→Button
Namespace
Editor
Assembly
Sandbox.Tools
Declaration
public class Editor.Button : Editor.Widget

Constructors3

Showing 3 constructors

Methods7

Showing 7 methods

protected virtual void OnClicked()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnPaint()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnPressed()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnReleased()PROTECTEDVIRTUAL

Returns:void—

protected virtual void OnToggled()PROTECTEDVIRTUAL

Returns:void—

public void SetIcon(Editor.Pixmap pixmap)PUBLIC

Sets an icon for the button via a raw image.

ParameterTypeDescription
pixmapPixmap—
Returns:void—

Properties5

Showing 5 properties

public string Editor.Button.Icon { get; set; }PUBLICGETSET

Sets an icon for the button via a filepath.

Returns:string—

public bool Editor.Button.IsChecked { get; set; }PUBLICGETSET

Whether this button is checked. See `Editor.Button.IsToggle`.

Returns:bool—

public bool Editor.Button.IsToggle { get; set; }PUBLICGETSET

Whether this button can be toggled on or off. See `Editor.Button.IsChecked`.

Returns:bool—

public string Editor.Button.Text { get; set; }PUBLICGETSET

Text on the button.

Returns:string—

public Color Editor.Button.Tint { get; set; }PUBLICGETSET

The tint of the button color

Returns:Color—

Related Guides

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

GetDescription()

Previous Page

Icon

Next Page

On this page

Constructorspublic Button(Editor.Widget parent = null)public Button(System.String title, Editor.Widget parent = null)public Button(System.String title, System.String icon, Editor.Widget parent = null)Methodspublic Editor.Pixmap GetIcon()protected virtual System.Void OnClicked()protected virtual System.Void OnPaint()protected virtual System.Void OnPressed()protected virtual System.Void OnReleased()protected virtual System.Void OnToggled()public System.Void SetIcon(Editor.Pixmap pixmap)Propertiespublic System.String Editor.Button.Icon { get; set; }public System.Boolean Editor.Button.IsChecked { get; set; }public System.Boolean Editor.Button.IsToggle { get; set; }public System.String Editor.Button.Text { get; set; }public Color Editor.Button.Tint { get; set; }Metadata