Interface Element

Element

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

Wdrażanie zajęć

NazwaKrótki opis
BodyElement reprezentujący treść dokumentu.
ContainerElementOgólny element, który może zawierać inne elementy.
DateElement reprezentujący sformatowaną datę
EquationElement reprezentujący wyrażenie matematyczne.
EquationFunctionElement reprezentujący funkcję w matematycznym Equation.
EquationFunctionArgumentSeparatorElement reprezentujący separator funkcji w matematyce Equation.
EquationSymbolElement reprezentujący symbol w Equation matematycznym.
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 reprezentują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, np. pliku na Dysku czy filmu 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 jest nieznany lub którego skrypt nie może mieć 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, np. 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 następny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu parametru Document.
merge()ElementŁączy element z poprzednim elementem równorzędnym 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.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

Body – bieżący element.

Upoważnienie

Skrypty korzystające 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

asDate()

Zwraca bieżący element jako Date.

Jeśli wiesz, że element należy do typu Date, użyj tej metody, aby ustawić jego typ jako Date. Dzięki temu autouzupełnianie w edytorze Apps Script będzie pokazywać metody, których możesz używać w przypadku obiektu Date.

Powroty

Date – bieżący element, którego typ to Date.

Upoważnienie

Skrypty korzystające 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

asEquation()

Zwraca bieżący element jako Equation.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

Equation – bieżący element.

Upoważnienie

Skrypty korzystające 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

asEquationFunction()

Zwraca bieżący element jako EquationFunction.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

EquationFunction – bieżący element.

Upoważnienie

Skrypty korzystające 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

asEquationFunctionArgumentSeparator()

Zwraca bieżący element jako EquationFunctionArgumentSeparator.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

EquationFunctionArgumentSeparator – bieżący element.

Upoważnienie

Skrypty korzystające 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

asEquationSymbol()

Zwraca bieżący element jako EquationSymbol.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

EquationSymbol – bieżący element.

Upoważnienie

Skrypty korzystające 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

asFooterSection()

Zwraca bieżący element jako FooterSection.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

FooterSection – bieżący element.

Upoważnienie

Skrypty korzystające 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

asFootnote()

Zwraca bieżący element jako Footnote.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

Footnote – bieżący element.

Upoważnienie

Skrypty korzystające 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

asFootnoteSection()

Zwraca bieżący element jako FootnoteSection.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

FootnoteSection – bieżący element.

Upoważnienie

Skrypty korzystające 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

asHeaderSection()

Zwraca bieżący element jako HeaderSection.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

HeaderSection – bieżący element.

Upoważnienie

Skrypty korzystające 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

asHorizontalRule()

Zwraca bieżący element jako HorizontalRule.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

HorizontalRule – bieżący element.

Upoważnienie

Skrypty korzystające 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

asInlineDrawing()

Zwraca bieżący element jako InlineDrawing.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

InlineDrawing – bieżący element.

Upoważnienie

Skrypty korzystające 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

asInlineImage()

Zwraca bieżący element jako InlineImage.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

InlineImage – bieżący element.

Upoważnienie

Skrypty korzystające 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

asListItem()

Zwraca bieżący element jako ListItem.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

ListItem – bieżący element.

Upoważnienie

Skrypty korzystające 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

asPageBreak()

Zwraca bieżący element jako PageBreak.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

PageBreak – bieżący element.

Upoważnienie

Skrypty korzystające 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

asParagraph()

Zwraca bieżący element jako Paragraph.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

Paragraph – bieżący element.

Upoważnienie

Skrypty korzystające 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

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 pokazuje metody, których możesz używać z elementem dotyczącym osoby.

Powroty

Person – bieżący element, którego typ to Person.

Upoważnienie

Skrypty korzystające 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

Zwraca bieżący element jako RichLink, np. link do pliku Arkuszy Google.

Jeśli wiesz, że element należy do typu RichLink, użyj tej metody, aby ustawić jego typ jako RichLink. Dzięki temu autouzupełnianie w edytorze Apps Script będzie pokazywać metody, których możesz używać z elementem RichLink.

Powroty

RichLink – bieżący element, którego typ to RichLink.

Upoważnienie

Skrypty korzystające 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

asTable()

Zwraca bieżący element jako Table.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

Table – bieżący element.

Upoważnienie

Skrypty korzystające 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

asTableCell()

Zwraca bieżący element jako TableCell.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

TableCell – bieżący element.

Upoważnienie

Skrypty korzystające 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

asTableOfContents()

Zwraca bieżący element jako TableOfContents.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

TableOfContents – bieżący element.

Upoważnienie

Skrypty korzystające 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

asTableRow()

Zwraca bieżący element jako TableRow.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

TableRow – bieżący element.

Upoważnienie

Skrypty korzystające 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

asText()

Zwraca bieżący element jako Text.

Skorzystaj z tej metody, aby ułatwić autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powroty

Text – bieżący element.

Upoważnienie

Skrypty korzystające 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

copy()

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

Kopiowane są też wszystkie elementy podrzędne występujące w elemencie. Nowy element nie ma elementu nadrzędnego.

Powroty

Element – nowa kopia.

Upoważnienie

Skrypty korzystające 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.

W efekcie powstanie obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, w którym każda nazwa właściwości odpowiada elementowi w wyliczeniu 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]);
}

Powroty

Object – atrybuty elementu.

Upoważnienie

Skrypty korzystające 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 równorzędny elementu.

Następne elementy nadrzędne mają ten sam element nadrzędny i następują po bieżącym elemencie.

Powroty

Element – następny element równorzędny.

Upoważnienie

Skrypty korzystające 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 elementu.

Element nadrzędny zawiera element bieżący.

Powroty

ContainerElement – element nadrzędny.

Upoważnienie

Skrypty korzystające 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 równorzędny.

Poprzedni element nadrzędny ma ten sam element nadrzędny i poprzedza bieżący element.

Powroty

Element – poprzedni element równorzędny.

Upoważnienie

Skrypty korzystające 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 ElementType elementu.

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

Powroty

ElementType – typ elementu.

Upoważnienie

Skrypty korzystające 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

isAtDocumentEnd()

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

Powroty

Boolean – określa, czy element znajduje się na końcu dokumentu.

Upoważnienie

Skrypty korzystające 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

merge()

Łączy element z poprzednim elementem równorzędnym tego samego typu.

Można scalać tylko elementy elementu ElementType. Wszystkie elementy podrzędne zawarte w bieżącym elemencie są przenoszone do poprzedniego elementu równorzę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();

Powroty

Element – scalony element.

Upoważnienie

Skrypty korzystające 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 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();
}

Powroty

Element – usunięty element

Upoważnienie

Skrypty korzystające 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.

Określony parametr atrybutów musi być obiektem, w którym każda nazwa właściwości jest elementem w wyliczeniu DocumentApp.Attribute, a każda wartość właściwości jest nową wartością 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.

Powroty

Element – bieżący element.

Upoważnienie

Skrypty korzystające 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