Class Position

Position

Ein Verweis auf eine Position auf dem Dokument-Tab relativ zu einem bestimmten Element. Der Cursor des Nutzers wird unter anderem als Position dargestellt. Skripts können nur auf den Cursor des Nutzers zugreifen, der das Skript ausführt, und nur, wenn das Skript 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

MethodeRückgabetypKurzbeschreibung
getElement()ElementRuft das Element ab, das diese Position enthält.
getOffset()IntegerGibt die relative Position dieses Position-Elements innerhalb des Elements zurück, das es enthält.
getSurroundingText()TextErstellt ein künstliches Text-Element, das den Text und die Formatierung des Paragraph- oder ListItem-Elements darstellt, das das Position-Element direkt oder über eine Kette untergeordneter Elemente enthält.
getSurroundingTextOffset()IntegerRuft den Offset dieses Position innerhalb des Text-Elements ab, das von getSurroundingText() zurückgegeben wird.
insertBookmark()BookmarkErstellt und fügt an dieser Position eine neue Bookmark ein.
insertInlineImage(image)InlineImage|nullErstellt und fügt an dieser Position ein neues InlineImage aus dem angegebenen Bild-Blob ein.
insertText(text)Text|nullFügt den angegebenen Text an dieser Position ein.

Detaillierte Dokumentation

getElement()

Ruft das Element ab, das diese Position enthält. Das kann entweder ein Text-Element oder ein Container-Element wie Paragraph sein. 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()

Gibt die relative Position dieses Position-Elements innerhalb des Elements zurück, das es enthält. Wenn das Element ein Text-Element ist, ist der Offset die Anzahl der Zeichen vor dem Position (d. h. der Index des Zeichens nach diesem Position). Bei jedem anderen Element ist der Offset 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, 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-Elements darstellt, das das Position-Element direkt oder über eine Kette untergeordneter Elemente enthält. Verwenden Sie getSurroundingTextOffset(), um den Offset von Position im zurückgegebenen Text-Element zu ermitteln.

Rückflug

Text: ein Element, das dem Ergebnis des Aufrufs von editAsText() für das Paragraph oder ListItem entspricht, das das 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 dieses Position innerhalb des Text-Elements ab, das von getSurroundingText() zurückgegeben wird. Der Offset ist die Anzahl der Zeichen vor dem Position (d. h. der Index des Zeichens nach diesem Position).

Rückflug

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

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ückflug

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 ein neues InlineImage aus dem angegebenen Bild-Blob ein.

Parameter

NameTypBeschreibung
imageBlobSourceDie Bilddaten, die an dieser Position eingefügt werden sollen.

Rückflug

InlineImage|null – das neue Bildelement oder null, wenn in das Element, in dem sich dieses Position befindet, keine Bilder eingefügt werden können

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

Parameter

NameTypBeschreibung
textStringDer String, der an dieser Position eingefügt werden soll.

Rückflug

Text|null: Das neue Textelement oder null, wenn in das Element, in dem sich dieses Position befindet, kein Text eingefügt werden kann

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