Version: 2019.3
LanguageEnglish
  • C#

UxmlEnumAttributeDescription<T0>

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 XML attribute representing an enum as a string.

Properties

defaultValueAsStringThe default value for the attribute, as a string.

Constructors

UxmlEnumAttributeDescription_1Constructor.

Public Methods

GetValueFromBagRetrieves the value of this attribute from the attribute bag. Returns it if it is found, otherwise return defaultValue.
TryGetValueFromBagTries to retrieve the value of this attribute from the attribute bag. Returns true if it is found, otherwise returns false.

Inherited Members

Properties

defaultValueThe default value to be used for that specific attribute.
defaultValueAsStringThe string representation of the default value of the uxml attribute.
defaultValueAsStringThe default value for the attribute, as a string.
nameThe attribute name.
obsoleteNamesA list of obsolete names for this attribute.
restrictionRestrictions on the possible values of the attribute.
typeAttribute type.
typeNamespaceAttribute namespace.
useWhether the attribute is optional, required or prohibited.

Protected Methods

GetValueFromBagGet the attribute value from the attribute bag.
TryGetValueFromBagTries to get the attribute value from the attribute bag.