ToggleButtonGroup
UnityEngine.UIElements.ToggleButtonGroup
읽는 시간 3분최근 업데이트: 한 달 전
Use ToggleButtonGroup to enable single or multiple selections from a logical group of Button elements. The ToggleButtonGroup consists of a label and a set of interactable Button elements.
참고
To align an element with other fields in an Inspector window, simply apply the USS class to it. For more information, refer to .
.unity-base-field__alignedBaseFieldCreate a ToggleButtonGroup
You can create a ToggleButtonGroup with UI Builder, UXML, and C#.
UI Builder
To create a ToggleButtonGroup in UI Builder:
- Drag ToggleButtonGroup from the Library panel into the Hierarchy panel.
- Add a set of Button elements to the ToggleButtonGroup element as its child elements.
To create a ToggleButtonGroup in UXML, add a ToggleButtonGroup element to a UXML document and add a set of Button elements as its child elements. For example:
C#
To create a ToggleButtonGroup in C#, create a new instance of a ToggleButtonGroup object and add a set of Buttons.
By default, you can select one button at a time. To enable multiple selections, set the to .
is-multiple-selectiontrueTo enable empty selection, set the to .
allow-empty-selectiontrueExample
The following UXML example creates a ToggleButtonGroup with Buttons:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <ToggleButtonGroup label="UXML Toggle Button Group"> <Button text="A"/> <Button text="B"/> <Button text="C"/> <Button text="D"/> <Button text="E"/> </ToggleButtonGroup></UXML>
The following USS example styles the ToggleButtonGroup:
.my-custom-style .unity-button-group__button { -unity-font-style: bold;}
The following C# example illustrates some customizable functionalities of the ToggleButtonGroup and its Buttons:
// Create custom buttons with Text value only. var csharpToggleButtonGroupWithButtonTextOnly = new ToggleButtonGroup("C# Toggle Button Group Buttons with Text"); csharpToggleButtonGroupWithButtonTextOnly.Add(new Button() { text = "one", tooltip = "custom button one" }); csharpToggleButtonGroupWithButtonTextOnly.Add(new Button() { text = "two", tooltip = "custom button two" }); container.Add(csharpToggleButtonGroupWithButtonTextOnly); // Create custom buttons with IconImage value only. var csharpToggleButtonGroupWithButtonIconOnly = new ToggleButtonGroup("C# Toggle Button Group Buttons with Icons"); csharpToggleButtonGroupWithButtonIconOnly.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_PlayButton"), tooltip = "Play" }); csharpToggleButtonGroupWithButtonIconOnly.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_PauseButton"), tooltip = "Pause" }); csharpToggleButtonGroupWithButtonIconOnly.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_StepButton"), tooltip = "Step" }); container.Add(csharpToggleButtonGroupWithButtonIconOnly); // Create custom buttons with IconImage and Text. var csharpToggleButtonGroupWithButtonIconAndText = new ToggleButtonGroup("C# Toggle Button Group Buttons with Icons and Text"); csharpToggleButtonGroupWithButtonIconAndText.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_PlayButton"), text = "Play", tooltip = "Play" }); csharpToggleButtonGroupWithButtonIconAndText.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_PauseButton"), text = "Pause", tooltip = "Pause" }); csharpToggleButtonGroupWithButtonIconAndText.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_StepButton"), text = "Step", tooltip = "Step" }); container.Add(csharpToggleButtonGroupWithButtonIconAndText); // Create custom buttons with IconImage, Text and AllowEmptySelection. var csharpToggleButtonGroupSingleSelectionAndAllowEmptySelection = new ToggleButtonGroup("C# Toggle Button Group Buttons with Allow Empty Selection") { allowEmptySelection = true }; csharpToggleButtonGroupSingleSelectionAndAllowEmptySelection.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_PlayButton"), text = "Play", tooltip = "Play" }); csharpToggleButtonGroupSingleSelectionAndAllowEmptySelection.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_PauseButton"), text = "Pause", tooltip = "Pause" }); csharpToggleButtonGroupSingleSelectionAndAllowEmptySelection.Add(new Button() { iconImage = EditorGUIUtility.FindTexture("d_StepButton"), text = "Step", tooltip = "Step" }); container.Add(csharpToggleButtonGroupSingleSelectionAndAllowEmptySelection); // Create a ToggleButtonGroup that allows multiple active selections. var csharpToggleButtonGroupAllowMultiSelect = new ToggleButtonGroup("C# Toggle Button Group with Multiple Selection Enabled") { isMultipleSelection = true }; csharpToggleButtonGroupAllowMultiSelect.Add(new Button() { text = "X", tooltip = "tooltip text for X" }); csharpToggleButtonGroupAllowMultiSelect.Add(new Button() { text = "Y", tooltip = "tooltip text for Y" }); csharpToggleButtonGroupAllowMultiSelect.Add(new Button() { text = "Z", tooltip = "tooltip text for Z" }); container.Add(csharpToggleButtonGroupAllowMultiSelect); // Create a ToggleButtonGroup that allows multiple active selections and allow empty selection. var csharpToggleButtonGroupAllowMultiSelectWithAllowEmptySelection = new ToggleButtonGroup("C# Toggle Button Group with Multiple Selection and Allow Empty Selection") { isMultipleSelection = true, allowEmptySelection = true }; csharpToggleButtonGroupAllowMultiSelectWithAllowEmptySelection.Add(new Button() { text = "X", tooltip = "tooltip text for X" }); csharpToggleButtonGroupAllowMultiSelectWithAllowEmptySelection.Add(new Button() { text = "Y", tooltip = "tooltip text for Y" }); csharpToggleButtonGroupAllowMultiSelectWithAllowEmptySelection.Add(new Button() { text = "Z", tooltip = "tooltip text for Z" }); container.Add(csharpToggleButtonGroupAllowMultiSelectWithAllowEmptySelection); // Create ToggleButtonGroup with a custom class that sets the text's font style to Bold. var csharpToggleButtonGroupWithCustomClass = new ToggleButtonGroup("C# Toggle Button Group with a Custom Class"); csharpToggleButtonGroupWithCustomClass.AddToClassList("my-custom-style"); csharpToggleButtonGroupWithCustomClass.Add(new Button() { text = "Button A", tooltip = "Bolded font Button A" }); csharpToggleButtonGroupWithCustomClass.Add(new Button() { text = "Button B", tooltip = "Bolded font Button B" }); container.Add(csharpToggleButtonGroupWithCustomClass);
To try this example live in Unity, go to Window > UI Toolkit > Samples.
C# base class and namespace
C# class:
ToggleButtonGroupNamespace:
UnityEngine.UIElementsBase class:
BaseField_1Member UXML attributes
This element has the following member attributes:
Name | Type | Description |
|---|---|---|
| | Allows having all buttons to be unchecked when set to true. When the property value is false, the control will automatically set the first available button to checked. |
| | Whether all buttons can be selected. |
Inherited UXML attributes
This element inherits the following attributes from its base class:
Name | Type | Description |
|---|---|---|
| | Path of the target property to be bound. |
| | If false, this prevents the element from being focused. The element can only be focused if its canGrabFocus property is true. |
| | The string representing the label that will appear beside the field. If the string is empty, the label element is removed from the hierarchy. If the string is not empty, the label element is added to the hierarchy. |
| | An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero. Setting the |
| | The value associated with the field. |
This element also inherits the following attributes from :
VisualElementName | Type | Description |
|---|---|---|
| | Logical container where child elements are added. If a child is added to this element, the child is added to this element's content container instead. When iterating over the If the content container is the same as the element itself, child elements are added directly to the element. This is true for most elements but can be overridden by more complex types. The |
| | Assigns a data source to this VisualElement which overrides any inherited data source. This data source is inherited by all children. |
| | Path from the data source to the value. |
| | 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. |
| | Returns true if the This flag isn't changed if the VisualElement is disabled implicitly by one of its parents. To verify this, use |
| | Indicates the directionality of the element's text. The value will propagate to the element's children. Setting |
| | 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. |
| | Determines if this element can be the target of pointer events or picked by Elements can not be picked if: - They are invisible- Their Elements with a picking mode of |
| | Sets the style values on a The returned style data, computed from USS files or inline styles written to this object in C#, doesn't represent the fully resolved styles, such as the final height and width of a VisualElement. To access these fully resolved styles, use For information about how to use this property and all the supported USS properties, refer to the Apply styles in C# scripts and USS properties reference manual pages. |
| | 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. |
| | A combination of hint values that specify high-level intended usage patterns for the |
| | 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 |
USS classes
The following table lists all the C# public property names and their related USS selector.
C# property | USS selector | Description |
|---|---|---|
| | USS class name of elements for this type. |
| | USS class name of container element of this type. |
| | USS class name of elements of this type. |
| | USS class name of labels in elements of this type. |
| | USS class name of input elements in elements of this type. |
| | USS class name of elements of this type, when there is no label. |
| | USS class name of labels in elements of this type, when there is a dragger attached on them. |
| | USS class name of elements that show mixed values |
| | USS class name of elements that are aligned in a inspector element |
| | 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 at every level of its hierarchy.
VisualElement