Document Service

Document

Ce service permet aux scripts de créer, d'accéder et de modifier des fichiers Google Docs.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Classes

NomBrève description
AttributeÉnumération des attributs de l'élément.
BodyContenu d'un onglet dans un document Google Docs.
BookmarkObjet représentant un favori.
ContainerElementÉlément générique pouvant contenir d'autres éléments.
DateÉlément représentant une date mise en forme
DocumentDocument contenant un ou plusieurs objets Tab, chacun contenant du texte enrichi et des éléments tels que des tableaux et des listes.
DocumentAppLe service de documents crée et ouvre Documents qui peut être modifié.
DocumentTabUn onglet de document contenant du texte enrichi et des éléments tels que des tableaux et des listes.
ElementÉlément générique.
ElementTypeÉnumération de tous les types d'éléments.
EquationÉlément représentant une expression mathématique.
EquationFunctionÉlément représentant une fonction dans un Equation mathématique.
EquationFunctionArgumentSeparatorÉlément représentant un séparateur de fonction dans un Equation mathématique.
EquationSymbolÉlément représentant un symbole dans un Equation mathématique.
FontFamilyÉnumération des polices compatibles.
FooterSectionÉlément représentant une section de pied de page.
FootnoteÉlément représentant une note de bas de page.
FootnoteSectionÉlément représentant une section de notes de bas de page.
GlyphTypeÉnumération des types de glyphes acceptés.
HeaderSectionÉlément représentant une section d'en-tête.
HorizontalAlignmentÉnumération des types d'alignement horizontal acceptés.
HorizontalRuleÉlément représentant une règle horizontale.
InlineDrawingÉlément représentant un dessin intégré.
InlineImageÉlément représentant une image intégrée.
ListItemÉlément représentant un élément de liste.
NamedRangeUn Range qui possède un nom et un ID pour pouvoir être récupéré ultérieurement.
PageBreakÉlément représentant un saut de page.
ParagraphÉlément représentant un paragraphe.
ParagraphHeadingÉnumération des titres de paragraphes standards.
PersonÉlément représentant un lien vers une personne.
PositionRéférence à un emplacement dans l'onglet du document, par rapport à un élément spécifique.
PositionedImageImage à position fixe ancrée à un Paragraph.
PositionedLayoutÉnumération qui spécifie la manière dont un PositionedImage doit être disposé par rapport au texte environnant.
RangePlage d'éléments dans un document.
RangeBuilderCompilateur utilisé pour construire des objets Range à partir d'éléments de document.
RangeElementWrapper autour d'un Element avec un décalage de début et de fin possible.
RichLinkÉlément représentant un lien vers une ressource Google, telle qu'un fichier Drive ou une vidéo YouTube.
TabOnglet dans un document Google Docs.
TabTypeÉnumération de tous les types d'onglets.
TableÉlément représentant un tableau.
TableCellÉlément représentant une cellule de tableau.
TableOfContentsÉlément contenant une table des matières.
TableRowÉlément représentant une ligne de tableau.
TextÉlément représentant une région de texte enrichi.
TextAlignmentÉnumération du type d'alignement du texte.
UnsupportedElementÉlément représentant une région inconnue ou qui ne peut pas être affectée par un script, comme un numéro de page.
VerticalAlignmentÉnumération des types d'alignement vertical acceptés.

Attribute

Propriétés

PropriétéTypeDescription
BACKGROUND_COLOREnumCouleur d'arrière-plan d'un élément (paragraphe, tableau, etc.) ou d'un document.
BOLDEnumParamètre d'épaisseur de police pour le texte enrichi.
BORDER_COLOREnumCouleur de la bordure pour les éléments de tableau.
BORDER_WIDTHEnumLargeur de la bordure en points pour les éléments de tableau.
CODEEnumContenu du code pour les éléments d'équation.
FONT_FAMILYEnumParamètre de famille de polices pour le texte enrichi.
FONT_SIZEEnumTaille de la police en points pour le texte enrichi.
FOREGROUND_COLOREnumParamètre de couleur de premier plan pour le texte enrichi.
HEADINGEnumType de titre pour les éléments de paragraphe (par exemple, DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumParamètre de hauteur pour les éléments d'image.
HORIZONTAL_ALIGNMENTEnumAlignement horizontal des éléments de paragraphe (par exemple, DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumParamètre de retrait de fin en points pour les éléments de paragraphe.
INDENT_FIRST_LINEEnumParamètre de retrait de première ligne en points pour les éléments de paragraphe.
INDENT_STARTEnumParamètre de retrait de début en points pour les éléments de paragraphe.
ITALICEnumParamètre de style de police pour le texte enrichi.
GLYPH_TYPEEnumType de glyphe pour les éléments de liste.
LEFT_TO_RIGHTEnumParamètre d'orientation du texte, pour le texte enrichi.
LINE_SPACINGEnumParamètre d'interligne sous forme de multiplicateur pour les éléments de paragraphe.
LINK_URLEnumURL du lien, pour le texte enrichi.
LIST_IDEnumID de la liste englobante pour les éléments de liste.
MARGIN_BOTTOMEnumParamètre de marge inférieure en points pour les éléments de paragraphe.
MARGIN_LEFTEnumParamètre de marge de gauche en points pour les éléments de paragraphe.
MARGIN_RIGHTEnumParamètre de marge de droite en points pour les éléments de paragraphe.
MARGIN_TOPEnumParamètre de marge supérieure en points pour les éléments de paragraphe.
NESTING_LEVELEnumNiveau d'imbrication de l'élément, pour les éléments de liste.
MINIMUM_HEIGHTEnumParamètre de hauteur minimale en points pour les éléments de ligne de tableau.
PADDING_BOTTOMEnumParamètre de marge intérieure inférieure en points pour les éléments de cellule de tableau.
PADDING_LEFTEnumParamètre de marge intérieure de gauche en points pour les éléments de cellule de tableau.
PADDING_RIGHTEnumParamètre de marge intérieure à droite, en points, pour les éléments de cellule de tableau.
PADDING_TOPEnumParamètre de marge intérieure supérieure en points pour les éléments de cellule de tableau.
PAGE_HEIGHTEnumParamètre de hauteur de page en points pour les documents.
PAGE_WIDTHEnumParamètre de largeur de page en points pour les documents.
SPACING_AFTEREnumParamètre d'espacement inférieur en points pour les éléments de paragraphe.
SPACING_BEFOREEnumParamètre d'espacement supérieur en points pour les éléments de paragraphe.
STRIKETHROUGHEnumParamètre de texte barré, pour le texte enrichi.
UNDERLINEEnumParamètre de soulignement pour le texte enrichi.
VERTICAL_ALIGNMENTEnumParamètre d'alignement vertical pour les éléments de cellule de tableau.
WIDTHEnumParamètre de largeur pour les éléments de cellule de tableau et d'image.

Body

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute le InlineImage donné.
appendListItem(listItem)ListItemAjoute le ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouvel élément ListItem contenant le contenu textuel spécifié.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak donné.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouvel élément Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouvel Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute le Table donné.
clear()BodyEfface le contenu de l'élément.
copy()BodyRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getHeadingAttributes(paragraphHeading)ObjectRécupère l'ensemble des attributs pour le ParagraphHeading fourni.
getImages()InlineImage[]|nullRécupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]|nullRécupère tous les ListItems contenus dans la section.
getMarginBottom()Number|nullRécupère la marge inférieure, en points.
getMarginLeft()Number|nullRécupère la marge de gauche, en points.
getMarginRight()Number|nullRécupère la marge de droite.
getMarginTop()Number|nullRécupère la marge supérieure.
getNumChildren()IntegerRécupère le nombre d'enfants.
getPageHeight()Number|nullRécupère la hauteur de la page, en points.
getPageWidth()Number|nullRécupère la largeur de la page, en points.
getParagraphs()Paragraph[]|nullRécupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getTables()Table[]|nullRécupère tous les Tables contenus dans la section.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)BodySupprime l'élément enfant spécifié.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)BodyDéfinit les attributs de l'élément.
setHeadingAttributes(paragraphHeading, attributes)BodyDéfinit les attributs pour le ParagraphHeading fourni.
setMarginBottom(marginBottom)BodyDéfinit la marge inférieure, en points.
setMarginLeft(marginLeft)BodyDéfinit la marge de gauche, en points.
setMarginRight(marginRight)BodyDéfinit la marge de droite, en points.
setMarginTop(marginTop)BodyDéfinit la marge supérieure.
setPageHeight(pageHeight)BodyDéfinit la hauteur de la page, en points.
setPageWidth(pageWidth)BodyDéfinit la largeur de la page, en points.
setText(text)BodyDéfinit le contenu en tant que texte brut.
setTextAlignment(textAlignment)BodyDéfinit l'alignement du texte.

