Back Help

ValidateNodeCommandContext.TestContext

This page contains reference documentation for the TestContext function. This function sets the UI state for commands which require a certain node type to be selected in order to function properly. If any nodes of type 'NodeType' are selected, the hint is printed directly. Otherwise, the hint is printed in conjunction with information on how to enable the command.

Prototype

static int TestContext( CommandPresentationModuleInfo CommandInfo, TypeInformation NodeType, string CommandHint )

Parameters

Function parameters are as follows:

  • CommandInfo: A CommandPresentationModuleInfo object which is used to control parts of Scenome's user interface, including the relevant command user interface (toolbar button, menu item).
  • NodeType: The type of node whose command context is to be tested.
  • CommandHint: A hint for the command. This hint will be printed using the StatusBar member of 'CommandInfo'.