Class Paragraph

Paragrafo

Un elemento che rappresenta un paragrafo. Un elemento Paragraph può contenere 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") sono convertiti in caratteri di interruzione di riga ("\r").

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

// Append a tab 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 dell'immagine specificato.
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendInlineImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendInlineImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendPageBreak()PageBreakCrea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)PageBreakAggiungi il valore PageBreak specificato.
appendText(text)TextCrea e aggiunge un nuovo elemento Text con i contenuti specificati.
appendText(text)TextAccoda l'elemento Text specificato.
clear()ParagraphCancella i contenuti dell'elemento.
copy()ParagraphRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente 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 specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAlignment()HorizontalAlignmentRecupera l'oggetto HorizontalAlignment.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getHeading()ParagraphHeadingRecupera l'oggetto ParagraphHeading.
getIndentEnd()NumberRecupera il rientro finale, in punti.
getIndentFirstLine()NumberRecupera il rientro della prima riga, in punti.
getIndentStart()NumberRecupera il rientro iniziale.
getLineSpacing()NumberRecupera l'interlinea, in punti.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPositionedImage(id)PositionedImageRecupera un valore PositionedImage dall'ID dell'immagine.
getPositionedImages()PositionedImage[]Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente 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()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un HorizontalRule nell'indice specificato.
insertInlineImage(childIndex, image)InlineImageCrea e inserisce un nuovo InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertInlineImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertPageBreak(childIndex)PageBreakCrea e inserisce un nuovo PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)PageBreakInserisce il valore PageBreak specificato nell'indice specificato.
insertText(childIndex, text)TextCrea e inserisce un nuovo elemento di testo in corrispondenza dell'indice specificato.
insertText(childIndex, text)TextInserisce l'elemento Text specificato nell'indice specificato, con il testo specificato contenuti.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
isLeftToRight()BooleanRecupera l'impostazione da sinistra a destra.
merge()ParagraphUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeChild(child)ParagraphRimuove l'elemento secondario specificato.
removeFromParent()ParagraphRimuove l'elemento da quello principale.
removePositionedImage(id)BooleanRimuove una PositionedImage dall'ID dell'immagine.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAlignment(alignment)ParagraphImposta il HorizontalAlignment.
setAttributes(attributes)ParagraphConsente di impostare 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 impostare un'impostazione da sinistra a destra.
setLineSpacing(multiplier)ParagraphConsente di impostare l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea.
setLinkUrl(url)ParagraphImposta l'URL del link.
setSpacingAfter(spacingAfter)ParagraphConsente di impostare la spaziatura dopo l'elemento, in punti.
setSpacingBefore(spacingBefore)ParagraphConsente di impostare la spaziatura prima dell'elemento, in punti.
setText(text)voidImposta i contenuti del paragrafo come testo.
setTextAlignment(textAlignment)ParagraphImposta l'allineamento del testo.

Documentazione dettagliata

addPositionedImage(image)

Crea e inserisce un nuovo PositionedImage dal blob dell'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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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 tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

Parametri

NomeTipoDescrizione
imageBlobSourceI dati dell'immagine.

Invio

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

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

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

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

Invio

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 dell'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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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 dell'immagine.

Invio

InlineImage: 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)

Aggiungi il valore 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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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 dell'immagine.

Invio

InlineImage: 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 potrebbe non essere contenuto in TableCells. Se l'elemento corrente è contenuto in una cella di 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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

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

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

Invio

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)

Aggiungi il valore PageBreak specificato.

Nota: PageBreaks non può essere contenuto in TableCells. Se l'elemento corrente esiste in una cella di 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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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.

Invio

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

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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
textStringI contenuti del testo.

Invio

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)

Accoda 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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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.

Invio

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.

Invio

Paragraph: l'elemento corrente.


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

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

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

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

Gli elementi secondari completamente contenuti all'interno di un intervallo di testo eliminato vengono rimossi dall'elemento.

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

Invio

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.

Invio

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 specificato RangeElement.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 di ricerca da cui eseguire la ricerca.

Invio

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 caratteristiche dell'espressione regolare JavaScript non è completamente supportato, ad esempio: gruppi di acquisizione e modificatori di modalità.

Il pattern dell'espressione regolare fornito viene confrontato in modo indipendente con ogni blocco di testo contenuto nell'elemento corrente.

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare

Invio

RangeElement: un risultato di ricerca che indica la posizione del testo di ricerca o nullo in caso contrario compensare

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 i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.

Un sottoinsieme delle caratteristiche dell'espressione regolare JavaScript non è completamente supportato, ad esempio: gruppi di acquisizione e modificatori di modalità.

Il pattern dell'espressione regolare fornito viene confrontato in modo indipendente con ogni blocco di testo contenuto nell'elemento corrente.

Parametri

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

Invio

RangeElement: un risultato di ricerca che indica la posizione successiva del testo di ricerca o nullo se non è presente compensare

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 l'oggetto 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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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());

Invio

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

getChild(childIndex)

Recupera l'elemento figlio nell'indice figlio specificato.

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

// Obtain the first element in the tab.
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 figlio da recuperare.

Invio

Element: l'elemento secondario nell'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.

Invio

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 l'oggetto 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(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().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());

Invio

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.

Invio

Number: il 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 rientro della prima riga, in punti.

Invio

Number: il rientro della 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.

Invio

Number: il 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.

Invio

Number: 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.

Invio

String: l'URL del link o nullo 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 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

getNumChildren()

Recupera il numero di elementi figlio.

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

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

Invio

Integer: il 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.

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

getPositionedImage(id)

Recupera un valore PositionedImage dall'ID dell'immagine.

Parametri

NomeTipoDescrizione
idStringl'ID immagine

Invio

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.

Invio

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

getSpacingAfter()

Recupera la spaziatura dopo l'elemento, in punti.

Invio

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.

Invio

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.

Invio

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

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

Invio

TextAlignment: il tipo di allineamento del testo o null se il testo contiene più tipi di testo allineamenti o se l'allineamento del testo 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 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

insertHorizontalRule(childIndex)

Crea e inserisce un HorizontalRule nell'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento

Invio

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 dell'immagine specificato, nel punto specificato indice.

Parametri

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

Invio

InlineImage: l'elemento 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 nell'indice specificato.

Parametri

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

Invio

InlineImage: l'elemento 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 potrebbe non essere contenuto in TableCells. Se l'elemento corrente è contenuto in una cella di tabella, verrà generata un'eccezione.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento

Invio

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 nell'indice specificato.

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

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
pageBreakPageBreakl'interruzione p[age per inserire

Invio

PageBreak: l'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 in corrispondenza dell'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
textStringi contenuti del testo

Invio

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 nell'indice specificato, con il testo specificato contenuti.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
textTextl'elemento di testo per inserire

Invio

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

isLeftToRight()

Recupera l'impostazione da sinistra a destra.

Invio

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 l'elemento di pari livello precedente dello stesso tipo.

È possibile unire solo elementi dello stesso elemento ElementType. Qualsiasi elemento secondario contenuto in gli elementi correnti vengono spostati all'elemento di pari livello precedente.

L'elemento corrente viene rimosso dal documento.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

Invio

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

Invio

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

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

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 una PositionedImage dall'ID dell'immagine.

Parametri

NomeTipoDescrizione
idStringl'ID immagine

Invio

Boolean: indica se l'immagine specificata è stata rimossa o meno

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 regolari le espressioni regolari.

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

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

Il pattern dell'espressione regolare fornito viene confrontato in modo indipendente con ogni blocco di testo contenuto nell'elemento corrente.

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

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

Parametri

NomeTipoDescrizione
searchPatternStringil pattern dell'espressione regolare per cercare
replacementStringil testo da utilizzare come sostituzione

Invio

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

setAlignment(alignment)

Imposta il HorizontalAlignment.

Parametri

NomeTipoDescrizione
alignmentHorizontalAlignmentl'allineamento orizzontale

Invio

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

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

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

Invio

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

setIndentEnd(indentEnd)

Imposta il rientro finale, in punti.

Parametri

NomeTipoDescrizione
indentEndNumberil rientro finale, in punti

Invio

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

setIndentFirstLine(indentFirstLine)

Imposta il rientro della prima riga, in punti.

Parametri

NomeTipoDescrizione
indentFirstLineNumberil rientro della prima riga, in punti

Invio

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

setIndentStart(indentStart)

Imposta il rientro iniziale in punti.

Parametri

NomeTipoDescrizione
indentStartNumberil rientro iniziale, in punti

Invio

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

setLeftToRight(leftToRight)

Consente di impostare un'impostazione da sinistra a destra.

Parametri

NomeTipoDescrizione
leftToRightBooleanl'impostazione da sinistra a destra

Invio

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

setLineSpacing(multiplier)

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

Parametri

NomeTipoDescrizione
multiplierNumberil numero di righe

Invio

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

setLinkUrl(url)

Imposta l'URL del link.

Parametri

NomeTipoDescrizione
urlStringl'URL del link

Invio

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

setSpacingAfter(spacingAfter)

Consente di impostare la spaziatura dopo l'elemento, in punti.

Parametri

NomeTipoDescrizione
spacingAfterNumberla spaziatura dopo l'elemento, in punti

Invio

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

setSpacingBefore(spacingBefore)

Consente di impostare la spaziatura prima dell'elemento, in punti.

Parametri

NomeTipoDescrizione
spacingBeforeNumberla spaziatura prima dell'elemento, in punti

Invio

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

setText(text)

Imposta i contenuti del paragrafo come testo.

Nota: i contenuti esistenti sono stati 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 in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametri

NomeTipoDescrizione
textAlignmentTextAlignmentil tipo di allineamento del testo da applicare

Invio

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