GanttLocalizer.GetString(GanttStringId) Method

Returns a caption or a date-time format for the specified visual element.

Namespace : DevExpress.XtraGantt.Localization

Assembly : DevExpress.XtraGantt.v25.2.dll

NuGet Package : DevExpress.Win.Gantt

Declaration

C#
VB.NET

csharp

public static string GetString(
    GanttStringId id
)

Public Shared Function GetString(
    id As GanttStringId
) As String

Parameters

Name	Type	Description
id	GanttStringId

A value that specifies a visual element for which to return a caption or date-time format.

Returns

Type	Description
String

A String value that specifies a caption or date-time format.

Example

The code below shows how to localize the date-time format for days in the timescale ruler and captions for commands in a Ribbon control.

C#
VB.NET

csharp

using DevExpress.XtraGantt.Localization;

GanttLocalizer.Active = new MyGanttLocalizer();

public class MyGanttLocalizer : GanttLocalizer {
    public override string GetLocalizedString(GanttStringId id) {
        switch (id) {
            case GanttStringId.BothPanelsVisibilityCaption: return "Task List and Chart"; break;
            case GanttStringId.DayFormat: return "dddd, d"; break;
            default: return base.GetLocalizedString(id);
        }
    }
}

Imports DevExpress.XtraGantt.Localization

GanttLocalizer.Active = New MyGanttLocalizer()

Public Class MyGanttLocalizer
    Inherits GanttLocalizer

    Public Overrides Function GetLocalizedString(ByVal id As GanttStringId) As String
        Select Case id
            Case GanttStringId.BothPanelsVisibilityCaption
                Return "Task List and Chart"
            Case GanttStringId.DayFormat
                Return "dddd, d"
            Case Else
                Return MyBase.GetLocalizedString(id)
        End Select
    End Function
End Class