WklColumn

Dim myWklColumn As WklColumn

A column of a tree list.

None

A column object is a live view of the list's definition: a change takes effect at once and is saved with the form (WklTreeList.ColumnLayout).

Not created directly; returned by other members of the library.

None

None

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

Gets or sets the unique name of the column.

None

Property value: String – The name; used by CellValue, CellText and the events.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the field of the record source the column shows.

None

Property value: String – A field name.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the header text.

None

Property value: String – The text; empty for the field name.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the width in twips.

None

Property value: Long – The width; 1,440 twips are one inch (2.54 cm).

Read/write.

None

Declared by WklColumn.

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

Gets or sets whether the column is shown.

None

Property value: Boolean – True to show the column.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the position of the column in its band row.

None

Property value: Long – The 0-based display position.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the band that holds the column.

None

Property value: String – The band name; empty for none.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the row of a multi-row record the column is shown in.

None

Property value: Long – The 0-based row; 0 is the first row.

Rows greater than 0 turn every record into several rows, for example to show an address below a name.

Read/write.

None

Declared by WklColumn.

Property Get Alignment() As WklAlignment
Property Let Alignment(RHS As WklAlignment)

Gets or sets the alignment of the cells.

None

Property value: `WklAlignment` – A `WklAlignment` constant.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the display format, as in Access.

None

Property value: String – A named format (Currency, Short Date …) or a format string such as #,##0.00.

The format applies to the display, to CellText and to the Excel export. The named formats are accepted in English and in German (Currency or Währung, Short Date or Datum, kurz).

Read/write.

None

Declared by WklColumn.

Property Get Editor() As WklEditor
Property Let Editor(RHS As WklEditor)

Gets or sets the cell editor.

None

Property value: `WklEditor` – A `WklEditor` constant.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the list of a lookup column.

None

Property value: String – A table, query or SQL statement, or a value list such as 'A';'B';'C'.

Used with Editor = wedLookup. BoundColumn and DisplayColumn select the stored and the displayed column of the list.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the column of the lookup list that is stored.

None

Property value: Long – The 1-based column number.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the column of the lookup list that is displayed.

None

Property value: Long – The 1-based column number; 0 to display the bound column.

Read/write.

None

Declared by WklColumn.

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

Gets or sets whether the cells of the column can be edited.

None

Property value: Boolean – True to prevent editing.

Read/write.

None

Declared by WklColumn.

Property Get SortDirection() As WklSortDirection
Property Let SortDirection(RHS As WklSortDirection)

Gets or sets the sort direction of the column.

None

Property value: `WklSortDirection` – A `WklSortDirection` constant.

Sorting by columns orders sibling nodes; it overrides SortOrder while a column is sorted. A click on a column header sorts by it.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the rank of the column among the sorted columns.

None

Property value: Long – 0 for the first sort column; -1 when the column is not sorted.

Read/write.

None

Declared by WklColumn.

Property Get Summary() As WklSummary
Property Let Summary(RHS As WklSummary)

Gets or sets the total shown in the footer.

None

Property value: `WklSummary` – A `WklSummary` constant.

The footer is shown with WklTreeList.ShowFooter. The total covers the loaded records; group nodes are not counted.

Read/write.

None

Declared by WklColumn.

Sub AddImageItem(ByVal Value As Variant, ByVal Image As String, Optional ByVal Text As String = "")

Adds an entry to the image lookup list of the column.

Used with Editor = wedImageLookup.

None

Declared by WklColumn.

Sub ClearImageItems()

Removes all entries of the image lookup list or the status list.

None

None

None

Declared by WklColumn.

Property Get ImageItemCount() As Long

Returns the number of entries of the image lookup list or the status list.

None

Property value: Long – The number of entries.

Read-only.

None

Declared by WklColumn.

Sub BestFit()

Sets the width to fit the header and the contents.

None

None

None

Declared by WklColumn.

Sub AddStatusItem(ByVal Value As Variant, ByVal Text As String, Optional ByVal Kind As WklStatusKind = wskNeutral, Optional ByVal Image As String = "")

Adds or replaces the status label of a value.

Used with Editor = wedStatus. The cell shows the label of the entry whose value equals the field; the user changes it with a drop-down list of the labels, as with a lookup. A value without an entry shows its formatted value on a label whose kind comes from StatusKindField, so texts computed per record - “expires in 5 days” - need no entry at all.

In Windows high contrast mode the labels keep no color of their own: they are drawn as outlines in the text color of the theme. A format rule that sets colors on the cell overrides the kind's colors. In an export as shown (wemWysiwyg) the kind's colors become the fill and font color of the cell.

None

Declared by WklColumn.

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

Gets or sets the field of the record that holds the kind of a status label, for values without an entry.

None

Property value: String – A field name of the record source; empty (default): such labels are neutral.

The field holds a number 0-4 or a name (ok, warn, bad, info, neutral); anything else is neutral. Usually it is a calculated field of the query, so the rule that decides the kind lives next to the data, for example IIf([GueltigBis] < Date(), 'neutral', IIf([GueltigBis] < Date() + 14, 'warn', 'ok')) AS SchluesselArt. Setting it loads the field with the records.

Read/write.

None

Declared by WklColumn.

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

Gets or sets whether a status label is a link.

None

Property value: Boolean – True: a click on the label, or Enter on its cell, raises StatusClick of the grid and does not edit the cell; False (default).

Clickable labels are underlined and show the hand cursor, as a hyperlink in an Access datasheet. Typical use: a count such as “3 rules” that opens the rules of the record.

Read/write.

None

Declared by WklColumn.

Sub AddCommand(ByVal Name As String, ByVal Caption As String, Optional ByVal Kind As WklCommandKind = wcmNormal, Optional ByVal VisibleField As String = "", Optional ByVal EnabledField As String = "", Optional ByVal DisabledReasonField As String = "", Optional ByVal AccessibleField As String = "", Optional ByVal Shortcut As String = "", Optional ByVal AllowMultiple As Boolean = False)

Adds a command to a command column, or replaces the command of the same name.

Used with Editor = wedCommands; setting that editor clears FieldName, since a command column shows no field. The grid does nothing itself: no delete, no write - RowCommand decides, typically after asking the user. A shortcut is taken before the grid's own keys, so a command on Del never deletes the record, whatever AllowDeletions says; a disabled command takes its key as well and runs nothing.

The fields are read like any field of the record: Null and unreadable values count as false, so a command whose condition is unknown is not offered. Deliver them from the data source; in server mode over ODBC, expressions only Access understands (IIf, Date()) make the grid read through Access instead.

Buttons stand side by side from the left of the cell, at most MaxVisibleCommands; further commands - and buttons that do not fit the column - go into the menu of the “⋯” button. Enter or Space on the focused command cell opens a menu of all the record's commands. For UI Automation every record exposes each of its commands as a button - also while the buttons are not drawn - with Invoke.

' Sessions: "End" only for open sessions, the spoken name from the record.
Private Sub Form_Load()
    With Me!Grid1.Object.Columns.Add("Actions", "Actions")
        .Editor = wedCommands
        .AddCommand "edit", "Edit"
        .AddCommand "end", "End", wcmDestructive, EnabledField:="CanEnd", _
            DisabledReasonField:="EndReason", AccessibleField:="EndName", Shortcut:="Del"
    End With
End Sub

Declared by WklColumn.

Sub ClearCommands()

Removes all commands of a command column.

None

None

None

Declared by WklColumn.

Property Get CommandCount() As Long

Returns the number of commands of a command column.

None

Property value: Long – The number of commands.

Read-only.

None

Declared by WklColumn.

Property Get CommandsDisplay() As WklCommandsDisplay
Property Let CommandsDisplay(RHS As WklCommandsDisplay)

Gets or sets when the buttons of a command column are drawn.

None

Property value: `WklCommandsDisplay` – A WklCommandsDisplay; default wcdHoverAndSelected.

UI Automation exposes the commands of every record in both modes.

Read/write.

None

Declared by WklColumn.

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

Gets or sets the most buttons a record of a command column shows.

None

Property value: Long – A number from 0; default 2. Further commands go into the “⋯” menu; 0 puts all of them there.

Read/write.

None

Declared by WklColumn.

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

Gets or sets whether a value must be entered in the column's cells.

None

Property value: Boolean – True when Null, an empty text and a text of blanks are refused; False (default) otherwise.

The rule is checked as the other rules of the column (see ValidateMode). The row for a new record checks it before it is saved, also when the user never entered the cell. The value is saved with the form.

Read/write.

Me!Grid1.Object.Columns("Name").Required = True

Declared by WklColumn.

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

Gets or sets the most characters a text in the column may have.

None

Property value: Long – A number of characters; 0 (default) for the size of the field in the data source (a Short Text field of 50 allows 50), -1 for no limit.

The field size is read from the data source (DAO Field.Size) the first time a text of the column is checked; a field that is no text has no limit. Use -1 for a calculated column whose field size says nothing. The value is saved with the form.

Read/write.

Me!Grid1.Object.Columns("Kuerzel").MaxLength = 8

Declared by WklColumn.

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

Gets or sets a regular expression the whole entered text must match.

None

Property value: String – A .NET regular expression, without ^ and $ (the whole text must match anyway); empty (default) for none.

A pattern that is no valid regular expression raises wkeInvalidValue when it is set. An empty cell is not checked against the pattern; set Required as well when a value must be entered. A pattern that takes longer than a quarter of a second on one value counts as not matched. The value is saved with the form.

Read/write.

' An identifier as SQL Server names it, without hyphen; a network in CIDR notation.
Me!Grid1.Object.Columns("Name").Pattern = "[A-Za-z_][A-Za-z0-9_]*"
Me!Grid1.Object.Columns("Netz").Pattern = "(25[0-5]|2[0-4]\d|1?\d?\d)(\.(25[0-5]|2[0-4]\d|1?\d?\d)){3}/(3[0-2]|[12]?\d)"

Declared by WklColumn.

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

Gets or sets the smallest value allowed in the column.

None

Property value: Variant – A number, a date or a text; Null (default) for none.

