GuiUpdateTag

Category: GUI
Since engine version: 7.0 OC

Description

Changes the tag of an existing GUI window, that has previously been opened with GuiOpen(). It is possible to update only one certain sub-window by passing child_id and target. The tag will also be set for the children of the target window. Returns true if a window was found.

Syntax

bool GuiUpdateTag(string tag, int gui_id, int child_id, object target);

Parameters

tag:: The new tag for the window and children.
gui_id:: The ID of the gui window that was returned by GuiOpen().
child_id:: Optional. If given, the sub-window of the menu_id window with the matching child_id will be updated. Should be used together with the parameter target.
target:: Optional. Should be used together with child_id. The target of the sub-window that will be updated.

Remark

See the GUI documentation for further explanations.

Example

var menu =
{
	BackgroundColor = 
	{
		Std = RGB(0, 0, 255),
		GoGreen = RGB(0, 255, 0)
	}
};
var menuID = GuiOpen(menu);
GuiUpdateTag("GoGreen", menuID)

Opens a blue screen and then makes it go green.

Zapper, 2014-10