Class FootnoteSection

PrzypisSekcja

Element reprezentujący sekcję przypisu. Element FootnoteSection zawiera tekst odpowiadający elementowi Footnote. Element FootnoteSection może zawierać elementy ListItem lub Paragraph. Więcej informacji o strukturze dokumentu znajdziesz w przewodniku po rozszerzaniu Dokumentów Google.

Metody

MetodaZwracany typKrótki opis
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nowy element Paragraph zawierający określony tekst.
clear()FootnoteSectionCzyści zawartość elementu.
copy()FootnoteSectionZwraca 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.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
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.
removeChild(child)FootnoteSectionUsuwa określony element podrzędny.
removeFromParent()FootnoteSectionUsuwa 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)FootnoteSectionUstawia atrybuty elementu.
setText(text)FootnoteSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FootnoteSectionUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

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

clear()

Czyści zawartość elementu.

Powrót

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

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

getNextSibling()

Pobiera następny element nadrzędny.

Następny element równego rzędu ma tego samego rodzica i następuje po bieżącym elemencie.

Powrót

Element – następny element równorzę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

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

getPreviousSibling()

Pobiera poprzedni element nadrzędny elementu.

Poprzedni element ma tego samego rodzica i poprzedza bieżący element.

Powrót

Element – poprzedni równorzędny 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

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

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

removeChild(child)

Usuwa określony element podrzędny.

Parametry

NazwaTypOpis
childElementElement podrzędny do usunięcia.

Powrót

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

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

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

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

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