Version: 6000.0+
Want to learn how to create runtime data binding? Use this example to get started. This example creates a data source asset and uses UI(User Interface) Allows a user to interact with your application. Unity currently supports three UI systems. More info
See in Glossary Builder to bind the data source to a UI.
To set a runtime binding in UI Builder:
This example creates a data source asset that contains a string property, and binds it to the Text property of a Label control in UI Builder. When you change the string property in the data source asset, the text of the label changes.
You can find the completed files that this example creates in this GitHub repository.
This guide is for developers familiar with the Unity Editor, UI Toolkit, and C# scripting. Before you start, get familiar with the following:
Create a data source asset that contains the properties you want to bind to. In this example, you create a ScriptableObject
asset named ExampleObject
that contains a string
property.
Assets
folder of your project, create a C# script named ExampleObject.cs
with the following content:using Unity.Properties;
using UnityEngine;
using UnityEngine.UIElements;
#if UNITY_EDITOR
using UnityEditor;
#endif
[CreateAssetMenu]
public class ExampleObject : ScriptableObject
{
[Header("Simple binding")]
public string simpleLabel = "Hello World!";
}
Assets
folder of your project.ExampleObject.asset
.Create a UI that binds to the data source asset you created in the previous step. In this example, you create a UXML file that contains a Label.
Assets
folder of your project, create a UXML file named ExampleObject.uxml
.ExampleObject.uxml
file to open it in UI Builder.Bind the UI to the data source asset you created in the previous step.
In the Inspector panel of the Label, from the Bindings > Data Source > Object list, select ExampleObject.
In the Data Source Path list, select simpleLabel.
Right-click the Text property and select Add binding.
From the Binding Mode list, select To Target. This updates the UI when the data source changes.
From the Advanced Settings > Update Trigger list, select On Source Changed, which is the default setting. This updates the UI when the data source changes.
Select Add binding to apply your changes.
Save and close UI Builder. Your ExampleObject.uxml
file looks like the following:
<engine:UXML xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:engine="UnityEngine.UIElements"
xmlns:editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False">
<engine:Label text="Label" data-source="ExampleObject.asset" data-source-path="simpleLabel">
<Bindings>
<engine:DataBinding property="text" binding-mode="ToTarget" />
</Bindings>
</engine:Label>
</engine:UXML>
Update the label text of the LabelText in the data source asset and check changes replicated in the UI.
Assets
folder of your project, select ExampleObject.asset
.Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.