Localizing WPF Controls via Localizer Objects

• Aug 03, 2020
• 5 minutes to read

Each DevExpress component or library has a specific Localizer class (see the table below) that provides localized strings. For example, in the Data Grid control, this is the GridControlLocalizer class.

Note

Important: Not all strings can be translated via Localizer classes. Some components contain form resources (e.g., the XtraReports Search dialog), and the only way to translate them is to create satellite assemblies. Thus, localization via resources is the preferable solution.

Localization Process

Use custom localizers to provide translated strings for localization as follows.

• Create a descendant of a corresponding Localizer class and override either the GetLocalizedString method (which returns strings for specific string resource identifiers) or PopulateStringTable method (which adds strings for specified resource identifiers).
• To use this localizer, assign an instance of this class to the static Active property of the localizer class you inherited from.

The following table lists Localizer classes and Resource String enumerations for DevExpress WPF products.

Product	Localizer Class	Resource String Enumeration	Namespace
Data Grid	GridControlLocalizer	GridControlStringId / GridControlRuntimeStringId	DevExpress.Xpf.Grid
PropertyGrid	DevExpress.Xpf.PropertyGrid.PropertyGridControlLocalizer	DevExpress.Xpf.PropertyGrid.PropertyGridControlStringID	DevExpress.Xpf.PropertyGrid
Gantt	DevExpress.Xpf.Gantt.Localization.GanttControlLocalizer	DevExpress.Xpf.Gantt.Localization.GanttControlStringId	DevExpress.Xpf.Gantt.Localization
Docking	DevExpress.Xpf.Docking.Base.DockingLocalizer	DevExpress.Xpf.Docking.Base.DockingStringId	DevExpress.Xpf.Docking.Base
Diagram	DiagramControlLocalizer	DevExpress.Diagram.Core.Localization.DiagramControlStringId	DevExpress.Xpf.Diagram
Toolbar-Menu / Ribbon	BarsLocalizer	DevExpress.Xpf.Bars.BarsStringId	DevExpress.Xpf.Bars
Chart	ChartLocalizer	ChartStringId	DevExpress.Xpf.Charts.Localization
Pivot Grid	PivotGridLocalizer	PivotGridStringId	DevExpress.XtraPivotGrid.Localization
Scheduler	DevExpress.Xpf.Scheduling.Common.SchedulerLocalizer	DevExpress.Xpf.Scheduling.Common.SchedulerStringId	DevExpress.Xpf.Scheduling.Common
Rich Text Editor	DevExpress.Xpf.RichEdit.Localization.XpfRichEditLocalizer	DevExpress.Xpf.RichEdit.RichEditControl.StringId	DevExpress.Xpf.RichEdit.Localization DevExpress.Xpf.RichEdit
Spreadsheet	DevExpress.Xpf.Spreadsheet.Localization.XpfSpreadsheetLocalizer	DevExpress.Xpf.Spreadsheet.SpreadsheetControlStringId	DevExpress.Xpf.Spreadsheet.Localization DevExpress.Xpf.Spreadsheet
Gauge Controls	GaugeLocalizer	DevExpress.Xpf.Gauges.Localization.GaugeStringId	DevExpress.Xpf.Gauges.Localization
Dock Windows	DockingLocalizer	DevExpress.Xpf.Docking.Base.DockingStringId	DevExpress.Xpf.Docking.Base
Printing-Exporting	PrintingLocalizer	PrintingStringId	DevExpress.Xpf.Printing
Report Designer	ReportDesignerLocalizer	ReportDesignerStringId	DevExpress.Xpf.Reports.UserDesigner.Localization
Data Editors	EditorLocalizer	EditorStringId	DevExpress.Xpf.Editors
Navigation Bar	NavBarLocalizer	NavBarStringId	DevExpress.Xpf.NavBar
PDF Viewer	PdfViewerLocalizer	PdfViewerStringId	DevExpress.Xpf.PdfViewer
SpellChecker	SpellCheckerLocalizer	DevExpress.XtraSpellChecker.Localization.SpellCheckerStringId	DevExpress.XtraSpellChecker.Localization

Example

The following example demonstrates how to localize the DXGrid control via a custom localizer. For other localization approaches, refer to Localizing WPF Controls via Satellite Resource Assemblies.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-localize-the-dxgrid-control-via-the-gridcontrollocalizer-class-e962.

Window1.xaml.cs

using System;
using System.Collections.Generic;
using System.Windows;
using System.Windows.Documents;
using DevExpress.Xpf.Grid;

namespace DXGrid_Localization {

