Project Provider Framework/Global Interface Methods

From LabVIEW Wiki
Jump to: navigation, search

Global Interface Methods define global-level events not tied to a specific object type.

Method Definition
Init Description: Called every time the provider is loaded. This happens when LabVIEW.exe runs and whenever a project explorer window is created (open, new, etc.). It should be used to construct menus and do any other initialization tasks. If licensing is not integrated, the check should be performed here (in addition to any licensing-based initialization).

Inputs:

  • Object (ItemRef) - Reference to the global item

Outputs: None

OnCommand Description: Called when executing global menu and toolbar commands. Should be used to define or call button/menu behaviors.

Inputs:

  • Item (ItemRef) - Reference to the global item
  • CommandID (String) - Menu tag of the command that was selected (defined when registered)

Outputs: None

OnUpdateCommand Description: Called during framework update operations. Building menus calls this for each customized menu item. When in the project window, this is called in a loop to make sure all the menus are in the most recent state.

Inputs:

  • Item (ItemRef) - Reference to the global item
  • Menu Item (mxLvMenuItem) - In The menu item being updated

Outputs: None

Exit Description: Not currently called.

Inputs:

  • Item (ItemRef) - Reference to the global item

Outputs: None