Class FootnoteSection

Przypis

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

Metody

MetodaZwracany typKrótki opis
appendParagraph(paragraph)ParagraphDołącza daną właściwość Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph zawierający określony tekst.
clear()FootnoteSectionCzyści zawartość elementu.
copy()FootnoteSectionZwraca odłączoną głęboką kopię bieżącego elementu.
editAsText()TextUzyskuje do edycji wersję Text bieżącego elementu.
findElement(elementType)RangeElementWyszukuje zawartość elementu w przypadku elementu potomnego określonego typu.
findElement(elementType, from)RangeElementWyszukuje zawartość elementu w przypadku potomna określonego typu, począwszy od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu w określonym wzorze tekstowym za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu w określonym wzorze tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny w określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędny określonego elementu podrzędnego.
getNextSibling()ElementPobiera element potomny.
getNumChildren()IntegerPobiera liczbę elementów podrzędnych.
getParagraphs()Paragraph[]Pobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera element potomny.
getText()StringPobiera zawartość elementu w postaci ciągu tekstowego.
getTextAlignment()TextAlignmentUzyskaj wyrównanie tekstu.
getType()ElementTypePobiera element ElementType.
insertParagraph(childIndex, paragraph)ParagraphWstawia podaną wartość Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphPowoduje utworzenie i wstawienie nowego parametru Paragraph w określonym indeksie zawierającego treści tekstowe.
removeChild(child)FootnoteSectionUsuwa określony element podrzędny.
removeFromParent()FootnoteSectionUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstowego na określony ciąg zastępczy za pomocą wyrażeń regularnych.
setAttributes(attributes)FootnoteSectionUstawia atrybuty elementu.
setText(text)FootnoteSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FootnoteSectionUstawia wyrównanie tekstu.

Szczegółowa dokumentacja

appendParagraph(paragraph)

Dołącza daną właściwość Paragraph.

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

Parametry

NazwaTypOpis
paragraphParagraphakapitu do dołączenia

Zwróć

Paragraph – dołączony akapit

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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ślony tekst.

Parametry

NazwaTypOpis
textStringzawartość akapitu

Zwróć

Paragraph – nowy akapit

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

clear()

Czyści zawartość elementu.

Zwróć

FootnoteSection – bieżący element


copy()

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

Wszystkie jego elementy podrzędne też zostaną skopiowane. Nowy element nie ma elementu nadrzędnego.

Zwróć

FootnoteSection – nowa kopia.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

editAsText()

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

Wartość editAsText służy do manipulowania treścią elementów jako tekst sformatowany. Tryb editAsText ignoruje elementy nietekstowe (np. InlineImage i HorizontalRule).

Elementy podrzędne w całości usuniętego zakresu tekstowego są usuwane z elementu.

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

Zwróć

Text – wersja tekstowa bieżącego elementu.


findElement(elementType)

Wyszukuje zawartość elementu w przypadku elementu potomnego określonego typu.

Parametry

NazwaTypOpis
elementTypeElementTypetyp elementu do wyszukania.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

findElement(elementType, from)

Wyszukuje zawartość elementu w przypadku potomna określonego typu, począwszy 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 elementu do wyszukania.
fromRangeElementwynik wyszukiwania do wyszukania

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 w określonym wzorze tekstowym za pomocą wyrażeń regularnych.

Część funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwana, np. grupy przechwytywania i modyfikatory trybu.

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

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania

Zwróć

RangeElement – wynik wyszukiwania wskazujący pozycję wyszukiwanego hasła lub wartość null, jeśli nie ma dopasowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 w określonym wzorze tekstu, zaczynając od danego wyniku wyszukiwania.

Część funkcji wyrażeń regularnych JavaScript nie jest w pełni obsługiwana, np. grupy przechwytywania i modyfikatory trybu.

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

Parametry

NazwaTypOpis
searchPatternStringwzór do wyszukania
fromRangeElementwynik wyszukiwania do wyszukania

Zwróć

RangeElement – wynik wyszukiwania wskazujący następną pozycję wyszukiwanego hasła lub wartość null w przypadku braku dopasowania.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getAttributes()

Pobiera atrybuty elementu.

W rezultacie obiekt zawiera właściwość dla każdego prawidłowego atrybutu elementu, gdzie każda nazwa właściwości odpowiada elementowi na liście 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]);
}

Zwróć

Object – atrybuty elementu

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 w określonym indeksie podrzędnym.

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

Zwróć

Element – element podrzędny w określonym indeksie,

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getChildIndex(child)

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

Parametry

NazwaTypOpis
childElementelement podrzędny, dla którego zostanie pobrany indeks

Zwróć

Integer – indeks podrzędny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getNextSibling()

Pobiera element potomny.

Kolejne rodzeństwo ma tego samego elementu nadrzędnego i jednocześnie występuje w bieżącym elemencie.

Zwróć

Element – następny element potomny

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego 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.");

Zwróć

Integer – liczba dzieci

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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).

Zwróć

Paragraph[] – akapity sekcji

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Element nadrzędny zawiera bieżący element.

Zwróć

ContainerElement – element nadrzędny;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getPreviousSibling()

Pobiera element potomny.

Poprzednie rodzeństwo ma ten sam element nadrzędny i wyprzedza bieżący element.

Zwróć

Element – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getText()

Pobiera zawartość elementu w postaci ciągu tekstowego.

Zwróć

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getTextAlignment()

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

Zwróć

TextAlignment – typ wyrównania tekstu lub null, jeśli tekst zawiera wiele typów wyrównania tekstu lub jeśli wyrównanie tekstu nigdy nie zostało ustawione.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

getType()

Pobiera element ElementType.

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

Zwróć

ElementType – typ elementu;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

insertParagraph(childIndex, paragraph)

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

Parametry

NazwaTypOpis
childIndexIntegerindeks, do którego należy wstawić
paragraphParagraphakapitu do wstawienia

Zwróć

Paragraph – wstawiony akapit

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

insertParagraph(childIndex, text)

Powoduje utworzenie i wstawienie nowego parametru Paragraph w określonym indeksie zawierającego treści tekstowe.

Parametry

NazwaTypOpis
childIndexIntegerindeks, do którego należy wstawić
textStringzawartość akapitu

Zwróć

Paragraph – nowy akapit

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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

Zwróć

FootnoteSection – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

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

Zwróć

FootnoteSection – usunięty element;

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 tekstowego na określony ciąg zastępczy za pomocą wyrażeń regularnych.

Wzorzec wyszukiwania jest przekazywany jako ciąg znaków, a nie obiekt wyrażenia regularnego JavaScript. Z tego powodu trzeba uniknąć zmiany ukośników we wzorze.

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

Podany wzorzec wyrażenia regularnego jest indywidualnie dopasowywany do każdego bloku tekstowego zawartego 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
searchPatternStringwyrażenie regularne do wyszukania
replacementStringtekst, który ma być używany jako zamiennik.

Zwróć

Element – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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.

Wskazany parametr musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczeniach DocumentApp.Attribute, a każda wartość właściwości to nowa wartość 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.

Zwróć

FootnoteSection – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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: istniejąca zawartość zostanie wyczyszczona.

Parametry

NazwaTypOpis
textStringnowa zawartość tekstowa

Zwróć

FootnoteSection – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametry

NazwaTypOpis
textAlignmentTextAlignmenttyp dopasowania tekstu, który ma zostać zastosowany

Zwróć

FootnoteSection – bieżący element

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu co najmniej jednego z tych zakresów:

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

Wycofane metody