Project Provider Framework/CreateNewWizard Interface Methods

From LabVIEW Wiki
Jump to: navigation, search

CreateNewWizard Interface Methods define events that occur while adding items of new types to the project tree. Primary Providers Only

Method Definition
Finalize Description: Called after the new item has been created.

Inputs:

  • Wizard (ItemRef) - Reference to the wizard
  • Item (ItemRef) - Reference to the newly created item

Outputs: None

GetCreateNewWeight Description: Called when the appropriate New menu is being constructed.

Inputs:

  • Wizard (ItemRef) - Reference to the wizard

Outputs:

  • Weight (I32) - Controls the relative position of the entry in the New menu
GetNewItemInfo Description: Called whenever right-clicked on an item that supports this New menu.

Inputs:

  • Wizard (ItemRef) - Reference to the wizard

Outputs:

  • NewInfo (CreateNewInfo) - Unknown
IncludeItem Description: Called when the appropriate New menu is being constructed.

Inputs:

  • Wizard (ItemRef) - Reference to the wizard

Outputs:

  • IncludeItem (Boolean) - Controls inclusion of the item in the New menu based on some logic
Init Description: Called to initialize the wizard.

Inputs:

  • Wizard (ItemRef) - Reference to the wizard

Outputs:

  • Enable Next (Boolean) - Controls whether the CreateNewWizard_Invoke is called or not on creating a new item.
  • Enable Finish (Boolean) - Unknown
  • Label (String) - The text that shows up in the New pop-up menu
Invoke Description: Called when an entry added to a New menu by this provider is selected.

Inputs:

  • Wizard (ItemRef) - Reference to the wizard
  • New Item Parent (mxLvNIIM) - Item Moniker representing the parent of the item to be created

Outputs:

  • Canceled (Boolean) - Controls whether the framework should create the new item (false if done through VI Server)