Class ListItem

ListItem

Element reprezentujący element listy. ListItem to Paragraph powiązany z identyfikatorem listy. Element ListItem może zawierać elementy Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak i Text. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.

ListItems nie może zawierać znaków nowego wiersza. Znaki nowego wiersza („\n”) są konwertowane na znaki podziału wiersza („\r”).

ListItems o tym samym identyfikatorze listy należą do tej samej listy i są odpowiednio numerowane. Elementy ListItems na danej liście nie muszą być sąsiadujące na karcie ani nawet mieć tego samego elementu nadrzędnego. 2 elementy należące do tej samej listy mogą znajdować się w dowolnym miejscu na karcie, zachowując kolejną numerację, jak pokazano w tym przykładzie:

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy PositionedImage z określonego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podany element InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podany element PageBreak.
appendText(text)TextTworzy i dołącza nowy element Text z określoną zawartością.
appendText(text)TextDołącza podany element Text.
clear()ListItemUsuwa zawartość elementu.
copy()ListItemZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAlignment()HorizontalAlignment|nullPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getGlyphType()GlyphType|nullPobiera GlyphType elementu listy.
getHeading()ParagraphHeading|nullPobiera ParagraphHeading.
getIndentEnd()Number|nullPobiera wcięcie końcowe w punktach.
getIndentFirstLine()Number|nullPobiera wcięcie pierwszego wiersza w punktach.
getIndentStart()Number|nullPobiera wcięcie początkowe.
getLineSpacing()Number|nullPobiera odstęp między wierszami w punktach.
getLinkurl()String|nullPobiera adres URL linku.
getListId()String|nullPobiera identyfikator listy.
getNestingLevel()IntegerPobiera poziom zagnieżdżenia elementu listy.
getNextSibling()Element|nullPobiera następny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera PositionedImage według identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie.
getPreviousSibling()Element|nullPobiera poprzedni element równorzędny elementu.
getSpacingAfter()Number|nullPobiera odstęp po elemencie w punktach.
getSpacingBefore()Number|nullPobiera odstęp przed elementem w punktach.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia znak HorizontalRule w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak w określonym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia podany element Text w określonym indeksie z podaną zawartością tekstu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isLeftToRight()Boolean|nullPobiera ustawienie od lewej do prawej.
merge()ListItem|nullŁączy element z poprzednim elementem tego samego typu.
removeChild(child)ListItemUsuwa określony element podrzędny.
removeFromParent()ListItem|nullUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa PositionedImage na podstawie identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAlignment(alignment)ListItemUstawia wartość HorizontalAlignment.
setAttributes(attributes)ListItemUstawia atrybuty elementu.
setGlyphType(glyphType)ListItemUstawia GlyphType elementu listy.
setHeading(heading)ListItemUstawia wartość ParagraphHeading.
setIndentEnd(indentEnd)ListItemUstawia wcięcie końcowe w punktach.
setIndentFirstLine(indentFirstLine)ListItemUstawia wcięcie pierwszego wiersza w punktach.
setIndentStart(indentStart)ListItemUstawia wcięcie początkowe w punktach.
setLeftToRight(leftToRight)ListItemUstawia kierunek od lewej do prawej.
setLineSpacing(multiplier)ListItemUstawia odstęp między wierszami jako liczbę wierszy, które mają być użyte do określenia odstępu.
setLinkurl(/sitelet?url=https%3A%2F%2Fdevelopers.google.com%2Fapps-script%2Freference%2Fdocument%2Furl)ListItemUstawia adres URL linku.
setListId(listItem)ListItemUstawia identyfikator listy.
setNestingLevel(nestingLevel)ListItemUstawia poziom zagnieżdżenia elementu listy.
setSpacingAfter(spacingAfter)ListItemUstawia odstęp po elemencie w punktach.
setSpacingBefore(spacingBefore)ListItemUstawia odstęp przed elementem w punktach.
setText(text)voidUstawia zawartość elementu listy jako tekst.
setTextAlignment(textAlignment)ListItemUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

addPositionedImage(image)

Tworzy i wstawia nowy PositionedImage z określonego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu,

Powrót

PositionedImage – nowy obraz z określoną pozycją.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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.

Powrót

HorizontalRule – nowa linia pozioma;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 element InlineImage z określonego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu,

Powrót

InlineImage – dołączony obraz;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendInlineImage(image)

Dołącza podany element InlineImage.

Parametry

NazwaTypOpis
imageInlineImagedane obrazu,

Powrót

InlineImage – dołączony obraz;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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: PageBreaks może nie zawierać się w TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Powrót

PageBreak – nowy element podziału strony.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendPageBreak(pageBreak)

Dołącza podany element PageBreak.

Uwaga: PageBreaks może nie zawierać się w TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Parametry

NazwaTypOpis
pageBreakPageBreakpodział strony do dołączenia,

Powrót

PageBreak – dołączony element podziału strony;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
textStringzawartość tekstową,

Powrót

Text – nowy element tekstowy.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendText(text)

Dołącza podany element Text.

Parametry

NazwaTypOpis
textTextelement tekstowy do dodania

Powrót

Text – dołączony element tekstowy.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

clear()

Usuwa zawartość elementu.

Powrót

ListItem – bieżący element.


copy()

Zwraca odłączoną, głęboką kopię bieżącego elementu.

Kopiowane są też wszystkie elementy podrzędne znajdujące się w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

ListItem – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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.

Użyj editAsText, aby manipulować zawartością elementów jako tekstem sformatowanym. Tryb editAsText ignoruje elementy inne niż tekstowe (takie jak InlineImage i HorizontalRule).

Elementy podrzędne w pełni zawarte w zakresie usuniętego tekstu są usuwane z elementu.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Powrót

Text – tekstowa wersja bieżącego elementu.


findElement(elementType)

Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.

Parametry

NazwaTypOpis
elementTypeElementTypeTyp elementu do wyszukania.

Powrót

RangeElement|null – wynik wyszukiwania wskazujący pozycję elementu wyszukiwania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parametry

NazwaTypOpis
elementTypeElementTypeTyp elementu do wyszukania.
fromRangeElementWynik wyszukiwania, z którego chcesz wyszukiwać.

Powrót

RangeElement|null – wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.

Niektóre funkcje wyrażeń regularnych JavaScriptu nie są w pełni obsługiwane, np. grupy przechwytywania i modyfikatory trybu.

Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania,

Powrót

RangeElement|null – wynik wyszukiwania wskazujący pozycję tekstu wyszukiwania lub wartość null, jeśli nie ma dopasowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.

Niektóre funkcje wyrażeń regularnych JavaScriptu nie są w pełni obsługiwane, np. grupy przechwytywania i modyfikatory trybu.

Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania,
fromRangeElementwynik wyszukiwania, z którego chcesz wyszukiwać;

Powrót

RangeElement|null – wynik wyszukiwania wskazujący następną pozycję tekstu wyszukiwania lub wartość null, jeśli nie ma dopasowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAlignment()

Pobiera HorizontalAlignment.

Powrót

HorizontalAlignment|null – wyrównanie

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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ść dla każdego prawidłowego atrybutu elementu, przy czym nazwa każdej właściwości odpowiada elementowi w wyliczeniu DocumentApp.Attribute.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Powrót

Object – atrybuty elementu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 o określonym indeksie.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parametry

NazwaTypOpis
childIndexIntegerIndeks elementu podrzędnego do pobrania.

Powrót

Element – element podrzędny w określonym indeksie.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getChildIndex(child)

Pobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.

Parametry

NazwaTypOpis
childElementElement 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 użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getGlyphType()

Pobiera GlyphType elementu listy.

Powrót

GlyphType|null – typ glifu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getHeading()

Pobiera ParagraphHeading.

Powrót

ParagraphHeading|null – nagłówek;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getIndentEnd()

Pobiera wcięcie końcowe w punktach.

Powrót

Number|null – wcięcie na końcu w punktach;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getIndentFirstLine()

Pobiera wcięcie pierwszego wiersza w punktach.

Powrót

Number|null – wcięcie pierwszego wiersza w punktach;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getIndentStart()

Pobiera wcięcie początkowe.

Powrót

Number|null – wcięcie na początku;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getLineSpacing()

Pobiera odstęp między wierszami w punktach.

Powrót

Number|null – odstępy między wierszami w punktach;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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.

Powrót

String|null – adres URL linku lub wartość null, jeśli element zawiera wiele wartości tego atrybutu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getListId()

Pobiera identyfikator listy.

Powrót

String|null – identyfikator listy;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNestingLevel()

Pobiera poziom zagnieżdżenia elementu listy.

Domyślnie elementy listy mają poziom zagnieżdżenia 0. Poziom zagnieżdżenia określa glif używany przez element listy.

Powrót

Integer – poziom zagnieżdżenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNextSibling()

Pobiera następny element równorzędny elementu.

Następny element równorzędny ma tego samego elementu nadrzędnego i występuje po bieżącym elemencie.

Powrót

Element|null – następny element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNumChildren()

Pobiera liczbę dzieci.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Powrót

Integer – liczba dzieci.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement|null – element nadrzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
idStringidentyfikator obrazu,

Powrót

PositionedImage – obraz z określoną pozycją.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 w akapicie.

Powrót

PositionedImage[] – lista obrazów z określonymi pozycjami.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getPreviousSibling()

Pobiera poprzedni element równorzędny elementu.

Poprzedni element równorzędny ma tego samego rodzica i występuje przed bieżącym elementem.

Powrót

Element|null – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSpacingAfter()

Pobiera odstęp po elemencie w punktach.

Powrót

Number|null – odstęp po elemencie w punktach;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSpacingBefore()

Pobiera odstęp przed elementem w punktach.

Powrót

Number|null – odstęp przed elementem w punktach;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

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 użyciem co najmniej jednego 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|null – typ wyrównania tekstu lub null, jeśli tekst zawiera wiele typów wyrównania lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getType()

Pobiera ElementType elementu.

Użyj właściwości getType(), aby określić dokładny typ danego elementu.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Powrót

ElementType – typ elementu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 znak HorizontalRule w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element

Powrót

HorizontalRule – nowy element linii poziomej

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 InlineImage z określonego obiektu blob obrazu w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element
imageBlobSourcedane obrazu,

Powrót

InlineImage – wstawiony element obrazu w tekście

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertInlineImage(childIndex, image)

Wstawia podany element InlineImage w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element
imageInlineImagedane obrazu,

Powrót

InlineImage – wstawiony element obrazu w tekście

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 element PageBreak w określonym indeksie.

Uwaga: PageBreaks może nie zawierać się w TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element

Powrót

PageBreak – nowy element podziału strony.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertPageBreak(childIndex, pageBreak)

Wstawia podany element PageBreak w określonym indeksie.

Uwaga: PageBreaks może nie zawierać się w TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element
pageBreakPageBreakpodział strony do wstawienia;

Powrót

PageBreak – wstawiony element podziału strony;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element
textStringzawartość tekstową,

Powrót

Text – nowy element tekstowy.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertText(childIndex, text)

Wstawia podany element Text w określonym indeksie z podaną zawartością tekstu.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym ma zostać wstawiony element
textTextelement tekstowy do wstawienia;

Powrót

Text – wstawiony element tekstowy

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 Document.

Powrót

Boolean – czy element znajduje się na końcu karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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.

Powrót

Boolean|null – ustawienie od lewej do prawej;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

merge()

Łączy element z poprzednim elementem tego samego typu.

Można scalać tylko elementy tego samego ElementType. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do poprzedniego elementu równorzędnego.

Bieżący element zostanie usunięty z dokumentu.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Powrót

ListItem|null – scalony element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
childElementelement podrzędny do usunięcia.

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Powrót

ListItem|null – usunięty element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
idString

Powrót

Boolean – czy określony obraz został usunięty;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie jako obiekt wyrażenia regularnego JavaScriptu. Dlatego musisz zmienić znaczenie wszystkich ukośników odwrotnych we wzorcu.

Ta metoda korzysta z biblioteki wyrażeń regularnych RE2 od Google, co ogranicza obsługiwaną składnię.

Podany wzorzec wyrażenia regularnego jest niezależnie dopasowywany do każdego bloku tekstu zawartego w bieżącym elemencie.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Parametry

NazwaTypOpis
searchPatternStringwzór wyrażenia regularnego do wyszukania,
replacementStringtekst, który ma zastąpić oryginalny tekst;

Powrót

Element – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setAlignment(alignment)

Ustawia wartość HorizontalAlignment.

Parametry

NazwaTypOpis
alignmentHorizontalAlignmentwyrównanie w poziomie,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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.

Parametr specifiedAttributes musi być obiektem, w którym każda nazwa właściwości jest elementem wyliczenia DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowania.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setGlyphType(glyphType)

Ustawia GlyphType elementu listy.

Parametry

NazwaTypOpis
glyphTypeGlyphTypetyp glifu,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setHeading(heading)

Ustawia wartość ParagraphHeading.

Parametry

NazwaTypOpis
headingParagraphHeadingnagłówek,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 końcowe w punktach.

Parametry

NazwaTypOpis
indentEndNumberwcięcie na końcu w punktach,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
indentFirstLineNumberwcięcie pierwszego wiersza w punktach,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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

NazwaTypOpis
indentStartNumberwcięcie na początku w punktach,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLeftToRight(leftToRight)

Ustawia kierunek od lewej do prawej.

Parametry

NazwaTypOpis
leftToRightBooleanustawienie od lewej do prawej,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLineSpacing(multiplier)

Ustawia odstęp między wierszami jako liczbę wierszy, które mają być użyte do określenia odstępu.

Parametry

NazwaTypOpis
multiplierNumberliczba wierszy,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setLinkurl(/sitelet?url=https%3A%2F%2Fdevelopers.google.com%2Fapps-script%2Freference%2Fdocument%2Furl)

Ustawia adres URL linku.

Parametry

NazwaTypOpis
urlStringadres URL linku,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setListId(listItem)

Ustawia identyfikator listy.

Identyfikator listy ma taką samą wartość w przypadku określonego parametru ListItem. Oba znaki ListItems będą traktowane jako elementy tej samej listy.

Parametry

NazwaTypOpis
listItemListItemelement listy, którego identyfikator listy ma być użyty;

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setNestingLevel(nestingLevel)

Ustawia poziom zagnieżdżenia elementu listy.

Domyślnie elementy listy mają poziom zagnieżdżenia 0. Poziom zagnieżdżenia określa glif używany przez element listy.

Parametry

NazwaTypOpis
nestingLevelIntegerpoziom zagnieżdżenia,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSpacingAfter(spacingAfter)

Ustawia odstęp po elemencie w punktach.

Parametry

NazwaTypOpis
spacingAfterNumberodstęp po elemencie w punktach,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setSpacingBefore(spacingBefore)

Ustawia odstęp przed elementem w punktach.

Parametry

NazwaTypOpis
spacingBeforeNumberodstęp przed elementem w punktach,

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setText(text)

Ustawia zawartość elementu listy jako tekst.

Uwaga: dotychczasowa zawartość zostanie wyczyszczona.

Parametry

NazwaTypOpis
textStringnową zawartość tekstową,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametry

NazwaTypOpis
textAlignmentTextAlignmenttyp wyrównania tekstu do zastosowania;

Powrót

ListItem – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents