Element reprezentujący sekcję przypisów. Element Footnote zawiera tekst, który odpowiada elementowi Footnote. Element Footnote może zawierać elementy List lub Paragraph. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.
Metody
| Metoda | Zwracany typ | Krótki opis |
|---|---|---|
append | Paragraph | Dołącza podany element Paragraph. |
append | Paragraph | Tworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe. |
clear() | Footnote | Usuwa zawartość elementu. |
copy() | Footnote | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
edit | Text | Pobiera wersję Text bieżącego elementu do edycji. |
find | Range | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
find | Range | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu Range. |
find | Range | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych. |
find | Range | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania. |
get | Object | Pobiera atrybuty elementu. |
get | Element | Pobiera element podrzędny o określonym indeksie. |
get | Integer | Pobiera indeks elementu podrzędnego dla określonego elementu podrzędnego. |
get | Element|null | Pobiera następny element równorzędny. |
get | Integer | Pobiera liczbę dzieci. |
get | Paragraph[]|null | Pobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym List). |
get | Container | Pobiera element nadrzędny elementu. |
get | Element|null | Pobiera poprzedni element sąsiedni elementu. |
get | String | Pobiera zawartość elementu jako ciąg tekstowy. |
get | Text | Pobiera wyrównanie tekstu. |
get | Element | Pobiera Element elementu. |
insert | Paragraph | Wstawia podany element Paragraph w określonym indeksie. |
insert | Paragraph | Tworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową. |
remove | Footnote | Usuwa określony element podrzędny. |
remove | Footnote | Usuwa element z elementu nadrzędnego. |
replace | Element | Zamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych. |
set | Footnote | Ustawia atrybuty elementu. |
set | Footnote | Ustawia zawartość jako zwykły tekst. |
set | Footnote | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
append Paragraph(paragraph)
Dołącza podany element Paragraph.
Użyj tej wersji append, gdy dołączasz kopię istniejącego Paragraph.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
paragraph | Paragraph | Akapit do załączenia. |
Powrót
Paragraph – dołączony akapit.
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
append Paragraph(text)
Tworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | String | Zawartość tekstowa akapitu. |
Powrót
Paragraph – nowy akapit.
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
clear()
copy()
Zwraca odłączoną, głęboką kopię bieżącego elementu.
Kopiowane są też wszystkie elementy podrzędne znajdujące się w elemencie. Nowy element nie ma elementu nadrzędnego.
Powrót
Footnote – nowy tekst.
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
edit As Text()
Pobiera wersję Text bieżącego elementu do edycji.
Użyj edit, aby manipulować zawartością elementów jako tekstem sformatowanym. Tryb edit ignoruje elementy inne niż tekstowe (takie jak Inline i Horizontal).
Elementy podrzędne w pełni zawarte w zakresie usuniętego 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.
find Element(elementType)
Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
element | Element | Typ elementu do wyszukania. |
Powrót
Range – wynik wyszukiwania wskazujący pozycję elementu wyszukiwania.
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
find Element(elementType, from)
Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu Range.
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 |
|---|---|---|
element | Element | Typ elementu do wyszukania. |
from | Range | Wynik wyszukiwania, z którego chcesz wyszukiwać. |
Powrót
Range – wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.
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
find Text(searchPattern)
Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
Niektóre funkcje wyrażeń regularnych JavaScriptu nie są w pełni obsługiwane, np. grupy przechwytywania i modyfikatory trybu.
Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstu zawartego w bieżącym elemencie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
search | String | wzór do wyszukania, |
Powrót
Range – wynik wyszukiwania wskazujący pozycję tekstu wyszukiwania lub wartość null, jeśli nie ma dopasowania.
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
find Text(searchPattern, from)
Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
Niektóre funkcje wyrażeń regularnych JavaScriptu nie są w pełni obsługiwane, np. grupy przechwytywania i modyfikatory trybu.
Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstu zawartego w bieżącym elemencie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
search | String | wzór do wyszukania, |
from | Range | wynik wyszukiwania, z którego chcesz wyszukiwać; |
Powrót
Range – wynik wyszukiwania wskazujący następną pozycję tekstu wyszukiwania lub wartość null, jeśli nie ma dopasowania.
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
get Attributes()
Pobiera atrybuty elementu.
Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym nazwa każdej właściwości odpowiada elementowi w wyliczeniu Document.
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 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
get Child(childIndex)
Pobiera element podrzędny o określonym indeksie.
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 |
|---|---|---|
child | Integer | Indeks elementu podrzędnego do pobrania. |
Powrót
Element – element podrzędny w określonym indeksie.
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
get Child Index(child)
Pobiera indeks elementu podrzędnego 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 użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Next Sibling()
Pobiera następny element równorzędny.
Następny element równorzędny ma tego samego rodzica i występuje po bieżącym elemencie.
Powrót
Element|null – następny element równorzędny.
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
get Num Children()
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 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
get Paragraphs()
Pobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym List).
Powrót
Paragraph[]|null – akapity sekcji.
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
get Parent()
Pobiera element nadrzędny elementu.
Element nadrzędny zawiera bieżący element.
Powrót
Container – element nadrzędny.
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
get Previous Sibling()
Pobiera poprzedni element sąsiedni elementu.
Poprzedni element równorzędny ma tego samego rodzica i występuje przed bieżącym elementem.
Powrót
Element|null – poprzedni element równorzędny.
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
get Text()
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 użyciem co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text Alignment()
Pobiera wyrównanie tekstu. Dostępne typy wyrównania to Document, Document i Document.
Powrót
Text – 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 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
get Type()
Pobiera Element elementu.
Użyj właściwości get, aby określić dokładny typ danego elementu.
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
Element – typ elementu.
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
insert Paragraph(childIndex, paragraph)
Wstawia podany element Paragraph w określonym indeksie.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
child | Integer | Indeks, w którym ma zostać wstawiony element. |
paragraph | Paragraph | Akapit do wstawienia. |
Powrót
Paragraph – wstawiony akapit.
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
insert Paragraph(childIndex, text)
Tworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
child | Integer | Indeks, w którym ma zostać wstawiony element. |
text | String | Zawartość tekstowa akapitu. |
Powrót
Paragraph – nowy akapit.
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
remove Child(child)
Usuwa określony element podrzędny.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
child | Element | Element podrzędny do usunięcia. |
Powrót
Footnote – bieżący element.
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
remove From Parent()
Usuwa element z 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
Footnote – usunięty element.
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
replace Text(searchPattern, replacement)
Zamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie jako obiekt wyrażenia regularnego JavaScript. Dlatego musisz zmienić znaczenie wszystkich ukośników odwrotnych we wzorcu.
Ta metoda korzysta z biblioteki wyrażeń regularnych RE2 Google, która ogranicza obsługiwaną składnię.
Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie 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 |
|---|---|---|
search | String | wzór wyrażenia regularnego do wyszukania; |
replacement | String | tekst, który ma zastąpić oryginalny tekst; |
Powrót
Element – bieżący element
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
set Attributes(attributes)
Ustawia atrybuty elementu.
Parametr specifiedAttributes musi być obiektem, w którym każda nazwa właściwości jest elementem wyliczenia Document, 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
Footnote – bieżący element.
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
set Text(text)
Ustawia zawartość jako zwykły tekst.
Uwaga: dotychczasowa zawartość zostanie wyczyszczona.
Parametry
| Nazwa | Typ | Opis |
|---|---|---|
text | String | Nowa zawartość tekstowa. |
Powrót
Footnote – bieżący element.
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
set Text Alignment(textAlignment)
Ustawia wyrównanie tekstu. Dostępne typy wyrównania to Document, Document i Document.
// 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 |
|---|---|---|
text | Text | typ wyrównania tekstu do zastosowania; |
Powrót
Footnote – bieżący element
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