SetCommitOnSelChange
Sets field commit on selection change prop.
Syntax
expression.SetCommitOnSelChange(bCommit);
expression - A variable that represents a ApiBaseListField class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| bCommit | Required | boolean | will the field value be applied to all with the same name immediately after the change |
Returns
boolean
Example
Set commit on selection change prop to field with list of options in a PDF document.
// How can I set commit on sel change using a list field in a PDF document?
// Set commit on sel change for a list field in a PDF document.
let doc = Api.GetDocument();
let page = doc.GetPage(0);
let comboboxField = Api.CreateComboboxField([10, 10, 160, 30]);
page.AddObject(comboboxField);
comboboxField.AddOption('Option 1');
comboboxField.AddOption('Option 2');
comboboxField.AddOption('Option 3');
comboboxField.SetCommitOnSelChange(true);
comboboxField.SetValue('Commit on sel change is: ' + comboboxField.IsCommitOnSelChange());