CaptionHelper Class

Exposes static methods used to localize display captions in an XAF application.

Namespace: DevExpress.ExpressApp.Utils

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public class CaptionHelper

VB.NET

Public Class CaptionHelper

Remarks

CaptionHelper is an auxiliary class that deals with the localization of display captions. Since CaptionHelper requires the Application Model to work correctly, you cannot use CaptionHelper methods until the application is initialized.

For more information on how to use the CaptionHelper class to localize custom strings, refer to the following topics:

• How to: Localize Custom String Constants
• Access Caption Helper in Custom Endpoint Methods

Usage Considerations

In most cases, it is highly recommended that you use ICaptionHelperProvider rather than the static API exposed by the CaptionHelper class. Note that the CaptionHelper static API is not supported in Backend Web API Service as well as the Reports and Dashboards modules. Additionally, if your business objects are used in Web API, dashboards, or reports, these business objects should also exclusively use ICaptionHelperProvider.

The CaptionHelper static API is required to obtain user-specific localized strings from a user Model Differences Storage. However, you can only use it in contexts where XafApplication is initialized, such as:

• XAF controllers
• Custom property editors
• Application modules

Inheritance

Object

CaptionHelper