Class ListItem

ListItem

Element reprezentujący element listy. Element ListItem to Paragraph, który jest powiązany o identyfikatorze listy. ListItem może zawierać Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak i Text . Więcej informacji na temat struktury dokumentów znajdziesz w przewodniku po rozszerzaniu plików Dokumentów Google.

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

ListItems o tym samym identyfikatorze należą do tej samej listy i mają odpowiednie numery. ListItems dla danej listy nie muszą przylegać do karty ani nawet mieć ten sam element nadrzędny. W dowolnym miejscu karty mogą znajdować się 2 elementy należące do tej samej listy zachowywanie ciągłości numeracji, jak pokazano w poniższym przykładzie:

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

// Append a new list item to the body.
var 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.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy obiekt PositionedImage z określonego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podaną wartość InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podaną wartość PageBreak.
appendText(text)TextTworzy i dodaje nowy element Text z podaną 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAlignment()HorizontalAlignmentPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getGlyphType()GlyphTypePobiera GlyphType elementu listy.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera wcięcie końcowe (w punktach).
getIndentFirstLine()NumberPobiera w punktach pierwsze wcięcie pierwszego wiersza.
getIndentStart()NumberPobiera wcięcie początkowe.
getLineSpacing()NumberPobiera odstępy między wierszami w punktach.
getLinkUrl()StringPobiera adres URL linku.
getListId()StringPobiera identyfikator listy.
getNestingLevel()IntegerPobiera poziom zagnieżdżenia elementu listy.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera wartość PositionedImage na podstawie identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getSpacingAfter()NumberPobiera odstępy po elemencie w punktach.
getSpacingBefore()NumberPobiera odstępy przed elementem (w punktach).
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia HorizontalRule w podanym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertInlineImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy PageBreak w podanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podaną wartość PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia dany element Text w określonym indeksie z określonym tekstem treści.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
isLeftToRight()BooleanPobiera ustawienie od lewej do prawej.
merge()ListItemScala element z poprzednim elementem potomnym tego samego typu.
removeChild(child)ListItemUsuwa określony element podrzędny.
removeFromParent()ListItemUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa wartość PositionedImage według identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAlignment(alignment)ListItemUstawia HorizontalAlignment.
setAttributes(attributes)ListItemUstawia atrybuty elementu.
setGlyphType(glyphType)ListItemUstawia GlyphType elementu listy.
setHeading(heading)ListItemUstawia 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)ListItemOkreśla ustawienie tekstu od lewej do prawej.
setLineSpacing(multiplier)ListItemUstawia odstępy między wierszami jako liczbę określającą ich liczbę.
setLinkUrl(url)ListItemUstawia adres URL linku.
setListId(listItem)ListItemUstawia identyfikator listy.
setNestingLevel(nestingLevel)ListItemOkreśla poziom zagnieżdżenia elementu listy.
setSpacingAfter(spacingAfter)ListItemUstawia odstępy po elemencie w punktach.
setSpacingBefore(spacingBefore)ListItemUstawia odstępy przed elementem w punktach.
setText(text)voidUstawia zawartość elementu listy jako tekst.
setTextAlignment(textAlignment)ListItemOkreśla wyrównanie tekstu.

Szczegółowa dokumentacja

addPositionedImage(image)

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

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu

Powrót

PositionedImage – nowy pozycjonowany obraz

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

appendHorizontalRule()

Tworzy i dołącza nowy element HorizontalRule.

Powrót

HorizontalRule – nowa linia pozioma

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

appendInlineImage(image)

Tworzy i dołącza nowy obiekt 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 co najmniej jednym z tych zakresów:

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

appendInlineImage(image)

Dołącza podaną wartość InlineImage.

Parametry

NazwaTypOpis
imageInlineImagedane obrazu

Powrót

InlineImage – dołączony obraz,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

appendPageBreak()

Tworzy i dołącza nowy element PageBreak.

Uwaga: pole PageBreaks nie może być zawarte w elemencie 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 co najmniej jednym z tych zakresów:

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

appendPageBreak(pageBreak)

Dołącza podaną wartość PageBreak.

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

Parametry

NazwaTypOpis
pageBreakPageBreakpodział strony, który chcesz dołączyć

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

appendText(text)

Tworzy i dodaje nowy element Text z podaną zawartością.

Parametry

NazwaTypOpis
textStringzawartość tekstu

Powrót

Text – nowy element tekstowy;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

appendText(text)

Dołącza podany element Text.

Parametry

NazwaTypOpis
textTextelement tekstowy do dołączenia

Powrót

Text – dołączony element tekstowy;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

clear()

Usuwa zawartość elementu.

Powrót

ListItem – bieżący element.


copy()

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

Skopiowane są też wszystkie elementy podrzędne zawarte w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

ListItem – nowa wersja,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

editAsText()

Pobiera wersję Text bieżącego elementu do edycji.

editAsText umożliwia manipulowanie zawartością elementów jako tekstu sformatowanego. Tryb editAsText ignoruje elementy inne niż tekstowe (np. InlineImage i HorizontalRule).

Elementy podrzędne, które w pełni znajdują się w usuniętym zakresie tekstowym, są usuwane z elementu.

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

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

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

Powrót

Text – wersja tekstowa bieżącego elementu,


findElement(elementType)

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

Parametry

NazwaTypOpis
elementTypeElementTypeTyp szukanego elementu.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

findElement(elementType, from)

Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.

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

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parametry

NazwaTypOpis
elementTypeElementTypeTyp szukanego elementu.
fromRangeElementWynik wyszukiwania.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

findText(searchPattern)

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.

Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, na przykład grup przechwytywania i modyfikatorów trybów.

Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzorzec do wyszukania

Powrót

RangeElement – wynik wyszukiwania wskazujący pozycję szukanego tekstu lub wartość null, jeśli nie ma wartości; gra

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

findText(searchPattern, from)

Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.

Niektóre funkcje wyrażeń regularnych JavaScript nie są w pełni obsługiwane, na przykład grup przechwytywania i modyfikatorów trybów.

Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.

Parametry

NazwaTypOpis
searchPatternStringwzorzec do wyszukania
fromRangeElementwynik wyszukiwania

Powrót

RangeElement – wynik wyszukiwania wskazujący następną pozycję wyszukiwanego tekstu lub wartość null, jeśli nie ma podanej wartości; gra

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getAlignment()

Pobiera HorizontalAlignment.

Powrót

HorizontalAlignment – wyrównanie

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getAttributes()

Pobiera atrybuty elementu.

Wynikiem jest obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute.

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

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Powrót

Object – atrybuty elementu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getChild(childIndex)

Pobiera element podrzędny z określonego indeksu podrzędnego.

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

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

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

Parametry

NazwaTypOpis
childIndexIntegerIndeks elementu podrzędnego do pobrania.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getChildIndex(child)

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

Parametry

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 co najmniej jednym 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 – typ glifu,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getHeading()

Pobiera ParagraphHeading.

Powrót

ParagraphHeading – nagłówek,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getIndentEnd()

Pobiera wcięcie końcowe (w punktach).

Powrót

Number – wcięcie końcowe w punktach.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getIndentFirstLine()

Pobiera w punktach pierwsze wcięcie pierwszego wiersza.

Powrót

Number – wcięcie pierwszego wiersza w punktach;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getIndentStart()

Pobiera wcięcie początkowe.

Powrót

Number – wcięcie początkowe.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getLineSpacing()

Pobiera odstępy między wierszami w punktach.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getLinkUrl()

Pobiera adres URL linku.

Powrót

String – 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 co najmniej jednym z tych zakresów:

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

getListId()

Pobiera identyfikator listy.

Powrót

String – identyfikator listy,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNestingLevel()

Pobiera poziom zagnieżdżenia elementu listy.

Domyślnie poziom zagnieżdżenia elementów listy wynosi 0. Poziom zagnieżdżenia określa glif używane przez element listy.

Powrót

Integer – poziom zagnieżdżenia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNextSibling()

Pobiera kolejny element równorzędny elementu.

Następne elementy równorzędne mają tego samego elementu nadrzędnego i następują po bieżącym elemencie.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getNumChildren()

Pobiera liczbę dzieci.

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

// Log the number of elements in the tab.
Logger.log("There are " + body.getNumChildren() +
    " elements in the tab's body.");

Powrót

Integer – liczba dzieci.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getParent()

Pobiera element nadrzędny elementu.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getPositionedImage(id)

Pobiera wartość PositionedImage na podstawie identyfikatora obrazu.

Parametry

NazwaTypOpis
idStringidentyfikator obrazu

Powrót

PositionedImage – pozycjonowany obraz

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getPositionedImages()

Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu.

Powrót

PositionedImage[] – lista umieszczonych obrazów

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getPreviousSibling()

Pobiera poprzedni element równorzędny elementu.

Poprzednie elementy nadrzędne mają tego samego elementu nadrzędnego i wyprzedzają bieżący element.

Powrót

Element – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSpacingAfter()

Pobiera odstępy po elemencie w punktach.

Powrót

Number – odstępy po elemencie w punktach.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSpacingBefore()

Pobiera odstępy przed elementem (w punktach).

Powrót

Number – odstępy przed elementem (w punktach).

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getText()

Pobiera zawartość elementu jako ciąg tekstowy.

Powrót

String – zawartość elementu w postaci ciągu tekstowego;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getTextAlignment()

Pobiera wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

Powrót

TextAlignment – typ wyrównania tekstu lub null, jeśli tekst zawiera różne typy tekstu. lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getType()

Pobiera wartość ElementType elementu.

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

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

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

var firstChild = body.getChild(0);

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

Powrót

ElementType – typ elementu.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertHorizontalRule(childIndex)

Tworzy i wstawia HorizontalRule w podanym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element

Powrót

HorizontalRule – nowy element linii poziomej

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertInlineImage(childIndex, image)

Tworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
imageBlobSourcedane obrazu

Powrót

InlineImage – wstawiony element obrazu w tekście;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertInlineImage(childIndex, image)

