Questa pagina è stata tradotta dall'API Cloud Translation.

Class DocumentTab

Una scheda di un documento contenente testo in formato RTF ed elementi come tabelle ed elenchi.

Recupera una scheda di un documento utilizzando Document.getTabs()[tabIndex].asDocumentTab().

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
var documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

Metodi

Metodo	Tipo restituito	Breve descrizione
`addBookmark(position)`	`Bookmark`	Aggiunge un `Bookmark` a `Position` specificato.
`addFooter()`	`FooterSection`	Aggiunge una sezione per il piè di pagina delle schede, se non ne esiste nessuna.
`addHeader()`	`HeaderSection`	Aggiunge una sezione di intestazione della scheda, se non ne esiste nessuna.
`addNamedRange(name, range)`	`NamedRange`	Aggiunge un `NamedRange`, ovvero un `Range` che ha un nome e un ID da utilizzare per per il recupero in un secondo momento.
`getBody()`	`Body`	Recupera il valore `Body` della scheda.
`getBookmark(id)`	`Bookmark`	Recupera `Bookmark` con l'ID specificato.
`getBookmarks()`	`Bookmark[]`	Recupera tutti gli oggetti `Bookmark` nella scheda.
`getFooter()`	`FooterSection`	Recupera la sezione del piè di pagina della scheda, se esistente.
`getFootnotes()`	`Footnote[]`	Recupera tutti gli elementi `Footnote` nel corpo della scheda.
`getHeader()`	`HeaderSection`	Recupera la sezione dell'intestazione della scheda, se esistente.
`getNamedRangeById(id)`	`NamedRange`	Recupera `NamedRange` con l'ID specificato.
`getNamedRanges()`	`NamedRange[]`	Recupera tutti gli oggetti `NamedRange` nella scheda.
`getNamedRanges(name)`	`NamedRange[]`	Recupera tutti gli oggetti `NamedRange` nella scheda con il nome specificato.
`newPosition(element, offset)`	`Position`	Crea un nuovo `Position`, che è un riferimento a una posizione nella scheda, rispetto a un elemento specifico.
`newRange()`	`RangeBuilder`	Crea un builder utilizzato per costruire oggetti `Range` da elementi scheda.

Documentazione dettagliata

`addBookmark(position)`

Aggiunge un Bookmark a Position specificato.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

Parametri

Nome	Tipo	Descrizione
`position`	`Position`	La posizione del nuovo preferito.

Invio

Bookmark: il nuovo preferito.

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

`addFooter()`

Aggiunge una sezione per il piè di pagina delle schede, se non ne esiste nessuna.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Invio

FooterSection: il piè di pagina 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

`addHeader()`

Aggiunge una sezione di intestazione della scheda, se non ne esiste nessuna.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Invio

HeaderSection: l'intestazione 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

`addNamedRange(name, range)`

Aggiunge un NamedRange, ovvero un Range che ha un nome e un ID da utilizzare per per il recupero in un secondo momento. I nomi non sono necessariamente univoci, anche da una scheda all'altra; diversi intervalli uno stesso documento può avere lo stesso nome, proprio come una classe in HTML. Al contrario, gli ID univoci all'interno del documento, come un ID in HTML. Dopo aver aggiunto un NamedRange, non puoi modificarlo, potete solo rimuoverlo.

Qualsiasi script che accede alla scheda può accedere a un NamedRange. Per evitare indesiderate i conflitti tra gli script, considera l'idea di anteporre ai nomi degli intervalli una stringa univoca.

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
var documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

Parametri

Nome	Tipo	Descrizione
`name`	`String`	Il nome dell'intervallo, che non deve essere univoco. i nomi degli intervalli devono essere tra 1 e 256 caratteri.
`range`	`Range`	L'intervallo di elementi da associare al nome. l'intervallo può essere un risultato di ricerca o essere creato manualmente con `newRange()`.

Invio

NamedRange - Il NamedRange.

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

`getBody()`

Recupera il valore Body della scheda.

Le schede possono contenere diversi tipi di sezioni (ad es. HeaderSection e FooterSection). La sezione attiva di una scheda è Body.

I metodi degli elementi in DocumentTab delegano al Body.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Invio

Body: sezione del corpo 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

