Legacy Documentation: Version 5.6 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

InputField.onValidateInput

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 var onValidateInput: UI.InputField.OnValidateInput;
public UI.InputField.OnValidateInput onValidateInput;

Description

The function to call to validate the input characters.

#pragma strict
// Required when Using UI elements.
public class Example {
    public var mainInputField;
    public function Start() {
        // Sets the MyValidate method to invoke after the input field's default input validation invoke (default validation happens every time a character is entered into the text field.)
        mainInputField.onValidateInput += function() {
            return MyValidate(addedChar);
        };
    }
    private function MyValidate(charToValidate) {
        //Checks if a dollar sign is entered....
        if (charToValidate == '$') {
            // ... if it is change it to an empty character.
            charToValidate = '\0';
        }
        return charToValidate;
    }
}
using UnityEngine;
using System.Collections;
using UnityEngine.UI; // Required when Using UI elements.

public class Example : MonoBehaviour { public InputField mainInputField;

public void Start() { // Sets the MyValidate method to invoke after the input field's default input validation invoke (default validation happens every time a character is entered into the text field.) mainInputField.onValidateInput += delegate(string input, int charIndex, char addedChar) { return MyValidate(addedChar); }; }

private char MyValidate(char charToValidate) { //Checks if a dollar sign is entered.... if (charToValidate == '$') { // ... if it is change it to an empty character. charToValidate = '\0'; } return charToValidate; } }