Élément représentant un paragraphe. Un élément Paragraph
peut contenir les éléments suivants : Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
,
et Text
. Pour en savoir plus sur la structure des documents, consultez le guide sur l'extension de Google Docs.
Paragraphs
ne doit pas contenir de caractères de retour à la ligne. Les caractères de retour à la ligne ("\n") sont
convertis en caractères de saut de ligne ("\r").
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a tab header paragraph. var header = body.appendParagraph("A Document"); header.setHeading(DocumentApp.ParagraphHeading.HEADING1); // Append a section header paragraph. var section = body.appendParagraph("Section 1"); section.setHeading(DocumentApp.ParagraphHeading.HEADING2); // Append a regular paragraph. body.appendParagraph("This is a typical paragraph.");
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addPositionedImage(image) | PositionedImage | Crée et insère un nouveau PositionedImage à partir du blob d'image spécifié. |
appendHorizontalRule() | HorizontalRule | Crée et ajoute un nouveau HorizontalRule . |
appendInlineImage(image) | InlineImage | Crée et ajoute un nouveau InlineImage à partir du blob d'image spécifié. |
appendInlineImage(image) | InlineImage | Ajoute l'élément InlineImage donné. |
appendPageBreak() | PageBreak | Crée et ajoute un nouveau PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Ajoute l'élément PageBreak donné. |
appendText(text) | Text | Crée et ajoute un élément Text avec le contenu spécifié. |
appendText(text) | Text | Ajoute l'élément Text donné. |
clear() | Paragraph | Efface le contenu de l'élément. |
copy() | Paragraph | Renvoie une copie complète et dissociée de l'élément actuel. |
editAsText() | Text | Récupère une version Text de l'élément actuel, pour modification. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du
RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières. |
findText(searchPattern, from) | RangeElement | Recherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche. |
getAlignment() | HorizontalAlignment | Récupère les HorizontalAlignment . |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index enfant de l'élément enfant spécifié. |
getHeading() | ParagraphHeading | Récupère les ParagraphHeading . |
getIndentEnd() | Number | Récupère le retrait de fin, en points. |
getIndentFirstLine() | Number | Récupère le retrait de la première ligne, en points. |
getIndentStart() | Number | Récupère le retrait de début. |
getLineSpacing() | Number | Récupère l'interligne, en points. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPositionedImage(id) | PositionedImage | Récupère un PositionedImage par l'ID de l'image. |
getPositionedImages() | PositionedImage[] | Récupère tous les objets PositionedImage ancrés au paragraphe. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getSpacingAfter() | Number | Récupère l'espacement après l'élément, en points. |
getSpacingBefore() | Number | Récupère l'espacement avant l'élément, en points. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule à l'index spécifié. |
insertInlineImage(childIndex, image) | InlineImage | Crée et insère un nouveau InlineImage à partir du blob d'image spécifié, à l'emplacement
de l'index. |
insertInlineImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertPageBreak(childIndex) | PageBreak | Crée et insère un nouveau PageBreak à l'index spécifié. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insère le PageBreak donné à l'index spécifié. |
insertText(childIndex, text) | Text | Crée et insère un élément de texte à l'index spécifié. |
insertText(childIndex, text) | Text | Insère l'élément Text donné à l'index spécifié, avec le texte spécifié.
contenus. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
isLeftToRight() | Boolean | Récupère le paramètre de gauche à droite. |
merge() | Paragraph | Fusionne l'élément avec le frère précédent du même type. |
removeChild(child) | Paragraph | Supprime l'élément enfant spécifié. |
removeFromParent() | Paragraph | Supprime l'élément de son parent. |
removePositionedImage(id) | Boolean | Supprime un élément PositionedImage à côté de l'ID de l'image. |
replaceText(searchPattern, replacement) | Element | Remplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs . |
setAlignment(alignment) | Paragraph | Définit HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Définit les attributs de l'élément. |
setHeading(heading) | Paragraph | Définit ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Définit le retrait à la fin, en points. |
setIndentFirstLine(indentFirstLine) | Paragraph | Définit le retrait de la première ligne, en points. |
setIndentStart(indentStart) | Paragraph | Définit le retrait au début, en points. |
setLeftToRight(leftToRight) | Paragraph | Définit le paramètre de gauche à droite. |
setLineSpacing(multiplier) | Paragraph | Définit l'interligne, sous la forme d'une quantité indiquant le nombre de lignes à utiliser. |
setLinkUrl(url) | Paragraph | Définit l'URL du lien. |
setSpacingAfter(spacingAfter) | Paragraph | Définit l'espacement après l'élément, en points. |
setSpacingBefore(spacingBefore) | Paragraph | Définit l'espacement avant l'élément, en points. |
setText(text) | void | Définit le contenu du paragraphe sous forme de texte. |
setTextAlignment(textAlignment) | Paragraph | Définit l'alignement du texte. |
Documentation détaillée
addPositionedImage(image)
Crée et insère un nouveau PositionedImage
à partir du blob d'image spécifié.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the specified image URL. const image = UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png'); // Adds the image to the tab, anchored to the first paragraph. paragraph.addPositionedImage(image);
Paramètres
Nom | Type | Description |
---|---|---|
image | BlobSource | Données de l'image. |
Renvois
PositionedImage
: nouvelle image positionnée.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendHorizontalRule()
Crée et ajoute un nouveau HorizontalRule
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a horizontal line under the first paragraph. paragraph.appendHorizontalRule();
Renvois
HorizontalRule
: nouvelle règle horizontale.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Crée et ajoute un nouveau InlineImage
à partir du blob d'image spécifié.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the image from the specified image URL. const image = UrlFetchApp .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png'); // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
Paramètres
Nom | Type | Description |
---|---|---|
image | BlobSource | Données de l'image. |
Renvois
InlineImage
: image ajoutée.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Ajoute l'élément InlineImage
donné.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Makes a copy of the first image in the body. const image = body.getImages()[0].copy();; // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
Paramètres
Nom | Type | Description |
---|---|---|
image | InlineImage | Données de l'image. |
Renvois
InlineImage
: image ajoutée.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
Crée et ajoute un nouveau PageBreak
.
Remarque: PageBreaks
ne peut pas être contenu dans TableCells
.
Si l'élément actuel est contenu dans une cellule de tableau, une exception sera générée.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. paragraph.appendPageBreak();
Renvois
PageBreak
: nouvel élément de saut de page.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
Ajoute l'élément PageBreak
donné.
Remarque: PageBreaks
ne peut pas être contenu dans TableCells
.
Si l'élément actuel existe dans une cellule de tableau, le script génère une exception.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. const pageBreak = paragraph.appendPageBreak(); // Makes a copy of the page break. const newPageBreak = pageBreak.copy(); // Adds the copied page break to the paragraph. paragraph.appendPageBreak(newPageBreak);
Paramètres
Nom | Type | Description |
---|---|---|
pageBreak | PageBreak | Saut de page à ajouter. |
Renvois
PageBreak
: élément de saut de page ajouté.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
Crée et ajoute un élément Text
avec le contenu spécifié.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a string to the paragraph. paragraph.appendText('This is a new sentence.');
Paramètres
Nom | Type | Description |
---|---|---|
text | String | Contenu du texte. |
Renvois
Text
: nouvel élément textuel.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
Ajoute l'élément Text
donné.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the text from the first paragraph in the body. const paragraph1 = body.getParagraphs()[0]; const text = paragraph1.getText(); // Gets the third paragraph in the body. const paragraph3 = body.getParagraphs()[2]; // Adds the text from the first paragraph to the third paragraph. paragraph3.appendText(text);
Paramètres
Nom | Type | Description |
---|---|---|
text | Text | Élément de texte à ajouter. |
Renvois
Text
: élément textuel ajouté.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Renvoie une copie complète et dissociée de l'élément actuel.
Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.
Renvois
Paragraph
: nouvelle copie.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Récupère une version Text
de l'élément actuel, pour modification.
Utilisez editAsText
pour manipuler le contenu des éléments en texte enrichi. Le mode editAsText
ignore les éléments non textuels (tels que InlineImage
et HorizontalRule
).
Les éléments enfants entièrement contenus dans une plage de texte supprimée sont retirés de l'élément.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Renvois
Text
: version texte de l'élément actuel
findElement(elementType)
Recherche un descendant du type spécifié dans le contenu de l'élément.
Paramètres
Nom | Type | Description |
---|---|---|
elementType | ElementType | Type d'élément à rechercher. |
Renvois
RangeElement
: résultat de recherche indiquant la position de l'élément de recherche.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du
RangeElement
spécifié.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Paramètres
Nom | Type | Description |
---|---|---|
elementType | ElementType | Type d'élément à rechercher. |
from | RangeElement | Résultat de recherche à partir duquel effectuer la recherche. |
Renvois
RangeElement
: résultat de recherche indiquant la position suivante de l'élément de recherche.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Recherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
Un sous-ensemble des fonctionnalités des expressions régulières JavaScript ne sont pas entièrement compatibles : des groupes de capture et des modificateurs de mode.
Le format d'expression régulière fourni est mis en correspondance de manière indépendante avec chaque bloc de texte. contenus dans l'élément actuel.
Paramètres
Nom | Type | Description |
---|---|---|
searchPattern | String | le modèle à rechercher |
Renvois
RangeElement
: résultat de recherche indiquant la position du texte à rechercher, ou valeur "null" en l'absence de texte
correspondance
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Recherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
Un sous-ensemble des fonctionnalités des expressions régulières JavaScript ne sont pas entièrement compatibles : des groupes de capture et des modificateurs de mode.
Le format d'expression régulière fourni est mis en correspondance de manière indépendante avec chaque bloc de texte. contenus dans l'élément actuel.
Paramètres
Nom | Type | Description |
---|---|---|
searchPattern | String | le modèle à rechercher |
from | RangeElement | le résultat de recherche à partir duquel effectuer la recherche |
Renvois
RangeElement
: résultat de recherche indiquant la position suivante du texte à rechercher, ou valeur "null" en l'absence de
correspondance
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAlignment()
Récupère les HorizontalAlignment
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Sets the horizontal alignment to left for the first paragraph. paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT); // Gets the horizontal alignment of the first paragraph and logs it to the console. console.log(paragraph.getAlignment().toString());
Renvois
HorizontalAlignment
: alignement.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Récupère les attributs de l'élément.
Le résultat est un objet contenant une propriété pour chaque attribut d'élément valide, où chaque
nom de la propriété correspond à un élément de l'énumération DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Renvois
Object
: attributs de l'élément.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Récupère l'élément enfant au niveau de l'index enfant spécifié.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | Index de l'élément enfant à récupérer. |
Renvois
Element
: élément enfant au niveau de l'index spécifié.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Récupère l'index enfant de l'élément enfant spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
child | Element | Élément enfant pour lequel récupérer l'index. |
Renvois
Integer
: index enfant.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeading()
Récupère les ParagraphHeading
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Adds a paragraph to the body. const paragraph = body.appendParagraph('Title heading'); // Sets the paragraph heading style to 'Title.' paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE); // Gets the heading style and logs it to the console. console.log(paragraph.getHeading().toString());
Renvois
ParagraphHeading
: titre
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentEnd()
Récupère le retrait de fin, en points.
Renvois
Number
: retrait à la fin, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentFirstLine()
Récupère le retrait de la première ligne, en points.
Renvois
Number
: retrait de la première ligne, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentStart()
Récupère le retrait de début.
Renvois
Number
: retrait du début
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLineSpacing()
Récupère l'interligne, en points.
Renvois
Number
: interligne, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Récupère l'URL du lien.
Renvois
String
: URL du lien, ou valeur "null" si l'élément contient plusieurs valeurs pour cet attribut
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Récupère l'élément frère suivant de l'élément.
Le frère suivant a le même parent et suit l'élément actuel.
Renvois
Element
: élément frère suivant.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Récupère le nombre d'enfants.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log("There are " + body.getNumChildren() + " elements in the tab's body.");
Renvois
Integer
: nombre d'enfants.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Récupère l'élément parent de l'élément.
L'élément parent contient l'élément actuel.
Renvois
ContainerElement
: élément parent.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPositionedImage(id)
Récupère un PositionedImage
par l'ID de l'image.
Paramètres
Nom | Type | Description |
---|---|---|
id | String | ID de l'image |
Renvois
PositionedImage
: image positionnée
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPositionedImages()
Récupère tous les objets PositionedImage
ancrés au paragraphe.
Renvois
PositionedImage[]
: liste d'images positionnées
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Récupère l'élément frère précédent de l'élément.
Le frère précédent a le même parent et est antérieur à l'élément actuel.
Renvois
Element
: élément frère précédent.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSpacingAfter()
Récupère l'espacement après l'élément, en points.
Renvois
Number
: espacement après l'élément, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSpacingBefore()
Récupère l'espacement avant l'élément, en points.
Renvois
Number
: espacement avant l'élément, en points
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Récupère le contenu de l'élément sous forme de chaîne de texte.
Renvois
String
: contenu de l'élément sous forme de chaîne de texte
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Récupère l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
et DocumentApp.TextAlignment.SUPERSCRIPT
.
Renvois
TextAlignment
: type d'alignement du texte, ou null
si le texte contient plusieurs types de texte
ou si l'alignement du texte n'a jamais été défini
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Récupère l'ElementType
de l'élément.
Utilisez getType()
pour déterminer le type exact d'un élément donné.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Renvois
ElementType
: type d'élément.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Crée et insère un HorizontalRule
à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
Renvois
HorizontalRule
: nouvel élément de règle horizontale
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Crée et insère un nouveau InlineImage
à partir du blob d'image spécifié, à l'emplacement
de l'index.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
image | BlobSource | les données de l'image |
Renvois
InlineImage
: élément image intégré inséré
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Insère le InlineImage
donné à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
image | InlineImage | les données de l'image |
Renvois
InlineImage
: élément image intégré inséré
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
Crée et insère un nouveau PageBreak
à l'index spécifié.
Remarque: PageBreaks
ne peut pas être contenu dans TableCells
.
Si l'élément actuel est contenu dans une cellule de tableau, une exception sera générée.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
Renvois
PageBreak
: nouvel élément de saut de page
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
Insère le PageBreak
donné à l'index spécifié.
Remarque: PageBreaks
ne peut pas être contenu dans TableCells
.
Si l'élément actuel est contenu dans une cellule de tableau, une exception sera générée.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
pageBreak | PageBreak | le p[age casser à insérer |
Renvois
PageBreak
: élément de saut de page inséré
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Crée et insère un élément de texte à l'index spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
text | String | le contenu du texte |
Renvois
Text
: nouvel élément textuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Insère l'élément Text
donné à l'index spécifié, avec le texte spécifié.
contenus.
Paramètres
Nom | Type | Description |
---|---|---|
childIndex | Integer | l'index auquel l'élément doit être inséré |
text | Text | l'élément textuel à insérer |
Renvois
Text
: élément textuel inséré
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Détermine si l'élément se trouve à la fin de Document
.
Renvois
Boolean
: indique si l'élément se trouve à la fin de l'onglet.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isLeftToRight()
Récupère le paramètre de gauche à droite.
Renvois
Boolean
: paramètre de gauche à droite
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Fusionne l'élément avec le frère précédent du même type.
Seuls les éléments du même ElementType
peuvent être fusionnés. Tout élément enfant contenu dans
l'élément actuel sont déplacés vers l'élément frère précédent.
L'élément actuel est supprimé du document.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Renvois
Paragraph
: élément fusionné.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Supprime l'élément enfant spécifié.
Paramètres
Nom | Type | Description |
---|---|---|
child | Element | l'élément enfant pour supprimer |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Supprime l'élément de son parent.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Renvois
Paragraph
: élément supprimé.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removePositionedImage(id)
Supprime un élément PositionedImage
à côté de l'ID de l'image.
Paramètres
Nom | Type | Description |
---|---|---|
id | String | ID de l'image |
Renvois
Boolean
: indique si l'image spécifiée a été supprimée ou non.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Remplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
Le format de recherche est transmis en tant que chaîne, et non en tant qu'objet d'expression régulière JavaScript. Pour cette raison, vous devez échapper toutes les barres obliques inverses dans le modèle.
Cette méthode utilise la norme RE2 standard de Google bibliothèque d'expressions, ce qui limite la syntaxe compatible.
Le format d'expression régulière fourni est mis en correspondance de manière indépendante avec chaque bloc de texte. contenus dans l'élément actuel.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Paramètres
Nom | Type | Description |
---|---|---|
searchPattern | String | le modèle d'expression régulière à rechercher |
replacement | String | Texte à utiliser comme remplacement |
Renvois
Element
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAlignment(alignment)
Définit HorizontalAlignment
.
Paramètres
Nom | Type | Description |
---|---|---|
alignment | HorizontalAlignment | l'alignement horizontal |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Définit les attributs de l'élément.
Le paramètre d'attributs spécifié doit être un objet où chaque nom d'établissement est un élément dans
l'énumération DocumentApp.Attribute
, et chaque valeur de propriété correspond à la nouvelle valeur à
appliquée.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Paramètres
Nom | Type | Description |
---|---|---|
attributes | Object | Attributs de l'élément. |
Renvois
Paragraph
: élément actuel.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeading(heading)
Définit ParagraphHeading
.
Paramètres
Nom | Type | Description |
---|---|---|
heading | ParagraphHeading | l'en-tête |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
Définit le retrait à la fin, en points.
Paramètres
Nom | Type | Description |
---|---|---|
indentEnd | Number | retrait de fin, en points |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
Définit le retrait de la première ligne, en points.
Paramètres
Nom | Type | Description |
---|---|---|
indentFirstLine | Number | retrait de la première ligne, en points |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
Définit le retrait au début, en points.
Paramètres
Nom | Type | Description |
---|---|---|
indentStart | Number | retrait du début, en points |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
Définit le paramètre de gauche à droite.
Paramètres
Nom | Type | Description |
---|---|---|
leftToRight | Boolean | le paramètre de gauche à droite |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLineSpacing(multiplier)
Définit l'interligne, sous la forme d'une quantité indiquant le nombre de lignes à utiliser.
Paramètres
Nom | Type | Description |
---|---|---|
multiplier | Number | le nombre de lignes |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Définit l'URL du lien.
Paramètres
Nom | Type | Description |
---|---|---|
url | String | URL du lien |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
Définit l'espacement après l'élément, en points.
Paramètres
Nom | Type | Description |
---|---|---|
spacingAfter | Number | espacement après l'élément, en points |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
Définit l'espacement avant l'élément, en points.
Paramètres
Nom | Type | Description |
---|---|---|
spacingBefore | Number | espacement avant l'élément, en points |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
Définit le contenu du paragraphe sous forme de texte.
Remarque: Les contenus existants sont effacés.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | le nouveau contenu textuel |
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Définit l'alignement du texte. Les types d'alignement disponibles sont DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
et DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Paramètres
Nom | Type | Description |
---|---|---|
textAlignment | TextAlignment | le type d'alignement de texte à appliquer |
Renvois
Paragraph
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents