Class PageBreak

PageBreak

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 si trovi all'interno di un Table, HeaderSection, FooterSection o FootnoteSection. Un elemento PageBreak non può contenere altri elementi. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida per estendere Google Documenti.

Metodi

MetodoTipo restituitoBreve descrizione
copy()PageBreakRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
removeFromParent()PageBreakRimuove l'elemento da quello principale.
setAttributes(attributes)PageBreakConsente di impostare gli attributi dell'elemento.

Documentazione dettagliata

copy()

Restituisce una copia diretta scollegata dell'elemento corrente.

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

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 di elemento valido in cui nome della proprietà corrisponde a un elemento nell'enumerazione DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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]);
}

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 di pari livello successivo dell'elemento.

L'altro elemento di pari livello ha lo stesso elemento principale e segue l'elemento corrente.

Invio

Element: l'elemento di pari livello 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.

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 di pari livello precedente dell'elemento.

L'elemento di pari livello precedente ha lo stesso elemento principale e precede l'elemento corrente.

Invio

Element: l'elemento di pari livello 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 il valore ElementType dell'elemento.

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

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

// Obtain the first element in the active tab's 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.');
}

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

Invio

Boolean: 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 da quello principale.

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

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var 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)

Consente di impostare gli attributi dell'elemento.

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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);

Parametri

NomeTipoDescrizione
attributesObjectGli 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