Wstawia podaną wartość InlineImage w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
imageInlineImagedane obrazu

Powrót

InlineImage – wstawiony element obrazu w tekście;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertPageBreak(childIndex)

Tworzy i wstawia nowy PageBreak w podanym indeksie.

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

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element

Powrót

PageBreak – nowy element podziału strony

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertPageBreak(childIndex, pageBreak)

Wstawia podaną wartość PageBreak w określonym indeksie.

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

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
pageBreakPageBreakthe p[age break to insert the p[age break to insert

Powrót

PageBreak – wstawiony element podziału strony;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertText(childIndex, text)

Tworzy i wstawia nowy element tekstowy w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
textStringzawartość tekstu

Powrót

Text – nowy element tekstowy;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertText(childIndex, text)

Wstawia dany element Text w określonym indeksie z określonym tekstem treści.

Parametry

NazwaTypOpis
childIndexIntegerindeks, w którym należy wstawić element
textTextelement tekstowy do wstawienia

Powrót

Text – wstawiony element tekstowy;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

isAtDocumentEnd()

Określa, czy element jest na końcu Document.

Powrót

Boolean – określa, czy element jest na końcu karty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

isLeftToRight()

Pobiera ustawienie od lewej do prawej.

Powrót

Boolean – ustawienie od lewej do prawej

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

merge()

Scala element z poprzednim elementem potomnym tego samego typu.

Można scalać tylko elementy o tej samej wartości ElementType. Wszystkie elementy podrzędne zawarte w bieżący element jest przenoszony do poprzedniego elementu równorzędnego.

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

Powrót

ListItem – scalony element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

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 co najmniej jednym 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

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

Powrót

ListItem – usunięty element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

removePositionedImage(id)

Usuwa wartość PositionedImage według identyfikatora obrazu.

Parametry

NazwaTypOpis
idString

Powrót

Boolean – określa, czy określony obraz został usunięty.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

replaceText(searchPattern, replacement)

Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu konieczne jest ominięcie ukośnika wstecznego we wzorcu.

Ta metoda korzysta ze standardowego algorytmu Google RE2 biblioteki wyrażeń, która ogranicza obsługiwaną składnię.

Podany wzorzec wyrażeń regularnych jest niezależnie dopasowywany do każdego bloku tekstu zawarte w bieżącym elemencie.

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

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

Parametry

NazwaTypOpis
searchPatternStringwzorzec wyrażenia regularnego do wyszukania
replacementStringtekst, który ma zostać użyty jako zamiennik

Powrót

Element – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setAlignment(alignment)

Ustawia HorizontalAlignment.

Parametry

NazwaTypOpis
alignmentHorizontalAlignmentwyrównanie w poziomie

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setAttributes(attributes)

Ustawia atrybuty elementu.

Określony parametr atrybutów musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczenie DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowano.

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

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

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

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

Parametry

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

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 co najmniej jednym z tych zakresów:

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

setHeading(heading)

Ustawia ParagraphHeading.

Parametry

NazwaTypOpis
headingParagraphHeadingnagłówek

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setIndentEnd(indentEnd)

Ustawia wcięcie końcowe w punktach.

Parametry

NazwaTypOpis
indentEndNumberwcięcie końcowe w punktach

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

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 co najmniej jednym 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 początkowe w punktach

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setLeftToRight(leftToRight)

Określa ustawienie tekstu od lewej do prawej.

Parametry

NazwaTypOpis
leftToRightBooleanustawienie tekstu od lewej do prawej

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setLineSpacing(multiplier)

Ustawia odstępy między wierszami jako liczbę określającą ich liczbę.

Parametry

NazwaTypOpis
multiplierNumberliczba wierszy

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setLinkUrl(url)

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 co najmniej jednym 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 elementu ListItem. 2 elementy ListItems będą traktowane jako członkowie tej samej listy.

Parametry

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

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setNestingLevel(nestingLevel)

Określa poziom zagnieżdżenia elementu listy.

Domyślnie poziom zagnieżdżenia elementów listy wynosi 0. Poziom zagnieżdżenia określa glif używane 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 co najmniej jednym z tych zakresów:

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

setSpacingAfter(spacingAfter)

Ustawia odstępy po elemencie w punktach.

Parametry

NazwaTypOpis
spacingAfterNumberodstępy po elemencie w punktach

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setSpacingBefore(spacingBefore)

Ustawia odstępy przed elementem w punktach.

Parametry

NazwaTypOpis
spacingBeforeNumberodstępy przed elementem w punktach

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setText(text)

Ustawia zawartość elementu listy jako tekst.

Uwaga: istniejąca zawartość zostanie wyczyszczona.

Parametry

NazwaTypOpis
textStringnowa zawartość tekstu,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

setTextAlignment(textAlignment)

Określa wyrównanie tekstu. Dostępne typy wyrównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametry

NazwaTypOpis
textAlignmentTextAlignmenttyp wyrównania tekstu, który ma zostać zastosowany

Powrót

ListItem – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z co najmniej jednym z tych zakresów:

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