Document Service

Dokument

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

// 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 zwykły tekst oraz elementy takie jak tabele i listy.
DocumentAppUsługa dokumentu tworzy i otwiera Documents, który można edytować.
DocumentTabKarta dokumentu zawierająca tekst formatowany i elementy takie jak tabele i listy.
ElementOgólny element.
ElementTypeWyliczenie wszystkich typów elementów.
EquationElement reprezentujący wyrażenie matematyczne.
EquationFunctionElement reprezentujący funkcję w ujęciu matematycznym Equation.
EquationFunctionArgumentSeparatorElement reprezentujący separator funkcji w funkcji matematycznej Equation.
EquationSymbolElement reprezentujący symbol w matematycznym Equation.
FontFamilyWyliczenie obsługiwanych czcionek.
FooterSectionElement reprezentujący sekcję stopki.
FootnoteElement reprezentujący przypis.
FootnoteSectionElement reprezentujący sekcję przypisu.
GlyphTypeWyliczenie obsługiwanych typów glifu.
HeaderSectionElement reprezentujący sekcję nagłówka.
HorizontalAlignmentWyliczenie obsługiwanych typów wyrównania poziomego.
HorizontalRuleElement reprezentujący linię poziomą.
InlineDrawingElement reprezentujący osadzony rysunek.
InlineImageElement reprezentujący osadzony obraz.
ListItemElement reprezentujący element listy.
NamedRangeRange, który ma nazwę i identyfikator umożliwiający późniejsze wyszukiwanie.
PageBreakElement reprezentujący podział strony.
ParagraphElement reprezentujący akapit.
ParagraphHeadingWyliczenie standardowych nagłówków akapitów.
PersonElement reprezentujący link do osoby.
PositionOdwołuje się do lokalizacji na karcie dokumentu względem konkretnego elementu.
PositionedImageObraz w stałym miejscu zakotwiczony w elementach Paragraph.
PositionedLayoutWyliczenie określające sposób rozmieszczania elementu PositionedImage w stosunku do otaczającego go tekstu.
RangeZakres elementów w dokumencie.
RangeBuilderBuilder służący do tworzenia obiektów Range z elementów dokumentu.
RangeElementOtoczka dla Element z możliwym przesunięciem początkowym i końcowym.
RichLinkElement reprezentujący link do zasobu Google, takiego jak plik na Dysku lub film w YouTube.
TabKarta w dokumencie w Dokumentach 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 region tekstu sformatowanego.
TextAlignmentWyliczenie typów wyrównania tekstu.
UnsupportedElementElement reprezentujący region, który jest nieznany lub na który skrypt nie może wpływać, np. numer strony.
VerticalAlignmentWyliczenie obsługiwanych typów wyrównania pionowego.

Attribute

Właściwości

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

Body

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dodaje nową wartość HorizontalRule.
appendImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendImage(image)InlineImageDodaje podany parametr InlineImage.
appendListItem(listItem)ListItemDodaje podany parametr ListItem.
appendListItem(text)ListItemTworzy i dodaje nowy element ListItem zawierający określony tekst.
appendPageBreak()PageBreakTworzy i dodaje nową wartość PageBreak.
appendPageBreak(pageBreak)PageBreakDodaje podany parametr PageBreak.
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nowy element Paragraph zawierający określony tekst.
appendTable()TableTworzy i dodaje nową wartość Table.
appendTable(cells)TableDodaje nową wartość Table zawierającą element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDodaje podany parametr Table.
clear()BodyCzyści zawartość elementu.
copy()BodyZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getHeadingAttributes(paragraphHeading)ObjectPobiera zestaw atrybutów dla podanego obiektu ParagraphHeading.
getImages()InlineImage[]Pobiera wszystkie InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie ListItems zawarte w sekcji.
getMarginBottom()NumberPobiera dolny margines w punktach.
getMarginLeft()NumberPobiera lewy margines w punktach.
getMarginRight()NumberPobiera prawy margines.
getMarginTop()NumberPobiera górne marginesy.
getNumChildren()IntegerPobiera liczbę dzieci.
getPageHeight()NumberPobiera wysokość strony w punktach.
getPageWidth()NumberPobiera szerokość strony w punktach.
getParagraphs()Paragraph[]Pobiera wszystkie Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getTables()Table[]Pobiera wszystkie Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule na wskazanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego bloba obrazu na określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem na wskazanej pozycji.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w wybranym miejscu, zawierający podany tekst.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak na wskazanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak na wskazanej pozycji.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph na wskazanej pozycji.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst.
insertTable(childIndex)TableTworzy i wstawia nowy element Table na wskazanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający wskazane komórki w wybranym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table na wskazanej pozycji.
removeChild(child)BodyUsuwa określony element podrzędny.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
setAttributes(attributes)BodyUstawia atrybuty elementu.
setHeadingAttributes(paragraphHeading, attributes)BodyUstawia atrybuty dla podanego obiektu 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 PositionBookmarkDocumentTab.
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()ContainerElementCzyści zawartość elementu.
copy()ContainerElementZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()ContainerElementŁączy element z poprzednim elementem tego samego typu.
removeFromParent()ContainerElementUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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 wyświetlaną wartość renderowaną w dokumencie.
getLocale()StringZwraca ustawioną lokalizację daty, która jest używana do wyświetlania wartości.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getTimestamp()DateZwraca sygnaturę czasową powiązaną z datą.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()DateŁączy element z poprzednim elementem tego samego typu.
removeFromParent()DateUsuwa element z jego elementu nadrzędnego.
setAttributes(attributes)DateUstawia atrybuty elementu.

