Class ListItem

ListItem

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

Pole 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. ListItems w danej liście nie musi znajdować się obok siebie w dokumencie ani nawet mieć tego samego elementu nadrzędnego. Dwie elementy należące do tej samej listy mogą znajdować się w dowolnym miejscu w dokumencie z zachowaniem numeracji sekwencyjnej, jak pokazano w tym przykładzie:

var body = DocumentApp.getActiveDocument().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 ze wskazanego 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)InlineImageDodaje podaną wartość InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDodaje podaną wartość PageBreak.
appendText(text)TextTworzy i dołącza nowy element Text o określonej zawartości.
appendText(text)TextDodaje dany element Text.
clear()ListItemCzyści zawartość elementu.
copy()ListItemZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera do edycji wersję Text bieżącego elementu.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu według określonego wzorca tekstowego, zaczynając od danego 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 element GlyphType elementu listy.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera końcowe wcięcie w punktach.
getIndentFirstLine()NumberPobiera wcięcie pierwszego wiersza w punktach.
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 następny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę elementów podrzędnych.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera właściwość PositionedImage na podstawie identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie.
getPreviousSibling()ElementPobiera poprzedni element równorzędny.
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()TextAlignmentWyrównuje tekst.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia HorizontalRule w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob obrazu o określonym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podany InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak w określonym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany 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 podaną zawartością tekstową.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu parametru Document.
isLeftToRight()BooleanPobiera ustawienie od lewej do prawej.
merge()ListItemŁączy element z poprzednim elementem równorzędnym tego samego typu.
removeChild(child)ListItemUsuwa określony element podrzędny.
removeFromParent()ListItemUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa pole PositionedImage według identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym zastępczym ciągiem znaków przy użyciu wyrażeń regularnych.
setAlignment(alignment)ListItemUstawia HorizontalAlignment.
setAttributes(attributes)ListItemUstawia atrybuty elementu.
setGlyphType(glyphType)ListItemUstawia wartość 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)ListItemUstawia ustawienie „od lewej do prawej”.
setLineSpacing(multiplier)ListItemUstawia odstępy między wierszami, które określają liczbę wierszy, jaka ma być zastosowana do odstępów.
setLinkUrl(url)ListItemUstawia adres URL linku.
setListId(listItem)ListItemUstawia identyfikator listy.
setNestingLevel(nestingLevel)ListItemUstawia poziom zagnieżdżenia elementu listy.
setSpacingAfter(spacingAfter)ListItemUstawia odstępy w punktach po elemencie.
setSpacingBefore(spacingBefore)ListItemOkreśla odstępy w punktach przed elementem.
setText(text)voidUstawia zawartość elementu listy jako tekst.
setTextAlignment(textAlignment)ListItemUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

addPositionedImage(image)

Tworzy i wstawia nowy obiekt PositionedImage ze wskazanego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu

Powroty

PositionedImage – nowy obraz,

Upoważnienie

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.

Powroty

HorizontalRule – nowa linia pozioma,

Upoważnienie

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 element InlineImage z określonego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu

Powroty

InlineImage – dołączony obraz,

Upoważnienie

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)

Dodaje podaną wartość InlineImage.

Parametry

NazwaTypOpis
imageInlineImagedane obrazu

Powroty

InlineImage – dołączony obraz,

Upoważnienie

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: dyrektywa PageBreaks nie może być zawarta w elemencie TableCells. Jeśli bieżący element znajduje się w komórce tabeli, zostanie zgłoszony wyjątek.

Powroty

PageBreak – nowy element podziału strony;

Upoważnienie

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)

Dodaje podaną wartość PageBreak.

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

Parametry

NazwaTypOpis
pageBreakPageBreakpodział strony do dołączenia

Powroty

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

Upoważnienie

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 dołącza nowy element Text o określonej zawartości.

Parametry

NazwaTypOpis
textStringzawartość tekstu,

Powroty

Text – nowy element tekstowy,

Upoważnienie

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)

Dodaje dany element Text.

Parametry

NazwaTypOpis
textTextelement tekstowy, który ma zostać dołączony

Powroty

Text – dołączony element tekstowy,

Upoważnienie

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()

Czyści zawartość elementu.

Powroty

