Version: Unity 6 Preview (6000.0)
LanguageEnglish
  • C#

UxmlBoolAttributeDescription

class in UnityEngine.UIElements

/

Inherits from:UIElements.TypedUxmlAttributeDescription_1

/

Implemented in:UnityEngine.UIElementsModule

Suggest a change

Success!

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.

Close

Submission failed

For 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.

Close

Cancel

Description

Describes a UXML bool attribute.

Properties

defaultValueAsString The default value for the attribute, as a string.

Constructors

UxmlBoolAttributeDescription Constructor.

Public Methods

GetValueFromBag Retrieves the value of this attribute from the attribute bag. Returns the value if found; otherwise, it returns defaultValue.
TryGetValueFromBag Attempts to retrieve the value of this attribute from the attribute bag and returns true if found, otherwise false.

Inherited Members

Properties

defaultValue The default value to be used for that specific attribute.
defaultValueAsString The string representation of the default value of the UXML attribute.
name The attribute name.
obsoleteNames A list of obsolete names for this attribute.
restriction Restrictions on the possible values of the attribute.
type Attribute type.
typeNamespace Attribute namespace.
use Whether the attribute is optional, required or prohibited.

Protected Methods

GetValueFromBag Get the attribute value from the attribute bag.
TryGetValueFromBag Tries to get the attribute value from the attribute bag.