closeBackground

Typemessage
DictionaryLCS
LibraryLiveCode Script
Syntax
closeBackground <pBackgroundID>
Associationscard
Summary

Sent to the current card when the user is leaving a card that has a group to go to one that doesn't have the group.

Introduced1.0
OSmac, windows, linux, ios, android
Platformsdesktop, server, mobile
Parameters
NameTypeDescription
pBackgroundID

The ID number of the background being exited.

Example
on closeBackground theClosedGroupID
-- save when exiting a particular background:
  if theClosedGroupID is 234 then saveNotesToFile
  pass closeBackground
end closeBackground
RelatedKeyword: card
Property: backgroundBehavior
Message: preOpenBackground, closeStack, shutdown, openBackground, closeCard, closeBackground
Command: group
Object: card
Glossary: property, current card, message, background, group
Description

Handle the closeBackground message if you want to perform cleanup or do other tasks when the user leaves a background.

A background is closed when the user either goes to a card that doesn't have the group on it, or closes the stack.

The closeBackground message is sent only if the group's backgroundBehavior property is set to true. If the group's backgroundBehavior is false, no closeBackground message is sent, even if the group is placed on multiple cards.

A separate closeBackground message is sent for each background that is being closed.

Tagsnavigation