Element reprezentujący treść dokumentu. Element Body
może zawierać elementy ListItem
, Paragraph
, Table
i TableOfContents
. Więcej informacji o strukturze dokumentów znajdziesz w przewodniku po rozszerzeniach Dokumentów Google.
Element Body
zwykle zawiera pełną treść dokumentu oprócz HeaderSection
, FooterSection
i wszystkich elementów FootnoteSection
.
var doc = DocumentApp.getActiveDocument(); var body = doc.getBody(); // Append a paragraph and a page break to the document 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 bloba obrazu. |
appendImage(image) | InlineImage | Dołącza daną właściwość InlineImage . |
appendListItem(listItem) | ListItem | Dołącza daną właściwość ListItem . |
appendListItem(text) | ListItem | Tworzy i dołącza nowy element ListItem zawierający określony tekst. |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dołącza daną właściwość PageBreak . |
appendParagraph(paragraph) | Paragraph | Dołącza daną właściwość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy element Paragraph zawierający określony tekst. |
appendTable() | Table | Tworzy i dołącza nowy element Table . |
appendTable(cells) | Table | Zawiera nowy element Table zawierający TableCell dla każdej określonej wartości ciągu. |
appendTable(table) | Table | Dołącza daną właściwość Table . |
clear() | Body | Czyści zawartość elementu. |
copy() | Body | Zwraca odłączoną głęboką kopię bieżącego elementu. |
editAsText() | Text | Uzyskuje do edycji wersję Text bieżącego elementu. |
findElement(elementType) | RangeElement | Wyszukuje zawartość elementu w przypadku elementu potomnego określonego typu. |
findElement(elementType, from) | RangeElement | Wyszukuje zawartość elementu w przypadku potomna określonego typu, począwszy od określonego elementu RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu w określonym wzorze tekstowym za pomocą wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu w określonym wzorze tekstu, zaczynając od danego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny w określonym indeksie podrzędnym. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny określonego elementu podrzędnego. |
getHeadingAttributes(paragraphHeading) | Object | Pobiera zestaw atrybutów dla podanego ciągu ParagraphHeading . |
getImages() | InlineImage[] | Pobiera wszystkie elementy InlineImages zawarte w sekcji. |
getListItems() | ListItem[] | Pobiera wszystkie elementy 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ę elementów podrzędnych. |
getPageHeight() | Number | Pobiera wysokość strony w punktach. |
getPageWidth() | Number | Pobiera szerokość strony w punktach. |
getParagraphs() | Paragraph[] | Pobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny. |
getTables() | Table[] | Pobiera wszystkie elementy Tables zawarte w sekcji. |
getText() | String | Pobiera zawartość elementu w postaci ciągu tekstowego. |
getTextAlignment() | TextAlignment | Uzyskaj wyrównanie tekstu. |
getType() | ElementType | Pobiera element ElementType . |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia nowy indeks HorizontalRule w określonym indeksie. |
insertImage(childIndex, image) | InlineImage | Tworzy i wstawia InlineImage z określonego bloba obrazu w określonym indeksie. |
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 | Powoduje utworzenie i wstawienie nowego parametru ListItem w określonym indeksie zawierającego treści tekstowe. |
insertPageBreak(childIndex) | PageBreak | Tworzy i wstawia nowy indeks PageBreak w określonym 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 | Powoduje utworzenie i wstawienie nowego parametru Paragraph w określonym indeksie zawierającego treści tekstowe. |
insertTable(childIndex) | Table | Tworzy i wstawia nowy indeks Table w określonym indeksie. |
insertTable(childIndex, cells) | Table | Powoduje utworzenie i wstawienie nowego elementu Table zawierającego 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 | Zamienia wszystkie wystąpienia danego wzorca tekstowego na określony ciąg zastępczy za pomocą wyrażeń regularnych. |
setAttributes(attributes) | Body | Ustawia atrybuty elementu. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Ustawia atrybuty podanego ParagraphHeading . |
setMarginBottom(marginBottom) | Body | Ustawia dolny margines w punktach. |
setMarginLeft(marginLeft) | Body | Ustawia lewy margines w punktach. |
setMarginRight(marginRight) | Body | Ustawia odpowiedni margines w punktach. |
setMarginTop(marginTop) | Body | Ustawia górny margines. |
setPageHeight(pageHeight) | Body | Ustawia wysokość strony w punktach. |
setPageWidth(pageWidth) | Body | Ustawia szerokość strony w punktach. |
setText(text) | Body | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | Body | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
appendHorizontalRule()
Tworzy i dołącza nowy element HorizontalRule
.
Element HorizontalRule
będzie zawarty w nowym interfejsie Paragraph
.
Zwróć
HorizontalRule
– nowa reguła pozioma
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 bloba obrazu.
Obraz zostanie umieszczony w nowym pliku Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | BlobSource | dane obrazu |
Zwróć
InlineImage
– załączony obraz.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
Dołącza daną właściwość InlineImage
.
Element InlineImage
będzie zawarty w nowym interfejsie Paragraph
.
Użyj tej wersji klucza appendImage
, gdy dołączasz kopię istniejącego pliku InlineImage
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | InlineImage | dane obrazu |
Zwróć
InlineImage
– załączony obraz.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
Dołącza daną właściwość ListItem
.
Użyj tej wersji klucza appendListItem
, gdy dołączasz kopię istniejącego pliku ListItem
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
listItem | ListItem | elementu listy do dołączenia |
Zwróć
ListItem
– dołączony element listy.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
Tworzy i dołącza nowy element ListItem
zawierający określony tekst.
Kolejne pozycje na liście są dodawane do tej samej listy.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | treść tekstu elementu listy |
Zwróć
ListItem
– nowy element listy
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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
będzie zawarty w nowym interfejsie Paragraph
.
Zwróć
PageBreak
– nowy podział strony
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
Dołącza daną właściwość PageBreak
.
Element PageBreak
będzie zawarty w nowym interfejsie Paragraph
.
Użyj tej wersji klucza appendPageBreak
, gdy dołączasz kopię istniejącego pliku PageBreak
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageBreak | PageBreak | podział strony do dołączenia |
Zwróć
PageBreak
– dołączony podział strony
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
Dołącza daną właściwość Paragraph
.
Użyj tej wersji klucza appendParagraph
, gdy dołączasz kopię istniejącego pliku Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraph | Paragraph | akapitu do dołączenia |
Zwróć
Paragraph
– dołączony akapit
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
Tworzy i dołącza nowy element Paragraph
zawierający określony tekst.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | zawartość akapitu |
Zwróć
Paragraph
– nowy akapit
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 dołączy też pusty akapit po tabeli, bo dokumenty Google nie mogą kończyć się tabelą.
Zwróć
Table
– nowa tabela
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
Zawiera nowy element Table
zawierający TableCell
dla każdej określonej wartości ciągu.
Ta metoda dołączy też pusty akapit po tabeli, bo dokumenty Google nie mogą kończyć się tabelą.
Parametry
Nazwa | Typ | Opis |
---|---|---|
cells | String[][] | zawartość komórek tabeli do dodania do nowej tabeli |
Zwróć
Table
– dołączona tabela
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
Dołącza daną właściwość Table
.
Użyj tej wersji klucza appendTable
, gdy dołączasz kopię istniejącego pliku Table
.
Ta metoda dołączy też pusty akapit po tabeli, bo dokumenty Google nie mogą kończyć się tabelą.
Parametry
Nazwa | Typ | Opis |
---|---|---|
table | Table | tabelę do dołączenia |
Zwróć
Table
– dołączona tabela
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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.
Wszystkie jego elementy podrzędne też zostaną skopiowane. Nowy element nie ma elementu nadrzędnego.
Zwróć
Body
– nowa kopia.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Uzyskuje do edycji wersję Text
bieżącego elementu.
Wartość editAsText
służy do manipulowania treścią elementów jako tekst sformatowany. Tryb editAsText
ignoruje elementy nietekstowe (np. InlineImage
i HorizontalRule
).
Elementy podrzędne w całości usuniętego zakresu tekstowego są usuwane z elementu.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Zwróć
Text
– wersja tekstowa bieżącego elementu.
findElement(elementType)
Wyszukuje zawartość elementu w przypadku elementu potomnego określonego typu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
elementType | ElementType | typ elementu do wyszukania. |
Zwróć
RangeElement
– wynik wyszukiwania wskazujący pozycję elementu wyszukiwania;
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Wyszukuje zawartość elementu w przypadku potomna określonego typu, począwszy od określonego elementu RangeElement
.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Parametry
Nazwa | Typ | Opis |
---|---|---|
elementType | ElementType | typ elementu do wyszukania. |
from | RangeElement | wynik wyszukiwania do wyszukania |
Zwróć
RangeElement
– wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Przeszukuje zawartość elementu w określonym wzorze tekstowym za pomocą wyrażeń regularnych.
Część funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwana, np. grupy przechwytywania i modyfikatory trybu.
Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstowego zawartego w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wzór do wyszukania |
Zwróć
RangeElement
– wynik wyszukiwania wskazujący pozycję wyszukiwanego hasła lub wartość null, jeśli nie ma dopasowania.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Przeszukuje zawartość elementu w określonym wzorze tekstu, zaczynając od danego wyniku wyszukiwania.
Część funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwana, np. grupy przechwytywania i modyfikatory trybu.
Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstowego zawartego w bieżącym elemencie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wzór do wyszukania |
from | RangeElement | wynik wyszukiwania do wyszukania |
Zwróć
RangeElement
– wynik wyszukiwania wskazujący następną pozycję wyszukiwanego hasła lub wartość null w przypadku braku dopasowania.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Pobiera atrybuty elementu.
W rezultacie obiekt zawiera właściwość dla każdego prawidłowego atrybutu elementu, gdzie każda nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Zwróć
Object
– atrybuty elementu
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Pobiera element podrzędny w określonym indeksie podrzędnym.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks elementu podrzędnego do pobrania |
Zwróć
Element
– element podrzędny w określonym indeksie,
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Pobiera indeks podrzędny określonego elementu podrzędnego.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Element | element podrzędny, dla którego zostanie pobrany indeks |
Zwróć
Integer
– indeks podrzędny
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 ciągu ParagraphHeading
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraphHeading | ParagraphHeading | nagłówka, którego atrybuty zostaną pobrane. |
Zwróć
Object
– mapa atrybutów i ich bieżących wartości;
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
Pobiera wszystkie elementy InlineImages
zawarte w sekcji.
Zwróć
InlineImage[]
– obrazy sekcji
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
Pobiera wszystkie elementy ListItems
zawarte w sekcji.
Zwróć
ListItem[]
– elementy listy sekcji;
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginBottom()
Pobiera dolny margines w punktach.
Zwróć
Number
– dolny margines w punktach
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginLeft()
Pobiera lewy margines w punktach.
Zwróć
Number
– lewy margines w punktach
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginRight()
Pobiera prawy margines.
Zwróć
Number
– prawy margines w punktach
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginTop()
Pobiera górny margines.
Zwróć
Number
– górny margines w punktach
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Pobiera liczbę elementów podrzędnych.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Zwróć
Integer
– liczba dzieci
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageHeight()
Pobiera wysokość strony w punktach.
Zwróć
Number
– wysokość strony w punktach,
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageWidth()
Pobiera szerokość strony w punktach.
Zwróć
Number
– szerokość strony w punktach,
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
Pobiera wszystkie elementy Paragraphs
zawarte w sekcji (w tym ListItems
).
Zwróć
Paragraph[]
– akapity sekcji
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Pobiera element nadrzędny.
Element nadrzędny zawiera bieżący element.
Zwróć
ContainerElement
– element nadrzędny;
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTables()
getText()
Pobiera zawartość elementu w postaci ciągu tekstowego.
Zwróć
String
– zawartość elementu w postaci ciągu tekstowego;
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Uzyskaj wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
i DocumentApp.TextAlignment.SUPERSCRIPT
.
Zwróć
TextAlignment
– typ wyrównania tekstu lub null
, jeśli tekst zawiera wiele typów wyrównania tekstu lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Pobiera element ElementType
.
Użyj właściwości getType()
, aby dokładnie określić typ danego elementu.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Zwróć
ElementType
– typ elementu;
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Tworzy i wstawia nowy indeks HorizontalRule
w określonym indeksie.
Element HorizontalRule
będzie zawarty w nowym interfejsie Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
Zwróć
HorizontalRule
– nowa reguła pozioma
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
Tworzy i wstawia InlineImage
z określonego bloba obrazu w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
image | BlobSource | dane obrazu |
Zwróć
InlineImage
– wstawiony obraz wbudowany
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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, do którego należy wstawić element |
image | InlineImage | obraz do wstawienia |
Zwróć
InlineImage
– wstawiony obraz wbudowany
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 którego należy wstawić |
listItem | ListItem | element listy do wstawienia |
Zwróć
ListItem
– wstawiony element listy
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
Powoduje utworzenie i wstawienie nowego parametru ListItem
w określonym indeksie zawierającego treści tekstowe.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić |
text | String | treść tekstu elementu listy |
Zwróć
ListItem
– nowy element listy
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
Tworzy i wstawia nowy indeks PageBreak
w określonym indeksie.
Element PageBreak
będzie zawarty w nowym interfejsie Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
Zwróć
PageBreak
– nowy podział strony
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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
będzie zawarty w nowym interfejsie Paragraph
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
pageBreak | PageBreak | przerwa p[age] |
Zwróć
PageBreak
– wstawiony podział strony
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 którego należy wstawić |
paragraph | Paragraph | akapitu do wstawienia |
Zwróć
Paragraph
– wstawiony akapit
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Powoduje utworzenie i wstawienie nowego parametru Paragraph
w określonym indeksie zawierającego treści tekstowe.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić |
text | String | zawartość akapitu |
Zwróć
Paragraph
– nowy akapit
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
Tworzy i wstawia nowy indeks Table
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić |
Zwróć
Table
– nowa tabela
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
Powoduje utworzenie i wstawienie nowego elementu Table
zawierającego określone komórki w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić |
cells | String[][] | zawartość komórek tabeli do dodania do nowej tabeli |
Zwróć
Table
– nowa tabela
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 którego należy wstawić |
table | Table | tabela do wstawienia |
Zwróć
Table
– wstawiono tabelę
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Zamienia wszystkie wystąpienia danego wzorca tekstowego na określony ciąg zastępczy za pomocą wyrażeń regularnych.
Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu trzeba uniknąć zmiany ukośników we wzorze.
Ta metoda wykorzystuje bibliotekę wyrażeń regularnych RE2 Google, która ogranicza obsługiwaną składnię.
Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstowego zawartego w bieżącym elemencie.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parametry
Nazwa | Typ | Opis |
---|---|---|
searchPattern | String | wyrażenie regularne do wyszukania |
replacement | String | tekst, który ma być używany jako zamiennik. |
Zwróć
Element
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Ustawia atrybuty elementu.
Wskazany parametr musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczeniach DocumentApp.Attribute
, a każda wartość właściwości to nowa wartość do zastosowania.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parametry
Nazwa | Typ | Opis |
---|---|---|
attributes | Object | Atrybuty elementu. |
Zwróć
Body
– bieżący element.
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeadingAttributes(paragraphHeading, attributes)
Ustawia atrybuty podanego ParagraphHeading
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
paragraphHeading | ParagraphHeading | nagłówka, którego atrybuty zostaną ustawione |
attributes | Object | mapę atrybutów i ich wartości |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginRight(marginRight)
Ustawia odpowiedni margines w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
marginRight | Number | prawy margines |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPageHeight(pageHeight)
Ustawia wysokość strony w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageHeight | Number | wysokość strony w punktach |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPageWidth(pageWidth)
Ustawia szerokość strony w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageWidth | Number | szerokość strony w punktach |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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 |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Ustawia wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
i DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametry
Nazwa | Typ | Opis |
---|---|---|
textAlignment | TextAlignment | typ dopasowania tekstu, który ma zostać zastosowany |
Zwróć
Body
– bieżący element
Autoryzacja
Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents