Enumerations
WklErrorCode enumeration
Signature
Enum WklErrorCode
wkeNotConfigured = &H80040301
wkeSourceError = &H80040302
wkeDuplicateKey = &H80040303
wkeCycle = &H80040304
wkeKeyNotFound = &H80040305
wkeInvalidValue = &H80040306
wkeNotAvailable = &H80040307
End Enum
Summary
The error numbers of the WKL controls, as Err.Number shows them; Err.Source is WklForms.
Parameters
| Constant | Value | Description |
|---|---|---|
wkeNotConfigured | &H80040301 | The record source or a required field is missing. |
wkeSourceError | &H80040302 | Access reported an error while reading or saving; Err.Description holds Access' text. |
wkeDuplicateKey | &H80040303 | A key occurs twice. |
wkeCycle | &H80040304 | The parent keys of the record source form a cycle. |
wkeKeyNotFound | &H80040305 | No node has this key, or a path finds no node. |
wkeInvalidValue | &H80040306 | A value or a file is invalid. |
wkeNotAvailable | &H80040307 | The command is not available now: the control is not in form view, or the command does not apply to the focused record (as Access's error 2046 for its own commands). |
Remarks
None
Code example
None
Inheritance
None
WklSortOrder enumeration
Signature
Enum WklSortOrder
wsoAscending = 0
wsoDescending = 1
wsoDataOrder = 2
wsoCustom = 3
End Enum
Summary
The order of sibling nodes.
Parameters
| Constant | Value | Description |
|---|---|---|
wsoAscending | 0 | By SortField, then by text, ascending (default). |
wsoDescending | 1 | By SortField, then by text, descending. |
wsoDataOrder | 2 | In the order the record source delivers the records. |
wsoCustom | 3 | By the CompareNodes event. |
Remarks
None
Code example
None
Inheritance
None
WklMasterFilterMode enumeration
Signature
Enum WklMasterFilterMode
wmfSource = 0
wmfLocal = 1
End Enum
Summary
How a linked tree selects the records of the master record (MasterFilterMode).
Parameters
| Constant | Value | Description |
|---|---|---|
wmfSource | 0 | A WHERE condition on the record source for each master record (default). |
wmfLocal | 1 | The record source is read once and filtered in memory for each master record. |
Remarks
None
Code example
None
Inheritance
None
WklColorScheme enumeration
Signature
Enum WklColorScheme
wcoAutomatic = 0
wcoLight = 1
wcoDark = 2
wcoHighContrast = 3
End Enum
Summary
The color scheme of a control (ColorScheme).
Parameters
| Constant | Value | Description |
|---|---|---|
wcoAutomatic | 0 | Windows high contrast mode, else the color set of the database design, else light (default). |
wcoLight | 1 | The light colors, whatever the database design. |
wcoDark | 2 | The dark colors. |
wcoHighContrast | 3 | The system colors of the contrast theme, also without high contrast mode. |
Remarks
None
Code example
None
Inheritance
None
WklDropPosition enumeration
Signature
Enum WklDropPosition
wdpInside = 0
wdpBefore = 1
wdpAfter = 2
End Enum
Summary
Where a node goes relative to a target node.
Parameters
| Constant | Value | Description |
|---|---|---|
wdpInside | 0 | As the last child of the target. |
wdpBefore | 1 | As the sibling before the target. |
wdpAfter | 2 | As the sibling after the target. |
Remarks
None
Code example
None
Inheritance
None
WklFileFormat enumeration
Signature
Enum WklFileFormat
wffAuto = 0
wffJson = 1
wffXml = 2
End Enum
Summary
The file format of SaveToFile, LoadFromFile, SaveToStream, LoadFromStream, SaveToString and LoadFromString.
Parameters
| Constant | Value | Description |
|---|---|---|
wffAuto | 0 | When saving, XML for a file with the extension .xml and JSON otherwise; when loading, recognized from the content. |
wffJson | 1 | JSON. |
wffXml | 2 | XML. |
Remarks
None
Code example
None
Inheritance
None
WklDropEffect enumeration
Signature
Enum WklDropEffect
wdeMove = 0
wdeCopy = 1
End Enum
Summary
Whether a dragged node is moved or copied.
Parameters
| Constant | Value | Description |
|---|---|---|
wdeMove | 0 | The node is moved. |
wdeCopy | 1 | The node is copied with its subtree (Ctrl held down). |
Remarks
None
Code example
None
Inheritance
None
WklUpdateAction enumeration
Signature
Enum WklUpdateAction
wuaRename = 0
wuaMove = 1
wuaAdd = 2
wuaCopy = 3
wuaDelete = 4
wuaSortValue = 5
wuaChecked = 6
wuaCellValue = 7
wuaTask = 8
wuaLink = 9
End Enum
Summary
The kind of a change to the record source (BeforeUpdate, AfterUpdate).
Parameters
| Constant | Value | Description |
|---|---|---|
wuaRename | 0 | A node's text changed. |
wuaMove | 1 | A node's parent changed. |
wuaAdd | 2 | A record was added. |
wuaCopy | 3 | A record was added as a copy. |
wuaDelete | 4 | A record was deleted. |
wuaSortValue | 5 | A node's sort value changed. |
wuaChecked | 6 | A node's check mark changed. |
wuaCellValue | 7 | A cell value of a tree list changed. |
wuaTask | 8 | Start, finish, progress or segments of a task changed (WklGantt). |
wuaLink | 9 | A dependency added or deleted (WklGantt). |
Remarks
None
Code example
None
Inheritance
None
WklCheckMode enumeration
Signature
Enum WklCheckMode
wcmIndependent = 0
wcmRecursive = 1
End Enum
Summary
How check boxes behave.
Parameters
| Constant | Value | Description |
|---|---|---|
wcmIndependent | 0 | Each node is checked on its own (default). |
wcmRecursive | 1 | A check mark applies to the whole subtree; parents show a mixed state when only some descendants are checked. |
Remarks
None
Code example
None
Inheritance
None
WklCheckState enumeration
Signature
Enum WklCheckState
wcsUnchecked = 0
wcsChecked = 1
wcsMixed = 2
End Enum
Summary
The displayed state of a check box.
Parameters
| Constant | Value | Description |
|---|---|---|
wcsUnchecked | 0 | Not checked. |
wcsChecked | 1 | Checked. |
wcsMixed | 2 | Some descendants are checked (only with wcmRecursive). |
Remarks
None
Code example
None
Inheritance
None
WklGridLines enumeration
Signature
Enum WklGridLines
wglNone = 0
wglHorizontal = 1
wglVertical = 2
wglBoth = 3
End Enum
Summary
The grid lines of a tree list.
Parameters
| Constant | Value | Description |
|---|---|---|
wglNone | 0 | No grid lines. |
wglHorizontal | 1 | Lines between rows. |
wglVertical | 2 | Lines between columns. |
wglBoth | 3 | Lines between rows and columns (default). |
Remarks
None
Code example
None
Inheritance
None
WklAlignment enumeration
Signature
Enum WklAlignment
walGeneral = 0
walLeft = 1
walCenter = 2
walRight = 3
End Enum
Summary
The alignment of a column.
Parameters
| Constant | Value | Description |
|---|---|---|
walGeneral | 0 | Text left, numbers and dates right, as in Access. |
walLeft | 1 | Left. |
walCenter | 2 | Centered. |
walRight | 3 | Right. |
Remarks
None
Code example
None
Inheritance
None
WklEditor enumeration
Signature
Enum WklEditor
wedAuto = 0
wedText = 1
wedNumber = 2
wedDate = 3
wedCheckBox = 4
wedLookup = 5
wedImageLookup = 6
wedStatus = 7
wedCommands = 8
wedToggle = 9
wedTokens = 10
wedSpin = 11
wedMemo = 12
wedLink = 13
End Enum
Summary
The cell editor of a column.
Parameters
| Constant | Value | Description |
|---|---|---|
wedAuto | 0 | Chosen from the value of each cell: a Yes/No value (True/False) a check box, a date a date box, a number a number box, anything else text. Properties of the table field such as DisplayControl are not read. |
wedText | 1 | A text box. |
wedNumber | 2 | A text box for numbers. |
wedDate | 3 | A date box with a calendar. |
wedCheckBox | 4 | A check box for Yes/No fields: checked for True or a number other than 0; a click or Space switches it, also in the first column. |
wedLookup | 5 | A drop-down list from RowSource. |
wedImageLookup | 6 | A drop-down list of symbols with text (AddImageItem). |
wedStatus | 7 | Status labels: each value drawn as a colored pill with its text, the color given by its kind (AddStatusItem, StatusKindField). |
wedCommands | 8 | Row commands: no field, a button per command and record (AddCommand); a click raises RowCommand of the grid. |
wedToggle | 9 | Yes/No as a toggle switch, as in the Windows settings; a click or Space switches it at once, OnText/OffText stand beside it. |
wedTokens | 10 | Tokens: the values of one text field, split at Separator, each drawn as a chip; read-only (the values are edited with WklTokenBox). |
wedSpin | 11 | A number with up and down arrows in the editor: Step per arrow, never outside MinValue/MaxValue, Unit after the number (the control on a form: WklSpinEdit). |
wedMemo | 12 | A long text, read-only: the cell shows its first line with text and a mark when there is more; a double click, F2, Shift+F2 or Enter opens a zoom box with the whole text, as Access's Zoom box does. |
wedLink | 13 | A link: the cell text drawn as a hyperlink (“Rules: 3”); a click or Enter raises LinkClick of WklGrid with the column's field; never edited. |
Remarks
None
Code example
None
Inheritance
None
WklStatusKind enumeration
Signature
Enum WklStatusKind
wskNeutral = 0
wskOk = 1
wskWarn = 2
wskBad = 3
wskInfo = 4
wskMuted = 5
End Enum
Summary
The meaning of a status label, which decides its colors. Every kind has a pale background and a dark text of the same hue with a contrast ratio of at least 4.5:1.
Parameters
| Constant | Value | Description |
|---|---|---|
wskNeutral | 0 | No judgement, such as closed or switched off (gray). |
wskOk | 1 | Good, such as active, valid or reachable (green). |
wskWarn | 2 | Needs attention soon, such as expiring or not confirmed (amber). |
wskBad | 3 | Bad, such as locked, failed or refused (red). |
wskInfo | 4 | Informational, a kind or category rather than a judgement (blue). |
wskMuted | 5 | Present but unimportant right now, such as archived, inherited or a default value (gray text). |
Remarks
None
Code example
None
Inheritance
None
WklCommandPlacement enumeration
Signature
Enum WklCommandPlacement
wcpStandard = 0
wcpPrimary = 1
wcpMenu = 2
wcpRight = 3
End Enum
Summary
Where a command of a WklActionBar stands.
Parameters
| Constant | Value | Description |
|---|---|---|
wcpStandard | 0 | In the row from the left; moves into More when the row is too narrow. |
wcpPrimary | 1 | The main command of the page, filled with the accent color; the last to move into More. |
wcpMenu | 2 | Always in the More menu. |
wcpRight | 3 | In the group at the right edge (export, refresh); always visible. |
Remarks
None
Code example
None
Inheritance
None
WklCommandKind enumeration
Signature
Enum WklCommandKind
wcmNormal = 0
wcmDestructive = 1
End Enum
Summary
How a command button of a command column looks.
Parameters
| Constant | Value | Description |
|---|---|---|
wcmNormal | 0 | A plain button. |
wcmDestructive | 1 | A command that removes, locks or ends something: red outline and text. |
Remarks
None
Code example
None
Inheritance
None
WklCommandsDisplay enumeration
Signature
Enum WklCommandsDisplay
wcdHoverAndSelected = 0
wcdAlways = 1
End Enum
Summary
When the buttons of a command column are drawn.
Parameters
| Constant | Value | Description |
|---|---|---|
wcdHoverAndSelected | 0 | In the record under the mouse and in selected records (default; for lists). |
wcdAlways | 1 | In every record (for short lists where the action is the point). |
Remarks
None
Code example
None
Inheritance
None
WklSortDirection enumeration
Signature
Enum WklSortDirection
wsdNone = 0
wsdAscending = 1
wsdDescending = 2
End Enum
Summary
The sort direction of a column.
Parameters
| Constant | Value | Description |
|---|---|---|
wsdNone | 0 | Not sorted. |
wsdAscending | 1 | Ascending. |
wsdDescending | 2 | Descending. |
Remarks
None
Code example
None
Inheritance
None
WklSummary enumeration
Signature
Enum WklSummary
wsuNone = 0
wsuCount = 1
wsuSum = 2
wsuMin = 3
wsuMax = 4
wsuAverage = 5
End Enum
Summary
The total of a column in the footer.
Parameters
| Constant | Value | Description |
|---|---|---|
wsuNone | 0 | No total. |
wsuCount | 1 | The number of records. |
wsuSum | 2 | The sum. |
wsuMin | 3 | The smallest value. |
wsuMax | 4 | The largest value. |
wsuAverage | 5 | The average. |
Remarks
None
Code example
None
Inheritance
None
WklRuleKind enumeration
Signature
Enum WklRuleKind
wrkValue = 0
wrkExpression = 1
wrkDataBar = 2
wrkIconSet = 3
wrkColorScale = 4
End Enum
Summary
The kind of a format rule.
Parameters
| Constant | Value | Description |
|---|---|---|
wrkValue | 0 | Compares the column value with Value1 (and Value2). |
wrkExpression | 1 | Evaluates an expression in Access syntax. |
wrkDataBar | 2 | Draws a bar proportional to the value. |
wrkIconSet | 3 | Draws a symbol of an icon set according to the value. |
wrkColorScale | 4 | Colors the background between MinColor, MidColor and MaxColor according to the value (a heat map). |
Remarks
None
Code example
None
Inheritance
None
WklRuleOperator enumeration
Signature
Enum WklRuleOperator
wroEqual = 0
wroNotEqual = 1
wroLess = 2
wroLessOrEqual = 3
wroGreater = 4
wroGreaterOrEqual = 5
wroBetween = 6
wroNotBetween = 7
wroContains = 8
wroIsNull = 9
wroIsNotNull = 10
End Enum
Summary
The comparison of a value rule.
Parameters
| Constant | Value | Description |
|---|---|---|
wroEqual | 0 | Equal to Value1. |
wroNotEqual | 1 | Not equal to Value1. |
wroLess | 2 | Less than Value1. |
wroLessOrEqual | 3 | Less than or equal to Value1. |
wroGreater | 4 | Greater than Value1. |
wroGreaterOrEqual | 5 | Greater than or equal to Value1. |
wroBetween | 6 | Between Value1 and Value2, limits included. |
wroNotBetween | 7 | Outside Value1 and Value2. |
wroContains | 8 | The text contains Value1. |
wroIsNull | 9 | The value is Null. |
wroIsNotNull | 10 | The value is not Null. |
Remarks
None
Code example
None
Inheritance
None
WklExportMode enumeration
Signature
Enum WklExportMode
wemDataAware = 0
wemWysiwyg = 1
End Enum
Summary
The kind of an export.
Parameters
| Constant | Value | Description |
|---|---|---|
wemDataAware | 0 | Values with their types and formats; the tree becomes an outline (default). |
wemWysiwyg | 1 | As displayed: bands and multi-line records as merged cells, the colors and fonts of the format rules, grid lines. |
Remarks
None
Code example
None
Inheritance
None
WklExportRows enumeration
Signature
Enum WklExportRows
werAll = 0
werVisible = 1
End Enum
Summary
The records an export contains.
Parameters
| Constant | Value | Description |
|---|---|---|
werAll | 0 | All records, collapsed ones included; with LazyLoad all records are read once (default). |
werVisible | 1 | Only the rows visible in the list (expanded and not filtered out). |
Remarks
None
Code example
None
Inheritance
None
WklMenuPlacement enumeration
Signature
Enum WklMenuPlacement
wmpOwnAfter = 0
wmpOwnBefore = 1
wmpOwnOnly = 2
wmpBuiltInOnly = 3
End Enum
Summary
Where the own entries - those of ShortcutMenuBar and AddMenuItem - stand in the shortcut menu.
Parameters
| Constant | Value | Description |
|---|---|---|
wmpOwnAfter | 0 | After the built-in entries (default). |
wmpOwnBefore | 1 | Before the built-in entries. |
wmpOwnOnly | 2 | Only the own entries. |
wmpBuiltInOnly | 3 | Only the built-in entries; the bar and the custom items are not shown. |
Remarks
None
Code example
None
Inheritance
None
WklEditFormMode enumeration
Signature
Enum WklEditFormMode
wfmNone = 0
wfmDialog = 1
wfmWindow = 2
wfmDocked = 3
wfmAuto = 4
wfmOverlay = 5
End Enum
Summary
Where the edit form (EditForm) of a list is shown.
Parameters
| Constant | Value | Description |
|---|---|---|
wfmNone | 0 | No edit form; the list edits in its cells (default). |
wfmDialog | 1 | A modal dialog (acDialog); the list reads again when it is closed. |
wfmWindow | 2 | An ordinary form window; the list goes on at once. |
wfmDocked | 3 | In the subform control EditFormControl of the list's own form. |
wfmAuto | 4 | Docked while the list keeps enough width, otherwise a dialog. |
wfmOverlay | 5 | In the subform control EditFormControl, over the right part of the list, only while a record is edited. |
Remarks
None
Code example
None
Inheritance
None
WklValidateMode enumeration
Signature
Enum WklValidateMode
wvmOnLeave = 0
wvmOnSave = 1
wvmImmediate = 2
End Enum
Summary
When the rules of the columns are checked (ValidateMode).
Parameters
| Constant | Value | Description |
|---|---|---|
wvmOnLeave | 0 | A cell when its editor is left, the row for a new record before it is saved (default, as Access). |
wvmOnSave | 1 | The row for a new record only when it is saved; existing records cell by cell as with wvmOnLeave. |
wvmImmediate | 2 | A cell marked while the user types, refused when its editor is left. |
Remarks
None
Code example
None
Inheritance
None
WklEditFormResult enumeration
Signature
Enum WklEditFormResult
wfrUnchanged = 0
wfrChanged = 1
wfrAdded = 2
wfrDeleted = 3
wfrUnknown = 4
End Enum
Summary
What became of the record of an edit form (EditFormResult).
Parameters
| Constant | Value | Description |
|---|---|---|
wfrUnchanged | 0 | The record reads as before, or no record was added. |
wfrChanged | 1 | At least one field reads differently. |
wfrAdded | 2 | A new record exists; its key is in EditFormNewKey when it is certain. |
wfrDeleted | 3 | The record no longer exists. |
wfrUnknown | 4 | The list could not read the record (no record source, a read error). |
Remarks
None
Code example
None
Inheritance
None
WklExportFormat enumeration
Signature
Enum WklExportFormat
wefAuto = 0
wefXlsx = 1
wefXml = 2
wefJson = 3
End Enum
Summary
The file format of an export.
Parameters
| Constant | Value | Description |
|---|---|---|
wefAuto | 0 | Chosen from the file extension (default). |
wefXlsx | 1 | An Excel workbook (.xlsx). |
wefXml | 2 | XML with the columns, the records as a tree with their values, and the sums (.xml). |
wefJson | 3 | JSON with the columns, the records as a tree with their values, and the sums (.json). |
Remarks
None
Code example
None
Inheritance
None
WklIconSet enumeration
Signature
Enum WklIconSet
wisArrows = 0
wisTrafficLights = 1
wisFlags = 2
wisStars = 3
End Enum
Summary
The symbols of an icon set rule.
Parameters
| Constant | Value | Description |
|---|---|---|
wisArrows | 0 | Arrows. |
wisTrafficLights | 1 | Traffic lights. |
wisFlags | 2 | Flags. |
wisStars | 3 | Stars. |
Remarks
None
Code example
None
Inheritance
None
WklGanttDurationUnit enumeration
Signature
Enum WklGanttDurationUnit
wguDays = 0
wguHours = 1
End Enum
Summary
The unit of durations and lags of a Gantt chart.
Parameters
| Constant | Value | Description |
|---|---|---|
wguDays | 0 | Working days; dates without time, a finish counts to the end of its day (default). |
wguHours | 1 | Working hours of WorkHours; dates with time. |
Remarks
None
Code example
None
Inheritance
None
WklGanttScheduleMode enumeration
Signature
Enum WklGanttScheduleMode
wgsManual = 0
wgsAutomatic = 1
End Enum
Summary
What happens to dependent tasks when a task changes.
Parameters
| Constant | Value | Description |
|---|---|---|
wgsManual | 0 | Nothing moves by itself; broken dependencies are listed in Violations (default). |
wgsAutomatic | 1 | Dependent tasks are scheduled as soon as possible; a task moved by hand gets “start no earlier than”. |
Remarks
None
Code example
None
Inheritance
None
WklGanttDateChangeMode enumeration
Signature
Enum WklGanttDateChangeMode
wgdMoveTask = 0
wgdUpdateDuration = 1
End Enum
Summary
What a new start entered in the grid does.
Parameters
| Constant | Value | Description |
|---|---|---|
wgdMoveTask | 0 | The task moves; its duration stays (default). |
wgdUpdateDuration | 1 | The finish stays; the duration changes. |
Remarks
None
Code example
None
Inheritance
None
WklGanttLinkType enumeration
Signature
Enum WklGanttLinkType
wglFinishToStart = 0
wglStartToStart = 1
wglFinishToFinish = 2
wglStartToFinish = 3
End Enum
Summary
The type of a dependency.
Parameters
| Constant | Value | Description |
|---|---|---|
wglFinishToStart | 0 | The successor starts after the predecessor finished (default). |
wglStartToStart | 1 | The successor starts no earlier than the predecessor. |
wglFinishToFinish | 2 | The successor finishes no earlier than the predecessor. |
wglStartToFinish | 3 | The successor finishes no earlier than the predecessor starts. |
Remarks
None
Code example
None
Inheritance
None
WklGanttConstraint enumeration
Signature
Enum WklGanttConstraint
wgcAsSoonAsPossible = 0
wgcStartNoEarlierThan = 1
wgcStartNoLaterThan = 2
wgcFinishNoEarlierThan = 3
wgcFinishNoLaterThan = 4
wgcMustStartOn = 5
wgcMustFinishOn = 6
End Enum
Summary
The scheduling constraint of a task.
Parameters
| Constant | Value | Description |
|---|---|---|
wgcAsSoonAsPossible | 0 | No date limit (default). |
wgcStartNoEarlierThan | 1 | Starts on or after the constraint date. |
wgcStartNoLaterThan | 2 | Starts on or before the constraint date. |
wgcFinishNoEarlierThan | 3 | Finishes on or after the constraint date. |
wgcFinishNoLaterThan | 4 | Finishes on or before the constraint date. |
wgcMustStartOn | 5 | Starts on the constraint date; never moved by scheduling. |
wgcMustFinishOn | 6 | Finishes on the constraint date; never moved by scheduling. |
Remarks
None
Code example
None
Inheritance
None
WklGanttZoom enumeration
Signature
Enum WklGanttZoom
wgzHours = 0
wgzDays = 1
wgzWeeks = 2
wgzMonths = 3
wgzQuarters = 4
wgzYears = 5
End Enum
Summary
The time unit of a timeline column.
Parameters
| Constant | Value | Description |
|---|---|---|
wgzHours | 0 | Hours. |
wgzDays | 1 | Days (default). |
wgzWeeks | 2 | Weeks. |
wgzMonths | 3 | Months. |
wgzQuarters | 4 | Quarters. |
wgzYears | 5 | Years. |
Remarks
None
Code example
None
Inheritance
None
WklGanttProgressScale enumeration
Signature
Enum WklGanttProgressScale
wgpPercent = 0
wgpFraction = 1
End Enum
Summary
The range of ProgressField and TaskProgress.
Parameters
| Constant | Value | Description |
|---|---|---|
wgpPercent | 0 | 0 to 100 (default). |
wgpFraction | 1 | 0 to 1, as a field with the Access format Percent stores it. |
Remarks
None
Code example
None
Inheritance
None
WklGanttTaskKind enumeration
Signature
Enum WklGanttTaskKind
wgkNone = 0
wgkTask = 1
wgkMilestone = 2
wgkSummary = 3
End Enum
Summary
What the row of a task shows.
Parameters
| Constant | Value | Description |
|---|---|---|
wgkNone | 0 | No bar: start, or finish and duration, are missing. |
wgkTask | 1 | A task bar. |
wgkMilestone | 2 | A milestone. |
wgkSummary | 3 | A summary task computed from its subtasks. |
Remarks
None
Code example
None
Inheritance
None
WklGanttExportRange enumeration
Signature
Enum WklGanttExportRange
wgrProject = 0
wgrVisible = 1
End Enum
Summary
The period of a picture or PDF export.
Parameters
| Constant | Value | Description |
|---|---|---|
wgrProject | 0 | The whole project: ChartStart to ChartFinish, or the first start to the last finish (default). |
wgrVisible | 1 | The period the timeline of the open form shows. |
Remarks
None
Code example
None
Inheritance
None
WklGanttImportMatch enumeration
Signature
Enum WklGanttImportMatch
wgiAuto = 0
wgiUidField = 1
wgiKey = 2
wgiName = 3
End Enum
Summary
How ImportFromProject finds the record of each task of the file.
Parameters
| Constant | Value | Description |
|---|---|---|
wgiAuto | 0 | By ProjectUidField when it is set, otherwise by the key (default). |
wgiUidField | 1 | The value of ProjectUidField equals the task's UID. |
wgiKey | 2 | The key, a whole number, equals the task's UID: files written by ExportToProject. |
wgiName | 3 | The name and the names of all summary tasks above it are equal, ignoring case: the first import of a plan made elsewhere. |
Remarks
None
Code example
None
Inheritance
None
WklNewItemRow enumeration
Signature
Enum WklNewItemRow
wniNone = 0
wniBottom = 1
wniTop = 2
End Enum
Summary
Where the row for a new record of a WklGrid appears.
Parameters
| Constant | Value | Description |
|---|---|---|
wniNone | 0 | No row for new records. |
wniBottom | 1 | Below the last record, as in an Access datasheet (default). |
wniTop | 2 | Above the first record. |
Remarks
None
Code example
None
Inheritance
None
WklGridViewMode enumeration
Signature
Enum WklGridViewMode
wgvTable = 0
wgvList = 1
End Enum
Summary
How a WklGrid shows its records.
Parameters
| Constant | Value | Description |
|---|---|---|
wgvTable | 0 | The datasheet with column headers (default). |
wgvList | 1 | A list of entries drawn after ItemTemplate, without column headers. |
Remarks
None
Code example
None
Inheritance
None
WklGridDataMode enumeration
Signature
Enum WklGridDataMode
wgdMemory = 0
wgdServer = 1
End Enum
Summary
Where a WklGrid reads its records from.
Parameters
| Constant | Value | Description |
|---|---|---|
wgdMemory | 0 | Every record is loaded; filter, groups and summaries are computed in memory (default). |
wgdServer | 1 | Only the records shown are read; filter, groups and summaries are statements on the record source. |
Remarks
None
Code example
None
Inheritance
None
WklLinkDifferenceKind enumeration
Signature
Enum WklLinkDifferenceKind
wldMissing = 0
wldWrongConnection = 1
wldWrongRemoteTable = 2
wldLocalTableInTheWay = 3
wldNoConnection = 4
wldUnmanaged = 5
End Enum
Summary
Kinds of difference between the configuration and the tables of the front end.
Parameters
| Constant | Value | Description |
|---|---|---|
wldMissing | 0 | The configured table is not in the front end. |
wldWrongConnection | 1 | The link points to another source (driver, server, database, login or parameters differ). |
wldWrongRemoteTable | 2 | The link points to another remote table. |
wldLocalTableInTheWay | 3 | A local table has the configured name; it is never replaced. |
wldNoConnection | 4 | The connection row named by the table does not exist, or the connection has no row for the profile. |
wldUnmanaged | 5 | An ODBC link that is not in USysLinkedTable; information only. |
Remarks
None
Code example
None
Inheritance
None
WklSplitOrientation enumeration
Signature
Enum WklSplitOrientation
wsoVertical = 0
wsoHorizontal = 1
End Enum
Summary
Direction of a WklSplitter.
Parameters
| Constant | Value | Description |
|---|---|---|
wsoVertical | 0 | A vertical bar between areas left and right of it; dragged sideways (default). |
wsoHorizontal | 1 | A horizontal bar between areas above and below it; dragged up and down. |
Remarks
None
Code example
None
Inheritance
None
WklSplitCollapse enumeration
Signature
Enum WklSplitCollapse
wscNone = 0
wscFirst = 1
wscSecond = 2
End Enum
Summary
Side of a WklSplitter that is folded away.
Parameters
| Constant | Value | Description |
|---|---|---|
wscNone | 0 | No side is folded away. |
wscFirst | 1 | The areas left of or above the bar. |
wscSecond | 2 | The areas right of or below the bar. |
Remarks
None
Code example
None
Inheritance
None
WklDockZone enumeration
Signature
Enum WklDockZone
wdzLeft = 0
wdzTop = 1
wdzRight = 2
wdzBottom = 3
wdzFill = 4
End Enum
Summary
Zone of an area in a WklDockLayout.
Parameters
| Constant | Value | Description |
|---|---|---|
wdzLeft | 0 | A strip along the left edge, the full height of the room left. |
wdzTop | 1 | A strip along the top edge, the full width of the room left. |
wdzRight | 2 | A strip along the right edge, the full height of the room left. |
wdzBottom | 3 | A strip along the bottom edge, the full width of the room left. |
wdzFill | 4 | What the docked areas leave over. |
Remarks
None
Code example
None
Inheritance
None
WklTabChangeReason enumeration
Signature
Enum WklTabChangeReason
wtcUser = 0
wtcCode = 1
wtcRestore = 2
End Enum
Summary
Why a tab group of a WklDockLayout shows another card (AfterTabChange).
Parameters
| Constant | Value | Description |
|---|---|---|
wtcUser | 0 | The user chose the card: a click on its tab, an arrow key on the tab strip, or a screen reader. |
wtcCode | 1 | Code showed another card: GroupPane, or Reset, Layout, Refresh. |
wtcRestore | 2 | The user's remembered arrangement was restored when the form opened. |
Remarks
None
Code example
None
Inheritance
None
WklStatusDisplay enumeration
Signature
Enum WklStatusDisplay
wsdPill = 0
wsdDot = 1
wsdSymbol = 2
End Enum
Summary
How a WklStatusLabel shows its kind.
Parameters
| Constant | Value | Description |
|---|---|---|
wsdPill | 0 | A colored pill that carries the text (default). |
wsdDot | 1 | A colored dot before the text. |
wsdSymbol | 2 | The glyph in the color of the kind before the text; without a glyph, a dot. |
Remarks
None
Code example
None
Inheritance
None
WklNavBarMode enumeration
Signature
Enum WklNavBarMode
wnmExpanded = 0
wnmCompact = 1
wnmHidden = 2
End Enum
Summary
How much of a WklNavBar is shown.
Parameters
| Constant | Value | Description |
|---|---|---|
wnmExpanded | 0 | Symbols with captions and group headers (default). |
wnmCompact | 1 | The narrow column of symbols only. |
wnmHidden | 2 | Nothing; the bar takes no room. Code or the shortcut brings it back. |
Remarks
None
Code example
None
Inheritance
None
WklNavBarPosition enumeration
Signature
Enum WklNavBarPosition
wnpTop = 0
wnpBottom = 1
End Enum
Summary
Where an entry of a WklNavBar stands.
Parameters
| Constant | Value | Description |
|---|---|---|
wnpTop | 0 | At the top, ungrouped or in a group; scrolls when the bar is too low. |
wnpBottom | 1 | At the bottom edge, without group; never scrolls, for example for settings and help. |
Remarks
None
Code example
None
Inheritance
None
WklNavTargetKind enumeration
Signature
Enum WklNavTargetKind
wntNone = 0
wntSubform = 1
wntForm = 2
wntReport = 3
End Enum
Summary
What choosing an entry of a WklNavBar shows without code.
Parameters
| Constant | Value | Description |
|---|---|---|
wntNone | 0 | Nothing; the application reacts to Navigate. |
wntSubform | 1 | The target becomes the SourceObject of the subform control TargetControl. |
wntForm | 2 | The target form is opened, or activated when it is open. |
wntReport | 3 | The target report is opened in print preview. |
Remarks
None
Code example
None
Inheritance
None
WklButtonKind enumeration
Signature
Enum WklButtonKind
wbkButton = 0
wbkMenu = 1
wbkSplit = 2
wbkSegment = 3
End Enum
Summary
What pressing a WklButton does.
Parameters
| Constant | Value | Description |
|---|---|---|
wbkButton | 0 | Raises Click (default). |
wbkMenu | 1 | Opens the menu; choosing an entry raises MenuItemClick. |
wbkSplit | 2 | The main part raises Click, the arrow opens the menu. |
wbkSegment | 3 | A row of segments of which one (or, with MultiSelect, several) is selected; a change by the user raises Change. |
Remarks
None
Code example
None
Inheritance
None
WklButtonStyle enumeration
Signature
Enum WklButtonStyle
wbsStandard = 0
wbsPrimary = 1
wbsSubtle = 2
wbsDanger = 3
End Enum
Summary
The emphasis of a WklButton.
Parameters
| Constant | Value | Description |
|---|---|---|
wbsStandard | 0 | The ordinary button of Office dialogs: light fill, thin border (default). |
wbsPrimary | 1 | The main command of a page: filled with the accent color. |
wbsSubtle | 2 | A command in a bar: no fill or border until the mouse pointer is over it. |
wbsDanger | 3 | A command that deletes or discards: filled red. |
Remarks
None
Code example
None
Inheritance
None
WklGlyphPosition enumeration
Signature
Enum WklGlyphPosition
wgpLeft = 0
wgpTop = 1
wgpOnly = 2
End Enum
Summary
Where a WklButton draws its symbol.
Parameters
| Constant | Value | Description |
|---|---|---|
wgpLeft | 0 | Before the caption (default). |
wgpTop | 1 | Above the caption, larger, as the large buttons of the Office ribbon. |
wgpOnly | 2 | Only the symbol; the caption is the name screen readers hear. |
Remarks
None
Code example
None
Inheritance
None
WklToastKind enumeration
Signature
Enum WklToastKind
wtkInfo = 0
wtkSuccess = 1
wtkWarning = 2
wtkError = 3
End Enum
Summary
The kind of a note, which decides the color of its bar and its symbol.
Parameters
| Constant | Value | Description |
|---|---|---|
wtkInfo | 0 | A neutral note (blue, i). |
wtkSuccess | 1 | Something worked, such as saved or deleted (green, check mark). |
wtkWarning | 2 | Something worked but needs attention (amber, triangle). |
wtkError | 3 | Something failed (red, cross). |
Remarks
None
Code example
None
Inheritance
None
WklToastCloseReason enumeration
Signature
Enum WklToastCloseReason
wtrTimeout = 0
wtrAction = 1
wtrUser = 2
wtrCode = 3
wtrOwnerClosed = 4
End Enum
Summary
Why a note closed.
Parameters
| Constant | Value | Description |
|---|---|---|
wtrTimeout | 0 | Its time ran out. |
wtrAction | 1 | The user chose its action. |
wtrUser | 2 | The user closed it (close button or Esc). |
wtrCode | 3 | Close or CloseAll. |
wtrOwnerClosed | 4 | The form it was shown in, or Access, closed. |
Remarks
None
Code example
None
Inheritance
None
WklBadgeCorner enumeration
Signature
Enum WklBadgeCorner
wbcTopRight = 0
wbcTopLeft = 1
wbcBottomRight = 2
wbcBottomLeft = 3
wbcRightMiddle = 4
End Enum
Summary
The corner of the target a badge stands on.
Parameters
| Constant | Value | Description |
|---|---|---|
wbcTopRight | 0 | Centered on the top-right corner (default). |
wbcTopLeft | 1 | Centered on the top-left corner. |
wbcBottomRight | 2 | Centered on the bottom-right corner. |
wbcBottomLeft | 3 | Centered on the bottom-left corner. |
wbcRightMiddle | 4 | Inside the target at its right edge, centered vertically, for example a count at the end of a wide button. |
Remarks
None
Code example
None
Inheritance
None
WklPrintStyle enumeration
Signature
Enum WklPrintStyle
wpsAutomatic = 0
wpsColor = 1
wpsPatterns = 2
End Enum
Summary
When a chart or gauge tells its series and ranges apart by pattern as well as by color.
Parameters
| Constant | Value | Description |
|---|---|---|
wpsAutomatic | 0 | By pattern when printed or in print preview, by color on the screen. |
wpsColor | 1 | By color only, also when printed. |
wpsPatterns | 2 | By pattern as well, also on the screen. |
Remarks
None
Code example
None
Inheritance
None
WklGaugeShape enumeration
Signature
Enum WklGaugeShape
wgeHalfCircle = 0
wgeThreeQuarterCircle = 1
wgeHorizontal = 2
wgeVertical = 3
End Enum
Summary
The outline of a WklGauge.
Parameters
| Constant | Value | Description |
|---|---|---|
wgeHalfCircle | 0 | A half circle open to the bottom, minimum on the left (default). |
wgeThreeQuarterCircle | 1 | Three quarters of a circle open to the bottom, minimum at the lower left. |
wgeHorizontal | 2 | A horizontal bar, minimum on the left; can show further bars. |
wgeVertical | 3 | A vertical bar, minimum at the bottom; can show further bars. |
Remarks
None
Code example
None
Inheritance
None
WklGaugeStyle enumeration
Signature
Enum WklGaugeStyle
wgfFill = 0
wgfNeedle = 1
End Enum
Summary
How a WklGauge shows its value.
Parameters
| Constant | Value | Description |
|---|---|---|
wgfFill | 0 | The arc or bar is filled up to the value (default). |
wgfNeedle | 1 | A needle or a tick points at the value; the ranges stay visible behind it. |
Remarks
None
Code example
None
Inheritance
None
WklDrawerCloseReason enumeration
Signature
Enum WklDrawerCloseReason
wdcCode = 0
wdcUser = 1
wdcEscape = 2
End Enum
Summary
Why a WklDrawer closed.
Parameters
| Constant | Value | Description |
|---|---|---|
wdcCode | 0 | By code (Close, Toggle, IsOpen = False). |
wdcUser | 1 | By the user with the close button of the bar. |
wdcEscape | 2 | By the user with Esc (only with CloseOnEscape). |
Remarks
None
Code example
None
Inheritance
None
WklAppMode enumeration
Signature
Enum WklAppMode
wamDevelopment = 0
wamAdministration = 1
wamProduction = 2
End Enum
Summary
The mode a database runs in, measured from the file and from Access.
Parameters
| Constant | Value | Description |
|---|---|---|
wamDevelopment | 0 | An ACCDB, opened in full Access or the runtime. |
wamAdministration | 1 | An ACCDE in full Access. |
wamProduction | 2 | An ACCDE in the runtime. |
Remarks
None
Code example
None
Inheritance
None
WklTrustCode enumeration
Signature
Enum WklTrustCode
wtuOk = 0
wtuLocationMissing = 10
wtuUserLocationsForbidden = 11
wtuAllLocationsDisabled = 12
wtuNetworkLocationForbidden = 13
wtuMacrosDisabledByPolicy = 20
wtuSignatureMissing = 30
wtuPublisherNotTrusted = 31
wtuActiveXDisabledByPolicy = 40
wtuActiveXDisabled = 41
wtuFileBlockedFromInternet = 50
wtuComponentsNotRegistered = 60
End Enum
Summary
Whether Access runs the code of an application file, and if not, the one reason to fix. The numbers never change; they are also the exit codes of Test-AccessTrust.ps1.
Parameters
| Constant | Value | Description |
|---|---|---|
wtuOk | 0 | Access runs the code (0). |
wtuLocationMissing | 10 | No trusted location covers the folder of the file (10). |
wtuUserLocationsForbidden | 11 | A group policy allows only the trusted locations of the policy (11). |
wtuAllLocationsDisabled | 12 | A group policy switches off all trusted locations (12). |
wtuNetworkLocationForbidden | 13 | The trusted location is on the network, and trusted locations on the network are not allowed (13). |
wtuMacrosDisabledByPolicy | 20 | A group policy disables all macros without notification (20). |
wtuSignatureMissing | 30 | Only digitally signed code runs, and the file is not signed (30). |
wtuPublisherNotTrusted | 31 | Only digitally signed code runs, and the publisher is not a trusted publisher (31). |
wtuActiveXDisabledByPolicy | 40 | The code runs, but a group policy disables ActiveX controls, so the WKL controls stay empty (40). |
wtuActiveXDisabled | 41 | The code runs, but the user's own Trust Center setting “Disable all controls without notification” disables ActiveX controls, so the WKL controls stay empty - also in a trusted location; the user can change it (41). |
wtuFileBlockedFromInternet | 50 | The file comes from the internet, and macros from the internet are blocked (50). |
wtuComponentsNotRegistered | 60 | The WKL components are not registered for the user in the bitness of Access (60); returned by Test-AccessTrust.ps1 when it cannot create the components. |
Remarks
None
Code example
None
Inheritance
None
WklSymbology enumeration
Signature
Enum WklSymbology
wsyQrCode = 0
wsyCode128 = 1
wsyDataMatrix = 2
End Enum
Summary
The kind of code of WklBarcode.
Parameters
| Constant | Value | Description |
|---|---|---|
wsyQrCode | 0 | QR Code (ISO/IEC 18004), any text as UTF-8 (default). |
wsyCode128 | 1 | Code 128 (ISO/IEC 15417), ASCII 0-127, one row of bars. |
wsyDataMatrix | 2 | Data Matrix ECC 200 (ISO/IEC 16022), square, ISO-8859-1. |
Remarks
None
Code example
None
Inheritance
None
WklErrorCorrection enumeration
Signature
Enum WklErrorCorrection
wecLow = 0
wecMedium = 1
wecQuartile = 2
wecHigh = 3
End Enum
Summary
How much of a QR Code may be damaged and still be read.
Parameters
| Constant | Value | Description |
|---|---|---|
wecLow | 0 | About 7 %. |
wecMedium | 1 | About 15 % (default). |
wecQuartile | 2 | About 25 %. |
wecHigh | 3 | About 30 %. |
Remarks
None
Code example
None
Inheritance
None
WklImageSizeMode enumeration
Signature
Enum WklImageSizeMode
wimClip = 0
wimStretch = 1
wimZoom = 2
End Enum
Summary
How the picture of WklImage fills the control.
Parameters
| Constant | Value | Description |
|---|---|---|
wimClip | 0 | Natural size from the top left; what does not fit is cut off. |
wimStretch | 1 | Fills the control; the aspect ratio is not kept. |
wimZoom | 2 | As large as fits with the aspect ratio kept, centered (default). |
Remarks
None
Code example
None
Inheritance
None
WklTimerTaskKind enumeration
Signature
Enum WklTimerTaskKind
wttEvent = 0
wttSteps = 1
wttHttp = 2
wttFile = 3
wttChecksum = 4
wttZip = 5
wttProgram = 6
End Enum
Summary
The kind of work of a WklTimerTask.
Parameters
| Constant | Value | Description |
|---|---|---|
wttEvent | 0 | Raises TaskDue; the event procedure is the run. |
wttSteps | 1 | VBA in steps (not available in this version). |
wttHttp | 2 | A queue of web requests sent by the control. |
wttFile | 3 | Copy or move files (not available in this version). |
wttChecksum | 4 | Checksum of a file (not available in this version). |
wttZip | 5 | Pack or unpack a ZIP file (not available in this version). |
wttProgram | 6 | External program (not available in this version). |
Remarks
None
Code example
None
Inheritance
None
WklTimerOverlap enumeration
Signature
Enum WklTimerOverlap
wtoSkip = 0
wtoOnce = 1
End Enum
Summary
What happens with due times that pass while a run is still going.
Parameters
| Constant | Value | Description |
|---|---|---|
wtoSkip | 0 | They are dropped. |
wtoOnce | 1 | Exactly one run follows right after. |
Remarks
None
Code example
None
Inheritance
None
WklTimerTaskState enumeration
Signature
Enum WklTimerTaskState
wtsStopped = 0
wtsWaiting = 1
wtsRunning = 2
wtsPaused = 3
wtsDone = 4
End Enum
Summary
The state of a WklTimerTask.
Parameters
| Constant | Value | Description |
|---|---|---|
wtsStopped | 0 | Not started, or stopped. |
wtsWaiting | 1 | Waiting for its due time. |
wtsRunning | 2 | A run is going on. |
wtsPaused | 3 | Paused; Resume goes on with the time left. |
wtsDone | 4 | Ran once and has no interval. |
Remarks
None
Code example
None
Inheritance
None
WklHttpRequestState enumeration
Signature
Enum WklHttpRequestState
wrsWaiting = 0
wrsSending = 1
wrsCompleted = 2
wrsFailed = 3
wrsCancelled = 4
End Enum
Summary
The state of a WklHttpRequest.
Parameters
| Constant | Value | Description |
|---|---|---|
wrsWaiting | 0 | In the queue, not yet sent. |
wrsSending | 1 | On the way. |
wrsCompleted | 2 | Answered with 2xx or 3xx. |
wrsFailed | 3 | Answered otherwise, or no answer and no retry left. |
wrsCancelled | 4 | Canceled; never sent again. |
Remarks
None
Code example
None
Inheritance
None
WklTimerCancelReason enumeration
Signature
Enum WklTimerCancelReason
wcrCancel = 0
wcrStop = 1
wcrTimeout = 2
wcrClose = 3
End Enum
Summary
Why a run or a request was canceled.
Parameters
| Constant | Value | Description |
|---|---|---|
wcrCancel | 0 | Cancel or Requests.Clear. |
wcrStop | 1 | Stop. |
wcrTimeout | 2 | The time limit passed. |
wcrClose | 3 | The form closed. |
Remarks
None
Code example
None
Inheritance
None
WklChartType enumeration
Signature
Enum WklChartType
wctLine = 0
wctPoint = 1
wctColumn = 2
wctBar = 3
End Enum
Summary
The kind of picture of a WklChart.
Parameters
| Constant | Value | Description |
|---|---|---|
wctLine | 0 | Lines through the points. |
wctPoint | 1 | Points without lines. |
wctColumn | 2 | Vertical columns. |
wctBar | 3 | Horizontal bars. |
Remarks
None
Code example
None
Inheritance
None
WklChartXKind enumeration
Signature
Enum WklChartXKind
wcxNumber = 0
wcxDate = 1
wcxCategory = 2
End Enum
Summary
What the X values of a WklChart are.
Parameters
| Constant | Value | Description |
|---|---|---|
wcxNumber | 0 | Numbers on a linear axis. |
wcxDate | 1 | Dates and times on a time axis. |
wcxCategory | 2 | Texts; each distinct text is one category. |
Remarks
None
Code example
None
Inheritance
None
WklChartGrouping enumeration
Signature
Enum WklChartGrouping
wcgGrouped = 0
wcgStacked = 1
End Enum
Summary
How several series of columns or bars stand.
Parameters
| Constant | Value | Description |
|---|---|---|
wcgGrouped | 0 | Side by side. |
wcgStacked | 1 | On top of each other. |
Remarks
None
Code example
None
Inheritance
None
WklChartAggregate enumeration
Signature
Enum WklChartAggregate
wcaNone = 0
wcaSum = 1
wcaAverage = 2
wcaCount = 3
wcaMin = 4
wcaMax = 5
End Enum
Summary
How values of one X or period are combined.
Parameters
| Constant | Value | Description |
|---|---|---|
wcaNone | 0 | Every row is a point. |
wcaSum | 1 | Sum. |
wcaAverage | 2 | Mean. |
wcaCount | 3 | Number of rows; no Y field needed. |
wcaMin | 4 | Smallest value. |
wcaMax | 5 | Largest value. |
Remarks
None
Code example
None
Inheritance
None
WklChartPeriod enumeration
Signature
Enum WklChartPeriod
wcyNone = 0
wcyDay = 1
wcyWeek = 2
wcyMonth = 3
wcyQuarter = 4
wcyYear = 5
End Enum
Summary
The period a date axis is grouped by.
Parameters
| Constant | Value | Description |
|---|---|---|
wcyNone | 0 | None: equal dates are combined. |
wcyDay | 1 | Day. |
wcyWeek | 2 | ISO week, from Monday. |
wcyMonth | 3 | Month. |
wcyQuarter | 4 | Quarter. |
wcyYear | 5 | Year. |
Remarks
None
Code example
None
Inheritance
None
WklChartMissing enumeration
Signature
Enum WklChartMissing
wcvGap = 0
wcvConnect = 1
wcvZero = 2
End Enum
Summary
What happens with a missing Y value.
Parameters
| Constant | Value | Description |
|---|---|---|
wcvGap | 0 | The line is interrupted. |
wcvConnect | 1 | The point is left out; the line connects its neighbors. |
wcvZero | 2 | The value counts as 0. |
Remarks
None
Code example
None
Inheritance
None