Document Service

Document

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

// 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
DocumentUn document contenant un ou plusieurs objets Tab, chacun contenant du texte enrichi et tels que des tableaux et des listes.
DocumentAppLe service Documents crée et ouvre un fichier Documents modifiable.
DocumentTabUn onglet de document contenant du texte enrichi et des éléments tels que des tableaux et des listes.
ElementUn é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 note 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 compatibles.
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.
NamedRangeUne Range avec un nom et un ID pour permettre une récupération ultérieure.
PageBreakÉlément représentant un saut de page.
ParagraphÉlément représentant un paragraphe.
ParagraphHeadingÉnumération des en-têtes de paragraphe 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.
PositionedImageCorrection de la position de l'image ancrée à un Paragraph.
PositionedLayoutÉnumération spécifiant comment mettre en page un élément PositionedImage par rapport à l'environnement texte.
RangeUne plage d'éléments dans un document.
RangeBuilderCompilateur utilisé pour construire des objets Range à partir d'éléments de document.
RangeElementUn wrapper 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, comme 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 du tableau.
TextÉlément représentant une zone de texte enrichi.
TextAlignmentÉnumération des types d'alignements de texte.
UnsupportedElementUn élément représentant une région inconnue ou qui ne peut pas être affecté par un script, comme une numéro de page.
VerticalAlignmentÉnumération des types d'alignement vertical compatibles.

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 la police pour le texte enrichi.
BORDER_COLOREnumCouleur de la bordure des éléments du tableau.
BORDER_WIDTHEnumLargeur de la bordure en points pour les éléments du 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 des éléments 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 la première ligne en points, pour les éléments de paragraphe.
INDENT_STARTEnumParamètre de retrait du 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 "Orientation du texte" pour le texte enrichi.
LINE_SPACINGEnumParamètre d'interligne en tant que multiplicateur pour les éléments de paragraphe.
LINK_URLEnumURL du lien, pour le texte enrichi.
LIST_IDEnumID de la liste environnante, pour les éléments d'élément de liste.
MARGIN_BOTTOMEnumMarge inférieure définie en points pour les éléments de paragraphe.
MARGIN_LEFTEnumParamètre de marge gauche en points pour les éléments de paragraphe.
MARGIN_RIGHTEnumMarge droite définie en points pour les éléments de paragraphe.
MARGIN_TOPEnumParamètre de marge supérieure en points des éléments de paragraphe.
NESTING_LEVELEnumNiveau d'imbrication des éléments de liste.
MINIMUM_HEIGHTEnumParamètre de hauteur minimale en points pour les éléments des lignes du tableau.
PADDING_BOTTOMEnumParamètre de marge intérieure inférieure en points, pour les éléments des cellules d'un tableau.
PADDING_LEFTEnumParamètre de marge intérieure gauche en points, pour les éléments des cellules d'un tableau.
PADDING_RIGHTEnumParamètre de marge intérieure droite en points, pour les éléments des cellules d'un tableau.
PADDING_TOPEnumParamètre de marge intérieure supérieure en points, pour les éléments des cellules d'un 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 en haut des éléments de paragraphe.
STRIKETHROUGHEnumParamètre Barré pour le texte enrichi.
UNDERLINEEnumSouligné pour le texte enrichi.
VERTICAL_ALIGNMENTEnumParamètre d'alignement vertical des éléments des cellules du tableau.
WIDTHEnumParamètre de largeur des éléments des cellules du tableau et des images.

