Create a bindable custom control

Version: 2023.2+

This example demonstrates how to create a bindable custom control in a custom Editor window.

Example overview

This example creates a custom control bound to a property with the double data type. You can adapt this example to bind to properties with other data types such as a string or an integer.

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:

• UI Builder
• Visual Tree
• UXML
• SerializedObject data binding

Create the custom control class

Create a C# class to define the custom control.

1. Create a Unity project with any template.
2. Create a folder named ExampleField to store your files.
3. In the ExampleField folder, create a C# script named ExampleField.cs and replace its content with the following:

[!code-cs]

Use the custom control in a UXML file

1. In the ExampleField folder, create a UI Document named ExampleField.uxml.
2. Open ExampleField.uxml in a text editor and replace its contents with the following:

[!code-xml]

Create the class for the binding target

1. In Unity, double-click ExampleField.uxml to open it in the UI Builder. The ExampleField displays in the Hierarchy window and is visualized in the Viewport. If you select the ExampleField in the Hierarchy window, the Inspector window shows the values assigned to the Binding Path and Label boxes.
2. In the ExampleField folder, create a C# script named ExampleFieldComponent.cs and replace its contents with the following:

[!code-cs]

Create the custom Editor for the binding target

1. In the ExampleField folder, create a folder named Editor.
2. In the Editor folder, create a C# script named ExampleFieldCustomEditor.cs and replace its contents with the following:

[!code-cs]

Test the example

1. In Unity, select ExampleFieldCustomEditor.cs in the Project window.
2. Drag ExampleField.uxml into the Uxml box in the Inspector window.
3. Add an empty GameObject to a scene.
4. Add the ExampleFieldComponent component to the GameObject. The custom control appears in the Inspector with the default value of 0 for the Binding Target. If you change the value of the underlying double property, the UI reflects that change.

其他资源

• Custom controls