Class DocumentTab

Karta Dokument

Karta dokumentu zawierająca tekst formatowany i elementy takie jak tabele i listy.

Pobierz kartę dokumentu za pomocą 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();

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje Bookmark w danym Position.
addFooter()FooterSectionDodaje sekcję stopki karty, jeśli nie ma takiej sekcji.
addHeader()HeaderSectionDodaje sekcję nagłówka karty, jeśli nie ma takiej sekcji.
addNamedRange(name, range)NamedRangeDodaje NamedRange, czyli Range z nazwą i identyfikatorem do użycia do późniejszego wyszukiwania.
getBody()BodyPobiera wartość Body karty.
getBookmark(id)BookmarkPobiera Bookmark o podanym identyfikatorze.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark na karcie.
getFooter()FooterSectionPobiera sekcję stopki karty, jeśli istnieje.
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote w treści karty.
getHeader()HeaderSectionPobiera nagłówek karty, jeśli istnieje.
getNamedRangeById(id)NamedRangePobiera NamedRange o podanym identyfikatorze.
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty NamedRange na karcie.
getNamedRanges(name)NamedRange[]Pobiera wszystkie obiekty NamedRange na karcie o podanej nazwie.
newPosition(element, offset)PositionTworzy nowy element Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu.
newRange()RangeBuilderTworzy kreator służący do tworzenia obiektów Range z elementów karty.

Szczegółowa dokumentacja

addBookmark(position)

Dodaje Bookmark w danym Position. 

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

Parametry

NazwaTypOpis
positionPositionpozycja nowej zakładki.

Powrót

Bookmark – nowa zakładka.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addFooter()

Dodaje sekcję stopki karty, jeśli nie ma takiej sekcji. 

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

Powrót

FooterSection – stopka karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addHeader()

Dodaje sekcję nagłówka karty, jeśli nie ma takiej sekcji. 

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

Powrót

HeaderSection – nagłówek karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

addNamedRange(name, range)

Dodaje NamedRange, czyli Range z nazwą i identyfikatorem do użycia do późniejszego wyszukiwania. Nazwy nie muszą być unikalne, nawet na różnych kartach. Kilka różnych zakresów w tym samym dokumencie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne w dokumencie, podobnie jak identyfikatory w HTML. Po dodaniu NamedRange nie możesz go zmodyfikować, możesz go tylko usunąć.

Każdy skrypt, który uzyskuje dostęp do karty, może uzyskać dostęp do NamedRange. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków. 

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

Parametry

NazwaTypOpis
nameStringNazwa zakresu, która nie musi być niepowtarzalna. Nazwy zakresów muszą mieć od 1 do 256 znaków.
rangeRangeZakres elementów do powiązania z nazwą; zakres może być wynikiem wyszukiwania lub ręcznie utworzony za pomocą atrybutu newRange().

Powrót

NamedRange – NamedRange.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBody()

Pobiera wartość Body karty.

Karty mogą zawierać różne typy sekcji (np. HeaderSection, FooterSection). Aktywna sekcja na karcie to Body.

Metody elementów w komponencie DocumentTab są delegowane do komponentu 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());

Powrót

Body – sekcja treści karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmark(id)

Pobiera Bookmark o podanym identyfikatorze. Ta metoda zwraca null, jeśli na tej karcie nie ma takiego elementu 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.');
}

Parametry

NazwaTypOpis
idStringIdentyfikator Bookmark.

Powrót

Bookmark – Bookmark o podanym identyfikatorze lub null, jeśli na karcie nie ma takiego Bookmark.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getBookmarks()

Pobiera wszystkie obiekty Bookmark na karcie. 

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

Powrót

Bookmark[] – tablica obiektów Bookmark na karcie.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFooter()

Pobiera sekcję stopki karty, jeśli istnieje. 

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

Powrót

FooterSection – stopka karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getFootnotes()

Pobiera wszystkie elementy Footnote w treści karty.

Wywołania funkcji getFootnotes powodują iterację elementów karty. W przypadku dużych kart unikaj niepotrzebnych wywołań tej metody. 

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

Powrót

Footnote[] – przypisy do karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeader()

Pobiera nagłówek karty, jeśli istnieje. 

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

Powrót

HeaderSection – nagłówek karty.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRangeById(id)

Pobiera NamedRange o podanym identyfikatorze. Ta metoda zwraca null, jeśli na karcie nie ma takiego elementu NamedRange. Nazwy nie muszą być unikalne, nawet na różnych kartach. Kilka różnych zakresów w tym samym dokumencie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne na karcie, podobnie jak identyfikator w HTML.

Parametry

NazwaTypOpis
idStringIdentyfikator zakresu, który jest unikalny w ramach karty.

Powrót

NamedRange – NamedRange o podanym identyfikatorze lub null, jeśli taki zakres nie istnieje na tej karcie.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges()

Pobiera wszystkie obiekty NamedRange na karcie.

Do NamedRange może uzyskać dostęp dowolny skrypt, który uzyskuje dostęp do karty. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków.

Powrót

NamedRange[] – tablica obiektów NamedRange na karcie, która może zawierać wiele zakresów o tej samej nazwie.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNamedRanges(name)

Pobiera wszystkie obiekty NamedRange na karcie o podanej nazwie. Nazwy nie muszą być unikalne, nawet na różnych kartach. Kilka różnych zakresów w tym samym dokumencie może mieć tę samą nazwę, podobnie jak klasa w HTML. Identyfikatory są natomiast unikalne na karcie, podobnie jak identyfikator w HTML.

Do NamedRange może uzyskać dostęp dowolny skrypt, który uzyskuje dostęp do karty. Aby uniknąć niezamierzonych konfliktów między skryptami, rozważ dodanie do nazw zakresów unikalnego ciągu znaków.

Parametry

NazwaTypOpis
nameStringNazwa zakresu, która nie musi być unikalna.

Powrót

NamedRange[] – tablica obiektów NamedRange na karcie o podanej nazwie.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newPosition(element, offset)

Tworzy nowy element Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu. Kursor użytkownika jest reprezentowany przez Position, między innymi. 

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

Parametry

NazwaTypOpis
elementElementElement, który zawiera nowo utworzony element Position. Musi to być element Text lub element kontenera, np. Paragraph.
offsetIntegerW przypadku elementów Text liczba znaków przed Position; w przypadku innych elementów liczba elementów podrzędnych przed Position w tym samym elemencie kontenera.

Powrót

Position – nowy Position.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

newRange()

Tworzy kreator służący do tworzenia obiektów Range z elementów karty. 

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

Powrót

RangeBuilder – nowy kreator.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents