Class Person

Person

Ein Element, das einen Link zu einer Person darstellt. Ein Personenlink verweist auf eine E‑Mail-Adresse und kann optional einen Namen enthalten, der mit der Adresse verknüpft ist. Wenn der Name festgelegt ist, wird er im Dokumentkörper angezeigt.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()PersonGibt eine unabhängige, vollständige Kopie des aktuellen Elements zurück.
getAttributes()ObjectRuft die Attribute des Elements ab.
getEmail()StringGibt die E‑Mail-Adresse der Person zurück.
getName()String|nullGibt den Anzeigenamen der Person zurück, falls festgelegt.
getNextSibling()Element|nullRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElement|nullRuft das übergeordnete Element des Elements ab.
getPreviousSibling()Element|nullRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft das Element ElementType ab.
isAtDocumentEnd()BooleanGibt an, ob sich das Element am Ende des Document befindet.
merge()Person|nullFührt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen.
removeFromParent()Person|nullEntfernt das Element aus dem übergeordneten Element.
setAttributes(attributes)PersonLegt die Attribute des Elements fest.

Detaillierte Dokumentation

copy()

Gibt eine unabhängige, vollständige Kopie des aktuellen Elements zurück.

Alle im Element vorhandenen untergeordneten Elemente werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Rückgabe

Person : Die neue Kopie.

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

getAttributes()

Ruft die Attribute des Elements ab.

Das Ergebnis ist ein Objekt mit einer Property für jedes gültige Elementattribut. Jeder Propertyname entspricht einem Element in der Aufzählung DocumentApp.Attribute. 

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

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Rückgabe

Object : Die Attribute des Elements.

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

getEmail()

Gibt die E‑Mail-Adresse der Person zurück.

Rückgabe

String : Die E‑Mail-Adresse der Person.

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

getName()

Gibt den Anzeigenamen der Person zurück, falls festgelegt.

Rückgabe

String|null : Der Anzeigename des Personenlinks oder null, wenn stattdessen die E‑Mail Adresse im Element angezeigt wird.

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

getNextSibling()

Ruft das nächste gleichgeordnete Element des Elements ab.

Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt auf das aktuelle Element.

Rückgabe

Element|null : Das nächste gleichgeordnete Element.

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

getParent()

Ruft das übergeordnete Element des Elements ab.

Das übergeordnete Element enthält das aktuelle Element.

Rückgabe

ContainerElement|null : Das übergeordnete Element.

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

getPreviousSibling()

Ruft das vorherige gleichgeordnete Element des Elements ab.

Das vorherige gleichgeordnete Element hat dasselbe übergeordnete Element und geht dem aktuellen Element voraus.

Rückgabe

Element|null : Das vorherige gleichgeordnete Element.

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

getType()

Ruft den ElementType des Elements ab.

Mit getType() können Sie den genauen Typ eines bestimmten Elements ermitteln. 

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

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Rückgabe

ElementType : Der Elementtyp.

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

isAtDocumentEnd()

Gibt an, ob sich das Element am Ende des Document befindet.

Rückgabe

Boolean : Gibt an, ob sich das Element am Ende des Tabs befindet.

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

merge()

Führt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen.

Es können nur Elemente desselben ElementType zusammengeführt werden. Alle im aktuellen Element enthaltenen untergeordneten Elemente werden in das vorherige gleichgeordnete Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt. 

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Rückgabe

Person|null : Das zusammengeführte Element.

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

removeFromParent()

Entfernt das Element aus dem übergeordneten Element. 

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Rückgabe

Person|null : Das entfernte Element.

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

setAttributes(attributes)

Legt die Attribute des Elements fest.

Der angegebene Parameter „attributes“ muss ein Objekt sein, bei dem jeder Propertyname ein Element in der Aufzählung DocumentApp.Attribute und jeder Propertywert der neue anzuwendende Wert ist. 

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

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parameter

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Rückgabe

Person : Das aktuelle Element.

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