home / documentation / reference / hm_onitemcreated

HM_OnItemCreated

Description:

The custom (user defined) method that is called just after the creation of a menu item.

Value:

JavaScript function.

Applies To:

Menu Items.

Browser Compatibility:

HM_OnItemCreated is supported in all browsers.

Parameters:

(itemEl)

itemEl is the HTML element for the menu item

Comments:

HM_OnItemCreated is a HierMenus Menu Event Hook; a means for you to execute your own custom JavaScript code from within normal HierMenus processing. All menu event hooks expect to be set to the name of a custom function (typically of your own creation, although the HM_Loader.js file contains some custom functions designed for use with event hooks), a function literal, or a dynamically generated function.

The function you create for use with this menu event hook should be designed as a method of the item object, i.e., the internal item object that HierMenus creates to track the various unique parameters of the item itself. Thus, the this keyword, within the context of your custom function, refers directly to the item object.

The item object (referred to by this) is not the same as the item element. The item object is the internal structure that HierMenus uses to track various pieces of information specific to this item. The item element is the actual HTML page element that represents the item itself. You access the item object via the this keyword within your custom method; you access the item element via the first parameter passed to the function.

When HM_OnItemCreated is called, the actual menu item dimensions (menu item width and height) have not yet been adjusted by HierMenus. They should therefore not be relied upon. If you need to examine or utilize the finished menu item dimensions, you will need to hook HM_OnMenuCreated and locate the specific menu item you need.

For further usage and implementation information, see the mini-tutorial Menu Event Hooks.

Example Method:

// write a message to the status bar 
// describing the creation of an item
function HM_fc_ItemCreated() {
   window.status=this.MenuID+" "+this.ItemCount+
                 " was just created.";
}

Example Settings:

// Ok:
HM_OnItemCreated:HM_fc_ItemCreated,
HM_OnItemCreated:null,  // remove hook for this item

// Incorrect:
HM_OnItemCreated:"HM_fc_ItemCreated",
   // do not quote function names here
HM_OnItemCreated:"null", 
   // do not quote null here

Default:

null

See Also:

HM_OnVisibilityToggle, HM_OnMove, HM_OnCreateMenu, HM_OnMenuCreated, HM_OnItemHilite, HM_OnBuildMenus, HM_OnItemClick, HM_OnItemHover, HM_OnCreateItem, HM_OnMenuOver, HM_OnMenuOut, HM_OnItemOver, HM_OnItemOut, HM_OnLink, setTrans, killTrans, Menu Event Hooks Mini-Tutorial