Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Navigation items in the WMC are identified by Navigation Paths. These paths describe the hierarchy of how the item is arranged with respect to other nodes. The root node of the Navigation Path (called the domain) indicates the type of navigation item.

NodeDescription
NAVIGATIONTREEA Navigation Path that identifies an item in the navigation tree
HELPA Navigation Path that identifies a help pane itemcontent
TASKLISTA Navigation Path that identifies an a group or item in the task list that sits below the navigation tree in the WMC.
MESSAGEBARA Navigation Path that identifies an item in the navigation bar at the top of the WMC

e.g. NAVIGATIONTREE\ControlPanel\Events refers to the Events item that sits under the Control Panel node in the navigation tree. TASKLIST\Data\ResetValue refers to the task ResetValue that lies under the Data task group.

NavInsertItem takes a Navigation Path and uses it to create an item for that path. The 4 separate types of navigation items have their own hierarchy and you cannot put one type into another hierarchy. The paths can be any path that you define (Apart from the root item) and have little bearing on each other apart from help items and navigation tree items which are discussed belowdomain with which an item sits is defined by the root level subpath and levels in the hierarchy are specified by the path separator '\'. Paths can effectively be any depth you wish.

Aliases

Navigation Paths can have aliases that are used to quickly reference an item without having to know the entire underlying path. NavInsertItem allows you to specify an alias when you add the item. It must consist of a '{' character followed by the (case sensitive) alias name and then a '}'. e.g {ControlPanel} references the Control Panel node in the navigation tree whose real Navigation Path is NAVIGATIONTREE\ControlPanel 

Using aliases makes it easier for developers of other components to use your Navigation Paths without you having to publish the entire hierarchy. You can then change the hierarchy in later versions of your component and so long as you have kept the alias the same, their code will continue to work correctly.