Element reprezentujący sekcję przypisu. FootnoteSection
zawiera tekst odpowiadający wartości Footnote
. Element FootnoteSection
może zawierać elementy ListItem
lub Paragraph
. Więcej informacji na temat struktury dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendParagraph(paragraph) | Paragraph | Dodaje podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy element Paragraph zawierający podaną zawartość tekstową. |
clear() | FootnoteSection | Czyści zawartość elementu. |
copy() | FootnoteSection | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera do edycji wersję Text bieżącego elementu. |
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 podrzędnego określonego typu, zaczynając od określonego elementu RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstowego przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu według określonego wzorca tekstowego, zaczynając od danego 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. |
getNextSibling() | Element | Pobiera następny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę elementów podrzędnych. |
getParagraphs() | Paragraph[] | Pobiera wszystkie dane (Paragraphs ) zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Wyrównuje tekst. |
getType() | ElementType | Pobiera ElementType elementu. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podany Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia w określonym indeksie nowy obiekt Paragraph zawierający określoną zawartość tekstową. |
removeChild(child) | FootnoteSection | Usuwa określony element podrzędny. |
removeFromParent() | FootnoteSection | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym zastępczym ciągiem znaków przy użyciu wyrażeń regularnych. |
setAttributes(attributes) | FootnoteSection | Ustawia atrybuty elementu. |
setText(text) | FootnoteSection | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | FootnoteSection | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
appendParagraph(paragraph)
Dodaje podaną wartość Paragraph
.
Użyj tej wersji appendParagraph
, dołączając kopię istniejącego obiektu Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraph | Paragraph | akapit, który chcesz dołączyć |
Powroty
Paragraph
– dołączony akapit.
Upoważnienie
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
appendParagraph(text)
Tworzy i dołącza nowy element Paragraph
zawierający podaną zawartość tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | zawartość akapitu, |
Powroty
Paragraph
– nowy akapit
Upoważnienie
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
clear()
copy()
Zwraca odłączoną, głęboką kopię bieżącego elementu.
Kopiowane są też wszystkie elementy podrzędne występujące w elemencie. Nowy element nie ma elementu nadrzędnego.
Powroty
FootnoteSection
– nowa kopia.
Upoważnienie
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 do edycji wersję Text
bieżącego elementu.
editAsText
służy do manipulowania zawartością elementów pod postacią tekstu sformatowanego. Tryb editAsText
ignoruje elementy inne niż tekstowe (takie jak InlineImage
i HorizontalRule
).
Elementy podrzędne w pełni zawarte w usuniętym zakresie tekstu są z niego usuwane.
var body = DocumentApp.getActiveDocument().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);
Powroty
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; |
Powroty
RangeElement
– wynik wyszukiwania wskazujący pozycję elementu wyszukiwania;
Upoważnienie
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 podrzędnego określonego typu, zaczynając od określonego elementu RangeElement
.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().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, który ma być wyszukiwany |
Powroty
RangeElement
– wynik wyszukiwania wskazujący następną pozycję wyszukiwanego elementu.
Upoważnienie
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 tekstowego przy użyciu wyrażeń regularnych.
Podzbiór funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwany, np. grupy przechwytywania i modyfikatory trybów.
Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstowego w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wzór do wyszukania |
Powroty
RangeElement
– wynik wyszukiwania wskazujący pozycję wyszukiwanego tekstu lub wartość null, jeśli nie ma żadnego dopasowania.
Upoważnienie
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 według określonego wzorca tekstowego, zaczynając od danego wyniku wyszukiwania.
Podzbiór funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwany, np. grupy przechwytywania i modyfikatory trybów.
Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstowego w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wzór do wyszukania |
from | RangeElement | wynik wyszukiwania, który ma być wyszukiwany |
Powroty
RangeElement
– wynik wyszukiwania wskazujący następną pozycję wyszukiwanego tekstu lub wartość null, jeśli nie ma dopasowania.
Upoważnienie
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.
W efekcie powstanie obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, w którym każda nazwa właściwości odpowiada elementowi w wyliczeniu DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().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]); }
Powroty
Object
– atrybuty elementu.
Upoważnienie
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.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. 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 |
Powroty
Element
– element podrzędny o określonym indeksie.
Upoważnienie
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, z którego ma zostać pobrany indeks; |
Powroty
Integer
– indeks podrzędny.
Upoważnienie
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 następny element równorzędny elementu.
Następne elementy nadrzędne mają ten sam element nadrzędny i następują po bieżącym elemencie.
Powroty
Element
– następny element równorzędny.
Upoważnienie
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ę elementów podrzędnych.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Powroty
Integer
– liczba dzieci,
Upoważnienie
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
getParagraphs()
Pobiera wszystkie dane (Paragraphs
) zawarte w sekcji (w tym ListItems
).
Powroty
Paragraph[]
– akapity sekcji,
Upoważnienie
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 element bieżący.
Powroty
ContainerElement
– element nadrzędny.
Upoważnienie
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.
Poprzedni element nadrzędny ma ten sam element nadrzędny i poprzedza bieżący element.
Powroty
Element
– poprzedni element równorzędny.
Upoważnienie
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.
Powroty
String
– zawartość elementu jako ciąg tekstowy;
Upoważnienie
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()
Wyrównuje tekst. Dostępne typy wyrównywania to DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
i DocumentApp.TextAlignment.SUPERSCRIPT
.
Powroty
TextAlignment
– typ wyrównania tekstu lub null
, jeśli tekst zawiera różne rodzaje wyrównania tekstu lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.
Upoważnienie
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 ElementType
elementu.
Użyj właściwości getType()
, aby określić dokładny typ danego elementu.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document 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.'); }
Powroty
ElementType
– typ elementu.
Upoważnienie
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
insertParagraph(childIndex, paragraph)
Wstawia podany Paragraph
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić |
paragraph | Paragraph | akapit do wstawienia |
Powroty
Paragraph
– wstawiony akapit,
Upoważnienie
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
insertParagraph(childIndex, text)
Tworzy i wstawia w określonym indeksie nowy obiekt Paragraph
zawierający określoną zawartość tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić |
text | String | zawartość akapitu, |
Powroty
Paragraph
– nowy akapit
Upoważnienie
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
removeChild(child)
Usuwa określony element podrzędny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Element | element podrzędny do usunięcia |
Powroty
FootnoteSection
– bieżący element,
Upoważnienie
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 body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Powroty
FootnoteSection
– usunięty element
Upoważnienie
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 zastępczym ciągiem znaków przy użyciu wyrażeń regularnych.
Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu musisz zmienić znaczenie ukośnika lewego we wzorcu.
Ta metoda korzysta z biblioteki wyrażeń regularnych Google RE2, która ogranicza obsługiwaną składnię.
Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstowego w bieżącym elemencie.
var body = DocumentApp.getActiveDocument().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 |
Powroty
Element
– bieżący element,
Upoważnienie
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 wyliczeniu DocumentApp.Attribute
, a każda wartość właściwości jest nową wartością do zastosowania.
var body = DocumentApp.getActiveDocument().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. |
Powroty
FootnoteSection
– bieżący element.
Upoważnienie
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
setText(text)
Ustawia zawartość jako zwykły tekst.
Uwaga: dotychczasowe treści zostaną wyczyszczone.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | nowa zawartość tekstu, |
Powroty
FootnoteSection
– bieżący element,
Upoważnienie
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)
Ustawia wyrównanie tekstu. Dostępne typy wyrównywania to DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
i DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametry
Nazwa | Typ | Opis |
---|---|---|
textAlignment | TextAlignment | typ wyrównania tekstu do zastosowania; |
Powroty
FootnoteSection
– bieżący element,
Upoważnienie
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