Class InlineDrawing

InlineDrawing

Ein Element, das eine eingebettete Zeichnung darstellt. Ein InlineDrawing kann in ListItem oder Paragraph enthalten sein, es sei denn, ListItem oder Paragraph ist in FootnoteSection. Ein InlineDrawing kann selbst keine anderen Elemente enthalten. Weitere Informationen zur Dokumentstruktur finden Sie im Leitfaden zum Erweitern von Google Docs.

Methoden

MethodeRückgabetypKurzbeschreibung
copy()InlineDrawingGibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.
getAltDescription()StringGibt die alternative Beschreibung der Zeichnung zurück
getAltTitle()StringGibt den alternativen Titel der Zeichnung zurück
getAttributes()ObjectRuft die Attribute des Elements ab.
getNextSibling()ElementRuft das nächste gleichgeordnete Element des Elements ab.
getParent()ContainerElementRuft das übergeordnete Element des Elements ab.
getPreviousSibling()ElementRuft das vorherige gleichgeordnete Element des Elements ab.
getType()ElementTypeRuft den ElementType des Elements ab.
isAtDocumentEnd()BooleanBestimmt, ob sich das Element am Ende von Document befindet.
merge()InlineDrawingFührt das Element mit dem vorherigen gleichgeordneten Element desselben Typs zusammen.
removeFromParent()InlineDrawingEntfernt das Element aus seinem übergeordneten Element.
setAltDescription(description)InlineDrawingLegt die alternative Beschreibung der Zeichnung fest.
setAltTitle(title)InlineDrawingLegt den alternativen Titel der Zeichnung fest.
setAttributes(attributes)InlineDrawingLegt die Attribute des Elements fest.

Detaillierte Dokumentation

copy()

Gibt eine getrennte, tiefgehende Kopie des aktuellen Elements zurück.

Alle untergeordneten Elemente, die im Element vorhanden sind, werden ebenfalls kopiert. Das neue Element hat kein übergeordnetes Element.

Return

InlineDrawing: 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

getAltDescription()

Gibt die alternative Beschreibung der Zeichnung zurück

Return

String: der alternative Titel oder null, wenn das Element keinen alternativen Titel hat

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

getAltTitle()

Gibt den alternativen Titel der Zeichnung zurück

Return

String: der alternative Titel oder null, wenn das Element keinen alternativen Titel hat

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 ein Attribut für jedes gültige Elementattribut enthält, wobei jeder Attributname einem Element in der DocumentApp.Attribute-Aufzählung entspricht.

var body = DocumentApp.getActiveDocument().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]);
}

Return

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

getNextSibling()

Ruft das nächste gleichgeordnete Element des Elements ab.

Das nächste gleichgeordnete Element hat das gleiche übergeordnete Element und folgt dem aktuellen Element.

Return

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.

Return

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 das gleiche übergeordnete Element und steht dem aktuellen Element vor.

Return

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

getType()

Ruft den ElementType des Elements ab.

Verwenden Sie getType(), um den genauen Typ eines bestimmten Elements zu bestimmen.

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document 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.');
}

Return

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

isAtDocumentEnd()

Bestimmt, ob sich das Element am Ende von Document befindet.

Return

Boolean: Gibt an, ob sich das Element am Ende des Dokuments 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 vorherigen gleichgeordneten Element desselben Typs zusammen.

Nur Elemente derselben ElementType können zusammengeführt werden. Alle untergeordneten Elemente, die im aktuellen Element enthalten sind, werden in das vorherige gleichgeordnete Element verschoben.

Das aktuelle Element wird aus dem Dokument entfernt.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
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();

Return

InlineDrawing: 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 seinem übergeordneten Element.

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Return

InlineDrawing: 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

setAltDescription(description)

Legt die alternative Beschreibung der Zeichnung fest. Wenn der angegebene Titel null lautet, wird für die Beschreibung ein leerer String festgelegt.

Parameter

NameTypBeschreibung
descriptionStringder alternative Titel

Return

InlineDrawing – das aktuelle Objekt

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

setAltTitle(title)

Legt den alternativen Titel der Zeichnung fest. Wenn der angegebene Titel null lautet, wird der Titel auf den leeren String festgelegt.

Parameter

NameTypBeschreibung
titleStringder alternative Titel

Return

InlineDrawing – das aktuelle Objekt

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, bei dem jeder Attributname ein Element in der DocumentApp.Attribute-Aufzählung und jeder Attributwert der neue Wert ist, der angewendet werden soll.

var body = DocumentApp.getActiveDocument().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

NameTypBeschreibung
attributesObjectDie Attribute des Elements.

Return

InlineDrawing: 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