Class Paragraph

Paragrafo

Un elemento che rappresenta un paragrafo. Un Paragraph può contenere elementi Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak e Text. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.

Paragraphs non può contenere caratteri di nuova riga. I caratteri di nuova riga ("\n") vengono convertiti in caratteri di interruzione di riga ("\t"). 

var body = DocumentApp.getActiveDocument().getBody();

// Append a document header paragraph.
var header = body.appendParagraph("A Document");
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
var section = body.appendParagraph("Section 1");
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph("This is a typical paragraph.");

Metodi

MetodoTipo restituitoBreve descrizione
addPositionedImage(image)PositionedImageCrea e inserisce un nuovo PositionedImage dal blob immagine specificato.
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendInlineImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob di immagine specificato.
appendInlineImage(image)InlineImageAggiunge il InlineImage specificato.
appendPageBreak()PageBreakCrea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)PageBreakAggiunge il PageBreak specificato.
appendText(text)TextCrea e aggiunge un nuovo elemento Text con i contenuti specificati.
appendText(text)TextAggiunge l'elemento Text specificato.
clear()ParagraphCancella i contenuti dell'elemento.
copy()ParagraphRestituisce una copia profonda dell'elemento corrente scollegata.
editAsText()TextPermette di ottenere una versione Text dell'elemento corrente da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal valore RangeElement specificato.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca, nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAlignment()HorizontalAlignmentRecupera il HorizontalAlignment.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio all'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getHeading()ParagraphHeadingRecupera il ParagraphHeading.
getIndentEnd()NumberRecupera il rientro finale, in punti.
getIndentFirstLine()NumberRecupera il primo rientro di riga, in punti.
getIndentStart()NumberRecupera il rientro iniziale.
getLineSpacing()NumberRecupera l'interlinea, in punti.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera il successivo elemento di pari livello dell'elemento.
getNumChildren()IntegerRecupera il numero di bambini.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPositionedImage(id)PositionedImageVisualizza il valore PositionedImage in base all'ID dell'immagine.
getPositionedImages()PositionedImage[]Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.
getPreviousSibling()ElementRecupera il precedente elemento di pari livello dell'elemento.
getSpacingAfter()NumberRecupera la spaziatura dopo l'elemento, in punti.
getSpacingBefore()NumberRecupera la spaziatura prima dell'elemento, in punti.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentConsente di ottenere l'allineamento del testo.
getType()ElementTypeRecupera i ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un HorizontalRule nell'indice specificato.
insertInlineImage(childIndex, image)InlineImageCrea e inserisce un nuovo InlineImage dal blob immagine specificato, all'indice specificato.
insertInlineImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato all'indice specificato.
insertPageBreak(childIndex)PageBreakCrea e inserisce un nuovo PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)PageBreakInserisce il valore PageBreak specificato all'indice specificato.
insertText(childIndex, text)TextCrea e inserisce un nuovo elemento di testo nell'indice specificato.
insertText(childIndex, text)TextInserisce l'elemento Text specificato all'indice specificato, con il contenuto specificato.
isAtDocumentEnd()BooleanDetermina se l'elemento è alla fine di Document.
isLeftToRight()BooleanRecupera l'impostazione da sinistra a destra.
merge()ParagraphUnisce l'elemento con il gemello precedente dello stesso tipo.
removeChild(child)ParagraphRimuove l'elemento secondario specificato.
removeFromParent()ParagraphRimuove l'elemento dall'elemento principale.
removePositionedImage(id)BooleanRimuove un PositionedImage dall'ID dell'immagine.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando espressioni regolari.
setAlignment(alignment)ParagraphImposta il HorizontalAlignment.
setAttributes(attributes)ParagraphImposta gli attributi dell'elemento.
setHeading(heading)ParagraphImposta il ParagraphHeading.
setIndentEnd(indentEnd)ParagraphImposta il rientro finale, in punti.
setIndentFirstLine(indentFirstLine)ParagraphImposta il rientro della prima riga, in punti.
setIndentStart(indentStart)ParagraphImposta il rientro iniziale in punti.
setLeftToRight(leftToRight)ParagraphConsente di configurare l'impostazione da sinistra a destra.
setLineSpacing(multiplier)ParagraphImposta l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea.
setLinkUrl(url)ParagraphImposta l'URL del link.
setSpacingAfter(spacingAfter)ParagraphImposta la spaziatura dopo l'elemento, in punti.
setSpacingBefore(spacingBefore)ParagraphImposta la spaziatura in punti prima dell'elemento.
setText(text)voidImposta il contenuto del paragrafo come testo.
setTextAlignment(textAlignment)ParagraphImposta l'allineamento del testo.

Documentazione dettagliata

addPositionedImage(image)

Crea e inserisce un nuovo PositionedImage dal blob immagine specificato. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image =
  UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png');

// Adds the image to the document, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parametri

NomeTipoDescrizione
imageBlobSourceI dati di immagine.

Andata e ritorno

PositionedImage: la nuova immagine posizionata.

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

appendHorizontalRule()

Crea e aggiunge un nuovo HorizontalRule. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

Andata e ritorno

HorizontalRule: la nuova regola orizzontale.

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

appendInlineImage(image)

Crea e aggiunge un nuovo InlineImage dal blob di immagine specificato. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp
  .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png');

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parametri

NomeTipoDescrizione
imageBlobSourceI dati di immagine.

Andata e ritorno

InlineImage: l'immagine aggiunta.

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

appendInlineImage(image)

Aggiunge il InlineImage specificato. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();;

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

Parametri

NomeTipoDescrizione
imageInlineImageI dati di immagine.

Andata e ritorno

InlineImage: l'immagine aggiunta.

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

appendPageBreak()

Crea e aggiunge un nuovo PageBreak.

Nota: PageBreaks non può essere incluso in TableCells. Se l'elemento corrente è contenuto in una cella della tabella, verrà generata un'eccezione. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

Andata e ritorno

PageBreak: il nuovo elemento di interruzione di pagina.

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

appendPageBreak(pageBreak)

Aggiunge il PageBreak specificato.

Nota: PageBreaks non può essere incluso in TableCells. Se l'elemento corrente è presente in una cella della tabella, lo script genera un'eccezione. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

Parametri

NomeTipoDescrizione
pageBreakPageBreakL'interruzione di pagina da aggiungere.

Andata e ritorno

PageBreak: l'elemento di interruzione di pagina aggiunto,

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

appendText(text)

Crea e aggiunge un nuovo elemento Text con i contenuti specificati. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

Parametri

NomeTipoDescrizione
textStringIl contenuto del testo.

Andata e ritorno

Text: il nuovo elemento di testo.

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

appendText(text)

Aggiunge l'elemento Text specificato. 

 // Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

Parametri

NomeTipoDescrizione
textTextL'elemento di testo da aggiungere.

Andata e ritorno

Text: l'elemento di testo aggiunto,

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

clear()

Cancella i contenuti dell'elemento.

Andata e ritorno

Paragraph: elemento corrente

copy()

Restituisce una copia profonda dell'elemento corrente scollegata.

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

Andata e ritorno

Paragraph: 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

editAsText()

Permette di ottenere una versione Text dell'elemento corrente da modificare.

Utilizza editAsText per manipolare i contenuti degli elementi come testo RTF. La modalità editAsText ignora gli elementi non testuali (come InlineImage e HorizontalRule).

Gli elementi secondari interamente contenuti in un intervallo di testo eliminato vengono rimossi dall'elemento. 

var body = DocumentApp.getActiveDocument().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Andata e ritorno

Text: una versione di testo dell'elemento corrente

findElement(elementType)

Cerca nei contenuti dell'elemento un discendente del tipo specificato.

Parametri

NomeTipoDescrizione
elementTypeElementTypeil tipo di elemento da cercare

Andata e ritorno

RangeElement: un risultato di ricerca che indica la posizione dell'elemento di ricerca

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

findElement(elementType, from)

Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal valore RangeElement specificato. 

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parametri

NomeTipoDescrizione
elementTypeElementTypeil tipo di elemento da cercare
fromRangeElementil risultato della ricerca da cui eseguire la ricerca

Andata e ritorno

RangeElement: un risultato di ricerca che indica la posizione successiva dell'elemento di ricerca

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

findText(searchPattern)

Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.

Un sottoinsieme delle funzionalità di espressione regolare JavaScript non è completamente supportato, come i gruppi di acquisizione e i modificatori di modalità.

Il pattern di espressione regolare specificato viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare

Andata e ritorno

RangeElement: un risultato di ricerca che indica la posizione del testo della ricerca oppure null se non esiste una corrispondenza

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

findText(searchPattern, from)

Cerca, nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.

Un sottoinsieme delle funzionalità di espressione regolare JavaScript non è completamente supportato, come i gruppi di acquisizione e i modificatori di modalità.

Il pattern di espressione regolare specificato viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare
fromRangeElementil risultato della ricerca da cui eseguire la ricerca

Andata e ritorno

RangeElement: un risultato di ricerca che indica la posizione successiva del testo di ricerca oppure null se non esiste una corrispondenza

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

getAlignment()

