Call your Ax customization from Visual Studio C# code

How about calling your Axapta customizations (Classes / Class & Table methods / Enums) from your EP User control?

For this you need your X++ code resources available for use in Visual Studio. A proxy can do it for you. Ax already has this proxy defined for you as Proxies static file that is maintained in the AOT. You need to add references for your classes, methods or enums that you want to access from User Controls to this existing proxy.

Step 1

Add to the proxy

  • In the AOT, Go to Web –> Web Files –> Static Files –> Proxies file
  • Right-click the Proxies file, and then click Edit.
  • Use the Web Application Editor to add definitions for the additional items that you want to include in the proxy. You can use the existing items in the proxy as a template for how to add more items.

    To add an enum, use the following syntax.
    /enum:EnumName

    To add a class that has methods, use the following syntax.

    /class:ClassName
    /method:ClassName.MethodName

    To add a table with methods, use the following syntax.

    /table:TableName
    /method:TableName.MethodName
  • When you are finished making changes, close the Web Application Editor and be sure to save the changes.

Step 2

Deploy the updated proxy

  • In Ax, click Microsoft Dynamics AX > Tools > Development Tools > Web development > Proxies.
  • In the Generate Proxies window, click Generate in the Development Web Site group. After several moments, the proxies will be generated for the Enterprise Portal Web site.

Step 3

Reference proxy

  • Open the Visual Studio project for your User Control.
  • In Solution Explorer, right-click the App_Code group. Click Generate Proxies to create the C# files that provide the interface for the proxy.
  • To view the C# files generated, expand the Proxies folder in the App_Code group. View the individual files to see details about what each file accesses.

To use the proxy from C# code for the User Controls, you must add a reference in your code. The following using statement makes the content of the proxy available to your code.

using Microsoft.Dynamics.Portal.Application.Proxy;

Step 4

Use items added in the proxy

Some items in the proxy such as enums can be accessed directly without any additional code. Accessing methods from the proxy requires passing the IAxaptaAdapter object together with the method call. This object is part of the AxSession object. Add the following helper method to the C# file for the User Control in your Visual Studio project to allow for the AxSession object to be retrieved.

private ISession AxSession
{
get
{
AxBaseWebPart webpart = AxBaseWebPart.GetWebpart(this);
return webpart == null ? null : webpart.Session;
}
}

When you call the method from the proxy, use this helper method to retrieve the IAxaptaAdapter object. The following example calls the AddNumber method from the Test class.

protected void Button_AddNo(object sender, EventArgs e)
{
string test_result;
using (IAxaptaAdapter a = this.AxSession.AxaptaAdapter)
{
test_result = Test.AddNumber(a, Convert.ToInt16(No1.Text), Convert.ToInt16(No2.Text));
Total.Text = test_result;
}
}
If you liked the story and want to see more of this kind of content, please follow our twitter handle @CursorRun or FB page @CursorRun
Default image
Rahul Sharma
Rahul is a technology enthusiast, solutions architect, trainer, and blogger, working on various Microsoft and open source solutions with more than 18 years of industry experience. He specially takes interest in designing enterprise applications, cloud integrations, IoT, and other architecture rich business solutions.

2 Comments

  1. I am using VS 2008 and not getting the proxies as you have mentioned in Step 3 and also not able to use my class in button click event as you mentioned in Step 4?

    Waiting for ur reply.

  2. Hi Khan,

    Can you elaborate more on this? What kind of problems you facing?

    To help you and provide you accurate solution, I need more information about the errors you getting while trying above steps.

    Happy new year!!!

Leave a Reply

%d bloggers like this: