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 des Documents pouvant être modifiés.
DocumentTabOnglet 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 une Equation mathématique.
EquationFunctionArgumentSeparatorÉlément représentant un séparateur de fonction dans une Equation mathématique.
EquationSymbolÉlément représentant un symbole dans une 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 compatibles.
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 ligne 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.
NamedRangeRange avec un nom et un ID permettant de le récupérer 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 en position fixe ancrée à un Paragraph.
PositionedLayoutÉnumération qui spécifie comment mettre en page un PositionedImage par rapport au texte environnant.
RangePlage d'éléments dans un document.
RangeBuilderCompilateur utilisé pour créer des objets Range à partir d'éléments de document.
RangeElementEncapsulement 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, comme un fichier Drive ou une vidéo YouTube.
TabOnglet d'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 zone de texte enrichi.
TextAlignmentÉnumération des types d'alignements de 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_SIZEEnumParamètre de taille de 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 Image.
HORIZONTAL_ALIGNMENTEnumAlignement horizontal, pour les é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 la 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 d'élément de liste.
LEFT_TO_RIGHTEnumParamètre d'orientation du texte, pour le texte enrichi.
LINE_SPACINGEnumParamètre d'espacement des lignes 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 la marge gauche en points, pour les éléments de paragraphe.
MARGIN_RIGHTEnumParamètre de la marge 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 des éléments, pour les éléments d'é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 à gauche, en points, pour les éléments de cellule de tableau.
PADDING_RIGHTEnumParamètre de marge intérieure approprié 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 en bas, en points, pour les éléments de paragraphe.
SPACING_BEFOREEnumParamètre d'espacement en haut, en points, pour les éléments de paragraphe.
STRIKETHROUGHEnumParamètre de barrer le texte, 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 objet 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 contenant le contenu textuel spécifié.
appendPageBreak()PageBreakCrée et ajoute un objet PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute le PageBreak donné.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un objet Table.
appendTable(cells)TableAjoute un nouvel élément Table contenant un élément 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getHeadingAttributes(paragraphHeading)ObjectRécupère l'ensemble d'attributs pour l'ParagraphHeading fournie.
getImages()InlineImage[]Récupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]Récupère tous les ListItems contenus dans la section.
getMarginBottom()NumberRécupère la marge inférieure, en points.
getMarginLeft()NumberRécupère la marge de gauche, en points.
getMarginRight()NumberRécupère la marge de droite.
getMarginTop()NumberRécupère la marge supérieure.
getNumChildren()IntegerRécupère le nombre d'enfants.
getPageHeight()NumberRécupère la hauteur de la page, en points.
getPageWidth()NumberRécupère la largeur de la page, en points.
getParagraphs()Paragraph[]Récupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElementRécupère l'élément parent de l'élément.
getTables()Table[]Ré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()TextAlignmentRé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 l'InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère l'ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un nouvel élément ListItem à 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 l'PageBreak donné à l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère l'Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouvel élément Paragraph à 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 l'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 de l'ParagraphHeading fournie.
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 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 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 de l'Bookmark dans le DocumentTab.
remove()voidSupprime la 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 en tant que 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()TextAlignmentRé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()ContainerElementFusionne l'élément avec le frère précédent de même type.
removeFromParent()ContainerElementSupprime 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 profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getDisplayText()StringRenvoie la valeur d'affichage affichée dans le document.
getLocale()StringRenvoie les paramètres régionaux de la date utilisés pour la valeur à afficher.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getTimestamp()DateRenvoie l'horodatage 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()DateFusionne l'élément avec le frère précédent de même type.
removeFromParent()DateSupprime 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 à l'Position donnée dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs de l'Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs de l'Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des éditeurs de l'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 l'Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des spectateurs de l'Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des spectateurs de l'Document.
getActiveTab()TabRécupère l'Tab actuellement actif de l'utilisateur dans le document.
getAs(contentType)BlobRécupère le contenu actuel de Document sous forme de blob du type spécifié.
getBlob()BlobRécupère le contenu actuel de Document sous forme de blob.
getBody()BodyRécupère l'Body du premier onglet ou, pour les scripts liés à un document, l'DocumentBodySection de l'onglet actif.
getBookmark(id)BookmarkRécupère l'Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getCursor()PositionRécupère le curseur de l'utilisateur dans l'onglet actif.
getEditors()User[]Récupère la liste des éditeurs de cet objet Document.
getFooter()FooterSectionRé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[]Récupère tous les éléments Footnote dans le corps du premier onglet ou, pour les scripts liés à un document, dans le corps de l'onglet actif.
getHeader()HeaderSectionRé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)NamedRangeRécupère l'NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getNamedRanges()NamedRange[]Récupère tous les objets NamedRange dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getNamedRanges(name)NamedRange[]Récupère tous les objets NamedRange portant le nom donné dans le premier onglet ou, pour les scripts liés à un document, dans l'onglet actif.
getSelection()RangeRécupère 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[]Récupère 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[]Récupère la liste des lecteurs et des commentateurs de cet 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 dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
newRange()RangeBuilderCrée un compilateur utilisé pour créer des objets Range à partir d'éléments d'onglet dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
removeEditor(emailAddress)DocumentSupprime l'utilisateur donné de la liste des éditeurs de l'Document.
removeEditor(user)DocumentSupprime l'utilisateur donné de la liste des éditeurs de l'Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'Document.
removeViewer(user)DocumentSupprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'Document.
saveAndClose()voidEnregistre la Document actuelle.
setActiveTab(tabId)voidDéfinit l'Tab sélectionnée par l'utilisateur dans le document actuel sur l'onglet avec l'ID spécifié.
setCursor(position)DocumentDéfinit le curseur de l'utilisateur, à partir 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, à partir 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 affiche 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 indiqué.
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 à l'Position spécifié.
addFooter()FooterSectionAjoute une section de pied de page d'onglet, si aucune n'existe.
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)BookmarkRécupère le Bookmark avec l'ID donné.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark de l'onglet.
getFooter()FooterSectionRécupère la section de pied de page de l'onglet, le cas échéant.
getFootnotes()Footnote[]Récupère tous les éléments Footnote dans le corps de l'onglet.
getHeader()HeaderSectionRécupère la section d'en-tête de l'onglet, le cas échéant.
getNamedRangeById(id)NamedRangeRé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 donné.
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 permettant de créer 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 en tant que 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 sous forme de 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 profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()ElementFusionne l'élément avec le frère précédent de même type.
removeFromParent()ElementSupprime 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()TextAlignmentRé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()EquationFusionne l'élément avec le frère précédent de même type.
removeFromParent()EquationSupprime 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getCode()StringRécupère le code correspondant à la fonction d'équation.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()TextAlignmentRé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()EquationFunctionFusionne l'élément avec le frère précédent de même type.
removeFromParent()EquationFunctionSupprime 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 profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()EquationFunctionArgumentSeparatorFusionne l'élément avec le frère précédent de même type.
removeFromParent()EquationFunctionArgumentSeparatorSupprime 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 profonde dissociée 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()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()EquationSymbolFusionne l'élément avec le frère précédent de même type.
removeFromParent()EquationSymbolSupprime 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 objet 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 contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un objet Table.
appendTable(cells)TableAjoute un nouvel élément Table contenant un élément 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getImages()InlineImage[]Récupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]Récupère tous les ListItems contenus dans la section.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]Récupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElementRécupère l'élément parent de l'élément.
getTables()Table[]Ré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()TextAlignmentRé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 l'InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère l'ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un nouvel élément ListItem à l'index spécifié, contenant le contenu textuel spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère l'Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouvel élément Paragraph à 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 l'Table donné à l'index spécifié.
removeChild(child)FooterSectionSupprime l'élément enfant spécifié.
removeFromParent()FooterSectionSupprime 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 texte brut.
setTextAlignment(textAlignment)FooterSectionDéfinit l'alignement du texte.

Footnote

Méthodes

MéthodeType renvoyéBrève description
copy()FootnoteRenvoie une copie profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getFootnoteContents()FootnoteSectionRécupère le contenu de l'élément de note de bas de page.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()FootnoteSupprime 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 Paragraph contenant le contenu textuel spécifié.
clear()FootnoteSectionEfface le contenu de l'élément.
copy()FootnoteSectionRenvoie une copie profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]Récupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()TextAlignmentRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
insertParagraph(childIndex, paragraph)ParagraphInsère l'Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouvel élément Paragraph à l'index spécifié, contenant le contenu textuel spécifié.
removeChild(child)FootnoteSectionSupprime l'élément enfant spécifié.
removeFromParent()FootnoteSectionSupprime 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 texte brut.
setTextAlignment(textAlignment)FootnoteSectionDéfinit l'alignement du texte.

GlyphType

Propriétés

PropriétéTypeDescription
BULLETEnumPuce circulaire et remplie par défaut.
HOLLOW_BULLETEnumUne balle creuse.
SQUARE_BULLETEnumPuce carrée.
NUMBEREnumPuces basées sur des nombres
LATIN_UPPEREnumPoint d'exclamation majuscule latin.
LATIN_LOWEREnumPoint d'exclamation en minuscules latines.
ROMAN_UPPEREnumChiffre romain, puce majuscule.
ROMAN_LOWEREnumChiffre romain, puce minuscule.

HeaderSection

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un objet 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 contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un objet Table.
appendTable(cells)TableAjoute un nouvel élément Table contenant un élément 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getImages()InlineImage[]Récupère tous les InlineImages contenus dans la section.
getListItems()ListItem[]Récupère tous les ListItems contenus dans la section.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParagraphs()Paragraph[]Récupère tous les Paragraphs contenus dans la section (y compris ListItems).
getParent()ContainerElementRécupère l'élément parent de l'élément.
getTables()Table[]Ré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()TextAlignmentRé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 l'InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère l'ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un nouvel élément ListItem à l'index spécifié, contenant le contenu textuel spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère l'Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouvel élément Paragraph à 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 l'Table donné à l'index spécifié.
removeChild(child)HeaderSectionSupprime l'élément enfant spécifié.
removeFromParent()HeaderSectionSupprime 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 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.
JUSTIFYEnumL'option justify-alignment.

HorizontalRule

Méthodes

MéthodeType renvoyéBrève description
copy()HorizontalRuleRenvoie une copie profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()HorizontalRuleSupprime 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 profonde dissociée de l'élément actuel.
getAltDescription()StringRenvoie la description alternative du dessin.
getAltTitle()StringRenvoie le titre alternatif du dessin.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()InlineDrawingFusionne l'élément avec le frère précédent de même type.
removeFromParent()InlineDrawingSupprime 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 profonde dissociée de l'élément actuel.
getAltDescription()StringRenvoie la description alternative de l'image.
getAltTitle()StringRenvoie 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()BlobRenvoyez les données de cet objet sous forme de blob.
getHeight()IntegerRécupère la hauteur de l'image, en pixels.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()InlineImageFusionne l'élément avec le frère précédent de même type.
removeFromParent()InlineImageSupprime 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 objet 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 objet 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAlignment()HorizontalAlignmentRécupère 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 de l'élément enfant pour l'élément enfant spécifié.
getGlyphType()GlyphTypeRécupère le GlyphType de l'élément de liste.
getHeading()ParagraphHeadingRécupère ParagraphHeading.
getIndentEnd()NumberRécupère l'indentation de fin, en points.
getIndentFirstLine()NumberRécupère la mise en retrait de la première ligne, en points.
getIndentStart()NumberRécupère l'indentation de début.
getLineSpacing()NumberRécupère l'interligne, en points.
getLinkUrl()StringRécupère l'URL du lien.
getListId()StringRécupère l'ID de la liste.
getNestingLevel()IntegerRécupère le niveau d'imbrication de l'élément de liste.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPositionedImage(id)PositionedImageRécupère un PositionedImage par l'ID de l'image.
getPositionedImages()PositionedImage[]Récupère tous les objets PositionedImage ancrés au paragraphe.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getSpacingAfter()NumberRécupère l'espacement après l'élément, en points.
getSpacingBefore()NumberRé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()TextAlignmentRé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 l'InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère l'PageBreak donné à l'index spécifié.
insertText(childIndex, text)TextCrée et insère un élément de texte à l'indice 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()BooleanRécupère le paramètre de gauche à droite.
merge()ListItemFusionne l'élément avec le frère précédent de même type.
removeChild(child)ListItemSupprime l'élément enfant spécifié.
removeFromParent()ListItemSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un PositionedImage par 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 l'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'espacement des lignes, en tant que 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()StringRécupère l'ID de cet objet NamedRange.
getName()StringRécupère le nom de cet objet NamedRange.
getRange()RangeRécupère la plage d'éléments associés à cette NamedRange.
remove()voidSupprime cet NamedRange de l'onglet.

PageBreak

Méthodes

MéthodeType renvoyéBrève description
copy()PageBreakRenvoie une copie profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()PageBreakSupprime 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 objet 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 objet 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAlignment()HorizontalAlignmentRécupère 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 de l'élément enfant pour l'élément enfant spécifié.
getHeading()ParagraphHeadingRécupère ParagraphHeading.
getIndentEnd()NumberRécupère l'indentation de fin, en points.
getIndentFirstLine()NumberRécupère la mise en retrait de la première ligne, en points.
getIndentStart()NumberRécupère l'indentation de début.
getLineSpacing()NumberRécupère l'interligne, en points.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPositionedImage(id)PositionedImageRécupère un PositionedImage par l'ID de l'image.
getPositionedImages()PositionedImage[]Récupère tous les objets PositionedImage ancrés au paragraphe.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getSpacingAfter()NumberRécupère l'espacement après l'élément, en points.
getSpacingBefore()NumberRé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()TextAlignmentRé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 l'InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak à l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère l'PageBreak donné à l'index spécifié.
insertText(childIndex, text)TextCrée et insère un élément de texte à l'indice 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()BooleanRécupère le paramètre de gauche à droite.
merge()ParagraphFusionne l'élément avec le frère précédent de même type.
removeChild(child)ParagraphSupprime l'élément enfant spécifié.
removeFromParent()ParagraphSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un PositionedImage par 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'espacement des lignes, en tant que 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 en tant que texte.
setTextAlignment(textAlignment)ParagraphDéfinit l'alignement du texte.

ParagraphHeading

Propriétés

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

Person

Méthodes

MéthodeType renvoyéBrève description
copy()PersonRenvoie une copie profonde dissociée 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()StringRenvoie le nom à afficher de la personne, le cas échéant.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()PersonFusionne l'élément avec le frère précédent de même type.
removeFromParent()PersonSupprime 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 cette Position.
getOffset()IntegerRécupère la position relative de cet élément 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 du Paragraph ou du ListItem contenant le Position, directement ou via une chaîne d'éléments enfants.
getSurroundingTextOffset()IntegerRécupère le décalage de cet élément Position dans l'élément Text renvoyé par getSurroundingText().
insertBookmark()BookmarkCrée et insère un Bookmark à cet emplacement Position.
insertInlineImage(image)InlineImageCrée et insère un InlineImage à cet emplacement Position à partir du blob d'image spécifié.
insertText(text)TextInsère le texte spécifié à cet emplacement 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()BlobRenvoyez 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()PositionedLayoutRécupère une valeur d'énumération 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 mise en page de l'image.
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 coupe le texte à gauche et à droite.
BREAK_LEFTEnumL'image coupe le texte à gauche.
BREAK_RIGHTEnumL'image coupe le texte à droite.
WRAP_TEXTEnumL'image est entourée de texte.

