How to: Localize XAF Application Items Using XAF Tools

• Mar 09, 2024
• 7 minutes to read

This topic describes how to localize typical XAF application items using XAF tools. We recommend reviewing the Application Model Basics and Localization Basics topics before proceeding.

Refer to the How to: Localize an XAF Application topic for information on how to translate XAF applications.

You can localize parts of an XAF application in two ways:

• Using the Localization Tool, which can be invoked from the Model Editor Toolbar. This tool gathers all the localizable values in one grid, provides the import/export functionality, as well as the ability to use the Microsoft Translator service.
• Directly in the Model Editor by translating each localizable value.

We recommend using the Localization Tool to speed up the localization process.

Use the Localization Tool

Start the translation in the platform-agnostic module and then proceed to the platform-specific modules. Follow the steps below to localize each XAF application module with the Localization Tool.

1. Click the Localization button in the Model Editor Toolbar to invoke the XAF Localization window.

   

   

   This window provides the grid editor with all localizable property names, paths, descriptions, and values. A toolbar with the base localization commands is also provided. The Localization Tool topic describes grid columns and this window’s available actions.

2. In the Localization window toolbar, select the target language in the Translation Language drop-down list.

   

   Note

   The text supplied with the standard XAF modules are translated if you have successfully installed satellite assemblies for the target language.

3. Apply the Untranslated non-calculated filter using the Filters action.

   

   This filter selects the properties that have non-empty default language values with Is Translated and Is Calculated unchecked.

4. Translate all the values in the Translated Value column. Move focus to the next row pressing the ENTER key. If there are several properties with the same Default Language value, the Multiple Values Translation dialog is invoked. If you click Yes, the tool translates all these values at once and focuses the next value to be translated.

   

   Note

   • You can use the Translate… button to automate the translation. Select one, several or all rows, and click Translate… or press CTRL+T. In the invoked dialog, select the original language (English by default), click Translate and the Microsoft Translator service translates it. An Internet connection is required for this feature, and automatic translation requires reviewing the results.
   • If you are not fluent in the target language, you can hire a professional translator. Export the selected rows to a CSV file using the Export | Selected records command, and pass this file to the translator. The translator will edit the values in the Translated Value column using a spreadsheet or a plain text editor of their choice. The Description column content helps them see the context. The translated values can be loaded from a CSV file using the Import Action. The file encoding should be UTF-8 if the CSV file contains non-Latin characters.

5. When you have finished the translation, click Save or press CTRL+S to save changes to the Application Model. The translated properties are hidden due to the Untranslated… filter, and the Is Translated checkbox is checked after saving.

   

6. Next, apply the Calculated filter to review the calculated values.

   

7. After closing the Localization window, you can see the localized values in the Model Editor. Save the changes in the Model Editor.

A typical XAF application has platform-specific authentication, security strategy and module versions. For instance, Windows Forms and ASP.NET Web Forms applications can have SchedulerWindowsFormsModule and SchedulerAspNetModule modules. These modules extend the Application Model with localizable properties that are not available at the module level. You can have platform-specific Controllers that provide strings that need to be localized (action captions, tooltips, exceptions, etc.). You should repeat these steps for each platform-specific module.

Localize an XAF Application Directly in the Model Editor

Follow the steps below to localize the main parts of your XAF application directly in the Model Editor. Note that some translation values contain properties’ names (ObjectCaptionFormat, DisplayFormat, etc.) and should not be localized.

1. Select the target language in the Model Editor Toolbar.
2. Set the localized values to the Application root node’s properties.
3. Expand the ActionDesign | Actions node. Set the localized values to all its child nodes’ Caption properties. The ShortCaption and the Tooltip properties are localized automatically, as they expose Caption properties’ values by default. Localize the ConfirmationMessage properties if required.

   Note

   If you do not use the Active Directory authentication, the Log On window (web page) UI elements localization requires particular attention. The Log On and Cancel buttons are Actions. These Actions have Logon and DialogCancel IDs and are localizable in the ActionDesign | Actions node.

4. Expand the ActionDesign | DisableReasons node and set localized values to its child nodes’ Caption properties.
5. Expand the BOModel node and assign localized values to its child nodes’ Caption properties. You can skip nodes of classes that are not represented in the application UI (for example, the XPBaseObject node). Note that localizing ObjectCaptionFormat properties may also be required. The Caption properties of CreatableItems, NavigationItems and Views child nodes are automatically localized as they expose values from class captions by default.
6. Expand the Localization node and set localized values to its child nodes’ Value properties. The Exceptions | UserVisibleExceptions child node localization requires particular attention. You can skip the Exceptions | SystemExceptions node, as it contains exceptions addressed to developers and administrators, and is invisible to end-users in normal application operation.
7. Expand the NavigationItems and localize the Default node caption.

8. If you use the ValidationModule module, expand the Validation node and assign localized values to the child node properties the globe glyph () denotes.

   

9. A typical XAF application has platform-specific versions of the authentication, security strategy and modules. For instance, Windows Forms and ASP.NET Web Forms applications can have SchedulerWindowsFormsModule and SchedulerAspNetModule modules included. These modules extend the Application Model with localizable properties that are not available at the module level. You should repeat these steps for each platform-specific module because you can have platform-specific Controllers that provide strings that need to be localized (Action captions, tooltips, exceptions, etc.).
10. If you do not use the Active Directory authentication type, the Log On window (web page) localization requires particular attention. The AuthenticationStandardLogonParameters Detail View represents this window (web page) content, so navigate to the Views | AuthenticationStandardLogonParameters_DetailView node and set the localized value to its Caption property. Expand the Items child node and localize the LogonText node’s Text property. Localize the UserName and Passwords node captions.

    Note

    This step should be performed separately for Windows Forms and ASP.NET Web Forms applications. Use the Model Editor in each application project to localize the Log On window (web page) UI elements. The Log On and Cancel Actions captions can also be localized in the module project Model. See step 5 for details. The message displayed when the logon fails is localized in the module project Model in the Localization | Exceptions | UserVisibleExceptions | Security node.

11. Invoke the Model Editor for the application project (Windows Forms or ASP.NET Web Forms) to see additional platform-specific Localization child nodes. For instance, in the Windows Forms application Model, you should assign localized values to Confirmations, DialogButtons and FrameTemplates child nodes.

Note

If you received the FormatException or MemberNotFoundException, ensure that you have not localized a property name in a localizable value.

Refer to the following topics to learn how to localize particular messages in an application:

• How to: Localize Custom String Constants
• How to: Localize a WinForms Template
• Localize Validation Messages

The Localize Standard XAF Modules and DevExpress Controls Used in an Application topic describes how to localize built-in XAF Modules and DevExpress controls.