Body

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un nouveau HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage donné.
appendListItem(listItem)ListItemAjoute l'élément ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouveau ListItem contenant le contenu textuel spécifié.
appendPageBreak()PageBreakCrée et ajoute un nouveau PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute l'élément PageBreak donné.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouveau Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un nouveau Table.
appendTable(cells)TableAjoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute l'élément Table donné.
clear()BodyEfface le contenu de l'élément.
copy()BodyRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de l'élément enfant spécifié.
getHeadingAttributes(paragraphHeading)ObjectRécupère l'ensemble d'attributs pour l'élément ParagraphHeading fourni.
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 gauche, en points.
getMarginRight()NumberRécupère la marge 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 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 l'ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un nouveau HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un objet InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
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 nouveau ListItem à l'index spécifié, contenant les du texte.
insertPageBreak(childIndex)PageBreakCrée et insère un nouveau 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 nouveau Paragraph à l'index spécifié, contenant les du texte.
insertTable(childIndex)TableCrée et insère un nouveau Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un nouveau 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 format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
setAttributes(attributes)BodyDéfinit les attributs de l'élément.
setHeadingAttributes(paragraphHeading, attributes)BodyDéfinit les attributs pour l'élément ParagraphHeading fourni.
setMarginBottom(marginBottom)BodyDéfinit la marge inférieure, en points.
setMarginLeft(marginLeft)BodyDéfinit la marge 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 de Bookmark.
getPosition()PositionRécupère les Position de Bookmark au sein de DocumentTab.
remove()voidSupprime 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 complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'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 du même type.
removeFromParent()ContainerElementSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 complète et 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 d'affichage.
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 le code temporel associé à la date.
getType()ElementTypeRécupère l'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 du même type.
removeFromParent()DateSupprime l'élément de son parent.
setAttributes(attributes)DateDéfinit les attributs de l'élément.

Document

Les méthodes de la classe Document qui accèdent directement au contenu textuel et le modifient opèrent soit sur l'onglet actif (dans les scripts liés à un document particulier), soit sur le premier onglet (si aucun onglet actif n'est disponible). Les scripts qui s'appuient sur ces méthodes (comme Document.getBody()) peuvent être mis à jour pour prendre en charge les onglets vers l'une des options suivantes:

  • Utiliser le premier onglet: Document.getTabs()[0].asDocumentTab().getBody()
  • Utiliser tous les onglets: parcourez l'arborescence d'onglets à l'aide des boutons Document.getTabs() et Tab.getChildTabs(). Pour chaque onglet de l'arborescence, appelez Tab.asDocumentTab().getBody().
  • Utiliser l'onglet sélectionné: Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
  • Utilisez un onglet spécifique: Document.getTab(TAB_ID).asDocumentTab().getBody()

Pour en savoir plus sur la fonctionnalité des onglets, consultez Utiliser les onglets.

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark au niveau de la Position donnée du premier onglet ou, pour les scripts qui sont lié à un document, l'onglet actif.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs de Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs de Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des éditeurs pour Document.
addFooter()FooterSectionAjoute une section de pied de page, le cas échéant, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addHeader()HeaderSectionAjoute une section d'en-tête, le cas échéant, au premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range dont le nom et l'ID sont à utiliser pour par la suite, 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 lecteurs de Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des lecteurs de Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document.
getActiveTab()TabRécupère les Tab actuellement actifs de l'utilisateur dans le document.
getAs(contentType)BlobRécupère le contenu Document actuel sous la forme d'un 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, le DocumentBodySection de l'onglet actif.
getBookmark(id)BookmarkRécupère le Bookmark avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark du 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 pour cet élément Document.
getFooter()FooterSectionRécupère la section du pied de page du premier onglet ou, pour les scripts qui sont liés à un document, le 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, l'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 le NamedRange avec l'ID donné dans le premier onglet ou, pour les scripts liés à un document, l'onglet actif.
getNamedRanges()NamedRange[]Récupère tous les objets NamedRange du 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 qui sont liés à un document, 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 acceptés dans les fichiers Google Docs.
getTab(tabId)TabRécupère l'élément Tab avec l'ID spécifié.
getTabs()Tab[]Récupère tous les éléments 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 Document.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement dans l'onglet, par rapport à élément spécifique du premier onglet ou, pour les scripts liés à un document, à l'onglet actif.
newRange()RangeBuilderCrée un compilateur pour construire des objets Range à partir des éléments d'onglet dans premier onglet ou, pour les scripts liés à un l'onglet actif.
removeEditor(emailAddress)DocumentSupprime l'utilisateur indiqué de la liste des éditeurs pour Document.
removeEditor(user)DocumentSupprime l'utilisateur indiqué de la liste des éditeurs pour Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Document.
removeViewer(user)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs pour Document.
saveAndClose()voidEnregistre la Document actuelle.
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
AttributeAttributeL'énumération Attribute.
ElementTypeElementTypeL'énumération ElementType.
FontFamilyFontFamilyL'énumération FontFamily.
GlyphTypeGlyphTypeL'énumération GlyphType.
HorizontalAlignmentHorizontalAlignmentL'énumération HorizontalAlignment.
ParagraphHeadingParagraphHeadingL'énumération ParagraphHeading.
PositionedLayoutPositionedLayoutL'énumération PositionedLayout.
TextAlignmentTextAlignmentL'énumération TextAlignment.
VerticalAlignmentVerticalAlignmentL'énumération VerticalAlignment.

Méthodes

MéthodeType renvoyéBrève description
create(name)DocumentCrée et renvoie un document.
getActiveDocument()DocumentRenvoie le document dans lequel le script est lié au conteneur.
getUi()UiRenvoie une instance de l'environnement d'interface utilisateur du document qui permet au script d'ajouter fonctionnalités telles que les menus, les boîtes de dialogue et les 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 niveau de l'Position donné.
addFooter()FooterSectionAjoute une section de pied d'onglet, le cas échéant.
addHeader()HeaderSectionAjoute une section d'en-tête d'onglet, le cas échéant.
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range dont le nom et l'ID sont à utiliser pour une récupération ultérieure.
getBody()BodyRécupère l'Body de l'onglet.
getBookmark(id)BookmarkRécupère l'élément 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 l'élément 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 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 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 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 complète et 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 l'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 du 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 à Date .
EQUATIONEnumType correspondant à l'élément Equation.
EQUATION_FUNCTIONEnumType correspondant à l'élément EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumType correspondant à 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 à 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 complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'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 du même type.
removeFromParent()EquationSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'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 du même type.
removeFromParent()EquationFunctionSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 complète et 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 l'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 du 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 complète et 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 l'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 du 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 nouveau HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage donné.
appendListItem(listItem)ListItemAjoute l'élément ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouveau ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouveau Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un nouveau Table.
appendTable(cells)TableAjoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute l'élément Table donné.
clear()FooterSectionEfface le contenu de l'élément.
copy()FooterSectionRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un nouveau HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un objet InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
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 nouveau ListItem à l'index spécifié, contenant les du texte.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouveau Paragraph à l'index spécifié, contenant les du texte.
insertTable(childIndex)TableCrée et insère un nouveau Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un nouveau 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()FooterSectionSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 complète et 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 l'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 l'élément Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouveau Paragraph contenant le contenu textuel spécifié.
clear()FootnoteSectionEfface le contenu de l'élément.
copy()FootnoteSectionRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'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 nouveau Paragraph à l'index spécifié, contenant les du texte.
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 format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 par défaut, circulaire et pleine.
HOLLOW_BULLETEnumPuce vide.
SQUARE_BULLETEnumPuce carrée.
NUMBEREnumPuce composée d'un nombre.
LATIN_UPPEREnumPuce latine en majuscule.
LATIN_LOWEREnumPuce latine en minuscule.
ROMAN_UPPEREnumUn chiffre romain, une puce en majuscules.
ROMAN_LOWEREnumUn chiffre romain, une puce en minuscule.

HeaderSection

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un nouveau HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage donné.
appendListItem(listItem)ListItemAjoute l'élément ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouveau ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouveau Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un nouveau Table.
appendTable(cells)TableAjoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée.
appendTable(table)TableAjoute l'élément Table donné.
clear()HeaderSectionEfface le contenu de l'élément.
copy()HeaderSectionRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un nouveau HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un objet InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
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 nouveau ListItem à l'index spécifié, contenant les du texte.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un nouveau Paragraph à l'index spécifié, contenant les du texte.
insertTable(childIndex)TableCrée et insère un nouveau Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un nouveau 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()HeaderSectionSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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.
RIGHTEnumL'option d'alignement à droite.
JUSTIFYEnumOption justify-alignment.

HorizontalRule

Méthodes

MéthodeType renvoyéBrève description
copy()HorizontalRuleRenvoie une copie complète et 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 l'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 complète et dissociée de l'élément actuel.
getAltDescription()StringAffiche la description alternative du dessin.
getAltTitle()StringAffiche 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 l'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 du 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 complète et dissociée de l'élément actuel.
getAltDescription()StringAffiche la description alternative de l'image.
getAltTitle()StringAffiche le titre alternatif de l'image.
getAs(contentType)BlobRenvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
getAttributes()ObjectRécupère les attributs de l'élément.
getBlob()BlobRenvoyez les données contenues dans 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 l'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 du 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 nouveau PositionedImage à partir du blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un nouveau HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute l'élément InlineImage donné.
appendPageBreak()PageBreakCrée et ajoute un nouveau PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute l'élément 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 complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAlignment()HorizontalAlignmentRécupère les HorizontalAlignment.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de l'élément enfant spécifié.
getGlyphType()GlyphTypeRécupère l'GlyphType de l'élément de liste.
getHeading()ParagraphHeadingRécupère les ParagraphHeading.
getIndentEnd()NumberRécupère le retrait de fin, en points.
getIndentFirstLine()NumberRécupère le retrait de la première ligne, en points.
getIndentStart()NumberRécupère le retrait de début.
getLineSpacing()NumberRécupère l'interligne, en points.
getLinkUrl()StringRécupère l'URL du lien.
getListId()StringRécupère l'identifiant 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 l'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 nouveau InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un nouveau 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 texte spécifié. contenus.
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 du même type.
removeChild(child)ListItemSupprime l'élément enfant spécifié.
removeFromParent()ListItemSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un élément PositionedImage à côté de l'ID de l'image.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 à la fin, en points.
setIndentFirstLine(indentFirstLine)ListItemDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ListItemDéfinit le retrait au 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.
setLinkUrl(url)ListItemDéfinit l'URL du lien.
setListId(listItem)ListItemDéfinit l'identifiant 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 ce NamedRange.
getName()StringRécupère le nom de ce NamedRange.
getRange()RangeRécupère la plage d'éléments associés à ce NamedRange.
remove()voidSupprime ce NamedRange de l'onglet.

PageBreak

Méthodes

MéthodeType renvoyéBrève description
copy()PageBreakRenvoie une copie complète et 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 l'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 nouveau PositionedImage à partir du blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un nouveau HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute l'élément InlineImage donné.
appendPageBreak()PageBreakCrée et ajoute un nouveau PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute l'élément 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 complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAlignment()HorizontalAlignmentRécupère les HorizontalAlignment.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de l'élément enfant spécifié.
getHeading()ParagraphHeadingRécupère les ParagraphHeading.
getIndentEnd()NumberRécupère le retrait de fin, en points.
getIndentFirstLine()NumberRécupère le retrait de la première ligne, en points.
getIndentStart()NumberRécupère le retrait 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 l'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 nouveau InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un nouveau 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 texte spécifié. contenus.
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 du même type.
removeChild(child)ParagraphSupprime l'élément enfant spécifié.
removeFromParent()ParagraphSupprime l'élément de son parent.
removePositionedImage(id)BooleanSupprime un élément PositionedImage à côté de l'ID de l'image.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 à la fin, en points.
setIndentFirstLine(indentFirstLine)ParagraphDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ParagraphDéfinit le retrait au 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.
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 de titre pour le texte normal.
HEADING1EnumOption de titre le plus élevé.
HEADING2EnumDeuxième option de titre.
HEADING3EnumLa troisième option de titre
HEADING4EnumQuatrième option de titre.
HEADING5EnumLa cinquième option de titre.
HEADING6EnumL'option de titre le plus bas.
TITLEEnumOption d'en-tête de titre.
SUBTITLEEnumOption du titre du sous-titre.

Person

Méthodes

MéthodeType renvoyéBrève description
copy()PersonRenvoie une copie complète et dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getEmail()StringAffiche l'adresse e-mail de la personne.
getName()StringRenvoie le nom à afficher de la personne, si ce champ est défini.
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 l'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 du 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 contenant ce Position.
getOffset()IntegerRécupère 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 du Paragraph ou ListItem qui contient 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 nouveau Bookmark à cet Position.
insertInlineImage(image)InlineImageCrée et insère un nouveau InlineImage au niveau de cette Position à partir de l'image spécifiée blob.
insertText(text)TextInsère le texte spécifié à cet emplacement Position.

