Class DocumentApp

DocumentApp

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

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

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

Attribute

AttributTypBeschreibung
AttributeAttributeDie Aufzählung Attribute.
ElementTypeElementTypeDie Aufzählung ElementType.
FontFamilyFontFamilyDie Aufzählung FontFamily.
GlyphTypeGlyphTypeDie Aufzählung GlyphType.
HorizontalAlignmentHorizontalAlignmentDie Aufzählung HorizontalAlignment.
ParagraphHeadingParagraphHeadingDie Aufzählung ParagraphHeading.
PositionedLayoutPositionedLayoutDie Aufzählung PositionedLayout.
TextAlignmentTextAlignmentDie Aufzählung TextAlignment.
VerticalAlignmentVerticalAlignmentDie Aufzählung VerticalAlignment.

Methoden

MethodeRückgabetypKurzbeschreibung
create(name)DocumentErstellt ein neues Dokument und gibt es zurück.
getActiveDocument()DocumentGibt das Dokument zurück, an das das Skript containergebunden ist.
getUi()UiGibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, die es dem Skript ermöglicht, wie Menüs, Dialogfelder und Seitenleisten.
openById(id)DocumentGibt 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.
var doc = DocumentApp.create('Document Name');

Parameter

NameTypBeschreibung
nameStringDer Name des neuen Dokuments.

Rückflug

Document: Die neue Dokumentinstanz.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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

getActiveDocument()

Gibt das Dokument zurück, an das das Skript containergebunden ist. Um mit dem Dokument zu interagieren, Das Skript ist nicht containergebunden. Verwenden Sie openById(id) oder openByUrl(url). .

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

Rückflug

Document – die Dokumentinstanz

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

getUi()

Gibt eine Instanz der Benutzeroberflächenumgebung des Dokuments zurück, die es dem Skript ermöglicht, wie Menüs, Dialogfelder und Seitenleisten. Ein Skript kann nur mit der UI für den aktuelle Instanz eines offenen Dokuments und nur dann, wenn das Skript an das Dokument gebunden ist. Weitere Informationen finden Sie in der Anleitungen 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ächenumgebung dieses Dokuments


openById(id)

Gibt das Dokument mit der angegebenen ID zurück. Wenn das Skript containergebunden ist, Verwende stattdessen getActiveDocument().

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

Parameter

NameTypBeschreibung
idStringDie ID des zu öffnenden Dokuments.

Rückflug

Document: Die Dokumentinstanz.

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren 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 Skript containergebunden ist an den Dokument verwenden, verwenden Sie stattdessen getActiveDocument().

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

Parameter

NameTypBeschreibung
urlStringDie URL des zu öffnenden Dokuments

Rückflug

Document – die Dokumentinstanz

Autorisierung

Skripts, die diese Methode verwenden, erfordern eine Autorisierung mit einem oder mehreren der folgenden Bereiche:

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