Class HeaderSection

Nagłóweksekcji

Element reprezentujący sekcję nagłówka. Document zawiera zwykle maksymalnie 1 HeaderSection. Element HeaderSection 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 dodaje nową wartość HorizontalRule.
appendImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendImage(image)InlineImageDodaje podany parametr InlineImage.
appendListItem(listItem)ListItemDodaje podany parametr ListItem.
appendListItem(text)ListItemTworzy i dodaje nowy element ListItem zawierający określony tekst.
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nowy element Paragraph zawierający określony tekst.
appendTable()TableTworzy i dodaje nową wartość Table.
appendTable(cells)TableDodaje nową wartość Table zawierającą element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDodaje podany parametr Table.
clear()HeaderSectionCzyści zawartość elementu.
copy()HeaderSectionZwraca 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 potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getImages()InlineImage[]Pobiera wszystkie InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getTables()Table[]Pobiera wszystkie Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule na wskazanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego bloba obrazu na określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem na wskazanej pozycji.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w wybranym miejscu, zawierający podany tekst.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph na wskazanej pozycji.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst.
insertTable(childIndex)TableTworzy i wstawia nowy element Table na wskazanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający wskazane komórki w wybranym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table na wskazanej pozycji.
removeChild(child)HeaderSectionUsuwa określony element podrzędny.
removeFromParent()HeaderSectionUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
setAttributes(attributes)HeaderSectionUstawia atrybuty elementu.
setText(text)HeaderSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)HeaderSectionUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

appendHorizontalRule()

Tworzy i dodaje nową wartość HorizontalRule.

Element HorizontalRule będzie zawarty w nowym elemencie Paragraph.

Powrót

HorizontalRule – nowa linia pozioma.

Autoryzacja

Skrypty, które korzystają 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

appendImage(image)

Tworzy i dodaje nowy element InlineImage z określonego bloba obrazu.

Obraz będzie zawarty w nowym pliku Paragraph.

Parametry

NazwaTypOpis
imageBlobSourceDane obrazu.

Powrót

InlineImage – dołączony obraz.

Autoryzacja

Skrypty, które korzystają 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

appendImage(image)

Dodaje podany parametr InlineImage.

Element InlineImage będzie zawarty w nowym elemencie Paragraph.

Użyj tej wersji appendImage, dołączając kopię istniejącej wersji InlineImage.

Parametry

NazwaTypOpis
imageInlineImageDane obrazu.

Powrót

InlineImage – dołączony obraz.

Autoryzacja

Skrypty, które korzystają 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

appendListItem(listItem)

Dodaje podany parametr ListItem.

Użyj tej wersji appendListItem, dołączając kopię istniejącej wersji ListItem.

Parametry

NazwaTypOpis
listItemListItemElement listy do dołączenia.

Powrót

ListItem – dołączony element listy.

Autoryzacja

Skrypty, które korzystają 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

appendListItem(text)

Tworzy i dodaje nowy element ListItem zawierający określony tekst.

Kolejne elementy listy są dodawane jako część tej samej listy.

Parametry

NazwaTypOpis
textStringTreść tekstowa elementu listy.

Powrót

ListItem – nowy element listy.

Autoryzacja

Skrypty, które korzystają 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

appendParagraph(paragraph)

Dodaje podany parametr Paragraph.

Użyj tej wersji appendParagraph, dołączając kopię istniejącej wersji Paragraph.

Parametry

NazwaTypOpis
paragraphParagraphAkapit do załączenia.

Powrót

Paragraph – załączony akapit.

Autoryzacja

Skrypty, które korzystają 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

appendParagraph(text)

Tworzy i dodaje nowy element Paragraph zawierający określony tekst.

Parametry

NazwaTypOpis
textStringTreść tekstu akapitu.

Powrót

Paragraph – nowy akapit.

Autoryzacja

Skrypty, które korzystają 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

appendTable()

Tworzy i dodaje nową wartość 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, które korzystają 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

appendTable(cells)

Dodaje nową wartość Table zawierającą 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[][]Treść tekstowa komórek tabeli, którą chcesz dodać do nowej tabeli.

Powrót

Table – dołączona tabela.

Autoryzacja

Skrypty, które korzystają 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

appendTable(table)

Dodaje podany parametr Table.

Użyj tej wersji appendTable, dołączając kopię istniejącej wersji 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 której chcesz dołączyć dane.

Powrót

Table – dołączona tabela.

Autoryzacja

Skrypty, które korzystają 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.

Powrót

HeaderSection – bieżący element.


copy()

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

Skopiowane zostaną też wszystkie elementy podrzędne obecne w danym elemencie. Nowy element nie ma rodzica.

Powrót

HeaderSection – nowa kopia.

Autoryzacja

Skrypty, które korzystają 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.

Aby manipulować zawartością elementów jako tekstem sformatowanym, użyj editAsText. Tryb editAsText ignoruje elementy inne niż tekstowe (takie jak InlineImageHorizontalRule).

Elementy podrzędne całkowicie zawarte w usuniętym zakresie 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 potomka określonego typu.

Parametry

NazwaTypOpis
elementTypeElementTypeTyp elementu do wyszukania.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 potomka 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 – wynik wyszukiwania wskazujący następną pozycję elementu wyszukiwania.

Autoryzacja

Skrypty, które korzystają 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 za pomocą wyrażeń regularnych.

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

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

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania.

Powrót

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

Autoryzacja

Skrypty, które korzystają 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 wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.

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

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

Parametry

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

Powrót

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

Autoryzacja

Skrypty, które korzystają 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ść dla każdego prawidłowego atrybutu elementu, przy czym każda nazwa 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, które korzystają 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 o określonym indeksie podrzędnym.

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

Autoryzacja

Skrypty, które korzystają 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ędnego elementu podrzędnego.

Parametry

NazwaTypOpis
childElementElement podrzędny, którego indeks ma zostać pobrany.

Powrót

Integer – indeks podrzędny.

Autoryzacja

Skrypty, które korzystają 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

getImages()

Pobiera wszystkie InlineImages zawarte w sekcji.

Powrót

InlineImage[] – obrazy sekcji.

Autoryzacja

Skrypty, które korzystają 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

getListItems()

Pobiera wszystkie ListItems zawarte w sekcji.

Powrót

ListItem[] – elementy listy sekcji.

Autoryzacja

Skrypty, które korzystają 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.

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, które korzystają 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

getParagraphs()

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

Powrót

Paragraph[] – akapity sekcji.

Autoryzacja

Skrypty, które korzystają 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.

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement – element nadrzędny.

Autoryzacja

Skrypty, które korzystają 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

getTables()

Pobiera wszystkie Tables zawarte w sekcji.

Powrót

Table[] – tabele sekcji.

Autoryzacja

Skrypty, które korzystają 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 jako ciąg tekstowy

Autoryzacja

Skrypty, które korzystają 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.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT.

Powrót

TextAlignment – 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, które korzystają 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ść atrybutu ElementType elementu.

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

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, które korzystają 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 nowy element HorizontalRule na wskazanym indeksie.

Element HorizontalRule będzie zawarty w nowym elemencie Paragraph.

Parametry

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

Powrót

HorizontalRule – nowa linia pozioma.

Autoryzacja

Skrypty, które korzystają 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

insertImage(childIndex, image)

Tworzy i wstawia InlineImage z określonego bloba obrazu na określonym indeksie.

Parametry

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

Powrót

InlineImage – wstawiony obraz.

Autoryzacja

Skrypty, które korzystają 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

insertImage(childIndex, image)

Wstawia podany element InlineImage na wskazanej pozycji.

Obraz będzie zawarty w nowym pliku Paragraph.

Parametry

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

Powrót

InlineImage – wstawiony obraz.

Autoryzacja

Skrypty, które korzystają 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

insertListItem(childIndex, listItem)

Wstawia podany element ListItem na wskazanej pozycji.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.
listItemListItemElement listy do wstawienia.

Powrót

ListItem – wstawiony element listy.

Autoryzacja

Skrypty, które korzystają 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

insertListItem(childIndex, text)

Tworzy i wstawia nowy element ListItem w wybranym miejscu, zawierający podany tekst.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.
textStringTreść tekstowa elementu listy.

Powrót

ListItem – nowy element listy.

Autoryzacja

Skrypty, które korzystają 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

insertParagraph(childIndex, paragraph)

Wstawia podany element Paragraph na wskazanej pozycji.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.
paragraphParagraphAkapit do wstawienia.

Powrót

Paragraph – wstawiony akapit.

Autoryzacja

Skrypty, które korzystają 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

insertParagraph(childIndex, text)

Tworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.
textStringTreść tekstu akapitu.

Powrót

Paragraph – nowy akapit.

Autoryzacja

Skrypty, które korzystają 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

insertTable(childIndex)

Tworzy i wstawia nowy element Table na wskazanym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.

Powrót

Table – nowa tabela.

Autoryzacja

Skrypty, które korzystają 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

insertTable(childIndex, cells)

Tworzy i wstawia nowy element Table zawierający wskazane komórki w wybranym indeksie.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.
cellsString[][]Treść tekstowa komórek tabeli, którą chcesz dodać do nowej tabeli.

Powrót

Table – nowa tabela.

Autoryzacja

Skrypty, które korzystają 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

insertTable(childIndex, table)

Wstawia podany element Table na wskazanej pozycji.

Parametry

NazwaTypOpis
childIndexIntegerIndeks, w którym ma nastąpić wstawienie.
tableTableTabela do wstawienia.

Powrót

Table – wstawiona tabela.

Autoryzacja

Skrypty, które korzystają 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

HeaderSection – bieżący element.

Autoryzacja

Skrypty, które korzystają 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 jego 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

HeaderSection – usunięty element.

Autoryzacja

Skrypty, które korzystają 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)

Za pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.

Wzór wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScriptu. W tym celu musisz uciec się do użycia ukośnika wstecznego w wzorze.

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

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

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

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

Parametry

NazwaTypOpis
searchPatternStringwzór wyrażenia regularnego do wyszukania;
replacementStringtekst, który ma być użyty jako tekst zastępczy;

Powrót

Element – bieżący element.

Autoryzacja

Skrypty, które korzystają 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.

Parametr specified attributes musi być obiektem, w którym każda nazwa właściwości jest elementem zbioru 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

HeaderSection – bieżący element.

Autoryzacja

Skrypty, które korzystają 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ść jako zwykły tekst.

Uwaga: istniejące treści zostaną usunięte.

Parametry

NazwaTypOpis
textStringnowe treści tekstowe.

Powrót

HeaderSection – bieżący element.

Autoryzacja

Skrypty, które korzystają 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ównania to DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPTDocumentApp.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, który ma być zastosowany.

Powrót

HeaderSection – bieżący element.

Autoryzacja

Skrypty, które korzystają 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

Wycofane metody