Class PageBreak

PageBreak

Un elemento che rappresenta un'interruzione di pagina. Un elemento PageBreak può essere contenuto in un elemento ListItem o Paragraph, a meno che ListItem o Paragraph non si trovino all'interno di un elemento Table, HeaderSection, FooterSection, o FootnoteSection. Un elemento PageBreak non può contenere altri elementi. Per saperne di più sulla struttura dei documenti, consulta la guida all'estensione di Google Documenti.

Metodi

MetodoTipo restituitoBreve descrizione
copy()PageBreakRestituisce una copia profonda e indipendente dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getNextSibling()Element|nullRecupera l'elemento associato successivo dell'elemento.
getParent()ContainerElement|nullRecupera l'elemento principale dell'elemento.
getPreviousSibling()Element|nullRecupera l'elemento associato precedente dell'elemento.
getType()ElementTypeRecupera l'ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine del Document.
removeFromParent()PageBreak|nullRimuove l'elemento dal relativo elemento principale.
setAttributes(attributes)PageBreakImposta gli attributi dell'elemento.

Documentazione dettagliata

copy()

Restituisce una copia profonda e indipendente dell'elemento corrente.

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

Indietro

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 dell'elemento valido, dove ogni nome di proprietà corrisponde a un elemento nell'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]}`);
}

Indietro

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 associato successivo dell'elemento.

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

Indietro

Element|null : l'elemento associato successivo.

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.

Indietro

ContainerElement|null : 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 associato precedente dell'elemento.

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

Indietro

Element|null : l'elemento associato precedente.

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

Indietro

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 si trova alla fine del Document.

Indietro

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();
}

Indietro

PageBreak|null : 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 di proprietà è un elemento nell'enumerazione DocumentApp.Attribute e ogni valore di 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

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Indietro

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