How to: Add a Task Pane Page

Dynamics AX 2009

The Microsoft Dynamics AX client task pane provides access to useful utilities or links to other resources. For example, when you press CTRL-F1 the task pane opens and displays the Global Search utility. The task pane includes a framework that enables you to add new task pane pages. You can use task pane pages to provide access to a new utility or to link to a variety of resources.

To add to the task pane, use the Application Object Tree (AOT) to construct an HTML task pane page. The AOT provides tools to build a task pane page, add units of functionality known as weblets to that page, and add scripts. To enable a task pane page to execute a utility or to link to another resource, use a weblet or a script. For more information about weblets, see Weblets Overview.

For example, you can create a task pane page that uses a weblet to execute any AOT defined class that has an action menu item. You can use the specified class to initiate or perform a wide variety of actions. For more information about classes, see Classes in X++.

To add a task pane page to the task pane, follow these steps:

  • Create a task pane page. To add functionality to the task pane page, add weblets, script, or links that enable you to perform the available actions.

  • Add the task pane page to the task pane menu. The task pane page cannot be displayed until you add a menu item for that page to the task pane menu.

In this procedure, you will create a task pane page. The procedure shows how to use a weblet to access an existing AOT class.

To create a task pane page

  1. Press CTRL-D to open the AOT. Expand Application Documentation, right-click Task Panes, and then click New. A task pane page node is added to the task pane list in the AOT.

  2. Right-click the new task pane page node, and then click Properties. The Properties window opens and displays the default properties for the task pane page. Set values for the following task pane page properties.

    Property

    Value

    Description

    Specify a description of the task pane page.

    Name

    Specify a name that uniquely identifies the task pane page.

    Title

    Specify the text that appears as the task pane heading for this page.

  3. Right-click the task pane page node, and then click Save. Close the properties window.

  4. Right-click the task pane page node, and then click Edit. The Task Pane Editor opens. Use the editor to add text to the task pane page. Click in the Normal tab, and then enter text to display on the task pane page. For example, enter Sample Task Pane Page and then press ENTER.

  5. Use the Task Pane Editor to add functionality to the task pane page by adding weblets. For example, open the Insert menu, click Link, and then click Class processing. The Insert link to class window opens. In the Insert link to class window, enter the following values.

    Property

    Value

    Link text

    Specify the text message for the link. This text will appear in the body of the task pane page.

    Menu item action

    Click the name of the class you want to execute. For example, you can use the task pane page to open the System Information window by clicking SystemInfo.

    Tooltip

    Specify the text to display when the mouse pauses on the link.

  6. Click OK to close the Insert link to class window. If you are prompted to save the changes, click Yes, and then click OK.

  7. In the Task Pane Editor, press the ENTER key to move to the next line.

    NoteNote

    To include additional formatting and functionality, add more weblets to the task pane page. For example, in the Task Pane Editor menu click Insert, click Application element, and then click Weblet. The weblets window opens. To display the current system date and time when the task pane page opens, click Date/Time Weblet and then click OK.


  8. When you have finished modifying the task pane page, click the File menu, and then click Save.

    NoteNote

    To view or modify the HTML or script associated with the task pane page, click the HTML tab of the Task Pane Editor. To view or test the task pane page, click the Preview tab.


  9. Close the Task Pane Editor.

The task pane page is complete and ready to be added to the task pane. The next step is to add the task pane page to the task pane of the Microsoft Dynamics AX client.

In this procedure, you will add a task pane page to the task pane.

To add a task pane page to the task pane

  1. In the AOT, expand Menu Items, right-click Action, and then click New Menu Item. A new menu item node is added to the action menu item list in the AOT.

  2. Right-click the new menu item node, and then click Properties. The Properties window opens. Set values for the following properties.

    Property

    Value

    Label

    Specify a display name for the menu item.

    Name

    Specify a name that uniquely identifies this menu item.

    Object

    SysTaskPane

    NoteNote
    You have to set the value of the Object Type property before you set this property value.

    Object Type

    Class

    Parameters

    Enter the name property from the task pane page that you created earlier.

  3. Right-click the menu item node, and then click Save. Close the Properties window.

  4. In the AOT, expand Menus, right-click TaskPanes, click New, and then click Menu item. A menu item node is added in the AOT.

  5. Right-click the new menu item node and then click Properties. The Properties window opens. Set values for the following properties.

    Property

    Value

    MenuItemName

    Click the name of the menu item that you created earlier.

    NoteNote
    You have to set the value of the MenuItemType property before you set this property value.

    MenuItemType

    Action

    Name

    This property is automatically set using the label property of the specified menu item.

  6. Right-click the menu node, and then click Save. Close the Properties window.

The new task pane page is added to the task pane. To view the task pane page in the task pane, you have to close and restart the client. From the Microsoft Dynamics AX menu, click View, and then click Task Pane. To display the new task pane page, click the list at the top of the task pane and click the name of the task pane page. The specified task pane page opens in the task pane.

Community Additions

ADD
Show: