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 Dokumenttext angezeigt.
Methoden
| Methode | Rückgabetyp | Kurzbeschreibung |
|---|---|---|
copy() | Person | Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück. |
get | Object | Ruft die Attribute des Elements ab. |
get | String | Gibt die E‑Mail-Adresse der Person zurück. |
get | String|null | Gibt den Anzeigenamen der Person zurück, falls er festgelegt ist. |
get | Element|null | Ruft das nächste gleichgeordnete Element des Elements ab. |
get | Container | Ruft das übergeordnete Element des Elements ab. |
get | Element|null | Ruft das vorherige gleichgeordnete Element des Elements ab. |
get | Element | Ruft den Element des Elements ab. |
is | Boolean | Gibt an, ob sich das Element am Ende von Document befindet. |
merge() | Person|null | Führt das Element mit dem vorhergehenden gleichartigen Geschwisterelement zusammen. |
remove | Person|null | Entfernt das Element aus dem übergeordneten Element. |
set | Person | Legt die Attribute des Elements fest. |
Detaillierte Dokumentation
copy()
Gibt eine getrennte, vollständige Kopie des aktuellen Elements zurück.
Alle untergeordneten Elemente des Elements werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.
Rückflug
Person: Der neue Text.
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
get Attributes()
Ruft die Attribute des Elements ab.
Das Ergebnis ist ein Objekt, das für jedes gültige Elementattribut eine Property enthält. Jeder Property-Name entspricht einem Element in der Document-Aufzählung.
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ückflug
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
get Email()
Gibt die E‑Mail-Adresse der Person zurück.
Rückflug
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
get Name()
Gibt den Anzeigenamen der Person zurück, falls er festgelegt ist.
Rückflug
String|null: Der Anzeigename des Personenlinks oder null, wenn im Element stattdessen die E-Mail-Adresse 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
get Next Sibling()
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ückflug
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
get Parent()
Ruft das übergeordnete Element des Elements ab.
Das übergeordnete Element enthält das aktuelle Element.
Rückflug
Container: 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
get Previous Sibling()
Ruft das vorherige gleichgeordnete Element des Elements ab.
Das vorherige gleichgeordnete Element hat dasselbe übergeordnete Element und geht dem aktuellen Element voraus.
Rückflug
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
get Type()
Ruft den Element des Elements ab.
Mit get 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ückflug
Element: 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
is At Document End()
Gibt an, ob sich das Element am Ende von Document befindet.
Rückflug
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 vorhergehenden gleichartigen Geschwisterelement zusammen.
Es können nur Elemente desselben Element zusammengeführt werden. Alle untergeordneten Elemente des aktuellen Elements werden in das vorhergehende 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ückflug
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
remove From Parent()
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ückflug
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
set Attributes(attributes)
Legt die Attribute des Elements fest.
Der angegebene Parameter „attributes“ muss ein Objekt sein, in dem jeder Attributname ein Element in der Aufzählung Document ist und jeder Attributwert der neue Wert ist, der angewendet werden soll.
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
| Name | Typ | Beschreibung |
|---|---|---|
attributes | Object | Die Attribute des Elements. |
Rückflug
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