Skip to content

TWebCheckListBox

Description

Below is a list of the most important properties methods and events for TWebCheckListBox. A TWebCheckListBox is a control having a list of (text) items, similar to a VCL TCheckListBox.

Designtime Runtime

The checked state of items in the list can be get & set in code via the following property:

WebCheckListBox.Checked[Index]: Boolean;

The method below can be called to check or uncheck all checkbox items at once:

WebCheckListBox.CheckAll(AState: TCheckBoxState; AllowGrayed,AllowDisabled: Boolean) 

HTML template tag

The HTML tag the component can be associated with in an HTML template. Assign the ID attribute with a unique value and set the identical value to the ElementID property. Detailed information can be found in the Use of HTML templates topic.

HTML tag <DIV ID=”UniqueID”></DIV>
ElementID UniqueID

Properties for TWebCheckListBox

Property Description
BorderStyle Sets the border style for the control
ElementClassName Optionally sets the CSS classname for the checklistbox when styling via CSS is used
ElementItemClassName Optionally sets the CSS classname for the items in the list when styling via CSS is used
ElementID Optionally sets the HTML element ID for a HTML element in the form HTML file the date picker needs to be connected with. When connected, no new listbox is created but the control class is connected with the existing HTML element in the form HTML file
Enabled Sets whether the control is enabled or disabled
ItemHeight Sets the height of individual items in the listbox
ItemIndex Sets or gets the index of the selected item
Items Access to the items in the listbox as a TStringList
TabOrder Sets the tab order of the control
TabStop When true, the focus is turned to the control when pressing tab
TextDirection Sets the text direction to
tdDefault: does not use direction attribute
tdInherit: uses TextDirection of parent control
tdRightToLeft: uses rtl direction attribute
tdLeftToRight: uses ltr direction attribute

Events for TWebCheckListBox

Event Description
OnChange Event triggered when the selected item changes in the listbox
OnClick Event triggered when the listbox is clicked
OnClickCheck Event triggered when a checkbox in the list is clicked
OnDblClick Event triggered when the listbox is doubleclicked
OnEnter Event triggered when the control gets focus
OnExit Event triggered when focus leaves the control