XafApplication.CustomizeLanguage Event

Occurs after a language has been set for the application internally.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v24.1.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public event EventHandler<CustomizeLanguageEventArgs> CustomizeLanguage

VB.NET

Public Event CustomizeLanguage As EventHandler(Of CustomizeLanguageEventArgs)

Event Data

The CustomizeLanguage event's data class is CustomizeLanguageEventArgs. The following properties provide information specific to this event:

Property	Description
LanguageName	Specifies the language currently used by the application.
PreferredLanguageName	Specifies the language currently set for the Application Model‘s IModelApplication.PreferredLanguage property.
UserLanguageName	Specifies the language which is set in the user’s operating system or passed by the Internet browser.

Remarks

Handle this event to set the required language to be used by the application. To get the language currently set, use the handler’s CustomizeLanguageEventArgs.LanguageName property. In addition, you can get the language which is set in the user’s operating system or passed by the Internet browser. For this purpose, use the handler’s CustomizeLanguageEventArgs.UserLanguageName property. To get the language which is currently set for the Application node’s IModelApplication.PreferredLanguage property, use the handler’s CustomizeLanguageEventArgs.PreferredLanguageName property. Note that the language you set in this event handler cannot be changed via the Application Model at runtime.

The following code snippets demonstrate how to set German, instead of the default language.

WinForms

C#

using System;
using DevExpress.ExpressApp;
//...
static class Program {
   public static void Main() {
      //...
      MySolutionWindowsFormsApplication application = new MySolutionWindowsFormsApplication(); 
      application.CustomizeLanguage += application_MyLanguage;
      // ...
   }
   private static void application_MyLanguage(object sender, CustomizeLanguageEventArgs e) {
      e.LanguageName = "de";
      //To use the default (English) language, use the following code line instead:
      //e.LanguageName = "en";
   }
}

VB.NET

Imports System
Imports DevExpress.ExpressApp
'...
Friend Class Program
   Public Shared Sub Main()
      '...
      Dim _application As MySolutionWindowsFormsApplication = _
      New MySolutionWindowsFormsApplication()
      AddHandler _application.CustomizeLanguage, AddressOf application_CustomizeLanguageEventArgs
      ' ...
   End Sub
   Private Shared Sub application_CustomizeLanguageEventArgs(ByVal sender As Object, _
         ByVal e As CustomizeLanguageEventArgs)
      e.LanguageName = "de"
      'To use the default (English) language, use the following code line instead:
      'e.LanguageName = "en"
   End Sub
End Class

ASP.NET Web Forms

C#

using System;
using System.Collections.Generic;
using System.Configuration;
using DevExpress.ExpressApp;
using DevExpress.ExpressApp.Web;
//...
public class Global : System.Web.HttpApplication {
    protected void Session_Start(Object sender, EventArgs e) {       
        WebApplication.Instance.CustomizeLanguage += 
            new EventHandler<CustomizeLanguageEventArgs>(instanse_MyLanguage);
        //...
    }
    private static void instanse_MyLanguage(object sender, CustomizeLanguageEventArgs e) {
        e.LanguageName = "de";
        //To use the default (English) language, use the following code line instead:
        //e.LanguageName = "en";
    }
    //...
}

VB.NET

Imports System
Imports System.Collections.Generic
Imports System.Configuration
Imports DevExpress.ExpressApp
Imports DevExpress.ExpressApp.Web
'...
Public Class [Global]
    Inherits System.Web.HttpApplication
    Protected Sub Session_Start(ByVal sender As Object, ByVal e As EventArgs)
        AddHandler WebApplication.Instance.CustomizeLanguage, AddressOf instanse_MyLanguage
        '...
    End Sub
    Private Shared Sub instanse_MyLanguage(ByVal sender As Object, ByVal e As CustomizeLanguageEventArgs)
        e.LanguageName = "de"
        'To use the default (English) language, use the following code line instead:
        'e.LanguageName = "en";
    End Sub
    '...
End Class

Of course, you should localize properties in the “de” language before running the application with the code above. Otherwise, the default (English) language will be used.

You can use the IModelApplication.PreferredLanguage property of the Application Model’s Application node to set a language, if you do not use any conditions to determine the language the application should use.