Project Provider Framework/Provider Interface Methods

From LabVIEW Wiki
Jump to: navigation, search

Provider Interface Methods defines events that occur to multiple items in the project tree.

Key Description / Inputs / Outputs
InitItems Description: Called when multiple items in the project are bound.

Inputs:

  • Items Array (ItemRef[]) - Array of references to project items

Outputs: None

LoadComplete Description: Called when the project has finished loading.

Inputs:

  • Project (ItemRef) - Reference to the project

Outputs: None

LoadCompleteWithWarnings Description: Same as LoadComplete except save warnings are optionally returned.

Inputs:

  • Project (ItemRef) - Reference to the project

Outputs:

  • warnSummaryStrings (String[]) - Warning summary messages
  • warnStrings (String[]) - Warning messages
NotifyChanged Description: Called when changes occur involving multiple items (create, add, etc.)

Inputs:

  • item IDs (ItemRef[])
  • Change Type (mxLvChangeType)
  • error in (Error Cluster) - Input error cluster

Outputs:

  • error out (Error Cluster) - Output error cluster
OnCommand Description: Called when a command is invoked on multiple items (menu or toolbar).

Inputs:

  • Items Array (ItemRef[])
  • Command ID (String) - Menu tag defined when command was registered

Outputs: None

OnPopupMenu Description: Called right before the project items' popup menu is displayed—can modify menu.

Inputs:

  • objects (ItemRef[]) - References to the selected items

Outputs: None

OnSaveForPrevious Description: Called when a project is being saved to a previous version—gives provider a chance to modify property bag to match the previous version.

Inputs:

  • Version (U32) - Version number that is being saved for
  • ObjectsIn (ItemRef[]) - References to items being saved

Outputs: None

OnSaveForPreviousEx Description: Same as OnSaveForPrevious except the provider is also passed to the method.

Inputs:

  • Version (U32) - Version number that is being saved for
  • ObjectsIn (ItemRef[]) - References to items being saved
  • Provider Item (ItemRef) - Reference to this provider

Outputs: None

OnSaveForPreviousWithWarnings Description: Same as OnSaveForPreviousEx except save warnings are optionally returned.

Inputs:

  • Version (U32) - Version number being saved for
  • ObjectsIn (ItemRef[]) - References to items being saved
  • Provider Item (ItemRef) - Reference to this provider

Outputs:

  • Warning Summaries (String[]) - Warning summary messages
  • Warnings (String[]) - Warning messages
OnSaveProject Description: Called when the project is being saved.

Inputs:

  • Project (ItemRef) - Reference to the project

Outputs: None

OnUpdateCommandBegin Description: Called before UpdateCommand is called for each command in the toolbar or menu.

Inputs:

  • Project (ItemRef) - Reference to the project

Outputs: None

OnUpdateCommandEnd Description: Called after UpdateCommand is called for each command in the toolbar or menu.

Inputs:

  • Project (ItemRef) - Reference to the project

Outputs: None

Shutdown Description: Called when the project shuts down.

Inputs:

  • Project (ItemRef) - Reference to the project
  • Is LV Exiting? (Boolean) - Specifies whether LabVIEW is exiting (true) or not (false)

Outputs: None

Startup Description: Called when the project is created.

Inputs:

  • Project (ItemRef) - Reference to the project

Outputs: None

Retrieved from "https://labviewwiki.org/w/index.php?title=Project_Provider_Framework/Provider_Interface_Methods&oldid=32415"