Skip to main content

SetMultipleSelection

Sets field multiselect prop.

Syntax

expression.SetMultipleSelection(bMulti);

expression - A variable that represents a ApiListboxField class.

Parameters

NameRequired/OptionalData typeDefaultDescription
bMultiRequiredbooleanallow user select multi values

Returns

boolean

Example

This example sets multiple selection for listbox field.

let doc = Api.GetDocument();
let page = doc.GetPage(0);
let listboxField = Api.CreateListboxField([10, 10, 160, 100]);
page.AddObject(listboxField);

listboxField.AddOption('Option 1');
listboxField.AddOption('Option 2');
listboxField.AddOption('Option 3');
listboxField.AddOption('Option 4');
listboxField.SetMultipleSelection(true);
listboxField.SetValueIndexes([0, 3]);