I contenuti di una scheda in un documento di Documenti Google. Body
può contenere ListItem
,
Elementi Paragraph
, Table
e TableOfContents
. Per ulteriori informazioni
struttura dei documenti, consulta la guida
l'estensione di Documenti Google.
Body
in genere include i contenuti completi della scheda, tranne HeaderSection
, FooterSection
e tutti gli elementi FootnoteSection
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph("A paragraph."); body.appendPageBreak();
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
appendHorizontalRule() | HorizontalRule | Crea e aggiunge un nuovo HorizontalRule . |
appendImage(image) | InlineImage | Crea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato. |
appendImage(image) | InlineImage | Aggiungi il valore InlineImage specificato. |
appendListItem(listItem) | ListItem | Aggiungi il valore ListItem specificato. |
appendListItem(text) | ListItem | Crea e aggiunge un nuovo ListItem contenente i contenuti di testo specificati. |
appendPageBreak() | PageBreak | Crea e aggiunge un nuovo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Aggiungi il valore PageBreak specificato. |
appendParagraph(paragraph) | Paragraph | Aggiungi il valore Paragraph specificato. |
appendParagraph(text) | Paragraph | Crea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati. |
appendTable() | Table | Crea e aggiunge un nuovo Table . |
appendTable(cells) | Table | Aggiunge un nuovo Table contenente un TableCell per ogni valore di stringa specificato. |
appendTable(table) | Table | Aggiungi il valore Table specificato. |
clear() | Body | Cancella i contenuti dell'elemento. |
copy() | Body | Restituisce una copia diretta scollegata dell'elemento corrente. |
editAsText() | Text | Consente di ottenere una versione Text dell'elemento corrente, da modificare. |
findElement(elementType) | RangeElement | Cerca nei contenuti dell'elemento un discendente del tipo specificato. |
findElement(elementType, from) | RangeElement | Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal
specificato RangeElement . |
findText(searchPattern) | RangeElement | Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari. |
findText(searchPattern, from) | RangeElement | Cerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca. |
getAttributes() | Object | Recupera gli attributi dell'elemento. |
getChild(childIndex) | Element | Recupera l'elemento figlio nell'indice figlio specificato. |
getChildIndex(child) | Integer | Recupera l'indice figlio per l'elemento figlio specificato. |
getHeadingAttributes(paragraphHeading) | Object | Recupera l'insieme di attributi per il valore ParagraphHeading fornito. |
getImages() | InlineImage[] | Recupera tutti i valori InlineImages contenuti nella sezione. |
getListItems() | ListItem[] | Recupera tutti i valori ListItems contenuti nella sezione. |
getMarginBottom() | Number | Recupera il margine inferiore, in punti. |
getMarginLeft() | Number | Recupera il margine sinistro, in punti. |
getMarginRight() | Number | Recupera il margine destro. |
getMarginTop() | Number | Recupera il margine superiore. |
getNumChildren() | Integer | Recupera il numero di elementi figlio. |
getPageHeight() | Number | Recupera l'altezza della pagina, in punti. |
getPageWidth() | Number | Recupera la larghezza della pagina, in punti. |
getParagraphs() | Paragraph[] | Recupera tutti i valori Paragraphs contenuti nella sezione (incluso ListItems ). |
getParent() | ContainerElement | Recupera l'elemento principale dell'elemento. |
getTables() | Table[] | Recupera tutti i valori Tables contenuti nella sezione. |
getText() | String | Recupera i contenuti dell'elemento come stringa di testo. |
getTextAlignment() | TextAlignment | Ottiene l'allineamento del testo. |
getType() | ElementType | Recupera il valore ElementType dell'elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserisce un nuovo HorizontalRule nell'indice specificato. |
insertImage(childIndex, image) | InlineImage | Crea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato
indice. |
insertImage(childIndex, image) | InlineImage | Inserisce il valore InlineImage specificato nell'indice specificato. |
insertListItem(childIndex, listItem) | ListItem | Inserisce il valore ListItem specificato nell'indice specificato. |
insertListItem(childIndex, text) | ListItem | Crea e inserisce un nuovo ListItem nell'indice specificato, contenente il valore specificato
contenuti testuali. |
insertPageBreak(childIndex) | PageBreak | Crea e inserisce un nuovo PageBreak nell'indice specificato. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Inserisce il valore PageBreak specificato nell'indice specificato. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserisce il valore Paragraph specificato nell'indice specificato. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato
contenuti testuali. |
insertTable(childIndex) | Table | Crea e inserisce un nuovo Table nell'indice specificato. |
insertTable(childIndex, cells) | Table | Crea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato. |
insertTable(childIndex, table) | Table | Inserisce il valore Table specificato nell'indice specificato. |
removeChild(child) | Body | Rimuove l'elemento secondario specificato. |
replaceText(searchPattern, replacement) | Element | Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari. |
setAttributes(attributes) | Body | Consente di impostare gli attributi dell'elemento. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Imposta gli attributi per l'attributo ParagraphHeading fornito. |
setMarginBottom(marginBottom) | Body | Imposta il margine inferiore, in punti. |
setMarginLeft(marginLeft) | Body | Imposta il margine sinistro, in punti. |
setMarginRight(marginRight) | Body | Imposta il margine destro, in punti. |
setMarginTop(marginTop) | Body | Imposta il margine superiore. |
setPageHeight(pageHeight) | Body | Consente di impostare l'altezza della pagina, in punti. |
setPageWidth(pageWidth) | Body | Imposta la larghezza della pagina, in punti. |
setText(text) | Body | Imposta i contenuti come testo normale. |
setTextAlignment(textAlignment) | Body | Imposta l'allineamento del testo. |
Documentazione dettagliata
appendHorizontalRule()
Crea e aggiunge un nuovo HorizontalRule
.
HorizontalRule
sarà contenuto in un nuovo Paragraph
.
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
appendImage(image)
Crea e aggiunge un nuovo InlineImage
dal blob dell'immagine specificato.
L'immagine sarà contenuta in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | BlobSource | I 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
appendImage(image)
Aggiungi il valore InlineImage
specificato.
InlineImage
sarà contenuto in un nuovo Paragraph
.
Usa questa versione di appendImage
quando aggiungi una copia di un InlineImage
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | InlineImage | I 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
appendListItem(listItem)
Aggiungi il valore ListItem
specificato.
Usa questa versione di appendListItem
quando aggiungi una copia di un ListItem
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
listItem | ListItem | La voce dell'elenco da aggiungere. |
Invio
ListItem
: voce dell'elenco 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
appendListItem(text)
Crea e aggiunge un nuovo ListItem
contenente i contenuti di testo specificati.
Gli elementi consecutivi vengono aggiunti come parte dello stesso elenco.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I contenuti di testo dell'elemento dell'elenco. |
Invio
ListItem
: la nuova voce dell'elenco.
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
.
PageBreak
sarà contenuto in un nuovo Paragraph
.
Invio
PageBreak
: la nuova 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.
PageBreak
sarà contenuto in un nuovo Paragraph
.
Usa questa versione di appendPageBreak
quando aggiungi una copia di un PageBreak
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
pageBreak | PageBreak | L'interruzione di pagina da aggiungere. |
Invio
PageBreak
: l'interruzione di pagina 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
appendParagraph(paragraph)
Aggiungi il valore Paragraph
specificato.
Usa questa versione di appendParagraph
quando aggiungi una copia di un Paragraph
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraph | Paragraph | Il paragrafo da aggiungere. |
Invio
Paragraph
: il paragrafo 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
appendParagraph(text)
Crea e aggiunge un nuovo Paragraph
contenente i contenuti di testo specificati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I contenuti di testo del paragrafo. |
Invio
Paragraph
: il nuovo paragrafo.
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
appendTable()
Crea e aggiunge un nuovo Table
.
Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti di Documenti Google non può terminare con una tabella.
Invio
Table
: la nuova tabella.
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
appendTable(cells)
Aggiunge un nuovo Table
contenente un TableCell
per ogni valore di stringa specificato.
Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti di Documenti Google non può terminare con una tabella.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
cells | String[][] | I contenuti testuali delle celle della tabella da aggiungere alla nuova tabella. |
Invio
Table
: tabella 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
appendTable(table)
Aggiungi il valore Table
specificato.
Usa questa versione di appendTable
quando aggiungi una copia di un Table
esistente.
Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti di Documenti Google
non può terminare con una tabella.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
table | Table | La tabella da aggiungere. |
Invio
Table
: tabella 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
clear()
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
Body
: 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
Nome | Tipo | Descrizione |
---|---|---|
elementType | ElementType | Il 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
Nome | Tipo | Descrizione |
---|---|---|
elementType | ElementType | Il tipo di elemento da cercare. |
from | RangeElement | Il 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
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il 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
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il pattern da cercare |
from | RangeElement | il 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
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
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'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
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'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
getHeadingAttributes(paragraphHeading)
Recupera l'insieme di attributi per il valore ParagraphHeading
fornito.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraphHeading | ParagraphHeading | L'intestazione di cui è necessario recuperare gli attributi. |
Invio
Object
: una mappa degli attributi e dei relativi valori correnti.
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
getImages()
Recupera tutti i valori InlineImages
contenuti nella sezione.
Invio
InlineImage[]
: immagini della sezione.
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
getListItems()
Recupera tutti i valori ListItems
contenuti nella sezione.
Invio
ListItem[]
: le voci dell'elenco delle sezioni.
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
getMarginBottom()
Recupera il margine inferiore, in punti.
Invio
Number
: il margine inferiore, 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
getMarginLeft()
Recupera il margine sinistro, in punti.
Invio
Number
: il margine sinistro, 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
getMarginRight()
Recupera il margine destro.
Invio
Number
: il margine destro, 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
getMarginTop()
Recupera il margine superiore.
Invio
Number
: il margine superiore, 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
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
getPageHeight()
Recupera l'altezza della pagina, in punti.
Invio
Number
: l'altezza della pagina, 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
getPageWidth()
Recupera la larghezza della pagina, in punti.
Invio
Number
: la larghezza della pagina, 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
getParagraphs()
Recupera tutti i valori Paragraphs
contenuti nella sezione (incluso ListItems
).
Invio
Paragraph[]
: i paragrafi della sezione.
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
getTables()
Recupera tutti i valori Tables
contenuti nella sezione.
Invio
Table[]
: le tabelle delle sezioni.
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 nuovo HorizontalRule
nell'indice specificato.
HorizontalRule
sarà contenuto in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
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
insertImage(childIndex, image)
Crea e inserisce un InlineImage
dal blob dell'immagine specificato, nel punto specificato
indice.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
image | BlobSource | I dati dell'immagine. |
Invio
InlineImage
: l'immagine in linea inserita.
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
insertImage(childIndex, image)
Inserisce il valore InlineImage
specificato nell'indice specificato.
L'immagine sarà contenuta in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
image | InlineImage | L'immagine da inserire. |
Invio
InlineImage
: l'immagine in linea inserita.
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
insertListItem(childIndex, listItem)
Inserisce il valore ListItem
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
listItem | ListItem | La voce dell'elenco da inserire. |
Invio
ListItem
: l'elemento dell'elenco 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
insertListItem(childIndex, text)
Crea e inserisce un nuovo ListItem
nell'indice specificato, contenente il valore specificato
contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
text | String | I contenuti di testo dell'elemento dell'elenco. |
Invio
ListItem
: la nuova voce dell'elenco.
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.
PageBreak
sarà contenuto in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
Invio
PageBreak
: la nuova 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.
PageBreak
sarà contenuto in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
pageBreak | PageBreak | L'interruzione di pagina da inserire. |
Invio
PageBreak
: l'interruzione di pagina inserita.
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
insertParagraph(childIndex, paragraph)
Inserisce il valore Paragraph
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
paragraph | Paragraph | Il paragrafo da inserire. |
Invio
Paragraph
- Il paragrafo 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
insertParagraph(childIndex, text)
Crea e inserisce un nuovo Paragraph
nell'indice specificato, contenente il valore specificato
contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
text | String | I contenuti di testo del paragrafo. |
Invio
Paragraph
: il nuovo paragrafo.
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
insertTable(childIndex)
Crea e inserisce un nuovo Table
nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
Invio
Table
: la nuova tabella.
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
insertTable(childIndex, cells)
Crea e inserisce un nuovo Table
contenente le celle specificate, nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
cells | String[][] | I contenuti testuali delle celle della tabella da aggiungere alla nuova tabella. |
Invio
Table
: la nuova tabella.
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
insertTable(childIndex, table)
Inserisce il valore Table
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
table | Table | La tabella da inserire. |
Invio
Table
: la tabella inserita.
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
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'elemento secondario da rimuovere. |
Invio
Body
: 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
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
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il pattern dell'espressione regolare per cercare |
replacement | String | il 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
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
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
Invio
Body
: 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
setHeadingAttributes(paragraphHeading, attributes)
Imposta gli attributi per l'attributo ParagraphHeading
fornito.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraphHeading | ParagraphHeading | L'intestazione di cui impostare gli attributi. |
attributes | Object | Una mappa degli attributi e dei valori su cui impostarli. |
Invio
Body
: 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
setMarginBottom(marginBottom)
Imposta il margine inferiore, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
marginBottom | Number | Il margine inferiore, in punti. |
Invio
Body
: 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
setMarginLeft(marginLeft)
Imposta il margine sinistro, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
marginLeft | Number | Il margine sinistro, in punti. |
Invio
Body
: 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
setMarginRight(marginRight)
Imposta il margine destro, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
marginRight | Number | Margine destro. |
Invio
Body
: 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
setMarginTop(marginTop)
Imposta il margine superiore.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
marginTop | Number | Il margine superiore, in punti. |
Invio
Body
: 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
setPageHeight(pageHeight)
Consente di impostare l'altezza della pagina, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
pageHeight | Number | L'altezza della pagina, in punti. |
Invio
Body
: 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
setPageWidth(pageWidth)
Imposta la larghezza della pagina, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
pageWidth | Number | La larghezza della pagina, in punti. |
Invio
Body
: 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 come testo normale.
Nota: i contenuti esistenti sono stati cancellati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I nuovi contenuti di testo. |
Invio
Body
: 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
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
Nome | Tipo | Descrizione |
---|---|---|
textAlignment | TextAlignment | il tipo di allineamento del testo da applicare |
Invio
Body
: 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