Class PageBreak

Interruzione di pagina

Un elemento che rappresenta un'interruzione di pagina. Un PageBreak può essere contenuto in un ListItem o Paragraph, a meno che ListItem o Paragraph non sia all'interno di un Table, HeaderSection, FooterSection o FootnoteSection. Un elemento PageBreak non può contenere altri elementi. Per ulteriori informazioni sulla struttura del documento, consulta la guida all'estensione di Documenti Google.

Metodi

Metodo	Tipo restituito	Breve descrizione
copy()	PageBreak	Restituisce una copia approfondita e scollegata dell'elemento corrente.
getAttributes()	Object	Recupera gli attributi dell'elemento.
getNextSibling()	Element	Recupera l'elemento successivo associato all'elemento.
getParent()	ContainerElement	Recupera l'elemento principale dell'elemento.
getPreviousSibling()	Element	Recupera l'elemento precedente associato all'elemento.
getType()	ElementType	Recupera il ElementType dell'elemento.
isAtDocumentEnd()	Boolean	Determina se l'elemento è alla fine del Document.
removeFromParent()	PageBreak	Rimuove l'elemento dal relativo elemento principale.
setAttributes(attributes)	PageBreak	Imposta gli attributi dell'elemento.

Documentazione dettagliata

copy()

Restituisce una copia approfondita e scollegata dell'elemento corrente.

Vengono copiati anche gli eventuali elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento primario.

Invio

PageBreak: la nuova copia.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getAttributes()

Recupera gli attributi dell'elemento.

Il risultato è un oggetto contenente una proprietà per ogni attributo elemento valido, in cui ogni nome della proprietà corrisponde a un elemento dell'enumerazione DocumentApp.Attribute.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Invio

Object: gli attributi dell'elemento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getNextSibling()

Recupera l'elemento successivo associato all'elemento.

L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.

Invio

Element: l'elemento successivo associato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getParent()

Recupera l'elemento principale dell'elemento.

L'elemento principale contiene l'elemento corrente.

Invio

ContainerElement: l'elemento principale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getPreviousSibling()

Recupera l'elemento precedente associato all'elemento.

L'elemento precedente associato ha lo stesso elemento principale e precede l'elemento corrente.

Invio

Element: l'elemento precedente associato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getType()

Recupera il ElementType dell'elemento.

Utilizza getType() per determinare il tipo esatto di un determinato elemento.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const 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.');
}

Invio

ElementType: il tipo di elemento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

isAtDocumentEnd()

Determina se l'elemento è alla fine del Document.

Invio

Boolean: indica se l'elemento si trova alla fine della scheda.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

removeFromParent()

Rimuove l'elemento dal relativo elemento principale.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Invio

PageBreak: l'elemento rimosso.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

setAttributes(attributes)

Imposta gli attributi dell'elemento.

Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome della proprietà è un elemento dell'enumerazione DocumentApp.Attribute e ogni valore della proprietà è il nuovo valore da applicare.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parametri

Nome	Tipo	Descrizione
attributes	Object	Gli attributi dell'elemento.

Invio

PageBreak: l'elemento corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents