Document Service

Dokument

Ta usługa umożliwia skryptom tworzenie plików Dokumentów Google, uzyskiwanie do nich dostępu i ich modyfikowanie.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Zajęcia

NazwaKrótki opis
AttributeWyliczenie atrybutów elementu.
BodyTreść karty w dokumencie Dokumentów Google.
BookmarkObiekt reprezentujący zakładkę.
ContainerElementElement ogólny, który może zawierać inne elementy.
DateElement reprezentujący sformatowaną datę
DocumentDokument zawierający co najmniej 1 obiekt Tab, z których każdy zawiera tekst sformatowany i elementy takie jak tabele i listy.
DocumentAppUsługa dokumentów utworzy i otworzy plik Documents, który można edytować.
DocumentTabKarta dokumentu zawierająca tekst sformatowany i elementy takie jak tabele i listy.
ElementElement ogólny.
ElementTypeWyliczenie wszystkich typów elementów.
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.
FontFamilyWyliczenie obsługiwanych czcionek.
FooterSectionElement reprezentujący sekcję stopki.
FootnoteElement reprezentujący przypis.
FootnoteSectionElement reprezentujący sekcję przypisów.
GlyphTypeWyliczenie obsługiwanych typów glifów.
HeaderSectionElement reprezentujący sekcję nagłówka.
HorizontalAlignmentWyliczenie obsługiwanych typów wyrównania w poziomie.
HorizontalRuleElement reprezentujący linię poziomą.
InlineDrawingElement reprezentujący osadzony rysunek.
InlineImageElement reprezentujący umieszczony obraz.
ListItemElement reprezentujący element listy.
NamedRangeRange, która ma nazwę i identyfikator, co umożliwia późniejsze pobranie.
PageBreakElement reprezentujący podział strony.
ParagraphElement reprezentujący akapit.
ParagraphHeadingWyliczenie standardowych nagłówków akapitów.
PersonElement reprezentujący link do osoby.
PositionOdwołanie do lokalizacji na karcie dokumentu względem określonego elementu.
PositionedImageObraz o stałej pozycji zakotwiczony w Paragraph.
PositionedLayoutWyliczenie określające sposób rozmieszczenia elementu PositionedImage w stosunku do otaczającego go tekstu.
RangeZakres elementów w dokumencie.
RangeBuilderKonstruktor służący do tworzenia obiektów Range z elementów dokumentu.
RangeElementObiekt opakowujący Element z możliwym przesunięciem początku i końca.
RichLinkElement reprezentujący link do zasobu Google, np. pliku na Dysku lub filmu w YouTube.
TabKarta w dokumencie Google.
TabTypeWyliczenie wszystkich typów kart.
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.
TextAlignmentWyliczenie typów wyrównania tekstu.
UnsupportedElementElement reprezentujący region, który jest nieznany lub na który skrypt nie może mieć wpływu, np. numer strony.
VerticalAlignmentWyliczenie obsługiwanych typów wyrównania w pionie.

Attribute

Właściwości

WłaściwośćTypOpis
BACKGROUND_COLOREnumKolor tła elementu (akapit, tabela itp.) lub dokumentu.
BOLDEnumUstawienie grubości czcionki w przypadku tekstu sformatowanego.
BORDER_COLOREnumKolor obramowania elementów tabeli.
BORDER_WIDTHEnumSzerokość obramowania w punktach w przypadku elementów tabeli.
CODEEnumZawartość kodu w przypadku elementów równań.
FONT_FAMILYEnumUstawienie rodziny czcionek dla tekstu sformatowanego.
FONT_SIZEEnumUstawienie rozmiaru czcionki w punktach dla tekstu sformatowanego.
FOREGROUND_COLOREnumUstawienie koloru pierwszego planu dla tekstu sformatowanego.
HEADINGEnumTyp nagłówka w przypadku elementów akapitu (np. DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumUstawienie wysokości w przypadku elementów obrazu.
HORIZONTAL_ALIGNMENTEnumWyrównanie w poziomie w przypadku elementów akapitu (np. DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumUstawienie wcięcia na końcu w punktach dla elementów akapitu.
INDENT_FIRST_LINEEnumUstawienie wcięcia pierwszego wiersza w punktach dla elementów akapitu.
INDENT_STARTEnumUstawienie wcięcia na początku akapitu w punktach dla elementów akapitu.
ITALICEnumUstawienie stylu czcionki dla tekstu sformatowanego.
GLYPH_TYPEEnumTyp glifu w przypadku elementów listy.
LEFT_TO_RIGHTEnumUstawienie kierunku tekstu w przypadku tekstu sformatowanego.
LINE_SPACINGEnumUstawienie odstępów między wierszami jako mnożnika w przypadku elementów akapitu.
LINK_URLEnumAdres URL linku w przypadku tekstu sformatowanego.
LIST_IDEnumIdentyfikator listy nadrzędnej w przypadku elementów listy.
MARGIN_BOTTOMEnumUstawienie dolnego marginesu w punktach dla elementów akapitu.
MARGIN_LEFTEnumUstawienie lewego marginesu w punktach dla elementów akapitu.
MARGIN_RIGHTEnumUstawienie prawego marginesu w punktach dla elementów akapitu.
MARGIN_TOPEnumUstawienie górnego marginesu w punktach dla elementów akapitu.
NESTING_LEVELEnumPoziom zagnieżdżenia elementu w przypadku elementów listy.
MINIMUM_HEIGHTEnumMinimalna wysokość w punktach dla elementów wiersza tabeli.
PADDING_BOTTOMEnumUstawienie dopełnienia u dołu w punktach dla elementów komórek tabeli.
PADDING_LEFTEnumUstawienie dopełnienia z lewej strony w punktach dla elementów komórki tabeli.
PADDING_RIGHTEnumUstawienie dopełnienia z prawej strony w punktach dla elementów komórek tabeli.
PADDING_TOPEnumUstawienie dopełnienia u góry w punktach dla elementów komórki tabeli.
PAGE_HEIGHTEnumUstawienie wysokości strony w punktach w przypadku dokumentów.
PAGE_WIDTHEnumUstawienie szerokości strony w punktach dla dokumentów.
SPACING_AFTEREnumUstawienie odstępu dolnego w punktach dla elementów akapitu.
SPACING_BEFOREEnumUstawienie odstępu u góry w punktach dla elementów akapitu.
STRIKETHROUGHEnumUstawienie przekreślenia tekstu sformatowanego.
UNDERLINEEnumUstawienie podkreślenia dla tekstu sformatowanego.
VERTICAL_ALIGNMENTEnumUstawienie wyrównania w pionie dla elementów komórek tabeli.
WIDTHEnumUstawienie szerokości w przypadku komórek tabeli i elementów obrazu.

Body

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podany element InlineImage.
appendListItem(listItem)ListItemDołącza podany element ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy element ListItem zawierający określone treści tekstowe.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podany element PageBreak.
appendParagraph(paragraph)ParagraphDołącza podany element Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDołącza nowy element Table zawierający element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDołącza podany element Table.
clear()BodyUsuwa zawartość elementu.
copy()BodyZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getHeadingAttributes(paragraphHeading)ObjectPobiera zestaw atrybutów dla podanego ParagraphHeading.
getImages()InlineImage[]|nullPobiera wszystkie elementy InlineImages zawarte w sekcji.
getListItems()ListItem[]|nullPobiera wszystkie elementy ListItems zawarte w sekcji.
getMarginBottom()Number|nullPobiera dolny margines w punktach.
getMarginLeft()Number|nullPobiera lewy margines w punktach.
getMarginRight()Number|nullPobiera prawy margines.
getMarginTop()Number|nullPobiera górny margines.
getNumChildren()IntegerPobiera liczbę dzieci.
getPageHeight()Number|nullPobiera wysokość strony w punktach.
getPageWidth()Number|nullPobiera szerokość strony w punktach.
getParagraphs()Paragraph[]|nullPobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getTables()Table[]|nullPobiera wszystkie elementy Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule w określonym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w określonym indeksie, zawierający podaną treść tekstową.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak w określonym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak w określonym indeksie.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy element Table w określonym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający określone komórki we wskazanym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table w określonym indeksie.
removeChild(child)BodyUsuwa określony element podrzędny.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)BodyUstawia atrybuty elementu.
setHeadingAttributes(paragraphHeading, attributes)BodyUstawia atrybuty dla podanego ParagraphHeading.
setMarginBottom(marginBottom)BodyUstawia dolny margines w punktach.
setMarginLeft(marginLeft)BodyUstawia lewy margines w punktach.
setMarginRight(marginRight)BodyUstawia prawy margines w punktach.
setMarginTop(marginTop)BodyUstawia górny margines.
setPageHeight(pageHeight)BodyUstawia wysokość strony w punktach.
setPageWidth(pageWidth)BodyUstawia szerokość strony w punktach.
setText(text)BodyUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)BodyUstawia wyrównanie tekstu.

Bookmark

Metody

MetodaZwracany typKrótki opis
getId()StringPobiera identyfikator Bookmark.
getPosition()PositionPobiera Position z Bookmark w DocumentTab.
remove()voidUsuwa Bookmark.

ContainerElement

Metody

MetodaZwracany typKrótki opis
asBody()BodyZwraca bieżący element jako Body.
asEquation()EquationZwraca bieżący element jako Equation.
asFooterSection()FooterSectionZwraca bieżący element jako FooterSection.
asFootnoteSection()FootnoteSectionZwraca bieżący element jako FootnoteSection.
asHeaderSection()HeaderSectionZwraca bieżący element jako HeaderSection.
asListItem()ListItemZwraca bieżący element jako ListItem.
asParagraph()ParagraphZwraca bieżący element jako Paragraph.
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.
clear()ContainerElementUsuwa zawartość elementu.
copy()ContainerElementZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()ContainerElement|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()ContainerElement|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)ContainerElementUstawia atrybuty elementu.
setLinkUrl(url)ContainerElementUstawia adres URL linku.
setTextAlignment(textAlignment)ContainerElementUstawia wyrównanie tekstu.

Date

Metody

MetodaZwracany typKrótki opis
copy()DateZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getDisplayText()StringZwraca wartość wyświetlaną, która jest renderowana w dokumencie.
getLocale()StringZwraca ustawienia regionalne daty używane w przypadku wartości wyświetlanej.
getNextSibling()Element|nullPobiera następny element równorzędny.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getTimestamp()DateZwraca sygnaturę czasową powiązaną z datą.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()Date|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()Date|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)DateUstawia atrybuty elementu.

Document

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje znak Bookmark w podanym Position na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
addEditor(emailAddress)DocumentDodaje podanego użytkownika do listy edytujących Document.
addEditor(user)DocumentDodaje podanego użytkownika do listy edytujących Document.
addEditors(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy edytujących Document.
addFooter()FooterSectionDodaje sekcję stopki (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
addHeader()HeaderSectionDodaje sekcję nagłówka (jeśli nie istnieje) do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
addNamedRange(name, range)NamedRangeDodaje NamedRange, czyli Range z nazwą i identyfikatorem, który można później wykorzystać do pobierania danych, na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
addViewer(emailAddress)DocumentDodaje podanego użytkownika do listy osób, które mogą wyświetlać Document.
addViewer(user)DocumentDodaje podanego użytkownika do listy osób, które mogą wyświetlać Document.
addViewers(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy widzów Document.
getActiveTab()TabPobiera aktualnie aktywny Tab użytkownika w dokumencie.
getAs(contentType)BlobPobiera bieżącą zawartość Document jako obiekt blob określonego typu.
getBlob()BlobPobiera bieżącą zawartość Document jako obiekt blob.
getBody()BodyPobiera Body pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, DocumentBodySection aktywnej karty.
getBookmark(id)Bookmark|nullPobiera Bookmark o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
getCursor()Position|nullPobiera kursor użytkownika na aktywnej karcie.
getEditors()User[]Pobiera listę edytorów tego Document.
getFooter()FooterSection|nullPobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty.
getFootnotes()Footnote[]|nullPobiera wszystkie elementy Footnote w treści pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w treści aktywnej karty.
getHeader()HeaderSection|nullPobiera sekcję nagłówka pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję nagłówka aktywnej karty.
getId()StringPobiera unikalny identyfikator dokumentu.
getLanguage()StringPobiera kod języka dokumentu.
getName()StringPobiera tytuł dokumentu.
getNamedRangeById(id)NamedRange|nullPobiera NamedRange o podanym identyfikatorze z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty NamedRange z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
getNamedRanges(name)NamedRange[]Pobiera wszystkie obiekty NamedRange o podanej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
getSelection()Range|nullPobiera wybór użytkownika na aktywnej karcie.
getSupportedLanguageCodes()String[]Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
getTab(tabId)TabPobiera Tab o określonym identyfikatorze.
getTabs()Tab[]Pobiera wszystkie niezagłębione elementy Tab, które są częścią dokumentu.
getUrl()StringPobiera adres URL dostępu do bieżącego dokumentu.
getViewers()User[]Pobiera listę przeglądających i komentujących dla tego Document.
newPosition(element, offset)PositionTworzy nowy Position, który jest odwołaniem do lokalizacji na karcie względem określonego elementu na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, aktywnej karty.
newRange()RangeBuilderTworzy narzędzie do tworzenia obiektów Range z elementów karty na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
removeEditor(emailAddress)DocumentUsuwa danego użytkownika z listy osób edytujących Document.
removeEditor(user)DocumentUsuwa danego użytkownika z listy osób edytujących Document.
removeViewer(emailAddress)DocumentUsuwa danego użytkownika z listy przeglądających i komentujących Document.
removeViewer(user)DocumentUsuwa danego użytkownika z listy przeglądających i komentujących Document.
saveAndClose()voidZapisuje bieżący Document.
setActiveTab(tabId)voidUstawia wybraną przez użytkownika Tab w bieżącym dokumencie na kartę o określonym identyfikatorze.
setCursor(position)DocumentUstawia kursor użytkownika na podstawie wartości Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentUstawia tytuł dokumentu.
setSelection(range)DocumentUstawia wybór użytkownika na aktywnej karcie, biorąc pod uwagę Range.

DocumentApp

Właściwości

WłaściwośćTypOpis
AttributeAttributeAttribute wyliczenie.
ElementTypeElementTypeElementType wyliczenie.
FontFamilyFontFamilyFontFamily wyliczenie.
GlyphTypeGlyphTypeGlyphType wyliczenie.
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment wyliczenie.
ParagraphHeadingParagraphHeadingParagraphHeading wyliczenie.
PositionedLayoutPositionedLayoutPositionedLayout wyliczenie.
TextAlignmentTextAlignmentTextAlignment wyliczenie.
VerticalAlignmentVerticalAlignmentVerticalAlignment wyliczenie.

Metody

MetodaZwracany typKrótki opis
create(name)DocumentTworzy i zwraca nowy dokument.
getActiveDocument()DocumentZwraca dokument, z którym jest powiązany skrypt.
getUi()UiZwraca instancję środowiska interfejsu użytkownika dokumentu, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna i paski boczne.
openById(id)DocumentZwraca dokument o określonym identyfikatorze.
openByUrl(url)DocumentOtwiera i zwraca dokument o określonym adresie URL.

DocumentTab

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje Bookmark w podanym Position.
addFooter()FooterSectionDodaje sekcję stopki karty, jeśli jeszcze jej nie ma.
addHeader()HeaderSectionDodaje sekcję nagłówka karty, jeśli nie istnieje.
addNamedRange(name, range)NamedRangeDodaje NamedRange, czyli Range, który ma nazwę i identyfikator do późniejszego pobrania.
getBody()BodyPobiera Body karty.
getBookmark(id)Bookmark|nullPobiera Bookmark o podanym identyfikatorze.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark na karcie.
getFooter()FooterSection|nullPobiera sekcję stopki karty, jeśli taka istnieje.
getFootnotes()Footnote[]|nullPobiera wszystkie elementy Footnote w treści karty.
getHeader()HeaderSection|nullPobiera sekcję nagłówka karty, jeśli taka istnieje.
getNamedRangeById(id)NamedRange|nullPobiera NamedRange o podanym identyfikatorze.
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty NamedRange na karcie.
getNamedRanges(name)NamedRange[]Pobiera wszystkie obiekty NamedRange na karcie o podanej nazwie.
newPosition(element, offset)PositionTworzy nowy element Position, który jest odwołaniem do lokalizacji na karcie względem określonego elementu.
newRange()RangeBuilderTworzy kreator służący do konstruowania obiektów Range z elementów kart.

Element

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.

ElementType

Właściwości

WłaściwośćTypOpis
BODY_SECTIONEnumTyp odpowiadający elementowi Body.
COMMENT_SECTIONEnumTyp odpowiadający elementowi CommentSection.
DATEEnumTyp odpowiadający elementowi Date.
EQUATIONEnumTyp odpowiadający elementowi Equation.
EQUATION_FUNCTIONEnumTyp odpowiadający elementowi EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumTyp odpowiadający elementowi EquationFunctionArgumentSeparator.
EQUATION_SYMBOLEnumTyp odpowiadający elementowi EquationSymbol.
RICH_LINKEnumTyp odpowiadający elementowi RichLink.
FOOTER_SECTIONEnumTyp odpowiadający elementowi FooterSection.
FOOTNOTEEnumTyp odpowiadający elementowi Footnote.
FOOTNOTE_SECTIONEnumTyp odpowiadający elementowi FootnoteSection.
HEADER_SECTIONEnumTyp odpowiadający elementowi HeaderSection.
HORIZONTAL_RULEEnumTyp odpowiadający elementowi HorizontalRule.
INLINE_DRAWINGEnumTyp odpowiadający elementowi InlineDrawing.
INLINE_IMAGEEnumTyp odpowiadający elementowi InlineImage.
LIST_ITEMEnumTyp odpowiadający elementowi ListItem.
PAGE_BREAKEnumTyp odpowiadający elementowi PageBreak.
PARAGRAPHEnumTyp odpowiadający elementowi Paragraph.
PERSONEnumTyp odpowiadający elementowi Person.
TABLEEnumTyp odpowiadający elementowi Table.
TABLE_CELLEnumTyp odpowiadający elementowi TableCell.
TABLE_OF_CONTENTSEnumTyp odpowiadający elementowi TableOfContents.
TABLE_ROWEnumTyp odpowiadający elementowi TableRow.
TEXTEnumTyp odpowiadający elementowi Text.
UNSUPPORTEDEnumTyp odpowiadający UnsupportedElement.

Equation

Metody

MetodaZwracany typKrótki opis
clear()EquationUsuwa zawartość elementu.
copy()EquationZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()Equation|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()Equation|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)EquationUstawia atrybuty elementu.
setLinkUrl(url)EquationUstawia adres URL linku.
setTextAlignment(textAlignment)EquationUstawia wyrównanie tekstu.

EquationFunction

Metody

MetodaZwracany typKrótki opis
clear()EquationFunctionUsuwa zawartość elementu.
copy()EquationFunctionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getCode()StringPobiera kod odpowiadający funkcji równania.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()EquationFunction|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationFunction|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)EquationFunctionUstawia atrybuty elementu.
setLinkUrl(url)EquationFunctionUstawia adres URL linku.
setTextAlignment(textAlignment)EquationFunctionUstawia wyrównanie tekstu.

EquationFunctionArgumentSeparator

Metody

MetodaZwracany typKrótki opis
copy()EquationFunctionArgumentSeparatorZwraca 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()EquationFunctionArgumentSeparator|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationFunctionArgumentSeparator|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)EquationFunctionArgumentSeparatorUstawia atrybuty elementu.