Range

Méthodes

MéthodeType renvoyéBrève description
getRangeElements()RangeElement[]Récupère tous les éléments de cet élément 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 à cet élément RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAjoute deux éléments entiers et tous les éléments situés entre eux à cette RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAjoute deux éléments Text partiels et tous les éléments situés entre eux au 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[]Récupère tous les éléments de cet élément 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()ElementRécupère la Element correspondant à cette RangeElement.
getEndOffsetInclusive()IntegerRécupère la position de fin d'une plage partielle dans l'élément de plage.
getStartOffset()IntegerRécupère la position de début d'une plage partielle dans l'élément de plage.
isPartial()BooleanDétermine si cet élément de plage couvre l'élément entier ou une sélection partielle des caractères de l'élément.

Méthodes

MéthodeType renvoyéBrève description
copy()RichLinkRenvoie une copie profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getMimeType()StringRenvoie 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()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()RichLinkFusionne l'élément avec le frère précédent de même type.
removeFromParent()RichLinkSupprime 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 en tant que 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 en base 0 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 objet TableRow.
appendTableRow(tableRow)TableRowAjoute le TableRow donné.
clear()TableEfface le contenu de l'élément.
copy()TableRenvoie une copie profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getBorderColor()StringRécupère la couleur de la bordure.
getBorderWidth()NumberRécupère la largeur de la bordure, en points.
getCell(rowIndex, cellIndex)TableCellRécupère le TableCell aux indices 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 de l'élément enfant pour l'élément enfant spécifié.
getColumnWidth(columnIndex)NumberRécupère la largeur de la colonne de tableau spécifiée, en points.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRé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()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getRow(rowIndex)TableRowRécupère l'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()TextAlignmentRé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 l'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()TableSupprime l'élément de son parent.
removeRow(rowIndex)TableRowSupprime l'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 objet 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 objet ListItem.
appendParagraph(paragraph)ParagraphAjoute le Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un objet Paragraph.
appendTable()TableCrée et ajoute un objet Table.
appendTable(cells)TableAjoute un nouvel élément 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getBackgroundColor()StringRé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 de l'élément enfant pour l'élément enfant spécifié.
getColSpan()IntegerRécupère la plage de colonnes, c'est-à-dire le nombre de colonnes de cellules de table que cette cellule couvre.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getPaddingBottom()NumberRécupère la marge inférieure, en points.
getPaddingLeft()NumberRécupère la marge intérieure gauche, en points.
getPaddingRight()NumberRécupère la marge intérieure droite, en points.
getPaddingTop()NumberRécupère la marge intérieure supérieure, en points.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getParentRow()TableRowRécupère le TableRow contenant le TableCell actuel.
getParentTable()TableRécupère le Table contenant le TableCell actuel.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getRowSpan()IntegerRécupère la plage de lignes, qui correspond au nombre de lignes de cellules de table couvertes par cette cellule.
getText()StringRécupère le contenu de l'élément sous forme de chaîne de texte.
getTextAlignment()TextAlignmentRécupère l'alignement du texte.
getType()ElementTypeRécupère le ElementType de l'élément.
getVerticalAlignment()VerticalAlignmentRécupère VerticalAlignment.
getWidth()NumberRé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 l'InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère l'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 l'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 l'Table donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableCellFusionne l'élément avec le frère précédent de même type.
removeChild(child)TableCellSupprime l'élément enfant spécifié.
removeFromParent()TableCellSupprime 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 droite, en points.
setPaddingTop(paddingTop)TableCellDéfinit la marge intérieure supérieure, en points.
setText(text)TableCellDéfinit le contenu en 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 active, en points.

TableOfContents

Méthodes

