This repository was archived by the owner on Aug 31, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 225
Expand file tree
/
Copy pathcloseBackground.lcdoc
More file actions
53 lines (37 loc) · 1.55 KB
/
closeBackground.lcdoc
File metadata and controls
53 lines (37 loc) · 1.55 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Name: closeBackground
Type: message
Syntax: closeBackground <pBackgroundID>
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>.
Associations: card
Introduced: 1.0
OS: mac, windows, linux, ios, android
Platforms: desktop, server, mobile
Example:
on closeBackground theClosedGroupID
-- save when exiting a particular background:
if theClosedGroupID is 234 then saveNotesToFile
pass closeBackground
end closeBackground
Parameters:
pBackgroundID:
The ID number of the background being exited.
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(glossary)|group's> <backgroundBehavior> <property> is set to
true. If the <group(glossary)|group's> <backgroundBehavior> is false, no
<closeBackground> <message> is sent, even if the <group(command)> is
placed on multiple <card|cards>.
A separate <closeBackground> <message> is sent for each <background>
that is being closed.
References: group (command), property (glossary), current card (glossary),
message (glossary), background (glossary), group (glossary),
card (keyword), preOpenBackground (message), closeStack (message),
shutdown (message), openBackground (message), closeCard (message),
closeBackground (message), card (object), backgroundBehavior (property)
Tags: navigation