Bookmark

Méthodes

MéthodeType renvoyéBrève description
getId()StringRécupère l'ID du Bookmark.
getPosition()PositionRécupère le Position du Bookmark dans le DocumentTab.
remove()voidSupprime le Bookmark.

ContainerElement

Méthodes

MéthodeType renvoyéBrève description
asBody()BodyRenvoie l'élément actuel en tant que Body.
asEquation()EquationRenvoie l'élément actuel sous la forme d'un Equation.
asFooterSection()FooterSectionRenvoie l'élément actuel en tant que FooterSection.
asFootnoteSection()FootnoteSectionRenvoie l'élément actuel en tant que FootnoteSection.
asHeaderSection()HeaderSectionRenvoie l'élément actuel en tant que HeaderSection.
asListItem()ListItemRenvoie l'élément actuel en tant que ListItem.
asParagraph()ParagraphRenvoie l'élément actuel en tant que Paragraph.
asTable()TableRenvoie l'élément actuel en tant que Table.
asTableCell()TableCellRenvoie l'élément actuel en tant que TableCell.
asTableOfContents()TableOfContentsRenvoie l'élément actuel en tant que TableOfContents.
asTableRow()TableRowRenvoie l'élément actuel en tant que TableRow.
clear()ContainerElementEfface le contenu de l'élément.
copy()ContainerElementRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()ContainerElement|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()ContainerElement|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)ContainerElementDéfinit les attributs de l'élément.
setLinkUrl(url)ContainerElementDéfinit l'URL du lien.
setTextAlignment(textAlignment)ContainerElementDéfinit l'alignement du texte.

Date

Méthodes

MéthodeType renvoyéBrève description
copy()DateRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getDisplayText()StringRenvoie la valeur affichée dans le document.
getLocale()StringRenvoie le code de langue de la date utilisé pour la valeur affichée.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getTimestamp()DateRenvoie le code temporel associé à la date.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()Date|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()Date|nullSupprime l'élément de son parent.
setAttributes(attributes)DateDéfinit les attributs de l'élément.

Document

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark à la Position donnée au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des éditeurs de Document.
addFooter()FooterSectionAjoute une section de pied de page, si elle n'existe pas, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addHeader()HeaderSectionAjoute une section d'en-tête, si aucune n'existe, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure, dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
addViewer(emailAddress)DocumentAjoute l'utilisateur donné à la liste des spectateurs de Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des spectateurs de Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des spectateurs de Document.
getActiveTab()TabObtient le Tab actuellement actif de l'utilisateur dans le document.
getAs(contentType)BlobRécupère le contenu Document actuel sous forme de blob du type spécifié.
getBlob()BlobRécupère le contenu actuel de Document en tant que blob.
getBody()BodyRécupère le Body du premier onglet ou, pour les scripts associés à un document, le DocumentBodySection de l'onglet actif.
getBookmark(id)Bookmark|nullRécupère le Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getBookmarks()Bookmark[]Obtient tous les objets Bookmark du premier onglet ou, pour les scripts liés à un document, de l'onglet actif.
getCursor()Position|nullRécupère le curseur de l'utilisateur dans l'onglet actif.
getEditors()User[]Obtient la liste des éditeurs pour ce Document.
getFooter()FooterSection|nullRécupère la section de pied de page du premier onglet ou, pour les scripts liés à un document, la section de pied de page de l'onglet actif.
getFootnotes()Footnote[]|nullRécupère tous les éléments Footnote dans le corps du premier onglet ou, pour les scripts associés à un document, dans le corps de l'onglet actif.
getHeader()HeaderSection|nullRécupère la section d'en-tête du premier onglet ou, pour les scripts liés à un document, la section d'en-tête de l'onglet actif.
getId()StringRécupère l'identifiant unique du document.
getLanguage()StringRécupère le code de langue du document.
getName()StringRécupère le titre du document.
getNamedRangeById(id)NamedRange|nullRécupère le NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getNamedRanges()NamedRange[]Obtient tous les objets NamedRange du premier onglet ou, pour les scripts liés à un document, de l'onglet actif.
getNamedRanges(name)NamedRange[]Obtient tous les objets NamedRange portant le nom indiqué dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif.
getSelection()Range|nullObtient la sélection de l'utilisateur dans l'onglet actif.
getSupportedLanguageCodes()String[]Récupère tous les codes de langue compatibles avec les fichiers Google Docs.
getTab(tabId)TabRécupère le Tab avec l'ID spécifié.
getTabs()Tab[]Obtient tous les Tab non imbriqués qui font partie du document.
getUrl()StringRécupère l'URL permettant d'accéder au document actuel.
getViewers()User[]Obtient la liste des lecteurs et des commentateurs pour ce Document.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à un élément spécifique du premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
newRange()RangeBuilderCrée un compilateur utilisé pour construire des objets Range à partir d'éléments d'onglet dans le premier onglet ou, pour les scripts associés à un document, dans l'onglet actif.
removeEditor(emailAddress)DocumentSupprime l'utilisateur donné de la liste des éditeurs pour le Document.
removeEditor(user)DocumentSupprime l'utilisateur donné de la liste des éditeurs pour le Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le Document.
removeViewer(user)DocumentSupprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs pour le Document.
saveAndClose()voidEnregistre le Document actuel.
setActiveTab(tabId)voidDéfinit le Tab sélectionné par l'utilisateur dans le document actuel sur l'onglet portant l'ID spécifié.
setCursor(position)DocumentDéfinit le curseur de l'utilisateur, en fonction d'un Position.
setLanguage(languageCode)DocumentDéfinit le code de langue du document.
setName(name)DocumentDéfinit le titre du document.
setSelection(range)DocumentDéfinit la sélection de l'utilisateur dans l'onglet actif, en fonction d'un Range.

DocumentApp

Propriétés

PropriétéTypeDescription
AttributeAttributeÉnumération Attribute.
ElementTypeElementTypeÉnumération ElementType.
FontFamilyFontFamilyÉnumération FontFamily.
GlyphTypeGlyphTypeÉnumération GlyphType.
HorizontalAlignmentHorizontalAlignmentÉnumération HorizontalAlignment.
ParagraphHeadingParagraphHeadingÉnumération ParagraphHeading.
PositionedLayoutPositionedLayoutÉnumération PositionedLayout.
TextAlignmentTextAlignmentÉnumération TextAlignment.
VerticalAlignmentVerticalAlignmentÉnumération VerticalAlignment.

Méthodes

MéthodeType renvoyéBrève description
create(name)DocumentCrée et renvoie un document.
getActiveDocument()DocumentRenvoie le document auquel le script est lié au conteneur.
getUi()UiRenvoie une instance de l'environnement d'interface utilisateur du document qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
openById(id)DocumentRenvoie le document dont l'ID est spécifié.
openByUrl(url)DocumentOuvre et renvoie le document avec l'URL spécifiée.

DocumentTab

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark au Position donné.
addFooter()FooterSectionAjoute une section de pied de page à l'onglet, si elle n'existe pas.
addHeader()HeaderSectionAjoute une section d'en-tête d'onglet, si aucune n'existe.
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure.
getBody()BodyRécupère le Body de l'onglet.
getBookmark(id)Bookmark|nullRécupère le Bookmark avec l'ID donné.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark de l'onglet.
getFooter()FooterSection|nullRécupère la section de pied de page de l'onglet, le cas échéant.
getFootnotes()Footnote[]|nullRécupère tous les éléments Footnote du corps de l'onglet.
getHeader()HeaderSection|nullRécupère la section d'en-tête de l'onglet, le cas échéant.
getNamedRangeById(id)NamedRange|nullRécupère le NamedRange avec l'ID donné.
getNamedRanges()NamedRange[]Récupère tous les objets NamedRange de l'onglet.
getNamedRanges(name)NamedRange[]Récupère tous les objets NamedRange de l'onglet portant le nom spécifié.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à un élément spécifique.
newRange()RangeBuilderCrée un compilateur utilisé pour construire des objets Range à partir d'éléments d'onglet.

Element

Méthodes

MéthodeType renvoyéBrève description
asBody()BodyRenvoie l'élément actuel en tant que Body.
asDate()DateRenvoie l'élément actuel en tant que Date.
asEquation()EquationRenvoie l'élément actuel sous la forme d'un Equation.
asEquationFunction()EquationFunctionRenvoie l'élément actuel en tant que EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorRenvoie l'élément actuel en tant que EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolRenvoie l'élément actuel en tant que EquationSymbol.
asFooterSection()FooterSectionRenvoie l'élément actuel en tant que FooterSection.
asFootnote()FootnoteRenvoie l'élément actuel en tant que Footnote.
asFootnoteSection()FootnoteSectionRenvoie l'élément actuel en tant que FootnoteSection.
asHeaderSection()HeaderSectionRenvoie l'élément actuel en tant que HeaderSection.
asHorizontalRule()HorizontalRuleRenvoie l'élément actuel en tant que HorizontalRule.
asInlineDrawing()InlineDrawingRenvoie l'élément actuel en tant que InlineDrawing.
asInlineImage()InlineImageRenvoie l'élément actuel en tant que InlineImage.
asListItem()ListItemRenvoie l'élément actuel en tant que ListItem.
asPageBreak()PageBreakRenvoie l'élément actuel en tant que PageBreak.
asParagraph()ParagraphRenvoie l'élément actuel en tant que Paragraph.
asPerson()PersonRenvoie l'élément actuel en tant que Person.
asRichLink()RichLinkRenvoie l'élément actuel en tant que RichLink, par exemple un lien vers un fichier Google Sheets.
asTable()TableRenvoie l'élément actuel en tant que Table.
asTableCell()TableCellRenvoie l'élément actuel en tant que TableCell.
asTableOfContents()TableOfContentsRenvoie l'élément actuel en tant que TableOfContents.
asTableRow()TableRowRenvoie l'élément actuel en tant que TableRow.
asText()TextRenvoie l'élément actuel en tant que Text.
copy()ElementRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()Element|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()Element|nullSupprime l'élément de son parent.
setAttributes(attributes)ElementDéfinit les attributs de l'élément.

ElementType

Propriétés

PropriétéTypeDescription
BODY_SECTIONEnumType correspondant à l'élément Body.
COMMENT_SECTIONEnumType correspondant à l'élément CommentSection.
DATEEnumType correspondant à l'élément Date.
EQUATIONEnumType correspondant à l'élément Equation.
EQUATION_FUNCTIONEnumType correspondant à l'élément EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumType correspondant à l'élément EquationFunctionArgumentSeparator.
EQUATION_SYMBOLEnumType correspondant à l'élément EquationSymbol.
RICH_LINKEnumType correspondant à l'élément RichLink.
FOOTER_SECTIONEnumType correspondant à l'élément FooterSection.
FOOTNOTEEnumType correspondant à l'élément Footnote.
FOOTNOTE_SECTIONEnumType correspondant à l'élément FootnoteSection.
HEADER_SECTIONEnumType correspondant à l'élément HeaderSection.
HORIZONTAL_RULEEnumType correspondant à l'élément HorizontalRule.
INLINE_DRAWINGEnumType correspondant à l'élément InlineDrawing.
INLINE_IMAGEEnumType correspondant à l'élément InlineImage.
LIST_ITEMEnumType correspondant à l'élément ListItem.
PAGE_BREAKEnumType correspondant à l'élément PageBreak.
PARAGRAPHEnumType correspondant à l'élément Paragraph.
PERSONEnumType correspondant à l'élément Person.
TABLEEnumType correspondant à l'élément Table.
TABLE_CELLEnumType correspondant à l'élément TableCell.
TABLE_OF_CONTENTSEnumType correspondant à l'élément TableOfContents.
TABLE_ROWEnumType correspondant à l'élément TableRow.
TEXTEnumType correspondant à l'élément Text.
UNSUPPORTEDEnumType correspondant à UnsupportedElement.

Equation

Méthodes

MéthodeType renvoyéBrève description
clear()EquationEfface le contenu de l'élément.
copy()EquationRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()Equation|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()Equation|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)EquationDéfinit les attributs de l'élément.
setLinkUrl(url)EquationDéfinit l'URL du lien.
setTextAlignment(textAlignment)EquationDéfinit l'alignement du texte.

EquationFunction

Méthodes

MéthodeType renvoyéBrève description
clear()EquationFunctionEfface le contenu de l'élément.
copy()EquationFunctionRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getCode()StringRécupère le code correspondant à la fonction d'équation.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()EquationFunction|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()EquationFunction|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)EquationFunctionDéfinit les attributs de l'élément.
setLinkUrl(url)EquationFunctionDéfinit l'URL du lien.
setTextAlignment(textAlignment)EquationFunctionDéfinit l'alignement du texte.

EquationFunctionArgumentSeparator

Méthodes

MéthodeType renvoyéBrève description
copy()EquationFunctionArgumentSeparatorRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()EquationFunctionArgumentSeparator|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()EquationFunctionArgumentSeparator|nullSupprime l'élément de son parent.
setAttributes(attributes)EquationFunctionArgumentSeparatorDéfinit les attributs de l'élément.

EquationSymbol

Méthodes

MéthodeType renvoyéBrève description
copy()EquationSymbolRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getCode()StringRécupère le code correspondant au symbole d'équation.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()EquationSymbol|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()EquationSymbol|nullSupprime l'élément de son parent.
setAttributes(attributes)EquationSymbolDéfinit les attributs de l'élément.

FontFamily

FooterSection

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute le InlineImage donné.
appendListItem(listItem)ListItemAjoute le ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouvel élément ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouvel élément Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouvel Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute le Table donné.
clear()FooterSectionEfface le contenu de l'élément.
copy()FooterSectionRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getImages()InlineImage[]|nullRécupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]|nullRécupère tous les ListItems contenus dans la section.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]|nullRécupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getTables()Table[]|nullRécupère tous les Tables contenus dans la section.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)FooterSectionSupprime l'élément enfant spécifié.
removeFromParent()FooterSection|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)FooterSectionDéfinit les attributs de l'élément.
setText(text)FooterSectionDéfinit le contenu en tant que texte brut.
setTextAlignment(textAlignment)FooterSectionDéfinit l'alignement du texte.

Footnote

Méthodes

MéthodeType renvoyéBrève description
copy()FootnoteRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getFootnoteContents()FootnoteSection|nullRécupère le contenu de l'élément de note de bas de page.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeFromParent()Footnote|nullSupprime l'élément de son parent.
setAttributes(attributes)FootnoteDéfinit les attributs de l'élément.

FootnoteSection

Méthodes

MéthodeType renvoyéBrève description
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouvel élément Paragraph contenant le contenu textuel spécifié.
clear()FootnoteSectionEfface le contenu de l'élément.
copy()FootnoteSectionRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]|nullRécupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
removeChild(child)FootnoteSectionSupprime l'élément enfant spécifié.
removeFromParent()FootnoteSection|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)FootnoteSectionDéfinit les attributs de l'élément.
setText(text)FootnoteSectionDéfinit le contenu en tant que texte brut.
setTextAlignment(textAlignment)FootnoteSectionDéfinit l'alignement du texte.

GlyphType

Propriétés

PropriétéTypeDescription
BULLETEnumLa puce par défaut, circulaire et pleine.
HOLLOW_BULLETEnumUne puce vide.
SQUARE_BULLETEnumPuce carrée.
NUMBEREnumUne puce numérotée.
LATIN_UPPEREnumPuce latine en majuscule.
LATIN_LOWEREnumPuce latine minuscule.
ROMAN_UPPEREnumPuce majuscule avec un chiffre romain.
ROMAN_LOWEREnumUn chiffre romain, une puce en minuscules.

HeaderSection

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute le InlineImage donné.
appendListItem(listItem)ListItemAjoute le ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouvel élément ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouvel élément Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouvel Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute le Table donné.
clear()HeaderSectionEfface le contenu de l'élément.
copy()HeaderSectionRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getImages()InlineImage[]|nullRécupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]|nullRécupère tous les ListItems contenus dans la section.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]|nullRécupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getTables()Table[]|nullRécupère tous les Tables contenus dans la section.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)HeaderSectionSupprime l'élément enfant spécifié.
removeFromParent()HeaderSection|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)HeaderSectionDéfinit les attributs de l'élément.
setText(text)HeaderSectionDéfinit le contenu en tant que texte brut.
setTextAlignment(textAlignment)HeaderSectionDéfinit l'alignement du texte.

HorizontalAlignment

Propriétés

PropriétéTypeDescription
LEFTEnumOption d'alignement à gauche.
CENTEREnumOption d'alignement au centre.
RIGHTEnumOption d'alignement à droite.
JUSTIFYEnumOption d'alignement justifié.

HorizontalRule

Méthodes

MéthodeType renvoyéBrève description
copy()HorizontalRuleRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeFromParent()HorizontalRule|nullSupprime l'élément de son parent.
setAttributes(attributes)HorizontalRuleDéfinit les attributs de l'élément.

InlineDrawing

Méthodes

MéthodeType renvoyéBrève description
copy()InlineDrawingRenvoie une copie détachée et complète de l'élément actuel.
getAltDescription()String|nullRenvoie la description alternative du dessin.
getAltTitle()String|nullRenvoie le titre alternatif du dessin.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()InlineDrawing|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()InlineDrawing|nullSupprime l'élément de son parent.
setAltDescription(description)InlineDrawingDéfinit la description alternative du dessin.
setAltTitle(title)InlineDrawingDéfinit le titre alternatif du dessin.
setAttributes(attributes)InlineDrawingDéfinit les attributs de l'élément.