`getBookmark(id)`

Recupera Bookmark con l'ID specificato. Questo metodo restituisce null se Bookmark non esiste in questa scheda.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its position to the
// console. Otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Parametri

Nome	Tipo	Descrizione
`id`	`String`	L'ID di `Bookmark`.

Invio

Bookmark: Bookmark con l'ID specificato o null, in caso contrario, Bookmark sono presenti nella 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

`getBookmarks()`

Recupera tutti gli oggetti Bookmark nella scheda.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

Invio

Bookmark[]: un array degli oggetti Bookmark presenti nella 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

`getFooter()`

Recupera la sezione del piè di pagina della scheda, se esistente.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

Invio

FooterSection: piè di pagina 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

`getFootnotes()`

Recupera tutti gli elementi Footnote nel corpo della scheda.

Le chiamate a getFootnotes causano un'iterazione degli elementi della scheda. Per le schede di grandi dimensioni, evita chiamate non necessarie a questo metodo.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Invio

Footnote[]: note a piè di pagina 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

`getHeader()`

Recupera la sezione dell'intestazione della scheda, se esistente.

// Opens the Docs file and retrieves the tab by its IDs. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab = DocumentApp.openById(DOCUMENT_ID).getTab(TAB_ID).asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

Invio

HeaderSection: intestazione 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

`getNamedRangeById(id)`

Recupera NamedRange con l'ID specificato. Questo metodo restituisce null se non è un valore NamedRange esiste nella scheda. I nomi non sono necessariamente univoci, anche da una scheda all'altra; diversi intervalli nello stesso documento possono condividere lo stesso nome, proprio come una classe in HTML. Al contrario, gli ID sono univoci all'interno della scheda, come un ID nel codice HTML.

Parametri

Nome	Tipo	Descrizione
`id`	`String`	L'ID dell'intervallo, che è univoco all'interno della scheda.

Invio

NamedRange: NamedRange con l'ID specificato o null se questo intervallo non esiste in la 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

`getNamedRanges()`

Recupera tutti gli oggetti NamedRange nella scheda.

Un NamedRange è accessibile da qualsiasi script che accede alla scheda. Da evitare Conflitti involontari tra gli script, ti consigliamo di anteporre ai nomi degli intervalli una stringa univoca.

Invio

NamedRange[]: un array degli oggetti NamedRange nella scheda, che potrebbe includere più oggetti intervalli con lo stesso nome.

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

`getNamedRanges(name)`

Recupera tutti gli oggetti NamedRange nella scheda con il nome specificato. I nomi non sono necessariamente univoci anche da una scheda all'altra; diversi intervalli nello stesso documento possono condividere lo stesso proprio come una classe in HTML. Al contrario, gli ID sono univoci all'interno della scheda, come un ID in HTML.

Un NamedRange è accessibile da qualsiasi script che accede alla scheda. Da evitare Conflitti involontari tra gli script, ti consigliamo di anteporre ai nomi degli intervalli una stringa univoca.

Parametri

Nome	Tipo	Descrizione
`name`	`String`	Il nome dell'intervallo, che non è necessariamente univoco.

Invio

NamedRange[]: un array degli oggetti NamedRange nella scheda con il nome 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

`newPosition(element, offset)`

Crea un nuovo Position, che è un riferimento a una posizione nella scheda, rispetto a un elemento specifico. Il cursore dell'utente è rappresentato, ad esempio, da una Position.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
// TODO(developer): Replace the IDs with your own.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parametri

Nome	Tipo	Descrizione
`element`	`Element`	L'elemento che contiene l'elemento `Position` appena creato in cui: deve essere un elemento `Text` o un elemento contenitore come `Paragraph`.
`offset`	`Integer`	Per gli elementi `Text`, il numero di caratteri prima di `Position`; per gli altri elementi, il numero di elementi secondari prima di `Position` all'interno lo stesso elemento container.

Invio

Position: il nuovo Position.

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

`newRange()`

Crea un builder utilizzato per costruire oggetti Range da elementi scheda.

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
var doc = DocumentApp.openById(DOCUMENT_ID);
var documentTab = doc.getTab(TAB_ID).asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Invio

RangeBuilder: il nuovo builder.

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