Element ogólny, który może zawierać inne elementy. Wszystkie elementy, które mogą zawierać elementy podrzędne, takie jak Paragraph
, dziedziczą z poziomu Container
.
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
as | Body | Zwraca bieżący element jako Body . |
as | Equation | Zwraca bieżący element jako Equation . |
as | Footer | Zwraca bieżący element jako Footer . |
as | Footnote | Zwraca bieżący element jako Footnote . |
as | Header | Zwraca bieżący element jako Header . |
as | List | Zwraca bieżący element jako List . |
as | Paragraph | Zwraca bieżący element jako Paragraph . |
as | Table | Zwraca bieżący element jako Table . |
as | Table | Zwraca bieżący element jako Table . |
as | Table | Zwraca bieżący element jako Table . |
as | Table | Zwraca bieżący element jako Table . |
clear() | Container | Czyści zawartość elementu. |
copy() | Container | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
edit | Text | Pobiera wersję Text bieżącego elementu do edycji. |
find | Range | Przeszukuje zawartość elementu pod kątem potomka określonego typu. |
find | Range | Przeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu Range . |
find | Range | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych. |
find | Range | Przeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania. |
get | Object | Pobiera atrybuty elementu. |
get | Element | Pobiera element podrzędny o określonym indeksie podrzędnym. |
get | Integer | Pobiera indeks podrzędnego elementu podrzędnego. |
get | String | Pobiera adres URL linku. |
get | Element | Pobiera następny element nadrzędny. |
get | Integer | Pobiera liczbę dzieci. |
get | Container | Pobiera element nadrzędny. |
get | Element | Pobiera poprzedni element nadrzędny elementu. |
get | String | Pobiera zawartość elementu jako ciąg tekstowy. |
get | Text | Pobiera wyrównanie tekstu. |
get | Element | Pobiera wartość atrybutu Element elementu. |
is | Boolean | Określa, czy element znajduje się na końcu Document . |
merge() | Container | Łączy element z poprzednim elementem tego samego typu. |
remove | Container | Usuwa element z jego elementu nadrzędnego. |
replace | Element | Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym. |
set | Container | Ustawia atrybuty elementu. |
set | Container | Ustawia adres URL linku. |
set | Container | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
as Body()
Zwraca bieżący element jako Body
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Body
– 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
as Equation()
Zwraca bieżący element jako Equation
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Equation
– 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
as Footnote Section()
Zwraca bieżący element jako Footnote
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Footnote
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Header Section()
Zwraca bieżący element jako Header
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Header
– 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
as List Item()
Zwraca bieżący element jako List
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
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
as Paragraph()
Zwraca bieżący element jako Paragraph
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Paragraph
– 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
as Table()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– 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
as Table Cell()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– 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
as Table Of Contents()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– 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
as Table Row()
Zwraca bieżący element jako Table
.
Używaj tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element należy do określonego typu.
Powrót
Table
– 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
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
Container
– nowa kopia.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
Pobiera wersję Text
bieżącego elementu do edycji.
Aby manipulować zawartością elementów jako tekstem sformatowanym, użyj edit
. Tryb edit
ignoruje elementy inne niż tekstowe (takie jak Inline
i Horizontal
).
Elementy podrzędne całkowicie zawarte w usuniętym zakresie tekstu są usuwane z elementu.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Powrót
Text
– tekstowa wersja bieżącego elementu
find Element(elementType)
Przeszukuje zawartość elementu pod kątem potomka określonego typu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
element | Element | Typ elementu do wyszukania. |
Powrót
Range
– wynik wyszukiwania wskazujący pozycję elementu wyszukiwania.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Element(elementType, from)
Przeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu Range
.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Parametry
Nazwa | Typ | Opis |
---|---|---|
element | Element | Typ elementu do wyszukania. |
from | Range | Wynik wyszukiwania, z którego chcesz wyszukiwać. |
Powrót
Range
– wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
Przeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, np. grupy uchwytywania i modyfikatory trybu.
Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
search | String | wzór do wyszukania. |
Powrót
Range
– wynik wyszukiwania wskazujący pozycję tekstu wyszukiwania lub null, jeśli nie ma dopasowania
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
Przeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, np. grupy uchwytywania i modyfikatory trybu.
Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
search | String | wzór do wyszukania. |
from | Range | wynik wyszukiwania, z którego chcesz wyszukiwać |
Powrót
Range
– wynik wyszukiwania wskazujący następną pozycję tekstu wyszukiwania lub null, jeśli nie ma dopasowania
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
Pobiera atrybuty elementu.
Wynikiem jest obiekt zawierający właściwość dla każdego prawidłowego atrybutu elementu, przy czym każda nazwa właściwości odpowiada elementowi w wyliczeniu Document
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Powrót
Object
– atrybuty elementu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Child(childIndex)
Pobiera element podrzędny o określonym indeksie podrzędnym.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Integer | Indeks elementu podrzędnego do pobrania. |
Powrót
Element
– element podrzędny o określonym indeksie.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Child Index(child)
Pobiera indeks podrzędnego elementu podrzędnego.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Element | Element podrzędny, którego indeks ma zostać pobrany. |
Powrót
Integer
– indeks podrzędny.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get 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 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 Previous Sibling()
Pobiera poprzedni element nadrzędny elementu.
Poprzedni element ma tego samego rodzica i poprzedza bieżący element.
Powrót
Element
– poprzedni równorzędny element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
Pobiera zawartość elementu jako ciąg tekstowy.
Powrót
String
– zawartość elementu jako ciąg tekstowy
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
Pobiera wyrównanie tekstu. Dostępne typy wyrównania to Document
, Document
i Document
.
Powrót
Text
– typ wyrównania tekstu lub null
, jeśli tekst zawiera wiele typów wyrównania lub jeśli wyrównanie tekstu nigdy nie zostało ustawione
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
Pobiera wartość atrybutu Element
elementu.
Aby określić dokładny typ danego elementu, użyj właściwości get
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Powrót
Element
– typ elementu.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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
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
Container
– 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 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
Container
– usunięty element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
Wzór wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScriptu. W tym celu musisz uciec się do użycia ukośnika wstecznego w wzorze.
Ta metoda korzysta z biblioteki wyrażeń regularnych RE2 firmy Google, która ogranicza obsługiwaną składnię.
Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Parametry
Nazwa | Typ | Opis |
---|---|---|
search | String | wzór wyrażenia regularnego do wyszukania; |
replacement | String | tekst, który ma być użyty jako tekst zastępczy; |
Powrót
Element
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Ustawia atrybuty elementu.
Parametr specified attributes musi być obiektem, w którym każda nazwa właściwości jest elementem zbioru wyliczenia Document
, a każda wartość właściwości jest nową wartością do zastosowania.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parametry
Nazwa | Typ | Opis |
---|---|---|
attributes | Object | atrybuty elementu, |
Powrót
Container
– 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
Container
– bieżący element.
Autoryzacja
Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
Ustawia wyrównanie tekstu. Dostępne typy wyrównania to Document
, Document
i Document
.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | Text | typ wyrównania tekstu, który ma być zastosowany. |
Powrót
Container
– 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