Recupera il HorizontalAlignment. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the console.
console.log(paragraph.getAlignment().toString());

Andata e ritorno

HorizontalAlignment: l'allineamento.

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 in cui ogni nome della proprietà corrisponde a un elemento nell'enumerazione di 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]);
}

Andata e ritorno

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

getChild(childIndex)

Recupera l'elemento figlio all'indice figlio specificato. 

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice dell'elemento secondario da recuperare

Andata e ritorno

Element: l'elemento secondario all'indice specificato

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

getChildIndex(child)

Recupera l'indice figlio per l'elemento figlio specificato.

Parametri

NomeTipoDescrizione
childElementL'elemento figlio per il quale recuperare l'indice

Andata e ritorno

Integer: l'indice secondario

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

getHeading()

Recupera il ParagraphHeading. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

Andata e ritorno

ParagraphHeading: l'intestazione.

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

getIndentEnd()

Recupera il rientro finale, in punti.

Andata e ritorno

Number: rientro finale, in punti

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

getIndentFirstLine()

Recupera il primo rientro di riga, in punti.

Andata e ritorno

Number: rientro prima riga in punti

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

getIndentStart()

Recupera il rientro iniziale.

Andata e ritorno

Number: rientro iniziale

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

getLineSpacing()

Recupera l'interlinea, in punti.

Andata e ritorno

Number: l'interlinea, in punti

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

getLinkUrl()

Recupera l'URL del link.

Andata e ritorno

String: l'URL del link o null se l'elemento contiene più valori per questo attributo

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

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

Andata e ritorno

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

getNumChildren()

Recupera il numero di bambini. 

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Andata e ritorno

Integer: numero di bambini

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.

Andata e ritorno

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

getPositionedImage(id)

Visualizza il valore PositionedImage in base all'ID dell'immagine.

Parametri

NomeTipoDescrizione
idStringID immagine

Andata e ritorno

PositionedImage: l'immagine posizionata

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

getPositionedImages()

Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.

Andata e ritorno

PositionedImage[]: un elenco di immagini posizionate

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

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

Andata e ritorno

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

getSpacingAfter()

Recupera la spaziatura dopo l'elemento, in punti.

Andata e ritorno

Number: la spaziatura dopo l'elemento, in punti.

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

getSpacingBefore()

Recupera la spaziatura prima dell'elemento, in punti.

Andata e ritorno

Number: la spaziatura prima dell'elemento, in punti.

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

getText()

Recupera i contenuti dell'elemento come stringa di testo.

Andata e ritorno

String: i contenuti dell'elemento come stringa di testo

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

getTextAlignment()

Consente di ottenere l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

Andata e ritorno

TextAlignment: il tipo di allineamento del testo o null se il testo contiene più tipi di allineamenti di testo o se non è mai stato impostato.

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 i ElementType dell'elemento.

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

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

Andata e ritorno

ElementType: 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

insertHorizontalRule(childIndex)

Crea e inserisce un HorizontalRule nell'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento

Andata e ritorno

HorizontalRule: il nuovo elemento della regola orizzontale

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

insertInlineImage(childIndex, image)

Crea e inserisce un nuovo InlineImage dal blob immagine specificato, all'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
imageBlobSourcei dati di immagine

Andata e ritorno

InlineImage: elemento dell'immagine in linea inserito

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

insertInlineImage(childIndex, image)

Inserisce il valore InlineImage specificato all'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
imageInlineImagei dati di immagine

Andata e ritorno

InlineImage: elemento dell'immagine in linea inserito

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

insertPageBreak(childIndex)

Crea e inserisce un nuovo PageBreak nell'indice specificato.

Nota: PageBreaks non può essere incluso in TableCells. Se l'elemento corrente è contenuto in una cella della tabella, verrà generata un'eccezione.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento

Andata e ritorno

PageBreak: il nuovo elemento di interruzione di pagina

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

insertPageBreak(childIndex, pageBreak)

Inserisce il valore PageBreak specificato all'indice specificato.

