Element reprezentujący element listy. List
to Paragraph
powiązany z identyfikatorem listy. Element List
może zawierać elementy Equation
, Footnote
, Horizontal
, Inline
, Inline
, Page
i Text
. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.
List
nie może zawierać znaków nowego wiersza. Znaki nowego wiersza ("\n") są konwertowane na znaki podziału wiersza ("\r").
List
o tym samym identyfikatorze listy należą do tej samej listy i są odpowiednio ponumerowane.
Elementy List
danej listy nie muszą znajdować się obok siebie na karcie ani mieć tego samego elementu nadrzędnego. 2 elementy należące do tej samej listy mogą znajdować się w dowolnym miejscu na karcie, zachowując ciągłą numerację, jak w tym przykładzie:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const 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. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
add | Positioned | Tworzy i wstawia nowy element Positioned z określonego bloba obrazu. |
append | Horizontal | Tworzy i dodaje nową wartość Horizontal . |
append | Inline | Tworzy i dodaje nowy element Inline z określonego bloba obrazu. |
append | Inline | Dodaje podany parametr Inline . |
append | Page | Tworzy i dodaje nową wartość Page . |
append | Page | Dodaje podany parametr Page . |
append | Text | Tworzy i dodaje nowy element Text z określonymi treściami. |
append | Text | Dodaje podany element Text . |
clear() | List | Czyści zawartość elementu. |
copy() | List | 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 | Horizontal | Pobiera Horizontal . |
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 | Glyph | Pobiera wartość atrybutu Glyph elementu listy. |
get | Paragraph | Pobiera Paragraph . |
get | Number | Pobiera wcięcie końcowe w punktach. |
get | Number | Pobiera wcięcie pierwszego wiersza w punktach. |
get | Number | Pobiera wcięcie początkowe. |
get | Number | Pobiera odstęp między wierszami w punktach. |
get | String | Pobiera adres URL linku. |
get | String | Pobiera identyfikator listy. |
get | Integer | Pobiera poziom zagnieżdżenia elementu listy. |
get | Element | Pobiera następny element nadrzędny. |
get | Integer | Pobiera liczbę dzieci. |
get | Container | Pobiera element nadrzędny. |
get | Positioned | Pobiera Positioned według identyfikatora obrazu. |
get | Positioned | Pobiera wszystkie obiekty Positioned zakotwiczone w akapicie. |
get | Element | Pobiera poprzedni element nadrzędny elementu. |
get | Number | Pobiera odstęp po elemencie w punktach. |
get | Number | Pobiera odstęp przed elementem w punktach. |
get | String | Pobiera zawartość elementu jako ciąg tekstowy. |
get | Text | Pobiera wyrównanie tekstu. |
get | Element | Pobiera wartość atrybutu Element elementu. |
insert | Horizontal | Tworzy i wstawia element Horizontal na wskazanym indeksie. |
insert | Inline | Tworzy i wstawia nowy element Inline z określonego bloba obrazu na wskazanym indeksie. |
insert | Inline | Wstawia podany element Inline na wskazanej pozycji. |
insert | Page | Tworzy i wstawia nowy element Page na wskazanym indeksie. |
insert | Page | Wstawia podany element Page na wskazanej pozycji. |
insert | Text | Tworzy i wstawia nowy element tekstowy na określonym indeksie. |
insert | Text | Wstawia podany element Text w wybranym indeksie z wybranym tekstem. |
is | Boolean | Określa, czy element znajduje się na końcu Document . |
is | Boolean | Pobiera ustawienie tekstu od lewej do prawej. |
merge() | List | Łączy element z poprzednim elementem tego samego typu. |
remove | List | Usuwa określony element podrzędny. |
remove | List | Usuwa element z jego elementu nadrzędnego. |
remove | Boolean | Usuwa Positioned według identyfikatora obrazu. |
replace | Element | Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym. |
set | List | Ustawia wartość Horizontal . |
set | List | Ustawia atrybuty elementu. |
set | List | Ustawia Glyph elementu listy. |
set | List | Ustawia wartość Paragraph . |
set | List | Ustawia wcięcie końcowe w punktach. |
set | List | Ustawia wcięcie pierwszego wiersza w punktach. |
set | List | Ustawia wcięcie początkowe w punktach. |
set | List | Ustawia kierunek od lewej do prawej. |
set | List | Ustawia odstęp między wierszami jako liczbę wierszy, które mają być użyte do wypełnienia. |
set | List | Ustawia adres URL linku. |
set | List | Ustawia identyfikator listy. |
set | List | Ustawia poziom zagnieżdżenia elementu listy. |
set | List | Ustawia odstęp po elemencie w punktach. |
set | List | Ustawia odstęp przed elementem w punktach. |
set | void | Ustawia zawartość pozycji listy jako tekst. |
set | List | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
add Positioned Image(image)
Tworzy i wstawia nowy element Positioned
z określonego bloba obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | Blob | dane obrazu; |
Powrót
Positioned
– nowo umieszczony obraz
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 Horizontal Rule()
Tworzy i dodaje nową wartość Horizontal
.
Powrót
Horizontal
– nowa linia pozioma
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 Inline Image(image)
Tworzy i dodaje nowy element Inline
z określonego bloba obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | Blob | dane obrazu; |
Powrót
Inline
– dołączony obraz
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 Inline Image(image)
Dodaje podany parametr Inline
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | Inline | dane obrazu; |
Powrót
Inline
– dołączony obraz
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 Page Break()
Tworzy i dodaje nową wartość Page
.
Uwaga: Page
może nie być zawarty w Table
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie rzucony wyjątek.
Powrót
Page
– nowy element podziału strony
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 Page Break(pageBreak)
Dodaje podany parametr Page
.
Uwaga: Page
może nie być zawarty w Table
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie rzucony wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
page | Page | podział strony, który chcesz dołączyć |
Powrót
Page
– dołączony element podziału strony,
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 Text(text)
Tworzy i dodaje nowy element Text
z określonymi treściami.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | zawartość tekstowa; |
Powrót
Text
– nowy element 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
append Text(text)
Dodaje podany element Text
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | Text | element tekstowy, który chcesz dodać; |
Powrót
Text
– dołączony element 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
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
List
– 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 Alignment()
Pobiera Horizontal
.
Powrót
Horizontal
– wyrównanie
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 Glyph Type()
get Heading()
Pobiera Paragraph
.
Powrót
Paragraph
– nagłówek
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 Indent End()
Pobiera wcięcie końcowe w punktach.
Powrót
Number
– wcięcie na końcu w punktach
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 Indent First Line()
Pobiera wcięcie pierwszego wiersza w punktach.
Powrót
Number
– wcięcie pierwszego wiersza w punktach
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 Indent Start()
Pobiera wcięcie początkowe.
Powrót
Number
– wcięcie na początku
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 Line Spacing()
Pobiera odstęp między wierszami w punktach.
Powrót
Number
– odstępy między wierszami w punktach.
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 Link Url()
Pobiera adres URL linku.
Powrót
String
– adres URL linku lub null, jeśli element zawiera wiele wartości tego atrybutu
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 List Id()
Pobiera identyfikator listy.
Powrót
String
– identyfikator listy
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 Nesting Level()
Pobiera poziom zagnieżdżenia elementu listy.
Domyślnie pozycje listy mają poziom zagnieżdżenia 0. Poziom zagnieżdżania określa symbol używany przez element listy.
Powrót
Integer
– poziom zagnieżdżenia,
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 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 Positioned Image(id)
Pobiera Positioned
według identyfikatora obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | identyfikator obrazu. |
Powrót
Positioned
– umieszczony obraz
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 Positioned Images()
Pobiera wszystkie obiekty Positioned
zakotwiczone w akapicie.
Powrót
Positioned
– lista umieszczonych obrazów
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 Spacing After()
Pobiera odstęp po elemencie w punktach.
Powrót
Number
– odstęp po elemencie w punktach
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 Spacing Before()
Pobiera odstęp przed elementem w punktach.
Powrót
Number
– odstęp przed elementem w punktach
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 Horizontal Rule(childIndex)
Tworzy i wstawia element Horizontal
na wskazanym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
Powrót
Horizontal
– nowy element linii poziomej
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 Inline Image(childIndex, image)
Tworzy i wstawia nowy element Inline
z określonego bloba obrazu na wskazanym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
image | Blob | dane obrazu; |
Powrót
Inline
– wstawiony obraz w tekście
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 Inline Image(childIndex, image)
Wstawia podany element Inline
na wskazanej pozycji.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
image | Inline | dane obrazu; |
Powrót
Inline
– wstawiony obraz w tekście
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 Page Break(childIndex)
Tworzy i wstawia nowy element Page
na wskazanym indeksie.
Uwaga: Page
może nie być zawarty w Table
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie rzucony wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
Powrót
Page
– nowy element podziału strony
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 Page Break(childIndex, pageBreak)
Wstawia podany element Page
na wskazanej pozycji.
Uwaga: Page
może nie być zawarty w Table
.
Jeśli bieżący element znajduje się w komórce tabeli, zostanie rzucony wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
page | Page | podział strony, który chcesz wstawić |
Powrót
Page
– wstawiony element podziału strony
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 Text(childIndex, text)
Tworzy i wstawia nowy element tekstowy na określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
text | String | zawartość tekstowa; |
Powrót
Text
– nowy element 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
insert Text(childIndex, text)
Wstawia podany element Text
w wybranym indeksie z wybranym tekstem.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | indeks, w którym ma zostać wstawiony element; |
text | Text | element tekstowy do wstawienia. |
Powrót
Text
– wstawiony element 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
is At Document End()
Określa, czy element znajduje się na końcu Document
.
Powrót
Boolean
– określa, czy element znajduje się na końcu karty.
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
is Left To Right()
Pobiera ustawienie tekstu od lewej do prawej.
Powrót
Boolean
– ustawienie od lewej do prawej
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
merge()
Łączy element z poprzednim elementem tego samego typu.
Można scalać tylko elementy tego samego Element
. Wszystkie elementy podrzędne zawarte w bieżącym elemencie zostaną przeniesione do poprzedniego elementu nadrzędnego.
Bieżący element zostanie usunięty z dokumentu.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const 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. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Powrót
List
– scalony 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 Child(child)
Usuwa określony element podrzędny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Element | element podrzędny do usunięcia. |
Powrót
List
– 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
List
– 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
remove Positioned Image(id)
Usuwa Positioned
według identyfikatora obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String |
Powrót
Boolean
– czy wskazany obraz został usunięty
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 Alignment(alignment)
Ustawia wartość Horizontal
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
alignment | Horizontal | wyrównanie w poziomie; |
Powrót
List
– 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
List
– 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 Glyph Type(glyphType)
Ustawia Glyph
elementu listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
glyph | Glyph | typ glifu, |
Powrót
List
– 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 Heading(heading)
Ustawia wartość Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
heading | Paragraph | nagłówek |
Powrót
List
– 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 Indent End(indentEnd)
Ustawia wcięcie końcowe w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indent | Number | wcięcie na końcu w punktach |
Powrót
List
– 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 Indent First Line(indentFirstLine)
Ustawia wcięcie pierwszego wiersza w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indent | Number | wcięcie pierwszego wiersza w punktach |
Powrót
List
– 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 Indent Start(indentStart)
Ustawia wcięcie początkowe w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indent | Number | wcięcie na początku w punktach |
Powrót
List
– 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 Left To Right(leftToRight)
Ustawia kierunek od lewej do prawej.
Parametry
Nazwa | Typ | Opis |
---|---|---|
left | Boolean | ustawienie od lewej do prawej. |
Powrót
List
– 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 Line Spacing(multiplier)
Ustawia odstęp między wierszami jako liczbę wierszy, które mają być użyte do wypełnienia.
Parametry
Nazwa | Typ | Opis |
---|---|---|
multiplier | Number | liczba wierszy, |
Powrót
List
– 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 Link Url(url)
Ustawia adres URL linku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | adres URL linku, |
Powrót
List
– 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 List Id(listItem)
Ustawia identyfikator listy.
Identyfikator listy ma tę samą wartość w przypadku określonego parametru List
. Te 2 elementy List
będą traktowane jako elementy tej samej listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
list | List | element listy, którego identyfikator listy ma być użyty |
Powrót
List
– 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 Nesting Level(nestingLevel)
Ustawia poziom zagnieżdżenia elementu listy.
Domyślnie pozycje listy mają poziom zagnieżdżenia 0. Poziom zagnieżdżania określa symbol używany przez element listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
nesting | Integer | poziom zagnieżdżenia |
Powrót
List
– 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 Spacing After(spacingAfter)
Ustawia odstęp po elemencie w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
spacing | Number | odstęp po elemencie w punktach. |
Powrót
List
– 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 Spacing Before(spacingBefore)
Ustawia odstęp przed elementem w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
spacing | Number | odstęp przed elementem w punktach. |
Powrót
List
– 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ść pozycji listy jako tekst.
Uwaga: istniejące treści zostaną usunięte.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | nowe treści tekstowe. |
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
List
– 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