Class Position

Position

Ein Verweis auf eine Position im Dokumenttab, relativ zu einem bestimmten Element. Der Cursor des Nutzers wird unter anderem als Position dargestellt. Scripts können nur auf den Cursor des Nutzers zugreifen, der das Script ausführt, und nur, wenn das Script an das Dokument gebunden ist.

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Methoden

Methode	Rückgabetyp	Kurzbeschreibung
getElement()	Element	Ruft das Element ab, das diese Position enthält.
getOffset()	Integer	Ruft die relative Position dieser Position innerhalb des Elements ab, das sie enthält.
getSurroundingText()	Text	Erstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph oder ListItem darstellt, das die Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen.
getSurroundingTextOffset()	Integer	Ruft den Offset dieser Position innerhalb des Text-Elements ab, das von getSurroundingText() zurückgegeben wird.
insertBookmark()	Bookmark	Erstellt und fügt an dieser Position eine neue Bookmark ein.
insertInlineImage(image)	InlineImage|null	Erstellt und fügt an dieser Position aus dem angegebenen Image Blob ein neues InlineImage ein.
insertText(text)	Text|null	Fügt den angegebenen Text an dieser Position ein.

Detaillierte Dokumentation

getElement()

Ruft das Element ab, das diese Position enthält. Dies ist entweder ein Text-Element oder ein Containerelement wie Paragraph. In beiden Fällen kann die relative Position innerhalb des Elements mit getOffset() bestimmt werden.

Rückgabe

Element: Das Container- oder Text-Element, in dem sich dieses Position-Objekt befindet

---

getOffset()

Ruft die relative Position dieser Position innerhalb des Elements ab, das sie enthält. Wenn das Element ein Text-Element ist, ist der Offset die Anzahl der Zeichen vor der Position (d. h. der Index des Zeichens nach dieser Position). Bei jedem anderen Element ist der Offset die Anzahl der untergeordneten Elemente vor dieser Position innerhalb desselben Containerelements (d. h. der Index des untergeordneten Elements nach der Position).

Rückgabe

Integer – Bei Text-Elementen die Anzahl der Zeichen vor dieser Position. Bei anderen Elementen die Anzahl der untergeordneten Elemente vor dieser Position innerhalb desselben Containerelements

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

---

getSurroundingText()

Erstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph oder ListItem darstellt, das die Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen. Verwenden Sie getSurroundingTextOffset(), um den Offset der Position im zurückgegebenen Text Element zu bestimmen.

Rückgabe

Text – ein Element, das dem Ergebnis des Aufrufs von editAsText() für den Paragraph oder ListItem entspricht, der die Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen

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

---

getSurroundingTextOffset()

Ruft den Offset dieser Position innerhalb des Text-Elements ab, das von getSurroundingText() zurückgegeben wird. Der Offset ist die Anzahl der Zeichen vor der Position (d. h. der Index des Zeichens nach dieser Position).

Rückgabe

Integer: Die Anzahl der Zeichen vor dieser Position im Paragraph oder ListItem, der die Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen

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

---

insertBookmark()

Erstellt und fügt an dieser Position eine neue Bookmark ein.

Rückgabe

Bookmark: Das neue Lesezeichen

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

---

insertInlineImage(image)

Erstellt und fügt an dieser Position aus dem angegebenen Image-Blob ein neues InlineImage ein.

Parameter

Name	Typ	Beschreibung
image	BlobSource	Die Bilddaten, die an dieser Position eingefügt werden sollen

Rückgabe

InlineImage|null – das neue Bildelement oder null, wenn das Element, in dem sich diese Position befindet, das Einfügen von Bildern nicht zulässt

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

---

insertText(text)

Fügt den angegebenen Text an dieser Position ein. Mit dieser Methode wird ein neues Text Element erstellt, auch wenn die String in ein vorhandenes Text Element eingefügt wird. So lässt sich das neue Element ganz einfach formatieren.

Parameter

Name	Typ	Beschreibung
text	String	Die String, die an dieser Position eingefügt werden soll

Rückgabe

Text|null – das neue Textelement oder null, wenn das Element, in dem sich diese Position befindet, das Einfügen von Text nicht zulässt

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