Ein Verweis auf eine Stelle im Dokument, 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 auch nur dann, wenn das Skript 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 dieses Position enthält. |
getOffset() | Integer | Ruft die relative Position von Position innerhalb des Elements ab, in dem sie enthalten ist. |
getSurroundingText() | Text | Erstellt ein künstliches Text -Element, das den Text und die Formatierung von Paragraph oder ListItem darstellt, die Position enthält, entweder direkt oder über eine Kette von untergeordneten Elementen. |
getSurroundingTextOffset() | Integer | Ruft den Offset dieses Position innerhalb des von getSurroundingText() zurückgegebenen Text -Elements ab. |
insertBookmark() | Bookmark | Erstellt und fügt ein neues Bookmark in diesem Position ein. |
insertInlineImage(image) | InlineImage | Erstellt und fügt eine neue InlineImage in diesem Position aus dem angegebenen Bild-Blob ein. |
insertText(text) | Text | Fügt den angegebenen Text an dieser Position ein. |
Detaillierte Dokumentation
getElement()
Ruft das Element ab, 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.
Return
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, in dem sie enthalten ist. Wenn das Element ein Text
-Element ist, ist der Versatz die Anzahl der Zeichen vor 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
im selben Containerelement (d. h. der Index des untergeordneten Elements nach Position
).
Return
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
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 von Paragraph
oder ListItem
darstellt, die Position
enthält, entweder direkt oder über eine Kette von untergeordneten Elementen. Zum Ermitteln des Offsets von Position
im zurückgegebenen Text
-Element verwenden Sie getSurroundingTextOffset()
.
Return
Text
: ein Element, das dem Ergebnis des Aufrufs von editAsText()
für Paragraph
oder ListItem
entspricht, 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 Offset dieses Position
innerhalb des von getSurroundingText()
zurückgegebenen Text
-Elements ab. Der Offset ist die Anzahl der Zeichen vor dem Position
(d. h. der Index des Zeichens nach diesem Position
).
Return
Integer
: die Anzahl der Zeichen vor diesem Position
in den 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 und fügt ein neues Bookmark
in diesem Position
ein.
Return
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 und fügt eine neue InlineImage
in diesem Position
aus dem angegebenen Bild-Blob ein.
Parameter
Name | Typ | Beschreibung |
---|---|---|
image | BlobSource | die Bilddaten, die an diesem Position eingefügt werden sollen |
Return
InlineImage
: das neue Bildelement oder null
, wenn das Element, in dem sich diese Position
befindet, das Einfügen von Bildern nicht zulässt
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, auch wenn der String in einem vorhandenen Text
-Element eingefügt wird. So kann das neue Element einfach gestaltet werden.
Parameter
Name | Typ | Beschreibung |
---|---|---|
text | String | String, der an diesem Position eingefügt werden soll |
Return
Text
: das neue Textelement oder null
, wenn das Element, in dem sich diese Position
befindet, das Einfügen von Text nicht zulässt
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