Ein Dokument, das Rich-Text und Elemente wie Tabellen und Listen enthält.
Dokumente können mit DocumentApp
geöffnet oder erstellt werden.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
addBookmark(position) | Bookmark | Fügt am angegebenen Position ein Bookmark hinzu. |
addEditor(emailAddress) | Document | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. |
addEditor(user) | Document | Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. |
addEditors(emailAddresses) | Document | Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Document hinzu. |
addFooter() | FooterSection | Fügt einen Abschnitt in der Fußzeile eines Dokuments hinzu, falls keiner vorhanden ist |
addHeader() | HeaderSection | Fügt einen Abschnitt mit Dokumentheader hinzu, falls keiner vorhanden ist. |
addNamedRange(name, range) | NamedRange | Fügt ein NamedRange hinzu. Dabei handelt es sich um eine Range mit einem Namen und einer ID, die für den späteren Abruf verwendet werden soll. |
addViewer(emailAddress) | Document | Fügt den angegebenen Nutzer der Liste der Betrachter für Document hinzu. |
addViewer(user) | Document | Fügt den angegebenen Nutzer der Liste der Betrachter für Document hinzu. |
addViewers(emailAddresses) | Document | Fügt das angegebene Array von Nutzern der Liste der Betrachter für Document hinzu. |
getAs(contentType) | Blob | Ruft den aktuellen Document -Inhalt als Blob des angegebenen Typs ab. |
getBlob() | Blob | Ruft den aktuellen Inhalt von Document als Blob ab. |
getBody() | Body | Ruft den Body des aktiven Dokuments ab. |
getBookmark(id) | Bookmark | Ruft das Bookmark mit der angegebenen ID ab. |
getBookmarks() | Bookmark[] | Ruft alle Bookmark -Objekte im Dokument ab. |
getCursor() | Position | Ruft den Cursor des Nutzers im aktiven Dokument ab. |
getEditors() | User[] | Ruft die Liste der Bearbeiter für diesen Document ab. |
getFooter() | FooterSection | Ruft den Fußzeilenabschnitt des Dokuments ab, sofern vorhanden. |
getFootnotes() | Footnote[] | Ruft alle Footnote -Elemente im Dokumenttext ab. |
getHeader() | HeaderSection | Ruft den Header-Abschnitt des Dokuments ab, sofern vorhanden. |
getId() | String | Ruft die eindeutige ID des Dokuments ab. |
getLanguage() | String | Ruft den Sprachcode des Dokuments ab. |
getName() | String | Ruft den Titel des Dokuments ab. |
getNamedRangeById(id) | NamedRange | Ruft das NamedRange mit der angegebenen ID ab. |
getNamedRanges() | NamedRange[] | Ruft alle NamedRange -Objekte im Dokument ab. |
getNamedRanges(name) | NamedRange[] | Ruft alle NamedRange -Objekte im Dokument mit dem angegebenen Namen ab. |
getSelection() | Range | Ruft die Auswahl des Nutzers im aktiven Dokument ab. |
getSupportedLanguageCodes() | String[] | Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden. |
getUrl() | String | Ruft die URL für den Zugriff auf das aktuelle Dokument ab. |
getViewers() | User[] | Liste der Betrachter und Kommentatoren für diesen Document abrufen |
newPosition(element, offset) | Position | Erstellt einen neuen Position , der einen Verweis auf eine Stelle im Dokument ist, relativ zu einem bestimmten Element. |
newRange() | RangeBuilder | Erstellt einen Builder, mit dem Range -Objekte aus Dokumentelementen erstellt werden. |
removeEditor(emailAddress) | Document | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document . |
removeEditor(user) | Document | Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document . |
removeViewer(emailAddress) | Document | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Document . |
removeViewer(user) | Document | Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Document . |
saveAndClose() | void | Speichert den aktuellen Document . |
setCursor(position) | Document | Legt den Cursor des Nutzers im aktiven Dokument mit Position fest. |
setLanguage(languageCode) | Document | Legt den Sprachcode des Dokuments fest. |
setName(name) | Document | Legt den Dokumenttitel fest. |
setSelection(range) | Document | Legt die Auswahl des Nutzers im aktiven Dokument anhand eines Range fest. |
Detaillierte Dokumentation
addBookmark(position)
Fügt am angegebenen Position
ein Bookmark
hinzu.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId()); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
position | Position | Die Position des neuen Lesezeichens. |
Return
Bookmark
: Das neue Lesezeichen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(emailAddress)
Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document
hinzu. Wenn der Nutzer bereits in der Liste der Betrachter enthalten war, wird er mit dieser Methode aus der Liste der Betrachter herausgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der hinzugefügt werden soll. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditor(user)
Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document
hinzu. Wenn der Nutzer bereits in der Liste der Betrachter enthalten war, wird er mit dieser Methode aus der Liste der Betrachter herausgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des hinzuzufügenden Nutzers. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addEditors(emailAddresses)
Fügt das angegebene Array von Nutzern der Liste der Bearbeiter für Document
hinzu. Wenn einer der Nutzer bereits in der Liste der Betrachter enthalten war, wird er mit dieser Methode aus der Liste der Betrachter herausgestuft.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addHeader()
Fügt einen Abschnitt mit Dokumentheader hinzu, falls keiner vorhanden ist.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Adds a header to the document. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Return
HeaderSection
: Der Dokumentheader.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addNamedRange(name, range)
Fügt ein NamedRange
hinzu. Dabei handelt es sich um eine Range
mit einem Namen und einer ID, die für den späteren Abruf verwendet werden soll. Namen sind nicht unbedingt eindeutig. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML. Nachdem Sie einem Dokument eine NamedRange
hinzugefügt haben, können Sie sie nicht mehr ändern, sondern nur wieder entfernen.
Jedes Skript, das auf das Dokument zugreift, kann auf NamedRange
zugreifen. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String als Präfix hinzufügen.
// Creates a named range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.addNamedRange('Document tables', rangeBuilder.build());
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | Der Name für den Bereich. Er muss nicht eindeutig sein. Bereichsnamen müssen zwischen 1 und 256 Zeichen lang sein. |
range | Range | Der Elementbereich, der mit dem Namen verknüpft werden soll. Der Bereich kann die aktive Auswahl, ein Suchergebnis oder manuell mit newRange() erstellt werden. |
Return
NamedRange
: Die NamedRange
.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(emailAddress)
Fügt den angegebenen Nutzer der Liste der Betrachter für Document
hinzu. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befand, hat diese Methode keine Auswirkungen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der hinzugefügt werden soll. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewer(user)
Fügt den angegebenen Nutzer der Liste der Betrachter für Document
hinzu. Wenn sich der Nutzer bereits in der Liste der Bearbeiter befand, hat diese Methode keine Auswirkungen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des hinzuzufügenden Nutzers. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addViewers(emailAddresses)
Fügt das angegebene Array von Nutzern der Liste der Betrachter für Document
hinzu. Wenn sich Nutzer bereits in der Liste der Bearbeiter befanden, hat diese Methode keine Auswirkungen auf sie.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddresses | String[] | Ein Array mit E-Mail-Adressen der hinzuzufügenden Nutzer. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAs(contentType)
Ruft den aktuellen Document
-Inhalt als Blob des angegebenen Typs ab.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
Parameter
Name | Typ | Beschreibung |
---|---|---|
contentType | String | Der MIME-Typ, in den konvertiert werden soll. Derzeit wird nur 'application/pdf' unterstützt. |
Return
Blob
: Das aktuelle Dokument als Blob.
getBlob()
Ruft den aktuellen Inhalt von Document
als Blob ab.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Return
Blob
: Das aktuelle Dokument als Blob.
getBody()
Ruft den Body
des aktiven Dokuments ab.
Dokumente können unterschiedliche Arten von Abschnitten enthalten (z.B. HeaderSection
, FooterSection
). Der aktive Bereich für ein Dokument ist Body
.
Elementmethoden in Document
delegieren an das aktive Body
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Return
Body
: Der aktive Dokumenttextabschnitt.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmark(id)
Ruft das Bookmark
mit der angegebenen ID ab. Diese Methode gibt null
zurück, wenn keine solche Bookmark
vorhanden ist.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the bookmark by its ID. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the console. // otherwise, logs 'No bookmark exists with the given ID.' to the console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | Die ID für Bookmark . |
Return
Bookmark
– Die Bookmark
mit der angegebenen ID oder null
, wenn keine solche Bookmark
vorhanden ist.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBookmarks()
Ruft alle Bookmark
-Objekte im Dokument ab.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById('abc123456'); // Gets all of the bookmarks in the document. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the document to the console. console.log(bookmarks.length);
Return
Bookmark[]
: Ein Array der Bookmark
-Objekte im Dokument.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCursor()
Ruft den Cursor des Nutzers im aktiven Dokument ab. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und auch nur dann, wenn das Skript an das Dokument gebunden ist.
// Insert some text at the cursor position and make it bold. var cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's // containing element doesn't allow insertions, so show the user an error message. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Return
Position
: Darstellung des Nutzercursors oder null
, wenn der Nutzer keinen Cursor im Dokument platziert oder das Skript nicht an das Dokument gebunden ist.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEditors()
Ruft die Liste der Bearbeiter für diesen Document
ab.
Return
User[]
: Ein Array von Nutzern mit Bearbeitungsberechtigung.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getFootnotes()
Ruft alle Footnote
-Elemente im Dokumenttext ab.
Aufrufe von getFootnotes
lösen eine Iteration der Elemente des Dokuments aus. Vermeiden Sie bei großen Dokumenten unnötige Aufrufe dieser Methode.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the first footnote. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Return
Footnote[]
: die Dokumentfußnoten.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeader()
Ruft den Header-Abschnitt des Dokuments ab, sofern vorhanden.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the text of the document's header and logs it to the console. console.log(doc.getHeader().getText());
Return
HeaderSection
: Der Dokumentheader.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getId()
Ruft die eindeutige ID des Dokuments ab. Die Dokument-ID wird mit DocumentApp.openById()
verwendet, um eine bestimmte Dokumentinstanz zu öffnen.
Return
String
: die ID des Dokuments
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLanguage()
Ruft den Sprachcode des Dokuments ab. Das ist die Sprache, die im Dokumenteditor unter Datei > Sprache angezeigt wird. Sie entspricht möglicherweise nicht der Sprache, die das Dokument enthält.
Return
String
: Die Dokumentsprache oder null
, falls nicht definiert.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
Ruft den Titel des Dokuments ab.
Return
String
: der Dokumenttitel
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRangeById(id)
Ruft das NamedRange
mit der angegebenen ID ab. Diese Methode gibt null
zurück, wenn keine solche NamedRange
vorhanden ist. Namen sind nicht unbedingt eindeutig. Mehrere verschiedene Bereiche im selben Dokument können den gleichen Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML.
Parameter
Name | Typ | Beschreibung |
---|---|---|
id | String | Die Bereichs-ID, die innerhalb des Dokuments eindeutig ist |
Return
NamedRange
: NamedRange
mit der angegebenen ID oder null
, wenn kein solcher Bereich vorhanden ist
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges()
Ruft alle NamedRange
-Objekte im Dokument ab.
Ein NamedRange
kann von jedem Skript aufgerufen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String als Präfix hinzufügen.
Return
NamedRange[]
: ein Array der NamedRange
-Objekte im Dokument, das möglicherweise mehrere Bereiche mit demselben Namen enthält
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNamedRanges(name)
Ruft alle NamedRange
-Objekte im Dokument mit dem angegebenen Namen ab. Namen sind nicht unbedingt eindeutig. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML.
Ein NamedRange
kann von jedem Skript aufgerufen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen einen eindeutigen String als Präfix hinzufügen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | den Namen des Bereichs, der nicht unbedingt eindeutig ist. |
Return
NamedRange[]
: ein Array der NamedRange
-Objekte im Dokument mit dem angegebenen Namen
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSelection()
Ruft die Auswahl des Nutzers im aktiven Dokument ab. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen, der das Skript ausführt, und auch nur dann, wenn das Skript an das Dokument gebunden ist.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var elements = selection.getRangeElements(); DocumentApp.getUi().alert('Number of selected elements: ' + elements.length); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
Return
Range
– Eine Darstellung der Nutzerauswahl oder null
, wenn der Nutzer nichts im Dokument ausgewählt hat, wenn nur das Ende eines Absatzes ausgewählt ist, nur das Ende eines Absatzes und eine neue Zeile ausgewählt sind oder das Skript nicht an das Dokument gebunden ist.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSupportedLanguageCodes()
Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.
Return
String[]
: Ein Array von Sprachcodes.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getUrl()
Ruft die URL für den Zugriff auf das aktuelle Dokument ab.
var doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
Return
String
: die URL für den Zugriff auf das aktuelle Dokument
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getViewers()
Liste der Betrachter und Kommentatoren für diesen Document
abrufen
Return
User[]
: ein Array von Nutzern mit Lese- oder Kommentarberechtigung.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newPosition(element, offset)
Erstellt einen neuen Position
, der einen Verweis auf eine Stelle im Dokument ist, relativ zu einem bestimmten Element. Der Cursor des Nutzers wird unter anderem als Position
dargestellt.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parameter
Name | Typ | Beschreibung |
---|---|---|
element | Element | das Element, das das neue Position -Element enthalten wird. Dies muss entweder ein Text -Element oder ein Containerelement wie Paragraph sein. |
offset | Integer | Bei Text -Elementen die Anzahl der Zeichen vor dem Position ; bei anderen Elementen die Anzahl der untergeordneten Elemente vor dem Position innerhalb desselben Containerelements |
Return
Position
– das neue Position
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
newRange()
Erstellt einen Builder, mit dem Range
-Objekte aus Dokumentelementen erstellt werden.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Return
RangeBuilder
– der neue Builder
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document
. Diese Methode verhindert nicht, dass Nutzer auf Document
zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinen Zugriff gehören. Das ist z. B. der Fall, wenn Document
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer auch aus der Liste der Viewer entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der entfernt werden soll. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeEditor(user)
Entfernt den angegebenen Nutzer aus der Liste der Bearbeiter für Document
. Diese Methode verhindert nicht, dass Nutzer auf Document
zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinen Zugriff gehören. Das ist z. B. der Fall, wenn Document
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer auch aus der Liste der Viewer entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des Nutzers, der entfernt werden soll. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(emailAddress)
Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Document
. Diese Methode hat keine Auswirkungen, wenn der Nutzer Bearbeiter und kein Betrachter oder Kommentator ist. Außerdem wird durch diese Methode nicht verhindert, dass Nutzer auf Document
zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn die Document
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer auch aus der Liste der Bearbeiter entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
emailAddress | String | Die E-Mail-Adresse des Nutzers, der entfernt werden soll. |
Return
Document
: Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeViewer(user)
Entfernt den angegebenen Nutzer aus der Liste der Betrachter und Kommentatoren für Document
. Diese Methode hat keine Auswirkungen, wenn der Nutzer Bearbeiter und kein Betrachter ist. Außerdem verhindert diese Methode nicht, dass Nutzer auf Document
zugreifen, wenn sie zu einer Klasse von Nutzern mit allgemeinem Zugriff gehören, z. B. wenn Document
für die gesamte Domain des Nutzers freigegeben ist oder wenn sich Document
in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.
Bei Drive-Dateien wird der Nutzer auch aus der Liste der Bearbeiter entfernt.
Parameter
Name | Typ | Beschreibung |
---|---|---|
user | User | Eine Darstellung des Nutzers, der entfernt werden soll. |
Return
Document
: Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
saveAndClose()
Speichert den aktuellen Document
. Führt dazu, dass ausstehende Aktualisierungen geleert und angewendet werden.
Die Methode saveAndClose()
wird am Ende der Skriptausführung für jeden offenen bearbeitbaren Document
automatisch aufgerufen.
Ein geschlossenes Document
-Objekt kann nicht bearbeitet werden. Verwenden Sie DocumentApp.openById()
, um ein bestimmtes Dokument zur Bearbeitung noch einmal zu öffnen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setCursor(position)
Legt den Cursor des Nutzers im aktiven Dokument mit Position
fest. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und auch nur dann, wenn das Skript an das Dokument gebunden ist.
// Append a paragraph, then place the user's cursor after the first word of the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parameter
Name | Typ | Beschreibung |
---|---|---|
position | Position | die neue Cursorposition |
Return
Document
– dieses Document
für Verkettung
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLanguage(languageCode)
Legt den Sprachcode des Dokuments fest. Das ist die Sprache, die im Dokumenteditor unter Datei > Sprache angezeigt wird. Sie entspricht möglicherweise nicht der Sprache, die das Dokument enthält. Verwenden Sie getSupportedLanguageCodes()
, um alle gültigen Sprachcodes abzurufen.
Parameter
Name | Typ | Beschreibung |
---|---|---|
languageCode | String | Der Sprachcode. |
Return
Document
: Dieses Document
für Verkettungen.
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setName(name)
Legt den Dokumenttitel fest.
Parameter
Name | Typ | Beschreibung |
---|---|---|
name | String | der neue Dokumenttitel |
Return
Document
– das aktuelle Dokument
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSelection(range)
Legt die Auswahl des Nutzers im aktiven Dokument anhand eines Range
fest. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen, der das Skript ausführt, und nur dann, wenn das Skript an das Dokument gebunden ist.
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Parameter
Name | Typ | Beschreibung |
---|---|---|
range | Range | den neuen Elementbereich, |
Return
Document
– dieses Document
für Verkettung
Autorisierung
Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents