How to: Localize the Dashboard WinForms UI using Localizers

DevExpress products allow you to specify localization resource values programmatically at runtime. This approach can be useful when a resource value is not known at design time, or if you wish to set the resource value based on a runtime condition.

Note

Important: Not all strings can be translated via Localizer classes. Some components contain form resources (e.g., the XtraReports Search dialog), which must be translated via satellite assemblies, so localization via resources is recommended.

The steps to localize your application using this approach are as follows:

  1. Create a descendant of the localizer class.

    Two specific types of Localizer objects are available for the Dashboard Suite WinForms UI:

    Use the DashboardLocalizer and DashboardsResLocalizer classes respectively to localize cross-platform strings.

  2. Override its GetLocalizedString method. This method is called for each localized string and returns the string's value, and returns values that are contained within the DashboardWinStringId (in the DashboardWinLocalizer class) or the DashboardStringId (in the DashboardLocalizer class) resource string enumeration by default. Override the GetLocalizedString method to return your custom string values.
  3. Assign an instance of your class to the static Active property of the localizer class from which it was derived to use this localizer.

The following example demonstrates how to localize the UI of the Dashboard Designer into Spanish:

public class SpanishDashboardWinLocalizer : DashboardWinLocalizer {
   public override string Language { get { return "Español"; }}
   public override string GetLocalizedString(DashboardWinStringId id) {
      string ret = "";
      switch(id) {
         // ...
         case DashboardWinStringId.CommandNewDashboardCaption : return "Nuevo"; 
         case DashboardWinStringId.CommandOpenDashboardCaption : return "Abrir"; 
         case DashboardWinStringId.CommandSaveDashboardCaption : return "Guardar"; 
         case DashboardWinStringId.CommandSaveAsDashboardCaption : return "Guardar como"; 
         case DashboardWinStringId.CommandUndoCaption : return "Deshacer"; 
         case DashboardWinStringId.CommandRedoCaption : return "Rehacer"; 
         case DashboardWinStringId.CommandNewDataSourceCaption : return "Nueva Fuente de Datos"; 
         case DashboardWinStringId.CommandEditDataSourceCaption : return "Editar"; 
         case DashboardWinStringId.CommandDeleteDataSourceCaption : return "Eliminar";
         // ...
         default:
            ret = base.GetLocalizedString(id);
            break;
      }
      return ret;
   }
}
public class SpanishDashboardCoreLocalizer : DashboardLocalizer {
   public override string Language { get { return "Español"; }}
   public override string GetLocalizedString(DashboardStringId id) {
      string ret = "";
      switch(id) {
         // ...
         case DashboardStringId.DateTimeGroupIntervalYear : return "Año"; 
         case DashboardStringId.SummaryTypeSum : return "Suma"; 
         case DashboardStringId.DescriptionItemArgument : return "Argumento"; 
         case DashboardStringId.DescriptionArguments : return "Argumentos"; 
         case DashboardStringId.DescriptionItemValue : return "Valor"; 
         case DashboardStringId.DescriptionValues : return "Valores"; 
         // ...
         default:
            ret = base.GetLocalizedString(id);
            break;
      }
      return ret;
   }
}

After this, these localizers are instantiated and assigned to the Active property of their base class.

public Form1()
{
    DashboardWinLocalizer.Active = new SpanishDashboardWinLocalizer();
    DashboardLocalizer.Active = new SpanishDashboardCoreLocalizer();
    InitializeComponent();  
}

The result of localizing the Dashboard Designer interface is shown below.

Localization_LocalizedDesigner

Tip

You can use a simple application Localized String ID Visualizer to determine the correct name of the localized string ID enumeration member.

See Also