Questa pagina è stata tradotta dall'API Cloud Translation.

Class DocumentTab

Una scheda di un documento contenente testo avanzato ed elementi come tabelle ed elenchi.

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

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

Metodi

Metodo	Tipo restituito	Breve descrizione
`addBookmark(position)`	`Bookmark`	Aggiunge un `Bookmark` al `Position` specificato.
`addFooter()`	`FooterSection`	Aggiunge una sezione del piè di pagina della scheda, se non esiste.
`addHeader()`	`HeaderSection`	Aggiunge una sezione di intestazione della scheda, se non esiste.
`addNamedRange(name, range)`	`NamedRange`	Aggiunge un `NamedRange`, ovvero un `Range` con un nome e un ID da utilizzare per il recupero successivo.
`getBody()`	`Body`	Recupera il valore `Body` della scheda.
`getBookmark(id)`	`Bookmark`	Recupera il `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 il `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 generatore utilizzato per costruire oggetti `Range` da elementi di tabulazione.

Documentazione dettagliata

`addBookmark(position)`

Aggiunge un Bookmark al 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('123abc').getTab('123abc').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 del piè di pagina della scheda, se non esiste.

// 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('123abc').getTab('123abc').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 esiste.

// 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('123abc').getTab('123abc').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 con un nome e un ID da utilizzare per il recupero successivo. I nomi non sono necessariamente univoci, anche tra le schede; diversi intervalli nello stesso documento possono condividere lo stesso nome, proprio come una classe in HTML. Al contrario, gli ID sono unici all'interno del documento, come un ID in HTML. Una volta aggiunto un NamedRange, non puoi modificarlo, ma solo rimuoverlo.

Qualsiasi script che accede alla scheda può accedere a un NamedRange. Per evitare conflitti involontari tra gli script, ti consigliamo 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.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let 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 compreso tra 1 e 256 caratteri.
`range`	`Range`	L'intervallo di elementi da associare al nome; l'intervallo può essere un risultato di ricerca o 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 esempio HeaderSection, FooterSection). La sezione attiva per una scheda è Body.

I metodi degli elementi in DocumentTab vengono delegati a 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('123abc').getTab('123abc').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: la 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 il Bookmark con l'ID specificato. Questo metodo restituisce null se non esiste un null di questo tipo in questa scheda.Bookmark

// 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('123abc').getTab('123abc').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 del `Bookmark`.

Invio

Bookmark: il Bookmark con l'ID specificato o null se non esiste un Bookmark di questo tipo 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('123abc').getTab('123abc').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 di oggetti Bookmark 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('123abc').getTab('123abc').asDocumentTab();

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

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

`getFootnotes()`

Recupera tutti gli elementi Footnote nel corpo della scheda.

Le chiamate a getFootnotes causano un'iterazione sugli 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('123abc').getTab('123abc').asDocumentTab();

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

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

Invio

Footnote[]: le 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('123abc').getTab('123abc').asDocumentTab();

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

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

`getNamedRangeById(id)`

Recupera il NamedRange con l'ID specificato. Questo metodo restituisce null se non esiste un valore null nella scheda.NamedRange I nomi non sono necessariamente univoci, anche tra le schede; 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 in HTML.

Parametri

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

Invio

NamedRange: il NamedRange con l'ID specificato o null se non esiste un intervallo di questo tipo 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

`getNamedRanges()`

Recupera tutti gli oggetti NamedRange nella scheda.

A un NamedRange può accedere qualsiasi script che accede alla scheda. Per evitare conflitti involontari tra gli script, valuta la possibilità di anteporre ai nomi degli intervalli una stringa univoca.

Invio

NamedRange[]: un array di oggetti NamedRange nella scheda, che può includere più 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 unici, anche tra le schede; 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 in HTML.

Parametri

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

Invio

NamedRange[]: un array di 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 come Position, tra gli altri utilizzi.

// 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.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parametri

Nome	Tipo	Descrizione
`element`	`Element`	L'elemento che contiene il nuovo `Position` to; 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 dello stesso elemento contenitore.

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 generatore utilizzato per costruire oggetti Range da elementi di tabulazione.

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

Invio

RangeBuilder: il nuovo generatore.

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