Element reprezentujący sekcję przypisu. Element Footnote
zawiera tekst odpowiadający 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 | Dodaje podany parametr Paragraph . |
append | Paragraph | Tworzy i dodaje nowy element Paragraph zawierający określony tekst. |
clear() | Footnote | Czyści 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 potomka określonego typu. |
find | Range | Przeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu Range . |
find | Range | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych. |
find | Range | Przeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania. |
get | Object | Pobiera atrybuty elementu. |
get | Element | Pobiera element podrzędny o określonym indeksie podrzędnym. |
get | Integer | Pobiera indeks podrzędnego elementu podrzędnego. |
get | Element | Pobiera następny element nadrzędny. |
get | Integer | Pobiera liczbę dzieci. |
get | Paragraph[] | Pobiera wszystkie Paragraphs zawarte w sekcji (w tym List ). |
get | Container | Pobiera element nadrzędny. |
get | Element | Pobiera poprzedni element nadrzędny elementu. |
get | String | Pobiera zawartość elementu jako ciąg tekstowy. |
get | Text | Pobiera wyrównanie tekstu. |
get | Element | Pobiera wartość atrybutu Element elementu. |
insert | Paragraph | Wstawia podany element Paragraph na wskazanej pozycji. |
insert | Paragraph | Tworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst. |
remove | Footnote | Usuwa określony element podrzędny. |
remove | Footnote | Usuwa element z jego elementu nadrzędnego. |
replace | Element | Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym. |
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)
Dodaje podany parametr Paragraph
.
Użyj tej wersji append
, dołączając kopię istniejącej wersji Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraph | Paragraph | Akapit do załączenia. |
Powrót
Paragraph
– załączony akapit.
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
append Paragraph(text)
Tworzy i dodaje nowy element Paragraph
zawierający określony tekst.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Treść tekstu akapitu. |
Powrót
Paragraph
– nowy akapit.
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
clear()
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
Footnote
– 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
edit As Text()
Pobiera wersję Text
bieżącego elementu do edycji.
Aby manipulować zawartością elementów jako tekstem sformatowanym, użyj edit
. Tryb edit
ignoruje elementy inne niż tekstowe (takie jak Inline
i Horizontal
).
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
find Element(elementType)
Przeszukuje zawartość elementu pod kątem potomka 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, 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
find Element(elementType, from)
Przeszukuje zawartość elementu pod kątem potomka 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, 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
find Text(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 |
---|---|---|
search | String | wzór do wyszukania. |
Powrót
Range
– 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
find Text(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 |
---|---|---|
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 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
get Attributes()
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 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, 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
get Child(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 |
---|---|---|
child | 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
get Child Index(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
get Next Sibling()
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
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, 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
get Paragraphs()
Pobiera wszystkie Paragraphs
zawarte w sekcji (w tym List
).
Powrót
Paragraph[]
– akapity sekcji.
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
get Parent()
Pobiera element nadrzędny.
Element nadrzędny zawiera bieżący element.
Powrót
Container
– 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
get Previous Sibling()
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
get Text()
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
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, 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
get Type()
Pobiera wartość atrybutu Element
elementu.
Aby określić dokładny typ danego elementu, użyj właściwości get
.
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, 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
insert Paragraph(childIndex, paragraph)
Wstawia podany element Paragraph
na wskazanej pozycji.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | Indeks, w którym ma nastąpić wstawienie. |
paragraph | Paragraph | Akapit do wstawienia. |
Powrót
Paragraph
– wstawiony akapit.
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
insert Paragraph(childIndex, text)
Tworzy i wstawia nowy element Paragraph
w wybranym miejscu, zawierający podany tekst.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | Indeks, w którym ma nastąpić wstawienie. |
text | String | Treść tekstu akapitu. |
Powrót
Paragraph
– nowy akapit.
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
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, 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
remove From Parent()
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
Footnote
– 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
replace Text(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 |
---|---|---|
search | 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
set Attributes(attributes)
Ustawia atrybuty elementu.
Parametr specified attributes musi być obiektem, w którym każda nazwa właściwości jest elementem zbioru 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, 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
set Text(text)
Ustawia zawartość jako zwykły tekst.
Uwaga: istniejące treści zostaną usunięte.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | nowe treści tekstowe. |
Powrót
Footnote
– 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
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, który ma być zastosowany. |
Powrót
Footnote
– 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