Document

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje Bookmark w danym Position do pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
addEditor(emailAddress)DocumentDodaje danego użytkownika do listy edytujących Document.
addEditor(user)DocumentDodaje danego użytkownika do listy edytujących Document.
addEditors(emailAddresses)DocumentDodaje podany tablicowy zbiór użytkowników do listy edytujących w przypadku Document.
addFooter()FooterSectionDodaje sekcję stopki, jeśli nie ma żadnej, 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 element NamedRange, czyli element Range z nazwą i identyfikatorem do użycia do późniejszego pobrania, na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
addViewer(emailAddress)DocumentDodaje danego użytkownika do listy widzów Document.
addViewer(user)DocumentDodaje danego użytkownika do listy widzów Document.
addViewers(emailAddresses)DocumentDodaje podany tablicowy zbiór 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 blob określonego typu.
getBlob()BlobPobiera bieżącą zawartość Document jako blob.
getBody()BodyPobiera wartość Body z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, wartość DocumentBodySection z aktywnej karty.
getBookmark(id)BookmarkPobiera Bookmark o danym identyfikatorze na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark z pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, z aktywnej karty.
getCursor()PositionPobiera kursor użytkownika na aktywnej karcie.
getEditors()User[]Pobiera listę edytorów tego Document.
getFooter()FooterSectionPobiera sekcję stopki pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, sekcję stopki aktywnej karty.
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote w ciele pierwszej karty lub, w przypadku skryptów powiązanych z dokumentem, w ciele aktywnej karty.
getHeader()HeaderSectionPobiera 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)NamedRangePobiera NamedRange o danym identyfikatorze na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
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 danej nazwie na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, na aktywnej karcie.
getSelection()RangePobiera wybrany przez użytkownika element na karcie aktywnej.
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 niezawinicowione Tab, które są częścią dokumentu.
getUrl()StringPobiera adres URL dostępu do bieżącego dokumentu.
getViewers()User[]Pobiera listę osób, które oglądały lub komentowały ten Document.
newPosition(element, offset)PositionTworzy nową zmienną Position, która jest odwołaniem do lokalizacji na karcie względem określonego elementu na pierwszej karcie lub, w przypadku skryptów powiązanych z dokumentem, do aktywnej karty.
newRange()RangeBuilderTworzy kreator służący 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)DocumentUsunięcie danego użytkownika z listy edytujących w przypadku Document.
removeEditor(user)DocumentUsunięcie danego użytkownika z listy edytujących w przypadku Document.
removeViewer(emailAddress)DocumentUsunięcie danego użytkownika z listy widzów i komentujących Document.
removeViewer(user)DocumentUsunięcie danego użytkownika z listy widzów i komentujących Document.
saveAndClose()voidZapisuje bieżący Document.
setActiveTab(tabId)voidUstawia wybrany przez użytkownika element Tab w bieżącym dokumencie na kartę o określonym identyfikatorze.
setCursor(position)DocumentUstawia kursor użytkownika na podstawie Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentUstawia tytuł dokumentu.
setSelection(range)DocumentUstawia wybrany przez użytkownika element na karcie aktywnej, pod warunkiem że Range.

DocumentApp

Właściwości