Numbers compare by value (also a number typed with the user's decimal separator), dates as dates, texts without regard to case, as Access compares text. The value is saved with the form.

Read/write.

Me!Grid1.Object.Columns("Menge").MinValue = 1
Me!Grid1.Object.Columns("Ab").MinValue = #1/1/2026#

Declared by WklColumn.

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

Gets or sets the largest value allowed in the column.

None

Property value: Variant – A number, a date or a text; Null (default) for none.

Compared as MinValue. The message names the range: “"Quantity" must be between 1 and 100.” The value is saved with the form.

Read/write.

Me!Grid1.Object.Columns("Menge").MaxValue = 100

Declared by WklColumn.

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

Gets or sets the values allowed in the column.

None

Property value: String – An Access value list, "a";"b";"c" or a;b;c; empty (default) for any value.

Text compares without regard to case, numbers by value. For a choice the user picks from, use a lookup column (Editor wedLookup with RowSource) instead; ValueList checks what is typed. The value is saved with the form.

Read/write.

Me!Grid1.Object.Columns("Item").ValueList = "from;except_from;database"

Declared by WklColumn.

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

Gets or sets the message shown instead of the generated one when a value breaks a rule of the column.

None

Property value: String – A text; empty (default) for the generated messages.

As the Validation Text of an Access field, the text replaces the message of every rule of the column. The value is saved with the form.

Read/write.

Me!Grid1.Object.Columns("Netz").ValidationText = "Ein Netz wie 10.0.0.0/8"

Declared by WklColumn.

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

Gets or sets the text beside a toggle switch that is on.

None

Property value: String – A text such as Aktiv; empty (default) for none.

Used with Editor = wedToggle. The switch alone (both texts empty) suits narrow columns; a text such as Aktiv/Gesperrt names the meaning where the column caption does not. UI Automation, the search and the export use the texts as well; without them a screen reader hears Ein or Aus. A cell that holds Null (a bit column of SQL Server read over ODBC) shows a gray switch with the knob in the middle and no text; a click turns it on.

A click anywhere in the cell or Space switches it, through BeforeCellEdit, the column's rules, ValidateCell and saving, as typed input; there is no editor. ReadOnly, AllowEditing = False and a refusing BeforeCellEdit keep the value. UI Automation offers the Toggle pattern; its SetValue also takes OnText and OffText. The value is saved with the form.

Read/write.

With Me!Grid1.Object.Columns("Aktiv")
    .Editor = wedToggle
    .OnText = "Aktiv"
    .OffText = "Gesperrt"
End With

Declared by WklColumn.

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

Gets or sets the text beside a toggle switch that is off.

None

Property value: String – A text such as Gesperrt; empty (default) for none.

The counterpart of OnText; see there.

Read/write.

Me!Grid1.Object.Columns("Durchreiche").OffText = "nicht erlaubt"

Declared by WklColumn.

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

Gets or sets the separator between the values of a token column.

None

Property value: String – The separator, for example , or |; empty (default) for ;.

Used with Editor = wedTokens. The column shows one text field of the record as a row of chips: the field is split at the separator, blanks around each value are removed and empty values are dropped, so Red; Green;;Blue shows three chips. Chips that do not fit are counted in a trailing +n. UI Automation, the search, the copy and the export see the values joined with the separator and one blank (Red; Green; Blue).

The column is read-only, whatever ReadOnly says. The field is usually a query that joins the rows of a child table into one text (an Access query with a VBA function, or STRING_AGG in a SQL Server view), which cannot be written back, and one query per record would not scale to large lists. The values are edited in a WklTokenBox bound to the child table, for example in the edit form of the list.

Read/write.

With Me!Grid1.Object.Columns("Rollen")
    .Editor = wedTokens
    .Separator = ","
End With

Declared by WklColumn.

Property Get Step() As Double
Property Let Step(RHS As Double)

Gets or sets the change of one arrow or Up/Down key in a spin column.

None

Property value: Double – A number greater than 0; default 1. Zero, a negative number or an unreadable one raises wkeInvalidValue.

Used with Editor = wedSpin. Up/Down in the cell editor change the number by one step, Page Up/Page Down by ten steps; the result never leaves MinValue and MaxValue of the column. The column shows as many decimal places as the step has (a step of 0.25 shows two), unless Format is set. A typed value outside the limits is refused by the column's rules like any other entry.

Read/write.

With Me!Grid1.Object.Columns("Laufzeit")
    .Editor = wedSpin
    .MinValue = 0
    .MaxValue = 3650
    .Step = 30
    .Unit = "Tage"
End With

Declared by WklColumn.

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

Gets or sets the unit shown after the number in a spin column.

None

Property value: String – A text, for example “Tage” or “Std.”; empty (default) for none.

Display only: the field keeps the number in that unit, and the export writes the number. The cell editor and UI Automation (SetValue) take the number with or without the unit (“30” and “30 Tage”).

Read/write.

None

Declared by WklColumn.

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

Gets or sets whether the column's text is drawn in a fixed-width font.

None

Property value: Boolean – True draws the text in Consolas; False (default) in the font of the list.

For code, JSON, SQL or numbers that shall line up. With Editor = wedMemo the zoom box uses the fixed-width font too and keeps long lines unbroken (they scroll sideways).

Read/write.

None

Declared by WklColumn.

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

Gets or sets the text an empty cell shows.

None

Property value: String – A text, for example “–”, “nie” or “kein Ablauf”; empty (default) shows nothing.

Display only, in gray: Null and an empty text show it; the field keeps its empty value, and the search, copying and the export see the empty value. Screen readers hear it as the name of the cell.

Read/write.

None

Declared by WklColumn.