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_GOES_HERE');

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

Classes

NomBrève description
AttributeÉnumération des attributs de l'élément.
BodyÉlément représentant le corps d'un document.
BookmarkObjet représentant un favori.
ContainerElementUn élément générique qui peut contenir d'autres éléments.
DateÉlément représentant une date mise en forme
DocumentDocument contenant du texte enrichi et des éléments tels que des tableaux et des listes.
DocumentAppLe service Documents crée et ouvre des Documents qui peuvent être modifiés.
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 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'alignements horizontaux acceptés.
HorizontalRuleÉlément représentant une règle horizontale.
InlineDrawingÉlément représentant un dessin intégré.
InlineImageÉlément représentant une image intégrée.
ListItemÉlément représentant un élément de liste.
NamedRangeUn élément 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 du document, par rapport à un élément spécifique.
PositionedImagePosition fixe de l'image ancrée à un Paragraph
PositionedLayoutÉnumération spécifiant comment disposer une 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.
RangeElementWrapper autour d'un Element avec des décalages de début et de fin possibles.
RichLinkÉlément représentant un lien vers une ressource Google, comme un fichier Drive ou une vidéo YouTube.
TableÉlément représentant un tableau.
TableCellÉlément représentant la cellule d'un tableau.
TableOfContentsÉlément contenant une table des matières.
TableRowÉlément représentant la ligne d'un tableau.
TextÉlément représentant une zone de texte enrichi.
TextAlignmentÉnumération du type 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 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_SIZEEnumTaille de police définie en points pour le texte enrichi.
FOREGROUND_COLOREnumParamètre de couleur du 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 pour les éléments de paragraphe (par exemple, DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumParamètre de retrait à la 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'interligne en tant que multiplicateur, pour les éléments de paragraphe.
LINK_URLEnumURL du lien, pour le texte enrichi.
LIST_IDEnumID de la liste d'inclusion, pour les éléments d'élément de liste.
MARGIN_BOTTOMEnumMarge inférieure paramétrée en points pour les éléments de paragraphe.
MARGIN_LEFTEnumMarge gauche paramétrée en points pour les éléments de paragraphe.
MARGIN_RIGHTEnumMarge droite paramétrée 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 de liste.
MINIMUM_HEIGHTEnumParamètre de hauteur minimale en points pour les éléments de ligne du tableau.
PADDING_BOTTOMEnumParamètre de marge intérieure inférieure en points, pour les éléments de cellules de tableau.
PADDING_LEFTEnumParamètre de marge intérieure gauche en points pour les éléments de cellules du tableau.
PADDING_RIGHTEnumParamètre de marge intérieure droite en points pour les éléments de cellules de tableau.
PADDING_TOPEnumParamètre de marge intérieure supérieure en points pour les éléments de cellules de tableau.
PAGE_HEIGHTEnumParamètre de hauteur de la page, en points, pour les documents.
PAGE_WIDTHEnumParamètre de largeur de la 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, en points, pour les éléments de paragraphe.
STRIKETHROUGHEnumParamètre barré pour le texte enrichi.
UNDERLINEEnumParamètre de soulignement, pour le texte enrichi.
VERTICAL_ALIGNMENTEnumParamètre d'alignement vertical, pour les éléments de cellules de tableau.
WIDTHEnumParamètre de largeur pour les éléments de cellules et d'images du tableau.

Body

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir de l'objet blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage spécifié.
appendListItem(listItem)ListItemAjoute l'élément ListItem spécifié.
appendListItem(text)ListItemCrée et ajoute un ListItem contenant le contenu textuel spécifié.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute l'élément PageBreak spécifié.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph spécifié.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un 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 spécifié.
clear()BodyEfface le contenu de l'élément.
copy()BodyRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index de l'élément enfant spécifié.
getHeadingAttributes(paragraphHeading)ObjectRécupère l'ensemble des 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 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 l'ElementType de l'élément.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule au niveau de l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak au niveau de l'index spécifié.
insertPageBreak(childIndex, pageBreak)PageBreakInsère le PageBreak donné à l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un Table au niveau de l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)BodySupprime l'élément enfant spécifié.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)BodyDéfinit les attributs de l'élément.
setHeadingAttributes(paragraphHeading, attributes)BodyDéfinit les attributs du 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 d'Bookmark.
getPosition()PositionRécupère la Position de Bookmark dans l'Document.
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 profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 ou la sœur précédent du 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 détaché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 ou la sœur 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

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark au Position donné.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Document.
addFooter()FooterSectionAjoute une section de pied de page du document, le cas échéant.
addHeader()HeaderSectionAjoute une section d'en-tête de document, le cas échéant.
addNamedRange(name, range)NamedRangeAjout d'un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure.
addViewer(emailAddress)DocumentAjoute l'utilisateur donné à la liste des lecteurs pour Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des lecteurs pour Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document.
getAs(contentType)BlobRécupère le contenu Document actuel en tant qu'objet blob du type spécifié.
getBlob()BlobRécupère le contenu Document actuel en tant qu'objet blob.
getBody()BodyRécupère l'objet Body du document actif.
getBookmark(id)BookmarkRécupère les Bookmark avec l'ID donné.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark du document.
getCursor()PositionRécupère le curseur de l'utilisateur dans le document actif.
getEditors()User[]Récupère la liste des éditeurs pour ce Document.
getFooter()FooterSectionRécupère la section de pied de page du document, le cas échéant.
getFootnotes()Footnote[]Récupère tous les éléments Footnote dans le corps du document.
getHeader()HeaderSectionRécupère la section d'en-tête du document, le cas échéant.
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 les NamedRange avec l'ID donné.
getNamedRanges()NamedRange[]Récupère tous les objets NamedRange du document.
getNamedRanges(name)NamedRange[]Récupère tous les objets NamedRange portant le nom donné.
getSelection()RangeRécupère la sélection de l'utilisateur dans le document actif.
getSupportedLanguageCodes()String[]Récupère tous les codes de langue compatibles avec les fichiers Google Docs.
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 ce Document.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement du document par rapport à un élément spécifique.
newRange()RangeBuilderCrée un compilateur utilisé pour construire des objets Range à partir d'éléments de document.
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 de Document.
removeViewer(user)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Document.
saveAndClose()voidEnregistre le Document actuel.
setCursor(position)DocumentDéfinit le curseur de l'utilisateur dans le document actif, 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 le document actif, en fonction d'un Range.

DocumentApp

Propriétés

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

Méthodes

MéthodeType renvoyéBrève description
create(name)DocumentCrée et affiche un document.
getActiveDocument()DocumentRenvoie le document pour 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 des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
openById(id)DocumentRenvoie le document portant l'identifiant spécifié.
openByUrl(url)DocumentOuvre et renvoie le document avec l'URL spécifiée.

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 profonde détaché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 ou la sœur 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 à l'élément Date.
DOCUMENTEnumType correspondant à la racine du document.
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 détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 ou la sœur précédent du 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 détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 ou la sœur précédent du 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 détaché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 ou la sœur 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 profonde détaché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 ou la sœur 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 HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir de l'objet blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage spécifié.
appendListItem(listItem)ListItemAjoute l'élément ListItem spécifié.
appendListItem(text)ListItemCrée et ajoute un ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph spécifié.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un 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 spécifié.
clear()FooterSectionEfface le contenu de l'élément.
copy()FooterSectionRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 HorizontalRule au niveau de l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un Table au niveau de l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)FooterSectionSupprime l'élément enfant spécifié.
removeFromParent()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 détaché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 "footnote".
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 spécifié.
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 détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 Paragraph au niveau de 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 par défaut, circulaire et pleine.
HOLLOW_BULLETEnumPuce vide.
SQUARE_BULLETEnumPuce carrée.
NUMBEREnumPuce numérotée.
LATIN_UPPEREnumPuce latine en majuscules.
LATIN_LOWEREnumPuce latine minuscule.
ROMAN_UPPEREnumPuce en majuscules avec un chiffre romain.
ROMAN_LOWEREnumPuce minuscule en chiffres romains.

HeaderSection

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir de l'objet blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage spécifié.
appendListItem(listItem)ListItemAjoute l'élément ListItem spécifié.
appendListItem(text)ListItemCrée et ajoute un ListItem contenant le contenu textuel spécifié.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph spécifié.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph contenant le contenu textuel spécifié.
appendTable()TableCrée et ajoute un 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 spécifié.
clear()HeaderSectionEfface le contenu de l'élément.
copy()HeaderSectionRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 HorizontalRule au niveau de l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié.
insertTable(childIndex)TableCrée et insère un Table au niveau de l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
removeChild(child)HeaderSectionSupprime l'élément enfant spécifié.
removeFromParent()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.
JUSTIFYEnumOption de justification de l'alignement.

HorizontalRule

Méthodes

MéthodeType renvoyéBrève description
copy()HorizontalRuleRenvoie une copie profonde détaché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 profonde détaché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 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 ou la sœur 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 profonde détachée de l'élément actuel.
getAltDescription()StringAffiche la description alternative de l'image.
getAltTitle()StringRenvoie le titre de substitution de l'image.
getAs(contentType)BlobRenvoie les données contenues dans cet objet sous forme d'objet 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 d'objet 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 ou la sœur 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 de substitution 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 de l'objet blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un InlineImage à partir de l'objet blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute l'élément InlineImage spécifié.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute l'élément PageBreak spécifié.
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 détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAlignment()HorizontalAlignmentRécupère l'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 de l'élément enfant spécifié.
getGlyphType()GlyphTypeRécupère l'GlyphType de l'élément de liste.
getHeading()ParagraphHeadingRécupère l'ParagraphHeading.
getIndentEnd()NumberRécupère le retrait final, 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'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 objet PositionedImage à partir de 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 au niveau de l'index spécifié.
insertInlineImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak au niveau de 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 au niveau de l'index spécifié.
insertText(childIndex, text)TextInsère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isLeftToRight()BooleanRécupère le paramètre de gauche à droite.
merge()ListItemFusionne l'élément avec le frère ou la sœur 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 PositionedImage en fonction de l'ID de l'image.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAlignment(alignment)ListItemDéfinit HorizontalAlignment.
setAttributes(attributes)ListItemDéfinit les attributs de l'élément.
setGlyphType(glyphType)ListItemDéfinit l'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 de départ, en points.
setLeftToRight(leftToRight)ListItemDéfinit le paramètre de gauche à droite.
setLineSpacing(multiplier)ListItemDéfinit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.
setLinkUrl(url)ListItemDéfinit l'URL du lien.
setListId(listItem)ListItemDéfinit l'ID de la liste.
setNestingLevel(nestingLevel)ListItemDéfinit le niveau d'imbrication de l'élément de liste.
setSpacingAfter(spacingAfter)ListItemDéfinit l'espacement après l'élément, en points.
setSpacingBefore(spacingBefore)ListItemDéfinit l'espacement avant l'élément, en points.
setText(text)voidDéfinit le contenu de l'élément de liste sous forme de 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ée à ce NamedRange.
remove()voidSupprime ce NamedRange du document.

PageBreak

Méthodes

MéthodeType renvoyéBrève description
copy()PageBreakRenvoie une copie profonde détaché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 PositionedImage à partir de l'objet blob d'image spécifié.
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendInlineImage(image)InlineImageCrée et ajoute un InlineImage à partir de l'objet blob d'image spécifié.
appendInlineImage(image)InlineImageAjoute l'élément InlineImage spécifié.
appendPageBreak()PageBreakCrée et ajoute un PageBreak.
appendPageBreak(pageBreak)PageBreakAjoute l'élément PageBreak spécifié.
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 détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné.
getAlignment()HorizontalAlignmentRécupère l'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 de l'élément enfant spécifié.
getHeading()ParagraphHeadingRécupère l'ParagraphHeading.
getIndentEnd()NumberRécupère le retrait final, 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 objet PositionedImage à partir de 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 au niveau de l'index spécifié.
insertInlineImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié.
insertInlineImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertPageBreak(childIndex)PageBreakCrée et insère un PageBreak au niveau de 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 au niveau de l'index spécifié.
insertText(childIndex, text)TextInsère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
isLeftToRight()BooleanRécupère le paramètre de gauche à droite.
merge()ParagraphFusionne l'élément avec le frère ou la sœur 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 PositionedImage en fonction de l'ID de l'image.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAlignment(alignment)ParagraphDéfinit HorizontalAlignment.
setAttributes(attributes)ParagraphDéfinit les attributs de l'élément.
setHeading(heading)ParagraphDéfinit ParagraphHeading.
setIndentEnd(indentEnd)ParagraphDéfinit le retrait à la fin, en points.
setIndentFirstLine(indentFirstLine)ParagraphDéfinit le retrait de la première ligne, en points.
setIndentStart(indentStart)ParagraphDéfinit le retrait de départ, en points.
setLeftToRight(leftToRight)ParagraphDéfinit le paramètre de gauche à droite.
setLineSpacing(multiplier)ParagraphDéfinit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement.
setLinkUrl(url)ParagraphDéfinit l'URL du lien.
setSpacingAfter(spacingAfter)ParagraphDéfinit l'espacement après l'élément, en points.
setSpacingBefore(spacingBefore)ParagraphDéfinit l'espacement avant l'élément, en points.
setText(text)voidDéfinit le contenu du paragraphe sous forme de texte.
setTextAlignment(textAlignment)ParagraphDéfinit l'alignement du texte.

ParagraphHeading

Propriétés

PropriétéTypeDescription
NORMALEnumOption de titre pour le texte normal.
HEADING1EnumL'option 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 d'en-tête.
HEADING6EnumL'option de titre le plus bas.
TITLEEnumOption d'en-tête de titre.
SUBTITLEEnumOption de titre de sous-titre.

Person

Méthodes

MéthodeType renvoyéBrève description
copy()PersonRenvoie une copie profonde détaché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, s'il 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 ou la sœur 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 qui contient ce Position.
getOffset()IntegerRécupère l'emplacement relatif de cette Position dans l'élément qui la contient.
getSurroundingText()TextCrée un élément Text artificiel qui représente le texte et la mise en forme de l'élément Paragraph ou ListItem contenant le Position, soit directement, soit via une chaîne d'éléments enfants.
getSurroundingTextOffset()IntegerRécupère le décalage de ce Position dans l'élément Text renvoyé par getSurroundingText().
insertBookmark()BookmarkCrée et insère un Bookmark au niveau de ce Position.
insertInlineImage(image)InlineImageCrée et insère un objet InlineImage dans cet objet Position à partir du blob d'image spécifié.
insertText(text)TextInsère le texte spécifié au niveau de cet élément Position.

PositionedImage

Méthodes

MéthodeType renvoyéBrève description
getAs(contentType)BlobRenvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié.
getBlob()BlobRenvoyez les données contenues dans cet objet sous forme d'objet 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 mise en page de l'image.
setLeftOffset(offset)PositionedImageDéfinit le décalage de l'image, en points, à partir de 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 rompt le texte à gauche.
BREAK_RIGHTEnumL'image rompt le texte situé à droite.
WRAP_TEXTEnumL'image fait l'objet d'un retour à la ligne automatique.

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 qui n'inclut qu'une partie d'un élément Text).

RangeBuilder

Méthodes

MéthodeType renvoyéBrève description
addElement(element)RangeBuilderAjoute un Element entier à ce RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAjoute un élément Text partiel à ce RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAjoute deux éléments entiers, ainsi que tous les éléments situés entre eux, à ce RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAjoute deux éléments Text partiels et tous les éléments situés entre eux à RangeBuilder.
addRange(range)RangeBuilderAjoute le contenu d'un autre élément Range à ce 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 qui n'inclut qu'une partie d'un élément Text).

RangeElement

Méthodes

MéthodeType renvoyéBrève description
getElement()ElementRécupère les 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 ses caractères.

Méthodes

MéthodeType renvoyéBrève description
copy()RichLinkRenvoie une copie profonde détaché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 du lien affiché.
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 ou la sœur 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.

Table

Méthodes

MéthodeType renvoyéBrève description
appendTableRow()TableRowCrée et ajoute un TableRow.
appendTableRow(tableRow)TableRowAjoute l'élément TableRow spécifié.
clear()TableEfface le contenu de l'élément.
copy()TableRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 les TableCell au niveau des 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 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 les TableRow au niveau de 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 TableRow au niveau de 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 au niveau de l'index de ligne spécifié.
replaceText(searchPattern, replacement)ElementRemplace toutes les occurrences d'un modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableDéfinit les attributs de l'élément.
setBorderColor(color)TableDéfinit la couleur de la bordure.
setBorderWidth(width)TableDéfinit la largeur de la bordure, en points.
setColumnWidth(columnIndex, width)TableDéfinit la largeur de la colonne spécifiée, en points.
setLinkUrl(url)TableDéfinit l'URL du lien.
setTextAlignment(textAlignment)TableDéfinit l'alignement du texte.

TableCell

Méthodes