WłaściwośćTypOpis
AttributeAttributeWyliczenie Attribute.
ElementTypeElementTypeWyliczenie ElementType.
FontFamilyFontFamilyWyliczenie FontFamily.
GlyphTypeGlyphTypeWyliczenie GlyphType.
HorizontalAlignmentHorizontalAlignmentWyliczenie HorizontalAlignment.
ParagraphHeadingParagraphHeadingWyliczenie ParagraphHeading.
PositionedLayoutPositionedLayoutWyliczenie PositionedLayout.
TextAlignmentTextAlignmentWyliczenie TextAlignment.
VerticalAlignmentVerticalAlignmentWyliczenie VerticalAlignment.

Metody

MetodaZwracany typKrótki opis
create(name)DocumentTworzy i zwraca nowy dokument.
getActiveDocument()DocumentZwraca dokument, do którego skrypt jest powiązany z kontenerem.
getUi()UiZwraca instancję środowiska interfejsu użytkownika dokumentu, która umożliwia skryptowi dodawanie funkcji takich jak menu, okna dialogowe 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 danym Position.
addFooter()FooterSectionDodaje sekcję stopki karty, jeśli nie ma takiej sekcji.
addHeader()HeaderSectionDodaje sekcję nagłówka karty, jeśli nie ma takiej sekcji.
addNamedRange(name, range)NamedRangeDodaje NamedRange, czyli Range z nazwą i identyfikatorem do użycia do późniejszego wyszukiwania.
getBody()BodyPobiera wartość Body karty.
getBookmark(id)BookmarkPobiera Bookmark o podanym identyfikatorze.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark na karcie.
getFooter()FooterSectionPobiera sekcję stopki karty, jeśli istnieje.
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote w treści karty.
getHeader()HeaderSectionPobiera nagłówek karty, jeśli istnieje.
getNamedRangeById(id)NamedRangePobiera 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 konkretnego elementu.
newRange()RangeBuilderTworzy kreator służący do tworzenia obiektów Range z elementów karty.

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()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()ElementŁączy element z poprzednim elementem tego samego typu.
removeFromParent()ElementUsuwa element z jego 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 wartości UnsupportedElement.

Equation

Metody

MetodaZwracany typKrótki opis
clear()EquationCzyści zawartość elementu.
copy()EquationZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()EquationŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
setAttributes(attributes)EquationUstawia atrybuty elementu.
setLinkUrl(url)EquationUstawia adres URL linku.
setTextAlignment(textAlignment)EquationUstawia wyrównanie tekstu.

EquationFunction

Metody

MetodaZwracany typKrótki opis
clear()EquationFunctionCzyści zawartość elementu.
copy()EquationFunctionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getCode()StringPobiera kod odpowiadający funkcji równania.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()EquationFunctionŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationFunctionUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()EquationFunctionArgumentSeparatorŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationFunctionArgumentSeparatorUsuwa element z jego 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()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()EquationSymbolŁączy element z poprzednim elementem tego samego typu.
removeFromParent()EquationSymbolUsuwa element z jego elementu nadrzędnego.
setAttributes(attributes)EquationSymbolUstawia atrybuty elementu.

FontFamily

FooterSection

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dodaje nową wartość HorizontalRule.
appendImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendImage(image)InlineImageDodaje podany parametr InlineImage.
appendListItem(listItem)ListItemDodaje podany parametr ListItem.
appendListItem(text)ListItemTworzy i dodaje nowy element ListItem zawierający określony tekst.
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nowy element Paragraph zawierający określony tekst.
appendTable()TableTworzy i dodaje nową wartość Table.
appendTable(cells)TableDodaje nową wartość Table zawierającą element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDodaje podany parametr Table.
clear()FooterSectionCzyści zawartość elementu.
copy()FooterSectionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getImages()InlineImage[]Pobiera wszystkie InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getTables()Table[]Pobiera wszystkie Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule na wskazanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego bloba obrazu na określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem na wskazanej pozycji.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w wybranym miejscu, zawierający podany tekst.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph na wskazanej pozycji.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst.
insertTable(childIndex)TableTworzy i wstawia nowy element Table na wskazanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający wskazane komórki w wybranym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table na wskazanej pozycji.
removeChild(child)FooterSectionUsuwa określony element podrzędny.
removeFromParent()FooterSectionUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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()FootnoteSectionPobiera zawartość elementu przypisu.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeFromParent()FootnoteUsuwa element z jego elementu nadrzędnego.
setAttributes(attributes)FootnoteUstawia atrybuty elementu.

FootnoteSection

Metody

MetodaZwracany typKrótki opis
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nowy element Paragraph zawierający określony tekst.
clear()FootnoteSectionCzyści zawartość elementu.
copy()FootnoteSectionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph na wskazanej pozycji.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst.
removeChild(child)FootnoteSectionUsuwa określony element podrzędny.
removeFromParent()FootnoteSectionUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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ślna kula, okrągła i wypełniona.
HOLLOW_BULLETEnumPusty punktor.
SQUARE_BULLETEnumPunktor kwadratowy.
NUMBEREnumPunktor z liczbą.
LATIN_UPPEREnumWielka litera A w ramce.
LATIN_LOWEREnummała litera łacińska,
ROMAN_UPPEREnumRzymska cyfra, pogrubiona litera.
ROMAN_LOWEREnumRzymska cyfra, mała litera w kółku.

HeaderSection

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dodaje nową wartość HorizontalRule.
appendImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendImage(image)InlineImageDodaje podany parametr InlineImage.
appendListItem(listItem)ListItemDodaje podany parametr ListItem.
appendListItem(text)ListItemTworzy i dodaje nowy element ListItem zawierający określony tekst.
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nowy element Paragraph zawierający określony tekst.
appendTable()TableTworzy i dodaje nową wartość Table.
appendTable(cells)TableDodaje nową wartość Table zawierającą element TableCell dla każdej określonej wartości ciągu znaków.
appendTable(table)TableDodaje podany parametr Table.
clear()HeaderSectionCzyści zawartość elementu.
copy()HeaderSectionZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getImages()InlineImage[]Pobiera wszystkie InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny.
getTables()Table[]Pobiera wszystkie Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule na wskazanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego bloba obrazu na określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem na wskazanej pozycji.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w wybranym miejscu, zawierający podany tekst.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph na wskazanej pozycji.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w wybranym miejscu, zawierający podany tekst.
insertTable(childIndex)TableTworzy i wstawia nowy element Table na wskazanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający wskazane komórki w wybranym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table na wskazanej pozycji.
removeChild(child)HeaderSectionUsuwa określony element podrzędny.
removeFromParent()HeaderSectionUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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.
RIGHTEnumOpcja wyrównania do prawej.
JUSTIFYEnumOpcja wyrównania do lewej.

HorizontalRule

Metody

MetodaZwracany typKrótki opis
copy()HorizontalRuleZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeFromParent()HorizontalRuleUsuwa element z jego 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()StringZwraca alternatywny opis rysunku.
getAltTitle()StringZwraca alternatywny tytuł rysunku.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()InlineDrawingŁączy element z poprzednim elementem tego samego typu.
removeFromParent()InlineDrawingUsuwa element z jego 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()StringZwraca alternatywny opis obrazu.
getAltTitle()StringZwraca alternatywny tytuł obrazu.
getAs(contentType)BlobZwraca dane z tego obiektu jako blob przekonwertowany na określony typ treści.
getAttributes()ObjectPobiera atrybuty elementu.
getBlob()BlobZwraca dane z tego obiektu jako blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()InlineImageŁączy element z poprzednim elementem tego samego typu.
removeFromParent()InlineImageUsuwa element z jego elementu nadrzędnego.
setAltDescription(description)InlineImageUstawia alternatywny opis obrazu.
setAltTitle(title)InlineImageUstawia tytuł alternatywny obrazu.
setAttributes(attributes)InlineImageUstawia atrybuty elementu.
setHeight(height)InlineImageOkreśla 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 element PositionedImage z określonego bloba obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dodaje nową wartość HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendInlineImage(image)InlineImageDodaje podany parametr InlineImage.
appendPageBreak()PageBreakTworzy i dodaje nową wartość PageBreak.
appendPageBreak(pageBreak)PageBreakDodaje podany parametr PageBreak.
appendText(text)TextTworzy i dodaje nowy element Text z określonymi treściami.
appendText(text)TextDodaje podany element Text.
clear()ListItemCzyści zawartość elementu.
copy()ListItemZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAlignment()HorizontalAlignmentPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getGlyphType()GlyphTypePobiera wartość atrybutu GlyphType elementu listy.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera wcięcie końcowe w punktach.
getIndentFirstLine()NumberPobiera wcięcie pierwszego wiersza w punktach.
getIndentStart()NumberPobiera wcięcie początkowe.
getLineSpacing()NumberPobiera odstęp między wierszami w punktach.
getLinkUrl()StringPobiera adres URL linku.
getListId()StringPobiera identyfikator listy.
getNestingLevel()IntegerPobiera poziom zagnieżdżenia elementu listy.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getPositionedImage(id)PositionedImagePobiera PositionedImage według identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getSpacingAfter()NumberPobiera odstęp po elemencie w punktach.
getSpacingBefore()NumberPobiera odstęp przed elementem w punktach.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia element HorizontalRule na wskazanym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy element InlineImage z określonego bloba obrazu na wskazanym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak na wskazanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak na wskazanej pozycji.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy na określonym indeksie.
insertText(childIndex, text)TextWstawia podany element Text w wybranym indeksie z wybranym tekstem.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isLeftToRight()BooleanPobiera ustawienie tekstu od lewej do prawej.
merge()ListItemŁączy element z poprzednim elementem tego samego typu.
removeChild(child)ListItemUsuwa określony element podrzędny.
removeFromParent()ListItemUsuwa element z jego elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa PositionedImage według identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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 wypełnienia.
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ść pozycji 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 elementem NamedRange.
remove()voidUsuwa z karty element NamedRange.

