ICaptionHelperProvider Interface

Provides access to the ICaptionHelper service.

Namespace: DevExpress.ExpressApp.Services.Localization

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public interface ICaptionHelperProvider

VB.NET

Public Interface ICaptionHelperProvider

Remarks

Refer to the following help topics to find examples on how to use this service in different scenarios:

• Access Object Space, Security System, Caption Helper, and XAF Modules in the ASP.NET Core Environment
• Access Object Space, Security System, and 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