Version: 2023.2+
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 Builder to bind the data source to a UI.
This example demonstrates the following:
You can find the completed files that this example creates in this GitHub repository.
このガイドは、Unity エディター、UI Toolkit、および C# スクリプトに精通している開発者を対象としています。始める前に、以下をよく理解してください。
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, a Vector3
property, and a float
property. The float
property is a read-only property that returns the sum of the x
, y
, and z
values of the Vector3
property. The data source asset also contains a local converter that converts a float
to a Color
and a string
.
Unity で任意のテンプレートでプロジェクトを作成します。
In the Assets
folder of your project, create a C# script named ExampleObject.cs
with the following content:
[!code-cs[(Modules/UIElements/Tests/UIElementsExamples/Assets/ui-toolkit-manual-code-examples/runtime-data-binding/ExampleObject.cs)]
From the menu, select Assets > Create > Example Object. This creates an asset in the Assets
folder of your project.
Rename the asset as 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 VisualElement with a Vector3Field, a FloatField, and a Label as its child elements.
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. Set the data source for the root VisualElement and bind the label
and value
properties of the Vector3Field elements to the vector3Label
and the vector3Value
properties of the data source asset.
Bind the value
property of the Float to the sumOfVector3Properties
property of the data source asset.
Bind the properties of the Label to the properties of the data source asset and apply the type converter for the Label.
In the Hierarchy panel, select the Label.
In the Inspector panel, right-click the Text property and select Add binding.
In the Add Binding window, do the following:
Select Add binding to save your changes.
In the Inspector panel, expand the Background field.
Right-click the Color property and select Add binding.
In the Add Binding window, do the following:
Select Add binding to save your changes.
Save and close UI Builder. Your ExampleObject.uxml
file looks like the following content:
[!code-cs[(Modules/UIElements/Tests/UIElementsExamples/Assets/ui-toolkit-manual-code-examples/runtime-data-binding/ExampleObject.uxml)]
Update the label text of the Vector3Field in the data source asset to see changes replicated in the UI. Update the value of the Vector3 property in the UI to see changes replicated in the data source asset. Move the slider of the danger level in the data source to see changes replicated in the Label.
Assets
folder of your project, select the ExampleObject.asset
file.ExampleObject.asset
changes to the numbers you entered.ExampleObject.asset
, move the Danger Level slider. The text and the background color of the Label in the UI Builder Viewport change according to the value of the Danger Level.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.