EquationSymbol

Metody

MetodaZwracany typKrótki opis
copy()EquationSymbolZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getCode()StringPobiera kod odpowiadający symbolowi równania.
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()EquationSymbol|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationSymbol|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)EquationSymbolUstawia atrybuty elementu.

FontFamily

FooterSection

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podany element InlineImage.
appendListItem(listItem)ListItemDołącza podany element ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy element ListItem zawierający określone treści tekstowe.
appendParagraph(paragraph)ParagraphDołącza podany element Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDołącza nowy element Table zawierający element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDołącza podany element Table.
clear()FooterSectionUsuwa zawartość elementu.
copy()FooterSectionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getImages()InlineImage[]|nullPobiera wszystkie elementy InlineImages zawarte w sekcji.
getListItems()ListItem[]|nullPobiera wszystkie elementy ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]|nullPobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getTables()Table[]|nullPobiera wszystkie elementy Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule w określonym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w określonym indeksie, zawierający podaną treść tekstową.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy element Table w określonym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający określone komórki we wskazanym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table w określonym indeksie.
removeChild(child)FooterSectionUsuwa określony element podrzędny.
removeFromParent()FooterSection|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)FooterSectionUstawia atrybuty elementu.
setText(text)FooterSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FooterSectionUstawia wyrównanie tekstu.

Footnote

Metody

MetodaZwracany typKrótki opis
copy()FootnoteZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getFootnoteContents()FootnoteSection|nullPobiera zawartość elementu przypisu.
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.
removeFromParent()Footnote|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)FootnoteUstawia atrybuty elementu.

FootnoteSection

Metody

MetodaZwracany typKrótki opis
appendParagraph(paragraph)ParagraphDołącza podany element Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.
clear()FootnoteSectionUsuwa zawartość elementu.
copy()FootnoteSectionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]|nullPobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.
removeChild(child)FootnoteSectionUsuwa określony element podrzędny.
removeFromParent()FootnoteSection|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)FootnoteSectionUstawia atrybuty elementu.
setText(text)FootnoteSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FootnoteSectionUstawia wyrównanie tekstu.

GlyphType

Właściwości

WłaściwośćTypOpis
BULLETEnumDomyślny punktor, okrągły i wypełniony.
HOLLOW_BULLETEnumPusty punktor.
SQUARE_BULLETEnumPunktor kwadratowy.
NUMBEREnumPunktor z numerem.
LATIN_UPPEREnumPunktor w postaci wielkiej litery alfabetu łacińskiego.
LATIN_LOWEREnumPunktor w postaci małej litery łacińskiej.
ROMAN_UPPEREnumrzymska cyfra, duża litera.
ROMAN_LOWEREnumCyfra rzymska, mały punkt.

HeaderSection

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podany element InlineImage.
appendListItem(listItem)ListItemDołącza podany element ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy element ListItem zawierający określone treści tekstowe.
appendParagraph(paragraph)ParagraphDołącza podany element Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph zawierający określone treści tekstowe.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDołącza nowy element Table zawierający element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDołącza podany element Table.
clear()HeaderSectionUsuwa zawartość elementu.
copy()HeaderSectionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getImages()InlineImage[]|nullPobiera wszystkie elementy InlineImages zawarte w sekcji.
getListItems()ListItem[]|nullPobiera wszystkie elementy ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]|nullPobiera wszystkie elementy Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getTables()Table[]|nullPobiera wszystkie elementy Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule w określonym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w określonym indeksie, zawierający podaną treść tekstową.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w określonym indeksie, zawierający podaną treść tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy element Table w określonym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający określone komórki we wskazanym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table w określonym indeksie.
removeChild(child)HeaderSectionUsuwa określony element podrzędny.
removeFromParent()HeaderSection|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)HeaderSectionUstawia atrybuty elementu.
setText(text)HeaderSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)HeaderSectionUstawia wyrównanie tekstu.

HorizontalAlignment

Właściwości

WłaściwośćTypOpis
LEFTEnumOpcja wyrównania do lewej.
CENTEREnumOpcja wyrównania do środka.
RIGHTEnumopcję wyrównania do prawej strony;
JUSTIFYEnumOpcja wyrównania do lewej i prawej.

HorizontalRule

Metody

MetodaZwracany typKrótki opis
copy()HorizontalRuleZwraca 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.
removeFromParent()HorizontalRule|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)HorizontalRuleUstawia atrybuty elementu.

InlineDrawing

Metody

MetodaZwracany typKrótki opis
copy()InlineDrawingZwraca odłączoną, głęboką kopię bieżącego elementu.
getAltDescription()String|nullZwraca alternatywny opis rysunku.
getAltTitle()String|nullZwraca alternatywny tytuł rysunku.
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()InlineDrawing|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()InlineDrawing|nullUsuwa element z elementu nadrzędnego.
setAltDescription(description)InlineDrawingUstawia alternatywny opis rysunku.
setAltTitle(title)InlineDrawingUstawia alternatywny tytuł rysunku.
setAttributes(attributes)InlineDrawingUstawia atrybuty elementu.

InlineImage

Metody

MetodaZwracany typKrótki opis
copy()InlineImageZwraca odłączoną, głęboką kopię bieżącego elementu.
getAltDescription()String|nullZwraca alternatywny opis obrazu.
getAltTitle()String|nullZwraca alternatywny tytuł obrazu.
getAs(contentType)BlobZwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getAttributes()ObjectPobiera atrybuty elementu.
getBlob()BlobZwraca dane w tym obiekcie jako obiekt blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getLinkUrl()String|nullPobiera adres URL linku.
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.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()InlineImage|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()InlineImage|nullUsuwa element z elementu nadrzędnego.
setAltDescription(description)InlineImageUstawia opis alternatywny obrazu.
setAltTitle(title)InlineImageUstawia alternatywny tytuł obrazu.
setAttributes(attributes)InlineImageUstawia atrybuty elementu.
setHeight(height)InlineImageUstawia wysokość obrazu w pikselach.
setLinkUrl(url)InlineImageUstawia adres URL linku.
setWidth(width)InlineImageUstawia szerokość obrazu w pikselach.

ListItem

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy PositionedImage z określonego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podany element InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podany element PageBreak.
appendText(text)TextTworzy i dołącza nowy element Text z określoną zawartością.
appendText(text)TextDołącza podany element Text.
clear()ListItemUsuwa zawartość elementu.
copy()ListItemZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAlignment()HorizontalAlignment|nullPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getGlyphType()GlyphType|nullPobiera GlyphType elementu listy.
getHeading()ParagraphHeading|nullPobiera ParagraphHeading.
getIndentEnd()Number|nullPobiera wcięcie końcowe w punktach.
getIndentFirstLine()Number|nullPobiera wcięcie pierwszego wiersza w punktach.
getIndentStart()Number|nullPobiera wcięcie początkowe.
getLineSpacing()Number|nullPobiera odstęp między wierszami w punktach.
getLinkUrl()String|nullPobiera adres URL linku.
getListId()String|nullPobiera identyfikator listy.
getNestingLevel()IntegerPobiera poziom zagnieżdżenia elementu listy.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera PositionedImage według identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getSpacingAfter()Number|nullPobiera odstęp po elemencie w punktach.
getSpacingBefore()Number|nullPobiera odstęp przed elementem w punktach.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia znak HorizontalRule w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak w określonym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia podany element Text w określonym indeksie z podaną zawartością tekstu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isLeftToRight()Boolean|nullPobiera ustawienie od lewej do prawej.
merge()ListItem|nullŁączy element z poprzednim elementem tego samego typu.
removeChild(child)ListItemUsuwa określony element podrzędny.
removeFromParent()ListItem|nullUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa PositionedImage na podstawie identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAlignment(alignment)ListItemUstawia wartość HorizontalAlignment.
setAttributes(attributes)ListItemUstawia atrybuty elementu.
setGlyphType(glyphType)ListItemUstawia GlyphType elementu listy.
setHeading(heading)ListItemUstawia wartość ParagraphHeading.
setIndentEnd(indentEnd)ListItemUstawia wcięcie końcowe w punktach.
setIndentFirstLine(indentFirstLine)ListItemUstawia wcięcie pierwszego wiersza w punktach.
setIndentStart(indentStart)ListItemUstawia wcięcie początkowe w punktach.
setLeftToRight(leftToRight)ListItemUstawia kierunek od lewej do prawej.
setLineSpacing(multiplier)ListItemUstawia odstęp między wierszami jako liczbę wierszy, które mają być użyte do określenia odstępu.
setLinkUrl(url)ListItemUstawia adres URL linku.
setListId(listItem)ListItemUstawia identyfikator listy.
setNestingLevel(nestingLevel)ListItemUstawia poziom zagnieżdżenia elementu listy.
setSpacingAfter(spacingAfter)ListItemUstawia odstęp po elemencie w punktach.
setSpacingBefore(spacingBefore)ListItemUstawia odstęp przed elementem w punktach.
setText(text)voidUstawia zawartość elementu listy jako tekst.
setTextAlignment(textAlignment)ListItemUstawia wyrównanie tekstu.

NamedRange

Metody

MetodaZwracany typKrótki opis
getId()StringPobiera identyfikator tego NamedRange.
getName()StringPobiera nazwę tego NamedRange.
getRange()RangePobiera zakres elementów powiązanych z tym obiektem NamedRange.
remove()voidUsuwa kartę NamedRange.

PageBreak

Metody

MetodaZwracany typKrótki opis
copy()PageBreakZwraca 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.
removeFromParent()PageBreak|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)PageBreakUstawia atrybuty elementu.

Paragraph

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy PositionedImage z określonego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podany element InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podany element PageBreak.
appendText(text)TextTworzy i dołącza nowy element Text z określoną zawartością.
appendText(text)TextDołącza podany element Text.
clear()ParagraphUsuwa zawartość elementu.
copy()ParagraphZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAlignment()HorizontalAlignment|nullPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getHeading()ParagraphHeading|nullPobiera ParagraphHeading.
getIndentEnd()Number|nullPobiera wcięcie końcowe w punktach.
getIndentFirstLine()Number|nullPobiera wcięcie pierwszego wiersza w punktach.
getIndentStart()Number|nullPobiera wcięcie początkowe.
getLineSpacing()Number|nullPobiera odstęp między wierszami w punktach.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera PositionedImage według identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getSpacingAfter()Number|nullPobiera odstęp po elemencie w punktach.
getSpacingBefore()Number|nullPobiera odstęp przed elementem w punktach.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia znak HorizontalRule w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak w określonym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia podany element Text w określonym indeksie z podaną zawartością tekstu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isLeftToRight()Boolean|nullPobiera ustawienie od lewej do prawej.
merge()Paragraph|nullŁączy element z poprzednim elementem tego samego typu.
removeChild(child)ParagraphUsuwa określony element podrzędny.
removeFromParent()Paragraph|nullUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa PositionedImage na podstawie identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAlignment(alignment)ParagraphUstawia wartość HorizontalAlignment.
setAttributes(attributes)ParagraphUstawia atrybuty elementu.
setHeading(heading)ParagraphUstawia wartość ParagraphHeading.
setIndentEnd(indentEnd)ParagraphUstawia wcięcie końcowe w punktach.
setIndentFirstLine(indentFirstLine)ParagraphUstawia wcięcie pierwszego wiersza w punktach.
setIndentStart(indentStart)ParagraphUstawia wcięcie początkowe w punktach.
setLeftToRight(leftToRight)ParagraphUstawia kierunek od lewej do prawej.
setLineSpacing(multiplier)ParagraphUstawia odstęp między wierszami jako liczbę wierszy, które mają być użyte do określenia odstępu.
setLinkUrl(url)ParagraphUstawia adres URL linku.
setSpacingAfter(spacingAfter)ParagraphUstawia odstęp po elemencie w punktach.
setSpacingBefore(spacingBefore)ParagraphUstawia odstęp przed elementem w punktach.
setText(text)voidUstawia zawartość akapitu jako tekst.
setTextAlignment(textAlignment)ParagraphUstawia wyrównanie tekstu.

ParagraphHeading

Właściwości

WłaściwośćTypOpis
NORMALEnumOpcja nagłówka dla zwykłego tekstu.
HEADING1EnumNajwyższy poziom nagłówka.
HEADING2EnumDruga opcja nagłówka.
HEADING3EnumOpcja trzeciego nagłówka
HEADING4EnumCzwarta opcja nagłówka.
HEADING5EnumPiąta opcja nagłówka.
HEADING6EnumNajniższa opcja nagłówka.
TITLEEnumOpcja nagłówka tytułu.
SUBTITLEEnumOpcja nagłówka podtytułu.

Person

Metody

MetodaZwracany typKrótki opis
copy()PersonZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getEmail()StringZwraca adres e-mail osoby.
getName()String|nullZwraca wyświetlaną nazwę osoby, jeśli jest ustawiona.
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()Person|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()Person|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)PersonUstawia atrybuty elementu.

Position

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera element, który zawiera ten obiekt Position.
getOffset()IntegerPobiera względną lokalizację tego elementu Position w elemencie, który go zawiera.
getSurroundingText()TextTworzy sztuczny element Text, który reprezentuje tekst i formatowanie elementu Paragraph lub ListItem zawierającego element Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych.
getSurroundingTextOffset()IntegerPobiera przesunięcie tego elementu Position w elemencie Text zwróconym przez getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowy element Bookmark w tym Position.
insertInlineImage(image)InlineImage|nullTworzy i wstawia nowy element InlineImage w tym miejscu Position z określonego obiektu blob obrazu.
insertText(text)Text|nullWstawia określony tekst w tym miejscu Position.

PositionedImage

Metody

MetodaZwracany typKrótki opis
getAs(contentType)BlobZwraca dane w tym obiekcie jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane w tym obiekcie jako obiekt blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getId()StringPobiera identyfikator obrazu.
getLayout()PositionedLayoutPobiera wartość wyliczeniową, która określa układ obrazu.
getLeftOffset()NumberPobiera przesunięcie obrazu (w punktach) od lewej strony akapitu.
getParagraph()ParagraphZwraca Paragraph, do którego zakotwiczony jest obraz.
getTopOffset()NumberZwraca odsunięcie obrazu od góry akapitu w punktach.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
setHeight(height)PositionedImageUstawia wysokość obrazu w pikselach.
setLayout(layout)PositionedImageOkreśla definicję układu obrazu.
setLeftOffset(offset)PositionedImageUstawia odsunięcie obrazu od lewej strony akapitu (w punktach).
setTopOffset(offset)PositionedImageUstawia odsunięcie obrazu od góry akapitu (w punktach).
setWidth(width)PositionedImageUstawia szerokość obrazu w pikselach.

PositionedLayout

Właściwości

WłaściwośćTypOpis
ABOVE_TEXTEnumObraz znajduje się nad tekstem.
BREAK_BOTHEnumObraz przerywa tekst po lewej i prawej stronie.
BREAK_LEFTEnumObraz przerywa tekst po lewej stronie.
BREAK_RIGHTEnumObraz przerywa tekst po prawej stronie.
WRAP_TEXTEnumObraz jest otoczony tekstem.

Range

Metody

MetodaZwracany typKrótki opis
getRangeElements()RangeElement[]Pobiera wszystkie elementy w tym obiekcie Range, w tym wszystkie częściowe elementy Text (np. w przypadku zaznaczenia, które obejmuje tylko część elementu Text).

RangeBuilder

Metody

MetodaZwracany typKrótki opis
addElement(element)RangeBuilderDodaje cały Element do tego RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderDodaje częściowy element Text do tego elementu RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderDodaje do tego elementu RangeBuilder 2 całe elementy i wszystkie elementy między nimi.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderDodaje do elementu RangeBuilder 2 częściowe elementy Text i wszystkie elementy między nimi.
addRange(range)RangeBuilderDodaje zawartość innego elementu Range do tego elementu RangeBuilder.
build()RangeTworzy obiekt Range na podstawie ustawień zastosowanych w przypadku narzędzia do tworzenia.
getRangeElements()RangeElement[]Pobiera wszystkie elementy w tym obiekcie Range, w tym wszystkie częściowe elementy Text (np. w przypadku zaznaczenia, które obejmuje tylko część elementu Text).

RangeElement

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera Element odpowiadający temu RangeElement.
getEndOffsetInclusive()IntegerPobiera pozycję końca zakresu częściowego w elemencie zakresu.
getStartOffset()IntegerPobiera pozycję początku zakresu częściowego w elemencie zakresu.
isPartial()BooleanOkreśla, czy ten element zakresu obejmuje cały element, czy tylko częściowy wybór znaków elementu.

Metody

MetodaZwracany typKrótki opis
copy()RichLinkZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getMimeType()String|nullZwraca typ MIME linku, który jest dostępny, gdy element jest linkiem do pliku na Dysku, a w przeciwnym razie null.
getNextSibling()Element|nullPobiera następny element równorzędny.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getTitle()StringZwraca wyświetlany tytuł linku.
getType()ElementTypePobiera ElementType elementu.
getUrl()StringZwraca adres URL zasobu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()RichLink|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()RichLink|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)RichLinkUstawia atrybuty elementu.

Tab

Metody

MetodaZwracany typKrótki opis
asDocumentTab()DocumentTabPobiera zawartość karty jako DocumentTab.
getChildTabs()Tab[]Pobiera karty podrzędne zagnieżdżone na tej karcie.
getId()StringPobiera identyfikator karty.
getIndex()IntegerPobiera indeks karty w elemencie nadrzędnym liczony od zera.
getTitle()StringPobiera tytuł karty.
getType()TabTypePobiera typ karty.

