You can customize a UXML tag name, override the default value of a base class attribute, or restrict the accepted attributes for your custom control.
By default, the tag name in UXML for your custom control is the C# class name. It’s not recommended that a tag has a different name than the C# class. However, you can customize the tag name if there are name conflicts.
To customize a UXML tag name, override its IUxmlFactory.uxmlName
and IUXmlFactory.uxmlQualifiedName
properties. Make sure of the following:
uxmlName
is unique in your namespaceuxmlQualifiedName
is unique in your projectIf both names aren’t unique, Unity throws an exception when it loads the assembly.
The following code example overrides and customizes the UXML tag name:
public class FactoryWithCustomName : UxmlFactory<..., ...>
{
public override string uxmlName
{
get { return "UniqueName"; }
}
public override string uxmlQualifiedName
{
get { return uxmlNamespace + "." + uxmlName; }
}
}
By default, IUxmlFactory
instantiates an element and selects the element by the name of the element. To consider attribute values on the element for the selection, override IUXmlFactory.AcceptsAttributeBag()
. The factory examines the element attributes to decide if it can instantiate an object for the UXML element.
If your VisualElement
class is generic, it can be useful to have the factory examine element attributes. In this case, the class factory for a specialization of your class could examine the value of a UXML type
attribute. Depending on the value, instantiation can be accepted or refused.
If more than one factory can instantiate an element, the first registered factory is selected.
To change the default value of an attribute declared in a base class, set its defaultValue
in the derived UxmlTraits
class.
The following code example changes the default value of m_TabIndex
:
class MyElementTraits : VisualElement.UxmlTraits
{
public MyElementTraits()
{
m_TabIndex.defaultValue = 0;
}
}
By default, the generated UXML schema states that an element can have any attribute. This is in contrast to XML validators that check that the value of a declared attribute matches its declaration.
The IUxmlAttributes
bag includes additional attributes that are passed to the IUxmlFactory.AcceptsAttributeBag()
and IUxmlFactory.Init()
functions. The factory implementation decided whether to use these additional attributes. The default behavior is to discard additional attributes. These additional attributes aren’t attached to the instantiated VisualElement
and you can’t query these attributes with UQuery.
To restrict the accepted attributes to those explicitly declared in the IUxmlAttributes
bag when you define a new element, set the UxmlTraits.canHaveAnyAttribute
property to false
in your UxmlTraits
constructor.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.