Zawartość karty w dokumencie Dokumentów Google. Pole Body
może zawierać ListItem
,
Elementy Paragraph
, Table
i TableOfContents
. Więcej informacji na temat:
strukturę dokumentu, zobacz przewodnik po
rozszerzenie Dokumentów Google.
Element Body
zwykle zawiera pełną zawartość karty z wyjątkiem elementów HeaderSection
, FooterSection
i FootnoteSection
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph("A paragraph."); body.appendPageBreak();
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendListItem(listItem) | ListItem | Dołącza podaną wartość ListItem . |
appendListItem(text) | ListItem | Tworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu. |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dołącza podaną wartość PageBreak . |
appendParagraph(paragraph) | Paragraph | Dołącza podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu. |
appendTable() | Table | Tworzy i dołącza nowy element Table . |
appendTable(cells) | Table | Dodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu. |
appendTable(table) | Table | Dołącza podaną wartość Table . |
clear() | Body | Usuwa zawartość elementu. |
copy() | Body | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
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 potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getHeadingAttributes(paragraphHeading) | Object | Pobiera zestaw atrybutów dla podanego elementu ParagraphHeading . |
getImages() | InlineImage[] | Pobiera wszystkie InlineImages zawarte w sekcji. |
getListItems() | ListItem[] | Pobiera wszystkie ListItems zawarte w sekcji. |
getMarginBottom() | Number | Pobiera dolny margines (w punktach). |
getMarginLeft() | Number | Pobiera lewy margines (w punktach). |
getMarginRight() | Number | Pobiera prawy margines. |
getMarginTop() | Number | Pobiera górny margines. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getPageHeight() | Number | Pobiera wysokość strony w punktach. |
getPageWidth() | Number | Pobiera szerokość strony w punktach. |
getParagraphs() | Paragraph[] | Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getTables() | Table[] | Pobiera wszystkie Tables zawarte w sekcji. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia nowy HorizontalRule w podanym indeksie. |
insertImage(childIndex, image) | InlineImage | Tworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertListItem(childIndex, listItem) | ListItem | Wstawia podaną wartość ListItem w określonym indeksie. |
insertListItem(childIndex, text) | ListItem | Tworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertPageBreak(childIndex) | PageBreak | Tworzy i wstawia nowy PageBreak w podanym indeksie. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Wstawia podaną wartość PageBreak w określonym indeksie. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podaną wartość Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertTable(childIndex) | Table | Tworzy i wstawia nowy Table w podanym indeksie. |
insertTable(childIndex, cells) | Table | Tworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie. |
insertTable(childIndex, table) | Table | Wstawia podaną wartość Table w określonym indeksie. |
removeChild(child) | Body | Usuwa określony element podrzędny. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | Body | Ustawia atrybuty elementu. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Ustawia atrybuty dla podanego elementu ParagraphHeading . |
setMarginBottom(marginBottom) | Body | Ustawia dolny margines (w punktach). |
setMarginLeft(marginLeft) | Body | Ustawia lewy margines w punktach. |
setMarginRight(marginRight) | Body | Ustawia prawy margines (w punktach). |
setMarginTop(marginTop) | Body | Ustawia górny margines. |
setPageHeight(pageHeight) | Body | Określa wysokość strony w punktach. |
setPageWidth(pageWidth) | Body | Określa szerokość strony w punktach. |
setText(text) | Body | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | Body | Określa wyrównanie tekstu. |
Szczegółowa dokumentacja
appendHorizontalRule()
Tworzy i dołącza nowy element HorizontalRule
.
Element HorizontalRule
zostanie zawarty w nowym elemencie Paragraph
.
Powrót
HorizontalRule
– nowa linia pozioma.
Autoryzacja
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
appendImage(image)
Tworzy i dołącza nowy obiekt InlineImage
z określonego obiektu blob obrazu.
Obraz zostanie umieszczony w nowym pliku Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | BlobSource | Dane obrazu. |
Powrót
InlineImage
– dołączony obraz.
Autoryzacja
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
appendImage(image)
Dołącza podaną wartość InlineImage
.
Element InlineImage
zostanie zawarty w nowym elemencie Paragraph
.
Użyj tej wersji appendImage
, gdy dołączasz kopię istniejącego elementu InlineImage
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | InlineImage | Dane obrazu. |
Powrót
InlineImage
– dołączony obraz.
Autoryzacja
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
appendListItem(listItem)
Dołącza podaną wartość ListItem
.
Użyj tej wersji appendListItem
, gdy dołączasz kopię istniejącego elementu ListItem
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
listItem | ListItem | Element listy do dołączenia. |
Powrót
ListItem
– dołączony element listy.
Autoryzacja
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
appendListItem(text)
Tworzy i dołącza nowy dokument ListItem
zawierający określoną zawartość tekstu.
Kolejne elementy listy są dodawane jako część tej samej listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Zawartość tekstowa elementu listy. |
Powrót
ListItem
– nowy element listy.
Autoryzacja
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
.
Element PageBreak
zostanie zawarty w nowym elemencie Paragraph
.
Powrót
PageBreak
– nowy podział strony.
Autoryzacja
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)
Dołącza podaną wartość PageBreak
.
Element PageBreak
zostanie zawarty w nowym elemencie Paragraph
.
Użyj tej wersji appendPageBreak
, gdy dołączasz kopię istniejącego elementu PageBreak
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageBreak | PageBreak | Podział strony do dołączenia. |
Powrót
PageBreak
– dołączony podział strony.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Dołącza podaną wartość Paragraph
.
Użyj tej wersji appendParagraph
, gdy dołączasz kopię istniejącego elementu Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraph | Paragraph | Akapit do dołączenia. |
Powrót
Paragraph
– dołączony akapit.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
Tworzy i dołącza nowy dokument Paragraph
zawierający określoną zawartość tekstu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Treść akapitu. |
Powrót
Paragraph
– nowy akapit.
Autoryzacja
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
appendTable()
Tworzy i dołącza nowy element Table
.
Ta metoda spowoduje też dodanie pustego akapitu za tabelą, ponieważ dokumenty Dokumentów Google nie może kończyć się tabelą.
Powrót
Table
– nowa tabela.
Autoryzacja
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
appendTable(cells)
Dodaje nowy element Table
zawierający TableCell
dla każdej określonej wartości ciągu.
Ta metoda spowoduje też dodanie pustego akapitu za tabelą, ponieważ dokumenty Dokumentów Google nie może kończyć się tabelą.
Parametry
Nazwa | Typ | Opis |
---|---|---|
cells | String[][] | Zawartość tekstowa z komórek tabeli, które mają zostać dodane do nowej tabeli. |
Powrót
Table
– dołączona tabela.
Autoryzacja
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
appendTable(table)
Dołącza podaną wartość Table
.
Użyj tej wersji appendTable
, gdy dołączasz kopię istniejącego elementu Table
.
Ta metoda spowoduje też dodanie pustego akapitu za tabelą, ponieważ dokumenty Dokumentów Google
nie może kończyć się tabelą.
Parametry
Nazwa | Typ | Opis |
---|---|---|
table | Table | Tabela do dołączenia. |
Powrót
Table
– dołączona tabela.
Autoryzacja
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.
Skopiowane są też wszystkie elementy podrzędne zawarte w elemencie. Nowy element nie ma elementu nadrzędnego.
Powrót
Body
– nowa wersja,
Autoryzacja
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 wersję Text
bieżącego elementu do edycji.
editAsText
umożliwia manipulowanie zawartością elementów jako tekstu sformatowanego. Tryb editAsText
ignoruje elementy inne niż tekstowe (np. InlineImage
i HorizontalRule
).
Elementy podrzędne, które w pełni znajdują się w usuniętym zakresie tekstowym, są usuwane z elementu.
var 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
– 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. |
Powrót
RangeElement
– wynik wyszukiwania wskazujący pozycję elementu wyszukiwania.
Autoryzacja
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 potomnego określonego typu, zaczynając od
określono RangeElement
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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. |
Powrót
RangeElement
– wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.
Autoryzacja
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 tekstu przy użyciu wyrażeń regularnych.
Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, na przykład grup przechwytywania i modyfikatorów trybów.
Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wzorzec do wyszukania |
Powrót
RangeElement
– wynik wyszukiwania wskazujący pozycję szukanego tekstu lub wartość null, jeśli nie ma wartości;
gra
Autoryzacja
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 pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, na przykład grup przechwytywania i modyfikatorów trybów.
Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wzorzec do wyszukania |
from | RangeElement | wynik wyszukiwania |
Powrót
RangeElement
– wynik wyszukiwania wskazujący następną pozycję wyszukiwanego tekstu lub wartość null, jeśli nie ma podanej wartości;
gra
Autoryzacja
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.
Wynikiem jest obiekt zawierający właściwość każdego prawidłowego atrybutu elementu,
nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.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]); }
Powrót
Object
– atrybuty elementu.
Autoryzacja
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.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. 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. |
Powrót
Element
– element podrzędny o określonym indeksie.
Autoryzacja
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, dla którego ma zostać pobrany indeks. |
Powrót
Integer
– indeks podrzędny.
Autoryzacja
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
getHeadingAttributes(paragraphHeading)
Pobiera zestaw atrybutów dla podanego elementu ParagraphHeading
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraphHeading | ParagraphHeading | Nagłówek, z którego atrybuty mają zostać pobrane. |
Powrót
Object
– mapa atrybutów i ich bieżących wartości.
Autoryzacja
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
getImages()
Pobiera wszystkie InlineImages
zawarte w sekcji.
Powrót
InlineImage[]
– obrazy sekcji.
Autoryzacja
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
getListItems()
Pobiera wszystkie ListItems
zawarte w sekcji.
Powrót
ListItem[]
– elementy listy sekcji.
Autoryzacja
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
getMarginBottom()
Pobiera dolny margines (w punktach).
Powrót
Number
– dolny margines (w punktach).
Autoryzacja
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
getMarginLeft()
Pobiera lewy margines (w punktach).
Powrót
Number
– lewy margines (w punktach).
Autoryzacja
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
getMarginRight()
Pobiera prawy margines.
Powrót
Number
– prawy margines (w punktach).
Autoryzacja
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
getMarginTop()
Pobiera górny margines.
Powrót
Number
– górny margines (w punktach).
Autoryzacja
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ę dzieci.
var 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 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
getPageHeight()
Pobiera wysokość strony w punktach.
Powrót
Number
– wysokość strony w punktach.
Autoryzacja
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
getPageWidth()
Pobiera szerokość strony w punktach.
Powrót
Number
– szerokość strony w punktach.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
Pobiera wszystkie funkcje Paragraphs
zawarte w sekcji (w tym ListItems
).
Powrót
Paragraph[]
– akapity sekcji.
Autoryzacja
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 bieżący element.
Powrót
ContainerElement
– element nadrzędny.
Autoryzacja
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
getTables()
getText()
Pobiera zawartość elementu jako ciąg tekstowy.
Powrót
String
– zawartość elementu w postaci ciągu tekstowego;
Autoryzacja
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()
Pobiera wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
i DocumentApp.TextAlignment.SUPERSCRIPT
.
Powrót
TextAlignment
– typ wyrównania tekstu lub null
, jeśli tekst zawiera różne typy tekstu.
lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.
Autoryzacja
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 wartość ElementType
elementu.
Aby określić dokładny typ danego elementu, użyj właściwości getType()
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's 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.'); }
Powrót
ElementType
– typ elementu.
Autoryzacja
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 nowy HorizontalRule
w podanym indeksie.
Element HorizontalRule
zostanie zawarty w nowym elemencie Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks, w którym ma zostać wstawiony element. |
Powrót
HorizontalRule
– nowa linia pozioma.
Autoryzacja
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
insertImage(childIndex, image)
Tworzy i wstawia obiekt InlineImage
z określonego obiektu blob w określonym miejscu
indeksu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks, w którym ma zostać wstawiony element. |
image | BlobSource | Dane obrazu. |
Powrót
InlineImage
– wstawiony obraz w tekście.
Autoryzacja
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
insertImage(childIndex, image)
Wstawia podaną wartość InlineImage
w określonym indeksie.
Obraz zostanie umieszczony w nowym pliku Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks, w którym ma zostać wstawiony element. |
image | InlineImage | Obraz do wstawienia. |
Powrót
InlineImage
– wstawiony obraz w tekście.
Autoryzacja
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
insertListItem(childIndex, listItem)
Wstawia podaną wartość ListItem
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
listItem | ListItem | Element listy do wstawienia. |
Powrót
ListItem
– wstawiony element listy.
Autoryzacja
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
insertListItem(childIndex, text)
Tworzy i wstawia nowy element ListItem
w podanym indeksie, zawierający określony indeks
zawartość tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
text | String | Zawartość tekstowa elementu listy. |
Powrót
ListItem
– nowy element listy.
Autoryzacja
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 PageBreak
w podanym indeksie.
Element PageBreak
zostanie zawarty w nowym elemencie Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks, w którym ma zostać wstawiony element. |
Powrót
PageBreak
– nowy podział strony.
Autoryzacja
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 podaną wartość PageBreak
w określonym indeksie.
Element PageBreak
zostanie zawarty w nowym elemencie Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks, w którym ma zostać wstawiony element. |
pageBreak | PageBreak | Podział strony do wstawienia. |
Powrót
PageBreak
– wstawiony podział strony.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
Wstawia podaną wartość Paragraph
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
paragraph | Paragraph | Akapit do wstawienia. |
Powrót
Paragraph
– wstawiony akapit.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Tworzy i wstawia nowy element Paragraph
w podanym indeksie, zawierający określony indeks
zawartość tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
text | String | Treść akapitu. |
Powrót
Paragraph
– nowy akapit.
Autoryzacja
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
insertTable(childIndex)
Tworzy i wstawia nowy Table
w podanym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
Powrót
Table
– nowa tabela.
Autoryzacja
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
insertTable(childIndex, cells)
Tworzy i wstawia nowy obiekt Table
zawierający określone komórki w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
cells | String[][] | Zawartość tekstowa z komórek tabeli, które mają zostać dodane do nowej tabeli. |
Powrót
Table
– nowa tabela.
Autoryzacja
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
insertTable(childIndex, table)
Wstawia podaną wartość Table
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | Indeks do wstawienia. |
table | Table | Tabela do wstawienia. |
Powrót
Table
– wstawiona tabela.
Autoryzacja
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. |
Powrót
Body
– bieżący element.
Autoryzacja
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 ciągiem zastępczym, stosując zwykłe wyrażeń.
Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu konieczne jest ominięcie ukośnika wstecznego we wzorcu.
Ta metoda korzysta ze standardowego algorytmu Google RE2 biblioteki wyrażeń, która ogranicza obsługiwaną składnię.
Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.
var 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 |
---|---|---|
searchPattern | String | wzorzec wyrażenia regularnego do wyszukania |
replacement | String | tekst, który ma zostać użyty jako zamiennik |
Powrót
Element
– bieżący element.
Autoryzacja
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
wyliczenie DocumentApp.Attribute
, a każda wartość właściwości jest nową wartością do
zastosowano.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.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. |
Powrót
Body
– bieżący element.
Autoryzacja
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
setHeadingAttributes(paragraphHeading, attributes)
Ustawia atrybuty dla podanego elementu ParagraphHeading
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraphHeading | ParagraphHeading | Nagłówek, którego atrybuty powinny zostać ustawione. |
attributes | Object | Mapa atrybutów i wartości ich ustawienia. |
Powrót
Body
– bieżący element.
Autoryzacja
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
setMarginBottom(marginBottom)
Ustawia dolny margines (w punktach).
Parametry
Nazwa | Typ | Opis |
---|---|---|
marginBottom | Number | Dolny margines (w punktach). |
Powrót
Body
– bieżący element.
Autoryzacja
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
setMarginLeft(marginLeft)
Ustawia lewy margines w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
marginLeft | Number | Lewy margines (w punktach). |
Powrót
Body
– bieżący element.
Autoryzacja
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
setMarginRight(marginRight)
Ustawia prawy margines (w punktach).
Parametry
Nazwa | Typ | Opis |
---|---|---|
marginRight | Number | Prawy margines. |
Powrót
Body
– bieżący element.
Autoryzacja
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
setMarginTop(marginTop)
Ustawia górny margines.
Parametry
Nazwa | Typ | Opis |
---|---|---|
marginTop | Number | Górny margines (w punktach). |
Powrót
Body
– bieżący element.
Autoryzacja
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
setPageHeight(pageHeight)
Określa wysokość strony w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageHeight | Number | Wysokość strony w punktach. |
Powrót
Body
– bieżący element.
Autoryzacja
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
setPageWidth(pageWidth)
Określa szerokość strony w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageWidth | Number | Szerokość strony w punktach. |
Powrót
Body
– bieżący element.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
Ustawia zawartość jako zwykły tekst.
Uwaga: istniejąca zawartość zostanie wyczyszczona.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | Nowa zawartość tekstowa. |
Powrót
Body
– bieżący element.
Autoryzacja
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)
Określa wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
i DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametry
Nazwa | Typ | Opis |
---|---|---|
textAlignment | TextAlignment | typ wyrównania tekstu, który ma zostać zastosowany |
Powrót
Body
– bieżący element.
Autoryzacja
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