TabType

Właściwości

WłaściwośćTypOpis
DOCUMENT_TABEnumTyp odpowiadający DocumentTab.

Table

Metody

MetodaZwracany typKrótki opis
appendTableRow()TableRowTworzy i dołącza nowy element TableRow.
appendTableRow(tableRow)TableRowDołącza podany element TableRow.
clear()TableUsuwa zawartość elementu.
copy()TableZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getBorderColor()String|nullPobiera kolor obramowania.
getBorderWidth()Number|nullPobiera szerokość obramowania w punktach.
getCell(rowIndex, cellIndex)TableCell|nullPobiera TableCell w określonych indeksach wiersza i komórki.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getColumnWidth(columnIndex)Number|nullPobiera szerokość określonej kolumny tabeli w punktach.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getNumRows()IntegerPobiera liczbę TableRows.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getRow(rowIndex)TableRow|nullPobiera TableRow w określonym indeksie wiersza.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertTableRow(childIndex)TableRowTworzy i wstawia nowy element TableRow w określonym indeksie.
insertTableRow(childIndex, tableRow)TableRowWstawia podany element TableRow w określonym indeksie.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeChild(child)TableUsuwa określony element podrzędny.
removeFromParent()Table|nullUsuwa element z elementu nadrzędnego.
removeRow(rowIndex)TableRowUsuwa TableRow z określonego indeksu wiersza.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)TableUstawia atrybuty elementu.
setBorderColor(color)TableUstawia kolor obramowania.
setBorderWidth(width)TableUstawia szerokość obramowania w punktach.
setColumnWidth(columnIndex, width)TableUstawia szerokość określonej kolumny w punktach.
setLinkUrl(url)TableUstawia adres URL linku.
setTextAlignment(textAlignment)TableUstawia wyrównanie tekstu.

TableCell

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy element InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podany element InlineImage.
appendListItem(listItem)ListItemDołącza podany element ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy element ListItem.
appendParagraph(paragraph)ParagraphDołącza podany element Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDołącza nowy Table zawierający określone komórki.
appendTable(table)TableDołącza podany element Table.
clear()TableCellUsuwa zawartość elementu.
copy()TableCellZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getBackgroundColor()String|nullPobiera kolor tła.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getColSpan()IntegerPobiera zakres kolumn, czyli liczbę kolumn komórek tabeli, które obejmuje ta komórka.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getPaddingBottom()Number|nullPobiera dopełnienie u dołu w punktach.
getPaddingLeft()Number|nullPobiera dopełnienie z lewej strony w punktach.
getPaddingRight()Number|nullPobiera dopełnienie z prawej strony w punktach.
getPaddingTop()Number|nullPobiera dopełnienie u góry w punktach.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getParentRow()TableRow|nullPobiera TableRow zawierający bieżący TableCell.
getParentTable()Table|nullPobiera Table zawierający bieżący TableCell.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getRowSpan()IntegerPobiera zakres wierszy, czyli liczbę wierszy komórek tabeli, które obejmuje ta komórka.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
getVerticalAlignment()VerticalAlignment|nullPobiera VerticalAlignment.
getWidth()Number|nullPobiera szerokość kolumny zawierającej komórkę w punktach.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule w określonym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego obiektu blob obrazu w określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w określonym indeksie.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w określonym indeksie.
insertTable(childIndex)TableTworzy i wstawia nowy element Table w określonym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający określone komórki we wskazanym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table w określonym indeksie.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()TableCell|nullŁączy element z poprzednim elementem tego samego typu.
removeChild(child)TableCellUsuwa określony element podrzędny.
removeFromParent()TableCell|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)TableCellUstawia atrybuty elementu.
setBackgroundColor(color)TableCellUstawia kolor tła.
setLinkUrl(url)TableCellUstawia adres URL linku.
setPaddingBottom(paddingBottom)TableCellUstawia dolne dopełnienie w punktach.
setPaddingLeft(paddingLeft)TableCellUstawia dopełnienie z lewej strony w punktach.
setPaddingRight(paddingRight)TableCellUstawia dopełnienie z prawej strony w punktach.
setPaddingTop(paddingTop)TableCellUstawia górne dopełnienie w punktach.
setText(text)TableCellUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)TableCellUstawia wyrównanie tekstu.
setVerticalAlignment(alignment)TableCellUstawia wyrównanie w pionie.
setWidth(width)TableCellUstawia szerokość kolumny zawierającej bieżącą komórkę w punktach.

TableOfContents

Metody

MetodaZwracany typKrótki opis
clear()TableOfContentsUsuwa zawartość elementu.
copy()TableOfContentsZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getLinkUrl()String|nullPobiera adres URL linku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeFromParent()TableOfContents|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)TableOfContentsUstawia atrybuty elementu.
setLinkUrl(url)TableOfContentsUstawia adres URL linku.
setTextAlignment(textAlignment)TableOfContentsUstawia wyrównanie tekstu.

TableRow

Metody

MetodaZwracany typKrótki opis
appendTableCell()TableCellTworzy i dołącza nowy element TableCell.
appendTableCell(textContents)TableCellDołącza podany element TableCell zawierający określony tekst.
appendTableCell(tableCell)TableCellDołącza podany element TableCell.
clear()TableRowUsuwa zawartość elementu.
copy()TableRowZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getCell(cellIndex)TableCell|nullPobiera TableCell w określonym indeksie komórki.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie.
getChildIndex(child)IntegerPobiera indeks elementu podrzędnego dla określonego elementu podrzędnego.
getLinkUrl()String|nullPobiera adres URL linku.
getMinimumHeight()Number|nullPobiera minimalną wysokość w punktach.
getNextSibling()Element|nullPobiera następny element równorzędny.
getNumCells()IntegerPobiera liczbę komórek w wierszu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getParentTable()Table|nullPobiera Table zawierający bieżący wiersz.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getType()ElementTypePobiera ElementType elementu.
insertTableCell(childIndex)TableCellTworzy i wstawia nowy element TableCell w określonym indeksie.
insertTableCell(childIndex, textContents)TableCellWstawia podany element TableCell w określonym indeksie, zawierający podany tekst.
insertTableCell(childIndex, tableCell)TableCellWstawia podany element TableCell w określonym indeksie.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()TableRow|nullŁączy element z poprzednim elementem tego samego typu.
removeCell(cellIndex)TableCellUsuwa TableCell z określonego indeksu komórki.
removeChild(child)TableRowUsuwa określony element podrzędny.
removeFromParent()TableRow|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(attributes)TableRowUstawia atrybuty elementu.
setLinkUrl(url)TableRowUstawia adres URL linku.
setMinimumHeight(minHeight)TableRowUstawia minimalną wysokość w punktach.
setTextAlignment(textAlignment)TableRowUstawia wyrównanie tekstu.

