Class DocumentTab

DocumentTab

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

Pobierz kartę dokumentu za pomocą funkcji Document.getTabs()[tabIndex].asDocumentTab().

// Get a specific document tab based on the tab ID.
var documentTab = DocumentApp.openById('abc123456').getTab('t.0').asDocumentTab();

Metody

Metoda	Zwracany typ	Krótki opis
addBookmark(position)	Bookmark	Dodaje Bookmark w podanym elemencie Position.
addFooter()	FooterSection	Jeśli nie ma żadnej sekcji, dodaje sekcję stopki karty.
addHeader()	HeaderSection	Jeśli nie ma żadnej sekcji, dodaje sekcję nagłówka karty.
addNamedRange(name, range)	NamedRange	Dodaje obiekt NamedRange, który jest wartością Range, która ma nazwę i identyfikator dla pobrać później.
getBody()	Body	Pobiera atrybut Body karty.
getBookmark(id)	Bookmark	Pobiera obiekt Bookmark o podanym identyfikatorze.
getBookmarks()	Bookmark[]	Pobiera wszystkie obiekty (Bookmark) na karcie.
getFooter()	FooterSection	Pobiera sekcję stopki karty, jeśli taka istnieje.
getFootnotes()	Footnote[]	Pobiera wszystkie elementy Footnote w treści karty.
getHeader()	HeaderSection	Pobiera sekcję nagłówka karty, jeśli taka istnieje.
getNamedRangeById(id)	NamedRange	Pobiera obiekt NamedRange o podanym identyfikatorze.
getNamedRanges()	NamedRange[]	Pobiera wszystkie obiekty (NamedRange) na karcie.
getNamedRanges(name)	NamedRange[]	Pobiera na karcie wszystkie obiekty NamedRange o podanej nazwie.
newPosition(element, offset)	Position	Tworzy nowy obiekt Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu.
newRange()	RangeBuilder	Tworzy kreator służący do tworzenia obiektów Range z elementów karty.

Szczegółowa dokumentacja

addBookmark(position)

Dodaje Bookmark w podanym elemencie Position.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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

Nazwa	Typ	Opis
position	Position	Pozycja nowej zakładki.

Powrót

Bookmark – nowa zakładka.

Autoryzacja

Skrypty korzystające 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()

Jeśli nie ma żadnej sekcji, dodaje sekcję stopki karty.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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()

Jeśli nie ma żadnej sekcji, dodaje sekcję nagłówka karty.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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 obiekt NamedRange, który jest wartością Range, która ma nazwę i identyfikator dla pobrać później. Nazwy nie muszą być unikalne, nawet dla poszczególnych kart. kilka różnych zakresów w ten sam dokument może mieć taką samą nazwę, podobnie jak klasa w kodzie HTML. Identyfikatory są natomiast unikalny w obrębie dokumentu, np. identyfikator w kodzie HTML. Po dodaniu uprawnienia NamedRange nie będzie można możesz go tylko usunąć.

Każdy skrypt uzyskujący dostęp do karty może uzyskać dostęp do elementu NamedRange. Aby uniknąć niezamierzonego konflikty między skryptami, rozważ poprzedzenie nazw zakresów unikalnymi ciągami znaków.

// Creates a named range that includes every table in the tab with tab ID 't.0'.
var documentTab = DocumentApp.openById('abc123456').getTab('t.0').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());

Parametry

Nazwa	Typ	Opis
name	String	Nazwa zakresu, która nie musi być niepowtarzalna. nazwy zakresów muszą być od 1 do 256 znaków.
range	Range	Zakres elementów, które mają zostać powiązane z nazwą; zakres może być wynikiem wyszukiwania lub ręcznie utworzonym za pomocą funkcji newRange().

Powrót

NamedRange – NamedRange.

Autoryzacja

Skrypty korzystające 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 atrybut Body karty.

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

Metody elementów w narzędziu DocumentTab przekazują uprawnienia do Body.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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 obiekt Bookmark o podanym identyfikatorze. Jeśli na tej karcie nie ma żadnego typu Bookmark, ta metoda zwraca wartość null.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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

Nazwa	Typ	Opis
id	String	Identyfikator elementu Bookmark.

Powrót

Bookmark – Bookmark z podanym identyfikatorem lub null, jeśli nie ma takiego identyfikatora Bookmark znajduje się na karcie.

Autoryzacja

Skrypty korzystające 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 by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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 taka istnieje.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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 getFootnotes powodują wystąpienie iteracji nad elementami karty. W przypadku dużych kart unikaj zbędnych wywołań tej metody.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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 sekcję nagłówka karty, jeśli taka istnieje.

// Opens the Docs file by its ID and retrieves the tab with ID 't.0'. If you created your
// script from within a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the doc ID and the tab ID with your own.
const documentTab = DocumentApp.openById('abc123456').getTab('t.0').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 korzystające 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 obiekt NamedRange o podanym identyfikatorze. Ta metoda zwraca wartość null, jeśli nie ma takiej wartości NamedRange znajduje się na karcie. Nazwy nie muszą być unikalne, nawet dla różnych kart. kilka różnych zakresów w tym samym dokumencie może mieć tę samą nazwę, podobnie jak klasa w HTML. Z kolei identyfikatory na karcie są unikalne, podobnie jak identyfikatory w kodzie HTML.

Parametry

Nazwa	Typ	Opis
id	String	Identyfikator zakresu, który jest unikalny na karcie.

Powrót

NamedRange – NamedRange o podanym identyfikatorze lub null, jeśli nie ma takiego zakresu w kartę.

Autoryzacja

Skrypty korzystające 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.

Dostęp do elementu NamedRange można uzyskać za pomocą dowolnego skryptu, który uzyskuje dostęp do karty. Aby unikać niezamierzone konflikty między skryptami, rozważ dodanie do nazw zakresów unikalnych ciągów znaków.

Powrót

NamedRange[] – tablica obiektów NamedRange na karcie, zawierająca prawdopodobnie kilka wartości; zakresy o tej samej nazwie.

Autoryzacja

Skrypty korzystające 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 na karcie wszystkie obiekty NamedRange 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ć ten sam przypomina nazwę klasy w kodzie HTML. Identyfikatory są natomiast unikalne na karcie, np. identyfikator w HTML.

Dostęp do elementu NamedRange można uzyskać za pomocą dowolnego skryptu, który uzyskuje dostęp do karty. Aby unikać niezamierzone konflikty między skryptami, rozważ dodanie do nazw zakresów unikalnych ciągów znaków.

Parametry

Nazwa	Typ	Opis
name	String	Nazwa zakresu, która nie musi być unikalna.

Powrót

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

Autoryzacja

Skrypty korzystające 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 obiekt Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu. Kursor użytkownika jest reprezentowany m.in. jako Position.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.openById('abc123456');
var documentTab = doc.getTab('t.0').asDocumentTab();
var paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
var position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Parametry

Nazwa	Typ	Opis
element	Element	Element zawierający nowo utworzony element Position do: to musi być element Text lub kontener, np. Paragraph.
offset	Integer	W przypadku elementów Text jest to liczba znaków przed Position; dla pozostałych elementów, jest to liczba elementów podrzędnych przed Position w ten sam element kontenera.

Powrót

Position – nowe Position.

Autoryzacja

Skrypty korzystające 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.
var doc = DocumentApp.openById('abc123456');
var documentTab = doc.getTab('t.0').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());

Powrót

RangeBuilder – nowy kreator.

Autoryzacja

Skrypty korzystające 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