ListItem – bieżący element,


copy()

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

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

Powroty

ListItem – nowa kopia.

Upoważnienie

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 do edycji wersję Text bieżącego elementu.

editAsText służy do manipulowania zawartością elementów pod postacią tekstu sformatowanego. Tryb editAsText ignoruje elementy inne niż tekstowe (takie jak InlineImage i HorizontalRule).

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

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);

Powroty

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;

Powroty

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

Upoważnienie

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 podrzędnego określonego typu, zaczynając 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

NazwaTypOpis
elementTypeElementTypetyp szukanego elementu;
fromRangeElementwynik wyszukiwania, który ma być wyszukiwany

Powroty

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

Upoważnienie

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 tekstowego przy użyciu wyrażeń regularnych.

Podzbiór funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwany, np. grupy przechwytywania i modyfikatory trybów.

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

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania

Powroty

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

Upoważnienie

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 według określonego wzorca tekstowego, zaczynając od danego wyniku wyszukiwania.

Podzbiór funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwany, np. grupy przechwytywania i modyfikatory trybów.

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

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania
fromRangeElementwynik wyszukiwania, który ma być wyszukiwany

Powroty

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

Upoważnienie

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.

Powroty

HorizontalAlignment – wyrównanie,

Upoważnienie

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.

W efekcie powstanie obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, w którym każda nazwa właściwości odpowiada elementowi w wyliczeniu 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]);
}

Powroty

Object – atrybuty elementu.

Upoważnienie

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.

// 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

NazwaTypOpis
childIndexIntegerindeks elementu podrzędnego do pobrania

Powroty

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

Upoważnienie

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, z którego ma zostać pobrany indeks;

Powroty

Integer – indeks podrzędny.

Upoważnienie

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 element GlyphType elementu listy.

Powroty

GlyphType – typ glifu.

Upoważnienie

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.

Powroty

ParagraphHeading – nagłówek,

Upoważnienie

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 końcowe wcięcie w punktach.

Powroty

Number – wcięcie na końcu w punktach

Upoważnienie

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 wcięcie pierwszego wiersza w punktach.

Powroty

Number – wcięcie pierwszego wiersza w punktach,

Upoważnienie

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.

Powroty

Number – wcięcie początkowe

Upoważnienie

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.

Powroty

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

Upoważnienie

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.

Powroty

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

Upoważnienie

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.

Powroty

String – identyfikator listy,

Upoważnienie

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 elementy listy mają poziom zagnieżdżenia wynoszący 0. Poziom zagnieżdżenia określa glif używany przez element listy.

Powroty

Integer – poziom zagnieżdżenia.

Upoważnienie

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 następny element równorzędny elementu.

Następne elementy nadrzędne mają ten sam element nadrzędny i następują po bieżącym elemencie.

Powroty

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

Upoważnienie

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ę 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.");

Powroty

Integer – liczba dzieci,

Upoważnienie

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 element bieżący.

Powroty

ContainerElement – element nadrzędny.

Upoważnienie

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 właściwość PositionedImage na podstawie identyfikatora obrazu.

Parametry

NazwaTypOpis
idStringidentyfikator obrazu

Powroty

PositionedImage – obraz umieszczony w pozycji;

Upoważnienie

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 w akapicie.

Powroty

PositionedImage[] – lista rozmieszczonych obrazów.

Upoważnienie

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.

Poprzedni element nadrzędny ma ten sam element nadrzędny i poprzedza bieżący element.

Powroty

Element – poprzedni element równorzędny.

Upoważnienie

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.

Powroty

Number – odstęp po elemencie, w punktach

Upoważnienie

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.

Powroty

Number – odstępy przed elementem, w punktach

Upoważnienie

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.

Powroty

String – zawartość elementu jako ciąg tekstowy;

Upoważnienie

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()

Wyrównuje tekst. Dostępne typy wyrównywania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT i DocumentApp.TextAlignment.SUPERSCRIPT.

Powroty

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

Upoważnienie

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 ElementType elementu.

Użyj właściwości getType(), aby określić dokładny 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.');
}

Powroty

ElementType – typ elementu.

Upoważnienie

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 określonym indeksie.

Parametry

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

Powroty

HorizontalRule – nowy element na linijce poziomej,

