Interface Element

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Element

Element ogólny. Treści Document są przedstawiane jako elementy. Na przykład ListItem, Paragraph i Table są elementami i dziedziczą wszystkie metody zdefiniowane przez Element, takie jak getType().

Implementacja zajęć

NazwaKrótki opis
BodyElement reprezentujący treść dokumentu.
ContainerElementElement ogólny, który może zawierać inne elementy
DateElement reprezentujący sformatowaną datę
EquationElement reprezentujący wyrażenie matematyczne.
EquationFunctionElement reprezentujący funkcję w matematycznym narzędziu Equation.
EquationFunctionArgumentSeparatorElement reprezentujący separator funkcyjny w matemacie Equation.
EquationSymbolElement reprezentujący symbol w matemacie Equation.
FooterSectionElement reprezentujący sekcję stopki.
FootnoteElement reprezentujący przypis.
FootnoteSectionElement reprezentujący sekcję przypisu.
HeaderSectionElement reprezentujący sekcję nagłówka.
HorizontalRuleElement reprezentujący linię poziomą.
InlineDrawingElement przedstawiający umieszczony rysunek.
InlineImageElement reprezentujący umieszczony obraz.
ListItemElement reprezentujący element listy.
PageBreakElement reprezentujący podział strony.
ParagraphElement reprezentujący akapit.
PersonElement reprezentujący link do osoby.
RichLinkElement reprezentujący link do zasobu Google, na przykład plik na Dysku lub film w YouTube.
TableElement reprezentujący tabelę.
TableCellElement reprezentujący komórkę tabeli.
TableOfContentsElement zawierający spis treści.
TableRowElement reprezentujący wiersz tabeli.
TextElement reprezentujący region tekstu sformatowanego.
UnsupportedElementElement reprezentujący region, który nie jest znany lub nie ma na niego wpływu, np. numer strony.

Metody

MetodaZwracany typKrótki opis
asBody()BodyZwraca bieżący element jako Body.
asDate()DateZwraca bieżący element jako Date.
asEquation()EquationZwraca bieżący element jako Equation.
asEquationFunction()EquationFunctionZwraca bieżący element jako EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorZwraca bieżący element jako EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolZwraca bieżący element jako EquationSymbol.
asFooterSection()FooterSectionZwraca bieżący element jako FooterSection.
asFootnote()FootnoteZwraca bieżący element jako Footnote.
asFootnoteSection()FootnoteSectionZwraca bieżący element jako FootnoteSection.
asHeaderSection()HeaderSectionZwraca bieżący element jako HeaderSection.
asHorizontalRule()HorizontalRuleZwraca bieżący element jako HorizontalRule.
asInlineDrawing()InlineDrawingZwraca bieżący element jako InlineDrawing.
asInlineImage()InlineImageZwraca bieżący element jako InlineImage.
asListItem()ListItemZwraca bieżący element jako ListItem.
asPageBreak()PageBreakZwraca bieżący element jako PageBreak.
asParagraph()ParagraphZwraca bieżący element jako Paragraph.
asPerson()PersonZwraca bieżący element jako Person.
asRichLink()RichLinkZwraca bieżący element jako RichLink, na przykład link do pliku Arkuszy Google.
asTable()TableZwraca bieżący element jako Table.
asTableCell()TableCellZwraca bieżący element jako TableCell.
asTableOfContents()TableOfContentsZwraca bieżący element jako TableOfContents.
asTableRow()TableRowZwraca bieżący element jako TableRow.
asText()TextZwraca bieżący element jako Text.
copy()ElementZwraca odłączoną głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera element potomny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera element potomny.
getType()ElementTypePobiera element ElementType.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu elementu Document.
merge()ElementScala element z poprzednim elementem tego samego typu.
removeFromParent()ElementUsuwa element z elementu nadrzędnego.
setAttributes(attributes)ElementUstawia atrybuty elementu.

Szczegółowa dokumentacja

asBody()

Zwraca bieżący element jako Body.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asDate()

Zwraca bieżący element jako Date.

Jeśli element jest typu Date, użyj tej metody, aby ustawić jego typ jako Date. Pozwoli to na autouzupełnianie w edytorze Apps Script, aby zobaczyć metody, których możesz używać z Date.

Zwróć

Date – bieżący element z typem ustawionym na Date;

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

asEquation()

Zwraca bieżący element jako Equation.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asEquationFunction()

Zwraca bieżący element jako EquationFunction.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asEquationFunctionArgumentSeparator()

Zwraca bieżący element jako EquationFunctionArgumentSeparator.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asEquationSymbol()

Zwraca bieżący element jako EquationSymbol.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asFooterSection()

Zwraca bieżący element jako FooterSection.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asFootnote()

Zwraca bieżący element jako Footnote.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asFootnoteSection()

Zwraca bieżący element jako FootnoteSection.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

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

asHeaderSection()

Zwraca bieżący element jako HeaderSection.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asHorizontalRule()

Zwraca bieżący element jako HorizontalRule.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asInlineDrawing()

Zwraca bieżący element jako InlineDrawing.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asInlineImage()

Zwraca bieżący element jako InlineImage.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asListItem()

Zwraca bieżący element jako ListItem.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asPageBreak()

Zwraca bieżący element jako PageBreak.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asParagraph()

Zwraca bieżący element jako Paragraph.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asPerson()

Zwraca bieżący element jako Person.

Jeśli wiesz, że element to Person, użyj tej metody, aby ustawić jego typ jako osobę. Dzięki temu autouzupełnianie w edytorze Apps Script wyświetli metody, których możesz użyć w elemencie person.

Zwróć

Person – bieżący element z typem ustawionym na Person;

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

Zwraca bieżący element jako RichLink, na przykład link do pliku Arkuszy Google.

Jeśli element jest typu RichLink, użyj tej metody, aby ustawić jego typ jako RichLink. Pozwoli to na autouzupełnianie w edytorze Apps Script, aby zobaczyć metody, których możesz używać z RichLink.

Zwróć

RichLink – bieżący element z typem ustawionym na RichLink;

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

asTable()

Zwraca bieżący element jako Table.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asTableCell()

Zwraca bieżący element jako TableCell.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asTableOfContents()

Zwraca bieżący element jako TableOfContents.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asTableRow()

Zwraca bieżący element jako TableRow.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

asText()

Zwraca bieżący element jako Text.

Ta metoda ułatwia autouzupełnianie, gdy dany element jest znany z określonego typu.

Zwróć

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

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óć

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

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

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

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

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

isAtDocumentEnd()

Określa, czy element znajduje się na końcu elementu Document.

Zwróć

Boolean – określa, czy element jest na końcu dokumentu –

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

merge()

Scala element z poprzednim elementem tego samego typu.

Łączyć można tylko te same elementy ElementType. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do elementu nadrzędnego.

Bieżący element zostanie usunięty z dokumentu.

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

Zwróć

Element – scalony 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óć

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

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óć

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