Extend ui toolkit label control

Question

I'm building a runtime gui with ui toolkit and i'd like to extend the standard label control for to add multilang behaviour. I have all necesary code for do it adding a single component in a standard text ot text mesh pro, I only need help for modify the ui toolkit label text when the scene starts.

I'd like doit without create a label ctrl since zero. Can i extend the standard label using direct inheritance? I tried adapting the manual example but i don't know how to modify the text of the label.

 class Labelml : Label
 {
     public Labelml()
     {
     }
     public string Status { get; set; } = "status";
 
     public new class UxmlFactory : UxmlFactory<Labelml> { }
 
     public new class UxmlTraits : VisualElement.UxmlTraits
     {
         UxmlStringAttributeDescription m_Status = new UxmlStringAttributeDescription { name = "labelmlName" };
 
         public override IEnumerable<UxmlChildElementDescription> uxmlChildElementsDescription
         {
             get { yield break; }
         }
 
         public override void Init(VisualElement ve, IUxmlAttributes bag, CreationContext cc)
         {
             base.Init(ve, bag, cc);
             ((Labelml)ve).Status = m_Status.GetValueFromBag(bag, cc);
         }
     }
 }

Answer 1

Can i extend the standard label using direct inheritance?

Yes

i don't know how to modify the text of the label

 // @ constructor, for example
 this.text = "text";

or

 // @ UxmlTraits.Init()
 var label = (MyCustomLabel) ve;
 label.text = "text"

 [UnityEngine.Scripting.Preserve]
 public class MyCustomLabel : Label
 {
     public string LocalizationKey { get; set; }
     public MyCustomLabel () {}
     public new class UxmlFactory : UxmlFactory<MyCustomLabel,UxmlTraits> {}
     public new class UxmlTraits : VisualElement.UxmlTraits
     {
         UxmlStringAttributeDescription LocalizationKeyAttr = new UxmlStringAttributeDescription{ name="Localization-Key" , defaultValue="none" };
         public override void Init ( VisualElement ve , IUxmlAttributes attributes , CreationContext context )
         {
             base.Init( ve , attributes , context );
             var instance = (MyCustomLabel) ve;
 
             string locKey = LocalizationKeyAttr.GetValueFromBag( attributes , context );
             instance.LocalizationKey = locKey;
             instance.text = instance.LocalizeString( locKey );
         }
     }
     public string LocalizeString ( string key )
     {
         return "implement localization method here";
     }
 }

But. I don't think custom label type is a good way to go about localizing UI. Why? Because you cannot override existing Label implementations this way and many element types include them as child elements. For example, a Button - it will require writing custom Button type.

Alternative approach would be to find all Labels in a complete ui tree and modify their text values using official localization package.

Implementation example here: UIDocumentLocalization.cs.

Extend ui toolkit label control

1 Reply

Your answer

Follow this Question

Related Questions