struct in UnityEngine.UIElements
/
Implemented in:UnityEngine.UIElementsModule
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.
CloseThe structure that keeps track of the Button states inside a ToggleButtonGroup.
To set properties on how to serialize this type, use ToggleButtonGroupStatePropertiesAttribute.
| Property | Description |
|---|---|
| length | Returns the number of toggle button options available. |
| this[int] | The option based on the index. |
| Constructor | Description |
|---|---|
| ToggleButtonGroupState | Constructs a ToggleButtonGroupState. |
| Method | Description |
|---|---|
| CompareTo | Compares two ToggleButtonGroupState. |
| Equals | Checks if a given ToggleButtonGroupState matches with the current one. |
| GetActiveOptions | Retrieves a Span of integers containing the active options as indices. |
| GetHashCode | Get the hashcode of this ToggleButtonGroupState. |
| GetInactiveOptions | Retrieves a Span of integers containing the inactive options as indices. |
| ResetAllOptions | Resets the states of the toggle buttons. |
| SetAllOptions | Sets all the available options to active. |
| ToggleAllOptions | Toggles all the available options' state. |
| Method | Description |
|---|---|
| Compare | Compares two ToggleButtonGroupState of flag enum types. |
| CreateFromOptions | Helps generate a ToggleButtonGroupState based on a list of booleans. |
| FromEnumFlags | Creates a ToggleButtonGroupState based on a FlagsAttribute enum type. |
| ToEnumFlags | Synchronizes the internal data with the ToggleButtonGroupState from a FlagsAttribute. |
| Operator | Description |
|---|---|
| operator != | Checks if both of the ToggleButtonGroupState are not the same. |
| operator == | Checks if both of the ToggleButtonGroupState are the same. |
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.