Interface Element

Element

Element ogólny. Zawartość Document jest reprezentowana jako elementy. Na przykład ListItem, Paragraph i Table to elementy, które dziedziczą wszystkie metody zdefiniowane przez Element, takie jak getType().

Implementowanie klas

NazwaKrótki opis
BodyTreść karty w dokumencie Dokumentów Google.
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 Equation matematycznym.
EquationFunctionArgumentSeparatorElement reprezentujący separator funkcji w obiekcie matematycznym Equation.
EquationSymbolElement reprezentujący symbol w Equation matematycznym.
FooterSectionElement reprezentujący sekcję stopki.
FootnoteElement reprezentujący przypis.
FootnoteSectionElement reprezentujący sekcję przypisów.
HeaderSectionElement reprezentujący sekcję nagłówka.
HorizontalRuleElement reprezentujący linię poziomą.
InlineDrawingElement reprezentujący osadzony 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 lub 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 obszar tekstu sformatowanego.
UnsupportedElementElement reprezentujący region, który jest nieznany lub na który 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()Element|nullPobiera następny element równorzędny.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()Element|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()Element|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)ElementUstawia atrybuty elementu.

Szczegółowa dokumentacja

asBody()

Zwraca bieżący element jako Body.

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

Body – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 wiesz, że element jest Date, użyj tej metody, aby ustawić jego typ jako Date. Dzięki temu autouzupełnianie w edytorze Apps Script będzie wyświetlać metody, których możesz użyć z Date.

Powrót

Date – bieżący element z typem ustawionym jako Date.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

Equation – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

EquationFunction – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

EquationFunctionArgumentSeparator – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

EquationSymbol – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

FooterSection – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

Footnote – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

FootnoteSection – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

HeaderSection – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

HorizontalRule – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

InlineDrawing – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

InlineImage – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

ListItem – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

PageBreak – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

Paragraph – bieżący element.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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 jest Person, użyj tej metody, aby ustawić jego typ jako osoba. Dzięki temu autouzupełnianie w edytorze Apps Script będzie wyświetlać metody, których możesz używać z elementem person.

Powrót

Person – bieżący element z typem ustawionym jako Person.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem 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, np. link do pliku Arkuszy Google.

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

Powrót

RichLink – bieżący element z typem ustawionym jako RichLink.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

Table – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

TableCell – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

TableOfContents – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

TableRow – bieżący element.

Autoryzacja

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

Użyj tej metody, aby wspomagać autouzupełnianie, gdy wiadomo, że dany element jest określonego typu.

Powrót

Text – bieżący element.

Autoryzacja

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

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

Powrót

Element – nowy tekst.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 nazwa każdej 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 korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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.

Następny element równorzędny ma tego samego rodzica i występuje po bieżącym elemencie.

Powrót

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

Autoryzacja

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

Element nadrzędny zawiera bieżący element.

Powrót

ContainerElement|null – element nadrzędny.

Autoryzacja

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

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

getPreviousSibling()

Pobiera poprzedni element sąsiedni elementu.

Poprzedni element równorzędny ma tego samego rodzica i występuje przed bieżącym elementem.

Powrót

Element|null – poprzedni element równorzędny.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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. 

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 korzystające z tej metody wymagają autoryzacji z użyciem 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 Document.

Powrót

Boolean – czy element znajduje się na końcu karty.

Autoryzacja

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

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

merge()

Łączy element z poprzednim elementem tego samego typu.

Można scalać tylko elementy tego samego 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. 

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Powrót

Element|null – scalony element.

Autoryzacja

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

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

Element|null – usunięty element.

Autoryzacja

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

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

Element – bieżący element.

Autoryzacja

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

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