Diese Seite wurde von der Cloud Translation API übersetzt.

Class Position

Ein Verweis auf eine Position auf dem Dokument-Tab, in Bezug auf ein bestimmtes Element. Der Cursor des Nutzers wird unter anderem als Position dargestellt. Skripts können nur auf den Cursor des Nutzer, der das Skript ausführt, und nur, wenn es an das Dokument gebunden ist.

// Insert some text at the cursor position and make it bold.
var 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.
  var 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 von `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`, die das `Position` enthalten, entweder direkt oder über eine Kette von untergeordneten Elementen.
`getSurroundingTextOffset()`	`Integer`	Ruft den Versatz von `Position` innerhalb des `Text`-Elements ab, das von `getSurroundingText()` zurückgegeben wird.
`insertBookmark()`	`Bookmark`	Erstellt eine neue `Bookmark` und fügt sie an dieser `Position` ein.
`insertInlineImage(image)`	`InlineImage`	Erstellt eine neue `InlineImage` und fügt sie an dieser `Position` aus dem angegebenen Bild ein Blob.
`insertText(text)`	`Text`	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 oder ein Containerelement wie Paragraph. In beiden Fällen kann die relative kann die Position innerhalb des Elements mit getOffset() bestimmt werden.

Rückflug

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

`getOffset()`

Ruft die relative Position von Position innerhalb des Elements ab, das sie enthält. Wenn die -Element ein Text-Element ist, entspricht der Versatz der Anzahl der Zeichen vor Position (d. h. dem Index des Zeichens nach diesem Position). für alle anderen -Element ist der Versatz die Anzahl der untergeordneten Elemente vor diesem Position innerhalb der Containerelement (d. h. Index des untergeordneten Elements nach Position)

Rückflug

Integer: für Text-Elemente die Anzahl der Zeichen vor dieser Position; für anderen Elementen, die Anzahl der untergeordneten Elemente vor diesem Position innerhalb derselben Containerelement

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

`getSurroundingText()`

Erstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph oder ListItem, die das Position enthalten, entweder direkt oder über eine Kette von untergeordneten Elementen. Um den Offset von Position im zurückgegebenen Text-Element zu ermitteln, verwenden Sie getSurroundingTextOffset().

Rückflug

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

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

`getSurroundingTextOffset()`

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

Rückflug

Integer – Anzahl der Zeichen vor dieser Position in Paragraph oder ListItem, die das Position enthalten, entweder direkt oder über eine Kette von untergeordneten Elementen

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

`insertBookmark()`

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

Rückflug

Bookmark – das neue Lesezeichen

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

`insertInlineImage(image)`

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

Parameter

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

Rückflug

InlineImage: das neue Bildelement oder null, wenn das Element, in dem dieses Position-Element ist, ermittelt, können keine Bilder eingefügt werden.

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

`insertText(text)`

Fügt den angegebenen Text an dieser Position ein. Mit dieser Methode wird ein neues Text-Element erstellt -Element hinzufügen, auch wenn der String innerhalb eines vorhandenen Text-Elements eingefügt wird, sodass es das neue Element ganz einfach zu gestalten.

Parameter

Name	Typ	Beschreibung
`text`	`String`	Entspricht dem String, der an diesem `Position` eingefügt werden soll.

Rückflug

Text: das neue Textelement oder null, wenn das Element, in dem dieses Position-Element ist, befindet sich nicht, lässt das Einfügen von Text nicht zu.

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