Skip to main content

DashboardLocalizer Class

Provides localized strings for the dashboard user interface elements.

Namespace: DevExpress.DashboardCommon.Localization

Assembly: DevExpress.Dashboard.v24.1.Core.dll

NuGet Package: DevExpress.Dashboard.Core

Declaration

public class DashboardLocalizer :
    XtraLocalizer<DashboardStringId>,
    ILocalizeCustomFunctionDescription

Remarks

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

Use the following localizer objects to translate resources:

Important

Not all strings can be translated with Localizers. We recommend that you use the Localizer classes to override the localization of specific strings only. Use resources to localize the UI because some components contain form resources (for example, the “Export to PDF” dialog) that should be translated with satellite assemblies.

Follow the steps below to localize your application with this approach:

  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 the descendant’s 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_WinLocalizer_Example

You can use the following example to determine the correct name of the localized string ID enumeration member:

View Example: Localized String ID Visualizer

winforms-dashboard-localized-string-id-visualizer

Inheritance

See Also