DashboardLocalizer.GetString(DashboardStringId) Method

Gets the string, localized by the current DashboardLocalizer, for the specified user interface element.

Namespace: DevExpress.DashboardCommon.Localization

Assembly: DevExpress.Dashboard.v22.2.Core.dll

NuGet Packages: DevExpress.Dashboard.Core, DevExpress.Win.Dashboard.Design

Declaration

C#

public static string GetString(
    DashboardStringId id
)

VB.NET

Public Shared Function GetString(
    id As DashboardStringId
) As String

Parameters

Name	Type	Description
id	DashboardStringId	A DashboardStringId 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 in DashboardLocalizer class’ descendants, in order to modify the captions (text strings) of visual user interface elements. The GetString method gets a string ID (represented by an appropriate enumeration value) and should return an appropriate string.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetString(DashboardStringId) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-dashboard-recalculate-totals/CS/WinFormsDashboard_RecalculateTotals/Classes/DashboardTotalsHelper.cs#L19

switch (dashboardTotalType) {
    case GridColumnTotalType.Sum: return DashboardLocalizer.GetString(DashboardStringId.GridTotalTypeSum);
    case GridColumnTotalType.Avg: return DashboardLocalizer.GetString(DashboardStringId.GridTotalTypeAvg);

VB.NET

winforms-dashboard-recalculate-totals/VB/WinFormsDashboard_RecalculateTotals/Classes/DashboardTotalsHelper.vb#L29

Case GridColumnTotalType.Sum
    Return DashboardLocalizer.GetString(DashboardStringId.GridTotalTypeSum)
Case GridColumnTotalType.Avg