PageBreak

Metody

MetodaZwracany typKrótki opis
copy()PageBreakZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeFromParent()PageBreakUsuwa element z jego elementu nadrzędnego.
setAttributes(attributes)PageBreakUstawia atrybuty elementu.

Paragraph

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy element PositionedImage z określonego bloba obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dodaje nową wartość HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendInlineImage(image)InlineImageDodaje podany parametr InlineImage.
appendPageBreak()PageBreakTworzy i dodaje nową wartość PageBreak.
appendPageBreak(pageBreak)PageBreakDodaje podany parametr PageBreak.
appendText(text)TextTworzy i dodaje nowy element Text z określonymi treściami.
appendText(text)TextDodaje podany element Text.
clear()ParagraphCzyści zawartość elementu.
copy()ParagraphZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAlignment()HorizontalAlignmentPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera wcięcie końcowe w punktach.
getIndentFirstLine()NumberPobiera wcięcie pierwszego wiersza w punktach.
getIndentStart()NumberPobiera wcięcie początkowe.
getLineSpacing()NumberPobiera odstęp między wierszami w punktach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getPositionedImage(id)PositionedImagePobiera PositionedImage według identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone w akapicie.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getSpacingAfter()NumberPobiera odstęp po elemencie w punktach.
getSpacingBefore()NumberPobiera odstęp przed elementem w punktach.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia element HorizontalRule na wskazanym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy element InlineImage z określonego bloba obrazu na wskazanym indeksie.
insertInlineImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy element PageBreak na wskazanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podany element PageBreak na wskazanej pozycji.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy na określonym indeksie.
insertText(childIndex, text)TextWstawia podany element Text w wybranym indeksie z wybranym tekstem.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isLeftToRight()BooleanPobiera ustawienie tekstu od lewej do prawej.
merge()ParagraphŁączy element z poprzednim elementem tego samego typu.
removeChild(child)ParagraphUsuwa określony element podrzędny.
removeFromParent()ParagraphUsuwa element z jego elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa PositionedImage według identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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 wypełnienia.
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ższa opcja nagłówka.
HEADING2EnumDruga opcja nagłówka.
HEADING3EnumTrzecia opcja nagłówka
HEADING4EnumCzwarta opcja nagłówka.
HEADING5EnumPiąta opcja nagłówka.
HEADING6EnumNajniższa opcja nagłówka.
TITLEEnumOpcja nagłówka tytułu.
SUBTITLEEnumOpcja nagłówka napisów.

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 tej osoby.
getName()StringZwraca wyświetlaną nazwę osoby, jeśli została określona.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()PersonŁączy element z poprzednim elementem tego samego typu.
removeFromParent()PersonUsuwa element z jego elementu nadrzędnego.
setAttributes(attributes)PersonUstawia atrybuty elementu.

Position

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera element zawierający ten element Position.
getOffset()IntegerPobiera względną pozycję tego Position w elemencie, który go zawiera.
getSurroundingText()TextTworzy sztuczny element Text, który reprezentuje tekst i formatowanie elementu Paragraph lub ListItem, który zawiera element Position, bezpośrednio lub za pomocą ciągu elementów podrzędnych.
getSurroundingTextOffset()IntegerPobiera przesunięcie tego elementu Position w elemencie Text zwracanym przez funkcję getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowe Bookmark w tym Position.
insertInlineImage(image)InlineImageTworzy i wstawia nowy element InlineImage w tym Position z wybranego pliku blob obrazu.
insertText(text)TextWstawia określony tekst w tym miejscu Position.

PositionedImage

Metody

MetodaZwracany typKrótki opis
getAs(contentType)BlobZwraca dane z tego obiektu jako blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane z tego obiektu jako blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getId()StringPobiera identyfikator obrazu.
getLayout()PositionedLayoutPobiera wartość typu enum, która reprezentuje sposób rozmieszczenia obrazu.
getLeftOffset()NumberPobiera przesunięcie obrazu (w punktach) od lewej strony akapitu.
getParagraph()ParagraphPobiera Paragraph, do którego jest zakotwiczony obraz.
getTopOffset()NumberZwraca odsunięcie obrazu w punktach od góry akapitu.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
setHeight(height)PositionedImageOkreśla wysokość obrazu w pikselach.
setLayout(layout)PositionedImageOkreśla sposób rozmieszczenia obrazu.
setLeftOffset(offset)PositionedImageUstawia przesunięcie obrazu w punktach od lewej strony akapitu.
setTopOffset(offset)PositionedImageUstawia odsunięcie obrazu (w punktach) od góry akapitu.
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 po prawej stronie.
BREAK_LEFTEnumObraz przerywa tekst po lewej stronie.
BREAK_RIGHTEnumObraz przerywa tekst po prawej stronie.
WRAP_TEXTEnumObraz jest zawijany przez tekst.

Range

Metody

MetodaZwracany typKrótki opis
getRangeElements()RangeElement[]Pobiera wszystkie elementy tego elementu Range, w tym elementy częściowe Text (np. w przypadku zaznaczenia obejmującego tylko część elementu Text).

RangeBuilder

Metody

MetodaZwracany typKrótki opis
addElement(element)RangeBuilderDodaje całą listę Element do tej listy RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderDodaje do tego RangeBuilder częściowy element Text.
addElementsBetween(startElement, endElementInclusive)RangeBuilderDodaje do tego RangeBuilder 2 całe elementy i wszystkie elementy między nimi.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderDo elementu RangeBuilder dodaje 2 częściowe elementy Text oraz wszystkie elementy między nimi.
addRange(range)RangeBuilderDodaje zawartość innej Range do tej RangeBuilder.
build()RangeTworzy Range na podstawie ustawień zastosowanych w kreatorze.
getRangeElements()RangeElement[]Pobiera wszystkie elementy tego elementu Range, w tym elementy częściowe Text (np. w przypadku zaznaczenia obejmującego tylko część elementu Text).

RangeElement

Metody

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

Metody

MetodaZwracany typKrótki opis
copy()RichLinkZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getMimeType()StringZwraca typ MIME linku, który jest dostępny, gdy element jest linkiem do pliku na Dysku, a w innym przypadku null.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getTitle()StringZwraca wyświetlany tytuł linku.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
getUrl()StringZwraca adres URL zasobu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()RichLinkŁączy element z poprzednim elementem tego samego typu.
removeFromParent()RichLinkUsuwa element z jego 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 w tej karcie.
getId()StringPobiera identyfikator karty.
getIndex()IntegerPobiera indeks karty w rodzicu (liczony od 0).
getTitle()StringPobiera tytuł karty.
getType()TabTypePobiera typ karty.

TabType

Właściwości

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

Table

Metody

