Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Button.OnSubmit

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

public method OnSubmit(eventData: EventSystems.BaseEventData): void;
public void OnSubmit(EventSystems.BaseEventData eventData);

Parameters

eventData Data passed in (Typically by the event system).

Description

Registered ISubmitHandler callback.

This detects when a Button has been selected via a "submit" key you specify (default is the return key).

To change the submit key, either:

1. Go to Edit >Project Settings >Input.

2. Next, expand the Axes section and go to the Submit section if it exists.

3. If Submit doesn’t exist, add 1 number to the Size field. This creates a new section at the bottom. Expand the new section and change the Name field to “Submit”.

4. Change the Positive Button field to the key you want (e.g. space).

Or:

1. Go to your EventSystem in your Project

2. Go to the Inspector window and change the Submit Button field to one of the sections in the Input Manager (e.g. "Submit"), or create your own by naming it what you like, then following the next few steps.

3. Go to Edit >Project Settings >Input to get to the Input Manager.

4. Expand the Axes section in the Inspector window. Add 1 to the number in the Size field. This creates a new section at the bottom.

5. Expand the new section and name it the same as the name you inserted in the Submit Button field in the EventSystem. Set the Positive Button field to the key you want (e.g. space).

no example available in JavaScript
//Create a UI element by going to Create >UI and choose one of the visible items(Image, Button, Panel etc.) from the list. This script gives the GameObject a Button-like behaviour.
//Attach this script to the UI GameObject

using UnityEngine; using UnityEngine.UI; using UnityEngine.EventSystems;

public class ButtonOnSubmit : Button { //Press enter on the Button GameObject to trigger this Event public override void OnSubmit(BaseEventData eventData) { //Output that the Button is in the submit stage Debug.Log("Submitted!"); } }

Did you find this page useful? Please give it a rating: