Référence à un emplacement du document, par rapport à un élément spécifique. Le curseur de l'utilisateur est représenté par Position
, entre autres. Les scripts ne peuvent accéder qu'au curseur de l'utilisateur qui exécute les scripts, et uniquement s'ils sont liés au document.
// 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.'); }
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getElement() | Element | Récupère l'élément qui contient ce Position . |
getOffset() | Integer | Récupère l'emplacement relatif de cette Position dans l'élément qui la contient. |
getSurroundingText() | Text | Crée un élément Text artificiel qui représente le texte et la mise en forme de l'élément Paragraph ou ListItem contenant le Position , soit directement, soit via une chaîne d'éléments enfants. |
getSurroundingTextOffset() | Integer | Récupère le décalage de ce Position dans l'élément Text renvoyé par getSurroundingText() . |
insertBookmark() | Bookmark | Crée et insère un Bookmark au niveau de ce Position . |
insertInlineImage(image) | InlineImage | Crée et insère un objet InlineImage dans cet objet Position à partir du blob d'image spécifié. |
insertText(text) | Text | Insère le texte spécifié au niveau de cet élément Position . |
Documentation détaillée
getElement()
Récupère l'élément qui contient ce Position
. Il s'agira d'un élément Text
ou d'un élément conteneur comme Paragraph
. Dans les deux cas, la position relative dans l'élément peut être déterminée avec getOffset()
.
Renvois
Element
: conteneur ou élément Text
dans lequel se trouve cet objet Position
getOffset()
Récupère l'emplacement relatif de cette Position
dans l'élément qui la contient. Si l'élément est un élément Text
, le décalage correspond au nombre de caractères avant Position
(c'est-à-dire, l'index du caractère après cette Position
). Pour tout autre élément, le décalage correspond au nombre d'éléments enfants avant cet élément Position
dans le même élément conteneur (c'est-à-dire, l'index de l'élément enfant après Position
).
Renvois
Integer
: pour les éléments Text
, le nombre de caractères avant cette Position
; pour les autres éléments, le nombre d'éléments enfants avant cette Position
dans le même élément conteneur
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingText()
Crée un élément Text
artificiel qui représente le texte et la mise en forme de l'élément Paragraph
ou ListItem
contenant le Position
, soit directement, soit via une chaîne d'éléments enfants. Pour déterminer le décalage de Position
dans l'élément Text
renvoyé, utilisez getSurroundingTextOffset()
.
Renvois
Text
: élément équivalent au résultat de l'appel de editAsText()
sur l'élément Paragraph
ou ListItem
contenant l'élément Position
, soit directement, soit via une chaîne d'éléments enfants
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSurroundingTextOffset()
Récupère le décalage de ce Position
dans l'élément Text
renvoyé par getSurroundingText()
. Le décalage correspond au nombre de caractères avant Position
(c'est-à-dire l'index du caractère après cette Position
).
Renvois
Integer
: nombre de caractères avant cet élément Position
dans l'élément Paragraph
ou ListItem
contenant l'élément Position
, soit directement, soit via une chaîne d'éléments enfants
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertBookmark()
Crée et insère un Bookmark
au niveau de ce Position
.
Renvois
Bookmark
(nouveau favori)
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(image)
Crée et insère un objet InlineImage
dans cet objet Position
à partir du blob d'image spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
image | BlobSource | les données d'image à insérer à cet Position |
Renvois
InlineImage
: nouvel élément image, ou null
si l'élément dans lequel se trouve cette Position
n'autorise pas l'insertion d'images.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(text)
Insère le texte spécifié au niveau de cet élément Position
. Cette méthode crée un élément Text
, même si la chaîne est insérée dans un élément Text
existant, de sorte qu'il soit facile de styliser le nouvel élément.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | chaîne à insérer à cet Position |
Renvois
Text
: nouvel élément de texte, ou null
si l'élément dans lequel se trouve ce Position
ne permet pas d'insérer de texte.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents