Language
Edit

DataBindingProfile Class

Definition

This profile can be used to configure data and theme binding settings for a themed UX element.

[System.Serializable]
public class DataBindingProfile
[<System.Serializable>]
type DataBindingProfile = class
Public Class DataBindingProfile
Inheritance
DataBindingProfile
Attributes

Remarks

This object makes the connection between a data source, a theme source, and the UX elements that should be affected.
This is an experimental feature. This class is early in the cycle, it has been labeled as experimental to indicate that it is still evolving, and subject to change over time. Parts of the MRTK, such as this class, appear to have a lot of value even if the details haven't fully been fleshed out. For these types of features, we want the community to see them and get value out of them early enough so to provide feedback.

Constructors

Name Description
DataBindingProfile()

Properties

Name Description
DataKeyPath

Key path for the datum in the data source that can be used to retrieve the data bound value. This can be null or empty string if only theme bound.

GameObjectNameRegex

Optional pattern that can be used to find all UnityEngine.GameObject that contain an element (UnityEngine.Component or otherwise) that should be bound to this keypath.

RetrievalMethod

The type of data expected from the primary data source that will be used either directly, or to fetch the final object from the specified source.

ThemeKeyPath

Key path for the theme datum in a theme data source that can be used to retrieve the theme value. This can be null or empty string if only data bound.

UseRegex

Whether to do an exact match, or to use regex when comparing UnityEngine.GameObject names.

ValueToThemeKeypathLookup

Array of value and key pairs, where either an index or a specific string key is used to lookup a theme key path.

Applies to