Élément représentant un saut de page. Un PageBreak
peut être contenu dans un ListItem
ou un Paragraph
, sauf si le ListItem
ou le Paragraph
se trouve dans un Table
, un HeaderSection
, un FooterSection
ou un FootnoteSection
. Un élément PageBreak
ne peut pas contenir d'autre élément. Pour en savoir plus sur la structure des documents, consultez le guide d'extension de Google Docs.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
copy() | PageBreak | Renvoie une copie dissociée de l'élément actif. |
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'élément ElementType . |
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. |
Documentation détaillée
copy()
Renvoie une copie dissociée de l'élément actif.
Tous les éléments enfants présents dans l'élément sont également copiés. Le nouvel élément n'a pas de parent.
Aller-retour
PageBreak
: nouvelle copie
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Récupère les attributs de l'élément.
Il en résulte un objet contenant une propriété pour chaque attribut d'élément valide, où chaque nom de propriété correspond à un élément de l'énumération DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Aller-retour
Object
: attributs de l'élément
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Récupère l'élément frère suivant de l'élément.
La fratrie suivante a le même parent et suit l'élément actuel.
Aller-retour
Element
: élément frère suivant.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Récupère l'élément parent de l'élément.
L'élément parent contient l'élément actuel.
Aller-retour
ContainerElement
: élément parent
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Récupère l'élément frère précédent de l'élément.
Le frère et la sœur précédents ont le même parent et précède l'élément actuel.
Aller-retour
Element
: élément frère précédent.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Récupère l'élément ElementType
.
Utilisez getType()
pour déterminer le type exact d'un élément donné.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Aller-retour
ElementType
: type d'élément.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Détermine si l'élément se trouve à la fin de Document
.
Aller-retour
Boolean
: indique si l'élément se trouve à la fin du document.
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Supprime l'élément de son parent.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Aller-retour
PageBreak
: élément supprimé
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Définit les attributs de l'élément.
Le paramètre d'attributs spécifié doit être un objet dans lequel chaque nom de propriété est un élément de l'énumération DocumentApp.Attribute
, et chaque valeur de propriété correspond à la nouvelle valeur à appliquer.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Paramètres
Nom | Type | Description |
---|---|---|
attributes | Object | Attributs de l'élément. |
Aller-retour
PageBreak
: élément actuel
Autorisation
Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents