Class Document

Fügt dem ersten Tab oder, bei Skripts, die an ein Dokument gebunden sind, dem aktiven Tab ein Bookmark an der angegebenen Position hinzu. Mit der Methode DocumentTab.addBookmark(position) können Sie jedem Tab ein Lesezeichen hinzufügen.

// 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('123abc');

// Gets the active or first tab's 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

Rückflug

Bookmark: Das neue Lesezeichen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. Wenn der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste entfernt.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt den angegebenen Nutzer der Liste der Bearbeiter für Document hinzu. Wenn der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste entfernt.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt das angegebene Nutzer-Array der Liste der Bearbeiter für Document hinzu. Wenn einer der Nutzer bereits in der Liste der Zuschauer war, wird er durch diese Methode aus der Liste der Zuschauer entfernt.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Fußzeilenbereich hinzu, sofern noch keiner vorhanden ist. Mit der Methode DocumentTab.addFooter() können Sie jedem Tab einen Footerbereich hinzufügen.

// 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('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Rückflug

FooterSection: Die Tab-Fußzeile.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Headerbereich hinzu, sofern noch keiner vorhanden ist. Verwenden Sie die Methode DocumentTab.addHeader(), um einem beliebigen Tab einen Header hinzuzufügen.

// 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('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Rückflug

HeaderSection: Die Tab-Überschrift.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ein NamedRange ein, das ein Range mit einem Namen und einer ID ist, die für den späteren Abruf verwendet werden können. Verwenden Sie die Methode DocumentTab.addNamedRange(name, range), um in einem beliebigen Tab ein NamedRange hinzuzufügen. Namen sind nicht unbedingt eindeutig. Mehrere Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Dokuments eindeutig, wie eine ID in HTML. Nachdem Sie einem Dokument eine NamedRange hinzugefügt haben, können Sie sie nicht mehr ändern, sondern nur entfernen.

Jedes Script, das auf das Dokument zugreift, kann auf ein NamedRange zugreifen. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen ein eindeutiges Präfix voranstellen.

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

Parameter

Rückflug

NamedRange – Die NamedRange.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt den angegebenen Nutzer der Liste der Zuschauer für Document hinzu. Wenn der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt den angegebenen Nutzer der Liste der Zuschauer für Document hinzu. Wenn der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Fügt das angegebene Nutzer-Array der Liste der Betrachter für Document hinzu. Wenn einer der Nutzer bereits in der Liste der Bearbeiter enthalten war, hat diese Methode keine Auswirkungen auf ihn.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft die aktuell aktive Tab des Nutzers im Dokument ab. Ein Skript kann nur auf den aktiven Tab des Nutzers zugreifen, der das Skript ausführt, und nur, wenn das Skript an das Dokument gebunden ist.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

Rückflug

Tab: Die aktuell aktive Tab des Nutzers oder null, wenn das Skript nicht an das Dokument gebunden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft den aktuellen Inhalt von Document 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('123abc');

// 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

Rückflug

