XafApplication.ApplicationName Property

Specifies the application’s name.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v20.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public string ApplicationName { get; set; }

VB.NET

Public Property ApplicationName As String

Property Value

Type	Description
String	A string value that represents the application’s name.

Remarks

The ApplicationName value is not displayed in a UI (to set a visible name, use the XafApplication.Title or IModelApplication.Title property). Instead, it is used in the internal application flow. For instance, the ApplicationName is used to check if the database is compatible with the current application when the XafApplication.CheckCompatibilityType property is set to ModuleInfo. If the application name differs from the name stored in the database, the following error occurs in this mode: “Database is designed for the ‘MyApplication1’ application while you are running the ‘MyApplication2’ application”.

If you want to change the name stored in the database manually, locate the ModuleInfo table, and find the record with the True value in the IsMain column and update the Name value there:

UPDATE ModuleInfo SET Name='NewApplicationName' WHERE IsMain='true'

The ModuleInfo table is not created and the ApplicationName value is not stored in the database when the XafApplication.CheckCompatibilityType value is DatabaseSchema.

If you need to rename the application itself, use the Application Designer or set the ApplicationName property in code:

C#

static class Program {
   static void Main() {
      //...
      MySolutionWindowsFormsApplication application = new MySolutionWindowsFormsApplication();
      application.ApplicationName = "MyApplicationName";
      //...
   }
}

VB.NET

Friend Class Program
   Shared Sub Main()
      '...
      Dim _application As MySolutionWindowsFormsApplication = 
      New MySolutionWindowsFormsApplication()
      _application.ApplicationName = "MyApplicationName"
      '...
   End Sub
End Class

When you create an XAF application using the Solution Wizard, the ApplicationName property is set to the application solution name.

Note

To use the same database in several XAF applications with the XafApplication.CheckCompatibilityType set to ModuleInfo, set the ApplicationName of all applications to the same value.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ApplicationName property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XAF_how-to-implement-middle-tier-security-with-the-wcf-service-e4036/CS/ConsoleApplicationServer/ServerApplication.cs#L17

// Change the ServerApplication.ApplicationName property value. It should be the same as your client application name.
this.ApplicationName = "PermissionPolicyExample";

XAF_how-to-prevent-sorting-and-grouping-by-certain-columns-in-a-listview-e1254/CS/WinWebSolution.Web/WebApplication.cs#L49

//
this.ApplicationName = "WinWebSolution";
this.Connection = this.sqlConnection1;

XAF_how-to-initialize-an-object-created-via-the-new-action-e229/CS/InitializeNewActionObject.Web/ApplicationCode/WebApplication.cs#L45

//
this.ApplicationName = "HowToInitializeObjectCreatedViaNewAction";
this.Modules.Add(this.module1);

XAF_initiate-a-delayed-long-running-operation-and-process-it-on-the-server-without-blocking-e4228/CS/LongRunningOperations.Web/WebApplication.cs#L74

//
this.ApplicationName = "LongRunningOperations";
this.Connection = this.sqlConnection1;

XAF_how-to-implement-a-custom-attribute-to-customize-the-application-model-e1679/CS/DXExample.Web/ApplicationCode/WebApplication.cs#L36

//
this.ApplicationName = "DXExample";
this.Modules.Add(this.module1);

VB.NET

XAF_how-to-implement-middle-tier-security-with-the-wcf-service-e4036/VB/ConsoleApplicationServer/ServerApplication.vb#L19

' Change the ServerApplication.ApplicationName property value. It should be the same as your client application name.
Me.ApplicationName = "PermissionPolicyExample"

XAF_how-to-prevent-sorting-and-grouping-by-certain-columns-in-a-listview-e1254/VB/WinWebSolution.Web/WebApplication.vb#L50

'
Me.ApplicationName = "WinWebSolution"
Me.Connection = Me.sqlConnection1

XAF_how-to-initialize-an-object-created-via-the-new-action-e229/VB/InitializeNewActionObject.Web/ApplicationCode/WebApplication.vb#L45

'
Me.ApplicationName = "HowToInitializeObjectCreatedViaNewAction"
Me.Modules.Add(Me.module1)

XAF_initiate-a-delayed-long-running-operation-and-process-it-on-the-server-without-blocking-e4228/VB/LongRunningOperations.Web/WebApplication.vb#L66

'
Me.ApplicationName = "LongRunningOperations"
Me.Connection = Me.sqlConnection1

XAF_how-to-implement-a-custom-attribute-to-customize-the-application-model-e1679/VB/DXExample.Web/ApplicationCode/WebApplication.vb#L38

'
Me.ApplicationName = "DXExample"
Me.Modules.Add(Me.module1)