Skip to main content
Table of Contents

TTMSFNCCheckedListBox.CheckedItems Method

Returns all checked items in the list box.

API unit family: TMSFNCCheckedListBox Declaring type: TTMSFNCCheckedListBox Inherited from: TTMSFNCCustomCheckedListBox

Syntax

FMX.TMSFNCCheckedListBox.hppPascalC++
function CheckedItems: TTMSFNCListBoxCheckedItems; virtual;
virtual TTMSFNCListBoxCheckedItems __fastcall CheckedItems();

Returns

Array containing the checked items in display order.

Usage examples

Collect checked items

Uses bulk selection and enumerates the checked item array.

Collect checked itemsPascalC++
procedure TForm1.SelectAllOptions;
begin
  TMSFNCCheckedListBox1.CheckAll;
end;

procedure TForm1.ShowCheckedOptions;
var
  Checked: TTMSFNCListBoxCheckedItems;
  Item: TTMSFNCCheckedListBoxItem;
  Summary: string;
begin
  Checked := TMSFNCCheckedListBox1.CheckedItems;
  Summary := '';

  for Item in Checked do
  begin
    if Summary <> '' then
      Summary := Summary + ', ';

    Summary := Summary + Item.Text;
  end;

  ShowMessage(Summary);
end;

void __fastcall TForm1::SelectAllOptions()
{
  TMSFNCCheckedListBox1->CheckAll();
}

void __fastcall TForm1::ShowCheckedOptions()
{
  TTMSFNCListBoxCheckedItems Checked = TMSFNCCheckedListBox1->CheckedItems();
  System::UnicodeString Summary = "";

  for (int i = 0; i < Checked.Length; i++)
  {
    TTMSFNCCheckedListBoxItem *Item = Checked[i];
    if (Summary != "")
      Summary = Summary + ", ";

    Summary = Summary + Item->Text;
  }

  ShowMessage(Summary);
}

Read the related guide