IDxLocalizationService.GetString(String) Method

Returns a translated string by key.

Namespace: DevExpress.Blazor.Localization

Assembly: DevExpress.Blazor.v24.1.dll

NuGet Package: DevExpress.Blazor

Declaration

string GetString(
    string key
)

Parameters

Name	Type	Description
key	String	A string value that specifies a key.

Returns

Type	Description
String	The translated string that corresponds to the specified key.

Remarks

Use the GetString(key) method to obtain translated application resources (button captions, menu items, and etc.) to localize you Blazor applications. For more information, refer to Localization.

The following code snippet implements a custom service to localize an application:

LocalizationService.cs

using DevExpress.Blazor.Localization;
using System.Globalization;

namespace LocalizationService.Services {
    public class LocalizationService : DxLocalizationService, IDxLocalizationService {
        string? IDxLocalizationService.GetString(string key) {
            return CultureInfo.CurrentUICulture.Name == "it-IT" ?
                LocalizationProvider.GetString(key) :
                base.GetString(key);
        }

        public static class LocalizationProvider {
            public static Dictionary<string, string> localization = new Dictionary<string, string> {
                {"DxBlazorStringId.Calendar_TodayButton", "Oggi"},
                {"DxBlazorStringId.Calendar_ClearButton", "Pulisci"},
                {"DxBlazorStringId.Scheduler_CancelButton", "Annulla"},
                /* ... */
            };

            public static string? GetString(string key) {
                localization.TryGetValue(key, out string? value);
                return value;
            }
        }
    }
}

Program.cs

using BlazorClientApp.Services;
using DevExpress.Blazor.Localization;

/* ... */

builder.Services.AddSingleton(typeof(IDxLocalizationService), typeof(LocalizationService));

View Example: Localize DevExpress Blazor components