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
Nom | Brève description |
---|---|
Attribute | Énumération des attributs de l'élément. |
Body | Élément représentant le corps d'un document. |
Bookmark | Objet représentant un favori. |
ContainerElement | Un élément générique qui peut contenir d'autres éléments. |
Date | Élément représentant une date mise en forme |
Document | Document contenant du texte enrichi et des éléments tels que des tableaux et des listes. |
DocumentApp | Le service Documents crée et ouvre des Documents qui peuvent être modifiés. |
Element | Un é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. |
| É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. |
NamedRange | Un é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. |
Position | Référence à un emplacement du document, par rapport à un élément spécifique. |
PositionedImage | Position fixe de l'image ancrée à un Paragraph |
PositionedLayout | Énumération spécifiant comment disposer une PositionedImage par rapport au texte environnant. |
Range | Plage d'éléments dans un document. |
RangeBuilder | Compilateur utilisé pour créer des objets Range à partir d'éléments de document. |
RangeElement | Wrapper 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é | Type | Description |
---|---|---|
BACKGROUND_COLOR | Enum | Couleur d'arrière-plan d'un élément (Paragraphe, Tableau, etc.) ou d'un document. |
BOLD | Enum | Paramètre d'épaisseur de la police, pour le texte enrichi. |
BORDER_COLOR | Enum | Couleur de la bordure des éléments du tableau. |
BORDER_WIDTH | Enum | Largeur de la bordure en points pour les éléments du tableau. |
CODE | Enum | Contenu du code, pour les éléments d'équation. |
FONT_FAMILY | Enum | Paramètre de famille de polices, pour le texte enrichi. |
FONT_SIZE | Enum | Taille de police définie en points pour le texte enrichi. |
FOREGROUND_COLOR | Enum | Paramètre de couleur du premier plan, pour le texte enrichi. |
HEADING | Enum | Type de titre, pour les éléments de paragraphe (par exemple, DocumentApp.ParagraphHeading.HEADING1 ). |
HEIGHT | Enum | Paramètre de hauteur des éléments image. |
HORIZONTAL_ALIGNMENT | Enum | Alignement horizontal pour les éléments de paragraphe (par exemple, DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | Paramètre de retrait à la fin en points, pour les éléments de paragraphe. |
INDENT_FIRST_LINE | Enum | Paramètre de retrait de la première ligne en points, pour les éléments de paragraphe. |
INDENT_START | Enum | Paramètre de retrait de début en points, pour les éléments de paragraphe. |
ITALIC | Enum | Paramètre de style de police, pour le texte enrichi. |
GLYPH_TYPE | Enum | Type de glyphe, pour les éléments d'élément de liste. |
LEFT_TO_RIGHT | Enum | Paramètre d'orientation du texte, pour le texte enrichi. |
LINE_SPACING | Enum | Paramètre d'interligne en tant que multiplicateur, pour les éléments de paragraphe. |
LINK_URL | Enum | URL du lien, pour le texte enrichi. |
LIST_ID | Enum | ID de la liste d'inclusion, pour les éléments d'élément de liste. |
MARGIN_BOTTOM | Enum | Marge inférieure paramétrée en points pour les éléments de paragraphe. |
MARGIN_LEFT | Enum | Marge gauche paramétrée en points pour les éléments de paragraphe. |
MARGIN_RIGHT | Enum | Marge droite paramétrée en points pour les éléments de paragraphe. |
MARGIN_TOP | Enum | Paramètre de marge supérieure en points pour les éléments de paragraphe. |
NESTING_LEVEL | Enum | Niveau d'imbrication des éléments, pour les éléments de liste. |
MINIMUM_HEIGHT | Enum | Paramètre de hauteur minimale en points pour les éléments de ligne du tableau. |
PADDING_BOTTOM | Enum | Paramètre de marge intérieure inférieure en points, pour les éléments de cellules de tableau. |
PADDING_LEFT | Enum | Paramètre de marge intérieure gauche en points pour les éléments de cellules du tableau. |
PADDING_RIGHT | Enum | Paramètre de marge intérieure droite en points pour les éléments de cellules de tableau. |
PADDING_TOP | Enum | Paramètre de marge intérieure supérieure en points pour les éléments de cellules de tableau. |
PAGE_HEIGHT | Enum | Paramètre de hauteur de la page, en points, pour les documents. |
PAGE_WIDTH | Enum | Paramètre de largeur de la page en points, pour les documents. |
SPACING_AFTER | Enum | Paramètre d'espacement inférieur en points, pour les éléments de paragraphe. |
SPACING_BEFORE | Enum | Paramètre d'espacement en haut, en points, pour les éléments de paragraphe. |
STRIKETHROUGH | Enum | Paramètre barré pour le texte enrichi. |
UNDERLINE | Enum | Paramètre de soulignement, pour le texte enrichi. |
VERTICAL_ALIGNMENT | Enum | Paramètre d'alignement vertical, pour les éléments de cellules de tableau. |
WIDTH | Enum | Paramètre de largeur pour les éléments de cellules et d'images du tableau. |
Body
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendListItem(listItem) | ListItem | Ajoute l'élément ListItem spécifié. |
appendListItem(text) | ListItem | Crée et ajoute un ListItem contenant le contenu textuel spécifié. |
appendPageBreak() | PageBreak | Crée et ajoute un PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Ajoute l'élément PageBreak spécifié. |
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph contenant le contenu textuel spécifié. |
appendTable() | Table | Crée et ajoute un Table . |
appendTable(cells) | Table | Ajoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée. |
appendTable(table) | Table | Ajoute l'élément Table spécifié. |
clear() | Body | Efface le contenu de l'élément. |
copy() | Body | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getHeadingAttributes(paragraphHeading) | Object | Ré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() | Number | Récupère la marge inférieure, en points. |
getMarginLeft() | Number | Récupère la marge de gauche, en points. |
getMarginRight() | Number | Récupère la marge de droite. |
getMarginTop() | Number | Récupère la marge supérieure. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getPageHeight() | Number | Récupère la hauteur de la page, en points. |
getPageWidth() | Number | Ré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() | ContainerElement | Récupère l'élément parent de l'élément. |
getTables() | Table[] | Récupère tous les Tables contenus dans la section. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule au niveau de l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertListItem(childIndex, listItem) | ListItem | Insère le ListItem donné à l'index spécifié. |
insertListItem(childIndex, text) | ListItem | Crée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
insertPageBreak(childIndex) | PageBreak | Crée et insère un PageBreak au niveau de l'index spécifié. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insère le PageBreak donné à l'index spécifié. |
insertParagraph(childIndex, paragraph) | Paragraph | Insère le Paragraph donné à l'index spécifié. |
insertParagraph(childIndex, text) | Paragraph | Crée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
insertTable(childIndex) | Table | Crée et insère un Table au niveau de l'index spécifié. |
insertTable(childIndex, cells) | Table | Crée et insère un Table contenant les cellules spécifiées, à l'index spécifié. |
insertTable(childIndex, table) | Table | Insère le Table donné à l'index spécifié. |
removeChild(child) | Body | Supprime l'élément enfant spécifié. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | Body | Définit les attributs de l'élément. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Définit les attributs du ParagraphHeading fourni. |
setMarginBottom(marginBottom) | Body | Définit la marge inférieure, en points. |
setMarginLeft(marginLeft) | Body | Définit la marge gauche, en points. |
setMarginRight(marginRight) | Body | Définit la marge droite, en points. |
setMarginTop(marginTop) | Body | Définit la marge supérieure. |
setPageHeight(pageHeight) | Body | Définit la hauteur de la page, en points. |
setPageWidth(pageWidth) | Body | Définit la largeur de la page, en points. |
setText(text) | Body | Définit le contenu en texte brut. |
setTextAlignment(textAlignment) | Body | Définit l'alignement du texte. |
Bookmark
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getId() | String | Récupère l'ID d'Bookmark . |
getPosition() | Position | Récupère la Position de Bookmark dans l'Document . |
remove() | void | Supprime Bookmark . |
ContainerElement
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
asBody() | Body | Renvoie l'élément actuel en tant que Body . |
asEquation() | Equation | Renvoie l'élément actuel en tant que Equation . |
asFooterSection() | FooterSection | Renvoie l'élément actuel en tant que FooterSection . |
asFootnoteSection() | FootnoteSection | Renvoie l'élément actuel en tant que FootnoteSection . |
asHeaderSection() | HeaderSection | Renvoie l'élément actuel en tant que HeaderSection . |
asListItem() | ListItem | Renvoie l'élément actuel en tant que ListItem . |
asParagraph() | Paragraph | Renvoie l'élément actuel en tant que Paragraph . |
asTable() | Table | Renvoie l'élément actuel en tant que Table . |
asTableCell() | TableCell | Renvoie l'élément actuel en tant que TableCell . |
asTableOfContents() | TableOfContents | Renvoie l'élément actuel en tant que TableOfContents . |
asTableRow() | TableRow | Renvoie l'élément actuel en tant que TableRow . |
clear() | ContainerElement | Efface le contenu de l'élément. |
copy() | ContainerElement | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | ContainerElement | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | ContainerElement | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | ContainerElement | Définit les attributs de l'élément. |
setLinkUrl(url) | ContainerElement | Définit l'URL du lien. |
setTextAlignment(textAlignment) | ContainerElement | Définit l'alignement du texte. |
Date
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | Date | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getDisplayText() | String | Renvoie la valeur d'affichage affichée dans le document. |
getLocale() | String | Renvoie les paramètres régionaux de la date utilisés pour la valeur d'affichage. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getTimestamp() | Date | Renvoie le code temporel associé à la date. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | Date | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | Date | Supprime l'élément de son parent. |
setAttributes(attributes) | Date | Définit les attributs de l'élément. |
Document
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addBookmark(position) | Bookmark | Ajoute un Bookmark au Position donné. |
addEditor(emailAddress) | Document | Ajoute l'utilisateur donné à la liste des éditeurs pour Document . |
addEditor(user) | Document | Ajoute l'utilisateur donné à la liste des éditeurs pour Document . |
addEditors(emailAddresses) | Document | Ajoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Document . |
addFooter() | FooterSection | Ajoute une section de pied de page du document, le cas échéant. |
addHeader() | HeaderSection | Ajoute une section d'en-tête de document, le cas échéant. |
addNamedRange(name, range) | NamedRange | Ajout d'un NamedRange , qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure. |
addViewer(emailAddress) | Document | Ajoute l'utilisateur donné à la liste des lecteurs pour Document . |
addViewer(user) | Document | Ajoute l'utilisateur donné à la liste des lecteurs pour Document . |
addViewers(emailAddresses) | Document | Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document . |
getAs(contentType) | Blob | Récupère le contenu Document actuel en tant qu'objet blob du type spécifié. |
getBlob() | Blob | Récupère le contenu Document actuel en tant qu'objet blob. |
getBody() | Body | Récupère l'objet Body du document actif. |
getBookmark(id) | Bookmark | Récupère les Bookmark avec l'ID donné. |
getBookmarks() | Bookmark[] | Récupère tous les objets Bookmark du document. |
getCursor() | Position | Récupère le curseur de l'utilisateur dans le document actif. |
getEditors() | User[] | Récupère la liste des éditeurs pour ce Document . |
getFooter() | FooterSection | Ré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() | HeaderSection | Récupère la section d'en-tête du document, le cas échéant. |
getId() | String | Récupère l'identifiant unique du document. |
getLanguage() | String | Récupère le code de langue du document. |
getName() | String | Récupère le titre du document. |
getNamedRangeById(id) | NamedRange | Ré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() | Range | Ré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() | String | Ré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) | Position | Crée un Position , qui est une référence à un emplacement du document par rapport à un élément spécifique. |
newRange() | RangeBuilder | Crée un compilateur utilisé pour construire des objets Range à partir d'éléments de document. |
removeEditor(emailAddress) | Document | Supprime l'utilisateur indiqué de la liste des éditeurs pour Document . |
removeEditor(user) | Document | Supprime l'utilisateur indiqué de la liste des éditeurs pour Document . |
removeViewer(emailAddress) | Document | Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Document . |
removeViewer(user) | Document | Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Document . |
saveAndClose() | void | Enregistre le Document actuel. |
setCursor(position) | Document | Définit le curseur de l'utilisateur dans le document actif, en fonction d'un Position . |
setLanguage(languageCode) | Document | Définit le code de langue du document. |
setName(name) | Document | Définit le titre du document. |
setSelection(range) | Document | Définit la sélection de l'utilisateur dans le document actif, en fonction d'un Range . |
DocumentApp
Propriétés
Propriété | Type | Description |
---|---|---|
Attribute | Attribute | Énumération Attribute . |
ElementType | ElementType | Énumération ElementType . |
FontFamily |
| Énumération . |
GlyphType | GlyphType | Énumération GlyphType . |
HorizontalAlignment | HorizontalAlignment | Énumération HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | Énumération ParagraphHeading . |
PositionedLayout | PositionedLayout | Énumération PositionedLayout . |
TextAlignment | TextAlignment | Énumération TextAlignment . |
VerticalAlignment | VerticalAlignment | Énumération VerticalAlignment . |
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
create(name) | Document | Crée et affiche un document. |
getActiveDocument() | Document | Renvoie le document pour lequel le script est lié au conteneur. |
getUi() | Ui | Renvoie 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) | Document | Renvoie le document portant l'identifiant spécifié. |
openByUrl(url) | Document | Ouvre et renvoie le document avec l'URL spécifiée. |
Element
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
asBody() | Body | Renvoie l'élément actuel en tant que Body . |
asDate() | Date | Renvoie l'élément actuel en tant que Date . |
asEquation() | Equation | Renvoie l'élément actuel en tant que Equation . |
asEquationFunction() | EquationFunction | Renvoie l'élément actuel en tant que EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Renvoie l'élément actuel en tant que EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Renvoie l'élément actuel en tant que EquationSymbol . |
asFooterSection() | FooterSection | Renvoie l'élément actuel en tant que FooterSection . |
asFootnote() | Footnote | Renvoie l'élément actuel en tant que Footnote . |
asFootnoteSection() | FootnoteSection | Renvoie l'élément actuel en tant que FootnoteSection . |
asHeaderSection() | HeaderSection | Renvoie l'élément actuel en tant que HeaderSection . |
asHorizontalRule() | HorizontalRule | Renvoie l'élément actuel en tant que HorizontalRule . |
asInlineDrawing() | InlineDrawing | Renvoie l'élément actuel en tant que InlineDrawing . |
asInlineImage() | InlineImage | Renvoie l'élément actuel en tant que InlineImage . |
asListItem() | ListItem | Renvoie l'élément actuel en tant que ListItem . |
asPageBreak() | PageBreak | Renvoie l'élément actuel en tant que PageBreak . |
asParagraph() | Paragraph | Renvoie l'élément actuel en tant que Paragraph . |
asPerson() | Person | Renvoie l'élément actuel en tant que Person . |
asRichLink() | RichLink | Renvoie l'élément actuel en tant que RichLink (par exemple, un lien vers un fichier Google Sheets). |
asTable() | Table | Renvoie l'élément actuel en tant que Table . |
asTableCell() | TableCell | Renvoie l'élément actuel en tant que TableCell . |
asTableOfContents() | TableOfContents | Renvoie l'élément actuel en tant que TableOfContents . |
asTableRow() | TableRow | Renvoie l'élément actuel en tant que TableRow . |
asText() | Text | Renvoie l'élément actuel en tant que Text . |
copy() | Element | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | Element | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | Element | Supprime l'élément de son parent. |
setAttributes(attributes) | Element | Définit les attributs de l'élément. |
ElementType
Propriétés
Propriété | Type | Description |
---|---|---|
BODY_SECTION | Enum | Type correspondant à l'élément Body . |
COMMENT_SECTION | Enum | Type correspondant à l'élément . |
DATE | Enum | Type correspondant à l'élément Date . |
DOCUMENT | Enum | Type correspondant à la racine du document. |
EQUATION | Enum | Type correspondant à l'élément Equation . |
EQUATION_FUNCTION | Enum | Type correspondant à l'élément EquationFunction . |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | Type correspondant à l'élément EquationFunctionArgumentSeparator . |
EQUATION_SYMBOL | Enum | Type correspondant à l'élément EquationSymbol . |
RICH_LINK | Enum | Type correspondant à l'élément RichLink . |
FOOTER_SECTION | Enum | Type correspondant à l'élément FooterSection . |
FOOTNOTE | Enum | Type correspondant à l'élément Footnote . |
FOOTNOTE_SECTION | Enum | Type correspondant à l'élément FootnoteSection . |
HEADER_SECTION | Enum | Type correspondant à l'élément HeaderSection . |
HORIZONTAL_RULE | Enum | Type correspondant à l'élément HorizontalRule . |
INLINE_DRAWING | Enum | Type correspondant à l'élément InlineDrawing . |
INLINE_IMAGE | Enum | Type correspondant à l'élément InlineImage . |
LIST_ITEM | Enum | Type correspondant à l'élément ListItem . |
PAGE_BREAK | Enum | Type correspondant à l'élément PageBreak . |
PARAGRAPH | Enum | Type correspondant à l'élément Paragraph . |
PERSON | Enum | Type correspondant à l'élément Person . |
TABLE | Enum | Type correspondant à l'élément Table . |
TABLE_CELL | Enum | Type correspondant à l'élément TableCell . |
TABLE_OF_CONTENTS | Enum | Type correspondant à l'élément TableOfContents . |
TABLE_ROW | Enum | Type correspondant à l'élément TableRow . |
TEXT | Enum | Type correspondant à l'élément Text . |
UNSUPPORTED | Enum | Type correspondant à UnsupportedElement . |
Equation
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
clear() | Equation | Efface le contenu de l'élément. |
copy() | Equation | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | Equation | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | Equation | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | Equation | Définit les attributs de l'élément. |
setLinkUrl(url) | Equation | Définit l'URL du lien. |
setTextAlignment(textAlignment) | Equation | Définit l'alignement du texte. |
EquationFunction
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
clear() | EquationFunction | Efface le contenu de l'élément. |
copy() | EquationFunction | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getCode() | String | Récupère le code correspondant à la fonction d'équation. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | EquationFunction | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | EquationFunction | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | EquationFunction | Définit les attributs de l'élément. |
setLinkUrl(url) | EquationFunction | Définit l'URL du lien. |
setTextAlignment(textAlignment) | EquationFunction | Définit l'alignement du texte. |
EquationFunctionArgumentSeparator
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | EquationFunctionArgumentSeparator | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | EquationFunctionArgumentSeparator | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | EquationFunctionArgumentSeparator | Supprime l'élément de son parent. |
setAttributes(attributes) | EquationFunctionArgumentSeparator | Définit les attributs de l'élément. |
EquationSymbol
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | EquationSymbol | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getCode() | String | Récupère le code correspondant au symbole d'équation. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | EquationSymbol | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | EquationSymbol | Supprime l'élément de son parent. |
setAttributes(attributes) | EquationSymbol | Définit les attributs de l'élément. |
FontFamily
FooterSection
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendListItem(listItem) | ListItem | Ajoute l'élément ListItem spécifié. |
appendListItem(text) | ListItem | Crée et ajoute un ListItem contenant le contenu textuel spécifié. |
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph contenant le contenu textuel spécifié. |
appendTable() | Table | Crée et ajoute un Table . |
appendTable(cells) | Table | Ajoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée. |
appendTable(table) | Table | Ajoute l'élément Table spécifié. |
clear() | FooterSection | Efface le contenu de l'élément. |
copy() | FooterSection | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index 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() | Integer | Récupère le nombre d'enfants. |
getParagraphs() | Paragraph[] | Récupère tous les Paragraphs contenus dans la section (y compris ListItems ). |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getTables() | Table[] | Récupère tous les Tables contenus dans la section. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule au niveau de l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertListItem(childIndex, listItem) | ListItem | Insère le ListItem donné à l'index spécifié. |
insertListItem(childIndex, text) | ListItem | Crée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
insertParagraph(childIndex, paragraph) | Paragraph | Insère le Paragraph donné à l'index spécifié. |
insertParagraph(childIndex, text) | Paragraph | Crée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
insertTable(childIndex) | Table | Crée et insère un Table au niveau de l'index spécifié. |
insertTable(childIndex, cells) | Table | Crée et insère un Table contenant les cellules spécifiées, à l'index spécifié. |
insertTable(childIndex, table) | Table | Insère le Table donné à l'index spécifié. |
removeChild(child) | FooterSection | Supprime l'élément enfant spécifié. |
removeFromParent() | FooterSection | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | FooterSection | Définit les attributs de l'élément. |
setText(text) | FooterSection | Définit le contenu en texte brut. |
setTextAlignment(textAlignment) | FooterSection | Définit l'alignement du texte. |
Footnote
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | Footnote | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getFootnoteContents() | FootnoteSection | Récupère le contenu de l'élément "footnote". |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
removeFromParent() | Footnote | Supprime l'élément de son parent. |
setAttributes(attributes) | Footnote | Définit les attributs de l'élément. |
FootnoteSection
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph contenant le contenu textuel spécifié. |
clear() | FootnoteSection | Efface le contenu de l'élément. |
copy() | FootnoteSection | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParagraphs() | Paragraph[] | Récupère tous les Paragraphs contenus dans la section (y compris ListItems ). |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertParagraph(childIndex, paragraph) | Paragraph | Insère le Paragraph donné à l'index spécifié. |
insertParagraph(childIndex, text) | Paragraph | Crée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
removeChild(child) | FootnoteSection | Supprime l'élément enfant spécifié. |
removeFromParent() | FootnoteSection | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | FootnoteSection | Définit les attributs de l'élément. |
setText(text) | FootnoteSection | Définit le contenu en texte brut. |
setTextAlignment(textAlignment) | FootnoteSection | Définit l'alignement du texte. |
GlyphType
Propriétés
Propriété | Type | Description |
---|---|---|
BULLET | Enum | Puce par défaut, circulaire et pleine. |
HOLLOW_BULLET | Enum | Puce vide. |
SQUARE_BULLET | Enum | Puce carrée. |
NUMBER | Enum | Puce numérotée. |
LATIN_UPPER | Enum | Puce latine en majuscules. |
LATIN_LOWER | Enum | Puce latine minuscule. |
ROMAN_UPPER | Enum | Puce en majuscules avec un chiffre romain. |
ROMAN_LOWER | Enum | Puce minuscule en chiffres romains. |
HeaderSection
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendListItem(listItem) | ListItem | Ajoute l'élément ListItem spécifié. |
appendListItem(text) | ListItem | Crée et ajoute un ListItem contenant le contenu textuel spécifié. |
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph contenant le contenu textuel spécifié. |
appendTable() | Table | Crée et ajoute un Table . |
appendTable(cells) | Table | Ajoute un nouveau Table contenant un TableCell pour chaque valeur de chaîne spécifiée. |
appendTable(table) | Table | Ajoute l'élément Table spécifié. |
clear() | HeaderSection | Efface le contenu de l'élément. |
copy() | HeaderSection | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index 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() | Integer | Récupère le nombre d'enfants. |
getParagraphs() | Paragraph[] | Récupère tous les Paragraphs contenus dans la section (y compris ListItems ). |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getTables() | Table[] | Récupère tous les Tables contenus dans la section. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule au niveau de l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertListItem(childIndex, listItem) | ListItem | Insère le ListItem donné à l'index spécifié. |
insertListItem(childIndex, text) | ListItem | Crée et insère un ListItem au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
insertParagraph(childIndex, paragraph) | Paragraph | Insère le Paragraph donné à l'index spécifié. |
insertParagraph(childIndex, text) | Paragraph | Crée et insère un Paragraph au niveau de l'index spécifié, contenant le contenu textuel spécifié. |
insertTable(childIndex) | Table | Crée et insère un Table au niveau de l'index spécifié. |
insertTable(childIndex, cells) | Table | Crée et insère un Table contenant les cellules spécifiées, à l'index spécifié. |
insertTable(childIndex, table) | Table | Insère le Table donné à l'index spécifié. |
removeChild(child) | HeaderSection | Supprime l'élément enfant spécifié. |
removeFromParent() | HeaderSection | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | HeaderSection | Définit les attributs de l'élément. |
setText(text) | HeaderSection | Définit le contenu en texte brut. |
setTextAlignment(textAlignment) | HeaderSection | Définit l'alignement du texte. |
HorizontalAlignment
Propriétés
Propriété | Type | Description |
---|---|---|
LEFT | Enum | Option d'alignement à gauche. |
CENTER | Enum | Option d'alignement au centre. |
RIGHT | Enum | Option d'alignement à droite. |
JUSTIFY | Enum | Option de justification de l'alignement. |
HorizontalRule
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | HorizontalRule | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
removeFromParent() | HorizontalRule | Supprime l'élément de son parent. |
setAttributes(attributes) | HorizontalRule | Définit les attributs de l'élément. |
InlineDrawing
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | InlineDrawing | Renvoie une copie profonde détachée de l'élément actuel. |
getAltDescription() | String | Renvoie la description alternative du dessin. |
getAltTitle() | String | Renvoie le titre alternatif du dessin. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | InlineDrawing | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | InlineDrawing | Supprime l'élément de son parent. |
setAltDescription(description) | InlineDrawing | Définit la description alternative du dessin. |
setAltTitle(title) | InlineDrawing | Définit le titre alternatif du dessin. |
setAttributes(attributes) | InlineDrawing | Définit les attributs de l'élément. |
InlineImage
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | InlineImage | Renvoie une copie profonde détachée de l'élément actuel. |
getAltDescription() | String | Affiche la description alternative de l'image. |
getAltTitle() | String | Renvoie le titre de substitution de l'image. |
getAs(contentType) | Blob | Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getBlob() | Blob | Renvoyez les données contenues dans cet objet sous forme d'objet blob. |
getHeight() | Integer | Récupère la hauteur de l'image, en pixels. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
getWidth() | Integer | Récupère la largeur de l'image, en pixels. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | InlineImage | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | InlineImage | Supprime l'élément de son parent. |
setAltDescription(description) | InlineImage | Définit la description alternative de l'image. |
setAltTitle(title) | InlineImage | Définit le titre de substitution de l'image. |
setAttributes(attributes) | InlineImage | Définit les attributs de l'élément. |
setHeight(height) | InlineImage | Définit la hauteur de l'image, en pixels. |
setLinkUrl(url) | InlineImage | Définit l'URL du lien. |
setWidth(width) | InlineImage | Définit la largeur de l'image, en pixels. |
ListItem
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addPositionedImage(image) | PositionedImage | Crée et insère un PositionedImage à partir de l'objet blob d'image spécifié. |
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendInlineImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendInlineImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendPageBreak() | PageBreak | Crée et ajoute un PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Ajoute l'élément PageBreak spécifié. |
appendText(text) | Text | Crée et ajoute un élément Text avec le contenu spécifié. |
appendText(text) | Text | Ajoute l'élément Text donné. |
clear() | ListItem | Efface le contenu de l'élément. |
copy() | ListItem | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAlignment() | HorizontalAlignment | Récupère l'HorizontalAlignment . |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getGlyphType() | GlyphType | Récupère l'GlyphType de l'élément de liste. |
getHeading() | ParagraphHeading | Récupère l'ParagraphHeading . |
getIndentEnd() | Number | Récupère le retrait final, en points. |
getIndentFirstLine() | Number | Récupère le retrait de la première ligne, en points. |
getIndentStart() | Number | Récupère le retrait de début. |
getLineSpacing() | Number | Récupère l'interligne, en points. |
getLinkUrl() | String | Récupère l'URL du lien. |
getListId() | String | Récupère l'ID de la liste. |
getNestingLevel() | Integer | Récupère le niveau d'imbrication de l'élément de liste. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPositionedImage(id) | PositionedImage | Récupère un objet PositionedImage à partir de l'ID de l'image. |
getPositionedImages() | PositionedImage[] | Récupère tous les objets PositionedImage ancrés au paragraphe. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getSpacingAfter() | Number | Récupère l'espacement après l'élément, en points. |
getSpacingBefore() | Number | Récupère l'espacement avant l'élément, en points. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule au niveau de l'index spécifié. |
insertInlineImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertInlineImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertPageBreak(childIndex) | PageBreak | Crée et insère un PageBreak au niveau de l'index spécifié. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insère le PageBreak donné à l'index spécifié. |
insertText(childIndex, text) | Text | Crée et insère un élément de texte au niveau de l'index spécifié. |
insertText(childIndex, text) | Text | Insère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
isLeftToRight() | Boolean | Récupère le paramètre de gauche à droite. |
merge() | ListItem | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeChild(child) | ListItem | Supprime l'élément enfant spécifié. |
removeFromParent() | ListItem | Supprime l'élément de son parent. |
removePositionedImage(id) | Boolean | Supprime un PositionedImage en fonction de l'ID de l'image. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | ListItem | Définit HorizontalAlignment . |
setAttributes(attributes) | ListItem | Définit les attributs de l'élément. |
setGlyphType(glyphType) | ListItem | Définit l'GlyphType de l'élément de liste. |
setHeading(heading) | ListItem | Définit ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Définit le retrait à la fin, en points. |
setIndentFirstLine(indentFirstLine) | ListItem | Définit le retrait de la première ligne, en points. |
setIndentStart(indentStart) | ListItem | Définit le retrait de départ, en points. |
setLeftToRight(leftToRight) | ListItem | Définit le paramètre de gauche à droite. |
setLineSpacing(multiplier) | ListItem | Définit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement. |
setLinkUrl(url) | ListItem | Définit l'URL du lien. |
setListId(listItem) | ListItem | Définit l'ID de la liste. |
setNestingLevel(nestingLevel) | ListItem | Définit le niveau d'imbrication de l'élément de liste. |
setSpacingAfter(spacingAfter) | ListItem | Définit l'espacement après l'élément, en points. |
setSpacingBefore(spacingBefore) | ListItem | Définit l'espacement avant l'élément, en points. |
setText(text) | void | Définit le contenu de l'élément de liste sous forme de texte. |
setTextAlignment(textAlignment) | ListItem | Définit l'alignement du texte. |
NamedRange
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getId() | String | Récupère l'ID de ce NamedRange . |
getName() | String | Récupère le nom de ce NamedRange . |
getRange() | Range | Récupère la plage d'éléments associée à ce NamedRange . |
remove() | void | Supprime ce NamedRange du document. |
PageBreak
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | PageBreak | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
removeFromParent() | PageBreak | Supprime l'élément de son parent. |
setAttributes(attributes) | PageBreak | Définit les attributs de l'élément. |
Paragraph
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
addPositionedImage(image) | PositionedImage | Crée et insère un PositionedImage à partir de l'objet blob d'image spécifié. |
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendInlineImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendInlineImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendPageBreak() | PageBreak | Crée et ajoute un PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Ajoute l'élément PageBreak spécifié. |
appendText(text) | Text | Crée et ajoute un élément Text avec le contenu spécifié. |
appendText(text) | Text | Ajoute l'élément Text donné. |
clear() | Paragraph | Efface le contenu de l'élément. |
copy() | Paragraph | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAlignment() | HorizontalAlignment | Récupère l'HorizontalAlignment . |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getHeading() | ParagraphHeading | Récupère l'ParagraphHeading . |
getIndentEnd() | Number | Récupère le retrait final, en points. |
getIndentFirstLine() | Number | Récupère le retrait de la première ligne, en points. |
getIndentStart() | Number | Récupère le retrait de début. |
getLineSpacing() | Number | Récupère l'interligne, en points. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPositionedImage(id) | PositionedImage | Récupère un objet PositionedImage à partir de l'ID de l'image. |
getPositionedImages() | PositionedImage[] | Récupère tous les objets PositionedImage ancrés au paragraphe. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getSpacingAfter() | Number | Récupère l'espacement après l'élément, en points. |
getSpacingBefore() | Number | Récupère l'espacement avant l'élément, en points. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule au niveau de l'index spécifié. |
insertInlineImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertInlineImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertPageBreak(childIndex) | PageBreak | Crée et insère un PageBreak au niveau de l'index spécifié. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insère le PageBreak donné à l'index spécifié. |
insertText(childIndex, text) | Text | Crée et insère un élément de texte au niveau de l'index spécifié. |
insertText(childIndex, text) | Text | Insère l'élément Text donné à l'index spécifié, avec le contenu textuel spécifié. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
isLeftToRight() | Boolean | Récupère le paramètre de gauche à droite. |
merge() | Paragraph | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeChild(child) | Paragraph | Supprime l'élément enfant spécifié. |
removeFromParent() | Paragraph | Supprime l'élément de son parent. |
removePositionedImage(id) | Boolean | Supprime un PositionedImage en fonction de l'ID de l'image. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | Paragraph | Définit HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Définit les attributs de l'élément. |
setHeading(heading) | Paragraph | Définit ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Définit le retrait à la fin, en points. |
setIndentFirstLine(indentFirstLine) | Paragraph | Définit le retrait de la première ligne, en points. |
setIndentStart(indentStart) | Paragraph | Définit le retrait de départ, en points. |
setLeftToRight(leftToRight) | Paragraph | Définit le paramètre de gauche à droite. |
setLineSpacing(multiplier) | Paragraph | Définit l'interligne sous la forme d'une quantité indiquant le nombre de lignes à utiliser pour l'espacement. |
setLinkUrl(url) | Paragraph | Définit l'URL du lien. |
setSpacingAfter(spacingAfter) | Paragraph | Définit l'espacement après l'élément, en points. |
setSpacingBefore(spacingBefore) | Paragraph | Définit l'espacement avant l'élément, en points. |
setText(text) | void | Définit le contenu du paragraphe sous forme de texte. |
setTextAlignment(textAlignment) | Paragraph | Définit l'alignement du texte. |
ParagraphHeading
Propriétés
Propriété | Type | Description |
---|---|---|
NORMAL | Enum | Option de titre pour le texte normal. |
HEADING1 | Enum | L'option de titre le plus élevé. |
HEADING2 | Enum | Deuxième option de titre. |
HEADING3 | Enum | La troisième option de titre |
HEADING4 | Enum | Quatrième option de titre. |
HEADING5 | Enum | La cinquième option d'en-tête. |
HEADING6 | Enum | L'option de titre le plus bas. |
TITLE | Enum | Option d'en-tête de titre. |
SUBTITLE | Enum | Option de titre de sous-titre. |
Person
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | Person | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getEmail() | String | Affiche l'adresse e-mail de la personne. |
getName() | String | Renvoie le nom à afficher de la personne, s'il est défini. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | Person | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | Person | Supprime l'élément de son parent. |
setAttributes(attributes) | Person | Définit les attributs de l'élément. |
Position
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getElement() | Element | Récupère l'élément qui contient ce Position . |
getOffset() | Integer | Récupère l'emplacement relatif de cette Position dans l'élément qui la contient. |
getSurroundingText() | Text | Cré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() | Integer | Récupère le décalage de ce Position dans l'élément Text renvoyé par getSurroundingText() . |
insertBookmark() | Bookmark | Crée et insère un Bookmark au niveau de ce Position . |
insertInlineImage(image) | InlineImage | Crée et insère un objet InlineImage dans cet objet Position à partir du blob d'image spécifié. |
insertText(text) | Text | Insère le texte spécifié au niveau de cet élément Position . |
PositionedImage
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
getAs(contentType) | Blob | Renvoie les données contenues dans cet objet sous forme d'objet blob converti dans le type de contenu spécifié. |
getBlob() | Blob | Renvoyez les données contenues dans cet objet sous forme d'objet blob. |
getHeight() | Integer | Récupère la hauteur de l'image, en pixels. |
getId() | String | Récupère l'ID de l'image. |
getLayout() | PositionedLayout | Récupère une valeur d'énumération représentant la disposition de l'image. |
getLeftOffset() | Number | Récupère le décalage de l'image, en points, à partir de la gauche du paragraphe. |
getParagraph() | Paragraph | Récupère l'élément Paragraph auquel l'image est ancrée. |
getTopOffset() | Number | Récupère le décalage de l'image, en points, à partir du haut du paragraphe. |
getWidth() | Integer | Récupère la largeur de l'image, en pixels. |
setHeight(height) | PositionedImage | Définit la hauteur de l'image, en pixels. |
setLayout(layout) | PositionedImage | Définit la mise en page de l'image. |
setLeftOffset(offset) | PositionedImage | Définit le décalage de l'image, en points, à partir de la gauche du paragraphe. |
setTopOffset(offset) | PositionedImage | Définit le décalage de l'image, en points, par rapport au haut du paragraphe. |
setWidth(width) | PositionedImage | Définit la largeur de l'image, en pixels. |
PositionedLayout
Propriétés
Propriété | Type | Description |
---|---|---|
ABOVE_TEXT | Enum | L'image est positionnée au-dessus du texte. |
BREAK_BOTH | Enum | L'image divise le texte à gauche et à droite. |
BREAK_LEFT | Enum | L'image rompt le texte à gauche. |
BREAK_RIGHT | Enum | L'image rompt le texte situé à droite. |
WRAP_TEXT | Enum | L'image fait l'objet d'un retour à la ligne automatique. |
Range
Méthodes
Méthode | Type 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éthode | Type renvoyé | Brève description |
---|---|---|
addElement(element) | RangeBuilder | Ajoute un Element entier à ce RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Ajoute un élément Text partiel à ce RangeBuilder . |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Ajoute deux éléments entiers, ainsi que tous les éléments situés entre eux, à ce RangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Ajoute deux éléments Text partiels et tous les éléments situés entre eux à RangeBuilder . |
addRange(range) | RangeBuilder | Ajoute le contenu d'un autre élément Range à ce RangeBuilder . |
build() | Range | Construit 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éthode | Type renvoyé | Brève description |
---|---|---|
getElement() | Element | Récupère les Element correspondant à ce RangeElement . |
getEndOffsetInclusive() | Integer | Récupère la position de la fin d'une plage partielle dans l'élément de plage. |
getStartOffset() | Integer | Récupère la position du début d'une plage partielle dans l'élément de plage. |
isPartial() | Boolean | Détermine si cet élément de plage couvre l'intégralité de l'élément ou une sélection partielle de ses caractères. |
RichLink
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | RichLink | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getMimeType() | String | Renvoie le type MIME du lien, qui est disponible lorsque l'élément est un lien vers un fichier Drive, et null dans le cas contraire. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getTitle() | String | Renvoie le titre du lien affiché. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
getUrl() | String | Renvoie l'URL de la ressource. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | RichLink | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | RichLink | Supprime l'élément de son parent. |
setAttributes(attributes) | RichLink | Définit les attributs de l'élément. |
Table
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendTableRow() | TableRow | Crée et ajoute un TableRow . |
appendTableRow(tableRow) | TableRow | Ajoute l'élément TableRow spécifié. |
clear() | Table | Efface le contenu de l'élément. |
copy() | Table | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getBorderColor() | String | Récupère la couleur de la bordure. |
getBorderWidth() | Number | Récupère la largeur de la bordure, en points. |
getCell(rowIndex, cellIndex) | TableCell | Récupère les TableCell au niveau des index de ligne et de cellule spécifiés. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getColumnWidth(columnIndex) | Number | Récupère la largeur de la colonne de tableau spécifiée, en points. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getNumRows() | Integer | Récupère le nombre d'TableRows . |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getRow(rowIndex) | TableRow | Récupère les TableRow au niveau de l'index de ligne spécifié. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertTableRow(childIndex) | TableRow | Crée et insère un TableRow au niveau de l'index spécifié. |
insertTableRow(childIndex, tableRow) | TableRow | Insère le TableRow donné à l'index spécifié. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
removeChild(child) | Table | Supprime l'élément enfant spécifié. |
removeFromParent() | Table | Supprime l'élément de son parent. |
removeRow(rowIndex) | TableRow | Supprime TableRow au niveau de l'index de ligne spécifié. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | Table | Définit les attributs de l'élément. |
setBorderColor(color) | Table | Définit la couleur de la bordure. |
setBorderWidth(width) | Table | Définit la largeur de la bordure, en points. |
setColumnWidth(columnIndex, width) | Table | Définit la largeur de la colonne spécifiée, en points. |
setLinkUrl(url) | Table | Définit l'URL du lien. |
setTextAlignment(textAlignment) | Table | Définit l'alignement du texte. |
TableCell
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crée et ajoute un HorizontalRule . |
appendImage(image) | InlineImage | Crée et ajoute un InlineImage à partir de l'objet blob d'image spécifié. |
appendImage(image) | InlineImage | Ajoute l'élément InlineImage spécifié. |
appendListItem(listItem) | ListItem | Ajoute l'élément ListItem spécifié. |
appendListItem(text) | ListItem | Crée et ajoute un ListItem . |
appendParagraph(paragraph) | Paragraph | Ajoute l'élément Paragraph spécifié. |
appendParagraph(text) | Paragraph | Crée et ajoute un Paragraph . |
appendTable() | Table | Crée et ajoute un Table . |
appendTable(cells) | Table | Ajoute un nouveau Table contenant les cellules spécifiées. |
appendTable(table) | Table | Ajoute l'élément Table spécifié. |
clear() | TableCell | Efface le contenu de l'élément. |
copy() | TableCell | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getBackgroundColor() | String | Récupère la couleur d'arrière-plan. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getColSpan() | Integer | Récupère l'intervalle de colonne, qui correspond au nombre de colonnes de cellules du tableau que cette cellule s'étend. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getPaddingBottom() | Number | Récupère la marge intérieure inférieure, en points. |
getPaddingLeft() | Number | Récupère la marge intérieure de gauche, en points. |
getPaddingRight() | Number | Récupère la marge intérieure appropriée, en points. |
getPaddingTop() | Number | Récupère la marge intérieure supérieure, en points. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getParentRow() | TableRow | Récupère l'TableRow contenant la TableCell actuelle. |
getParentTable() | Table | Récupère l'Table contenant la TableCell actuelle. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getRowSpan() | Integer | Récupère l'intervalle de lignes, qui correspond au nombre de lignes de cellules du tableau contenues dans cette cellule. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
getVerticalAlignment() | VerticalAlignment | Récupère l'VerticalAlignment . |
getWidth() | Number | Récupère la largeur de la colonne contenant la cellule, en points. |
insertHorizontalRule(childIndex) | HorizontalRule | Crée et insère un HorizontalRule au niveau de l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Crée et insère un InlineImage à partir de l'objet blob d'image spécifié, dans l'index spécifié. |
insertImage(childIndex, image) | InlineImage | Insère le InlineImage donné à l'index spécifié. |
insertListItem(childIndex, listItem) | ListItem | Insère le ListItem donné à l'index spécifié. |
insertListItem(childIndex, text) | ListItem | Crée et insère un ListItem au niveau de l'index spécifié. |
insertParagraph(childIndex, paragraph) | Paragraph | Insère le Paragraph donné à l'index spécifié. |
insertParagraph(childIndex, text) | Paragraph | Crée et insère un Paragraph au niveau de l'index spécifié. |
insertTable(childIndex) | Table | Crée et insère un Table au niveau de l'index spécifié. |
insertTable(childIndex, cells) | Table | Crée et insère un Table contenant les cellules spécifiées, à l'index spécifié. |
insertTable(childIndex, table) | Table | Insère le Table donné à l'index spécifié. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | TableCell | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeChild(child) | TableCell | Supprime l'élément enfant spécifié. |
removeFromParent() | TableCell | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | TableCell | Définit les attributs de l'élément. |
setBackgroundColor(color) | TableCell | Définit la couleur de l'arrière-plan. |
setLinkUrl(url) | TableCell | Définit l'URL du lien. |
setPaddingBottom(paddingBottom) | TableCell | Définit la marge intérieure inférieure, en points. |
setPaddingLeft(paddingLeft) | TableCell | Définit la marge intérieure gauche, en points. |
setPaddingRight(paddingRight) | TableCell | Définit la marge intérieure appropriée, en points. |
setPaddingTop(paddingTop) | TableCell | Définit la marge intérieure supérieure, en points. |
setText(text) | TableCell | Définit le contenu en texte brut. |
setTextAlignment(textAlignment) | TableCell | Définit l'alignement du texte. |
setVerticalAlignment(alignment) | TableCell | Définit l'alignement vertical. |
setWidth(width) | TableCell | Définit la largeur en points de la colonne contenant la cellule actuelle. |
TableOfContents
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
clear() | TableOfContents | Efface le contenu de l'élément. |
copy() | TableOfContents | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getLinkUrl() | String | Récupère l'URL du lien. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
removeFromParent() | TableOfContents | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | TableOfContents | Définit les attributs de l'élément. |
setLinkUrl(url) | TableOfContents | Définit l'URL du lien. |
setTextAlignment(textAlignment) | TableOfContents | Définit l'alignement du texte. |
TableRow
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendTableCell() | TableCell | Crée et ajoute un TableCell . |
appendTableCell(textContents) | TableCell | Ajoute le TableCell donné contenant le texte spécifié. |
appendTableCell(tableCell) | TableCell | Ajoute l'élément TableCell spécifié. |
clear() | TableRow | Efface le contenu de l'élément. |
copy() | TableRow | Renvoie une copie profonde détachée de l'élément actuel. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findElement(elementType) | RangeElement | Recherche un descendant du type spécifié dans le contenu de l'élément. |
findElement(elementType, from) | RangeElement | Recherche dans le contenu de l'élément un descendant du type spécifié, à partir du RangeElement spécifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getCell(cellIndex) | TableCell | Récupère les TableCell au niveau de l'index de cellule spécifié. |
getChild(childIndex) | Element | Récupère l'élément enfant au niveau de l'index enfant spécifié. |
getChildIndex(child) | Integer | Récupère l'index de l'élément enfant spécifié. |
getLinkUrl() | String | Récupère l'URL du lien. |
getMinimumHeight() | Number | Récupère la hauteur minimale, en points. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getNumCells() | Integer | Récupère le nombre de cellules de la ligne. |
getNumChildren() | Integer | Récupère le nombre d'enfants. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getParentTable() | Table | Récupère le Table contenant la ligne actuelle. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
insertTableCell(childIndex) | TableCell | Crée et insère un TableCell au niveau de l'index spécifié. |
insertTableCell(childIndex, textContents) | TableCell | Insère le TableCell donné à l'index spécifié, contenant le texte donné. |
insertTableCell(childIndex, tableCell) | TableCell | Insère le TableCell donné à l'index spécifié. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | TableRow | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeCell(cellIndex) | TableCell | Supprime TableCell au niveau de l'index de cellule spécifié. |
removeChild(child) | TableRow | Supprime l'élément enfant spécifié. |
removeFromParent() | TableRow | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | TableRow | Définit les attributs de l'élément. |
setLinkUrl(url) | TableRow | Définit l'URL du lien. |
setMinimumHeight(minHeight) | TableRow | Définit la hauteur minimale, en points. |
setTextAlignment(textAlignment) | TableRow | Définit l'alignement du texte. |
Text
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
appendText(text) | Text | Ajoute le texte spécifié à la fin de cette zone de texte. |
copy() | Text | Renvoie une copie profonde détachée de l'élément actuel. |
deleteText(startOffset, endOffsetInclusive) | Text | Supprime une plage de texte. |
editAsText() | Text | Permet d'obtenir une version Text de l'élément actuel, qui peut être modifié. |
findText(searchPattern) | RangeElement | Recherche le modèle de texte spécifié à l'aide d'expressions régulières dans le contenu de l'élément. |
findText(searchPattern, from) | RangeElement | Recherche le modèle de texte spécifié dans le contenu de l'élément, à partir d'un résultat de recherche donné. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getAttributes(offset) | Object | Récupère les attributs au décalage de caractères spécifié. |
getBackgroundColor() | String | Récupère le paramètre de couleur d'arrière-plan. |
getBackgroundColor(offset) | String | Récupère la couleur d'arrière-plan au décalage de caractères spécifié. |
getFontFamily() | String | Récupère le paramètre de famille de polices. |
getFontFamily(offset) | String | Récupère la famille de polices au décalage de caractères spécifié. |
getFontSize() | Number | Récupère le paramètre de taille de police. |
getFontSize(offset) | Number | Récupère la taille de police au décalage de caractères spécifié. |
getForegroundColor() | String | Récupère le paramètre de couleur du premier plan. |
getForegroundColor(offset) | String | Récupère la couleur de premier plan selon le décalage de caractères spécifié. |
getLinkUrl() | String | Récupère l'URL du lien. |
getLinkUrl(offset) | String | Récupère l'URL du lien au décalage de caractères spécifié. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getText() | String | Récupère le contenu de l'élément sous forme de chaîne de texte. |
getTextAlignment() | TextAlignment | Récupère l'alignement du texte. |
getTextAlignment(offset) | TextAlignment | Ré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() | ElementType | Récupère l'ElementType de l'élément. |
insertText(offset, text) | Text | Insère le texte spécifié au décalage de caractères spécifié. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
isBold() | Boolean | Récupère le paramètre en gras. |
isBold(offset) | Boolean | Récupère le paramètre en gras lorsque le décalage de caractères spécifié est spécifié. |
isItalic() | Boolean | Récupère le paramètre "italique". |
isItalic(offset) | Boolean | Récupère le paramètre italique au décalage de caractères spécifié. |
isStrikethrough() | Boolean | Récupère le paramètre barré. |
isStrikethrough(offset) | Boolean | Récupère le paramètre barré au décalage de caractères spécifié. |
isUnderline() | Boolean | Récupère le paramètre de soulignement. |
isUnderline(offset) | Boolean | Récupère le paramètre de soulignement au décalage de caractères spécifié. |
merge() | Text | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | Text | Supprime l'élément de son parent. |
replaceText(searchPattern, replacement) | Element | Remplace 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) | Text | Applique les attributs spécifiés à la plage de caractères donnée. |
setAttributes(attributes) | Text | Définit les attributs de l'élément. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | Définit la couleur d'arrière-plan de la plage de caractères spécifiée. |
setBackgroundColor(color) | Text | Définit la couleur de l'arrière-plan. |
setBold(bold) | Text | Définit le paramètre de gras. |
setBold(startOffset, endOffsetInclusive, bold) | Text | Définit le paramètre de gras pour la plage de caractères spécifiée. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | Définit la famille de polices pour la plage de caractères spécifiée. |
setFontFamily(fontFamilyName) | Text | Définit la famille de polices. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | Définit la taille de la police pour la plage de caractères spécifiée. |
setFontSize(size) | Text | Définit la taille de la police. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | Définit la couleur de premier plan pour la plage de caractères spécifiée. |
setForegroundColor(color) | Text | Définit la couleur du premier plan. |
setItalic(italic) | Text | Définit le paramètre Italique. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | Définit le texte en italique pour la plage de caractères spécifiée. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | Définit l'URL du lien pour la plage de caractères spécifiée. |
setLinkUrl(url) | Text | Définit l'URL du lien. |
setStrikethrough(strikethrough) | Text | Définit le paramètre barré. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | Définit le paramètre barré pour la plage de caractères spécifiée. |
setText(text) | Text | Définit le contenu textuel. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | Définit l'alignement du texte pour une plage de caractères donnée. |
setTextAlignment(textAlignment) | Text | Définit l'alignement du texte. |
setUnderline(underline) | Text | Définit le paramètre de soulignement. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | Définit le soulignement pour la plage de caractères spécifiée. |
TextAlignment
Propriétés
Propriété | Type | Description |
---|---|---|
NORMAL | Enum | Alignement normal du texte. |
SUPERSCRIPT | Enum | Alignement du texte en exposant. |
SUBSCRIPT | Enum | Alignement du texte en indice. |
UnsupportedElement
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | UnsupportedElement | Renvoie une copie profonde détachée de l'élément actuel. |
getAttributes() | Object | Récupère les attributs de l'élément. |
getNextSibling() | Element | Récupère l'élément frère suivant de l'élément. |
getParent() | ContainerElement | Récupère l'élément parent de l'élément. |
getPreviousSibling() | Element | Récupère l'élément frère précédent de l'élément. |
getType() | ElementType | Récupère l'ElementType de l'élément. |
isAtDocumentEnd() | Boolean | Détermine si l'élément se trouve à la fin de Document . |
merge() | UnsupportedElement | Fusionne l'élément avec le frère ou la sœur précédent du même type. |
removeFromParent() | UnsupportedElement | Supprime l'élément de son parent. |
setAttributes(attributes) | UnsupportedElement | Définit les attributs de l'élément. |
VerticalAlignment
Propriétés
Propriété | Type | Description |
---|---|---|
BOTTOM | Enum | Option d'alignement en bas. |
CENTER | Enum | Option d'alignement au centre. |
TOP | Enum | Option d'alignement en haut. |