Document Service

Dokument

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

// 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.
BodyZawartość karty w dokumencie Dokumentów Google.
BookmarkObiekt reprezentujący zakładkę.
ContainerElementOgólny element, 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 takie jak tabele i listy.
DocumentAppUsługa dokumentów tworzy i otwiera plik Documents, który można edytować.
DocumentTabKarta dokumentu zawierająca tekst sformatowany i elementy takie jak tabele i listy.
ElementElement ogólny.
ElementTypeLista wszystkich typów elementów.
EquationElement reprezentujący wyrażenie matematyczne.
EquationFunctionElement reprezentujący funkcję w Equation.
EquationFunctionArgumentSeparatorElement reprezentujący separator funkcji w funkcji matematycznej Equation.
EquationSymbolElement reprezentujący symbol w Equation.
FontFamilyLista obsługiwanych czcionek.
FooterSectionElement reprezentujący sekcję stopki.
FootnoteElement reprezentujący przypis.
FootnoteSectionElement reprezentujący sekcję przypisu.
GlyphTypeLista obsługiwanych typów glifów.
HeaderSectionElement reprezentujący sekcję nagłówka.
HorizontalAlignmentLista obsługiwanych typów wyrównania w poziomie.
HorizontalRuleElement reprezentujący regułę poziomą.
InlineDrawingElement reprezentujący osadzony rysunek.
InlineImageElement reprezentujący osadzony obraz.
ListItemElement reprezentujący element listy.
NamedRangeRange z nazwą i identyfikatorem umożliwiającym późniejsze pobranie.
PageBreakElement reprezentujący podział strony.
ParagraphElement reprezentujący akapit.
ParagraphHeadingLista standardowych nagłówków akapitów.
PersonElement reprezentujący link do osoby.
PositionOdwołanie do lokalizacji na karcie dokumentu względem konkretnego elementu.
PositionedImageObraz o stałej pozycji zakotwiczony w elemencie Paragraph.
PositionedLayoutWyliczenie, które określa sposób ułożenia elementu PositionedImage w odniesieniu do otoczenia tekstu.
RangeZakres elementów w dokumencie.
RangeBuilderKreator używany do tworzenia obiektów Range z elementów dokumentu.
RangeElementKod wokół elementu Element z możliwym przesunięciem początku i końca.
RichLinkElement reprezentujący link do zasobu Google, np. do pliku na Dysku lub filmu w YouTube.
TabKarta w dokumencie w Dokumentach Google.
TabTypeLista 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.
TextAlignmentLista typów wyrównań tekstu.
UnsupportedElementElement reprezentujący region, który jest nieznany lub na który skrypt nie może mieć wpływu, np. numer strony.
VerticalAlignmentLista obsługiwanych typów wyrównania w pionie.

Attribute

Właściwości

WłaściwośćTypOpis
BACKGROUND_COLOREnumKolor tła elementu (akapitu, tabeli itp.) lub dokumentu.
BOLDEnumUstawienie grubości czcionki dla tekstu sformatowanego.
BORDER_COLOREnumKolor obramowania elementów tabeli.
BORDER_WIDTHEnumSzerokość obramowania elementów tabeli w punktach.
CODEEnumZawartość kodu 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 elementów akapitu (np. DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumUstawienie wysokości elementów graficznych.
HORIZONTAL_ALIGNMENTEnumWyrównanie w poziomie elementów akapitu (np. DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumUstawienie wcięcia końcowego w punktach dla elementów akapitu.
INDENT_FIRST_LINEEnumUstawienie wcięcia pierwszego wiersza w punktach dla elementów akapitu.
INDENT_STARTEnumUstawienie wcięcia początkowego w punktach dla elementów akapitu.
ITALICEnumUstawienie stylu czcionki dla tekstu sformatowanego.
GLYPH_TYPEEnumTyp glifu na potrzeby elementów elementu listy.
LEFT_TO_RIGHTEnumUstawienie kierunku tekstu dla tekstu sformatowanego.
LINE_SPACINGEnumUstawienie odstępów między wierszami jako mnożnik elementów akapitu.
LINK_URLEnumAdres URL linku w przypadku tekstu sformatowanego.
LIST_IDEnumIdentyfikator listy nadrzędnej na potrzeby elementów elementu 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 listy.
MINIMUM_HEIGHTEnumMinimalne ustawienie wysokości elementów wiersza tabeli w punktach.
PADDING_BOTTOMEnumDolne ustawienie dopełnienia w punktach dla elementów komórek tabeli.
PADDING_LEFTEnumUstawienie dopełnienia z lewej strony w punktach dla elementów komórek tabeli.
PADDING_RIGHTEnumUstawienie dopełnienia prawego w punktach dla elementów komórek tabeli.
PADDING_TOPEnumUstawienie dopełnienia górnego w punktach dla elementów komórek tabeli.
PAGE_HEIGHTEnumUstawienie wysokości strony w punktach dla dokumentów.
PAGE_WIDTHEnumUstawienie szerokości strony w punktach dla dokumentów.
SPACING_AFTEREnumUstawienie odstępów u dołu w punktach dla elementów akapitu.
SPACING_BEFOREEnumUstawienie odstępów u góry strony w punktach dla elementów akapitu.
STRIKETHROUGHEnumUstawienie przekreślenia w przypadku tekstu sformatowanego.
UNDERLINEEnumUstawienie podkreślenia w przypadku tekstu sformatowanego.
VERTICAL_ALIGNMENTEnumUstawienie wyrównania w pionie elementów komórek tabeli.
WIDTHEnumUstawienie szerokości komórek tabeli i elementów graficznych.

Body

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podaną wartość InlineImage.
appendListItem(listItem)ListItemDołącza podaną wartość ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podaną wartość PageBreak.
appendParagraph(paragraph)ParagraphDołącza podaną wartość Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu.
appendTable(table)TableDołącza podaną wartość 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getHeadingAttributes(paragraphHeading)ObjectPobiera zestaw atrybutów dla podanego elementu ParagraphHeading.
getImages()InlineImage[]Pobiera wszystkie zasoby InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie zasoby ListItems zawarte w sekcji.
getMarginBottom()NumberPobiera dolny margines (w punktach).
getMarginLeft()NumberPobiera lewy margines (w punktach).
getMarginRight()NumberPobiera prawy margines.
getMarginTop()NumberPobiera górny margines.
getNumChildren()IntegerPobiera liczbę dzieci.
getPageHeight()NumberPobiera wysokość strony w punktach.
getPageWidth()NumberPobiera szerokość strony w punktach.
getParagraphs()Paragraph[]Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny elementu.
getTables()Table[]Pobiera wszystkie zasoby Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy HorizontalRule w podanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podaną wartość ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks zawartość tekstową.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy PageBreak w podanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podaną wartość PageBreak w określonym indeksie.
insertParagraph(childIndex, paragraph)ParagraphWstawia podaną wartość Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks zawartość tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy Table w podanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie.
insertTable(childIndex, table)TableWstawia podaną wartość Table w określonym indeksie.
removeChild(child)BodyUsuwa określony element podrzędny.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)BodyUstawia atrybuty elementu.
setHeadingAttributes(paragraphHeading, attributes)BodyUstawia atrybuty dla podanego elementu 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)BodyOkreśla wysokość strony w punktach.
setPageWidth(pageWidth)BodyOkreśla szerokość strony w punktach.
setText(text)BodyUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)BodyOkreśla wyrównanie tekstu.

Bookmark

Metody

MetodaZwracany typKrótki opis
getId()StringPobiera identyfikator elementu Bookmark.
getPosition()PositionPobiera wartość Position funkcji 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()ContainerElementScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()ContainerElementUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)ContainerElementUstawia atrybuty elementu.
setLinkUrl(url)ContainerElementUstawia adres URL linku.
setTextAlignment(textAlignment)ContainerElementOkreśla 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ą wyrenderowaną w dokumencie.
getLocale()StringZwraca język daty używany dla wyświetlanej wartości.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getTimestamp()DateZwraca sygnaturę czasową powiązaną z datą.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()DateScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()DateUsuwa element z elementu nadrzędnego.
setAttributes(attributes)DateUstawia atrybuty elementu.

Document

Metody klasy Document, które uzyskują bezpośredni dostęp do tekstu i modyfikują tekst, działają na aktywnej karcie (w skryptach powiązanych z konkretnym dokumentem) lub na pierwszej karcie (jeśli aktywna nie jest dostępna). Skrypty korzystające z tych metod (np. Document.getBody()) można zaktualizować, tak aby obsługiwały jedną z tych kart:

  • Użyj pierwszej karty: Document.getTabs()[0].asDocumentTab().getBody()
  • Używanie wszystkich kart: poruszaj się po drzewie kart za pomocą narzędzi Document.getTabs() i Tab.getChildTabs(). Dla każdej karty w drzewie wywołaj Tab.asDocumentTab().getBody()
  • Użyj wybranej karty: Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
    • Uwaga: jeśli aktywna karta nie została ustawiona przez skrypt za pomocą metody Document.setActiveTab(tabId), powoduje to wyświetlenie błędu.
  • Użyj konkretnej karty: Document.getTab(TAB_ID).asDocumentTab().getBody()

Więcej informacji o funkcji kart znajdziesz w artykule Praca z kartami.

Metody

MetodaZwracany typKrótki opis
addBookmark(position)BookmarkDodaje element Bookmark w danym Position na pierwszej karcie lub w przypadku skryptów, które są powiązane z dokumentem – aktywną kartą.
addEditor(emailAddress)DocumentDodaje danego użytkownika do listy edytorów zasobu Document.
addEditor(user)DocumentDodaje danego użytkownika do listy edytorów zasobu Document.
addEditors(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy edytorów zasobu Document.
addFooter()FooterSectionDodaje sekcję stopki (jeśli nie ma takiej opcji) do pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – do aktywnej karty.
addHeader()HeaderSectionDodaje sekcję nagłówka (jeśli nie ma takiej opcji) do pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – do aktywnej karty.
addNamedRange(name, range)NamedRangeDodaje obiekt NamedRange, który jest wartością Range, która ma nazwę i identyfikator dla pobierania na pierwszej karcie lub – w przypadku skryptów powiązanych z dokumentem – na aktywnej karcie.
addViewer(emailAddress)DocumentDodaje danego użytkownika do listy przeglądających w: Document.
addViewer(user)DocumentDodaje danego użytkownika do listy przeglądających w: Document.
addViewers(emailAddresses)DocumentDodaje podaną tablicę użytkowników do listy przeglądających obiekt Document.
getActiveTab()TabPobiera w dokumencie aktywne Tab użytkownika.
getAs(contentType)BlobPobiera bieżącą zawartość Document jako obiekt blob określonego typu.
getBlob()BlobPobiera bieżącą zawartość Document jako obiekt blob.
getBody()BodyPobiera wartość Body pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – uprawnienia DocumentBodySection aktywnej karty.
getBookmark(id)BookmarkPobiera element Bookmark z podanym identyfikatorem na pierwszej karcie lub aktywną kartę (w przypadku skryptów powiązanych z dokumentem).
getBookmarks()Bookmark[]Pobiera wszystkie obiekty Bookmark z pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – aktywną kartę.
getCursor()PositionPobiera kursor użytkownika na aktywnej karcie.
getEditors()User[]Pobiera listę edytorów elementu Document.
getFooter()FooterSectionPobiera sekcję stopki pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – stopkę aktywnej karty. .
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote z treści pierwszej karty lub w przypadku skryptów powiązanych z dokumentem treść aktywnej karty.
getHeader()HeaderSectionPobiera sekcję nagłówka pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – nagłówek aktywnej karty. .
getId()StringPobiera unikalny identyfikator dokumentu.
getLanguage()StringPobiera kod języka dokumentu.
getName()StringPobiera tytuł dokumentu.
getNamedRangeById(id)NamedRangePobiera element NamedRange z podanym identyfikatorem na pierwszej karcie lub aktywną kartę (w przypadku skryptów powiązanych z dokumentem).
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty NamedRange z pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – aktywną kartę.
getNamedRanges(name)NamedRange[]Pobiera wszystkie obiekty NamedRange o danej nazwie na pierwszej karcie lub w przypadku skryptów, które są powiązane z dokumentem – aktywną kartą.
getSelection()RangePobiera elementy wybrane przez użytkownika z aktywnej karty.
getSupportedLanguageCodes()String[]Pobiera wszystkie kody języków obsługiwane w plikach Dokumentów Google.
getTab(tabId)TabPobiera obiekt Tab o podanym identyfikatorze.
getTabs()Tab[]Pobiera wszystkie niezagnieżdżone obiekty Tab, które są częścią dokumentu.
getUrl()StringPobiera adres URL umożliwiający dostęp do bieżącego dokumentu.
getViewers()User[]Pobiera listę przeglądających i komentujących dla elementu Document.
newPosition(element, offset)PositionTworzy nowy obiekt Position, który jest odwołaniem do lokalizacji na karcie względem konkretnego elementu na pierwszej karcie lub – w przypadku skryptów powiązanych z dokumentem – aktywnej karty.
newRange()RangeBuilderTworzy kreator służący do tworzenia obiektów Range z elementów karty w pierwszej karty lub w przypadku skryptów powiązanych z tagiem aktywnej karty.
removeEditor(emailAddress)DocumentUsuwa danego użytkownika z listy edytorów zasobu Document.
removeEditor(user)DocumentUsuwa danego użytkownika z listy edytorów zasobu Document.
removeViewer(emailAddress)DocumentUsuwa dane użytkownika z listy przeglądających i komentujących Document.
removeViewer(user)DocumentUsuwa dane użytkownika z listy przeglądających i komentujących Document.
saveAndClose()voidZapisuje bieżące ustawienie Document.
setActiveTab(tabId)voidUstawia element Tab wybrany przez użytkownika w bieżącym dokumencie na kartę o określonym identyfikatorze.
setCursor(position)DocumentUstawia kursor użytkownika z następującą wartością Position.
setLanguage(languageCode)DocumentUstawia kod języka dokumentu.
setName(name)DocumentOkreśla tytuł dokumentu.
setSelection(range)DocumentOkreśla wybór użytkownika w aktywnej karcie z uwzględnieniem 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, z którym skrypt jest powiązany z kontenerem.
getUi()UiZwraca wystąpienie środowiska interfejsu użytkownika dokumentu, które umożliwia skryptowi dodawanie takie 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 elemencie Position.
addFooter()FooterSectionJeśli nie ma żadnej sekcji, dodaje sekcję stopki karty.
addHeader()HeaderSectionJeśli nie ma żadnej sekcji, dodaje sekcję nagłówka karty.
addNamedRange(name, range)NamedRangeDodaje obiekt NamedRange, który jest wartością Range, która ma nazwę i identyfikator dla pobrać później.
getBody()BodyPobiera atrybut Body karty.
getBookmark(id)BookmarkPobiera obiekt Bookmark o podanym identyfikatorze.
getBookmarks()Bookmark[]Pobiera wszystkie obiekty (Bookmark) na karcie.
getFooter()FooterSectionPobiera sekcję stopki karty, jeśli taka istnieje.
getFootnotes()Footnote[]Pobiera wszystkie elementy Footnote w treści karty.
getHeader()HeaderSectionPobiera sekcję nagłówka karty, jeśli taka istnieje.
getNamedRangeById(id)NamedRangePobiera obiekt NamedRange o podanym identyfikatorze.
getNamedRanges()NamedRange[]Pobiera wszystkie obiekty (NamedRange) na karcie.
getNamedRanges(name)NamedRange[]Pobiera na karcie wszystkie obiekty NamedRange o podanej nazwie.
newPosition(element, offset)PositionTworzy nowy obiekt 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 w postaci RichLink, np. link do pliku Arkuszy Google.
asTable()TableZwraca bieżący element jako Table.
asTableCell()TableCellZwraca bieżący element jako TableCell.
asTableOfContents()TableOfContentsZwraca bieżący element jako TableOfContents.
asTableRow()TableRowZwraca bieżący element jako TableRow.
asText()TextZwraca bieżący element jako Text.
copy()ElementZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()ElementScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()ElementUsuwa element z elementu nadrzędnego.
setAttributes(attributes)ElementUstawia atrybuty elementu.

ElementType

Właściwości

WłaściwośćTypOpis
BODY_SECTIONEnumTyp odpowiadający elementowi Body.
COMMENT_SECTIONEnumTyp odpowiadający elementowi CommentSection.
DATEEnumTyp odpowiadający atrybutowi Date .
EQUATIONEnumTyp odpowiadający elementowi Equation.
EQUATION_FUNCTIONEnumTyp odpowiadający elementowi EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumTyp odpowiadający atrybutowi 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 atrybutowi Text .
UNSUPPORTEDEnumTyp odpowiadający wartości 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()EquationScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()EquationUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)EquationUstawia atrybuty elementu.
setLinkUrl(url)EquationUstawia adres URL linku.
setTextAlignment(textAlignment)EquationOkreśla 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getCode()StringPobiera kod odpowiadający funkcji równania.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()EquationFunctionScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()EquationFunctionUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)EquationFunctionUstawia atrybuty elementu.
setLinkUrl(url)EquationFunctionUstawia adres URL linku.
setTextAlignment(textAlignment)EquationFunctionOkreśla 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 kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()EquationFunctionArgumentSeparatorScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()EquationFunctionArgumentSeparatorUsuwa 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()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()EquationSymbolScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()EquationSymbolUsuwa 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 obiekt InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podaną wartość InlineImage.
appendListItem(listItem)ListItemDołącza podaną wartość ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu.
appendParagraph(paragraph)ParagraphDołącza podaną wartość Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu.
appendTable(table)TableDołącza podaną wartość 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getImages()InlineImage[]Pobiera wszystkie zasoby InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie zasoby ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny elementu.
getTables()Table[]Pobiera wszystkie zasoby Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy HorizontalRule w podanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podaną wartość ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks zawartość tekstową.
insertParagraph(childIndex, paragraph)ParagraphWstawia podaną wartość Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks zawartość tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy Table w podanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie.
insertTable(childIndex, table)TableWstawia podaną wartość Table w określonym indeksie.
removeChild(child)FooterSectionUsuwa określony element podrzędny.
removeFromParent()FooterSectionUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)FooterSectionUstawia atrybuty elementu.
setText(text)FooterSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FooterSectionOkreśla 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 kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
removeFromParent()FootnoteUsuwa element z elementu nadrzędnego.
setAttributes(attributes)FootnoteUstawia atrybuty elementu.

FootnoteSection

Metody

MetodaZwracany typKrótki opis
appendParagraph(paragraph)ParagraphDołącza podaną wartość Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu.
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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertParagraph(childIndex, paragraph)ParagraphWstawia podaną wartość Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks zawartość tekstową.
removeChild(child)FootnoteSectionUsuwa określony element podrzędny.
removeFromParent()FootnoteSectionUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)FootnoteSectionUstawia atrybuty elementu.
setText(text)FootnoteSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)FootnoteSectionOkreśla 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 liczby.
LATIN_UPPEREnumPunktor w alfabecie łacińskim.
LATIN_LOWEREnumPunktor w alfabecie łacińskim.
ROMAN_UPPEREnumCyfra rzymska z wielkimi literami.
ROMAN_LOWEREnumCyfra rzymska z małą kropką.

HeaderSection

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podaną wartość InlineImage.
appendListItem(listItem)ListItemDołącza podaną wartość ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu.
appendParagraph(paragraph)ParagraphDołącza podaną wartość Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu.
appendTable(table)TableDołącza podaną wartość 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getImages()InlineImage[]Pobiera wszystkie zasoby InlineImages zawarte w sekcji.
getListItems()ListItem[]Pobiera wszystkie zasoby ListItems zawarte w sekcji.
getNumChildren()IntegerPobiera liczbę dzieci.
getParagraphs()Paragraph[]Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems).
getParent()ContainerElementPobiera element nadrzędny elementu.
getTables()Table[]Pobiera wszystkie zasoby Tables zawarte w sekcji.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy HorizontalRule w podanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podaną wartość ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks zawartość tekstową.
insertParagraph(childIndex, paragraph)ParagraphWstawia podaną wartość Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks zawartość tekstową.
insertTable(childIndex)TableTworzy i wstawia nowy Table w podanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie.
insertTable(childIndex, table)TableWstawia podaną wartość Table w określonym indeksie.
removeChild(child)HeaderSectionUsuwa określony element podrzędny.
removeFromParent()HeaderSectionUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)HeaderSectionUstawia atrybuty elementu.
setText(text)HeaderSectionUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)HeaderSectionOkreśla 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.

HorizontalRule

Metody

MetodaZwracany typKrótki opis
copy()HorizontalRuleZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
removeFromParent()HorizontalRuleUsuwa 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()StringZwraca alternatywny opis rysunku.
getAltTitle()StringZwraca alternatywny tytuł rysunku.
getAttributes()ObjectPobiera atrybuty elementu.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()InlineDrawingScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()InlineDrawingUsuwa 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()StringZwraca alternatywny opis obrazu.
getAltTitle()StringZwraca alternatywny tytuł obrazu.
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getAttributes()ObjectPobiera atrybuty elementu.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako obiekt blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()InlineImageScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()InlineImageUsuwa element z elementu nadrzędnego.
setAltDescription(description)InlineImageUstawia alternatywny opis 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 obiekt PositionedImage z określonego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podaną wartość InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podaną wartość PageBreak.
appendText(text)TextTworzy i dodaje nowy element Text z podaną 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAlignment()HorizontalAlignmentPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getGlyphType()GlyphTypePobiera GlyphType elementu listy.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera wcięcie końcowe (w punktach).
getIndentFirstLine()NumberPobiera w punktach pierwsze wcięcie pierwszego wiersza.
getIndentStart()NumberPobiera wcięcie początkowe.
getLineSpacing()NumberPobiera odstępy między wierszami w punktach.
getLinkUrl()StringPobiera adres URL linku.
getListId()StringPobiera identyfikator listy.
getNestingLevel()IntegerPobiera poziom zagnieżdżenia elementu listy.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera wartość PositionedImage na podstawie identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getSpacingAfter()NumberPobiera odstępy po elemencie w punktach.
getSpacingBefore()NumberPobiera odstępy przed elementem (w punktach).
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia HorizontalRule w podanym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertInlineImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy PageBreak w podanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podaną wartość PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia dany element Text w określonym indeksie z określonym tekstem treści.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
isLeftToRight()BooleanPobiera ustawienie od lewej do prawej.
merge()ListItemScala element z poprzednim elementem potomnym tego samego typu.
removeChild(child)ListItemUsuwa określony element podrzędny.
removeFromParent()ListItemUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa wartość PositionedImage według identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAlignment(alignment)ListItemUstawia HorizontalAlignment.
setAttributes(attributes)ListItemUstawia atrybuty elementu.
setGlyphType(glyphType)ListItemUstawia GlyphType elementu listy.
setHeading(heading)ListItemUstawia 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)ListItemOkreśla ustawienie tekstu od lewej do prawej.
setLineSpacing(multiplier)ListItemUstawia odstępy między wierszami jako liczbę określającą ich liczbę.
setLinkUrl(url)ListItemUstawia adres URL linku.
setListId(listItem)ListItemUstawia identyfikator listy.
setNestingLevel(nestingLevel)ListItemOkreśla poziom zagnieżdżenia elementu listy.
setSpacingAfter(spacingAfter)ListItemUstawia odstępy po elemencie w punktach.
setSpacingBefore(spacingBefore)ListItemUstawia odstępy przed elementem w punktach.
setText(text)voidUstawia zawartość elementu listy jako tekst.
setTextAlignment(textAlignment)ListItemOkreśla wyrównanie tekstu.

NamedRange

Metody

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

PageBreak

Metody

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

Paragraph

Metody

MetodaZwracany typKrótki opis
addPositionedImage(image)PositionedImageTworzy i wstawia nowy obiekt PositionedImage z określonego obiektu blob obrazu.
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendInlineImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendInlineImage(image)InlineImageDołącza podaną wartość InlineImage.
appendPageBreak()PageBreakTworzy i dołącza nowy element PageBreak.
appendPageBreak(pageBreak)PageBreakDołącza podaną wartość PageBreak.
appendText(text)TextTworzy i dodaje nowy element Text z podaną 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAlignment()HorizontalAlignmentPobiera HorizontalAlignment.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getHeading()ParagraphHeadingPobiera ParagraphHeading.
getIndentEnd()NumberPobiera wcięcie końcowe (w punktach).
getIndentFirstLine()NumberPobiera w punktach pierwsze wcięcie pierwszego wiersza.
getIndentStart()NumberPobiera wcięcie początkowe.
getLineSpacing()NumberPobiera odstępy między wierszami w punktach.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPositionedImage(id)PositionedImagePobiera wartość PositionedImage na podstawie identyfikatora obrazu.
getPositionedImages()PositionedImage[]Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getSpacingAfter()NumberPobiera odstępy po elemencie w punktach.
getSpacingBefore()NumberPobiera odstępy przed elementem (w punktach).
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia HorizontalRule w podanym indeksie.
insertInlineImage(childIndex, image)InlineImageTworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertInlineImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertPageBreak(childIndex)PageBreakTworzy i wstawia nowy PageBreak w podanym indeksie.
insertPageBreak(childIndex, pageBreak)PageBreakWstawia podaną wartość PageBreak w określonym indeksie.
insertText(childIndex, text)TextTworzy i wstawia nowy element tekstowy w określonym indeksie.
insertText(childIndex, text)TextWstawia dany element Text w określonym indeksie z określonym tekstem treści.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
isLeftToRight()BooleanPobiera ustawienie od lewej do prawej.
merge()ParagraphScala element z poprzednim elementem potomnym tego samego typu.
removeChild(child)ParagraphUsuwa określony element podrzędny.
removeFromParent()ParagraphUsuwa element z elementu nadrzędnego.
removePositionedImage(id)BooleanUsuwa wartość PositionedImage według identyfikatora obrazu.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAlignment(alignment)ParagraphUstawia HorizontalAlignment.
setAttributes(attributes)ParagraphUstawia atrybuty elementu.
setHeading(heading)ParagraphUstawia 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)ParagraphOkreśla ustawienie tekstu od lewej do prawej.
setLineSpacing(multiplier)ParagraphUstawia odstępy między wierszami jako liczbę określającą ich liczbę.
setLinkUrl(url)ParagraphUstawia adres URL linku.
setSpacingAfter(spacingAfter)ParagraphUstawia odstępy po elemencie w punktach.
setSpacingBefore(spacingBefore)ParagraphUstawia odstępy przed elementem w punktach.
setText(text)voidUstawia zawartość akapitu jako tekst.
setTextAlignment(textAlignment)ParagraphOkreśla wyrównanie tekstu.

ParagraphHeading

Właściwości

WłaściwośćTypOpis
NORMALEnumOpcja nagłówka zwykłego tekstu.
HEADING1EnumOpcja najwyższego nagłówka.
HEADING2EnumOpcja drugiego nagłówka.
HEADING3EnumOpcja trzeciego nagłówka
HEADING4EnumCzwarta opcja nagłówka.
HEADING5EnumPiąta opcja nagłówka.
HEADING6EnumOpcja najniższego 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()StringZwraca wyświetlaną nazwę osoby, jeśli została ustawiona.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()PersonScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()PersonUsuwa element z elementu nadrzędnego.
setAttributes(attributes)PersonUstawia atrybuty elementu.

Position

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera element zawierający 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 Paragraph lub ListItem, który zawiera element Position (bezpośrednio lub przez łańcuch elementów podrzędnych).
getSurroundingTextOffset()IntegerPobiera przesunięcie wartości Position w elemencie Text zwróconym przez funkcję getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowy element Bookmark w tym miejscu: Position.
insertInlineImage(image)InlineImageTworzy i wstawia nowy element InlineImage w: Position na podstawie określonego obrazu blob.
insertText(text)TextWstawia określony tekst w tym miejscu: Position.

PositionedImage

Metody

MetodaZwracany typKrótki opis
getAs(contentType)BlobZwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści.
getBlob()BlobZwraca dane wewnątrz tego obiektu jako obiekt blob.
getHeight()IntegerPobiera wysokość obrazu w pikselach.
getId()StringPobiera identyfikator obrazu.
getLayout()PositionedLayoutPobiera wartość wyliczeniową, która reprezentuje układ obrazu.
getLeftOffset()NumberPobiera przesunięcie obrazu (w punktach) od lewej krawędzi akapitu.
getParagraph()ParagraphPobiera Paragraph, do którego jest zakotwiczony obraz.
getTopOffset()NumberPobiera przesunięcie obrazu (w punktach) od góry akapitu.
getWidth()IntegerPobiera szerokość obrazu w pikselach.
setHeight(height)PositionedImageUstawia wysokość obrazu w pikselach.
setLayout(layout)PositionedImageOkreśla definicję układu zdjęcia.
setLeftOffset(offset)PositionedImageOkreśla przesunięcie obrazu (w punktach) od lewej krawędzi akapitu.
setTopOffset(offset)PositionedImageOkreśla przesunię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 jest umieszczony nad tekstem.
BREAK_BOTHEnumObraz dzieli tekst z lewej i prawej strony.
BREAK_LEFTEnumObraz dzieli tekst po lewej stronie.
BREAK_RIGHTEnumObraz dzieli tekst po prawej stronie.
WRAP_TEXTEnumObraz jest zawijany przez tekst.

Range

Metody

MetodaZwracany typKrótki opis
getRangeElements()RangeElement[]Pobiera wszystkie elementy w tym elemencie typu Range, w tym częściowe elementy Text (na przykład w przypadku argumentu takiego, który zawiera tylko część elementu Text).

RangeBuilder

Metody

MetodaZwracany typKrótki opis
addElement(element)RangeBuilderDodaje cały element Element do elementu 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 pola 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 kreatorze.
getRangeElements()RangeElement[]Pobiera wszystkie elementy w tym elemencie typu Range, w tym częściowe elementy Text (na przykład w przypadku argumentu takiego, który zawiera tylko część elementu Text).

RangeElement

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera Element odpowiadającą 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 jego część znaków elementu.

Metody

MetodaZwracany typKrótki opis
copy()RichLinkZwraca odłączoną, głęboką kopię bieżącego elementu.
getAttributes()ObjectPobiera atrybuty elementu.
getMimeType()StringZwraca typ MIME link, który jest dostępny, gdy element jest linkiem do pliku na Dysku oraz null w przeciwnym razie.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getTitle()StringZwraca wyświetlany tytuł linku.
getType()ElementTypePobiera wartość ElementType elementu.
getUrl()StringZwraca adres URL zasobu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()RichLinkScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()RichLinkUsuwa 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 w tej karcie.
getId()StringPobiera identyfikator karty.
getIndex()IntegerPobiera indeks karty w elemencie nadrzędnym oparty na 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 dołącza nowy element TableRow.
appendTableRow(tableRow)TableRowDołącza podaną wartość 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getBorderColor()StringPobiera kolor obramowania.
getBorderWidth()NumberPobiera szerokość obramowania w punktach.
getCell(rowIndex, cellIndex)TableCellPobiera pole TableCell z określonego wiersza i indeksów komórek.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getColumnWidth(columnIndex)NumberPobiera szerokość określonej kolumny tabeli (w punktach).
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getNumRows()IntegerPobiera liczbę TableRows.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getRow(rowIndex)TableRowPobiera TableRow o określonym indeksie wiersza.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertTableRow(childIndex)TableRowTworzy i wstawia nowy TableRow w podanym indeksie.
insertTableRow(childIndex, tableRow)TableRowWstawia podaną wartość TableRow w określonym indeksie.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
removeChild(child)TableUsuwa określony element podrzędny.
removeFromParent()TableUsuwa element z elementu nadrzędnego.
removeRow(rowIndex)TableRowUsuwa wartość TableRow w określonym indeksie wiersza.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)TableUstawia atrybuty elementu.
setBorderColor(color)TableUstawia kolor obramowania.
setBorderWidth(width)TableOkreśla szerokość obramowania w punktach.
setColumnWidth(columnIndex, width)TableUstawia szerokość określonej kolumny (w punktach).
setLinkUrl(url)TableUstawia adres URL linku.
setTextAlignment(textAlignment)TableOkreśla wyrównanie tekstu.

TableCell

Metody

MetodaZwracany typKrótki opis
appendHorizontalRule()HorizontalRuleTworzy i dołącza nowy element HorizontalRule.
appendImage(image)InlineImageTworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu.
appendImage(image)InlineImageDołącza podaną wartość InlineImage.
appendListItem(listItem)ListItemDołącza podaną wartość ListItem.
appendListItem(text)ListItemTworzy i dołącza nowy element ListItem.
appendParagraph(paragraph)ParagraphDołącza podaną wartość Paragraph.
appendParagraph(text)ParagraphTworzy i dołącza nowy element Paragraph.
appendTable()TableTworzy i dołącza nowy element Table.
appendTable(cells)TableDodaje nowy element Table zawierający określone komórki.
appendTable(table)TableDołącza podaną wartość 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getBackgroundColor()StringPobiera kolor tła.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getColSpan()IntegerPobiera rozpiętość kolumny będącą liczbą kolumn komórek tabeli, które obejmuje ta komórka.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getPaddingBottom()NumberPobiera dopełnienie u dołu w punktach.
getPaddingLeft()NumberPobiera dopełnienie z lewej strony w punktach.
getPaddingRight()NumberPobiera odpowiednie dopełnienie w punktach.
getPaddingTop()NumberPobiera górne dopełnienie (w punktach).
getParent()ContainerElementPobiera element nadrzędny elementu.
getParentRow()TableRowPobiera obiekt TableRow zawierający bieżącą wartość TableCell.
getParentTable()TablePobiera obiekt Table zawierający bieżącą wartość TableCell.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getRowSpan()IntegerPobiera rozpiętość wierszy będącą liczbą wierszy komórek tabeli, które obejmuje ta komórka.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
getVerticalAlignment()VerticalAlignmentPobiera VerticalAlignment.
getWidth()NumberPobiera szerokość kolumny zawierającej komórkę (w punktach).
insertHorizontalRule(childIndex)HorizontalRuleTworzy i wstawia nowy HorizontalRule w podanym indeksie.
insertImage(childIndex, image)InlineImageTworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu indeksu.
insertImage(childIndex, image)InlineImageWstawia podaną wartość InlineImage w określonym indeksie.
insertListItem(childIndex, listItem)ListItemWstawia podaną wartość ListItem w określonym indeksie.
insertListItem(childIndex, text)ListItemTworzy i wstawia nowy ListItem w podanym indeksie.
insertParagraph(childIndex, paragraph)ParagraphWstawia podaną wartość Paragraph w określonym indeksie.
insertParagraph(childIndex, text)ParagraphTworzy i wstawia nowy Paragraph w podanym indeksie.
insertTable(childIndex)TableTworzy i wstawia nowy Table w podanym indeksie.
insertTable(childIndex, cells)TableTworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie.
insertTable(childIndex, table)TableWstawia podaną wartość Table w określonym indeksie.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()TableCellScala element z poprzednim elementem potomnym tego samego typu.
removeChild(child)TableCellUsuwa określony element podrzędny.
removeFromParent()TableCellUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)TableCellUstawia atrybuty elementu.
setBackgroundColor(color)TableCellUstawia kolor tła.
setLinkUrl(url)TableCellUstawia adres URL linku.
setPaddingBottom(paddingBottom)TableCellUstawia dopełnienie u dołu w punktach.
setPaddingLeft(paddingLeft)TableCellUstawia dopełnienie z lewej strony w punktach.
setPaddingRight(paddingRight)TableCellUstawia odpowiednie dopełnienie w punktach.
setPaddingTop(paddingTop)TableCellUstawia dopełnienie u góry w punktach.
setText(text)TableCellUstawia zawartość jako zwykły tekst.
setTextAlignment(textAlignment)TableCellOkreśla wyrównanie tekstu.
setVerticalAlignment(alignment)TableCellOkreśla wyrównanie w pionie.
setWidth(width)TableCellOkreśla 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
removeFromParent()TableOfContentsUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)TableOfContentsUstawia atrybuty elementu.
setLinkUrl(url)TableOfContentsUstawia adres URL linku.
setTextAlignment(textAlignment)TableOfContentsOkreśla 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 podaną wartość 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)RangeElementPrzeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu.
findElement(elementType, from)RangeElementPrzeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od określono RangeElement.
findText(searchPattern)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getCell(cellIndex)TableCellPobiera TableCell z podanego indeksu komórek.
getChild(childIndex)ElementPobiera element podrzędny z określonego indeksu podrzędnego.
getChildIndex(child)IntegerPobiera indeks podrzędny dla określonego elementu podrzędnego.
getLinkUrl()StringPobiera adres URL linku.
getMinimumHeight()NumberPobiera minimalną wysokość w punktach.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getNumCells()IntegerPobiera liczbę komórek w wierszu.
getNumChildren()IntegerPobiera liczbę dzieci.
getParent()ContainerElementPobiera element nadrzędny elementu.
getParentTable()TablePobiera pole Table zawierające bieżący wiersz.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getText()StringPobiera zawartość elementu jako ciąg tekstowy.
getTextAlignment()TextAlignmentPobiera wyrównanie tekstu.
getType()ElementTypePobiera wartość ElementType elementu.
insertTableCell(childIndex)TableCellTworzy i wstawia nowy TableCell w podanym indeksie.
insertTableCell(childIndex, textContents)TableCellWstawia podany element TableCell w określonym indeksie, zawierający podany tekst.
insertTableCell(childIndex, tableCell)TableCellWstawia podaną wartość TableCell w określonym indeksie.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()TableRowScala element z poprzednim elementem potomnym tego samego typu.
removeCell(cellIndex)TableCellUsuwa wartość TableCell w podanym indeksie komórek.
removeChild(child)TableRowUsuwa określony element podrzędny.
removeFromParent()TableRowUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
setAttributes(attributes)TableRowUstawia atrybuty elementu.
setLinkUrl(url)TableRowUstawia adres URL linku.
setMinimumHeight(minHeight)TableRowOkreśla minimalną wysokość w punktach.
setTextAlignment(textAlignment)TableRowOkreśla wyrównanie tekstu.