    public partial class Window1 : Window {
        public Window1() {
            InitializeComponent();
            grid.ItemsSource = TaskList.GetData();
        }
        static Window1() {
            GridControlLocalizer.Active = new CustomDXGridLocalizer();
        }

    }

    // Used for populating GridControl with data
    public class TaskList {
        public static List<Task> GetData() {
            List<Task> data = new List<Task>();
            data.Add(new Task() { TaskName = "Complete Project A", StartDate = new DateTime(2009, 7, 1), EndDate = new DateTime(2009, 7, 10) });
            data.Add(new Task() { TaskName = "Test Website", StartDate = new DateTime(2009, 7, 10), EndDate = new DateTime(2009, 7, 12) });
            data.Add(new Task() { TaskName = "Publish Docs", StartDate = new DateTime(2009, 7, 4), EndDate = new DateTime(2009, 7, 6) });
            return data;
        }
    }

    // Used for populating GridControl with data
    public class Task {
        public string TaskName { get; set; }
        public DateTime StartDate { get; set; }
        public DateTime EndDate { get; set; }
    }

    public class CustomDXGridLocalizer : GridControlLocalizer {
        protected override void PopulateStringTable() {
            base.PopulateStringTable();
            // Changes the caption of the menu item used to invoke the Total Summary Editor.
            AddString(GridControlStringId.MenuFooterCustomize, "Customize Totals");
            // Changes the Total Summary Editor's default caption.
            AddString(GridControlStringId.TotalSummaryEditorFormCaption, "Totals Editor");
            // Changes the default caption of the tab page that lists total summary items.
            AddString(GridControlStringId.SummaryEditorFormItemsTabCaption, "Summary Items");
        }
    }
}

Window1.xaml

<Window x:Class="DXGrid_Localization.Window1" 
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        Title="Window1" Height="300" Width="300" >
    <Grid>
        <dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew">
            <dxg:GridControl.View>
                <dxg:TableView AutoWidth="True" ShowTotalSummary="True" />
            </dxg:GridControl.View>
        </dxg:GridControl>
    </Grid>
</Window>

Window1.xaml.vb

Imports System
Imports System.Collections.Generic
Imports System.Windows
Imports System.Windows.Documents
Imports DevExpress.Xpf.Grid

Namespace DXGrid_Localization

    Partial Public Class Window1
        Inherits Window
        Public Sub New()
            InitializeComponent()
            grid.ItemsSource = TaskList.GetData()
        End Sub
        Shared Sub New()
            GridControlLocalizer.Active = New CustomDXGridLocalizer()
        End Sub

    End Class

    ' Used for populating GridControl with data
    Public Class TaskList
        Public Shared Function GetData() As List(Of Task)
            Dim data As New List(Of Task)()
            data.Add(New Task() With {.TaskName = "Complete Project A", .StartDate = New DateTime(2009, 7, 1), .EndDate = New DateTime(2009, 7, 10)})
            data.Add(New Task() With {.TaskName = "Test Website", .StartDate = New DateTime(2009, 7, 10), .EndDate = New DateTime(2009, 7, 12)})
            data.Add(New Task() With {.TaskName = "Publish Docs", .StartDate = New DateTime(2009, 7, 4), .EndDate = New DateTime(2009, 7, 6)})
            Return data
        End Function
    End Class

    ' Used for populating GridControl with data
    Public Class Task
        Private privateTaskName As String
        Public Property TaskName() As String
            Get
                Return privateTaskName
            End Get
            Set(ByVal value As String)
                privateTaskName = value
            End Set
        End Property
        Private privateStartDate As DateTime
        Public Property StartDate() As DateTime
            Get
                Return privateStartDate
            End Get
            Set(ByVal value As DateTime)
                privateStartDate = value
            End Set
        End Property
        Private privateEndDate As DateTime
        Public Property EndDate() As DateTime
            Get
                Return privateEndDate
            End Get
            Set(ByVal value As DateTime)
                privateEndDate = value
            End Set
        End Property
    End Class

    Public Class CustomDXGridLocalizer
        Inherits GridControlLocalizer
        Protected Overrides Sub PopulateStringTable()
            MyBase.PopulateStringTable()
            ' Changes the caption of the menu item used to invoke the Total Summary Editor.
            AddString(GridControlStringId.MenuFooterCustomize, "Customize Totals")
            ' Changes the Total Summary Editor's default caption.
            AddString(GridControlStringId.TotalSummaryEditorFormCaption, "Totals Editor")
            ' Changes the default caption of the tab page that lists total summary items.
            AddString(GridControlStringId.SummaryEditorFormItemsTabCaption, "Summary Items")
        End Sub
    End Class
End Namespace