Interface Element

Element

Element ogólny. Document treści są jako elementów. Na przykład ListItem, Paragraph i Table to elementów i dziedziczą wszystkie metody określone przez Element, takie jak getType().

Wdrażanie klas

NazwaKrótki opis
BodyZawartość karty w dokumencie Dokumentów Google.
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 Equation.
EquationFunctionArgumentSeparatorElement reprezentujący separator funkcji w funkcji matematycznej Equation.
EquationSymbolElement reprezentujący symbol w Equation.
FooterSectionElement reprezentujący sekcję stopki.
FootnoteElement reprezentujący przypis.
FootnoteSectionElement reprezentujący sekcję przypisu.
HeaderSectionElement reprezentujący sekcję nagłówka.
HorizontalRuleElement reprezentujący regułę poziomą.
InlineDrawingElement reprezentujący osadzony rysunek.
InlineImageElement reprezentujący osadzony 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. do 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 region 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 w postaci 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 kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()ElementScala element z poprzednim elementem potomnym 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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

Body – bieżący element.

Autoryzacja

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 to Date, użyj tej metody, aby ustawić jego typ jako Date. Dzięki temu autouzupełnianie w edytorze Apps Script będzie mogło wyświetlić metody, których możesz użyć dzięki funkcji Date.

Powrót

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

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

Equation – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

EquationFunction – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

EquationFunctionArgumentSeparator – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

EquationSymbol – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

FooterSection – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

Footnote – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

FootnoteSection – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

HeaderSection – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

HorizontalRule – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

InlineDrawing – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

InlineImage – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

ListItem – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

PageBreak – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

Paragraph – bieżący element.

Autoryzacja

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 będzie mogło wyświetlić metody, których możesz użyć osoba.

Powrót

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

Autoryzacja

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 w postaci RichLink, np. link do pliku Arkuszy Google.

Jeśli wiesz, że element to RichLink, użyj tej metody, aby ustawić jego typ jako RichLink. Dzięki temu autouzupełnianie w edytorze Apps Script będzie mogło wyświetlić i RichLink.

Powrót

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

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

Table – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

TableCell – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

TableOfContents – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

TableRow – bieżący element.

Autoryzacja

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.

Używaj tej metody, aby ułatwiać autouzupełnianie, gdy dane elementy są związane z konkretnym elementem typu.

Powrót

Text – bieżący element.

Autoryzacja

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.

Skopiowane są też wszystkie elementy podrzędne zawarte w elemencie. Nowy element nie ma elementu nadrzędnego.

Powrót

Element – nowa wersja,

Autoryzacja

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.

Wynikiem jest obiekt zawierający właściwość każdego prawidłowego atrybutu elementu, nazwa właściwości odpowiada elementowi na liście DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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]);
}

Powrót

Object – atrybuty elementu.

Autoryzacja

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 kolejny element równorzędny elementu.

Następne elementy równorzędne mają tego samego elementu nadrzędnego i następują po bieżącym elemencie.

Powrót

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

Autoryzacja

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 bieżący element.

Powrót

ContainerElement – element nadrzędny.

Autoryzacja

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 elementu.

Poprzednie elementy nadrzędne mają tego samego elementu nadrzędnego i wyprzedzają bieżący element.

Powrót

Element – poprzedni element równorzędny.

Autoryzacja

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 wartość ElementType elementu.

Aby określić dokładny typ danego elementu, użyj właściwości getType().

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

// Obtain the first element in the active tab's 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.');
}

Powrót

ElementType – typ elementu.

Autoryzacja

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 jest na końcu Document.

Powrót

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

Autoryzacja

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

Scala element z poprzednim elementem potomnym tego samego typu.

Można scalać tylko elementy o tej samej wartości ElementType. Wszystkie elementy podrzędne zawarte w bieżący element jest przenoszony do poprzedniego elementu równorzędnego.

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

Powrót

Element – scalony element.

Autoryzacja

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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Powrót

Element – usunięty element.

Autoryzacja

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 wyliczenie DocumentApp.Attribute, a każda wartość właściwości jest nową wartością do zastosowano.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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.

Powrót

Element – bieżący element.

Autoryzacja

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