A blog offering various X++ code snippets and tips for Microsoft Dynamics AX

Tuesday, July 29, 2008

Traversing run time controls

Welcome to another AX development lesson.

Today i will discuss traversing controls created at run time to get/set their properties or use them in your code.

First, you have to get a reference to the formDesign of your form. This can be done by calling element.design() in your form. don't forget that you can pass this to as a paramter to a method, so you will be able to process the controls in a seperate class. You method has to accapet a formDesign variable as a parameter as shown in the following code:

public void controlsProcessor(FormDesign _formDesign)
  FormBuildControl formBuildControl;
  Counter counter;
  FormCheckboxControl formCheckboxControl

  for (counter = 1; counter <= formDesign.controlCount(); counter++)
    // If current value of counter represent a valid control id in the form
    formBuildControl = formDesign.controlNum(counter);

    // If the current looped control is a textbox
    if (SysFormRun::controlType(classidget(formBuildControl)) == FormcontrolType::CheckBox)
      // Assign it to a formCheckboxControl
      // to get access to properites and methods
      // usually found on checkboxes
      formCheckboxControl = formDesign.controlNum(counter);

      // If the checkbox is checked
      if (formCheckboxControl.value())
      // Do your custom processing

Obviously you can use any type of form controls not just checkboxes by using the corresponding control classes.

You could call the above method from a form by using the following line of code:


If you any questions or comments e-mail me on: mirko@mirkobonello.com

Saturday, July 26, 2008

Creating a Form at Run Time

Welcome to another AX development lesson.

In this lesson I shall discuss how we can create a form at run time and add it to the AOT.

Here, we have to use various AX classes which are found under the System Documentation node in the AOT.

The class FormBuild is the base canvas on which we start building our form and on which our form level method have to be added. Therefore, we assign a new Form object (which resembles our form node in the AOT) and assign it to the FormBuild's form.

However, just like in standard AOT form design, we cannot add controls directly to the FormBuild but we need a FormBuildDesign class on which we will continue adding the rest of the controls.

We also need to add DataSources (if required) to the form object. Remember the form object is representing one form's route node in the AOT and your code has to rsemble the tree structure in the AOT i.e.

Form -> Methods
-> DataSources
-> Design -> Controls

The following job should make things clearer:

static void createFormAtRunTime(Args _args)
  TreeNode formlist;
  Form formNode;
  FormBuild formBuild = new FormBuild('MyRunTimeForm');
  FormBuildDesign formDesign;
  FormBuildTabControl formTab;
  FormBuildTabPageControl formTabPage;
  FormBuildDataSource formDatasource;
  FormBuildGridControl formGrid;
  XPPCompiler compiler;
  str dataSourceName;
  int dataSourceId;
  str sourceCode, methodName;
  methodName = 'runTimeMethod';
  sourceCode = @'
        void runTimeMethod()
  compiler = new XppCompiler();

  if (sourceCode && compiler.compile(sourceCode))
    // Assign to formBuild's base 'canvas' to a form object
    // This resembles the top node of a form in th AOT
    // To this form object (form node) we add designs and datasources
    formNode = formBuild.form();

    // Add ClassDeclaration
    formBuild.addMethod('classDeclaration', 'class FormRun extends ObjectRun     \n{}\n');

    // Add our previously built method
    formBuild.addMethod(methodName, sourceCode);

    // Add a new form Design
    formDesign = formNode.design();

    // Add a new tab - header
    formTab = formDesign.addControl(FormControlType::Tab, 'Header');
    formTab.widthMode(1); //column Width

    // Add a new tab page - overview
    formTabPage = formTab.addControl(FormControlType::TabPage, 'Overview');
    formTabPage.widthMode(1); //column Width
    formTabPage.heightMode(1); //column Height

    formlist = infolog.findNode('Forms');

    // Add a DataSource - SalesTable
    formDatasource = formNode.addDataSource(tablestr(SalesTable));
    dataSourceName = formDatasource.name();
    dataSourceId = formDatasource.id();

    // Add a Grid
    formGrid = formTabPage.addControl(FormControlType::Grid,tablestr     (SalesTable)+'Grid');

    // Add fields to the Grid
    formGrid.addDataField(dataSourceId, fieldNum(SalesTable, SalesId));
    formGrid.addDataField(dataSourceId, fieldNum(SalesTable, CustAccount));

    // Commit changes - same like pressing Save button in the AOT
    formNode = formList.AOTfindChild('MyRunTimeForm');

If we did not have AX's Morphx/AOT features we would have to write all that code just to create a simple form like the one generated if you run the above code and open the form it generates and adds to the AOT.

That's all for this lesson!

See you next time!

If you any questions or comments e-mail me on: mirko@mirkobonello.com

Compiling and running code at run time

Welcome to another lesson.

Here I will discuss how you can compile and run your code at run time. Similar to the scenario in the previous lesson, you might want to create certain code on the fly, when at compile time you do not know what should this code consist of. Therefore, you build the source code as a string based on certain conditions in your code.

Beware though, that this might pose a security risk and you must always call assert() on a valid (not null) SecurityPermission object before execute code which compiles and runs other code at run time. At the end of your dangerous code, you should then revert the permissions by using the following line of code:


Note: For the sake of clarity I will skip code relating to permissions in this lesson.

Let's get down to a simple example:

static void compileAtRunTime(Args _args)
  XppCompiler compiler;
  str sourceCode;
  sourceCode = @'
          static void runTimeMethod()

  compiler = new XppCompiler();

  // If some source code exists and it successfully compiled
  if (sourceCode && compiler.compile(sourceCode))
    // Execute the source code
    // Displays an infolog with "hello"

Obviously, the above code is not very useful, because the source code is hardcoded. In practice you would build your source code based on different conditions that you want to cater for.

If you any questions or comments e-mail me on: mirko@mirkobonello.com

Friday, July 25, 2008

Invoke a method at run time

Welcome to this lesson.

Through the Dict classes, AX allows you to invoke a particular method at run time.

This is useful if you want to call a different method based on some other condition which you do not know at design/compile time.

The following is a simple example:

static void invokeFindOnCustTable(Args _args)
  // Create an instance of dictTable passing a table as parameter
  DictTable dictTable = new DictTable(tableNum('CustTable'));
  CustTable customer;
  // Check if CustTable has method 'find'
  if (tableHasStaticMethod(dictTable, identifierstr('find')))
    // Invoke find method on CustTable at runtime
    customer = dictTable.callStatic(
      tableStaticMethodStr(CustTable, Find), '4000');

  info (customer.Name); // Displays Light and Design in AX 4 Demo Data

Here is another example which executes an object method on a class, if it exists:

static void invokeFindOnAClass(Args _args)
  // Table buffers
  SalesTable salesTable;

  // Objects
  SysDictClass dictClass;
  SalestableType salesTableType;
  dictClass = new SysDictClass(classNum('SalesTableType'));

  salesTable = SalesTable::find('00021_036');

  salesTableType = SalestableType::construct(salesTable);

  // If 'SalesTableType' has method delete
  if (dictClass.HasObjectMethod(identifierstr('delete')))
    // Invoke object method 'delete'
    // passing an object instance on which to execute the method
    dictClass.callObject('delete', salesTableType);

Code of this post currently tested on:

Dynamics AX 4.0
Dynamics AX 2009

If you any questions or comments e-mail me on: mirko@mirkobonello.com