Class DocumentTab

DocumentTab

Una scheda del documento, contenente testo RTF 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

MetodoTipo restituitoBreve descrizione
addBookmark(position)BookmarkAggiunge un Bookmark in corrispondenza del Position specificato.
addFooter()FooterSectionAggiunge una sezione di piè di pagina della scheda, se non esiste.
addHeader()HeaderSectionAggiunge una sezione di intestazione della scheda, se non esiste.
addNamedRange(name, range)NamedRangeAggiunge un NamedRange, ovvero un Range con un nome e un ID da utilizzare per il recupero successivo.
getBody()BodyRecupera il Body della scheda.
getBookmark(id)Bookmark|nullRecupera Bookmark con l'ID specificato.
getBookmarks()Bookmark[]Recupera tutti gli oggetti Bookmark nella scheda.
getFooter()FooterSection|nullRecupera la sezione del piè di pagina della scheda, se presente.
getFootnotes()Footnote[]|nullRecupera tutti gli elementi Footnote nel corpo della scheda.
getHeader()HeaderSection|nullRecupera la sezione dell'intestazione della scheda, se esiste.
getNamedRangeById(id)NamedRange|nullRecupera 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)PositionCrea un nuovo Position, ovvero un riferimento a una posizione nella scheda, relativa a un elemento specifico.
newRange()RangeBuilderCrea un builder utilizzato per costruire oggetti Range dagli elementi delle schede.

Documentazione dettagliata

addBookmark(position)

Aggiunge un Bookmark in corrispondenza del 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

NomeTipoDescrizione
positionPositionLa posizione del nuovo segnalibro.

Indietro

Bookmark: il nuovo segnalibro.

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

Indietro

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

Indietro

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, nemmeno nelle 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 del documento, come un ID in HTML. Dopo aver 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, valuta la possibilità di aggiungere un prefisso ai nomi degli intervalli con 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

NomeTipoDescrizione
nameStringIl nome dell'intervallo, che non deve essere univoco; i nomi degli intervalli devono essere compresi tra 1 e 256 caratteri.
rangeRangeL'intervallo di elementi da associare al nome. L'intervallo può essere un risultato di ricerca o costruito manualmente con newRange().

Indietro

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 Body della scheda.

Le schede possono contenere diversi tipi di sezioni (ad esempio HeaderSection, FooterSection). La sezione attiva di 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());

Indietro

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 Bookmark con l'ID specificato. Questo metodo restituisce null se non esiste alcun Bookmark all'interno di 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('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

NomeTipoDescrizione
idStringL'ID di Bookmark.

Indietro

Bookmark|null: il Bookmark con l'ID specificato o null se non esiste alcun 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

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

Indietro

Bookmark[]: un array degli 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 presente. 

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

Indietro

FooterSection|null: 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());

Indietro

Footnote[]|null: 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 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();

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

Indietro

HeaderSection|null: 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 NamedRange con l'ID specificato. Questo metodo restituisce null se non esiste NamedRange nella scheda. I nomi non sono necessariamente univoci, nemmeno 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

NomeTipoDescrizione
idStringL'ID dell'intervallo, univoco all'interno della scheda.

Indietro

NamedRange|null: 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.

Un NamedRange può essere accessibile da qualsiasi script che accede alla scheda. Per evitare conflitti indesiderati tra script, valuta la possibilità di aggiungere un prefisso ai nomi degli intervalli con una stringa univoca.

Indietro

NamedRange[]: un array degli oggetti NamedRange nella scheda, che potrebbe 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 univoci, nemmeno 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.

Un NamedRange può essere accessibile da qualsiasi script che accede alla scheda. Per evitare conflitti indesiderati tra script, valuta la possibilità di aggiungere un prefisso ai nomi degli intervalli con una stringa univoca.

Parametri

NomeTipoDescrizione
nameStringIl nome dell'intervallo, che non è necessariamente univoco.

Indietro

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, ovvero un riferimento a una posizione nella scheda, relativa a un elemento specifico. Il cursore dell'utente è rappresentato da un 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

NomeTipoDescrizione
elementElementL'elemento che contiene il nuovo Position; deve essere un elemento Text o un elemento contenitore come Paragraph.
offsetIntegerPer 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.

Indietro

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 dagli elementi delle schede. 

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

Indietro

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