Version: 2023.2
LanguageEnglish
  • C#

Button.clicked

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Description

Callback triggered when the button is clicked.

This is a shortcut for modifying Clickable.clicked. It is provided as a convenience. When you add or remove actions from clicked, it adds or removes them from Clickable.clicked automatically.

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

using UnityEngine;
using UnityEngine.UIElements;

public class ButtonClickedExample : MonoBehaviour { public UIDocument uiDocument;

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

uiDocument.rootVisualElement.Add(button); }

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