home / documentation / reference / hm_oncreateitem

HM_OnCreateItem

Description:

The custom (user defined) method that is called just prior to the creation of a menu item (that is, just before the menu item's HTML element is created).

Value:

JavaScript function.

Applies To:

Menu Items.

Browser Compatibility:

HM_OnCreateItem is supported in all browsers.

Parameters:

None.

Comments:

HM_OnCreateItem 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 cannot access the HTML element for the item in HM_OnCreateItem (because it has not yet been created).

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_CreateItem() {
   window.status=this.MenuID+" "+this.ItemCount+
                 " is being created.";
}

Example Settings:

// Ok:
HM_OnCreateItem:HM_fc_CreateItem,
HM_OnCreateItem:null,  // remove hook for this item

// Incorrect:
HM_OnCreateItem:"HM_fc_CreateItem",
   // do not quote function names here
HM_OnCreateItem:"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_OnItemCreated, HM_OnMenuOver, HM_OnMenuOut, HM_OnItemOver, HM_OnItemOut, HM_OnLink, setTrans, killTrans, Menu Event Hooks Mini-Tutorial