Diese Seite wurde von der Cloud Translation API übersetzt.

Class Position

Ein Verweis auf eine Position im Dokumenttab, bezogen auf ein bestimmtes 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 dann, 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`	Das Element abrufen, das dieses `Position` enthält.
`getOffset()`	`Integer`	Die relative Position dieses `Position` innerhalb des Elements, das es enthält.
`getSurroundingText()`	`Text`	Erstellt ein künstliches `Text`-Element, das den Text und die Formatierung des `Paragraph` oder `ListItem` darstellt, das bzw. die das `Position` enthält, entweder direkt oder über eine Kette von untergeordneten Elementen.
`getSurroundingTextOffset()`	`Integer`	Ermittelt den Offset dieses `Position` innerhalb des `Text`-Elements, das von `getSurroundingText()` zurückgegeben wird.
`insertBookmark()`	`Bookmark`	Erstellt und fügt an dieser Stelle `Position` eine neue `Bookmark` ein.
`insertInlineImage(image)`	`InlineImage`	Erstellt und fügt an dieser `Position` eine neue `InlineImage` aus dem angegebenen Bildblob ein.
`insertText(text)`	`Text`	Fügt den angegebenen Text an dieser `Position` ein.

Detaillierte Dokumentation

`getElement()`

Das Element abrufen, das dieses 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ückflug

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

`getOffset()`

Die relative Position dieses Position innerhalb des Elements, das es enthält. Wenn es sich um ein Text-Element handelt, ist der Versatz die Anzahl der Zeichen vor dem Position (d. h. der Index des Zeichens nach diesem Position). Bei allen anderen Elementen ist der Versatz die Anzahl der untergeordneten Elemente vor diesem Position innerhalb desselben Containerelements (d. h. der Index des untergeordneten Elements nach dem Position).

Rückflug

Integer: Bei Text-Elementen die Anzahl der Zeichen vor diesem Position; bei anderen Elementen die Anzahl der untergeordneten Elemente vor diesem Position innerhalb desselben Containerelements

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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 bzw. die das Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen. Mit getSurroundingTextOffset() lässt sich der Offset von Position im zurückgegebenen Text-Element ermitteln.

Rückflug

Text: Ein Element, das dem Ergebnis des Aufrufs von editAsText() auf dem Paragraph oder ListItem entspricht, das die Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getSurroundingTextOffset()`

Ermittelt den Offset dieses Position innerhalb des Text-Elements, das von getSurroundingText() zurückgegeben wird. Der Offset ist die Anzahl der Zeichen vor dem Position, also der Index des Zeichens nach diesem Position.

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertBookmark()`

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

Rückflug

Bookmark – das neue Lesezeichen

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertInlineImage(image)`

Erstellt und fügt an dieser Position eine neue InlineImage aus dem angegebenen Bildblob ein.

Parameter

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

Rückflug

InlineImage – 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, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

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 der String in ein vorhandenes Text-Element eingefügt wird. So lässt sich das neue Element ganz einfach stylen.

Parameter

Name	Typ	Beschreibung
`text`	`String`	Der String, der an dieser Stelle `Position` eingefügt werden soll

Rückflug

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

Autorisierung

Scripts, die diese Methode verwenden, erfordern eine Autorisierung für einen oder mehrere der folgenden Bereiche:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents