DashboardWinLocalizer.GetString(DashboardWinStringId) Method

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

Namespace: DevExpress.DashboardWin.Localization

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

NuGet Package: DevExpress.Win.Dashboard

Declaration

C#

public static string GetString(
    DashboardWinStringId id
)

VB.NET

Public Shared Function GetString(
    id As DashboardWinStringId
) As String

Parameters

Name	Type	Description
id	DashboardWinStringId	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 DashboardWinLocalizer 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 snippets (auto-collected from DevExpress Examples) contain references to the GetString(DashboardWinStringId) 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-custom-items-extension/CS/CustomItemExtension/CustomItems/Heatmap/HeatmapOptionsControl.cs#L172

if(!allowChanges && ((percents && percentScale.HasChanges) || (!percents && absoluteScale.HasChanges))) {
    if(XtraMessageBox.Show(LookAndFeel, this, DashboardWinLocalizer.GetString(DashboardWinStringId.MapLayerOptionsResetCustomScale),
        DashboardWinLocalizer.GetString(DashboardWinStringId.MessageBoxWarningTitle), MessageBoxButtons.YesNo, MessageBoxIcon.Warning) == DialogResult.No) {

winforms-dashboard-custom-properties/CS/WinForms-Dashboard-Custom-Properties/Modules/DashboardDescriptionModule.cs#L25

RibbonPage page = ribbon.GetDashboardRibbonPage(DashboardBarItemCategory.None, DashboardRibbonPage.Home);
RibbonPageGroup group = page.Groups.GetGroupByText(DashboardWinLocalizer.GetString(DashboardWinStringId.RibbonPageDashboardCaption));
BarButtonItem barItem = CreateBarItem("Dashboard Description", barImage);

VB.NET

winforms-dashboard-custom-properties/VB/WinForms-Dashboard-Custom-Properties/Modules/DashboardDescriptionModule.vb#L25

Dim page As RibbonPage = ribbon.GetDashboardRibbonPage(DashboardBarItemCategory.None, DashboardRibbonPage.Home)
Dim group As RibbonPageGroup = page.Groups.GetGroupByText(DashboardWinLocalizer.GetString(DashboardWinStringId.RibbonPageDashboardCaption))
Dim barItem As BarButtonItem = CreateBarItem("Dashboard Description", barImage)

winforms-dashboard-custom-items-extension/VB/CustomItemExtension/CustomItems/Heatmap/HeatmapOptionsControl.vb#L187

If Not allowChanges AndAlso ((percents AndAlso percentScale.HasChanges) OrElse (Not percents AndAlso absoluteScale.HasChanges)) Then
    If XtraMessageBox.Show(LookAndFeel, Me, DashboardWinLocalizer.GetString(DashboardWinStringId.MapLayerOptionsResetCustomScale), DashboardWinLocalizer.GetString(DashboardWinStringId.MessageBoxWarningTitle), MessageBoxButtons.YesNo, MessageBoxIcon.Warning) = DialogResult.No Then
        allowChanges = True