Nota: PageBreaks non può essere incluso in TableCells. Se l'elemento corrente è contenuto in una cella della tabella, verrà generata un'eccezione.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
pageBreakPageBreakThe p[age break to insert

Andata e ritorno

PageBreak: elemento di interruzione di pagina inserito

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

insertText(childIndex, text)

Crea e inserisce un nuovo elemento di testo nell'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
textStringil contenuto del testo

Andata e ritorno

Text: il nuovo elemento di testo

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

insertText(childIndex, text)

Inserisce l'elemento Text specificato all'indice specificato, con il contenuto specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
textTextL'elemento di testo da inserire

Andata e ritorno

Text: l'elemento di testo inserito.

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 di Document.

Andata e ritorno

Boolean: indica se l'elemento si trova alla fine del documento.

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

isLeftToRight()

Recupera l'impostazione da sinistra a destra.

Andata e ritorno

Boolean, l'impostazione da sinistra a destra

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

merge()

Unisce l'elemento con il gemello precedente dello stesso tipo.

È possibile unire soltanto gli elementi dello stesso ElementType. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento di pari livello precedente.

L'elemento corrente viene rimosso dal documento. 

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Andata e ritorno

Paragraph: l'elemento unito.

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

removeChild(child)

Rimuove l'elemento secondario specificato.

Parametri

NomeTipoDescrizione
childElementl'elemento secondario da rimuovere

Andata e ritorno

Paragraph: 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

removeFromParent()

Rimuove l'elemento dall'elemento principale. 

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

Andata e ritorno

Paragraph: 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

removePositionedImage(id)

Rimuove un PositionedImage dall'ID dell'immagine.

Parametri

NomeTipoDescrizione
idStringID immagine

Andata e ritorno

Boolean: indica se l'immagine specificata è stata rimossa

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

replaceText(searchPattern, replacement)

Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando espressioni regolari.

Il pattern di ricerca viene trasmesso come stringa, non come oggetto di espressione regolare JavaScript. Per questo motivo, dovrai eseguire l'escape di eventuali barre rovesciate nel pattern.

Questo metodo utilizza la libreria di espressioni regolari RE2 di Google, che limita la sintassi supportata.

Il pattern di espressione regolare specificato viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente. 

var body = DocumentApp.getActiveDocument().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Parametri

NomeTipoDescrizione
searchPatternStringil pattern regex per cercare
replacementStringil testo da usare come sostituto

Andata e ritorno

Element: 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

setAlignment(alignment)

Imposta il HorizontalAlignment.

Parametri

NomeTipoDescrizione
alignmentHorizontalAlignmentl'allineamento orizzontale

Andata e ritorno

Paragraph: 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

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 di DocumentApp.Attribute e ogni valore di proprietà è il nuovo valore da applicare. 

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

Parametri

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Andata e ritorno

Paragraph: 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

setHeading(heading)

Imposta il ParagraphHeading.

Parametri

NomeTipoDescrizione
headingParagraphHeadingl'intestazione

Andata e ritorno

Paragraph: 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

setIndentEnd(indentEnd)

Imposta il rientro finale, in punti.

Parametri

NomeTipoDescrizione
indentEndNumberil rientro finale, in punti

Andata e ritorno

Paragraph: 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

setIndentFirstLine(indentFirstLine)

Imposta il rientro della prima riga, in punti.

Parametri

NomeTipoDescrizione
indentFirstLineNumberrientro di prima riga, in punti

Andata e ritorno

Paragraph: 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

setIndentStart(indentStart)

Imposta il rientro iniziale in punti.

Parametri

NomeTipoDescrizione
indentStartNumberrientro iniziale, in punti

Andata e ritorno

Paragraph: 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

setLeftToRight(leftToRight)

Consente di configurare l'impostazione da sinistra a destra.

Parametri

NomeTipoDescrizione
leftToRightBooleanl'impostazione da sinistra a destra

Andata e ritorno

Paragraph: 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

setLineSpacing(multiplier)

Imposta l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea.

Parametri

NomeTipoDescrizione
multiplierNumberil numero di righe

Andata e ritorno

Paragraph: 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

setLinkUrl(url)

Imposta l'URL del link.

Parametri

NomeTipoDescrizione
urlStringl'URL del link

Andata e ritorno

Paragraph: 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

setSpacingAfter(spacingAfter)

Imposta la spaziatura dopo l'elemento, in punti.

Parametri

NomeTipoDescrizione
spacingAfterNumberla spaziatura dopo l'elemento, in punti

Andata e ritorno

Paragraph: 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

setSpacingBefore(spacingBefore)

Imposta la spaziatura in punti prima dell'elemento.

Parametri

NomeTipoDescrizione
spacingBeforeNumberla spaziatura prima dell'elemento, in punti

Andata e ritorno

Paragraph: 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

setText(text)

Imposta il contenuto del paragrafo come testo.

Nota: i contenuti esistenti vengono cancellati.

Parametri

NomeTipoDescrizione
textStringi nuovi contenuti testuali

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

setTextAlignment(textAlignment)

Imposta l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT. 

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametri

NomeTipoDescrizione
textAlignmentTextAlignmentil tipo di allineamento del testo da applicare

Andata e ritorno

Paragraph: 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