Diese Seite wurde von der Cloud Translation API übersetzt.

Class Document

Ein Dokument mit einem oder mehreren Tab-Objekten, die jeweils einen erweiterten Text und Elemente wie Tabellen und Listen enthalten.

Dokumente können mit DocumentApp geöffnet oder erstellt werden.

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

// Create and open a document.
doc = DocumentApp.create('Document Title');

Methoden der Klasse Document, die direkt auf Textinhalte zugreifen und sie ändern, werden entweder auf dem aktiven Tab (in Scripts, die an ein bestimmtes Dokument gebunden sind) oder auf dem ersten Tab ausgeführt, falls kein aktiver Tab verfügbar ist. Scripts, die auf diesen Methoden basieren (z. B. getBody()), können so migriert werden, dass sie Tabs mit getTabs() und dann Tab.asDocumentTab() unterstützen.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
`addBookmark(position)`	`Bookmark`	Fügen Sie dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab eine `Bookmark` an der angegebenen `Position` hinzu.
`addEditor(emailAddress)`	`Document`	Der angegebene Nutzer wird der Liste der Mitbearbeiter für die `Document` hinzugefügt.
`addEditor(user)`	`Document`	Der angegebene Nutzer wird der Liste der Mitbearbeiter für die `Document` hinzugefügt.
`addEditors(emailAddresses)`	`Document`	Fügt der Liste der Mitbearbeiter für die `Document` das angegebene Nutzerarray hinzu.
`addFooter()`	`FooterSection`	Fügen Sie dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Fußzeilenbereich hinzu, falls noch keiner vorhanden ist.
`addHeader()`	`HeaderSection`	Fügen Sie dem ersten Tab einen Headerabschnitt hinzu, falls noch keiner vorhanden ist, oder dem aktiven Tab, wenn das Script an ein Dokument gebunden ist.
`addNamedRange(name, range)`	`NamedRange`	Fügen Sie auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ein `NamedRange` hinzu. Das ist ein `Range` mit einem Namen und einer ID, die für die spätere Abrufung verwendet werden.
`addViewer(emailAddress)`	`Document`	Der angegebene Nutzer wird der Liste der Zuschauer für die `Document` hinzugefügt.
`addViewer(user)`	`Document`	Der angegebene Nutzer wird der Liste der Zuschauer für die `Document` hinzugefügt.
`addViewers(emailAddresses)`	`Document`	Fügen Sie der Liste der Zuschauer für die `Document` das angegebene Array von Nutzern hinzu.
`getActiveTab()`	`Tab`	Ruft die aktuell aktive `Tab` des Nutzers im Dokument ab.
`getAs(contentType)`	`Blob`	Ruft den aktuellen `Document`-Inhalt als Blob des angegebenen Typs ab.
`getBlob()`	`Blob`	Ruft den aktuellen `Document`-Inhalt als Blob ab.
`getBody()`	`Body`	Ruft die `Body` des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, die `DocumentBodySection` des aktiven Tabs ab.
`getBookmark(id)`	`Bookmark`	Ruft das `Bookmark` mit der angegebenen ID auf dem ersten Tab ab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab.
`getBookmarks()`	`Bookmark[]`	Hiermit werden alle `Bookmark`-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen.
`getCursor()`	`Position`	Ruft den Cursor des Nutzers auf dem aktiven Tab ab.
`getEditors()`	`User[]`	Ruft die Liste der Mitbearbeiter für diese `Document` ab.
`getFooter()`	`FooterSection`	Ruft den Abschnitt „Fußzeile“ des ersten Tabs ab oder, bei Scripts, die an ein Dokument gebunden sind, den Abschnitt „Fußzeile“ des aktiven Tabs.
`getFootnotes()`	`Footnote[]`	Ruft alle `Footnote`-Elemente im Body des ersten Tabs oder, bei Scripts, die an ein Dokument gebunden sind, den Body des aktiven Tabs ab.
`getHeader()`	`HeaderSection`	Ruft den Kopfbereich des ersten Tabs ab oder, bei Scripts, die an ein Dokument gebunden sind, den Kopfbereich des aktiven Tabs.
`getId()`	`String`	Ruft die eindeutige Kennung 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 auf dem ersten Tab ab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab.
`getNamedRanges()`	`NamedRange[]`	Hiermit werden alle `NamedRange`-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen.
`getNamedRanges(name)`	`NamedRange[]`	Hiermit werden alle `NamedRange`-Objekte mit dem angegebenen Namen auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen.
`getSelection()`	`Range`	Ruft die Auswahl des Nutzers auf dem aktiven Tab ab.
`getSupportedLanguageCodes()`	`String[]`	Alle Sprachcodes abrufen, die in Google Docs-Dateien unterstützt werden
`getTab(tabId)`	`Tab`	Ruft den `Tab` mit der angegebenen ID ab.
`getTabs()`	`Tab[]`	Alle nicht verschachtelten `Tab`s abrufen, die Teil des Dokuments sind
`getUrl()`	`String`	Ruft die URL für den Zugriff auf das aktuelle Dokument ab.
`getViewers()`	`User[]`	Ruft die Liste der Betrachter und Kommentatoren für diese `Document` ab.
`newPosition(element, offset)`	`Position`	Erstellt eine neue `Position`, die einen Verweis auf eine Position auf dem Tab relativ zu einem bestimmten Element auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf den aktiven Tab darstellt.
`newRange()`	`RangeBuilder`	Erstellt einen Builder, mit dem `Range`-Objekte aus Tabelementen auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab erstellt werden.
`removeEditor(emailAddress)`	`Document`	Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der `Document` entfernt.
`removeEditor(user)`	`Document`	Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der `Document` entfernt.
`removeViewer(emailAddress)`	`Document`	Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die `Document` entfernt.
`removeViewer(user)`	`Document`	Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die `Document` entfernt.
`saveAndClose()`	`void`	Speichert die aktuelle `Document`.
`setActiveTab(tabId)`	`void`	Stellt die ausgewählte `Tab` des Nutzers im aktuellen Dokument auf den Tab mit der angegebenen ID.
`setCursor(position)`	`Document`	Legt den Cursor des Nutzers anhand einer `Position` fest.
`setLanguage(languageCode)`	`Document`	Legt den Sprachcode des Dokuments fest.
`setName(name)`	`Document`	Hiermit wird der Dokumenttitel festgelegt.
`setSelection(range)`	`Document`	Legt die Auswahl des Nutzers auf dem Tab „Aktiv“ fest, wenn `Range` angegeben ist.

Detaillierte Dokumentation

`addBookmark(position)`

Fügen Sie dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab eine Bookmark an der angegebenen Position hinzu. Verwenden Sie die Methode DocumentTab.addBookmark(position), um einem Tab ein Lesezeichen 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');

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

Name	Typ	Beschreibung
`position`	`Position`	Die Position des neuen Lesezeichens.

Rückflug

Bookmark – das neue Lesezeichen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addEditor(emailAddress)`

Der angegebene Nutzer wird der Liste der Mitbearbeiter für die Document hinzugefügt. Wenn der Nutzer bereits auf der Liste der Zuschauer stand, wird er durch diese Methode aus der Liste entfernt.

Parameter

Name	Typ	Beschreibung
`emailAddress`	`String`	Die E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addEditor(user)`

Der angegebene Nutzer wird der Liste der Mitbearbeiter für die Document hinzugefügt. Wenn der Nutzer bereits auf der Liste der Zuschauer stand, wird er durch diese Methode aus der Liste entfernt.

Parameter

Name	Typ	Beschreibung
`user`	`User`	Eine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addEditors(emailAddresses)`

Fügt der Liste der Mitbearbeiter für die Document das angegebene Nutzerarray hinzu. Wenn sich einer der Nutzer bereits in der Liste der Zuschauer befand, wird er durch diese Methode aus der Liste entfernt.

Parameter

Name	Typ	Beschreibung
`emailAddresses`	`String[]`	Ein Array mit den E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addFooter()`

Fügen Sie dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, dem aktiven Tab einen Fußzeilenbereich hinzu, falls noch keiner vorhanden ist. Verwenden Sie die Methode DocumentTab.addFooter(), um einem Tab einen Fußzeilenbereich 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 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: Tab-Fußzeile

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addHeader()`

Fügen Sie dem ersten Tab einen Headerabschnitt hinzu, falls noch keiner vorhanden ist, oder dem aktiven Tab, wenn das Script an ein Dokument gebunden ist. Verwenden Sie die Methode DocumentTab.addHeader(), um einem Tab einen Kopfzeilenbereich 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: Tab-Überschrift.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addNamedRange(name, range)`

Fügen Sie auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab ein NamedRange hinzu. Das ist ein Range mit einem Namen und einer ID, die für die spätere Abrufung verwendet werden. Wenn Sie auf einem beliebigen Tab ein NamedRange hinzufügen möchten, verwenden Sie die Methode DocumentTab.addNamedRange(name, range). Namen müssen nicht eindeutig sein. Mehrere verschiedene Bereiche im selben Dokument können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Dokuments eindeutig, ähnlich wie eine ID in HTML. Nachdem Sie einem Dokument ein NamedRange hinzugefügt haben, können Sie es nicht mehr ändern, sondern nur noch entfernen.

Jedes Script, das auf das Dokument zugreift, kann auf eine NamedRange zugreifen. Um unbeabsichtigte Konflikte zwischen Scripts zu vermeiden, sollten Sie den 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

Name	Typ	Beschreibung
`name`	`String`	Der Name des Bereichs, der nicht eindeutig sein muss. Bereichsnamen müssen zwischen 1 und 256 Zeichen lang sein.
`range`	`Range`	Der Bereich der Elemente, die mit dem Namen verknüpft werden sollen. Der Bereich kann die aktive Auswahl, ein Suchergebnis oder manuell mit `newRange()` erstellt werden.

Rückflug

NamedRange – Der NamedRange.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addViewer(emailAddress)`

Der angegebene Nutzer wird der Liste der Zuschauer für die Document hinzugefügt. Wenn der Nutzer bereits in der Liste der Mitbearbeiter aufgeführt war, hat diese Methode keine Auswirkungen.

Parameter

Name	Typ	Beschreibung
`emailAddress`	`String`	Die E-Mail-Adresse des Nutzers, den Sie hinzufügen möchten.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addViewer(user)`

Der angegebene Nutzer wird der Liste der Zuschauer für die Document hinzugefügt. Wenn der Nutzer bereits in der Liste der Mitbearbeiter aufgeführt war, hat diese Methode keine Auswirkungen.

Parameter

Name	Typ	Beschreibung
`user`	`User`	Eine Darstellung des hinzuzufügenden Nutzers.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`addViewers(emailAddresses)`

Fügen Sie der Liste der Zuschauer für die Document das angegebene Array von Nutzern hinzu. Wenn einer der Nutzer bereits in der Liste der Mitbearbeiter aufgeführt war, hat diese Methode keine Auswirkungen auf ihn.

Parameter

Name	Typ	Beschreibung
`emailAddresses`	`String[]`	Ein Array mit den E-Mail-Adressen der Nutzer, die hinzugefügt werden sollen.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getActiveTab()`

Ruft die aktuell aktive Tab des Nutzers im Dokument ab. Ein Script kann nur auf den aktiven Tab des Nutzers zugreifen, der das Script ausführt, und nur dann, wenn das Script 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: Der aktuell aktive Tab des Nutzers oder null, wenn das Script nicht an das Dokument gebunden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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('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

Name	Typ	Beschreibung
`contentType`	`String`	Der MIME-Typ, in den konvertiert werden soll. `'application/pdf'` und `'text/markdown'` werden unterstützt.

Rückflug

Blob – Das aktuelle Dokument als Blob.

`getBlob()`

Ruft den aktuellen Document-Inhalt 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.

`getBody()`

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, 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 Tab-Textbereich.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 auf dem ersten Tab ab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab. Wenn Sie ein Lesezeichen auf einem beliebigen Tab abrufen möchten, verwenden Sie die Methode DocumentTab.getBookmark(id). Diese Methode gibt null zurück, wenn auf dem Tab 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('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

Name	Typ	Beschreibung
`id`	`String`	Die ID der `Bookmark`.

Rückflug

Bookmark: Der Bookmark mit der angegebenen ID oder null, wenn auf dem Tab kein solcher Bookmark vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getBookmarks()`

Hiermit werden alle Bookmark-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen. 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getCursor()`

Ruft den Cursor des Nutzers auf dem aktiven Tab ab. Ein Script kann nur auf den Cursor des Nutzers zugreifen, der das Script ausführt, und nur dann, wenn das Script 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 – 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getEditors()`

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getFooter()`

Ruft den Abschnitt „Fußzeile“ des ersten Tabs ab oder, bei Scripts, die an ein Dokument gebunden sind, den Abschnitt „Fußzeile“ des aktiven Tabs. Wenn Sie den Abschnitt „Fußzeile“ eines 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: Fußzeile des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getFootnotes()`

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

Aufrufe von getFootnotes führen zu einer Iteration über die Elemente des Tabs. 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[]: Die Fußnoten des Tabs.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getHeader()`

Ruft den Kopfbereich des ersten Tabs ab oder, bei Scripts, die an ein Dokument gebunden sind, den Kopfbereich des aktiven Tabs. Verwenden Sie die Methode DocumentTab.getHeader(), um den Kopfbereich 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: Der Tab-Header.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getId()`

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, erfordern eine Autorisierung für einen oder mehrere 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 Dokumenteneditor unter Datei > Sprache angezeigt wird. Dies ist möglicherweise nicht die tatsächliche Sprache des Dokuments.

