HelpBox
UnityEngine.UIElements.HelpBox
読み終わるまでの所要時間 2 分最終更新 1ヶ月前
A HelpBox displays a message to the user. You can set the type of message to display, such as a warning or an error. You can also set the message to display as rich text, or add a button or a link to the HelpBox.
Create a HelpBox
You can create a HelpBox with UXML and C#. The following C# example creates a HelpBox with the message "Help text" and the information icon:
HelpBox helpBox = new HelpBox("Help text", HelpBoxMessageType.Info);
Example
The following UXML example creates a HelpBox with a warning message:
<UXML xmlns="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements"> <HelpBox text="UXML Help Box" message-type="Info" name="the-uxml-help-box" /></UXML>
The following USS example styles the HelpBox:
.some-styled-help-box { height: 100px;}.some-styled-help-box .unity-help-box__label { -unity-font-style: bold;}
The following C# example illustrates some of the customizable functionalities of the HelpBox:
// Get a reference to the help box from UXML and update its text. var uxmlHelpBox = container.Q<HelpBox>("the-uxml-help-box"); uxmlHelpBox.text += " (Updated in C#)"; // Create a new help box and give it a style class. var csharpHelpBox = new HelpBox("This is a styled warning type help box.", HelpBoxMessageType.Warning); csharpHelpBox.AddToClassList("some-styled-help-box"); container.Add(csharpHelpBox); // Create an Error Type help box. var errorHelpBox = new HelpBox("This is an error type help box.", HelpBoxMessageType.Error); container.Add(errorHelpBox); // Create a help box with no icon. var standardHelpBox = new HelpBox("This is a help box without an icon.", HelpBoxMessageType.None); container.Add(standardHelpBox); // Create an Info Type help box with some long text. var infoHelpBox = new HelpBox("This is a help box with a short paragraph. The content here should help wrap the help box when the window size is small enough. Feel free to resize the sample window to see this wrap and unwrap.", HelpBoxMessageType.Info); container.Add(infoHelpBox); // Create a typed help box with a call-to-action button. var helpBoxWithCTAButton = new HelpBox("This is a help box with a call to action button.", HelpBoxMessageType.Warning); helpBoxWithCTAButton.buttonText = "Action"; helpBoxWithCTAButton.onButtonClicked += () => Debug.Log("Action Button Clicked"); container.Add(helpBoxWithCTAButton); // Create a typed help box with a call-to-action button and link. var helpBoxWithCTAButtonAndLink = new HelpBox("This is a help box with a call to action button and a link.", HelpBoxMessageType.Warning); helpBoxWithCTAButtonAndLink.buttonText = "Action"; helpBoxWithCTAButtonAndLink.onButtonClicked += () => Debug.Log("Action Button Clicked"); helpBoxWithCTAButtonAndLink.linkHref = "https://www.unity.com"; helpBoxWithCTAButtonAndLink.linkText = "Visit Unity!"; container.Add(helpBoxWithCTAButtonAndLink);
To try this example live in Unity, go to Window > UI Toolkit > Samples.
C# base class and namespace
C# class:
HelpBoxNamespace:
UnityEngine.UIElementsBase class:
VisualElementMember UXML attributes
This element has the following member attributes:
Name | Type | Description |
|---|---|---|
| | The action button's text value. Provide a value to create a new |
| | The hyperlink's reference value. Provide a value to create a |
| | The hyperlink's text value. Provide a value to create a |
| | The type of message. |
| | The message text. |
Inherited UXML attributes
This element inherits the following attributes from its base class:
Name | Type | Description |
|---|---|---|
| | Whether an element can potentially receive focus. If false, the element can't receive focus. If true, the element receives focus only when its |
| | An integer used to sort focusable elements in the focus ring. Must be greater than or equal to zero. Setting the |
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. |
| | 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 |
|---|---|---|
| | The USS class name for Elements of this type. |
| | The USS class name for the top content container of this Elements type. |
| | The USS class name for the bottom content container of this Elements type. |
| | The USS class name for the action link for this Elements type. |
| | The USS class name for the action button of this Elements type. |
| | The USS class name for labels in Elements of this type. |
| | The USS class name for images in Elements of this type. |
| | The USS class name for the |
| | The USS class name for the |
| | The USS class name for the |
| | The USS class name for the |
| | 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