TExcelFile.SetObjectSelection Method

Sets the selected item of an object from the "Forms" palette. It can be a combobox, a listbox, a spinbox or a scrollbar. Note that this only works for objects added through the Forms toolbar. It won't return the values of ActiveX objects.

Remarks

If the object is linked to a cell, this method will change both the object and the cell.

Syntax

Unit: FlexCel.Core

procedure TExcelFile.SetObjectSelection(const objectIndex: Integer; const objectPath: string; const selectedItem: Integer); virtual; abstract;

Parameters

<->	Parameter	Type	Description
const	objectIndex	Integer	Index of the object (1 based)
const	objectPath	string	Index to the child object you want to change the property. If it is a simple object, you can use String.Empty here, if not you need to get the ObjectPath from GetObjectProperties(Integer, Boolean) If it is "absolute"(it starts with "\"), then the path includes the objectIndex, and the objectIndex is not used. An object path of "\1\2\3" is exactly the same as using objectIndex = 1 and objectPath = "2\3"
const	selectedItem	Integer	Position of the selected item in the object. 0 means no selection, 1 means that the first item is selected.

Examples

To set a combobox selection to be the 5th item, use the code:

var
  xls: TXlsFile;
  i: Int32;
  shp: IShapeProperties;
begin
  xls := TXlsFile.Create('comboboxes.xls');
  try
    for i := 1 to xls.ObjectCount do
    begin
      shp := xls.GetObjectProperties(i, false);
      if (shp.ObjectType = TObjectType.ComboBox) and (shp.Text = 'MyText') then
      begin
        xls.SetObjectSelection(i, '', 5);
      end;

    end;
  finally
    xls.Free;
  end;
end;

To change a combo given its name instead of its text, replace shp.Text == "MyText" by shp.Name == "MyName" in the code above.

See also

• TExcelFile