Element reprezentujący element listy. Element ListItem
to obiekt Paragraph
powiązany z identyfikatorem listy. ListItem
może zawierać elementy Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
i Text
. Więcej informacji na temat struktury dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.
Pole ListItems
nie może zawierać znaków nowego wiersza. Znaki nowego wiersza („\n”) są konwertowane na znaki podziału wiersza („\r”).
ListItems
o tym samym identyfikatorze listy należą do tej samej listy i są odpowiednio numerowane.
ListItems
w danej liście nie musi znajdować się obok siebie w dokumencie ani nawet mieć tego samego elementu nadrzędnego. Dwie elementy należące do tej samej listy mogą znajdować się w dowolnym miejscu w dokumencie z zachowaniem numeracji sekwencyjnej, jak pokazano w tym przykładzie:
var body = DocumentApp.getActiveDocument().getBody(); // Append a new list item to the body. var item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([ ['Cell 1', 'Cell 2'] ]); // Append a second list item with the same list ID. The two items are treated as the same list, // despite not being consecutive. var item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addPositionedImage(image) | PositionedImage | Tworzy i wstawia nowy obiekt PositionedImage ze wskazanego obiektu blob obrazu. |
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendInlineImage(image) | InlineImage | Tworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu. |
appendInlineImage(image) | InlineImage | Dodaje podaną wartość InlineImage . |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dodaje podaną wartość PageBreak . |
appendText(text) | Text | Tworzy i dołącza nowy element Text o określonej zawartości. |
appendText(text) | Text | Dodaje dany element Text . |
clear() | ListItem | Czyści zawartość elementu. |
copy() | ListItem | 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. |
getAlignment() | HorizontalAlignment | Pobiera HorizontalAlignment . |
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. |
getGlyphType() | GlyphType | Pobiera element GlyphType elementu listy. |
getHeading() | ParagraphHeading | Pobiera ParagraphHeading . |
getIndentEnd() | Number | Pobiera końcowe wcięcie w punktach. |
getIndentFirstLine() | Number | Pobiera wcięcie pierwszego wiersza w punktach. |
getIndentStart() | Number | Pobiera wcięcie początkowe. |
getLineSpacing() | Number | Pobiera odstępy między wierszami w punktach. |
getLinkUrl() | String | Pobiera adres URL linku. |
getListId() | String | Pobiera identyfikator listy. |
getNestingLevel() | Integer | Pobiera poziom zagnieżdżenia elementu listy. |
getNextSibling() | Element | Pobiera następny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę elementów podrzędnych. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPositionedImage(id) | PositionedImage | Pobiera właściwość PositionedImage na podstawie identyfikatora obrazu. |
getPositionedImages() | PositionedImage[] | Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny. |
getSpacingAfter() | Number | Pobiera odstępy po elemencie w punktach. |
getSpacingBefore() | Number | Pobiera odstępy przed elementem w punktach. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Wyrównuje tekst. |
getType() | ElementType | Pobiera ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia HorizontalRule w określonym indeksie. |
insertInlineImage(childIndex, image) | InlineImage | Tworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob obrazu o określonym indeksie. |
insertInlineImage(childIndex, image) | InlineImage | Wstawia podany InlineImage w określonym indeksie. |
insertPageBreak(childIndex) | PageBreak | Tworzy i wstawia nowy element PageBreak w określonym indeksie. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Wstawia podany PageBreak w określonym indeksie. |
insertText(childIndex, text) | Text | Tworzy i wstawia nowy element tekstowy w określonym indeksie. |
insertText(childIndex, text) | Text | Wstawia dany element Text w określonym indeksie z podaną zawartością tekstową. |
isAtDocumentEnd() | Boolean | Określa, czy element znajduje się na końcu parametru Document . |
isLeftToRight() | Boolean | Pobiera ustawienie od lewej do prawej. |
merge() | ListItem | Łączy element z poprzednim elementem równorzędnym tego samego typu. |
removeChild(child) | ListItem | Usuwa określony element podrzędny. |
removeFromParent() | ListItem | Usuwa element z elementu nadrzędnego. |
removePositionedImage(id) | Boolean | Usuwa pole PositionedImage według identyfikatora obrazu. |
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. |
setAlignment(alignment) | ListItem | Ustawia HorizontalAlignment . |
setAttributes(attributes) | ListItem | Ustawia atrybuty elementu. |
setGlyphType(glyphType) | ListItem | Ustawia wartość GlyphType elementu listy. |
setHeading(heading) | ListItem | Ustawia ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Ustawia wcięcie końcowe w punktach. |
setIndentFirstLine(indentFirstLine) | ListItem | Ustawia wcięcie pierwszego wiersza w punktach. |
setIndentStart(indentStart) | ListItem | Ustawia wcięcie początkowe w punktach. |
setLeftToRight(leftToRight) | ListItem | Ustawia ustawienie „od lewej do prawej”. |
setLineSpacing(multiplier) | ListItem | Ustawia odstępy między wierszami, które określają liczbę wierszy, jaka ma być zastosowana do odstępów. |
setLinkUrl(url) | ListItem | Ustawia adres URL linku. |
setListId(listItem) | ListItem | Ustawia identyfikator listy. |
setNestingLevel(nestingLevel) | ListItem | Ustawia poziom zagnieżdżenia elementu listy. |
setSpacingAfter(spacingAfter) | ListItem | Ustawia odstępy w punktach po elemencie. |
setSpacingBefore(spacingBefore) | ListItem | Określa odstępy w punktach przed elementem. |
setText(text) | void | Ustawia zawartość elementu listy jako tekst. |
setTextAlignment(textAlignment) | ListItem | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
addPositionedImage(image)
Tworzy i wstawia nowy obiekt PositionedImage
ze wskazanego obiektu blob obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | BlobSource | dane obrazu |
Powroty
PositionedImage
– nowy obraz,
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
appendHorizontalRule()
Tworzy i dołącza nowy element HorizontalRule
.
Powroty
HorizontalRule
– nowa linia pozioma,
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
appendInlineImage(image)
Tworzy i dołącza nowy element InlineImage
z określonego obiektu blob obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | BlobSource | dane obrazu |
Powroty
InlineImage
– dołączony obraz,
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
appendInlineImage(image)
Dodaje podaną wartość InlineImage
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | InlineImage | dane obrazu |
Powroty
InlineImage
– dołączony obraz,
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
appendPageBreak()
Tworzy i dołącza nowy element PageBreak
.
Uwaga: dyrektywa PageBreaks
nie może być zawarta w elemencie TableCells
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.
Powroty
PageBreak
– nowy element podziału strony;
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
appendPageBreak(pageBreak)
Dodaje podaną wartość PageBreak
.
Uwaga: dyrektywa PageBreaks
nie może być zawarta w elemencie TableCells
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageBreak | PageBreak | podział strony do dołączenia |
Powroty
PageBreak
– dołączony element podziału strony,
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
appendText(text)
Tworzy i dołącza nowy element Text
o określonej zawartości.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | zawartość tekstu, |
Powroty
Text
– nowy element 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
appendText(text)
Dodaje dany element Text
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | Text | element tekstowy, który ma zostać dołączony |
Powroty
Text
– dołączony element 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
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
ListItem
– 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
getAlignment()
Pobiera HorizontalAlignment
.
Powroty
HorizontalAlignment
– wyrównanie,
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
getGlyphType()
getHeading()
Pobiera ParagraphHeading
.
Powroty
ParagraphHeading
– nagłówek,
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
getIndentEnd()
Pobiera końcowe wcięcie w punktach.
Powroty
Number
– wcięcie na końcu w punktach
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
getIndentFirstLine()
Pobiera wcięcie pierwszego wiersza w punktach.
Powroty
Number
– wcięcie pierwszego wiersza w punktach,
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
getIndentStart()
Pobiera wcięcie początkowe.
Powroty
Number
– wcięcie początkowe
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
getLineSpacing()
Pobiera odstępy między wierszami w punktach.
Powroty
Number
– odstępy między wierszami w punktach,
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
getLinkUrl()
Pobiera adres URL linku.
Powroty
String
– adres URL linku lub wartość null, jeśli element zawiera wiele wartości tego atrybutu
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
getListId()
Pobiera identyfikator listy.
Powroty
String
– identyfikator listy,
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
getNestingLevel()
Pobiera poziom zagnieżdżenia elementu listy.
Domyślnie elementy listy mają poziom zagnieżdżenia wynoszący 0. Poziom zagnieżdżenia określa glif używany przez element listy.
Powroty
Integer
– poziom zagnieżdżenia.
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
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
getPositionedImage(id)
Pobiera właściwość PositionedImage
na podstawie identyfikatora obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | identyfikator obrazu |
Powroty
PositionedImage
– obraz umieszczony w pozycji;
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
getPositionedImages()
Pobiera wszystkie obiekty PositionedImage
zakotwiczone w akapicie.
Powroty
PositionedImage[]
– lista rozmieszczonych obrazów.
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
getSpacingAfter()
Pobiera odstępy po elemencie w punktach.
Powroty
Number
– odstęp po elemencie, w punktach
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
getSpacingBefore()
Pobiera odstępy przed elementem w punktach.
Powroty
Number
– odstępy przed elementem, w punktach
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
insertHorizontalRule(childIndex)
Tworzy i wstawia HorizontalRule
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
Powroty
HorizontalRule
– nowy element na linijce poziomej,
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
insertInlineImage(childIndex, image)
Tworzy i wstawia nowy obiekt InlineImage
z określonego obiektu blob obrazu o określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
image | BlobSource | dane obrazu |
Powroty
InlineImage
– element graficzny wstawiony w tekście;
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
insertInlineImage(childIndex, image)
Wstawia podany InlineImage
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
image | InlineImage | dane obrazu |
Powroty
InlineImage
– element graficzny wstawiony w tekście;
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
insertPageBreak(childIndex)
Tworzy i wstawia nowy element PageBreak
w określonym indeksie.
Uwaga: dyrektywa PageBreaks
nie może być zawarta w elemencie TableCells
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
Powroty
PageBreak
– nowy element podziału strony;
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
insertPageBreak(childIndex, pageBreak)
Wstawia podany PageBreak
w określonym indeksie.
Uwaga: dyrektywa PageBreaks
nie może być zawarta w elemencie TableCells
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
pageBreak | PageBreak | p[przerwa wiekowa do wstawienia |
Powroty
PageBreak
– wstawiony element podziału strony,
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
insertText(childIndex, text)
Tworzy i wstawia nowy element tekstowy w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
text | String | zawartość tekstu, |
Powroty
Text
– nowy element 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
insertText(childIndex, text)
Wstawia dany element Text
w określonym indeksie z podaną zawartością tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, w którym ma zostać wstawiony element |
text | Text | element tekstowy do wstawienia |
Powroty
Text
– wstawiony element 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
isAtDocumentEnd()
Określa, czy element znajduje się na końcu parametru Document
.
Powroty
Boolean
– określa, czy element znajduje się na końcu dokumentu.
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
isLeftToRight()
Pobiera ustawienie od lewej do prawej.
Powroty
Boolean
– ustawienie od lewej do prawej.
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
merge()
Łączy element z poprzednim elementem równorzędnym tego samego typu.
Można scalać tylko elementy elementu ElementType
. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do poprzedniego elementu równorzędnego.
Bieżący element zostanie usunięty z dokumentu.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Powroty
ListItem
– scalony 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
removeChild(child)
Usuwa określony element podrzędny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Element | element podrzędny do usunięcia |
Powroty
ListItem
– 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
ListItem
– 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
removePositionedImage(id)
Usuwa pole PositionedImage
według identyfikatora obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String |
Powroty
Boolean
– określa, czy określony obraz został usunięty.
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
setAlignment(alignment)
Ustawia HorizontalAlignment
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
alignment | HorizontalAlignment | wyrównanie w poziomie |
Powroty
ListItem
– 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
ListItem
– 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
setGlyphType(glyphType)
Ustawia wartość GlyphType
elementu listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
glyphType | GlyphType | typ glifu |
Powroty
ListItem
– 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
setHeading(heading)
Ustawia ParagraphHeading
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
heading | ParagraphHeading | nagłówek |
Powroty
ListItem
– 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
setIndentEnd(indentEnd)
Ustawia wcięcie końcowe w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indentEnd | Number | wcięcie końcowe w punktach |
Powroty
ListItem
– 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
setIndentFirstLine(indentFirstLine)
Ustawia wcięcie pierwszego wiersza w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indentFirstLine | Number | wcięcie pierwszego wiersza w punktach |
Powroty
ListItem
– 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
setIndentStart(indentStart)
Ustawia wcięcie początkowe w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indentStart | Number | wcięcie początkowe w punktach |
Powroty
ListItem
– 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
setLeftToRight(leftToRight)
Ustawia ustawienie „od lewej do prawej”.
Parametry
Nazwa | Typ | Opis |
---|---|---|
leftToRight | Boolean | ustawienie od lewej do prawej |
Powroty
ListItem
– 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
setLineSpacing(multiplier)
Ustawia odstępy między wierszami, które określają liczbę wierszy, jaka ma być zastosowana do odstępów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
multiplier | Number | liczba wierszy |
Powroty
ListItem
– 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
setLinkUrl(url)
Ustawia adres URL linku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | adres URL linku |
Powroty
ListItem
– 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
setListId(listItem)
Ustawia identyfikator listy.
Identyfikator listy jest ustawiony na tę samą wartość dla określonego elementu ListItem
. Te 2 elementy typu ListItems
będą traktowane jako członkowie tej samej listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
listItem | ListItem | element listy, którego identyfikator ma zostać użyty |
Powroty
ListItem
– 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
setNestingLevel(nestingLevel)
Ustawia poziom zagnieżdżenia elementu listy.
Domyślnie elementy listy mają poziom zagnieżdżenia wynoszący 0. Poziom zagnieżdżenia określa glif używany przez element listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
nestingLevel | Integer | poziom zagnieżdżenia |
Powroty
ListItem
– 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
setSpacingAfter(spacingAfter)
Ustawia odstępy w punktach po elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
spacingAfter | Number | odstępy po elemencie w punktach |
Powroty
ListItem
– 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
setSpacingBefore(spacingBefore)
Określa odstępy w punktach przed elementem.
Parametry
Nazwa | Typ | Opis |
---|---|---|
spacingBefore | Number | odstępy przed elementem, w punktach |
Powroty
ListItem
– 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ść elementu listy jako tekst.
Uwaga: dotychczasowe treści zostaną wyczyszczone.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | nowa zawartość tekstu, |
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
ListItem
– 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