Tuesday, August 25, 2009

“Go to main table” on a RunBase dialog control

In one of my blog posts, I have been posed with the following question:

“how to achieve go to main table on dialog field.
for example a dialog is having a field of lookup custAccount, now what i need to have a go to main table functionality on the same.”

So, the short answer is: It is not possible to override jumpRef method directly on the dialog control. This is due to the fact that in order to show the “Go to Main table” link in the context menu of a control, you need to actually override that method on the form, which is later used to draw the context menu.

There are 3 possible ways that you can achieve the same functionality though, that I would like to briefly discuss here:

  1. Recommended Don’t bother with the dialog. Simply create a form, and override the jumpRef method on the needed control on the form. To demonstrate this behavior, you can use the Tutorial_RunBaseForm class and form. Override the jumpRef method, put the code to call the main form there. And you are done. Simple, and does not require a lot of coding. There is a lot of confusion, where junior AX developers think it will require a lot of code changes to replace a dialog with a form. This is not entirely that hard, as RunBase classes can use a regular AOT form instead of the regular dialog.
  2. Use controlMethodOverload approach, and create the controlName_context() method, which is executed when you try to open the context menu on the specified control. Inside this method, build the context menu from scratch. This way, only the items you want to be shown will be present in the context menu. Note: this means, that standard context menu items, like Setup, will not be shown in the menu (unless you add and handle them).
  3. Use controlMethodOverload approach, as in the previous example, but instead of overriding context() method, override the showContextMenu method. This will allow you to add your custom context menu items to the standard context menu. This does not seem to work on Axapta 3.0 though, and I did not try to figure out why. Note you need to uncomment some code in order to enable this approach (I left a TODO comment for that).

I have made the necessary changes, demonstrating the latter 2 approaches, using the class located under Classes\Tutorial_RunBaseBatch. You can download the xpo here (it contains only the USR layer changes).

The class used for drawing the context menu in the example is called PopupMenu. A good example of how this class can be used in the application is available in AOT under Forms\Tutorial_PopupMenu. Some information, along with another example, is available on MSDN.

A while ago, I have suggested some minor changes to the Dialog framework classes, which allow to simplify the process of overriding control event methods on the dialog. The original post can be found through this link: http://kashperuk.blogspot.com/2007/06/3-dialog-extensions.html

Let me know if any of this requires more clarification.

7 comments:

  1. Great post, thank you very much =)

    ReplyDelete
  2. How did you determine that "Fld2_1" was the control name to reference?

    ReplyDelete
  3. Well, you can just view the setup for the dialog when it opens - the name of the control will be shown. It is generated each time you open the form, and unless the controls are added/removed on the dialog, it will stay the same.
    If you want to be absolutely certain that you are using the right control, check the link above to the dialog extensions - there you will be able to manually specify the control name when adding it to the dialog.

    ReplyDelete
  4. Thanks! Used #3 method. I already knew controlName_modified() approach but didn`t managed to do it for going to main table.
    But I`ve never heard about controlName_context() or controlName_showContextMenu()
    How do you know such things? It`s not on msdn or anywhere else. Tell me your secret source :)

    ReplyDelete
  5. There is no secret :)
    The part after the underscore, like _showContextMenu or _context are simply method names available on the control of the specific type, FormStringControl, for example. So by viewing which methods are available there, you know, which should be the method names for them to process these events at runtime

    ReplyDelete
  6. If i want values of a field in a grid to appear as link and by clicking on the link it opens the Form(Go to main table), how can this be achieved?

    e-mail: nikunj1404@ymail.com

    ReplyDelete
  7. Well, you just need a working relation set up to that table.
    And then the form needs to be in View mode.
    The link will then be added automatically by the kernel.

    That's assuming you are using one of the later versions of AX

    ReplyDelete

Please don't forget to leave your contact details if you expect a reply from me. Thank you