CaptionHelper.GetLocalizedText(String, String, String) Method

Returns the value of a specified LocalizationItem.

Namespace: DevExpress.ExpressApp.Utils

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public static string GetLocalizedText(
    string groupPath,
    string itemName,
    string defaultText
)

VB.NET

Public Shared Function GetLocalizedText(
    groupPath As String,
    itemName As String,
    defaultText As String
) As String

Parameters

Name	Type	Description
groupPath	String	A string representing the group path to the LocalizationGroup containing the specified localization item.
itemName	String	A string holding the IModelLocalizationItemBase.Name of the required LocalizationItem node.
defaultText	String	A string that will be returned by the GetLocalizedText method, if the specified localization item is not found.

Returns

Type	Description
String	The IModelLocalizationItem.Value of the specified localization item.

Remarks

The Application Model has the Localization node, which allows localization of various constants. The Localization node is used to localize custom strings used in an XAF application. The node contains LocalizationGroup child nodes. Each LocalizationGroup child node contains a set of LocalizationItem child nodes. The GetLocalizedText method allows you to retrieve the value of particular LocalizationItem.

Each child LocalizationGroup node of the Localization node has a group path associated with it. This path is represented by a sequence of parent localization group names separated by a double backslash. Suppose, for example, that the Localization node has the Messages localization group, which in turn has the Custom child localization group. In this instance, the group path for the Custom group is “Messages\Custom”.

To see an example of localizing custom string constants, refer to the How to: Localize Custom String Constants help topic.