InlineImage

Méthodes

MéthodeType renvoyéBrève description
copy()InlineImageRenvoie une copie détachée et complète de l'élément actuel.
getAltDescription()String|nullRenvoie la description alternative de l'image.
getAltTitle()String|nullRenvoie le titre alternatif de l'image.
getAs(contentType)BlobRenvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getAttributes()ObjectRécupère les attributs de l'élément.
getBlob()BlobRenvoie les données de cet objet sous forme de blob.
getHeight()IntegerRécupère la hauteur de l'image, en pixels.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
getWidth()IntegerRécupère la largeur de l'image, en pixels.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()InlineImage|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()InlineImage|nullSupprime l'élément de son parent.
setAltDescription(description)InlineImageDéfinit la description alternative de l'image.
setAltTitle(title)InlineImageDéfinit le titre alternatif de l'image.
setAttributes(attributes)InlineImageDéfinit les attributs de l'élément.
setHeight(height)InlineImageDéfinit la hauteur de l'image, en pixels.
setLinkUrl(url)InlineImageDéfinit l'URL du lien.
setWidth(width)InlineImageDéfinit la largeur de l'image, en pixels.

ListItem

Méthodes

MéthodeType renvoyéBrève description
addPositionedImage(image)PositionedImageCrée et insère un PositionedImage à partir du blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute le InlineImage donné.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak donné.
appendText(text)TextCrée et ajoute un élément Text avec le contenu spécifié.
appendText(text)TextAjoute l'élément Text donné.
clear()ListItemEfface le contenu de l'élément.
copy()ListItemRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAlignment()HorizontalAlignment|nullRécupère le HorizontalAlignment.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getGlyphType()GlyphType|nullRécupère le GlyphType de l'élément de liste.
getHeading()ParagraphHeading|nullRécupère le ParagraphHeading.
getIndentEnd()Number|nullRécupère l'indentation de fin, en points.
getIndentFirstLine()Number|nullRécupère la mise en retrait de la première ligne, en points.
getIndentStart()Number|nullRécupère l'indentation de début.
getLineSpacing()Number|nullRécupère l'interligne, en points.
getLinkUrl()String|nullRécupère l'URL du lien.
getListId()String|nullRécupère l'ID de la liste.
getNestingLevel()IntegerRécupère le niveau d'imbrication de l'élément de liste.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPositionedImage(id)PositionedImageObtient un PositionedImage par l'ID de l'image.
getPositionedImages()PositionedImage[]Récupère tous les objets PositionedImage ancrés au paragraphe.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getSpacingAfter()Number|nullRécupère l'espacement après l'élément, en points.
getSpacingBefore()Number|nullRécupère l'espacement avant l'élément, en points.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertText(childIndex, text)TextCrée et insère un élément de texte à l'index spécifié.
insertText(childIndex, text)TextInsère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isLeftToRight()Boolean|nullRécupère le paramètre de gauche à droite.
merge()ListItem|nullFusionne l'élément avec l'élément frère précédent du même type.
removeChild(child)ListItemSupprime l'élément enfant spécifié.
removeFromParent()ListItem|nullSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un PositionedImage par l'ID de l'image.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAlignment(alignment)ListItemDéfinit HorizontalAlignment.
setAttributes(attributes)ListItemDéfinit les attributs de l'élément.
setGlyphType(glyphType)ListItemDéfinit le GlyphType de l'élément de liste.
setHeading(heading)ListItemDéfinit ParagraphHeading.
setIndentEnd(indentEnd)ListItemDéfinit le retrait de fin, en points.
setIndentFirstLine(indentFirstLine)ListItemDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ListItemDéfinit le retrait de début, en points.
setLeftToRight(leftToRight)ListItemDéfinit le paramètre de gauche à droite.
setLineSpacing(multiplier)ListItemDéfinit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.
setLinkUrl(url)ListItemDéfinit l'URL du lien.
setListId(listItem)ListItemDéfinit l'ID de la liste.
setNestingLevel(nestingLevel)ListItemDéfinit le niveau d'imbrication de l'élément de liste.
setSpacingAfter(spacingAfter)ListItemDéfinit l'espacement après l'élément, en points.
setSpacingBefore(spacingBefore)ListItemDéfinit l'espacement avant l'élément, en points.
setText(text)voidDéfinit le contenu de l'élément de liste en tant que texte.
setTextAlignment(textAlignment)ListItemDéfinit l'alignement du texte.

NamedRange

Méthodes

MéthodeType renvoyéBrève description
getId()StringObtient l'ID de ce NamedRange.
getName()StringRécupère le nom de cet objet NamedRange.
getRange()RangeObtient la plage d'éléments associée à cette NamedRange.
remove()voidSupprime ce NamedRange de l'onglet.

PageBreak

Méthodes

MéthodeType renvoyéBrève description
copy()PageBreakRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeFromParent()PageBreak|nullSupprime l'élément de son parent.
setAttributes(attributes)PageBreakDéfinit les attributs de l'élément.

Paragraph

Méthodes

MéthodeType renvoyéBrève description
addPositionedImage(image)PositionedImageCrée et insère un PositionedImage à partir du blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute le InlineImage donné.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak donné.
appendText(text)TextCrée et ajoute un élément Text avec le contenu spécifié.
appendText(text)TextAjoute l'élément Text donné.
clear()ParagraphEfface le contenu de l'élément.
copy()ParagraphRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAlignment()HorizontalAlignment|nullRécupère le HorizontalAlignment.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getHeading()ParagraphHeading|nullRécupère le ParagraphHeading.
getIndentEnd()Number|nullRécupère l'indentation de fin, en points.
getIndentFirstLine()Number|nullRécupère la mise en retrait de la première ligne, en points.
getIndentStart()Number|nullRécupère l'indentation de début.
getLineSpacing()Number|nullRécupère l'interligne, en points.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPositionedImage(id)PositionedImageObtient un PositionedImage par l'ID de l'image.
getPositionedImages()PositionedImage[]Récupère tous les objets PositionedImage ancrés au paragraphe.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getSpacingAfter()Number|nullRécupère l'espacement après l'élément, en points.
getSpacingBefore()Number|nullRécupère l'espacement avant l'élément, en points.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertText(childIndex, text)TextCrée et insère un élément de texte à l'index spécifié.
insertText(childIndex, text)TextInsère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isLeftToRight()Boolean|nullRécupère le paramètre de gauche à droite.
merge()Paragraph|nullFusionne l'élément avec l'élément frère précédent du même type.
removeChild(child)ParagraphSupprime l'élément enfant spécifié.
removeFromParent()Paragraph|nullSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un PositionedImage par l'ID de l'image.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAlignment(alignment)ParagraphDéfinit HorizontalAlignment.
setAttributes(attributes)ParagraphDéfinit les attributs de l'élément.
setHeading(heading)ParagraphDéfinit ParagraphHeading.
setIndentEnd(indentEnd)ParagraphDéfinit le retrait de fin, en points.
setIndentFirstLine(indentFirstLine)ParagraphDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ParagraphDéfinit le retrait de début, en points.
setLeftToRight(leftToRight)ParagraphDéfinit le paramètre de gauche à droite.
setLineSpacing(multiplier)ParagraphDéfinit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.
setLinkUrl(url)ParagraphDéfinit l'URL du lien.
setSpacingAfter(spacingAfter)ParagraphDéfinit l'espacement après l'élément, en points.
setSpacingBefore(spacingBefore)ParagraphDéfinit l'espacement avant l'élément, en points.
setText(text)voidDéfinit le contenu du paragraphe sous forme de texte.
setTextAlignment(textAlignment)ParagraphDéfinit l'alignement du texte.

