Ta strona została przetłumaczona przez Cloud Translation API.

Class TableOfContents

Element zawierający spis treści. Element TableOfContents może zawierać elementy ListItem, Paragraph i Table, ale zawartość elementu TableOfContents jest zwykle generowana automatycznie przez Dokumenty Google. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.

Metody

Metoda	Zwracany typ	Krótki opis
`clear()`	`TableOfContents`	Czyści zawartość elementu.
`copy()`	`TableOfContents`	Zwraca odłączoną, głęboką kopię bieżącego elementu.
`editAsText()`	`Text`	Pobiera wersję `Text` bieżącego elementu do edycji.
`findElement(elementType)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem potomka określonego typu.
`findElement(elementType, from)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu `RangeElement`.
`findText(searchPattern)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
`findText(searchPattern, from)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
`getAttributes()`	`Object`	Pobiera atrybuty elementu.
`getChild(childIndex)`	`Element`	Pobiera element podrzędny o określonym indeksie podrzędnym.
`getChildIndex(child)`	`Integer`	Pobiera indeks podrzędnego elementu podrzędnego.
`getLinkUrl()`	`String`	Pobiera adres URL linku.
`getNextSibling()`	`Element`	Pobiera następny element nadrzędny.
`getNumChildren()`	`Integer`	Pobiera liczbę dzieci.
`getParent()`	`ContainerElement`	Pobiera element nadrzędny.
`getPreviousSibling()`	`Element`	Pobiera poprzedni element nadrzędny elementu.
`getText()`	`String`	Pobiera zawartość elementu jako ciąg tekstowy.
`getTextAlignment()`	`TextAlignment`	Pobiera wyrównanie tekstu.
`getType()`	`ElementType`	Pobiera wartość atrybutu `ElementType` elementu.
`isAtDocumentEnd()`	`Boolean`	Określa, czy element znajduje się na końcu `Document`.
`removeFromParent()`	`TableOfContents`	Usuwa element z jego elementu nadrzędnego.
`replaceText(searchPattern, replacement)`	`Element`	Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
`setAttributes(attributes)`	`TableOfContents`	Ustawia atrybuty elementu.
`setLinkUrl(url)`	`TableOfContents`	Ustawia adres URL linku.
`setTextAlignment(textAlignment)`	`TableOfContents`	Ustawia wyrównanie tekstu.

Szczegółowa dokumentacja

`clear()`

Czyści zawartość elementu.

Powrót

TableOfContents – bieżący element.

`copy()`

Zwraca odłączoną, głęboką kopię bieżącego elementu.

Skopiowane zostaną też wszystkie elementy podrzędne obecne w danym elemencie. Nowy element nie ma rodzica.

Powrót

TableOfContents – nowa kopia.

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

`editAsText()`

Pobiera wersję Text bieżącego elementu do edycji.

Aby manipulować zawartością elementów jako tekstem sformatowanym, użyj editAsText. Tryb editAsText ignoruje elementy inne niż tekstowe (takie jak InlineImage i HorizontalRule).

Elementy podrzędne całkowicie zawarte w usuniętym zakresie tekstu są usuwane z elementu.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Powrót

Text – tekstowa wersja bieżącego elementu

`findElement(elementType)`

Przeszukuje zawartość elementu pod kątem potomka określonego typu.

Parametry

Nazwa	Typ	Opis
`elementType`	`ElementType`	Typ elementu do wyszukania.

Powrót

RangeElement – wynik wyszukiwania wskazujący pozycję elementu wyszukiwania.

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

`findElement(elementType, from)`

Przeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parametry

Nazwa	Typ	Opis
`elementType`	`ElementType`	Typ elementu do wyszukania.
`from`	`RangeElement`	Wynik wyszukiwania, z którego chcesz wyszukiwać.

Powrót

RangeElement – wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.

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

`findText(searchPattern)`

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.

Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, np. grupy uchwytywania i modyfikatory trybu.

Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

Nazwa	Typ	Opis
`searchPattern`	`String`	wzór do wyszukania.

Powrót

RangeElement – wynik wyszukiwania wskazujący pozycję tekstu wyszukiwania lub null, jeśli nie ma dopasowania

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

`findText(searchPattern, from)`

Przeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.

Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, np. grupy uchwytywania i modyfikatory trybu.

Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

Nazwa	Typ	Opis
`searchPattern`	`String`	wzór do wyszukania.
`from`	`RangeElement`	wynik wyszukiwania, z którego chcesz wyszukiwać

Powrót

RangeElement – wynik wyszukiwania wskazujący następną pozycję tekstu wyszukiwania lub null, jeśli nie ma dopasowania

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

`getAttributes()`

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym każda nazwa właściwości odpowiada elementowi w wyliczeniu DocumentApp.Attribute.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Powrót

Object – atrybuty elementu.

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

`getChild(childIndex)`

Pobiera element podrzędny o określonym indeksie podrzędnym.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parametry

Nazwa	Typ	Opis
`childIndex`	`Integer`	Indeks elementu podrzędnego do pobrania.

Powrót

Element – element podrzędny o określonym indeksie.

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

`getChildIndex(child)`

Pobiera indeks podrzędnego elementu podrzędnego.

Parametry

Nazwa	Typ	Opis
`child`	`Element`	Element podrzędny, którego indeks ma zostać pobrany.

Powrót

Integer – indeks podrzędny.

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

`getLinkUrl()`

Pobiera adres URL linku.

Powrót

String – adres URL linku lub null, jeśli element zawiera wiele wartości tego atrybutu

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

`getNextSibling()`

Pobiera następny element nadrzędny.

Następny element równego rzędu ma tego samego rodzica i następuje po bieżącym elemencie.

Powrót

Element – następny element równorzędny.

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

`getNumChildren()`

Pobiera liczbę dzieci.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Powrót

Integer – liczba dzieci.

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

`getParent()`

Pobiera element nadrzędny.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny.

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

`getPreviousSibling()`

Pobiera poprzedni element nadrzędny elementu.

Poprzedni element ma tego samego rodzica i poprzedza bieżący element.

Powrót

Element – poprzedni równorzędny element.

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

`getText()`

Pobiera zawartość elementu jako ciąg tekstowy.

Powrót

String – zawartość elementu jako ciąg tekstowy

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

`getTextAlignment()`

Pobiera wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

Powrót

TextAlignment – typ wyrównania tekstu lub null, jeśli tekst zawiera wiele typów wyrównania lub jeśli wyrównanie tekstu nigdy nie zostało ustawione

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

`getType()`

Pobiera wartość atrybutu ElementType elementu.

Aby określić dokładny typ danego elementu, użyj właściwości getType().

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Powrót

ElementType – typ elementu.

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

`isAtDocumentEnd()`

Określa, czy element znajduje się na końcu Document.

Powrót

Boolean – określa, czy element znajduje się na końcu 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

`removeFromParent()`

Usuwa element z jego elementu nadrzędnego.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Powrót

TableOfContents – usunięty element.

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

`replaceText(searchPattern, replacement)`

Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.

Wzór wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScriptu. W tym celu musisz uciec się do użycia ukośnika wstecznego w wzorze.

Ta metoda korzysta z biblioteki wyrażeń regularnych RE2 firmy Google, która ogranicza obsługiwaną składnię.

Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Parametry

Nazwa	Typ	Opis
`searchPattern`	`String`	wzór wyrażenia regularnego do wyszukania;
`replacement`	`String`	tekst, który ma być użyty jako tekst zastępczy;

Powrót

Element – bieżący element.

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

`setAttributes(attributes)`

Ustawia atrybuty elementu.

Parametr specified attributes musi być obiektem, w którym każda nazwa właściwości jest elementem zbioru wyliczenia DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowania.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parametry

Nazwa	Typ	Opis
`attributes`	`Object`	atrybuty elementu,

Powrót

TableOfContents – bieżący element.

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

`setLinkUrl(url)`

Ustawia adres URL linku.

Parametry

Nazwa	Typ	Opis
`url`	`String`	adres URL linku,

Powrót

TableOfContents – bieżący element.

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

`setTextAlignment(textAlignment)`

Ustawia wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametry

Nazwa	Typ	Opis
`textAlignment`	`TextAlignment`	typ wyrównania tekstu, który ma być zastosowany.

Powrót

TableOfContents – bieżący element.

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