Class UxmlTypeAttributeDescription<TBase>

Describes an XML System.Type attribute.

Inheritance

Object

UxmlAttributeDescription

TypedUxmlAttributeDescription<Type>

UxmlTypeAttributeDescription<TBase>

Inherited Members

TypedUxmlAttributeDescription<Type>.defaultValue

UxmlAttributeDescription.xmlSchemaNamespace

UxmlAttributeDescription.name

UxmlAttributeDescription.obsoleteNames

UxmlAttributeDescription.type

UxmlAttributeDescription.typeNamespace

UxmlAttributeDescription.use

UxmlAttributeDescription.restriction

UxmlAttributeDescription.TryGetValueFromBag<T>(IUxmlAttributes, CreationContext, Func<String, T, T>, T, T)

UxmlAttributeDescription.GetValueFromBag<T>(IUxmlAttributes, CreationContext, Func<String, T, T>, T)

Namespace: UnityEngine.UIElements

Syntax

public class UxmlTypeAttributeDescription<TBase> : TypedUxmlAttributeDescription<Type>

Type Parameters

Name	Description
TBase

Constructors

UxmlTypeAttributeDescription()

Constructor.

Declaration

public UxmlTypeAttributeDescription()

Properties

defaultValueAsString

The default value for the attribute, as a string.

Declaration

public override string defaultValueAsString { get; }

Property Value

Type	Description
String

Overrides

UnityEngine.UIElements.TypedUxmlAttributeDescription<Type>.defaultValueAsString

Methods

GetValueFromBag(IUxmlAttributes, CreationContext)

Method that retrieves an attribute's value from an attribute bag. Returns it if it is found, otherwise return .

Declaration

public override Type GetValueFromBag(IUxmlAttributes bag, CreationContext cc)

Parameters

Type	Name	Description
IUxmlAttributes	bag	The attribute bag.
CreationContext	cc	The context in which the method retrieves attribute values.

Returns

Type	Description
Type	The attribute's value. If the method cannot find the value, returns .

Overrides

UnityEngine.UIElements.TypedUxmlAttributeDescription<Type>.GetValueFromBag(UnityEngine.UIElements.IUxmlAttributes, UnityEngine.UIElements.CreationContext)

TryGetValueFromBag(IUxmlAttributes, CreationContext, ref Type)

Method that tries to retrieve an attribute's value from an attribute bag.. Returns true if it is found, otherwise returns false.

Declaration

public bool TryGetValueFromBag(IUxmlAttributes bag, CreationContext cc, ref Type value)

Parameters

Type	Name	Description
IUxmlAttributes	bag	The attribute bag.
CreationContext	cc	The context in which the method retrieves attribute values.
Type	value	The attribute's value.

Returns

Type	Description
Boolean	True if the method can retrieve the attribute's value. False otherwise.