Blob: Das aktuelle Dokument als Blob.

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('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

Rückflug

Blob: Das aktuelle Dokument als Blob.

Ruft die Body des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, die DocumentBodySection des aktiven Tabs ab. Mit der Methode DocumentTab.getBody() können Sie die DocumentBodySection eines beliebigen Tabs abrufen.

Tabs können verschiedene Arten von Abschnitten enthalten, z. B. HeaderSection und FooterSection. Der aktive Abschnitt für einen Tab ist der Body.

Elementmethoden in Document werden an das aktive Body delegiert.

// 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('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Rückflug

Body: Der Bereich mit dem Tab-Inhalt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft das Bookmark mit der angegebenen ID auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab. Verwenden Sie die Methode DocumentTab.getBookmark(id), um ein Lesezeichen auf einem beliebigen Tab zu setzen. Diese Methode gibt null zurück, wenn es auf dem Tab kein Bookmark gibt.

// 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('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
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

Rückflug

Bookmark|null: Die Bookmark mit der angegebenen ID oder null, wenn keine solche Bookmark auf dem Tab vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft alle Bookmark-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab. Wenn Sie alle Lesezeichen auf einem beliebigen Tab abrufen möchten, verwenden Sie die Methode DocumentTab.getBookmarks().

// 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('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Rückflug

Bookmark[]: Ein Array der Bookmark-Objekte auf dem Tab.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft den Cursor des Nutzers auf dem aktiven Tab ab. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und nur, wenn das Skript an das Dokument gebunden ist.

// Insert some text at the cursor position and make it bold.
const 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.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Rückflug

Position|null: Eine Darstellung des Cursors des Nutzers oder null, wenn der Nutzer keinen Cursor auf dem Tab platziert hat oder das Script nicht an das Dokument gebunden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft die Liste der Mitbearbeiter für diese Document ab.

Rückflug

User[]: Ein Array von Nutzern mit Bearbeitungsberechtigung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft den Fußzeilenbereich des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, den Fußzeilenbereich des aktiven Tabs ab. Wenn Sie den Fußbereich eines beliebigen Tabs abrufen möchten, verwenden Sie die Methode DocumentTab.getFooter().

// 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('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

Rückflug

FooterSection|null: Die Fußzeile des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft alle Footnote-Elemente im Textkörper des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, im Textkörper des aktiven Tabs ab. Wenn Sie alle Fußnoten auf einem Tab abrufen möchten, verwenden Sie die Methode DocumentTab.getFootnotes().

Bei Aufrufen von getFootnotes wird eine Iteration über die Elemente des Tabs ausgeführt. Bei großen Tabs sollten Sie unnötige Aufrufe dieser Methode vermeiden.

// 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('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Rückflug

Footnote[]|null: Die Fußnoten des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft den Header-Abschnitt des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, den Header-Abschnitt des aktiven Tabs ab. Verwenden Sie die Methode DocumentTab.getHeader(), um den Headerbereich eines beliebigen Tabs abzurufen.

// 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('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

Rückflug

HeaderSection|null: Der Header des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft die eindeutige Kennung des Dokuments ab. Die Dokument-ID wird mit DocumentApp.openById() verwendet, um eine bestimmte Dokumentinstanz zu öffnen.

Rückflug

String: Die ID des Dokuments.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft den Sprachcode des Dokuments ab. Dies ist die Sprache, die im Dokumenteditor unter Datei > Sprache angezeigt wird. Sie entspricht möglicherweise nicht der tatsächlichen Sprache des Dokuments.

Rückflug

String: Die Dokumentsprache oder null, falls nicht definiert.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft den Titel des Dokuments ab.

Rückflug

String: Der Dokumenttitel.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft das NamedRange mit der angegebenen ID auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab. Verwenden Sie die Methode DocumentTab.getNamedRangeById(id), um die NamedRange mit der angegebenen ID auf einem beliebigen Tab abzurufen. Diese Methode gibt null zurück, wenn es auf dem Tab keine solche NamedRange gibt. Namen sind nicht unbedingt eindeutig, auch nicht über Tabs hinweg. Mehrere Bereiche auf demselben Tab können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, wie eine ID in HTML.

Parameter

Rückflug

NamedRange|null: Der NamedRange mit der angegebenen ID oder null, wenn es keinen solchen Bereich auf dem Tab gibt.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft alle NamedRange-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab. Mit der Methode DocumentTab.getNamedRanges() können Sie alle NamedRange-Objekte auf einem beliebigen Tab abrufen.

Auf eine NamedRange kann von jedem Skript zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen ein eindeutiges Präfix voranstellen.

Rückflug

NamedRange[]: Ein Array der NamedRange-Objekte auf dem Tab, das möglicherweise mehrere Bereiche mit demselben Namen enthält.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft alle NamedRange-Objekte mit dem angegebenen Namen auf dem ersten Tab oder, bei Skripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ab. Wenn Sie alle NamedRange-Objekte auf einem beliebigen Tab abrufen möchten, verwenden Sie die Methode DocumentTab.getNamedRanges(name). Namen sind nicht unbedingt eindeutig, auch nicht über Tabs hinweg. Mehrere Bereiche auf demselben Tab können denselben Namen haben, ähnlich wie eine Klasse in HTML. Im Gegensatz dazu sind IDs innerhalb des Tabs eindeutig, wie eine ID in HTML.

Auf eine NamedRange kann von jedem Skript zugegriffen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Skripts zu vermeiden, sollten Sie Bereichsnamen ein eindeutiges Präfix voranstellen.

Parameter

Rückflug

NamedRange[]: Ein Array der NamedRange-Objekte auf dem Tab mit dem angegebenen Namen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft die Auswahl des Nutzers auf dem aktiven Tab ab. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen, der das Skript ausführt, und nur, wenn das Skript an das Dokument gebunden ist.

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Rückflug

Range|null: Eine Darstellung der Auswahl des Nutzers oder null, wenn der Nutzer auf dem Tab nichts ausgewählt hat, wenn nur das Ende eines Absatzes ausgewählt ist, wenn nur das Ende eines Absatzes und eine neue Zeile ausgewählt sind oder wenn das Skript nicht an das Dokument gebunden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft alle Sprachcodes ab, die in Google Docs-Dateien unterstützt werden.

Rückflug

String[] – Ein Array von Sprachcodes.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft das Tab mit der angegebenen ID ab. Diese Methode gibt null zurück, wenn keine solche Tab vorhanden ist. Kann auf Tabs auf jeder Verschachtelungsebene zugreifen.

Parameter

Rückflug

Tab: Das Tab mit der angegebenen ID oder null, wenn kein solches Tab vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft alle nicht verschachtelten Tab-Elemente ab, die Teil des Dokuments sind.

Tabs können untergeordnete Tabs enthalten, d. h. einen Tab, der in einem anderen Tab verschachtelt ist. Untergeordnete Tabs sind über Tab.getChildTabs() zugänglich.

Rückflug

Tab[]: Die Liste aller Tabs, die Teil des Dokuments sind.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft die URL für den Zugriff auf das aktuelle Dokument ab.

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

Rückflug

String: Die URL für den Zugriff auf das aktuelle Dokument.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Ruft die Liste der Betrachter und Kommentatoren für diese Document ab.

Rückflug

User[]: Ein Array von Nutzern mit Berechtigungen zum Anzeigen oder Kommentieren.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Erstellt eine neue Position, die sich auf eine Position auf dem Tab bezieht, relativ zu einem bestimmten Element auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab. Wenn Sie ein Position relativ zu einem Standort auf einem beliebigen Tab erstellen möchten, verwenden Sie die Methode DocumentTab.newPosition(element, offset). Der Cursor des Nutzers wird unter anderem als Position dargestellt.

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

Rückflug

Position – Die neue Position.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Erstellt einen Builder, mit dem Range-Objekte aus Tab-Elementen auf dem ersten Tab oder, bei Skripts, die an ein Dokument gebunden sind, auf dem aktiven Tab erstellt werden. Verwenden Sie die Methode DocumentTab.newRange(), um einen Builder zu erstellen, mit dem DocumentRange-Objekte aus Tab-Elementen auf einem beliebigen Tab erstellt werden.

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Rückflug

RangeBuilder – Der neue Builder.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Document. Mit dieser Methode wird der Zugriff von Nutzern auf die Document nicht blockiert, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder sich die Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Betrachter entfernt.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Entfernt den angegebenen Nutzer aus der Liste der Mitbearbeiter für die Document. Mit dieser Methode wird der Zugriff von Nutzern auf die Document nicht blockiert, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder sich die Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Betrachter entfernt.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Entfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Document. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter oder Kommentator ist. Mit dieser Methode wird auch nicht verhindert, dass Nutzer auf die Document zugreifen, wenn sie zu einer Nutzergruppe gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder wenn sich die Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Mitbearbeiter entfernt.

Parameter

Rückflug

Document – Diese Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Entfernt den angegebenen Nutzer aus der Liste der Zuschauer und Kommentatoren für die Document. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Bearbeiter und kein Betrachter ist. Mit dieser Methode wird auch nicht verhindert, dass Nutzer auf die Document zugreifen, wenn sie zu einer Nutzerklasse gehören, die allgemeinen Zugriff hat. Das ist beispielsweise der Fall, wenn die Document für die gesamte Domain des Nutzers freigegeben ist oder wenn sich die Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.

Bei Drive-Dateien wird der Nutzer dadurch auch aus der Liste der Mitbearbeiter entfernt.

Parameter

Rückflug

Document – Diese Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Speichert die aktuelle Document. Bewirkt, dass ausstehende Updates verworfen und angewendet werden.

Die Methode saveAndClose() wird am Ende der Skriptausführung automatisch für jedes offene bearbeitbare Document aufgerufen.

Ein geschlossenes Document kann nicht bearbeitet werden. Mit DocumentApp.openById() können Sie ein bestimmtes Dokument zum Bearbeiten wieder öffnen.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Legt die ausgewählte Tab des Nutzers im aktuellen Dokument auf den Tab mit der angegebenen ID fest.

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

Parameter

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Legt den Cursor des Nutzers anhand eines Position fest. Ein Skript kann nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und nur, wenn das Skript an das Dokument gebunden ist.

Wenn Sie eine Position von einem inaktiven Tab bereitstellen, wird der aktive Tab des Nutzers gewechselt.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Legt den Sprachcode des Dokuments fest. Dies ist die Sprache, die im Dokumenteditor unter Datei > Sprache angezeigt wird. Sie entspricht möglicherweise nicht der tatsächlichen Sprache des Dokuments. Verwenden Sie getSupportedLanguageCodes(), um alle gültigen Sprachcodes abzurufen.

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Legt den Dokumenttitel fest.

Parameter

Rückflug

Document: Das aktuelle Dokument.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

Legt die Auswahl des Nutzers auf dem aktiven Tab fest, wenn ein Range angegeben ist. Ein Skript kann nur auf die Auswahl des Nutzers zugreifen, der das Skript ausführt, und nur, wenn das Skript an das Dokument gebunden ist.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Parameter

Rückflug

Document – Diese Document zur Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, benötigen eine Autorisierung für mindestens einen der folgenden Zugriffsbereiche:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents