system.gui.getSibling

This function is used in Python Scripting.

Description

Given a component event object, looks up a sibling component. Shortcut for event.source.parent.getComponent("siblingName"). If no such sibling is found, the special value None is returned.

Client Permission Restrictions

This scripting function has no Client Permission restrictions.

Syntax

system.gui.getSibling(event, name)

Parameters

EventObject event - A component event object.

String name - The name of the sibling component.

Returns

PyObject - The sibling component itself.

Scope

Client

Code Examples

Code Snippet

# This example will get its sibling Text Field's text, and use it.
 
textField = system.gui.getSibling(event, 'TextField (1)')
if textField is None:
   system.gui.errorBox("There is no text field!")
else:
   system.gui.messageBox("You typed: %s" % textField.text)

Contents

Strategic Partner Links

Resources

All Manual Versions