ParagraphHeading

Propriétés

PropriétéTypeDescription
NORMALEnumOption d'en-tête pour le texte normal.
HEADING1EnumOption d'en-tête la plus élevée.
HEADING2EnumLa deuxième option de titre.
HEADING3EnumTroisième option de titre
HEADING4EnumQuatrième option de titre.
HEADING5EnumCinquième option d'en-tête.
HEADING6EnumOption de titre la plus basse.
TITLEEnumOption d'en-tête de titre.
SUBTITLEEnumOption d'en-tête de sous-titre.

Person

Méthodes

MéthodeType renvoyéBrève description
copy()PersonRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getEmail()StringRenvoie l'adresse e-mail de la personne.
getName()String|nullRenvoie le nom à afficher de la personne, s'il est défini.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()Person|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()Person|nullSupprime l'élément de son parent.
setAttributes(attributes)PersonDéfinit les attributs de l'élément.

Position

Méthodes

MéthodeType renvoyéBrève description
getElement()ElementRécupère l'élément qui contient ce Position.
getOffset()IntegerObtient l'emplacement relatif de ce Position dans l'élément qui le contient.
getSurroundingText()TextCrée un élément Text artificiel qui représente le texte et la mise en forme de Paragraph ou ListItem contenant Position, directement ou via une chaîne d'éléments enfants.
getSurroundingTextOffset()IntegerObtient le décalage de ce Position dans l'élément Text renvoyé par getSurroundingText().
insertBookmark()BookmarkCrée et insère un Bookmark à ce Position.
insertInlineImage(image)InlineImage|nullCrée et insère un InlineImage à ce Position à partir du blob d'image spécifié.
insertText(text)Text|nullInsère le texte spécifié à cet Position.

PositionedImage

Méthodes

MéthodeType renvoyéBrève description
getAs(contentType)BlobRenvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
getBlob()BlobRenvoie les données de cet objet sous forme de blob.
getHeight()IntegerRécupère la hauteur de l'image, en pixels.
getId()StringRécupère l'ID de l'image.
getLayout()PositionedLayoutObtient une valeur enum qui représente la mise en page de l'image.
getLeftOffset()NumberRécupère le décalage de l'image, en points, par rapport à la gauche du paragraphe.
getParagraph()ParagraphRécupère le Paragraph auquel l'image est ancrée.
getTopOffset()NumberRécupère le décalage de l'image, en points, par rapport au haut du paragraphe.
getWidth()IntegerRécupère la largeur de l'image, en pixels.
setHeight(height)PositionedImageDéfinit la hauteur de l'image, en pixels.
setLayout(layout)PositionedImageDéfinit la façon dont l'image est mise en page.
setLeftOffset(offset)PositionedImageDéfinit le décalage de l'image, en points, par rapport à la gauche du paragraphe.
setTopOffset(offset)PositionedImageDéfinit le décalage de l'image, en points, par rapport au haut du paragraphe.
setWidth(width)PositionedImageDéfinit la largeur de l'image, en pixels.

PositionedLayout

Propriétés

PropriétéTypeDescription
ABOVE_TEXTEnumL'image est placée au-dessus du texte.
BREAK_BOTHEnumL'image interrompt le texte à gauche et à droite.
BREAK_LEFTEnumL'image interrompt le texte à gauche.
BREAK_RIGHTEnumL'image coupe le texte à droite.
WRAP_TEXTEnumLe texte entoure l'image.

Range

Méthodes

MéthodeType renvoyéBrève description
getRangeElements()RangeElement[]Obtient tous les éléments de ce Range, y compris les éléments Text partiels (par exemple, dans le cas d'une sélection qui n'inclut qu'une partie d'un élément Text).

RangeBuilder

Méthodes

MéthodeType renvoyéBrève description
addElement(element)RangeBuilderAjoute un Element entier à ce RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAjoute un élément Text partiel à ce RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAjoute deux éléments entiers, ainsi que tous les éléments entre eux, à ce RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAjoute deux éléments Text partiels, ainsi que tous les éléments entre eux, à RangeBuilder.
addRange(range)RangeBuilderAjoute le contenu d'un autre Range à ce RangeBuilder.
build()RangeCrée un Range à partir des paramètres appliqués au compilateur.
getRangeElements()RangeElement[]Obtient tous les éléments de ce Range, y compris les éléments Text partiels (par exemple, dans le cas d'une sélection qui n'inclut qu'une partie d'un élément Text).

RangeElement

Méthodes

MéthodeType renvoyéBrève description
getElement()ElementObtient la Element qui correspond à cette RangeElement.
getEndOffsetInclusive()IntegerObtient la position de la fin d'une plage partielle dans l'élément de plage.
getStartOffset()IntegerObtient la position du début d'une plage partielle dans l'élément de plage.
isPartial()BooleanDétermine si cet élément de plage couvre l'intégralité de l'élément ou une sélection partielle des caractères de l'élément.

Méthodes

MéthodeType renvoyéBrève description
copy()RichLinkRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getMimeType()String|nullRenvoie le type MIME du lien, qui est disponible lorsque l'élément est un lien vers un fichier Drive et null dans le cas contraire.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getTitle()StringRenvoie le titre affiché du lien.
getType()ElementTypeRécupère le ElementType de l'élément.
getUrl()StringRenvoie l'URL de la ressource.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()RichLink|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()RichLink|nullSupprime l'élément de son parent.
setAttributes(attributes)RichLinkDéfinit les attributs de l'élément.

