WklToast

Dim myWklToast As New WklToast

Shows short notes after an action (“3 rules deleted – Undo”) at the bottom right of the Access window, as Outlook and Teams do: they never take the focus, close by themselves and can offer one action.

None

WklToast is an object, not a control: create it with New in any module, also in the module of a subform. A note does not belong to the form that showed it: it stays when that form closes, unless it was shown in that form (Form). Close, CloseAll and Count see the notes of every WklToast object of the Access session; the events Action and Closed go to the object that showed the note.

Placement: without Form, the notes stand in the bottom-right corner of the Access work area, above the status bar; with Form, in the corner of that form (a subform gives the subform's area). At most three are visible, the newest at the bottom; further notes wait and appear when one closes. A note follows its window when it moves or changes size, hides while Access is minimized or the form hidden, and closes when its form closes (wtrOwnerClosed).

Time: 4 seconds, 8 seconds with an action (time to reach it with the keyboard), or DurationMs; 0 keeps the note until the user or code closes it. The time stops while the mouse is over the note or the note has the focus, and a waiting note's time starts only when it appears.

No focus: a note appears without taking the focus or the keyboard, and clicking its action or its close button leaves the focus where it was, for example in a grid. A screen reader announces the note once when it appears, with the key of its action.

Keyboard, only while a note is visible:

• Ctrl+Shift+Z runs the action of the newest note that has one (Ctrl+Z stays the Undo of Access).
• F6 moves the focus into the newest note, as F6 reaches the message bar in Office. In the note, Tab moves between the action and the close button, Enter or Space presses the focused one, Esc closes the note, and F6 goes back to where the focus was. From then on F6 moves between the areas of the form (and of a WklDockLayout) as without a note, until another note appears. Shift+F6 never enters a note.

Without any visible note the object installs no keyboard hook and F6 is unchanged.

The action: Action occurs, then ActionFunction is evaluated, then the note closes. Events reach VBA only through a WithEvents variable, which VBA allows in the module of a form, a report or a class, on module level. A procedure that declares the object locally and ends does not hear Action any more; for that case ActionFunction names a function as OnAction of an Access menu does (=WiederHerstellen(17)), which Access evaluates when the user chooses the action, whatever became of the object. An error in that expression is shown in a message box, as Access shows it for a menu entry. ActionFunction needs Access; in other hosts only the event runs.

A walkthrough with Undo after deleting: How to: Show a note after an action, with Undo.

Created with New WklToast or CreateObject.

' In the module of the form frmRules
Private WithEvents mToast As WklToast
 
Private Sub Form_Load()
    Set mToast = New WklToast
End Sub
 
Private Sub cmdDelete_Click()
    Dim id As Long
    id = Me!ID
    CurrentDb.Execute "UPDATE tblRules SET IsDeleted = True WHERE ID = " & id, dbFailOnError
    Me.Requery
    mToast.Show "Rule deleted.", wtkSuccess, , "Undo", id
End Sub
 
Private Sub mToast_Action(ByVal Id As Long, ByVal Tag As Variant)
    CurrentDb.Execute "UPDATE tblRules SET IsDeleted = False WHERE ID = " & Tag, dbFailOnError
    Me.Requery
End Sub

None

Function Show(ByVal Text As String, Optional ByVal Kind As WklToastKind = wtkInfo, Optional ByVal Title As String = "", Optional ByVal ActionCaption As String = "", Optional ByVal Tag As Variant, Optional ByVal DurationMs As Long = -1, Optional ByVal Form As Variant, Optional ByVal ActionFunction As String = "") As Long

Shows a note, or queues it when three are visible.

Return value: Long – The id of the note, unique in the Access session; Close and the events use it.

Without Form, the note needs an Access window (or in other hosts an active window); when there is none, Show raises wkeNotAvailable.

None

Declared by WklToast.

Sub Close(ByVal Id As Long)

Closes a note, visible or waiting.

Closed occurs with wtrCode. A waiting note that is closed never appears.

None

Declared by WklToast.

Sub CloseAll()

Closes every note of the Access session, of every WklToast object; Closed occurs for each with wtrCode.

None

None

None

Declared by WklToast.

Property Get Count() As Long

Gets the number of notes of the Access session, visible and waiting.

None

Property value: Long – 0 when no note is open.

Read-only.

None

Declared by WklToast.

Function IsOpen(ByVal Id As Long) As Boolean

Tells whether a note is still visible or waiting.

Return value: Boolean – True while the note is visible or waits; False after it closed.

None

None

Declared by WklToast.

Property Get ColorScheme() As WklColorScheme
Property Let ColorScheme(RHS As WklColorScheme)

Gets or sets the color scheme of the notes this object shows.

None

Property value: `WklColorScheme` – wcoAutomatic (default), wcoLight, wcoDark or wcoHighContrast.

The scheme applies to notes shown after the change; a note already on the screen keeps its colors. It colors background, text, action link, border, and the bar and symbol in the color of the kind. wcoAutomatic follows, in this order, Windows high contrast mode, then the color set of the database design of the Access the code runs in (Access: Design › Themes or Colors, read once per Show), and draws light when the database has no design or the code runs in Excel or Word. Office's own design setting and the Windows app mode are not followed. In high contrast mode the notes always use the system colors. Every text keeps a contrast of at least 4.5:1. The setting is not stored: WklToast is an object in VBA, so set it after New WklToast when the notes should not follow the database.

Read/write.

None

Declared by WklToast.

Event Action(ByVal Id As Long, ByVal Tag As Variant)

Occurs when the user chooses the action of a note: a click on the link, Enter or Space on it, Ctrl+Shift+Z, or Invoke by a screen reader.

The note closes after the event (Closed with wtrAction), also when the procedure raises an error. ActionFunction runs after the event.

In a form module: Private Sub <ControlName>_Action(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklToast.

Event Closed(ByVal Id As Long, ByVal Reason As WklToastCloseReason)

Occurs when a note has closed.

In a form module: Private Sub <ControlName>_Closed(...). Parameters passed by reference can be changed by the procedure.

None

Declared by WklToast.