Ein Element, das einen Link zu einer Google-Ressource darstellt, z. B. einer Drive-Datei oder einem YouTube-Video.
Methoden
Methode | Rückgabetyp | Kurzbeschreibung |
---|---|---|
copy() | RichLink | Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück. |
getAttributes() | Object | Ruft die Attribute des Elements ab. |
getMimeType() | String | Gibt den MIME-Typ von
den Link, der verfügbar ist, wenn das Element ein Link zu einer Drive-Datei und null ist
sonst. |
getNextSibling() | Element | Ruft das nächste gleichgeordnete Element des Elements ab |
getParent() | ContainerElement | Ruft das übergeordnete Element des Elements ab. |
getPreviousSibling() | Element | Ruft das vorherige gleichgeordnete Element des Elements ab |
getTitle() | String | Gibt den angezeigten Titel des Links zurück. |
getType() | ElementType | Ruft den ElementType des Elements ab. |
getUrl() | String | Gibt die URL der Ressource zurück. |
isAtDocumentEnd() | Boolean | Bestimmt, ob sich das Element am Ende von Document befindet. |
merge() | RichLink | Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen. |
removeFromParent() | RichLink | Entfernt das Element aus dem übergeordneten Element. |
setAttributes(attributes) | RichLink | Legt die Attribute des Elements fest. |
Detaillierte Dokumentation
copy()
Gibt eine losgelöste, tiefe Kopie des aktuellen Elements zurück.
Alle im Element vorhandenen untergeordneten Elemente werden ebenfalls kopiert. Das neue Element hat kein Parent.
Rückflug
RichLink
: Die neue Kopie.
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
getAttributes()
Ruft die Attribute des Elements ab.
Das Ergebnis ist ein -Objekt, das eine -Eigenschaft für jedes gültige Elementattribut enthält, wobei jeder
Eigenschaftsname entspricht einem Element in der DocumentApp.Attribute
-Aufzählung.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Rückflug
Object
: Die Attribute des Elements.
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
getMimeType()
Gibt den MIME-Typ von
den Link, der verfügbar ist, wenn das Element ein Link zu einer Drive-Datei und null
ist
sonst.
Wenn der Link beispielsweise auf eine Google Docs-Datei verweist, wird der String
application/vnd.google-apps.document
zurückgegeben.
Rückflug
String
: Der MIME-Typ des Links, falls verfügbar.
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
getNextSibling()
Ruft das nächste gleichgeordnete Element des Elements ab
Das nächste gleichgeordnete Element hat dasselbe übergeordnete Element und folgt dem aktuellen Element.
Rückflug
Element
: Das nächste gleichgeordnete Element.
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
getParent()
Ruft das übergeordnete Element des Elements ab.
Das übergeordnete Element enthält das aktuelle Element.
Rückflug
ContainerElement
: Das übergeordnete Element.
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
getPreviousSibling()
Ruft das vorherige gleichgeordnete Element des Elements ab
Das vorherige gleichgeordnete Element hat dasselbe übergeordnete Element und ist dem aktuellen Element vorangestellt.
Rückflug
Element
: Das vorherige gleichgeordnete Element.
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
getTitle()
Gibt den angezeigten Titel des Links zurück. Dieser Titel stimmt mit dem Titel der verknüpften Ressource auf der
Zeitpunkt der Einfügung oder der letzten Aktualisierung des Links. Wenn dieser Link beispielsweise auf eine
Docs-Dokument mit dem Titel „Analyse“, Dies gibt Analysis
zurück.
Rückflug
String
: Der Anzeigetitel des Links.
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
getType()
Ruft den ElementType
des Elements ab.
Verwenden Sie getType()
, um den genauen Typ eines bestimmten Elements zu bestimmen.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var 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
ElementType
: Der Elementtyp.
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
getUrl()
Gibt die URL der Ressource zurück.
Rückflug
String
: Die URL der Ressource.
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
isAtDocumentEnd()
Bestimmt, ob sich das Element am Ende von Document
befindet.
Rückflug
Boolean
: gibt an, ob sich das Element am Ende des Tabs befindet.
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
merge()
Führt das Element mit dem vorangehenden gleichgeordneten Element desselben Typs zusammen.
Nur Elemente derselben ElementType
können zusammengeführt werden. Alle untergeordneten Elemente, die in
werden zum vorherigen gleichgeordneten Element verschoben.
Das aktuelle Element wird aus dem Dokument entfernt.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. var par1 = body.appendParagraph('Paragraph 1.'); var 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. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Rückflug
RichLink
: Das zusammengeführte Element.
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
removeFromParent()
Entfernt das Element aus dem übergeordneten Element.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Rückflug
RichLink
: Das entfernte Element.
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
setAttributes(attributes)
Legt die Attribute des Elements fest.
Der angegebene Attributparameter muss ein Objekt sein, in dem jeder Eigenschaftsname ein Element in
DocumentApp.Attribute
und jeder Attributwert ist der neue Wert,
angewendet.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var 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. var 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
RichLink
: Das aktuelle Element.
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