Upoważnienie

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 obrazu o określonym indeksie.

Parametry

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

Powroty

InlineImage – element graficzny wstawiony w tekście;

Upoważnienie

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 podany InlineImage w określonym indeksie.

Parametry

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

Powroty

InlineImage – element graficzny wstawiony w tekście;

Upoważnienie

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 element PageBreak w określonym indeksie.

Uwaga: dyrektywa PageBreaks nie może być zawarta 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 ma zostać wstawiony element

Powroty

PageBreak – nowy element podziału strony;

Upoważnienie

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 podany PageBreak w określonym indeksie.

Uwaga: dyrektywa PageBreaks nie może być zawarta 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 ma zostać wstawiony element
pageBreakPageBreakp[przerwa wiekowa do wstawienia

Powroty

PageBreak – wstawiony element podziału strony,

Upoważnienie

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 ma zostać wstawiony element
textStringzawartość tekstu,

Powroty

Text – nowy element tekstowy,

Upoważnienie

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 podaną zawartością tekstową.

Parametry

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

Powroty

Text – wstawiony element tekstowy,

Upoważnienie

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 znajduje się na końcu parametru Document.

Powroty

Boolean – określa, czy element znajduje się na końcu dokumentu.

Upoważnienie

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.

Powroty

Boolean – ustawienie od lewej do prawej.

Upoważnienie

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()

Łączy element z poprzednim elementem równorzędnym tego samego typu.

Można scalać tylko elementy elementu 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.

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();

Powroty

ListItem – scalony element.

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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 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();
}

Powroty

ListItem – usunięty element

Upoważnienie

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 pole PositionedImage według identyfikatora obrazu.

Parametry

NazwaTypOpis
idString

Powroty

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

Upoważnienie

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 zastępczym ciągiem znaków przy użyciu wyrażeń regularnych.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu musisz zmienić znaczenie ukośnika lewego we wzorcu.

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

Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie do każdego bloku tekstowego 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

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

Powroty

Element – bieżący element,

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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 wyliczeniu DocumentApp.Attribute, a każda wartość właściwości jest nową wartością 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

NazwaTypOpis
attributesObjectAtrybuty elementu.

Powroty

ListItem – bieżący element.

Upoważnienie

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 wartość GlyphType elementu listy.

Parametry

NazwaTypOpis
glyphTypeGlyphTypetyp glifu

Powroty

ListItem – bieżący element,

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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)

Ustawia ustawienie „od lewej do prawej”.

Parametry

NazwaTypOpis
leftToRightBooleanustawienie od lewej do prawej

Powroty

ListItem – bieżący element,

Upoważnienie

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, które określają liczbę wierszy, jaka ma być zastosowana do odstępów.

Parametry

NazwaTypOpis
multiplierNumberliczba wierszy

Powroty

ListItem – bieżący element,

Upoważnienie

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

Powroty

ListItem – bieżący element,

Upoważnienie

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 jest ustawiony na tę samą wartość dla określonego elementu ListItem. Te 2 elementy typu ListItems będą traktowane jako członkowie tej samej listy.

Parametry

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

Powroty

ListItem – bieżący element,

Upoważnienie

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)

Ustawia poziom zagnieżdżenia elementu listy.

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

Parametry

NazwaTypOpis
nestingLevelIntegerpoziom zagnieżdżenia

Powroty

ListItem – bieżący element,

Upoważnienie

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 w punktach po elemencie.

Parametry

NazwaTypOpis
spacingAfterNumberodstępy po elemencie w punktach

Powroty

ListItem – bieżący element,

Upoważnienie

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)

Określa odstępy w punktach przed elementem.

Parametry

NazwaTypOpis
spacingBeforeNumberodstępy przed elementem, w punktach

Powroty

ListItem – bieżący element,

Upoważnienie

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: dotychczasowe treści zostaną wyczyszczone.

Parametry

NazwaTypOpis
textStringnowa zawartość tekstu,

Upoważnienie

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)

Ustawia wyrównanie tekstu. Dostępne typy wyrównywania 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

NazwaTypOpis
textAlignmentTextAlignmenttyp wyrównania tekstu do zastosowania;

Powroty

ListItem – bieżący element,

Upoważnienie

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