Legacy Documentation: Version 2018.2 (Go to current version)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

UxmlFactory<T0,T1>

class in UnityEngine.Experimental.UIElements

/

Implemented in:UnityEngine.UIElementsModule


Implements interfaces:IUxmlFactory

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

Generic base class for UXML factories, which instantiate a VisualElement using the data read from a UXML file.

T0 The type of the element that will be instantiated. It must derive from VisualElement.

T1 The traits of the element that will be instantiated. It must derive from UxmlTraits.

Properties

canHaveAnyAttributeReturns UxmlTraits.canHaveAnyAttribute (where UxmlTraits is the argument for T1).
CreatesTypeReturns the Type of the objects created by this factory.
substituteForTypeNameReturns an empty string if T0 is not VisualElement; otherwise, returns "VisualElement".
substituteForTypeNamespaceReturns the namespace for substituteForTypeName.
substituteForTypeQualifiedNameReturns the fully qualified name for substituteForTypeName.
uxmlAttributesDescriptionReturns an empty enumerable.
uxmlChildElementsDescriptionReturns an empty enumerable.
uxmlNameReturns the type name of T0.
uxmlNamespaceReturns the namespace name of T0.
uxmlQualifiedNameReturns the typefully qualified name of T0.

Public Methods

AcceptsAttributeBagReturns true.
CreateInstantiate an object of type T0 and initialize it by calling T1 UxmlTraits.Init method.

Protected Methods

DoCreateIf implemented by your factory, this function will be called to instantiate an object of type T0. Otherwise, the default constructor of T0 will be used.

Did you find this page useful? Please give it a rating: