Class FormTriggerBuilder
Stay organized with collections
Save and categorize content based on your preferences.
FormTriggerBuilder
A builder for form triggers.
Detailed documentation
create()
Creates and returns the new trigger.
Return
Trigger — The new trigger.
onOpen()
Specifies a trigger that will fire when the form's edit view is opened.
const form = FormApp.getActiveForm();
ScriptApp.newTrigger('myFunction').forForm(form).onOpen().create();
Return
FormTriggerBuilder — This FormTriggerBuilder, for chaining.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003eFormTriggerBuilder helps in creating custom triggers for Google Forms.\u003c/p\u003e\n"],["\u003cp\u003eIt offers methods to set triggers for form submission (\u003ccode\u003eonFormSubmit()\u003c/code\u003e) and form opening (\u003ccode\u003eonOpen()\u003c/code\u003e).\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003ecreate()\u003c/code\u003e method finalizes and returns the new trigger.\u003c/p\u003e\n"],["\u003cp\u003eTriggers execute specified functions (\u003ccode\u003emyFunction\u003c/code\u003e in the examples) when the defined event (submit or open) occurs.\u003c/p\u003e\n"]]],[],null,["# Class FormTriggerBuilder\n\nFormTriggerBuilder\n\nA builder for form triggers. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------|--------------------------------------------------|------------------------------------------------------------------------------|\n| [create()](#create()) | [Trigger](/apps-script/reference/script/trigger) | Creates and returns the new trigger. |\n| [onFormSubmit()](#onFormSubmit()) | [FormTriggerBuilder](#) | Specifies a trigger that will fire when a response is submitted to the form. |\n| [onOpen()](#onOpen()) | [FormTriggerBuilder](#) | Specifies a trigger that will fire when the form's edit view is opened. |\n\nDetailed documentation\n----------------------\n\n### `create()`\n\nCreates and returns the new trigger.\n\n#### Return\n\n\n[Trigger](/apps-script/reference/script/trigger) --- The new trigger.\n\n*** ** * ** ***\n\n### `on``Form``Submit()`\n\nSpecifies a trigger that will fire when a response is submitted to the form.\n\n```javascript\nconst form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');\nScriptApp.newTrigger('myFunction').forForm(form).onFormSubmit().create();\n```\n\n#### Return\n\n\n[FormTriggerBuilder](#) --- this [FormTriggerBuilder](#), for chaining\n\n*** ** * ** ***\n\n### `on``Open()`\n\nSpecifies a trigger that will fire when the form's edit view is opened.\n\n```javascript\nconst form = FormApp.getActiveForm();\nScriptApp.newTrigger('myFunction').forForm(form).onOpen().create();\n```\n\n#### Return\n\n\n[FormTriggerBuilder](#) --- This [FormTriggerBuilder](#), for chaining."]]
