Skip to main content

IsMultipleSelection

Checks if the field supports multiple selection.

Syntax​

expression.IsMultipleSelection();

expression - A variable that represents a ApiListboxField class.

Parameters​

This method doesn't have any parameters.

Returns​

boolean

Example​

Check if a list selection field allows picking multiple items in a PDF.

// How do I know if multiple choices are allowed in a PDF?

// Verify the selection mode for this field in a PDF.

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]);
console.log('Multiple selection is: ' + listboxField.IsMultipleSelection());