Element reprezentujący akapit. Element Paragraph
może zawierać elementy Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
i Text
. Więcej informacji o strukturze dokumentów znajdziesz w przewodniku po rozszerzeniach Dokumentów Google.
Pole Paragraphs
nie może zawierać znaków nowego wiersza. Znaki nowego wiersza ("\n") są konwertowane na znaki podziału wiersza ("____").
var body = DocumentApp.getActiveDocument().getBody(); // Append a document header paragraph. var header = body.appendParagraph("A Document"); header.setHeading(DocumentApp.ParagraphHeading.HEADING1); // Append a section header paragraph. var section = body.appendParagraph("Section 1"); section.setHeading(DocumentApp.ParagraphHeading.HEADING2); // Append a regular paragraph. body.appendParagraph("This is a typical paragraph.");
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addPositionedImage(image) | PositionedImage | Tworzy i wstawia nowy obiekt PositionedImage z określonego obiektu blob obrazu. |
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendInlineImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego bloba obrazu. |
appendInlineImage(image) | InlineImage | Dołącza daną właściwość InlineImage . |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dołącza daną właściwość PageBreak . |
appendText(text) | Text | Tworzy i dołącza nowy element Text z określoną zawartością. |
appendText(text) | Text | Dołącza element Text . |
clear() | Paragraph | Czyści zawartość elementu. |
copy() | Paragraph | 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. |
getAlignment() | HorizontalAlignment | Pobiera HorizontalAlignment . |
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. |
getHeading() | ParagraphHeading | Pobiera ParagraphHeading . |
getIndentEnd() | Number | Pobiera wcięcie na końcu. |
getIndentFirstLine() | Number | Pobiera punkty wcięcia pierwszego wiersza. |
getIndentStart() | Number | Pobiera wcięcie rozpoczęcia. |
getLineSpacing() | Number | Pobiera odstępy między wierszami w punktach. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera element potomny. |
getNumChildren() | Integer | Pobiera liczbę elementów podrzędnych. |
getParent() | ContainerElement | Pobiera element nadrzędny. |
getPositionedImage(id) | PositionedImage | Pobiera PositionedImage według identyfikatora obrazu. |
getPositionedImages() | PositionedImage[] | Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu. |
getPreviousSibling() | Element | Pobiera element potomny. |
getSpacingAfter() | Number | Pobiera odstępy po elemencie w punktach. |
getSpacingBefore() | Number | Pobiera odstępy między elementami w punktach. |
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 HorizontalRule w określonym indeksie. |
insertInlineImage(childIndex, image) | InlineImage | Tworzy i wstawia nowy obiekt InlineImage z określonego bloba obrazu w określonym indeksie. |
insertInlineImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
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. |
insertText(childIndex, text) | Text | Tworzy i wstawia nowy element tekstowy w określonym indeksie. |
insertText(childIndex, text) | Text | Wstawia określony element Text w określonym indeksie z określoną treścią tekstową. |
isAtDocumentEnd() | Boolean | Określa, czy element znajduje się na końcu elementu Document . |
isLeftToRight() | Boolean | Pobiera ustawienie od lewej do prawej. |
merge() | Paragraph | Scala element z poprzednim elementem tego samego typu. |
removeChild(child) | Paragraph | Usuwa określony element podrzędny. |
removeFromParent() | Paragraph | Usuwa element z elementu nadrzędnego. |
removePositionedImage(id) | Boolean | Usuwa PositionedImage na podstawie identyfikatora obrazu. |
replaceText(searchPattern, replacement) | Element | Zamienia wszystkie wystąpienia danego wzorca tekstowego na określony ciąg zastępczy za pomocą wyrażeń regularnych. |
setAlignment(alignment) | Paragraph | Ustawia HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Ustawia atrybuty elementu. |
setHeading(heading) | Paragraph | Ustawia ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Ustawia wcięcie na końcu (w punktach). |
setIndentFirstLine(indentFirstLine) | Paragraph | Ustawia wcięcie pierwszego wiersza w punktach. |
setIndentStart(indentStart) | Paragraph | Ustawia wcięcie początkowe (w punktach). |
setLeftToRight(leftToRight) | Paragraph | Ustawia ustawienie od lewej do prawej. |
setLineSpacing(multiplier) | Paragraph | Ustawia odstępy między wierszami jako liczbę wskazującą liczbę wierszy, które mają być użyte do odstępów. |
setLinkUrl(url) | Paragraph | Ustawia URL linku. |
setSpacingAfter(spacingAfter) | Paragraph | Ustawia odstępy między elementami w punktach. |
setSpacingBefore(spacingBefore) | Paragraph | Ustawia odstępy między elementami w punktach. |
setText(text) | void | Ustawia treść akapitu jako tekst. |
setTextAlignment(textAlignment) | Paragraph | Ustawia wyrównanie tekstu. |
Szczegółowa dokumentacja
addPositionedImage(image)
Tworzy i wstawia nowy obiekt PositionedImage
z określonego obiektu blob obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
image | BlobSource | dane obrazu |
Zwróć
PositionedImage
– nowy obraz umieszczony na stronie.
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
appendHorizontalRule()
Tworzy i dołącza nowy element HorizontalRule
.
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
appendInlineImage(image)
Tworzy i dołącza nowy obiekt InlineImage
z określonego bloba obrazu.
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
appendInlineImage(image)
Dołącza daną właściwość 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
appendPageBreak()
Tworzy i dołącza nowy element PageBreak
.
Uwaga: język PageBreaks
nie może być zawarty w TableCells
.
Jeśli bieżący element jest zawarty w komórce tabeli, zwracany jest wyjątek.
Zwróć
PageBreak
– nowy element podziału 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
.
Uwaga: język PageBreaks
nie może być zawarty w TableCells
.
Jeśli bieżący element jest zawarty w komórce tabeli, zwracany jest wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
pageBreak | PageBreak | podział strony do dołączenia |
Zwróć
PageBreak
– dołączony element podziału 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
appendText(text)
Tworzy i dołącza nowy element Text
z określoną zawartością.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | zawartość tekstowa |
Zwróć
Text
– nowy element tekstowy
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
appendText(text)
Dołącza element Text
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | Text | element tekstowy, który chcesz dołączyć |
Zwróć
Text
– dołączony element tekstowy
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óć
Paragraph
– 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
getAlignment()
Pobiera HorizontalAlignment
.
Zwróć
HorizontalAlignment
– wyrównanie
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
getHeading()
Pobiera ParagraphHeading
.
Zwróć
ParagraphHeading
– nagłówek
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
getIndentEnd()
Pobiera wcięcie na końcu.
Zwróć
Number
– wcięcie na końcu (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
getIndentFirstLine()
Pobiera punkty wcięcia pierwszego wiersza.
Zwróć
Number
– pierwsze wcięcie wiersza 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
getIndentStart()
Pobiera wcięcie rozpoczęcia.
Zwróć
Number
– wcięcie rozpoczęcia
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
getLineSpacing()
Pobiera odstępy między wierszami w punktach.
Zwróć
Number
– odstępy między wierszami 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
getLinkUrl()
Pobiera adres URL linku.
Zwróć
String
– URL linku lub wartość null (jeśli element zawiera wiele wartości tego atrybutu)
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
getNextSibling()
Pobiera element potomny.
Kolejne rodzeństwo ma tego samego elementu nadrzędnego i jednocześnie występuje w bieżącym elemencie.
Zwróć
Element
– następny element potomny
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
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
getPositionedImage(id)
Pobiera PositionedImage
według identyfikatora obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | identyfikator obrazu |
Zwróć
PositionedImage
– rozmieszczony 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
getPositionedImages()
Pobiera wszystkie obiekty PositionedImage
zakotwiczone do akapitu.
Zwróć
PositionedImage[]
– lista pozycjonowanych obrazów
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
getPreviousSibling()
Pobiera element potomny.
Poprzednie rodzeństwo ma ten sam element nadrzędny i wyprzedza bieżący element.
Zwróć
Element
– poprzedni element równorzę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
getSpacingAfter()
Pobiera odstępy po elemencie w punktach.
Zwróć
Number
– odstęp po elemencie, 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
getSpacingBefore()
Pobiera odstępy między elementami w punktach.
Zwróć
Number
– odstęp przed elementem, 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
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 HorizontalRule
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
Zwróć
HorizontalRule
– nowy element reguły w poziomie
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
insertInlineImage(childIndex, image)
Tworzy i wstawia nowy obiekt 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 element obrazu
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
insertInlineImage(childIndex, image)
Wstawia podaną wartość InlineImage
w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
image | InlineImage | dane obrazu |
Zwróć
InlineImage
– wstawiony element obrazu
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.
Uwaga: język PageBreaks
nie może być zawarty w TableCells
.
Jeśli bieżący element jest zawarty w komórce tabeli, zwracany jest wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
Zwróć
PageBreak
– nowy element podziału 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.
Uwaga: język PageBreaks
nie może być zawarty w TableCells
.
Jeśli bieżący element jest zawarty w komórce tabeli, zwracany jest wyjątek.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
pageBreak | PageBreak | przerwa p[age] |
Zwróć
PageBreak
– wstawiony element podziału 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
insertText(childIndex, text)
Tworzy i wstawia nowy element tekstowy w określonym indeksie.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
text | String | zawartość tekstowa |
Zwróć
Text
– nowy element tekstowy
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
insertText(childIndex, text)
Wstawia określony element Text
w określonym indeksie z określoną treścią tekstową.
Parametry
Nazwa | Typ | Opis |
---|---|---|
childIndex | Integer | indeks, do którego należy wstawić element |
text | Text | element tekstowy do wstawienia |
Zwróć
Text
– wstawiony element tekstowy
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
isAtDocumentEnd()
Określa, czy element znajduje się na końcu elementu Document
.
Zwróć
Boolean
– określa, czy element jest na końcu dokumentu –
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
isLeftToRight()
Pobiera ustawienie od lewej do prawej.
Zwróć
Boolean
– ustawienie od lewej do prawej.
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
merge()
Scala element z poprzednim elementem tego samego typu.
Łączyć można tylko te same elementy ElementType
. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do elementu nadrzędnego.
Bieżący element zostanie usunięty z dokumentu.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Zwróć
Paragraph
– scalony 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
removeChild(child)
Usuwa określony element podrzędny.
Parametry
Nazwa | Typ | Opis |
---|---|---|
child | Element | element podrzędny do usunięcia |
Zwróć
Paragraph
– 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
removeFromParent()
Usuwa element z elementu nadrzędnego.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Zwróć
Paragraph
– usunięty 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
removePositionedImage(id)
Usuwa PositionedImage
na podstawie identyfikatora obrazu.
Parametry
Nazwa | Typ | Opis |
---|---|---|
id | String | identyfikator obrazu |
Zwróć
Boolean
– informacja o tym, czy określony obraz został usunięty;
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
setAlignment(alignment)
Ustawia HorizontalAlignment
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
alignment | HorizontalAlignment | wyrównanie w poziomie |
Zwróć
Paragraph
– 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óć
Paragraph
– 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
setHeading(heading)
Ustawia ParagraphHeading
.
Parametry
Nazwa | Typ | Opis |
---|---|---|
heading | ParagraphHeading | nagłówka |
Zwróć
Paragraph
– 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
setIndentEnd(indentEnd)
Ustawia wcięcie na końcu (w punktach).
Parametry
Nazwa | Typ | Opis |
---|---|---|
indentEnd | Number | wcięcie na końcu (w punktach) |
Zwróć
Paragraph
– 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
setIndentFirstLine(indentFirstLine)
Ustawia wcięcie pierwszego wiersza w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
indentFirstLine | Number | wcięcie pierwszego wiersza w punktach |
Zwróć
Paragraph
– 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
setIndentStart(indentStart)
Ustawia wcięcie początkowe (w punktach).
Parametry
Nazwa | Typ | Opis |
---|---|---|
indentStart | Number | wcięcie początkowe (w punktach) |
Zwróć
Paragraph
– 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
setLeftToRight(leftToRight)
Ustawia ustawienie od lewej do prawej.
Parametry
Nazwa | Typ | Opis |
---|---|---|
leftToRight | Boolean | ustawienie tekstu od lewej do prawej |
Zwróć
Paragraph
– 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
setLineSpacing(multiplier)
Ustawia odstępy między wierszami jako liczbę wskazującą liczbę wierszy, które mają być użyte do odstępów.
Parametry
Nazwa | Typ | Opis |
---|---|---|
multiplier | Number | liczba wierszy |
Zwróć
Paragraph
– 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
setLinkUrl(url)
Ustawia URL linku.
Parametry
Nazwa | Typ | Opis |
---|---|---|
url | String | adres URL linku |
Zwróć
Paragraph
– 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
setSpacingAfter(spacingAfter)
Ustawia odstępy między elementami w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
spacingAfter | Number | odstępy po elemencie w punktach |
Zwróć
Paragraph
– 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
setSpacingBefore(spacingBefore)
Ustawia odstępy między elementami w punktach.
Parametry
Nazwa | Typ | Opis |
---|---|---|
spacingBefore | Number | odstępy przed elementem w punktach |
Zwróć
Paragraph
– 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 treść akapitu jako tekst.
Uwaga: istniejąca zawartość zostanie wyczyszczona.
Parametry
Nazwa | Typ | Opis |
---|---|---|
text | String | nowa zawartość tekstowa |
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óć
Paragraph
– 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