Class FooterSection

SekcjaStopka

Element reprezentujący sekcję stopki. Document zwykle zawiera co najwyżej 1 FooterSection. Element FooterSection może zawierać elementy ListItem, Paragraph i Table. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podany element InlineImage.
appendListItem(listItem)ListItemDołącza podany element ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy element ListItem zawierający określone treści tekstowe.
appendParagraph(paragraph)ParagraphDołącza podany element Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDołącza nowy element Table zawierający element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDołącza podany element Table.
clear()FooterSectionUsuwa zawartość elementu.
copy()FooterSectionZwraca 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.
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.
getImages()InlineImage[]|nullPobiera wszystkie elementy InlineImages zawarte w sekcji.
getListItems()ListItem[]|nullPobiera wszystkie elementy ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]|nullPobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getTables()Table[]|nullPobiera wszystkie elementy Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule w określonym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w określonym indeksie, zawierający podaną treść tekstową.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy element Table w określonym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający określone komórki we wskazanym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table w określonym indeksie.
removeChild(child)FooterSectionUsuwa określony element podrzędny.
removeFromParent()FooterSection|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)FooterSectionUstawia atrybuty elementu.
setText(text)FooterSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FooterSectionUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

appendHorizontalRule()

Tworzy i dołącza nowy element HorizontalRule.

Element HorizontalRule będzie znajdować się w nowym elemencie Paragraph.

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

appendImage(image)

Tworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.

Obraz będzie znajdować się w nowym elemencie Paragraph.

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

appendImage(image)

Dołącza podany element InlineImage.

Element InlineImage będzie znajdować się w nowym elemencie Paragraph.

Użyj tej wersji appendImage, gdy dołączasz kopię istniejącego 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

appendListItem(listItem)

Dołącza podany element ListItem.

Użyj tej wersji appendListItem, gdy dołączasz kopię istniejącego ListItem.

Parametry

NazwaTypOpis
listItemListItemElement listy do dołączenia.

Powrót

ListItem – dołączony element 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

appendListItem(text)

Tworzy i dołącza nowy element ListItem zawierający określone treści tekstowe.

Kolejne elementy listy są dodawane w ramach tej samej listy.

Parametry

NazwaTypOpis
textStringZawartość tekstowa elementu listy.

Powrót

ListItem – nowy element 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

appendParagraph(paragraph)

Dołącza podany element Paragraph.

Użyj tej wersji appendParagraph, gdy dołączasz kopię istniejącego Paragraph.

Parametry

NazwaTypOpis
paragraphParagraphAkapit do załączenia.

Powrót

Paragraph – dołączony akapit.

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

appendParagraph(text)

Tworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.

Parametry

NazwaTypOpis
textStringZawartość tekstowa akapitu.

Powrót

Paragraph – nowy akapit.

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

appendTable()

Tworzy i dołącza nowy element Table.

Ta metoda spowoduje też dodanie pustego akapitu po tabeli, ponieważ dokumenty Dokumentów Google nie mogą kończyć się tabelą.

Powrót

Table – nowa tabela.

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

appendTable(cells)

Dołącza nowy element Table zawierający element TableCell dla każdej określonej wartości ciągu znaków.

Ta metoda spowoduje też dodanie pustego akapitu po tabeli, ponieważ dokumenty Dokumentów Google nie mogą kończyć się tabelą.

Parametry

NazwaTypOpis
cellsString[][]Zawartość tekstowa komórek tabeli, które mają zostać dodane do nowej tabeli.

Powrót

Table – dołączona tabela.

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

appendTable(table)

Dołącza podany element Table.

Użyj tej wersji appendTable, gdy dołączasz kopię istniejącego Table. Ta metoda spowoduje też dodanie pustego akapitu po tabeli, ponieważ dokumenty Dokumentów Google nie mogą kończyć się tabelą.

Parametry

NazwaTypOpis
tableTableTabela do dołączenia.

Powrót

Table – dołączona tabela.

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

FooterSection – 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

FooterSection – 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 dopasowywany niezależnie 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 dopasowywany niezależnie 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

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

getImages()

Pobiera wszystkie elementy InlineImages zawarte w sekcji.

Powrót

InlineImage[]|null – obrazy sekcji.

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

getListItems()

Pobiera wszystkie elementy ListItems zawarte w sekcji.

Powrót

ListItem[]|null – elementy listy sekcji.

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

getParagraphs()

Pobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).

Powrót

Paragraph[]|null – akapity sekcji.

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

getTables()

Pobiera wszystkie elementy Tables zawarte w sekcji.

Powrót

Table[]|null – tabele sekcji.

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

Element HorizontalRule będzie znajdować się w nowym elemencie Paragraph.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.

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

insertImage(childIndex, image)

Tworzy i wstawia 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 obraz 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

insertImage(childIndex, image)

Wstawia podany element InlineImage w określonym indeksie.

Obraz będzie znajdować się w nowym elemencie Paragraph.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
imageInlineImageObraz do wstawienia.

Powrót

InlineImage – wstawiony obraz 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

insertListItem(childIndex, listItem)

Wstawia podany element ListItem w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
listItemListItemElement listy do wstawienia.

Powrót

ListItem – wstawiony element 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

insertListItem(childIndex, text)

Tworzy i wstawia nowy element ListItem w określonym indeksie, zawierający podaną treść tekstową.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
textStringZawartość tekstowa elementu listy.

Powrót

ListItem – nowy element 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

insertParagraph(childIndex, paragraph)

Wstawia podany element Paragraph w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
paragraphParagraphAkapit do wstawienia.

Powrót

Paragraph – wstawiony akapit.

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

insertParagraph(childIndex, text)

Tworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
textStringZawartość tekstowa akapitu.

Powrót

Paragraph – nowy akapit.

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

insertTable(childIndex)

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

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.

Powrót

Table – nowa tabela.

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

insertTable(childIndex, cells)

Tworzy i wstawia nowy element Table zawierający określone komórki we wskazanym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
cellsString[][]Zawartość tekstowa komórek tabeli, które mają zostać dodane do nowej tabeli.

Powrót

Table – nowa tabela.

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

insertTable(childIndex, table)

Wstawia podany element Table w określonym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma zostać wstawiony element.
tableTableTabela do wstawienia.

Powrót

Table – wstawiona tabela.

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

FooterSection – 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

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

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 JavaScript. Dlatego musisz zmienić znaczenie wszystkich ukośników odwrotnych we wzorcu.

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

Podany wzorzec wyrażenia regularnego jest dopasowywany niezależnie 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

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

FooterSection – 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ść jako zwykły tekst.

Uwaga: dotychczasowa zawartość zostanie wyczyszczona.

Parametry

NazwaTypOpis
textStringNowa zawartość tekstowa.

Powrót

FooterSection – 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

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

FooterSection – 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

Wycofane metody