Tab

Méthodes

MéthodeType renvoyéBrève description
asDocumentTab()DocumentTabRécupère le contenu de l'onglet sous forme de DocumentTab.
getChildTabs()Tab[]Récupère les onglets enfants imbriqués dans cet onglet.
getId()StringRécupère l'ID de l'onglet.
getIndex()IntegerRécupère l'index (basé sur zéro) de l'onglet dans le parent.
getTitle()StringRécupère le titre de l'onglet.
getType()TabTypeRécupère le type d'onglet.

TabType

Propriétés

PropriétéTypeDescription
DOCUMENT_TABEnumType correspondant à DocumentTab.

Table

Méthodes

MéthodeType renvoyéBrève description
appendTableRow()TableRowCrée et ajoute un TableRow.
appendTableRow(tableRow)TableRowAjoute le TableRow donné.
clear()TableEfface le contenu de l'élément.
copy()TableRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getBorderColor()String|nullRécupère la couleur de la bordure.
getBorderWidth()Number|nullRécupère la largeur de la bordure, en points.
getCell(rowIndex, cellIndex)TableCell|nullRécupère le TableCell aux index de ligne et de cellule spécifiés.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getColumnWidth(columnIndex)Number|nullRécupère la largeur de la colonne de tableau spécifiée, en points.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getNumRows()IntegerRécupère le nombre de TableRows.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getRow(rowIndex)TableRow|nullRécupère le TableRow à l'index de ligne spécifié.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertTableRow(childIndex)TableRowCrée et insère un TableRow à l'index spécifié.
insertTableRow(childIndex, tableRow)TableRowInsère le TableRow donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeChild(child)TableSupprime l'élément enfant spécifié.
removeFromParent()Table|nullSupprime l'élément de son parent.
removeRow(rowIndex)TableRowSupprime le TableRow à l'index de ligne spécifié.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableDéfinit les attributs de l'élément.
setBorderColor(color)TableDéfinit la couleur de la bordure.
setBorderWidth(width)TableDéfinit la largeur de la bordure, en points.
setColumnWidth(columnIndex, width)TableDéfinit la largeur de la colonne spécifiée, en points.
setLinkUrl(url)TableDéfinit l'URL du lien.
setTextAlignment(textAlignment)TableDéfinit l'alignement du texte.

TableCell

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute le InlineImage donné.
appendListItem(listItem)ListItemAjoute le ListItem donné.
appendListItem(text)ListItemCrée et ajoute un ListItem.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouvel Table contenant les cellules spécifiées.
appendTable(table)TableAjoute le Table donné.
clear()TableCellEfface le contenu de l'élément.
copy()TableCellRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getBackgroundColor()String|nullRécupère la couleur d'arrière-plan.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getColSpan()IntegerRécupère l'étendue de la colonne, qui correspond au nombre de colonnes de cellules de tableau couvertes par cette cellule.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getPaddingBottom()Number|nullRécupère la marge intérieure inférieure, en points.
getPaddingLeft()Number|nullRécupère la marge intérieure de gauche, en points.
getPaddingRight()Number|nullRécupère la marge intérieure de droite, en points.
getPaddingTop()Number|nullRécupère la marge intérieure supérieure, en points.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getParentRow()TableRow|nullRécupère le TableRow contenant le TableCell actuel.
getParentTable()Table|nullRécupère le Table contenant le TableCell actuel.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getRowSpan()IntegerRécupère le nombre de lignes de cellules de tableau couvertes par cette cellule.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
getVerticalAlignment()VerticalAlignment|nullRécupère le VerticalAlignment.
getWidth()Number|nullRécupère la largeur de la colonne contenant la cellule, en points.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir du blob d'image spécifié, à l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem à l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph à l'index spécifié.
insertTable(childIndex)TableCrée et insère un Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableCell|nullFusionne l'élément avec l'élément frère précédent du même type.
removeChild(child)TableCellSupprime l'élément enfant spécifié.
removeFromParent()TableCell|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableCellDéfinit les attributs de l'élément.
setBackgroundColor(color)TableCellDéfinit la couleur d'arrière-plan.
setLinkUrl(url)TableCellDéfinit l'URL du lien.
setPaddingBottom(paddingBottom)TableCellDéfinit la marge intérieure inférieure, en points.
setPaddingLeft(paddingLeft)TableCellDéfinit la marge intérieure gauche, en points.
setPaddingRight(paddingRight)TableCellDéfinit la marge intérieure de droite, en points.
setPaddingTop(paddingTop)TableCellDéfinit la marge intérieure supérieure, en points.
setText(text)TableCellDéfinit le contenu en tant que texte brut.
setTextAlignment(textAlignment)TableCellDéfinit l'alignement du texte.
setVerticalAlignment(alignment)TableCellDéfinit l'alignement vertical.
setWidth(width)TableCellDéfinit la largeur de la colonne contenant la cellule actuelle, en points.

TableOfContents

Méthodes

MéthodeType renvoyéBrève description
clear()TableOfContentsEfface le contenu de l'élément.
copy()TableOfContentsRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getLinkUrl()String|nullRécupère l'URL du lien.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
removeFromParent()TableOfContents|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableOfContentsDéfinit les attributs de l'élément.
setLinkUrl(url)TableOfContentsDéfinit l'URL du lien.
setTextAlignment(textAlignment)TableOfContentsDéfinit l'alignement du texte.

TableRow

Méthodes

MéthodeType renvoyéBrève description
appendTableCell()TableCellCrée et ajoute un TableCell.
appendTableCell(textContents)TableCellAjoute le TableCell donné contenant le texte spécifié.
appendTableCell(tableCell)TableCellAjoute le TableCell donné.
clear()TableRowEfface le contenu de l'élément.
copy()TableRowRenvoie une copie détachée et complète de l'élément actuel.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findElement(elementType)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElement|nullRecherche dans le contenu de l'élément un descendant du type spécifié, en commençant par le RangeElement spécifié.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getCell(cellIndex)TableCell|nullRécupère le TableCell à l'index de cellule spécifié.
getChild(childIndex)ElementRécupère l'élément enfant à l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant pour l'élément enfant spécifié.
getLinkUrl()String|nullRécupère l'URL du lien.
getMinimumHeight()Number|nullRécupère la hauteur minimale, en points.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getNumCells()IntegerRécupère le nombre de cellules dans la ligne.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getParentTable()Table|nullRécupère le Table contenant la ligne actuelle.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertTableCell(childIndex)TableCellCrée et insère un TableCell à l'index spécifié.
insertTableCell(childIndex, textContents)TableCellInsère le TableCell donné à l'index spécifié, contenant le texte donné.
insertTableCell(childIndex, tableCell)TableCellInsère le TableCell donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableRow|nullFusionne l'élément avec l'élément frère précédent du même type.
removeCell(cellIndex)TableCellSupprime le TableCell à l'index de cellule spécifié.
removeChild(child)TableRowSupprime l'élément enfant spécifié.
removeFromParent()TableRow|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableRowDéfinit les attributs de l'élément.
setLinkUrl(url)TableRowDéfinit l'URL du lien.
setMinimumHeight(minHeight)TableRowDéfinit la hauteur minimale, en points.
setTextAlignment(textAlignment)TableRowDéfinit l'alignement du texte.

