class in UnityEngine.UIElements
/
Inherits from:UIElements.Binding
/
Implemented in:UnityEngine.UIElementsModule
Implements interfaces:IDataSourceProvider
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.
CloseFor 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.
CloseBinding type that enables data synchronization between a property of a data source and a property of a VisualElement.
bindingMode | Controls how this binding should be updated. The default value is BindingMode.TwoWay. |
dataSource | Object that serves as a local source for the binding, and is particularly useful when the data source is not part of the UI hierarchy, such as a static localization table. If this object is null, the binding resolves the data source using its normal resolution method. |
dataSourcePath | Path from the data source to the value. |
dataSourceType | The possible data source types that can be assigned to the binding. |
sourceToUiConverters | Returns the ConverterGroup used when trying to convert data from the data source to a UI property. |
uiToSourceConverters | Returns the ConverterGroup used when trying to convert data from a UI property back to the data source. |
DataBinding | Initializes and returns an instance of DataBinding. |
ApplyConverterGroupToSource | Applies a ConverterGroup to this binding that will be used when converting data between a UI control to a data source. |
ApplyConverterGroupToUI | Applies a ConverterGroup to this binding that will be used when converting data between a data source to a UI control. |
UpdateSource | Callback called to allow derived classes to update the data source with the resolved value when a change from the UI is detected. |
UpdateUI | Callback called to allow derived classes to update the UI with the resolved value from the data source. |
isDirty | When set to true, the binding instance updates during the next update cycle. When set to false, the binding instance updates only if a change is detected. |
updateTrigger | When set to BindingUpdateTrigger.EveryUpdate, the binding instance updates in every update, regardless of the data source version. |
MarkDirty | Notifies the binding system to process this binding. |
OnActivated | Called when the binding becomes active for a specific VisualElement. |
OnDataSourceChanged | Called when the resolved data source of a binding changes. |
OnDeactivated | Called when the binding is no longer active for a specific VisualElement. |
GetGlobalLogLevel | Gets the global log level for all binding failures. |
GetPanelLogLevel | Gets the log level for binding failures on a panel. |
ResetPanelLogLevel | Resets the log level for binding failures on a panel to use the global setting. |
SetGlobalLogLevel | Sets the log level for all binding failures. |
SetPanelLogLevel | Sets the log level for binding failures on a panel. |
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.