Button

Description

Represents an interactive UI button element.

A Button has a text label element that can respond to pointer and mouse events. You can add an icon to pair it with the text by assigning a Background (Texture, RenderTexture, Sprite or Vector Image) to the iconImage API or icon-image UXML property. Please note that by providing an icon image, this will automatically update the Button's hierarchy to contain an Image and a text label element.

By default, a single left mouse click activates the Button's Clickable property button. To remove this activator, or add more activators, modify the clickable.activators property. For details, see ManipulatorActivationFilter.

To bind a Button's text value to the contents of a variable, set the binding-path property in the UXML file, or the bindingPath property in the C# code, to a string that contains the variable name.

For more information, refer to UXML element Button.

Additional resources: Clickable, Image, ManipulatorActivationFilter

The following is a simple example of how to use a button. Using the clicked event to print a message to the console when the button is clicked.

using UnityEngine;
using UnityEditor;
using UnityEngine.UIElements;

public class ButtonExample : EditorWindow
{
    [MenuItem("Window/Button Example")]
    public static void ShowExample()
    {
        GetWindow<ButtonExample>();
    }

    void CreateGUI()
    {
        var button = new Button { text = "Click me" };
        button.clicked += OnClick;

        rootVisualElement.Add(button);
    }

    void OnClick()
    {
        Debug.Log("Clicked!");
    }
}

Static Properties

Properties

Constructors

Events

Inherited Members