Text

Méthodes

MéthodeType renvoyéBrève description
appendText(text)TextAjoute le texte spécifié à la fin de cette région de texte.
copy()TextRenvoie une copie détachée et complète de l'élément actuel.
deleteText(startOffset, endOffsetInclusive)TextSupprime une plage de texte.
editAsText()TextObtient une version Text de l'élément actuel, pour la modification.
findText(searchPattern)RangeElement|nullRecherche le contenu de l'élément correspondant au modèle de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElement|nullRecherche le contenu de l'élément pour trouver le modèle de texte spécifié, en commençant par un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getAttributes(offset)ObjectRécupère les attributs à l'offset de caractère spécifié.
getBackgroundColor()String|nullRécupère le paramètre de couleur d'arrière-plan.
getBackgroundColor(offset)String|nullRécupère la couleur d'arrière-plan à l'offset de caractère spécifié.
getFontFamily()String|nullRécupère le paramètre de la famille de polices.
getFontFamily(offset)String|nullRécupère la famille de polices à l'offset de caractère spécifié.
getFontSize()Number|nullRécupère le paramètre de taille de police.
getFontSize(offset)Number|nullRécupère la taille de la police à l'offset de caractère spécifié.
getForegroundColor()String|nullRécupère le paramètre de couleur du premier plan.
getForegroundColor(offset)String|nullRécupère la couleur de premier plan à l'offset de caractère spécifié.
getLinkUrl()String|nullRécupère l'URL du lien.
getLinkUrl(offset)String|nullRécupère l'URL du lien à l'offset de caractère spécifié.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignment|nullRécupère l'alignement du texte.
getTextAlignment(offset)TextAlignment|nullRécupère l'alignement du texte pour un seul caractère.
getTextAttributeIndices()Integer[]Récupère l'ensemble des index de texte qui correspondent au début des différentes exécutions de mise en forme du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertText(offset, text)TextInsère le texte spécifié au décalage de caractère donné.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isBold()Boolean|nullRécupère le paramètre de mise en gras.
isBold(offset)Boolean|nullRécupère le paramètre de mise en gras à l'offset de caractère spécifié.
isItalic()Boolean|nullRécupère le paramètre d'italique.
isItalic(offset)Boolean|nullRécupère le paramètre d'italique à l'offset de caractère spécifié.
isStrikethrough()Boolean|nullRécupère le paramètre de texte barré.
isStrikethrough(offset)Boolean|nullRécupère le paramètre de mise en forme barrée à l'offset de caractère spécifié.
isUnderline()Boolean|nullRécupère le paramètre de soulignement.
isUnderline(offset)Boolean|nullRécupère le paramètre de soulignement à l'offset de caractère spécifié.
merge()Text|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()Text|nullSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(startOffset, endOffsetInclusive, attributes)TextApplique les attributs spécifiés à la plage de caractères donnée.
setAttributes(attributes)TextDéfinit les attributs de l'élément.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextDéfinit la couleur d'arrière-plan pour la plage de caractères spécifiée.
setBackgroundColor(color)TextDéfinit la couleur d'arrière-plan.
setBold(bold)TextDéfinit le paramètre de mise en gras.
setBold(startOffset, endOffsetInclusive, bold)TextDéfinit le paramètre de mise en gras pour la plage de caractères spécifiée.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextDéfinit la famille de polices pour la plage de caractères spécifiée.
setFontFamily(fontFamilyName)TextDéfinit la famille de polices.
setFontSize(startOffset, endOffsetInclusive, size)TextDéfinit la taille de police pour la plage de caractères spécifiée.
setFontSize(size)TextDéfinit la taille de la police.
setForegroundColor(startOffset, endOffsetInclusive, color)TextDéfinit la couleur de premier plan pour la plage de caractères spécifiée.
setForegroundColor(color)TextDéfinit la couleur de premier plan.
setItalic(italic)TextDéfinit le paramètre d'italique.
setItalic(startOffset, endOffsetInclusive, italic)TextDéfinit le paramètre d'italique pour la plage de caractères spécifiée.
setLinkUrl(startOffset, endOffsetInclusive, url)TextDéfinit l'URL du lien pour la plage de caractères spécifiée.
setLinkUrl(url)TextDéfinit l'URL du lien.
setStrikethrough(strikethrough)TextDéfinit le paramètre de mise en forme barrée.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextDéfinit le paramètre de mise en forme barrée pour la plage de caractères spécifiée.
setText(text)TextDéfinit le contenu textuel.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextDéfinit l'alignement du texte pour une plage de caractères donnée.
setTextAlignment(textAlignment)TextDéfinit l'alignement du texte.
setUnderline(underline)TextDéfinit le paramètre de soulignement.
setUnderline(startOffset, endOffsetInclusive, underline)TextDéfinit le paramètre de soulignement pour la plage de caractères spécifiée.

TextAlignment

Propriétés

PropriétéTypeDescription
NORMALEnumAlignement normal du texte.
SUPERSCRIPTEnumAlignement du texte en exposant.
SUBSCRIPTEnumAlignement du texte en indice.

UnsupportedElement

Méthodes

MéthodeType renvoyéBrève description
copy()UnsupportedElementRenvoie une copie détachée et complète de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()Element|nullRécupère l'élément frère suivant de l'élément.
getParent()ContainerElement|nullRécupère l'élément parent de l'élément.
getPreviousSibling()Element|nullRécupère l'élément frère précédent de l'élément.
getType()ElementTypeRécupère le ElementType de l'élément.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()UnsupportedElement|nullFusionne l'élément avec l'élément frère précédent du même type.
removeFromParent()UnsupportedElement|nullSupprime l'élément de son parent.
setAttributes(attributes)UnsupportedElementDéfinit les attributs de l'élément.

VerticalAlignment

Propriétés

PropriétéTypeDescription
BOTTOMEnumOption d'alignement en bas
CENTEREnumOption d'alignement au centre.
TOPEnumOption d'alignement en haut.