Skip to main content

XtraLocalizer<T>.GetLocalizedString(T) Method

Gets the string, localized by the current XtraLocalizer<T>, for the specified user interface element.

Namespace: DevExpress.Utils.Localization

Assembly: DevExpress.Data.v24.1.dll

NuGet Package: DevExpress.Data

Declaration

public virtual string GetLocalizedString(
    T id
)

Parameters

Name Type Description
id T

A T enumeration value specifying the UI element whose caption (text) is to be localized.

Returns

Type Description
String

A String representing the text to be displayed within the specified UI element.

Remarks

This method should be overridden a XtraLocalizer<T> class’ descendants, in order to modify the captions (text strings) of visual user interface elements. The GetLocalizedString method gets a string ID (represented by an appropriate enumeration value) and should return an appropriate string.

Example

The code below demonstrates how you can localize Vertical Grid‘s captions in the row header context menu.

using DevExpress.XtraVerticalGrid.Localization;

VGridLocalizer.Active = new MyVGridLocalizer();

class MyVGridLocalizer : VGridLocalizer {
    public override string Language { get { return "English"; } }
    public override string GetLocalizedString(VGridStringId id) {
        switch (id) {
            case VGridStringId.MenuPropertySortAscending: return "Sort Ascending";
            case VGridStringId.MenuPropertySortDescending: return "Sort Descending";
            case VGridStringId.MenuPropertyClearSorting: return "Clear Sorting";
            case VGridStringId.MenuPropertyClearSortingAllProperties: return "Clear All Sorting";
            default: return base.GetLocalizedString(id);
        }
    }
}
See Also