Class DocumentTab

Dodaje Bookmark w podanym 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

Powrót

Bookmark – nowa zakładka.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Dodaje sekcję stopki karty, jeśli jeszcze jej nie ma.

// 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Dodaje sekcję nagłówka karty, jeśli nie 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();

// 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 użyciem co najmniej jednego z tych zakresów:

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

Dodaje NamedRange, czyli Range, który ma nazwę i identyfikator do późniejszego pobrania. Nazwy nie muszą być unikalne, nawet w obrębie kart. 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 ramach dokumentu, podobnie jak identyfikator w HTML. Po dodaniu NamedRange nie możesz go zmodyfikować, możesz go tylko usunąć.

Każdy skrypt, który ma 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

Powrót

NamedRange – NamedRange.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera Body karty.

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

Metody elementów w DocumentTab delegują do 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera Bookmark o podanym identyfikatorze. Jeśli na karcie nie ma takiego elementu Bookmark, ta metoda zwraca wartość null.

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera sekcję stopki karty, jeśli taka 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|null – stopka karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera wszystkie elementy Footnote w treści karty.

Wywołania funkcji getFootnotes powodują iterację po elementach 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[]|null – przypisy na karcie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera sekcję nagłówka karty, jeśli taka 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|null – nagłówek karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera NamedRange o podanym identyfikatorze. Jeśli na karcie nie ma takiego elementu, ta metoda zwraca wartość null.NamedRange Nazwy nie muszą być unikalne, nawet w obrębie kart. 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 obrębie karty, podobnie jak identyfikator w HTML-u.

Parametry

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera wszystkie obiekty NamedRange na karcie.

Do NamedRange może uzyskać dostęp każdy skrypt, który ma dostęp do karty. Aby uniknąć niepożądanych 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Pobiera wszystkie obiekty NamedRange na karcie o podanej nazwie. Nazwy nie muszą być unikalne, nawet w obrębie kart. 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 obrębie karty, podobnie jak identyfikator w HTML-u.

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

Parametry

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

Tworzy nowy element Position, który jest odwołaniem do lokalizacji na karcie względem określonego elementu. Kursor użytkownika jest reprezentowany przez symbol Position.

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

Powrót

Position – Nowy Position.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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

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

// 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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