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, jednak treść dokumentu TableOfContents jest zwykle generowana automatycznie przez Dokumenty Google. Więcej informacji na temat: strukturę dokumentu, zobacz przewodnik po rozszerzenie Dokumentów Google.

Metody

Metoda	Zwracany typ	Krótki opis
`clear()`	`TableOfContents`	Usuwa 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 elementu podrzędnego określonego typu.
`findElement(elementType, from)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono `RangeElement`.
`findText(searchPattern)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
`findText(searchPattern, from)`	`RangeElement`	Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
`getAttributes()`	`Object`	Pobiera atrybuty elementu.
`getChild(childIndex)`	`Element`	Pobiera element podrzędny z określonego indeksu podrzędnego.
`getChildIndex(child)`	`Integer`	Pobiera indeks podrzędny dla określonego elementu podrzędnego.
`getLinkUrl()`	`String`	Pobiera adres URL linku.
`getNextSibling()`	`Element`	Pobiera kolejny element równorzędny elementu.
`getNumChildren()`	`Integer`	Pobiera liczbę dzieci.
`getParent()`	`ContainerElement`	Pobiera element nadrzędny elementu.
`getPreviousSibling()`	`Element`	Pobiera poprzedni element równorzędny elementu.
`getText()`	`String`	Pobiera zawartość elementu jako ciąg tekstowy.
`getTextAlignment()`	`TextAlignment`	Pobiera wyrównanie tekstu.
`getType()`	`ElementType`	Pobiera wartość `ElementType` elementu.
`isAtDocumentEnd()`	`Boolean`	Określa, czy element jest na końcu `Document`.
`removeFromParent()`	`TableOfContents`	Usuwa element z elementu nadrzędnego.
`replaceText(searchPattern, replacement)`	`Element`	Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
`setAttributes(attributes)`	`TableOfContents`	Ustawia atrybuty elementu.
`setLinkUrl(url)`	`TableOfContents`	Ustawia adres URL linku.
`setTextAlignment(textAlignment)`	`TableOfContents`	Określa wyrównanie tekstu.

Szczegółowa dokumentacja

`clear()`

Usuwa zawartość elementu.

Powrót

TableOfContents – bieżący element.

`copy()`

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

Skopiowane są też wszystkie elementy podrzędne zawarte w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

TableOfContents – nowa wersja,

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

`editAsText()`

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

editAsText umożliwia manipulowanie zawartością elementów jako tekstu sformatowanego. Tryb editAsText ignoruje elementy inne niż tekstowe (np. InlineImage i HorizontalRule).

Elementy podrzędne, które w pełni znajdują się w usuniętym zakresie tekstowym, są usuwane z elementu.

var 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 – wersja tekstowa bieżącego elementu,

`findElement(elementType)`

Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.

Parametry

Nazwa	Typ	Opis
`elementType`	`ElementType`	Typ szukanego elementu.

Powrót

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

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

`findElement(elementType, from)`

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

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

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parametry

Nazwa	Typ	Opis
`elementType`	`ElementType`	Typ szukanego elementu.
`from`	`RangeElement`	Wynik wyszukiwania.

Powrót

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

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

`findText(searchPattern)`

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.

Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, na przykład grup przechwytywania i modyfikatorów trybów.

Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.

Parametry

Nazwa	Typ	Opis
`searchPattern`	`String`	wzorzec do wyszukania

Powrót

RangeElement – wynik wyszukiwania wskazujący pozycję szukanego tekstu lub wartość null, jeśli nie ma wartości; gra

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

`findText(searchPattern, from)`

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.

Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, na przykład grup przechwytywania i modyfikatorów trybów.

Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.

Parametry

Nazwa	Typ	Opis
`searchPattern`	`String`	wzorzec do wyszukania
`from`	`RangeElement`	wynik wyszukiwania

Powrót

RangeElement – wynik wyszukiwania wskazujący następną pozycję wyszukiwanego tekstu lub wartość null, jeśli nie ma podanej wartości; gra

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

`getAttributes()`

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute.

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

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Powrót

Object – atrybuty elementu.

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

`getChild(childIndex)`

Pobiera element podrzędny z określonego indeksu podrzędnego.

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

// Obtain the first element in the tab.
var 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 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

`getChildIndex(child)`

Pobiera indeks podrzędny dla określonego elementu podrzędnego.

Parametry

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

Powrót

Integer – indeks podrzędny.

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

`getLinkUrl()`

Pobiera adres URL linku.

Powrót

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

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

`getNextSibling()`

Pobiera kolejny element równorzędny elementu.

Następne elementy równorzędne mają tego samego elementu nadrzędnego i następują po bieżącym elemencie.

Powrót

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

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

`getNumChildren()`

Pobiera liczbę dzieci.

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

`getParent()`

Pobiera element nadrzędny elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny.

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

`getPreviousSibling()`

Pobiera poprzedni element równorzędny elementu.

Poprzednie elementy nadrzędne mają tego samego elementu nadrzędnego i wyprzedzają bieżący element.

Powrót

Element – poprzedni element równorzędny.

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

`getText()`

Pobiera zawartość elementu jako ciąg tekstowy.

Powrót

String – zawartość elementu w postaci ciągu tekstowego;

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

`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 różne typy tekstu. lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.

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

`getType()`

Pobiera wartość ElementType elementu.

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

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

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

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

`isAtDocumentEnd()`

Określa, czy element jest na końcu Document.

Powrót

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

`removeFromParent()`

Usuwa element z elementu nadrzędnego.

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

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

Powrót

TableOfContents – usunięty element.

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

`replaceText(searchPattern, replacement)`

Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu konieczne jest ominięcie ukośnika wstecznego we wzorcu.

Ta metoda korzysta ze standardowego algorytmu Google RE2 biblioteki wyrażeń, która ogranicza obsługiwaną składnię.

Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.

var 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`	wzorzec wyrażenia regularnego do wyszukania
`replacement`	`String`	tekst, który ma zostać użyty jako zamiennik

Powrót

Element – bieżący element.

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

`setAttributes(attributes)`

Ustawia atrybuty elementu.

Określony parametr atrybutów musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczenie DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowano.

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

// Define a custom paragraph style.
var 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.
var 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 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

`setLinkUrl(url)`

Ustawia adres URL linku.

Parametry

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

Powrót

TableOfContents – bieżący element.

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

`setTextAlignment(textAlignment)`

Określa 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametry

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

Powrót

TableOfContents – bieżący element.

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