AxToolbar

Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

The AxToolbar component provides access to the actions that can be performed for the items in a page. The AxToolbar component has the same function as the Toolbar Web Part. Consider using an AxToolbar component in a User Control when you do not want to rely on having a Toolbar web part on the page where the User Control will be used.

Properties

The AxToolbar component has the following properties:

Accessibility

Appearance

Behavior

Data

Layout

Microsoft Dynamics AX

Misc

Events

The AxToolbar component has the events listed in the following table.

Defining Toolbar Content with Code

In most cases, you define the content displayed by a toolbar by using Web Menu and Web Menu Item resources in the AOT. If you need the toolbar content to be more dynamic, you can define the toolbar content with code you add to the User Control that displays the toolbar. You do this by implementing a method that returns an IWebMenuGenerator object for the User Control. This method defines the contents of the toolbar.

The following using statements reference the namespaces that are required to define toolbar content with code.

using Microsoft.Dynamics.Framework.Portal.UI.WebControls;

using Microsoft.Dynamics.AX.Framework.Services.Client;

The following example is the GenerateToolbar() private method for a User Control. It defines the content for an AxToolbar component that is also part of the User Control. The toolbar contains a top-level item and a menu. The menu contains an item and a submenu with two additional items. After the contents of the toolbar have been defined, the completed structure is returned from the method.

// This is a private method that creates the content of a web menu
// that is used for an AxToolbar component.
private IWebMenuGenerator<WebMenuGeneratorEventArgs> GenerateToolbar()
{
    WebMenuItemMetadataHierarchicalContainer toolbar;
    WebMenuItemMetadataHierarchicalContainer menu;
    WebMenuItemMetadataHierarchicalContainer subMenu;
    URLWebMenuItemMetadata workOrderDetails;
    URLWebMenuItemMetadata roomDetails;
    URLWebMenuItemMetadata roomAdd;
    URLWebMenuItemMetadata MicrosoftLink;

    // Create the container that holds the toolbar menu items.
    toolbar = new WebMenuItemMetadataHierarchicalContainer("Toolbar");

    // Add a top-level item to the toolbar.
    MicrosoftLink = new URLWebMenuItemMetadata("Microsoft", "Microsoft", "Link to Microsoft.com", "https://www.microsoft.com");
    toolbar.AddWebMenuItem(MicrosoftLink);

    // Create the container that will hold the menu.
    menu = new WebMenuItemMetadataHierarchicalContainer("Facility", "Facility", "");

    // Define a menu item to add to the menu. This menu item uses an existing
    // web menu item that is defined in the AOT.
    workOrderDetails = new URLWebMenuItemMetadata(MetadataCache.GetURLWebMenuItemMetadata("WorkOrderDetails"));
    menu.AddWebMenuItem(workOrderDetails);

    // Create the container that will act as a submenu.
    subMenu = new WebMenuItemMetadataHierarchicalContainer("Rooms", "Rooms", "Actions for rooms");

    // Define two menu items that will appear in the submenu.
    roomDetails = new URLWebMenuItemMetadata(MetadataCache.GetURLWebMenuItemMetadata("RoomDetails"));
    roomAdd = new URLWebMenuItemMetadata(MetadataCache.GetURLWebMenuItemMetadata("RoomAdd"));

    // Add these menu items to the submenu.
    subMenu.AddWebMenuItem(roomDetails);
    subMenu.AddWebMenuItem(roomAdd);

    // Add the submenu to the menu.
    menu.AddSubMenu(subMenu);

    // Add the menu to the main toolbar.
    toolbar.AddSubMenu(menu);

    // Return the completed menu structure to use for the toolbar.
    return new WebMenuItemMetadataHierarchicalContainerGenerator(toolbar);
}

The contents of the AxToolbar component should be loaded when the page containing the User Control is loaded. In the Page_Load() method for the User Control, the WebMenuGeneratorConstructor for the AxToolbar component is used to create the content. Notice how the toolbar structure returned from the private method in the previous example is used by the constructor of the toolbar.

protected void Page_Load(object sender, EventArgs e)
{
    // Load the contents of the AxToolbar component.
    this.AxToolBar1.WebMenuGeneratorConstructor = this.GenerateToolbar;
}