Text

Metody

MetodaZwracany typKrótki opis
appendText(text)TextDodaje określony tekst na końcu tego regionu tekstowego.
copy()TextZwraca odłączoną, głęboką kopię bieżącego elementu.
deleteText(startOffset, endOffsetInclusive)TextUsuwa zakres tekstu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findText(searchPattern)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElement|nullPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getAttributes(offset)ObjectPobiera atrybuty na określonym przesunięciu znaku.
getBackgroundColor()String|nullPobiera ustawienie koloru tła.
getBackgroundColor(offset)String|nullPobiera kolor tła na określonym przesunięciu znaku.
getFontFamily()String|nullPobiera ustawienie rodziny czcionek.
getFontFamily(offset)String|nullPobiera rodzinę czcionek na określonym przesunięciu znaku.
getFontSize()Number|nullPobiera ustawienie rozmiaru czcionki.
getFontSize(offset)Number|nullPobiera rozmiar czcionki na określonym przesunięciu znaku.
getForegroundColor()String|nullPobiera ustawienie koloru pierwszego planu.
getForegroundColor(offset)String|nullPobiera kolor pierwszego planu na określonym przesunięciu znaku.
getLinkUrl()String|nullPobiera adres URL linku.
getLinkUrl(offset)String|nullPobiera adres URL linku na określonym przesunięciu znaku.
getNextSibling()Element|nullPobiera następny element równorzędny.
getParent()ContainerElement|nullPobiera element nadrzędny elementu.
getPreviousSibling()Element|nullPobiera poprzedni element sąsiedni elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignment|nullPobiera wyrównanie tekstu.
getTextAlignment(offset)TextAlignment|nullPobiera wyrównanie tekstu dla pojedynczego znaku.
getTextAttributeIndices()Integer[]Pobiera zbiór indeksów tekstowych odpowiadających początkowi odrębnych serii formatowania tekstu.
getType()ElementTypePobiera ElementType elementu.
insertText(offset, text)TextWstawia określony tekst na podanej pozycji znaku.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isBold()Boolean|nullPobiera ustawienie pogrubienia.
isBold(offset)Boolean|nullPobiera ustawienie pogrubienia na określonym przesunięciu znaku.
isItalic()Boolean|nullPobiera ustawienie kursywy.
isItalic(offset)Boolean|nullPobiera ustawienie kursywy na określonym przesunięciu znaku.
isStrikethrough()Boolean|nullPobiera ustawienie przekreślenia.
isStrikethrough(offset)Boolean|nullPobiera ustawienie przekreślenia na określonym przesunięciu znaku.
isUnderline()Boolean|nullPobiera ustawienie podkreślenia.
isUnderline(offset)Boolean|nullPobiera ustawienie podkreślenia na określonym przesunięciu znaku.
merge()Text|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()Text|nullUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZamienia wszystkie wystąpienia danego wzorca tekstu na dany ciąg zastępczy, korzystając z wyrażeń regularnych.
setAttributes(startOffset, endOffsetInclusive, attributes)TextStosuje określone atrybuty do podanego zakresu znaków.
setAttributes(attributes)TextUstawia atrybuty elementu.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextUstawia kolor tła dla określonego zakresu znaków.
setBackgroundColor(color)TextUstawia kolor tła.
setBold(bold)TextUstawia pogrubienie.
setBold(startOffset, endOffsetInclusive, bold)TextUstawia pogrubienie dla określonego zakresu znaków.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextUstawia rodzinę czcionek dla określonego zakresu znaków.
setFontFamily(fontFamilyName)TextUstawia rodzinę czcionek.
setFontSize(startOffset, endOffsetInclusive, size)TextUstawia rozmiar czcionki dla określonego zakresu znaków.
setFontSize(size)TextUstawia rozmiar czcionki.
setForegroundColor(startOffset, endOffsetInclusive, color)TextUstawia kolor pierwszego planu dla określonego zakresu znaków.
setForegroundColor(color)TextUstawia kolor pierwszego planu.
setItalic(italic)TextUstawia kursywę.
setItalic(startOffset, endOffsetInclusive, italic)TextUstawia kursywę dla określonego zakresu znaków.
setLinkUrl(startOffset, endOffsetInclusive, url)TextUstawia adres URL linku dla określonego zakresu znaków.
setLinkUrl(url)TextUstawia adres URL linku.
setStrikethrough(strikethrough)TextUstawia przekreślenie.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextUstawia przekreślenie dla określonego zakresu znaków.
setText(text)TextUstawia zawartość tekstu.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextUstawia wyrównanie tekstu dla danego zakresu znaków.
setTextAlignment(textAlignment)TextUstawia wyrównanie tekstu.
setUnderline(underline)TextUstawia podkreślenie.
setUnderline(startOffset, endOffsetInclusive, underline)TextUstawia podkreślenie dla określonego zakresu znaków.

TextAlignment

Właściwości

WłaściwośćTypOpis
NORMALEnumWyrównanie zwykłego tekstu.
SUPERSCRIPTEnumWyrównanie tekstu w indeksie górnym.
SUBSCRIPTEnumWyrównanie tekstu indeksu dolnego.

UnsupportedElement

Metody

MetodaZwracany typKrótki opis
copy()UnsupportedElementZwraca 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()UnsupportedElement|nullŁączy element z poprzednim elementem tego samego typu.
removeFromParent()UnsupportedElement|nullUsuwa element z elementu nadrzędnego.
setAttributes(attributes)UnsupportedElementUstawia atrybuty elementu.

VerticalAlignment

Właściwości

WłaściwośćTypOpis
BOTTOMEnumopcję wyrównania do dołu;
CENTEREnumOpcja wyrównania do środka.
TOPEnumOpcja wyrównania do góry.