TestContext Data Member Function

Sets the UI state for commands which require a certain <Node> type to be selected in order to function properly. If any <Node> objects 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 int32 TestContext( CommandPresentationModuleInfo p_oInfo, TypeInformation p_oNodeType, string p_sHint )

Parameters

Parameter Type Parameter Name Documentation
<CommandPresentationModuleInfo>p_oInfoA pointer to a <CommandPresentationModuleInfo> object which is used to control parts of Scenome's user interface, including the relevant command user interface (toolbar button, menu item).
TypeInformationp_oNodeTypeThe type of <Node> whose command context is to be tested.
stringp_sHintThe hint text to display in the status bar, for both success and failure cases. This hint will be displayed in the UI status bar at the lower left corner of the application.

Examples

Copy Text To Clipboard

None published. Please look for an example in the Scenome Scripting Language code base.