MéthodeType renvoyéBrève description
appendHorizontalRule()HorizontalRuleCrée et ajoute un HorizontalRule.
appendImage(image)InlineImageCrée et ajoute un InlineImage à partir de l'objet blob d'image spécifié.
appendImage(image)InlineImageAjoute l'élément InlineImage spécifié.
appendListItem(listItem)ListItemAjoute l'élément ListItem spécifié.
appendListItem(text)ListItemCrée et ajoute un ListItem.
appendParagraph(paragraph)ParagraphAjoute l'élément Paragraph spécifié.
appendParagraph(text)ParagraphCrée et ajoute un Paragraph.
appendTable()TableCrée et ajoute un Table.
appendTable(cells)TableAjoute un nouveau Table contenant les cellules spécifiées.
appendTable(table)TableAjoute l'élément Table spécifié.
clear()TableCellEfface le contenu de l'élément.
copy()TableCellRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 s'étend.
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 intérieure 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 de 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 l'VerticalAlignment.
getWidth()NumberRécupère la largeur de la colonne contenant la cellule, en points.
insertHorizontalRule(childIndex)HorizontalRuleCrée et insère un HorizontalRule au niveau de l'index spécifié.
insertImage(childIndex, image)InlineImageCrée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié.
insertImage(childIndex, image)InlineImageInsère le InlineImage donné à l'index spécifié.
insertListItem(childIndex, listItem)ListItemInsère le ListItem donné à l'index spécifié.
insertListItem(childIndex, text)ListItemCrée et insère un ListItem au niveau de l'index spécifié.
insertParagraph(childIndex, paragraph)ParagraphInsère le Paragraph donné à l'index spécifié.
insertParagraph(childIndex, text)ParagraphCrée et insère un Paragraph au niveau de l'index spécifié.
insertTable(childIndex)TableCrée et insère un Table au niveau de l'index spécifié.
insertTable(childIndex, cells)TableCrée et insère un Table contenant les cellules spécifiées, à l'index spécifié.
insertTable(childIndex, table)TableInsère le Table donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableCellFusionne l'élément avec le frère ou la sœur 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 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 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 gauche, en points.
setPaddingRight(paddingRight)TableCellDéfinit la marge intérieure appropriée, 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 en points de la colonne contenant la cellule actuelle.

TableOfContents

Méthodes

MéthodeType renvoyéBrève description
clear()TableOfContentsEfface le contenu de l'élément.
copy()TableOfContentsRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 au niveau de l'index enfant spécifié.
getChildIndex(child)IntegerRécupère l'index 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 modèle de texte donné par une chaîne de remplacement donnée, à l'aide d'expressions régulières.
setAttributes(attributes)TableOfContentsDéfinit les attributs de l'élément.
setLinkUrl(url)TableOfContentsDéfinit l'URL du lien.
setTextAlignment(textAlignment)TableOfContentsDéfinit l'alignement du texte.

TableRow

Méthodes

MéthodeType renvoyéBrève description
appendTableCell()TableCellCrée et ajoute un TableCell.
appendTableCell(textContents)TableCellAjoute le TableCell donné contenant le texte spécifié.
appendTableCell(tableCell)TableCellAjoute l'élément TableCell spécifié.
clear()TableRowEfface le contenu de l'élément.
copy()TableRowRenvoie une copie profonde détachée de l'élément actuel.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
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é à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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 les TableCell au niveau de 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 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 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 le 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 TableCell au niveau de l'index spécifié.
insertTableCell(childIndex, textContents)TableCellInsère le TableCell donné à l'index spécifié, contenant le texte donné.
insertTableCell(childIndex, tableCell)TableCellInsère le TableCell donné à l'index spécifié.
isAtDocumentEnd()BooleanDétermine si l'élément se trouve à la fin de Document.
merge()TableRowFusionne l'élément avec le frère ou la sœur 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 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 zone de texte.
copy()TextRenvoie une copie profonde détachée de l'élément actuel.
deleteText(startOffset, endOffsetInclusive)TextSupprime une plage de texte.
editAsText()TextPermet d'obtenir une version Text de l'élément actuel, qui peut être modifié.
findText(searchPattern)RangeElementRecherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément.
findText(searchPattern, from)RangeElementRecherche le modèle 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ères 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 police au décalage de caractères spécifié.
getForegroundColor()StringRécupère le paramètre de couleur du premier plan.
getForegroundColor(offset)StringRécupère la couleur de premier plan selon le décalage de caractères 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 index de texte correspondant au début d'exécutions de mise en forme de texte distinctes.
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 en gras.
isBold(offset)BooleanRécupère le paramètre en gras lorsque le décalage de caractères spécifié est spécifié.
isItalic()BooleanRécupère le paramètre "italique".
isItalic(offset)BooleanRécupère le paramètre 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 ou la sœur précédent du 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 de l'arrière-plan.
setBold(bold)TextDéfinit le paramètre de gras.
setBold(startOffset, endOffsetInclusive, bold)TextDéfinit le paramètre de 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 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 texte en 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 barré.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextDéfinit le paramètre 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 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 profonde détaché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 ou la sœur 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.