MetodaZwracany typKrótki opis
appendTableRow()TableRowTworzy i dodaje nową wartość TableRow.
appendTableRow(tableRow)TableRowDodaje podany parametr TableRow.
clear()TableCzyści zawartość elementu.
copy()TableZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getBorderColor()StringPobiera kolor obramowania.
getBorderWidth()NumberPobiera szerokość obramowania w punktach.
getCell(rowIndex, cellIndex)TableCellPobiera wartość TableCell w określonych indeksach wiersza i komórki.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getColumnWidth(columnIndex)NumberPobiera szerokość określonej kolumny tabeli w punktach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getNumRows()IntegerPobiera liczbę TableRows.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getRow(rowIndex)TableRowPobiera element TableRow w określonym indeksie wiersza.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertTableRow(childIndex)TableRowTworzy i wstawia nowy element TableRow na wskazanym indeksie.
insertTableRow(childIndex, tableRow)TableRowWstawia podany element TableRow na wskazanej pozycji.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeChild(child)TableUsuwa określony element podrzędny.
removeFromParent()TableUsuwa element z jego elementu nadrzędnego.
removeRow(rowIndex)TableRowUsuwa TableRow w określonym indeksie wiersza.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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 dodaje nową wartość HorizontalRule.
appendImage(image)InlineImageTworzy i dodaje nowy element InlineImage z określonego bloba obrazu.
appendImage(image)InlineImageDodaje podany parametr InlineImage.
appendListItem(listItem)ListItemDodaje podany parametr ListItem.
appendListItem(text)ListItemTworzy i dodaje nową wartość ListItem.
appendParagraph(paragraph)ParagraphDodaje podany parametr Paragraph.
appendParagraph(text)ParagraphTworzy i dodaje nową wartość Paragraph.
appendTable()TableTworzy i dodaje nową wartość Table.
appendTable(cells)TableDodaje nowy element Table zawierający wskazane komórki.
appendTable(table)TableDodaje podany parametr Table.
clear()TableCellCzyści zawartość elementu.
copy()TableCellZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getBackgroundColor()StringPobiera kolor tła.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getColSpan()IntegerPobiera zakres kolumny, czyli liczbę kolumn komórek tabeli, które obejmuje ta komórka.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getPaddingBottom()NumberPobiera wartość dolnej wypełnienia w punktach.
getPaddingLeft()NumberPobiera wartość wypełnienia z lewej strony w punktach.
getPaddingRight()NumberPobiera wartość dopełnienia z prawej strony w punktach.
getPaddingTop()NumberPobiera wartość górnego dopełnienia w punktach.
getParent()ContainerElementPobiera element nadrzędny.
getParentRow()TableRowPobiera TableRow zawierający bieżący TableCell.
getParentTable()TablePobiera Table zawierający bieżący TableCell.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getRowSpan()IntegerPobiera zakres wierszy, czyli liczbę wierszy komórek tabeli, które obejmuje dana komórka.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
getVerticalAlignment()VerticalAlignmentPobiera VerticalAlignment.
getWidth()NumberPobiera szerokość kolumny zawierającej komórkę w punktach.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy element HorizontalRule na wskazanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia InlineImage z określonego bloba obrazu na określonym indeksie.
insertImage(childIndex, image)InlineImageWstawia podany element InlineImage na wskazanej pozycji.
insertListItem(childIndex, listItem)ListItemWstawia podany element ListItem na wskazanej pozycji.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem na wskazanym indeksie.
insertParagraph(childIndex, paragraph)ParagraphWstawia podany element Paragraph na wskazanej pozycji.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph na wskazanym indeksie.
insertTable(childIndex)TableTworzy i wstawia nowy element Table na wskazanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy element Table zawierający wskazane komórki w wybranym indeksie.
insertTable(childIndex, table)TableWstawia podany element Table na wskazanej pozycji.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()TableCellŁączy element z poprzednim elementem tego samego typu.
removeChild(child)TableCellUsuwa określony element podrzędny.
removeFromParent()TableCellUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
setAttributes(attributes)TableCellUstawia atrybuty elementu.
setBackgroundColor(color)TableCellUstawia kolor tła.
setLinkUrl(url)TableCellUstawia adres URL linku.
setPaddingBottom(paddingBottom)TableCellUstawia dopełnienie dolne w punktach.
setPaddingLeft(paddingLeft)TableCellUstawia wypełnienie z lewej strony w punktach.
setPaddingRight(paddingRight)TableCellUstawia prawe wypełnienie w punktach.
setPaddingTop(paddingTop)TableCellUstawia dopełnienie góry 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()TableOfContentsCzyści zawartość elementu.
copy()TableOfContentsZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
removeFromParent()TableOfContentsUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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 dodaje nową wartość TableCell.
appendTableCell(textContents)TableCellDodaje do podanego elementu TableCell określony tekst.
appendTableCell(tableCell)TableCellDodaje podany parametr TableCell.
clear()TableRowCzyści zawartość elementu.
copy()TableRowZwraca odłączoną, głęboką kopię bieżącego elementu.
editAsText()TextPobiera wersję Text bieżącego elementu do edycji.
findElement(elementType)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem potomka określonego typu, zaczynając od określonego elementu RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getCell(cellIndex)TableCellPobiera wartość TableCell w określonym indeksie komórki.
getChild(childIndex)ElementPobiera element podrzędny o określonym indeksie podrzędnym.
getChildIndex(child)IntegerPobiera indeks podrzędnego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getMinimumHeight()NumberPobiera minimalną wysokość w punktach.
getNextSibling()ElementPobiera następny element nadrzędny.
getNumCells()IntegerPobiera liczbę komórek w wierszu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny.
getParentTable()TablePobiera element Table zawierający bieżący wiersz.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertTableCell(childIndex)TableCellTworzy i wstawia nowy element TableCell na wskazanym indeksie.
insertTableCell(childIndex, textContents)TableCellWstawia podany element TableCell w wybranym indeksie, zawierając określony tekst.
insertTableCell(childIndex, tableCell)TableCellWstawia podany element TableCell na wskazanej pozycji.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()TableRowŁączy element z poprzednim elementem tego samego typu.
removeCell(cellIndex)TableCellUsuwa TableCell w określonym indeksie komórki.
removeChild(child)TableRowUsuwa określony element podrzędny.
removeFromParent()TableRowUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstowego za pomocą wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzoru tekstowego, zaczynając od danego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getAttributes(offset)ObjectPobiera atrybuty w określonym przesunięciu znaków.
getBackgroundColor()StringPobiera ustawienie koloru tła.
getBackgroundColor(offset)StringPobiera kolor tła w określonym przesunięciu znaków.
getFontFamily()StringPobiera ustawienie rodziny czcionek.
getFontFamily(offset)StringPobiera rodzinę czcionek w określonym przesunięciu znaków.
getFontSize()NumberPobiera ustawienie rozmiaru czcionki.
getFontSize(offset)NumberPobiera rozmiar czcionki w określonym przesunięciu znaku.
getForegroundColor()StringPobiera ustawienie koloru pierwszego planu.
getForegroundColor(offset)StringPobiera kolor pierwszego planu w określonym przesunięciu znaków.
getLinkUrl()StringPobiera adres URL linku.
getLinkUrl(offset)StringPobiera adres URL linku w określonym przesunięciu znaków.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getTextAlignment(offset)TextAlignmentPobiera wyrównanie tekstu dla pojedynczego znaku.
getTextAttributeIndices()Integer[]Pobiera zbiór indeksów tekstowych odpowiadających początkowi poszczególnych przebiegów formatowania tekstu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
insertText(offset, text)TextWstawia określony tekst w danym przesunięciu znaków.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
isBold()BooleanPobiera ustawienie pogrubienia.
isBold(offset)BooleanPobiera ustawienie pogrubienia w określonym przesunięciu znaku.
isItalic()BooleanPobiera ustawienie kursywy.
isItalic(offset)BooleanPobiera ustawienie kursywy w określonym przesunięciu znaku.
isStrikethrough()BooleanPobiera ustawienie przekreślenia.
isStrikethrough(offset)BooleanPobiera ustawienie przekreślenia w określonym przesunięciu znaku.
isUnderline()BooleanPobiera ustawienie podkreślenia.
isUnderline(offset)BooleanPobiera ustawienie podkreślenia w określonym przesunięciu znaków.
merge()TextŁączy element z poprzednim elementem tego samego typu.
removeFromParent()TextUsuwa element z jego elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZa pomocą wyrażeń regularnych zastępuje wszystkie wystąpienia danego wzorca tekstowego podanym ciągiem tekstowym.
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 podanego zakresu znaków.
setBackgroundColor(color)TextUstawia kolor tła.
setBold(bold)TextUstawia pogrubienie.
setBold(startOffset, endOffsetInclusive, bold)TextUstawia ustawienie pogrubionego tekstu w wybranym zakresie 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 w przypadku podanego 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ę w przypadku podanego zakresu znaków.
setLinkUrl(startOffset, endOffsetInclusive, url)TextUstawia adres URL linku dla podanego zakresu znaków.
setLinkUrl(url)TextUstawia adres URL linku.
setStrikethrough(strikethrough)TextUstawia ustawienie przekreślenia.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextUstawia ustawienie przekreślenia dla podanego zakresu znaków.
setText(text)TextUstawia zawartość tekstową.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextOkreśla wyrównanie tekstu w danym zakresie znaków.
setTextAlignment(textAlignment)TextUstawia wyrównanie tekstu.
setUnderline(underline)TextUstawia ustawienie podkreślenia.
setUnderline(startOffset, endOffsetInclusive, underline)TextUstawia ustawienie podkreślenia dla określonego zakresu znaków.

TextAlignment

Właściwości

WłaściwośćTypOpis
NORMALEnumWyrównanie tekstu domyślne.
SUPERSCRIPTEnumWyrównanie tekstu w indeksie górnym.
SUBSCRIPTEnumWyrównanie tekstu w indeksie dolnym.

UnsupportedElement

Metody

MetodaZwracany typKrótki opis
copy()UnsupportedElementZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera następny element nadrzędny.
getParent()ContainerElementPobiera element nadrzędny.
getPreviousSibling()ElementPobiera poprzedni element nadrzędny elementu.
getType()ElementTypePobiera wartość atrybutu ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element znajduje się na końcu Document.
merge()UnsupportedElementŁączy element z poprzednim elementem tego samego typu.
removeFromParent()UnsupportedElementUsuwa element z jego elementu nadrzędnego.
setAttributes(attributes)UnsupportedElementUstawia atrybuty elementu.

VerticalAlignment

Właściwości

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