PositionedImage

Méthodes

MéthodeType renvoyéBrève description
getAs(contentType)BlobRenvoyez les données contenues dans cet objet sous la forme d'un blob converti dans le type de contenu spécifié.
getBlob()BlobRenvoyez les données contenues dans 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 représentant la disposition de l'image.
getLeftOffset()NumberRécupère le décalage de l'image, en points, à partir de la gauche du paragraphe.
getParagraph()ParagraphRécupère l'élément Paragraph auquel l'image est ancrée.
getTopOffset()NumberRécupère le décalage de l'image, en points, à partir du 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 définition de la disposition 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 positionnée au-dessus du texte.
BREAK_BOTHEnumL'image divise le texte à gauche et à droite.
BREAK_LEFTEnumL'image corrompt le texte situé à gauche.
BREAK_RIGHTEnumL'image corrompt le texte à droite.
WRAP_TEXTEnumL'image est encapsulée par du texte.

Range

Méthodes

MéthodeType renvoyéBrève description
getRangeElements()RangeElement[]Récupère tous les éléments de ce Range, y compris les éléments Text partiels (par exemple, dans le cas d'une sélection ne comprenant 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, ainsi que tous les éléments entre eux, à cette 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 élément Range à cet élément RangeBuilder.
build()RangeConstruit un Range à partir des paramètres appliqués au compilateur.
getRangeElements()RangeElement[]Récupère tous les éléments de ce Range, y compris les éléments Text partiels (par exemple, dans le cas d'une sélection ne comprenant qu'une partie d'un élément Text).

RangeElement

Méthodes

MéthodeType renvoyéBrève description
getElement()ElementRécupère le Element correspondant à ce RangeElement.
getEndOffsetInclusive()IntegerRécupère la position de la fin d'une plage partielle dans l'élément de plage.
getStartOffset()IntegerRécupère 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 de les caractères de l'élément.

Méthodes

MéthodeType renvoyéBrève description
copy()RichLinkRenvoie une copie complète et dissociée de l'élément actuel.
getAttributes()ObjectRécupère les attributs de l'élément.
getMimeType()StringRenvoie le type MIME de Le lien, qui est disponible lorsque l'élément est un lien vers un fichier Drive et null sinon.
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 l'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 du 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'identifiant 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 nouveau TableRow.
appendTableRow(tableRow)TableRowAjoute l'élément TableRow donné.
clear()TableEfface le contenu de l'élément.
copy()TableRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
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 les TableCell dans les index de ligne et de cellule spécifiés.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 d'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 la 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 l'ElementType de l'élément.
insertTableRow(childIndex)TableRowCrée et insère un nouveau 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()TableSupprime l'élément de son parent.
removeRow(rowIndex)TableRowSupprime TableRow de l'index de ligne spécifié.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 nouveau HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un nouveau InlineImage à partir du blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage donné.
appendListItem(listItem)ListItemAjoute l'élément ListItem donné.
appendListItem(text)ListItemCrée et ajoute un nouveau ListItem.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph donné.
appendParagraph(text)ParagraphCrée et ajoute un nouveau Paragraph.
appendTable()TableCrée et ajoute un nouveau Table.
appendTable(cells)TableAjoute un nouveau Table contenant les cellules spécifiées.
appendTable(table)TableAjoute l'élément Table donné.
clear()TableCellEfface le contenu de l'élément.
copy()TableCellRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de l'élément enfant spécifié.
getColSpan()IntegerRécupère l'intervalle de colonne, qui correspond au nombre de colonnes de cellules du tableau 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 intérieure inférieure, en points.
getPaddingLeft()NumberRécupère la marge intérieure de gauche, en points.
getPaddingRight()NumberRécupère la marge intérieure appropriée, en points.
getPaddingTop()NumberRécupère la marge supérieure, en points.
getParent()ContainerElementRécupère l'élément parent de l'élément.
getParentRow()TableRowRécupère l'TableRow contenant la TableCell actuelle.
getParentTable()TableRécupère l'Table contenant la TableCell actuelle.
getPreviousSibling()ElementRécupère l'élément frère précédent de l'élément.
getRowSpan()IntegerRécupère l'intervalle de lignes, qui correspond au nombre de lignes des cellules du tableau contenues dans 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 l'ElementType de l'élément.
getVerticalAlignment()VerticalAlignmentRécupère les VerticalAlignment.
getWidth()NumberRécupère la largeur de la colonne contenant la cellule, en points.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un nouveau HorizontalRule à l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un objet InlineImage à partir du blob d'image spécifié, à l'emplacement de l'index.
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 nouveau 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 nouveau Paragraph à l'index spécifié.
insertTable(childIndex)TableCrée et insère un nouveau Table à l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un nouveau 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()TableCellFusionne l'élément avec le frère précédent du 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 format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
setAttributes(attributes)TableCellDéfinit les attributs de l'élément.
setBackgroundColor(color)TableCellDéfinit la couleur de l'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 de 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 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 complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 l'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 format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 nouveau TableCell.
appendTableCell(textContents)TableCellAjoute la TableCell donnée contenant le texte spécifié.
appendTableCell(tableCell)TableCellAjoute l'élément TableCell donné.
clear()TableRowEfface le contenu de l'élément.
copy()TableRowRenvoie une copie complète et dissociée de l'élément actuel.
editAsText()TextRécupère une version Text de l'élément actuel, pour modification.
findElement(elementType)RangeElementRecherche un descendant du type spécifié dans le contenu de l'élément.
findElement(elementType, from)RangeElementRecherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
getAttributes()ObjectRécupère les attributs de l'élément.
getCell(cellIndex)TableCellRécupère la valeur TableCell à l'index de cellule spécifié.
getChild(childIndex)ElementRécupère l'élément enfant au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index enfant de 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 dans 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 la 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 l'ElementType de l'élément.
insertTableCell(childIndex)TableCellCrée et insère un nouveau TableCell à l'index spécifié.
insertTableCell(childIndex, textContents)TableCellInsère l'élément TableCell donné à l'index spécifié, contenant le texte indiqué.
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()TableRowFusionne l'élément avec le frère précédent du même type.
removeCell(cellIndex)TableCellSupprime TableCell au niveau de 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 format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
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 zone de texte.
copy()TextRenvoie une copie complète et 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, pour modification.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément à l'aide d'expressions régulières.
findText(searchPattern, from)RangeElementRecherche le format de texte spécifié dans le contenu de l'élément, à partir d'une dans les résultats de recherche.
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 selon le 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ères 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ères spécifié.
getForegroundColor()StringRécupère le paramètre de couleur de premier plan.
getForegroundColor(offset)StringRécupère la couleur de premier plan avec le 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 de texte d'un seul caractère.
getTextAttributeIndices()Integer[]Récupère l'ensemble des index de texte qui correspondent au début d'une mise en forme distincte du texte. s'exécute.
getType()ElementTypeRécupère l'ElementType de l'élément.
insertText(offset, text)TextInsère le texte spécifié au décalage de caractères spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isBold()BooleanRécupère le paramètre de mise en gras.
isBold(offset)BooleanRécupère le paramètre de mise en gras correspondant au décalage de caractères spécifié.
isItalic()BooleanRécupère le paramètre Italique.
isItalic(offset)BooleanRécupère le paramètre de mise en italique au décalage de caractères spécifié.
isStrikethrough()BooleanRécupère le paramètre barré.
isStrikethrough(offset)BooleanRécupère le paramètre barré au décalage de caractères 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ères spécifié.
merge()TextFusionne l'élément avec le frère précédent du même type.
removeFromParent()TextSupprime l'élément de son parent.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un format de texte donné par une chaîne de remplacement donnée, en utilisant des valeurs .
setAttributes(startOffset, endOffsetInclusive, attributes)TextApplique les attributs spécifiés à la plage de caractères indiqué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 de l'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 de 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 la 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 du premier plan.
setItalic(italic)TextDéfinit le paramètre Italique.
setItalic(startOffset, endOffsetInclusive, italic)TextDéfinit le paramètre 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 barré.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextDéfinit le paramètre de barré pour la plage de caractères spécifiée.
setText(text)TextDéfinit le contenu du texte.
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 complète et 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 l'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 du 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.