Text

Metody

MetodaZwracany typKrótki opis
appendText(text)TextDodaje określony tekst na końcu tego obszaru 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 tekstu przy użyciu wyrażeń regularnych.
findText(searchPattern, from)RangeElementPrzeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania.
getAttributes()ObjectPobiera atrybuty elementu.
getAttributes(offset)ObjectPobiera atrybuty z określonym przesunięciem znaków.
getBackgroundColor()StringPobiera ustawienie koloru tła.
getBackgroundColor(offset)StringPobiera kolor tła z określonym przesunięciem znaku.
getFontFamily()StringPobiera ustawienie rodziny czcionek.
getFontFamily(offset)StringPobiera rodzinę czcionek z określonym przesunięciem znaków.
getFontSize()NumberPobiera ustawienie rozmiaru czcionki.
getFontSize(offset)NumberPobiera rozmiar czcionki z określonym przesunięciem znaku.
getForegroundColor()StringPobiera ustawienie koloru pierwszego planu.
getForegroundColor(offset)StringPobiera kolor pierwszego planu z określonym przesunięciem znaku.
getLinkUrl()StringPobiera adres URL linku.
getLinkUrl(offset)StringPobiera adres URL linku z określonym przesunięciem znaków.
getNextSibling()ElementPobiera kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzę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 zestaw indeksów tekstowych, które odpowiadają początkowi odrębnego formatowania tekstu biegi.
getType()ElementTypePobiera wartość ElementType elementu.
insertText(offset, text)TextWstawia określony tekst z podanym przesunięciem znaków.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
isBold()BooleanPobiera ustawienie pogrubienia.
isBold(offset)BooleanPobiera ustawienie pogrubienia z określonym przesunięciem znaków.
isItalic()BooleanPobiera ustawienie kursywy.
isItalic(offset)BooleanPobiera ustawienie kursywy z określonym przesunięciem znaku.
isStrikethrough()BooleanPobiera ustawienie przekreślenia.
isStrikethrough(offset)BooleanPobiera ustawienie przekreślenia z określonym przesunięciem znaków.
isUnderline()BooleanPobiera ustawienie podkreślenia.
isUnderline(offset)BooleanPobiera ustawienie podkreślenia z określonym przesunięciem znaków.
merge()TextScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()TextUsuwa element z elementu nadrzędnego.
replaceText(searchPattern, replacement)ElementZastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń.
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 określonego zakresu znaków.
setBackgroundColor(color)TextUstawia kolor tła.
setBold(bold)TextOkreśla ustawienie pogrubienia.
setBold(startOffset, endOffsetInclusive, bold)TextOkreśla ustawienie pogrubienia w określonym 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 określonym zakresie 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)TextOkreśla ustawienie kursywy.
setItalic(startOffset, endOffsetInclusive, italic)TextOkreśla ustawienie kursywy w określonym zakresie znaków.
setLinkUrl(startOffset, endOffsetInclusive, url)TextUstawia adres URL linku dla określonego zakresu znaków.
setLinkUrl(url)TextUstawia adres URL linku.
setStrikethrough(strikethrough)TextOkreśla ustawienie przekreślenia.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextOkreśla ustawienie przekreślenia w wybranym zakresie znaków.
setText(text)TextOkreśla zawartość tekstu.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextOkreśla wyrównanie tekstu w danym zakresie znaków.
setTextAlignment(textAlignment)TextOkreśla wyrównanie tekstu.
setUnderline(underline)TextOkreśla ustawienie podkreślenia.
setUnderline(startOffset, endOffsetInclusive, underline)TextOkreśla ustawienie podkreślenia w określonym zakresie znaków.

TextAlignment

Właściwości

WłaściwośćTypOpis
NORMALEnumNormalne wyrównanie tekstu.
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 kolejny element równorzędny elementu.
getParent()ContainerElementPobiera element nadrzędny elementu.
getPreviousSibling()ElementPobiera poprzedni element równorzędny elementu.
getType()ElementTypePobiera wartość ElementType elementu.
isAtDocumentEnd()BooleanOkreśla, czy element jest na końcu Document.
merge()UnsupportedElementScala element z poprzednim elementem potomnym tego samego typu.
removeFromParent()UnsupportedElementUsuwa element z 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.