Class DocumentApp

DocumentApp

Der Dokumentdienst erstellt und öffnet Documents, die bearbeitet werden können.

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

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

Attribute

Attribut	Typ	Beschreibung
Attribute	Attribute	Die Aufzählung Attribute.
ElementType	ElementType	Die Aufzählung ElementType.
FontFamily	FontFamily	Die Aufzählung FontFamily.
GlyphType	GlyphType	Die Aufzählung GlyphType.
HorizontalAlignment	HorizontalAlignment	Die Aufzählung HorizontalAlignment.
ParagraphHeading	ParagraphHeading	Die Aufzählung ParagraphHeading.
PositionedLayout	PositionedLayout	Die Aufzählung PositionedLayout.
TextAlignment	TextAlignment	Die Aufzählung TextAlignment.
VerticalAlignment	VerticalAlignment	Die Aufzählung VerticalAlignment.

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
create(name)	Document	Erstellt ein neues Dokument und gibt es zurück.
getActiveDocument()	Document	Gibt das Dokument zurück, an das das Script containergebunden ist.
getUi()	Ui	Gibt eine Instanz der Benutzeroberfläche des Dokuments zurück, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können.
openById(id)	Document	Gibt das Dokument mit der angegebenen ID zurück.
openByUrl(url)	Document	Öffnet das Dokument mit der angegebenen URL und gibt es zurück.

Detaillierte Dokumentation

create(name)

Erstellt ein neues Dokument und gibt es zurück.

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

Parameter

Name	Typ	Beschreibung
name	String	Der Name des neuen Dokuments.

Rückflug

Document: Die neue Dokumentinstanz.

Autorisierung

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

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

---

getActiveDocument()

Gibt das Dokument zurück, an das das Script containergebunden ist. Wenn Sie mit einem Dokument interagieren möchten, das nicht containergebunden ist, verwenden Sie stattdessen openById(id) oder openByUrl(url).

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

Rückflug

Document – die Dokumentinstanz

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

---

getUi()

Gibt eine Instanz der Benutzeroberfläche des Dokuments zurück, mit der dem Script Funktionen wie Menüs, Dialogfelder und Seitenleisten hinzugefügt werden können. Ein Script kann nur mit der Benutzeroberfläche der aktuellen Instanz eines geöffneten Dokuments interagieren und nur, wenn das Script an das Dokument gebunden ist. Weitere Informationen finden Sie in den Leitfäden zu Menüs und Dialogfeldern und Seitenleisten.

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

Rückflug

Ui – eine Instanz der Benutzeroberflächen-Umgebung dieses Dokuments

---

openById(id)

Gibt das Dokument mit der angegebenen ID zurück. Wenn das Script containergebunden ist, verwenden Sie stattdessen getActiveDocument().

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

Parameter

Name	Typ	Beschreibung
id	String	Die ID des Dokuments, das geöffnet werden soll.

Rückflug

Document – die Dokumentinstanz.

Autorisierung

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

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

---

openByUrl(url)

Öffnet das Dokument mit der angegebenen URL und gibt es zurück. Wenn das Script containergebunden ist, verwenden Sie stattdessen getActiveDocument().

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Parameter

Name	Typ	Beschreibung
url	String	die URL des Dokuments, das geöffnet werden soll

Rückflug

Document – die Dokumentinstanz

Autorisierung

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

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