MéthodeType renvoyéBrève description
clear()TableOfContentsEfface le contenu de l'élément.
copy()TableOfContentsRenvoie une copie profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'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 de l'élément enfant pour l'élément enfant spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()TextAlignmentRé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()TableOfContentsSupprime 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 objet 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 profonde dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findElement(elementType)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir de l'RangeElement spécifié.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getCell(cellIndex)TableCellRé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 de l'élément enfant pour l'élément enfant spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getMinimumHeight()NumberRécupère la hauteur minimale, en points.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getNumCells()IntegerRécupère le nombre de cellules de la ligne.
getNumChildren()IntegerRécupère le nombre d'enfants.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getParentTable()TableRécupère l'Table contenant la ligne actuelle.
getPreviousSibling()ElementRé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()TextAlignmentRé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 l'TableCell donné à l'index spécifié, contenant le texte donné.
insertTableCell(childIndex, tableCell)TableCellInsère l'TableCell donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableRowFusionne l'élément avec le frère précédent de même type.
removeCell(cellIndex)TableCellSupprime le TableCell à l'index de cellule spécifié.
removeChild(child)TableRowSupprime l'élément enfant spécifié.
removeFromParent()TableRowSupprime 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 profonde dissociée de l'élément actuel.
deleteText(startOffset, endOffsetInclusive)TextSupprime une plage de texte.
editAsText()TextRécupère une version Text de l'élément actuel, à des fins de modification.
findText(searchPattern)RangeElementRecherche dans le contenu de l'élément le format de texte spécifié à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le motif de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAttributes()ObjectRécupère les attributs de l'élément.
getAttributes(offset)ObjectRécupère les attributs au décalage de caractères spécifié.
getBackgroundColor()StringRécupère le paramètre de couleur d'arrière-plan.
getBackgroundColor(offset)StringRécupère la couleur d'arrière-plan au décalage de caractère spécifié.
getFontFamily()StringRécupère le paramètre de famille de polices.
getFontFamily(offset)StringRécupère la famille de polices au décalage de caractère spécifié.
getFontSize()NumberRécupère le paramètre de taille de police.
getFontSize(offset)NumberRécupère la taille de la police au décalage de caractère spécifié.
getForegroundColor()StringRécupère le paramètre de couleur du premier plan.
getForegroundColor(offset)StringRécupère la couleur de premier plan au décalage de caractère spécifié.
getLinkUrl()StringRécupère l'URL du lien.
getLinkUrl(offset)StringRécupère l'URL du lien au décalage de caractères spécifié.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()TextAlignmentRécupère l'alignement du texte.
getTextAlignment(offset)TextAlignmentRécupère l'alignement du texte pour un seul caractère.
getTextAttributeIndices()Integer[]Récupère l'ensemble des indices de texte qui correspondent au début d'exécutions de mise en forme de texte distinctes.
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()BooleanRécupère le paramètre en gras.
isBold(offset)BooleanRécupère le paramètre en gras au décalage de caractères spécifié.
isItalic()BooleanRécupère le paramètre d'italique.
isItalic(offset)BooleanRécupère le paramètre d'italique au décalage de caractère spécifié.
isStrikethrough()BooleanRécupère le paramètre de barre de soulignement.
isStrikethrough(offset)BooleanRécupère le paramètre de trait en travers au décalage de caractère spécifié.
isUnderline()BooleanRécupère le paramètre de soulignement.
isUnderline(offset)BooleanRécupère le paramètre de soulignement au décalage de caractère spécifié.
merge()TextFusionne l'élément avec le frère précédent de même type.
removeFromParent()TextSupprime 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 de 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 en gras.
setBold(startOffset, endOffsetInclusive, bold)TextDéfinit le paramètre 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 d'avant-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 barre de soulignement.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextDéfinit le paramètre de trait barré 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 exposant.

UnsupportedElement

Méthodes

MéthodeType renvoyéBrève description
copy()UnsupportedElementRenvoie une copie profonde dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getNextSibling()ElementRécupère l'élément frère suivant de l'élément.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getPreviousSibling()ElementRé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()UnsupportedElementFusionne l'élément avec le frère précédent de même type.
removeFromParent()UnsupportedElementSupprime 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.