Class DocumentTab

DocumentoTab

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

MetodoTipo restituitoBreve descrizione
addBookmark(position)BookmarkAggiunge un Bookmark al Position specificato.
addFooter()FooterSectionAggiunge una sezione del 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 valore Body della scheda.
getBookmark(id)BookmarkRecupera il Bookmark con l'ID specificato.
getBookmarks()Bookmark[]Recupera tutti gli oggetti Bookmark nella scheda.
getFooter()FooterSectionRecupera la sezione del piè di pagina della scheda, se esistente.
getFootnotes()Footnote[]Recupera tutti gli elementi Footnote nel corpo della scheda.
getHeader()HeaderSectionRecupera la sezione dell'intestazione della scheda, se esistente.
getNamedRangeById(id)NamedRangeRecupera 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)PositionCrea un nuovo Position, che è un riferimento a una posizione nella scheda, rispetto a un elemento specifico.
newRange()RangeBuilderCrea un generatore utilizzato per costruire oggetti Range da elementi di tabulazione.

Documentazione dettagliata

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

NomeTipoDescrizione
idStringL'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

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

NomeTipoDescrizione
idStringL'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.

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.

Parametri

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

NomeTipoDescrizione
elementElementL'elemento che contiene il nuovo Position to; 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.

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