Use the XRM tooling common login control in your client applications

Start Microsoft Visual Studio, and create a new project.

In the New Project dialog box:

1. From the list of installed templates, expand Visual C#, and select CRM SDK Templates.
   
   
2. Ensure that .NET Framework 4.5.2 is selected.
   
   
3. Select WPF Application for CRM.
   
   
4. Specify the name and location of the project, and click OK.
   
   

To test the project:

1. Save the project and press F5 or click Debug > Start Debugging to verify if the project compiles successfully. On successful compilation, you’ll see a MainWindow with Login to CRM button. Click the button to display the common login control.
   
   
2. Test the authentication by providing your credentials to connect to CRM, and then click Login. A message displays your CRM connection status.
   
   

Open an existing WPF application project in Visual Studio. For this example, let’s assume that the name of your WPF application project is SampleWPFApp.

Add the common login control template to your project.

1. In the Solution Explorer pane, right-click the project name, and click Add > New Item.
   
   
2. In the Add New Item dialog box, from the list of installed templates, expand Visual C#, and select CRM SDK Templates. Click CRM Login Form for WPF Applications, and click OK.
   
   

The newly added CrmLoginForm1.xaml login control is displayed in the XAML designer area. If it doesn’t, double-click the CrmLoginForm1.xaml file in the Solution Explorer pane.

You must now call the newly added login control from your application. To do this, add a Button control on your MainWindow.xaml file, and set the name and content to btnSignIn and Sign in to CRM respectively.

Double-click the button to add code for the click event of the btnSignIn button in the MainWindow.xaml.cs file.

Add the following sample code in the click event of the btnSignIn button to call the CrmLoginForm1 control, and create an instance of the CRM connection object.

// Establish the Login control.
CRMLoginForm1 ctrl = new CRMLoginForm1();

// Wire event to login response. 
ctrl.ConnectionToCrmCompleted += ctrl_ConnectionToCrmCompleted;

// Show the login control. 
ctrl.ShowDialog();

// Handle the returned CRM connection object.
// On successful connection, display the CRM version and connected org name 
if (ctrl.CrmConnectionMgr != null && ctrl.CrmConnectionMgr.CrmSvc != null && ctrl.CrmConnectionMgr.CrmSvc.IsReady)
{
    MessageBox.Show("Connected to CRM! Version: " + ctrl.CrmConnectionMgr.CrmSvc.ConnectedOrgVersion.ToString() + 
    " Org: " + ctrl.CrmConnectionMgr.CrmSvc.ConnectedOrgUniqueName, "Connection Status");

    // Perform your actions here
}
else
{
    MessageBox.Show("Cannot connect; try again!", "Connection Status");
}

Add the definition of the ctrl_ConnectionToCrmCompleted event below the click event of the button:

private void ctrl_ConnectionToCrmCompleted(object sender, EventArgs e)
{
    if (sender is CRMLoginForm1)
    {
        this.Dispatcher.Invoke(() =>
        {
            ((CRMLoginForm1)sender).Close();
        });
    }
}

This is how your MainWindow.xaml.cs file appears after adding code from the previous two steps:

To test the project:

1. Save the project and press F5 or click Debug > Start Debugging to verify if the project compiles successfully. On successful compilation, you will see a MainWindow with the new Sign In to CRM button. Click it to display the common login control.
   
   
2. Test the authentication by providing your credentials to connect to CRM, and then click Login. If successful, a message appears stating the version and the organization name that you are connected to. Click OK to close the message.
   
   
3. If you click Sign In to CRM again, the application prompts you to either choose the saved credentials from the last sign-in activity, or to re-enter the new credentials.