Rückflug

String: Die Sprache des Dokuments oder null, wenn nicht definiert.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getName()`

Ruft den Titel des Dokuments ab.

Rückflug

String: Der Dokumenttitel.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 auf dem ersten Tab ab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab. Wenn Sie die NamedRange mit der angegebenen ID auf einem beliebigen Tab abrufen möchten, verwenden Sie die Methode DocumentTab.getNamedRangeById(id). Diese Methode gibt null zurück, wenn auf dem Tab keine solche NamedRange vorhanden ist. Namen müssen nicht unbedingt eindeutig sein, auch nicht auf verschiedenen Tabs. Mehrere verschiedene Bereiche auf demselben Tab können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML.

Parameter

Name	Typ	Beschreibung
`id`	`String`	Die ID des Bereichs, die innerhalb des Tabs eindeutig ist.

Rückflug

NamedRange: Der NamedRange mit der angegebenen ID oder null, wenn auf dem Tab kein solcher Bereich vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getNamedRanges()`

Hiermit werden alle NamedRange-Objekte auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen. Wenn Sie alle NamedRange-Objekte auf einem beliebigen Tab abrufen möchten, verwenden Sie die Methode DocumentTab.getNamedRanges().

Auf eine NamedRange kann über jedes Script zugegriffen werden, das auf den Tab zugreift. Um unbeabsichtigte Konflikte zwischen Scripts zu vermeiden, sollten Sie Bereichsnamen mit einem eindeutigen String vorangestellt.

Rückflug

NamedRange[]: Ein Array der NamedRange-Objekte auf dem Tab, möglicherweise mit mehreren Bereichen mit demselben Namen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getNamedRanges(name)`

Hiermit werden alle NamedRange-Objekte mit dem angegebenen Namen auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf dem aktiven Tab abgerufen. Mit der Methode DocumentTab.getNamedRanges(name) können Sie alle NamedRange-Objekte auf einem beliebigen Tab abrufen. Namen müssen nicht unbedingt eindeutig sein, auch nicht auf verschiedenen Tabs. Mehrere verschiedene Bereiche auf demselben Tab können denselben Namen haben, ähnlich wie eine Klasse in HTML. IDs hingegen sind innerhalb des Tabs eindeutig, ähnlich wie eine ID in HTML.

Auf eine NamedRange kann über jedes Script zugegriffen werden, das auf das Dokument zugreift. Um unbeabsichtigte Konflikte zwischen Scripts zu vermeiden, sollten Sie Bereichsnamen mit einem eindeutigen String vorangestellt.

Parameter

Name	Typ	Beschreibung
`name`	`String`	Der Name des Bereichs, der nicht unbedingt eindeutig sein muss.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getSelection()`

Ruft die Auswahl des Nutzers auf dem aktiven Tab ab. Ein Script kann nur auf die Auswahl des Nutzers zugreifen, der das Script ausführt, und nur dann, wenn das Script 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 – Darstellung der Auswahl des Nutzers oder null, wenn der Nutzer auf dem Tab nichts ausgewählt hat, nur das Ende eines Absatzes oder nur das Ende eines Absatzes und eine neue Zeile ausgewählt hat oder das Script nicht an das Dokument gebunden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getSupportedLanguageCodes()`

Alle Sprachcodes abrufen, die in Google Docs-Dateien unterstützt werden

Rückflug

String[]: Ein Array von Sprachcodes.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getTab(tabId)`

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

Parameter

Name	Typ	Beschreibung
`tabId`	`String`	Die ID des zu erhaltenden Tabs.

Rückflug

