WklKpiCard

Dim myWklKpiCard As WklKpiCard
Set myWklKpiCard = Me!ControlName.Object

A key figure for a start page: title, value with unit, the deviation from a comparison value, a status, a sparkline and a badge; clickable like a tile.

None

Use one card per figure that may need action: open sessions, keys that expire, refused log-ons. A click (Clickable) opens the list behind the figure; Key tells the Click procedure which one.

Fill it like a status label: unbound, code sets Value, Compare and the points of the sparkline (AddPoint, SetSeries), for example from a timer; bound, Control Source names a field or expression for Value. The deviation Value - Compare is drawn with an arrow in the text color of DeltaKind: whether more is good is the application's decision, not the card's. StatusText adds a pill under the title and a strip in the strong color of StatusKind along the left edge.

The card is not a live region: on a start page that refreshes every few seconds, announcing every change would talk over everything else. Screen readers read the statement (Statement) when they reach the card; a clickable card is a button with the Invoke action.

An ActiveX control: inserted into a form in design view (Form Design › Controls › ActiveX Controls); reports are not supported. VBA reaches it through the Object property of the control, where ControlName is the name of the control on the form.

Private Sub Form_Load()
    With Me!kpiLocked.Object
        .Title = "Gesperrte Personen"
        .Key = "locked"
        .Clickable = True
    End With
    RefreshCards
End Sub
 
Private Sub RefreshCards()
    With Me!kpiLocked.Object
        .Compare = .Value
        .Value = DCount("*", "tblPerson", "Status = 'gesperrt'")
        .DeltaKind = IIf(.Value > .Compare, wskBad, wskNeutral)
        .StatusText = IIf(.Value > 0, "Action needed", "")
        .StatusKind = wskBad
        .AddPoint .Value
    End With
End Sub
 
Private Sub kpiLocked_Click(ByVal Key As String)
    DoCmd.OpenForm "frmPeople", , , "Status = 'gesperrt'"
End Sub

None

Property Get Value() As Variant
Property Let Value(RHS As Variant)

Gets or sets the figure.

None

Property value: Variant – A number, or Null for no value (“–”).

Text and other values raise wkeInvalidValue; an empty text counts as Null.

Read/write.

None

Declared by WklKpiCard.

Property Get Title() As String
Property Let Title(RHS As String)

Gets or sets the title.

None

Property value: String – A text, for example “Open sessions”.

Read/write.

None

Declared by WklKpiCard.

Property Get Unit() As String
Property Let Unit(RHS As String)

Gets or sets the unit after value and deviation.

None

Property value: String – A text; empty for none.

Read/write.

None

Declared by WklKpiCard.

Property Get Format() As String
Property Let Format(RHS As String)

Gets or sets the format of the value.

None

Property value: String – An Access format; empty for the general format.

Read/write.

None

Declared by WklKpiCard.

Property Get Subtitle() As String
Property Let Subtitle(RHS As String)

Gets or sets a line under the value.

None

Property value: String – A text, for example “seit 08:00”; empty for none.

Read/write.

None

Declared by WklKpiCard.

Property Get Compare() As Variant
Property Let Compare(RHS As Variant)

Gets or sets the comparison value.

None

Property value: Variant – A number, or Null (default) for no deviation.

The deviation is Value - Compare, drawn as “▲ +5”, “▼ −3” or “= 0”; screen readers hear “plus 5 compared with 37”.

Read/write.

None

Declared by WklKpiCard.

Property Get DeltaKind() As WklStatusKind
Property Let DeltaKind(RHS As WklStatusKind)

Gets or sets the kind of the deviation, which sets its color.

None

Property value: `WklStatusKind` – A `WklStatusKind` constant; the default is wskNeutral.

Read/write.

None

Declared by WklKpiCard.

Property Get DeltaFormat() As String
Property Let DeltaFormat(RHS As String)

Gets or sets the format of the deviation.

None

Property value: String – An Access format; empty for the format of the value with a sign. A format with sections such as “+0;-0” writes its own sign.

Read/write.

None

Declared by WklKpiCard.

Property Get ShowSparkline() As Boolean
Property Let ShowSparkline(RHS As Boolean)

Gets or sets whether the sparkline is shown.

None

Property value: Boolean – True (default) or False.

The sparkline takes the room under value and subtitle; on a card too low for it, it is left out.

Read/write.

None

Declared by WklKpiCard.

Property Get SparkColumns() As Boolean
Property Let SparkColumns(RHS As Boolean)

Gets or sets whether the sparkline is drawn as columns.

None

Property value: Boolean – True for columns; False (default) for a line.

Read/write.

None

Declared by WklKpiCard.

Property Get Points() As Long
Property Let Points(RHS As Long)

Gets or sets how many points the sparkline keeps.

None

Property value: Long – 2 to 1000; the default is 20. Older points drop out first.

Read/write.

None

Declared by WklKpiCard.

Sub AddPoint(ByVal Value As Variant)

Appends a point to the sparkline.

The points belong to the running form and are not saved with it. A value that is no number raises wkeInvalidValue.

None

Declared by WklKpiCard.

Sub SetSeries(ByVal Values As Variant)

Replaces the points of the sparkline.

None

None

Declared by WklKpiCard.

Sub ClearPoints()

Removes all points of the sparkline.

None

None

None

Declared by WklKpiCard.

Property Get PointCount() As Long

Gets the number of points in the sparkline.

None

Property value: Long – The number of points.

Read-only.

None

Declared by WklKpiCard.

Property Get BadgeCount() As Long
Property Let BadgeCount(RHS As Long)

Gets or sets the count in the top right corner.

None

Property value: Long – 0 (default) hides it; a negative count raises wkeInvalidValue.

Read/write.

None

Declared by WklKpiCard.

Property Get BadgeKind() As WklStatusKind
Property Let BadgeKind(RHS As WklStatusKind)

Gets or sets the kind of the badge.

None

Property value: `WklStatusKind` – A `WklStatusKind` constant; the default is wskBad.

Read/write.

None

Declared by WklKpiCard.

Property Get Clickable() As Boolean
Property Let Clickable(RHS As Boolean)

Gets or sets whether the card behaves like a tile.

None

Property value: Boolean – True: hand pointer, border under the mouse, a tab stop, and Enter, Space and screen readers raise Click; False (default).

Click occurs on a mouse click in either case.

Read/write.

None

Declared by WklKpiCard.

Property Get BackColor() As OLE_COLOR
Property Let BackColor(RHS As OLE_COLOR)

Gets or sets the background color.

None

Property value: OLE_COLOR – A color number; the default is the window background.

Read/write.

None

Declared by WklKpiCard.

Property Get ForeColor() As OLE_COLOR
Property Let ForeColor(RHS As OLE_COLOR)

Gets or sets the text color.

None

Property value: OLE_COLOR – A color number; the default is the window text color.

Read/write.

None

Declared by WklKpiCard.

Property Get FontName() As String
Property Let FontName(RHS As String)

Gets or sets the font.

None

Property value: String – A font name; the default is “Segoe UI”.

Read/write.

None

Declared by WklKpiCard.

Property Get FontSize() As Long
Property Let FontSize(RHS As Long)

Gets or sets the font size of the title, in points.

None

Property value: Long – 6 to 72; the default is 9. The value is drawn larger.

Read/write.

None

Declared by WklKpiCard.

Property Get Statement() As String

Gets the statement screen readers hear.

None

Property value: String – For example “Open sessions: 42, plus 5 compared with 37, Action needed, 3 errors”.

Read-only.

None

Declared by WklKpiCard.

Property Get StatusText() As String
Property Let StatusText(RHS As String)

Gets or sets the status of the card.

None

Property value: String – A text such as “Action needed” or “Notice”; empty (default) for none.

Read/write.

None

Declared by WklKpiCard.

Property Get StatusKind() As WklStatusKind
Property Let StatusKind(RHS As WklStatusKind)

Gets or sets the kind of the status, which sets the colors of its pill and of the strip on the left edge.

None

Property value: `WklStatusKind` – A `WklStatusKind` constant; the default is wskNeutral.

Read/write.

None

Declared by WklKpiCard.

Property Get Key() As String
Property Let Key(RHS As String)

Gets or sets the key that Click passes on.

None

Property value: String – A text, for example the name of the list a click opens; empty by default.

Read/write.

None

Declared by WklKpiCard.

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

Gets or sets the color scheme the control draws in.

None

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

wcoAutomatic follows, in this order, Windows high contrast mode, then the color set of the database design (Access: Design › Themes or Colors), and draws light when the database has no design or the control is on an Excel or Word UserForm. Office's own design setting and the Windows app mode are not followed: a database looks the same on every PC. In high contrast mode the control always uses the system colors. The scheme colors background and text (while BackColor and ForeColor keep the system defaults), the border, the subtitle, the deviation and the sparkline; a BackColor you set wins over the scheme. Every text keeps a contrast of at least 4.5:1. The control reads the database design after it is first drawn, never while Access draws the form, and again when the form opens anew. The value is saved with the form.

Read/write.

None

Declared by WklKpiCard.

Event Click(ByVal Key As String)

Occurs when the user clicks the card; for a Clickable card also on Enter or Space while it has the focus, and when a screen reader invokes it.

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

None

Declared by WklKpiCard.