A ToolbarToggle is an Editor-only control that serves as a toggle in a ToolbarA row of buttons and basic controls at the top of the Unity Editor that allows you to interact with the Editor in various ways (e.g. scaling, translation). More info
See in Glossary. Itâs a ToggleA checkbox that allows the user to switch an option on or off. More info
See in Glossary with a predefined style that matches the Toolbar style. It looks like a button that you can toggle on and off.
You can create a ToolbarToggle with UI Builder, UXML, or C#. The following C# example creates a ToolbarToggle with a label:
using UnityEditor.UIElements;
...
var toolbarToggle = new ToolbarToggle() { text = "Toggle me" };
C# class: ToolbarToggle
Namespace: UnityEditor.UIElements
Base class: Toggle
This element inherits the following attributes from its base class:
Name Type Descriptionbinding-path string Path of the target property to be bound. focusable boolean True if the element can be focused. label string The string representing the label that will appear beside the field. tabindex int An integer used to sort focusables in the focus ring. Must be greater than or equal to zero. text string Optional text that appears after the BaseBoolField.
Unity creates a Label automatically if one does not exist.
toggle-on-label-click boolean Whether to activate the toggle when the user clicks the label. value boolean The value associated with the field.
This element also inherits the following attributes from VisualElement:
content-container string Child elements are added to it, usually this is the same as the element itself. data-source Object Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. data-source-path string Path from the data source to the value. data-source-type System.Type The possible type of data source assignable to this VisualElement.
This information is only used by the UI Builder as a hint to provide some completion to the data source path field when the effective data source cannot be specified at design time.
language-direction UIElements.LanguageDirection Indicates the directionality of the elementâs text. The value will propagate to the elementâs children.
Setting the languageDirection to RTL adds basic support for right-to-left (RTL) by reversing the text and handling linebreaking and word wrapping appropriately. However, it does not provide comprehensive RTL support, as this would require text shaping, which includes the reordering of characters, and OpenType font feature support. Comprehensive RTL support is planned for future updates, which will involve additional APIs to handle language, script, and font feature specifications.
To enhance the RTL functionality of this property, users can explore available third-party plugins in the Unity Asset Store and make use of ITextElementExperimentalFeatures.renderedText
name string The name of this VisualElement.
Use this property to write USS selectors that target a specific element. The standard practice is to give an element a unique name.
picking-mode UIElements.PickingMode Determines if this element can be pick during mouseEvents or IPanel.Pick queries. style string Sets the VisualElement style values. tooltip string Text to display inside an information box after the user hovers the element for a small amount of time. This is only supported in the Editor UI. usage-hints UIElements.UsageHints A combination of hint values that specify high-level intended usage patterns for the VisualElement. This property can only be set when the VisualElement is not yet part of a Panel. Once part of a Panel, this property becomes effectively read-only, and attempts to change it will throw an exception. The specification of proper UsageHints drives the system to make better decisions on how to process or accelerate certain operations based on the anticipated usage pattern. Note that those hints do not affect behavioral or visual results, but only affect the overall performance of the panel and the elements within. Itâs advised to always consider specifying the proper UsageHints, but keep in mind that some UsageHints might be internally ignored under certain conditions (e.g. due to hardware limitations on the target platform). view-data-key string Used for view data persistence, such as tree expanded states, scroll position, or zoom level.
This key is used to save and load the view data from the view data store. If you donât set this key, the persistence is disabled for the associated VisualElement. For more information, refer to View data persistence.
The following table lists all the C# public property names and their related USS selector.
C# property USS selector DescriptionussClassName .unity-toolbar-toggle USS class name of elements of this type. ussClassName .unity-toggle USS class name for Toggle elements.
Unity adds this USS class to every instance of the Toggle element. Any styling applied to this class affects every Toggle located beside, or below the stylesheet in the visual tree.
labelUssClassName .unity-toggle__label USS class name for Labels in Toggle elements.
Unity adds this USS class to the Label sub-element of the Toggle if the Toggle has a Label.
inputUssClassName .unity-toggle__input USS class name of input elements in Toggle elements.
Unity adds this USS class to the input sub-element of the Toggle. The input sub-element provides responses to the manipulator.
noTextVariantUssClassName .unity-toggle--no-text USS class name of Toggle elements that have no text.
Unity adds this USS class to the Toggle if the Toggle does not have a label.
checkmarkUssClassName .unity-toggle__checkmark USS class name of Images in Toggle elements.
Unity adds this USS class to the Image sub-element of the Toggle that contains the checkmark image.
textUssClassName .unity-toggle__text USS class name of Text elements in Toggle elements.
Unity adds this USS class to Text sub-elements of the Toggle.
mixedValuesUssClassName .unity-toggle__mixed-values USS class name of Toggle elements that have mixed values
Unity adds this USS class to checkmark of the Toggle when it has mixed values.
ussClassName .unity-base-field USS class name of elements of this type. labelUssClassName .unity-base-field__label USS class name of labels in elements of this type. inputUssClassName .unity-base-field__input USS class name of input elements in elements of this type. noLabelVariantUssClassName .unity-base-field--no-label USS class name of elements of this type, when there is no label. labelDraggerVariantUssClassName .unity-base-field__label--with-dragger USS class name of labels in elements of this type, when there is a dragger attached on them. mixedValueLabelUssClassName .unity-base-field__label--mixed-value USS class name of elements that show mixed values alignedFieldUssClassName .unity-base-field__aligned USS class name of elements that are aligned in a inspector element disabledUssClassName .unity-disabled USS class name of local disabled elements.
You can also use the Matching Selectors section in the Inspector or the UI Toolkit Debugger to see which USS selectors affect the components of the VisualElement at every level of its hierarchy.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4