Tab: Der Tab mit der angegebenen ID oder null, wenn kein solcher Tab vorhanden ist.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getTabs()`

Alle nicht verschachtelten Tabs abrufen, die Teil des Dokuments sind

Tabs können untergeordnete Tabs enthalten, also Tabs, die in einem anderen Tab verschachtelt sind. Untergeordnete Tabs können über Tab.getChildTabs() aufgerufen werden.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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.

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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`getViewers()`

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

Rückflug

User[]: Ein Array von Nutzern mit der Berechtigung zum Ansehen oder Kommentieren.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`newPosition(element, offset)`

Erstellt eine neue Position, die einen Verweis auf eine Position auf dem Tab relativ zu einem bestimmten Element auf dem ersten Tab oder, bei Scripts, die an ein Dokument gebunden sind, auf den aktiven Tab darstellt. Wenn Sie eine Position relativ zu einem Ort 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

Name	Typ	Beschreibung
`element`	`Element`	Das Element, das das neue `Position` enthalten soll. Dies muss entweder ein `Text`-Element oder ein Containerelement wie `Paragraph` sein.
`offset`	`Integer`	Bei `Text`-Elementen ist es die Anzahl der Zeichen vor dem `Position`. Bei anderen Elementen ist es die Anzahl der untergeordneten Elemente vor dem `Position` innerhalb desselben Containerelements.

Rückflug

Position – die neue Position.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 Tabelementen auf dem ersten Tab oder, bei Scripts, 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 Tabelementen 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`removeEditor(emailAddress)`

Der angegebene Nutzer wird aus der Liste der Mitbearbeiter der Document entfernt. Mit dieser Methode wird der Zugriff von Nutzern auf die Document nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. Das ist beispielsweise der Fall, wenn die Document für die gesamte Domain des Nutzers freigegeben wurde 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

Name	Typ	Beschreibung
`emailAddress`	`String`	Die E-Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`removeEditor(user)`

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

Parameter

Name	Typ	Beschreibung
`user`	`User`	Eine Darstellung des zu entfernenden Nutzers.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`removeViewer(emailAddress)`

Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Document entfernt. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Mitbearbeiter und kein Betrachter oder Kommentator ist. Außerdem wird mit dieser Methode der Zugriff von Nutzern auf die Document nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. Das ist beispielsweise der Fall, wenn die Document für die gesamte Domain des Nutzers freigegeben wurde oder sich die Document in einer geteilten Ablage befindet, auf die der Nutzer zugreifen kann.Document

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

Parameter

Name	Typ	Beschreibung
`emailAddress`	`String`	Die E-Mail-Adresse des Nutzers, der entfernt werden soll.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`removeViewer(user)`

Der angegebene Nutzer wird aus der Liste der Zuschauer und Kommentatoren für die Document entfernt. Diese Methode hat keine Auswirkungen, wenn der Nutzer ein Mitbearbeiter und kein Betrachter ist. Außerdem wird mit dieser Methode der Zugriff von Nutzern auf die Document nicht blockiert, wenn sie zu einer Gruppe von Nutzern mit allgemeinem Zugriff gehören. 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 auch aus der Liste der Mitbearbeiter entfernt.

Parameter

Name	Typ	Beschreibung
`user`	`User`	Eine Darstellung des zu entfernenden Nutzers.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`saveAndClose()`

Speichert die aktuelle Document. Dadurch werden ausstehende Updates gelöscht und angewendet.

Die Methode saveAndClose() wird am Ende der Scriptausführung automatisch für jede geöffnete bearbeitbare Document aufgerufen.

Eine geschlossene Document kann nicht bearbeitet werden. Mit DocumentApp.openById() können Sie ein bestimmtes Dokument zur Bearbeitung wieder öffnen.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`setActiveTab(tabId)`

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

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

Name	Typ	Beschreibung
`tabId`	`String`	Die ID des Tabs, der als aktiv festgelegt werden soll.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`setCursor(position)`

Legt den Cursor des Nutzers anhand einer Position fest. Ein Script kann nur auf den Cursor des Nutzers zugreifen, der das Script ausführt, und nur dann, wenn das Script mit dem Dokument verknüpft ist.

Wenn ein Nutzer eine Position von einer inaktiven Tab aus gibt, 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

Name	Typ	Beschreibung
`position`	`Position`	Die neue Cursorposition.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere 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 Dokumenteneditor unter Datei > Sprache angezeigt wird. Dies ist möglicherweise nicht die tatsächliche Sprache des Dokuments. Verwenden Sie getSupportedLanguageCodes(), um alle gültigen Sprachcodes abzurufen.

Parameter

Name	Typ	Beschreibung
`languageCode`	`String`	Der Sprachcode.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`setName(name)`

Hiermit wird der Dokumenttitel festgelegt.

Parameter

Name	Typ	Beschreibung
`name`	`String`	Der neue Dokumenttitel.

Rückflug

Document – das aktuelle Dokument.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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

`setSelection(range)`

Legt die Auswahl des Nutzers auf dem Tab „Aktiv“ fest, wenn Range angegeben ist. Ein Script kann nur auf die Auswahl des Nutzers zugreifen, der das Script ausführt, und nur dann, wenn das Script 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

Name	Typ	Beschreibung
`range`	`Range`	Der neue Bereich der Elemente, die ausgewählt werden sollen.

Rückflug

Document – Dieses Document für die Verkettung.

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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