Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

MenuNodeSetHiddenWhen

  • Last UpdatedJul 18, 2023
  • 1 minute read

Set the HiddenWhen expression for a newly added node. Be aware this function only works for menu nodes added with MenuNodeAddChild(). The HiddenWhen expression may only be set once for a node.

Be reminded that changes made to the menu tree will not be persisted back to the menu configuration database.

Syntax

MenuNodeSetHiddenWhen(hNode, sHiddenWhenName [, sHiddenWhenArgs])

hNode:

Handle of node to run command.

sHiddenWhenName:

Cicode function for HiddenWhen expression. The function needs to return an INT.

sHiddenWhenArgs:

Cicode parameters for HiddenWhen expression. Only supports static arguments.

Return Value

No Error (0) on success, Bad handle specified (269) if hNode does not refer to a valid node, or Invalid argument passed (274) if HiddenWhen Cicode has already been set or is not a valid expression.

MenuGetChild, MenuGetFirstChild, MenuGetGenericNode, MenuGetNextChild, MenuGetPageNode, MenuGetParent, MenuGetPrevChild, MenuGetWindowNode, MenuNodeAddChild, MenuNodeGetCurr, MenuNodeGetDepth, MenuNodeGetExpanded, MenuNodeGetProperty, MenuNodeGetTargetPage, MenuNodeHasCommand, MenuNodeIsDisabled, MenuNodeIsHidden, MenuNodeRemove, MenuNodeRunCommand, MenuNodeSetDisabledWhen, MenuNodeSetProperty, MenuReload

Example

INT hNode = MenuNodeAddChild(hParent, "LogIn", "LogIn");
INT Error = MenuNodeSetHiddenWhen(hNode, "UserInfo", "0");

See Also

Menu Functions

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in