Class DocumentTriggerBuilder
Stay organized with collections
Save and categorize content based on your preferences.
DocumentTriggerBuilder
A builder for document triggers.
Detailed documentation
create()
Creates and returns the new trigger.
Return
Trigger — The new trigger.
onOpen()
Specifies a trigger that will fire when the document is opened.
const document = DocumentApp.getActiveDocument();
ScriptApp.newTrigger('myFunction').forDocument(document).onOpen().create();
Return
DocumentTriggerBuilder — This DocumentTriggerBuilder, 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\u003eThe DocumentTriggerBuilder helps in creating and managing triggers for Google Docs.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods like \u003ccode\u003ecreate()\u003c/code\u003e to finalize the trigger and \u003ccode\u003eonOpen()\u003c/code\u003e to set a trigger for when the document is opened.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eonOpen()\u003c/code\u003e method allows you to specify a function to execute when a document is opened, enhancing document automation capabilities.\u003c/p\u003e\n"]]],["The `DocumentTriggerBuilder` class facilitates the creation of triggers for Google Documents. Key actions include `create()`, which generates and returns a new `Trigger` object, and `onOpen()`, which configures the trigger to activate when the document is opened. The `onOpen()` method returns the `DocumentTriggerBuilder` instance, allowing method chaining. The provided example demonstrates creating a trigger that runs \"myFunction\" upon document opening.\n"],null,["# Class DocumentTriggerBuilder\n\nDocumentTriggerBuilder\n\nA builder for document 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| [onOpen()](#onOpen()) | [DocumentTriggerBuilder](#) | Specifies a trigger that will fire when the document 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``Open()`\n\nSpecifies a trigger that will fire when the document is opened.\n\n```javascript\nconst document = DocumentApp.getActiveDocument();\nScriptApp.newTrigger('myFunction').forDocument(document).onOpen().create();\n```\n\n#### Return\n\n\n[DocumentTriggerBuilder](#) --- This [DocumentTriggerBuilder](#), for chaining."]]
