Lingo Dictionary > G-K > on getBehaviorDescription

 

on getBehaviorDescription

Syntax

on getBehaviorDescription
	statement(s)
end

Description

System message and event handler; contains Lingo that returns the string that appears in a behavior's description pane in the Behavior Inspector when the behavior is selected.

The description string is optional.

Director sends the getBehaviorDescription message to the behaviors attached to a sprite when the Behavior Inspector opens. Place the on getBehaviorDescription handler within a behavior.

The handler can contain embedded Return characters for formatting multiple-line descriptions.

Example

This statement displays "Vertical Multiline textField Scrollbar" in the description pane.

on getBehaviorDescription
	return "Vertical Multiline textField Scrollbar"
end

See also

on getPropertyDescriptionList, on getBehaviorTooltip, on runPropertyDialog