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
Nazwa | Krótki opis |
---|---|
Attribute | Wyliczenie atrybutów elementu. |
Body | Zawartość karty w dokumencie Dokumentów Google. |
Bookmark | Obiekt reprezentujący zakładkę. |
ContainerElement | Ogólny element, który może zawierać inne elementy. |
Date | Element reprezentujący sformatowaną datę |
Document | Dokument zawierający co najmniej 1 obiekt Tab , z których każdy zawiera tekst sformatowany i
takie jak tabele i listy. |
DocumentApp | Usługa dokumentów tworzy i otwiera plik Documents , który można edytować. |
DocumentTab | Karta dokumentu zawierająca tekst sformatowany i elementy takie jak tabele i listy. |
Element | Element ogólny. |
ElementType | Lista wszystkich typów elementów. |
Equation | Element reprezentujący wyrażenie matematyczne. |
EquationFunction | Element reprezentujący funkcję w Equation . |
EquationFunctionArgumentSeparator | Element reprezentujący separator funkcji w funkcji matematycznej Equation . |
EquationSymbol | Element reprezentujący symbol w Equation . |
| Lista obsługiwanych czcionek. |
FooterSection | Element reprezentujący sekcję stopki. |
Footnote | Element reprezentujący przypis. |
FootnoteSection | Element reprezentujący sekcję przypisu. |
GlyphType | Lista obsługiwanych typów glifów. |
HeaderSection | Element reprezentujący sekcję nagłówka. |
HorizontalAlignment | Lista obsługiwanych typów wyrównania w poziomie. |
HorizontalRule | Element reprezentujący regułę poziomą. |
InlineDrawing | Element reprezentujący osadzony rysunek. |
InlineImage | Element reprezentujący osadzony obraz. |
ListItem | Element reprezentujący element listy. |
NamedRange | Range z nazwą i identyfikatorem umożliwiającym późniejsze pobranie. |
PageBreak | Element reprezentujący podział strony. |
Paragraph | Element reprezentujący akapit. |
ParagraphHeading | Lista standardowych nagłówków akapitów. |
Person | Element reprezentujący link do osoby. |
Position | Odwołanie do lokalizacji na karcie dokumentu względem konkretnego elementu. |
PositionedImage | Obraz o stałej pozycji zakotwiczony w elemencie Paragraph . |
PositionedLayout | Wyliczenie, które określa sposób ułożenia elementu PositionedImage w odniesieniu do otoczenia
tekstu. |
Range | Zakres elementów w dokumencie. |
RangeBuilder | Kreator używany do tworzenia obiektów Range z elementów dokumentu. |
RangeElement | Kod wokół elementu Element z możliwym przesunięciem początku i końca. |
RichLink | Element reprezentujący link do zasobu Google, np. do pliku na Dysku lub filmu w YouTube. |
Tab | Karta w dokumencie w Dokumentach Google. |
TabType | Lista wszystkich typów kart. |
Table | Element reprezentujący tabelę. |
TableCell | Element reprezentujący komórkę tabeli. |
TableOfContents | Element zawierający spis treści. |
TableRow | Element reprezentujący wiersz tabeli. |
Text | Element reprezentujący region tekstu sformatowanego. |
TextAlignment | Lista typów wyrównań tekstu. |
UnsupportedElement | Element reprezentujący region, który jest nieznany lub na który skrypt nie może mieć wpływu, np. numer strony. |
VerticalAlignment | Lista obsługiwanych typów wyrównania w pionie. |
Attribute
Właściwości
Właściwość | Typ | Opis |
---|---|---|
BACKGROUND_COLOR | Enum | Kolor tła elementu (akapitu, tabeli itp.) lub dokumentu. |
BOLD | Enum | Ustawienie grubości czcionki dla tekstu sformatowanego. |
BORDER_COLOR | Enum | Kolor obramowania elementów tabeli. |
BORDER_WIDTH | Enum | Szerokość obramowania elementów tabeli w punktach. |
CODE | Enum | Zawartość kodu elementów równań. |
FONT_FAMILY | Enum | Ustawienie rodziny czcionek dla tekstu sformatowanego. |
FONT_SIZE | Enum | Ustawienie rozmiaru czcionki w punktach dla tekstu sformatowanego. |
FOREGROUND_COLOR | Enum | Ustawienie koloru pierwszego planu dla tekstu sformatowanego. |
HEADING | Enum | Typ nagłówka elementów akapitu (np. DocumentApp.ParagraphHeading.HEADING1 ). |
HEIGHT | Enum | Ustawienie wysokości elementów graficznych. |
HORIZONTAL_ALIGNMENT | Enum | Wyrównanie w poziomie elementów akapitu (np. DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | Ustawienie wcięcia końcowego w punktach dla elementów akapitu. |
INDENT_FIRST_LINE | Enum | Ustawienie wcięcia pierwszego wiersza w punktach dla elementów akapitu. |
INDENT_START | Enum | Ustawienie wcięcia początkowego w punktach dla elementów akapitu. |
ITALIC | Enum | Ustawienie stylu czcionki dla tekstu sformatowanego. |
GLYPH_TYPE | Enum | Typ glifu na potrzeby elementów elementu listy. |
LEFT_TO_RIGHT | Enum | Ustawienie kierunku tekstu dla tekstu sformatowanego. |
LINE_SPACING | Enum | Ustawienie odstępów między wierszami jako mnożnik elementów akapitu. |
LINK_URL | Enum | Adres URL linku w przypadku tekstu sformatowanego. |
LIST_ID | Enum | Identyfikator listy nadrzędnej na potrzeby elementów elementu listy. |
MARGIN_BOTTOM | Enum | Ustawienie dolnego marginesu w punktach dla elementów akapitu. |
MARGIN_LEFT | Enum | Ustawienie lewego marginesu w punktach dla elementów akapitu. |
MARGIN_RIGHT | Enum | Ustawienie prawego marginesu w punktach dla elementów akapitu. |
MARGIN_TOP | Enum | Ustawienie górnego marginesu w punktach dla elementów akapitu. |
NESTING_LEVEL | Enum | Poziom zagnieżdżenia elementu listy. |
MINIMUM_HEIGHT | Enum | Minimalne ustawienie wysokości elementów wiersza tabeli w punktach. |
PADDING_BOTTOM | Enum | Dolne ustawienie dopełnienia w punktach dla elementów komórek tabeli. |
PADDING_LEFT | Enum | Ustawienie dopełnienia z lewej strony w punktach dla elementów komórek tabeli. |
PADDING_RIGHT | Enum | Ustawienie dopełnienia prawego w punktach dla elementów komórek tabeli. |
PADDING_TOP | Enum | Ustawienie dopełnienia górnego w punktach dla elementów komórek tabeli. |
PAGE_HEIGHT | Enum | Ustawienie wysokości strony w punktach dla dokumentów. |
PAGE_WIDTH | Enum | Ustawienie szerokości strony w punktach dla dokumentów. |
SPACING_AFTER | Enum | Ustawienie odstępów u dołu w punktach dla elementów akapitu. |
SPACING_BEFORE | Enum | Ustawienie odstępów u góry strony w punktach dla elementów akapitu. |
STRIKETHROUGH | Enum | Ustawienie przekreślenia w przypadku tekstu sformatowanego. |
UNDERLINE | Enum | Ustawienie podkreślenia w przypadku tekstu sformatowanego. |
VERTICAL_ALIGNMENT | Enum | Ustawienie wyrównania w pionie elementów komórek tabeli. |
WIDTH | Enum | Ustawienie szerokości komórek tabeli i elementów graficznych. |
Body
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendListItem(listItem) | ListItem | Dołącza podaną wartość ListItem . |
appendListItem(text) | ListItem | Tworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu. |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dołącza podaną wartość PageBreak . |
appendParagraph(paragraph) | Paragraph | Dołącza podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu. |
appendTable() | Table | Tworzy i dołącza nowy element Table . |
appendTable(cells) | Table | Dodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu. |
appendTable(table) | Table | Dołącza podaną wartość Table . |
clear() | Body | Usuwa zawartość elementu. |
copy() | Body | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getHeadingAttributes(paragraphHeading) | Object | Pobiera 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() | Number | Pobiera dolny margines (w punktach). |
getMarginLeft() | Number | Pobiera lewy margines (w punktach). |
getMarginRight() | Number | Pobiera prawy margines. |
getMarginTop() | Number | Pobiera górny margines. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getPageHeight() | Number | Pobiera wysokość strony w punktach. |
getPageWidth() | Number | Pobiera szerokość strony w punktach. |
getParagraphs() | Paragraph[] | Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getTables() | Table[] | Pobiera wszystkie zasoby Tables zawarte w sekcji. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia nowy HorizontalRule w podanym indeksie. |
insertImage(childIndex, image) | InlineImage | Tworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertListItem(childIndex, listItem) | ListItem | Wstawia podaną wartość ListItem w określonym indeksie. |
insertListItem(childIndex, text) | ListItem | Tworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertPageBreak(childIndex) | PageBreak | Tworzy i wstawia nowy PageBreak w podanym indeksie. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Wstawia podaną wartość PageBreak w określonym indeksie. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podaną wartość Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertTable(childIndex) | Table | Tworzy i wstawia nowy Table w podanym indeksie. |
insertTable(childIndex, cells) | Table | Tworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie. |
insertTable(childIndex, table) | Table | Wstawia podaną wartość Table w określonym indeksie. |
removeChild(child) | Body | Usuwa określony element podrzędny. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | Body | Ustawia atrybuty elementu. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Ustawia atrybuty dla podanego elementu ParagraphHeading . |
setMarginBottom(marginBottom) | Body | Ustawia dolny margines (w punktach). |
setMarginLeft(marginLeft) | Body | Ustawia lewy margines w punktach. |
setMarginRight(marginRight) | Body | Ustawia prawy margines (w punktach). |
setMarginTop(marginTop) | Body | Ustawia górny margines. |
setPageHeight(pageHeight) | Body | Określa wysokość strony w punktach. |
setPageWidth(pageWidth) | Body | Określa szerokość strony w punktach. |
setText(text) | Body | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | Body | Określa wyrównanie tekstu. |
Bookmark
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getId() | String | Pobiera identyfikator elementu Bookmark . |
getPosition() | Position | Pobiera wartość Position funkcji Bookmark w: DocumentTab . |
remove() | void | Usuwa Bookmark . |
ContainerElement
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
asBody() | Body | Zwraca bieżący element jako Body . |
asEquation() | Equation | Zwraca bieżący element jako Equation . |
asFooterSection() | FooterSection | Zwraca bieżący element jako FooterSection . |
asFootnoteSection() | FootnoteSection | Zwraca bieżący element jako FootnoteSection . |
asHeaderSection() | HeaderSection | Zwraca bieżący element jako HeaderSection . |
asListItem() | ListItem | Zwraca bieżący element jako ListItem . |
asParagraph() | Paragraph | Zwraca bieżący element jako Paragraph . |
asTable() | Table | Zwraca bieżący element jako Table . |
asTableCell() | TableCell | Zwraca bieżący element jako TableCell . |
asTableOfContents() | TableOfContents | Zwraca bieżący element jako TableOfContents . |
asTableRow() | TableRow | Zwraca bieżący element jako TableRow . |
clear() | ContainerElement | Usuwa zawartość elementu. |
copy() | ContainerElement | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | ContainerElement | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | ContainerElement | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | ContainerElement | Ustawia atrybuty elementu. |
setLinkUrl(url) | ContainerElement | Ustawia adres URL linku. |
setTextAlignment(textAlignment) | ContainerElement | Określa wyrównanie tekstu. |
Date
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | Date | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getDisplayText() | String | Zwraca wartość wyświetlaną wyrenderowaną w dokumencie. |
getLocale() | String | Zwraca język daty używany dla wyświetlanej wartości. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getTimestamp() | Date | Zwraca sygnaturę czasową powiązaną z datą. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | Date | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | Date | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | Date | Ustawia 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()
iTab.getChildTabs()
. Dla każdej karty w drzewie wywołajTab.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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addBookmark(position) | Bookmark | Dodaje element Bookmark w danym Position na pierwszej karcie lub w przypadku skryptów, które są
powiązane z dokumentem – aktywną kartą. |
addEditor(emailAddress) | Document | Dodaje danego użytkownika do listy edytorów zasobu Document . |
addEditor(user) | Document | Dodaje danego użytkownika do listy edytorów zasobu Document . |
addEditors(emailAddresses) | Document | Dodaje podaną tablicę użytkowników do listy edytorów zasobu Document . |
addFooter() | FooterSection | Dodaje sekcję stopki (jeśli nie ma takiej opcji) do pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – do aktywnej karty. |
addHeader() | HeaderSection | Dodaje 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) | NamedRange | Dodaje 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) | Document | Dodaje danego użytkownika do listy przeglądających w: Document . |
addViewer(user) | Document | Dodaje danego użytkownika do listy przeglądających w: Document . |
addViewers(emailAddresses) | Document | Dodaje podaną tablicę użytkowników do listy przeglądających obiekt Document . |
getActiveTab() | Tab | Pobiera w dokumencie aktywne Tab użytkownika. |
getAs(contentType) | Blob | Pobiera bieżącą zawartość Document jako obiekt blob określonego typu. |
getBlob() | Blob | Pobiera bieżącą zawartość Document jako obiekt blob. |
getBody() | Body | Pobiera wartość Body pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – uprawnienia DocumentBodySection aktywnej karty. |
getBookmark(id) | Bookmark | Pobiera 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() | Position | Pobiera kursor użytkownika na aktywnej karcie. |
getEditors() | User[] | Pobiera listę edytorów elementu Document . |
getFooter() | FooterSection | Pobiera 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() | HeaderSection | Pobiera sekcję nagłówka pierwszej karty lub – w przypadku skryptów powiązanych z dokumentem – nagłówek aktywnej karty. . |
getId() | String | Pobiera unikalny identyfikator dokumentu. |
getLanguage() | String | Pobiera kod języka dokumentu. |
getName() | String | Pobiera tytuł dokumentu. |
getNamedRangeById(id) | NamedRange | Pobiera 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() | Range | Pobiera 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) | Tab | Pobiera obiekt Tab o podanym identyfikatorze. |
getTabs() | Tab[] | Pobiera wszystkie niezagnieżdżone obiekty Tab , które są częścią dokumentu. |
getUrl() | String | Pobiera 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) | Position | Tworzy 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() | RangeBuilder | Tworzy 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) | Document | Usuwa danego użytkownika z listy edytorów zasobu Document . |
removeEditor(user) | Document | Usuwa danego użytkownika z listy edytorów zasobu Document . |
removeViewer(emailAddress) | Document | Usuwa dane użytkownika z listy przeglądających i komentujących Document . |
removeViewer(user) | Document | Usuwa dane użytkownika z listy przeglądających i komentujących Document . |
saveAndClose() | void | Zapisuje bieżące ustawienie Document . |
setActiveTab(tabId) | void | Ustawia element Tab wybrany przez użytkownika w bieżącym dokumencie na kartę o określonym identyfikatorze. |
setCursor(position) | Document | Ustawia kursor użytkownika z następującą wartością Position . |
setLanguage(languageCode) | Document | Ustawia kod języka dokumentu. |
setName(name) | Document | Określa tytuł dokumentu. |
setSelection(range) | Document | Określa wybór użytkownika w aktywnej karcie z uwzględnieniem Range . |
DocumentApp
Właściwości
Właściwość | Typ | Opis |
---|---|---|
Attribute | Attribute | Wyliczenie Attribute . |
ElementType | ElementType | Wyliczenie ElementType . |
FontFamily |
| Wyliczenie . |
GlyphType | GlyphType | Wyliczenie GlyphType . |
HorizontalAlignment | HorizontalAlignment | Wyliczenie HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | Wyliczenie ParagraphHeading . |
PositionedLayout | PositionedLayout | Wyliczenie PositionedLayout . |
TextAlignment | TextAlignment | Wyliczenie TextAlignment . |
VerticalAlignment | VerticalAlignment | Wyliczenie VerticalAlignment . |
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
create(name) | Document | Tworzy i zwraca nowy dokument. |
getActiveDocument() | Document | Zwraca dokument, z którym skrypt jest powiązany z kontenerem. |
getUi() | Ui | Zwraca wystąpienie środowiska interfejsu użytkownika dokumentu, które umożliwia skryptowi dodawanie takie jak menu, okna i paski boczne. |
openById(id) | Document | Zwraca dokument o określonym identyfikatorze. |
openByUrl(url) | Document | Otwiera i zwraca dokument o określonym adresie URL. |
DocumentTab
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addBookmark(position) | Bookmark | Dodaje Bookmark w podanym elemencie Position . |
addFooter() | FooterSection | Jeśli nie ma żadnej sekcji, dodaje sekcję stopki karty. |
addHeader() | HeaderSection | Jeśli nie ma żadnej sekcji, dodaje sekcję nagłówka karty. |
addNamedRange(name, range) | NamedRange | Dodaje obiekt NamedRange , który jest wartością Range , która ma nazwę i identyfikator dla
pobrać później. |
getBody() | Body | Pobiera atrybut Body karty. |
getBookmark(id) | Bookmark | Pobiera obiekt Bookmark o podanym identyfikatorze. |
getBookmarks() | Bookmark[] | Pobiera wszystkie obiekty (Bookmark ) na karcie. |
getFooter() | FooterSection | Pobiera sekcję stopki karty, jeśli taka istnieje. |
getFootnotes() | Footnote[] | Pobiera wszystkie elementy Footnote w treści karty. |
getHeader() | HeaderSection | Pobiera sekcję nagłówka karty, jeśli taka istnieje. |
getNamedRangeById(id) | NamedRange | Pobiera 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) | Position | Tworzy nowy obiekt Position , który jest odwołaniem do lokalizacji na karcie względem
konkretnego elementu. |
newRange() | RangeBuilder | Tworzy kreator służący do tworzenia obiektów Range z elementów karty. |
Element
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
asBody() | Body | Zwraca bieżący element jako Body . |
asDate() | Date | Zwraca bieżący element jako Date . |
asEquation() | Equation | Zwraca bieżący element jako Equation . |
asEquationFunction() | EquationFunction | Zwraca bieżący element jako EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Zwraca bieżący element jako EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Zwraca bieżący element jako EquationSymbol . |
asFooterSection() | FooterSection | Zwraca bieżący element jako FooterSection . |
asFootnote() | Footnote | Zwraca bieżący element jako Footnote . |
asFootnoteSection() | FootnoteSection | Zwraca bieżący element jako FootnoteSection . |
asHeaderSection() | HeaderSection | Zwraca bieżący element jako HeaderSection . |
asHorizontalRule() | HorizontalRule | Zwraca bieżący element jako HorizontalRule . |
asInlineDrawing() | InlineDrawing | Zwraca bieżący element jako InlineDrawing . |
asInlineImage() | InlineImage | Zwraca bieżący element jako InlineImage . |
asListItem() | ListItem | Zwraca bieżący element jako ListItem . |
asPageBreak() | PageBreak | Zwraca bieżący element jako PageBreak . |
asParagraph() | Paragraph | Zwraca bieżący element jako Paragraph . |
asPerson() | Person | Zwraca bieżący element jako Person . |
asRichLink() | RichLink | Zwraca bieżący element w postaci RichLink , np. link do pliku Arkuszy Google. |
asTable() | Table | Zwraca bieżący element jako Table . |
asTableCell() | TableCell | Zwraca bieżący element jako TableCell . |
asTableOfContents() | TableOfContents | Zwraca bieżący element jako TableOfContents . |
asTableRow() | TableRow | Zwraca bieżący element jako TableRow . |
asText() | Text | Zwraca bieżący element jako Text . |
copy() | Element | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | Element | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | Element | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | Element | Ustawia atrybuty elementu. |
ElementType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
BODY_SECTION | Enum | Typ odpowiadający elementowi Body . |
COMMENT_SECTION | Enum | Typ odpowiadający elementowi . |
DATE | Enum | Typ odpowiadający atrybutowi Date
. |
EQUATION | Enum | Typ odpowiadający elementowi Equation . |
EQUATION_FUNCTION | Enum | Typ odpowiadający elementowi EquationFunction . |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | Typ odpowiadający atrybutowi EquationFunctionArgumentSeparator
. |
EQUATION_SYMBOL | Enum | Typ odpowiadający elementowi EquationSymbol . |
RICH_LINK | Enum | Typ odpowiadający elementowi RichLink . |
FOOTER_SECTION | Enum | Typ odpowiadający elementowi FooterSection . |
FOOTNOTE | Enum | Typ odpowiadający elementowi Footnote . |
FOOTNOTE_SECTION | Enum | Typ odpowiadający elementowi FootnoteSection . |
HEADER_SECTION | Enum | Typ odpowiadający elementowi HeaderSection . |
HORIZONTAL_RULE | Enum | Typ odpowiadający elementowi HorizontalRule . |
INLINE_DRAWING | Enum | Typ odpowiadający elementowi InlineDrawing . |
INLINE_IMAGE | Enum | Typ odpowiadający elementowi InlineImage . |
LIST_ITEM | Enum | Typ odpowiadający elementowi ListItem . |
PAGE_BREAK | Enum | Typ odpowiadający elementowi PageBreak . |
PARAGRAPH | Enum | Typ odpowiadający elementowi Paragraph . |
PERSON | Enum | Typ odpowiadający elementowi Person . |
TABLE | Enum | Typ odpowiadający elementowi Table . |
TABLE_CELL | Enum | Typ odpowiadający elementowi TableCell . |
TABLE_OF_CONTENTS | Enum | Typ odpowiadający elementowi TableOfContents . |
TABLE_ROW | Enum | Typ odpowiadający elementowi TableRow . |
TEXT | Enum | Typ odpowiadający atrybutowi Text
. |
UNSUPPORTED | Enum | Typ odpowiadający wartości UnsupportedElement . |
Equation
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
clear() | Equation | Usuwa zawartość elementu. |
copy() | Equation | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | Equation | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | Equation | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | Equation | Ustawia atrybuty elementu. |
setLinkUrl(url) | Equation | Ustawia adres URL linku. |
setTextAlignment(textAlignment) | Equation | Określa wyrównanie tekstu. |
EquationFunction
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
clear() | EquationFunction | Usuwa zawartość elementu. |
copy() | EquationFunction | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getCode() | String | Pobiera kod odpowiadający funkcji równania. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | EquationFunction | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | EquationFunction | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | EquationFunction | Ustawia atrybuty elementu. |
setLinkUrl(url) | EquationFunction | Ustawia adres URL linku. |
setTextAlignment(textAlignment) | EquationFunction | Określa wyrównanie tekstu. |
EquationFunctionArgumentSeparator
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | EquationFunctionArgumentSeparator | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | EquationFunctionArgumentSeparator | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | EquationFunctionArgumentSeparator | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | EquationFunctionArgumentSeparator | Ustawia atrybuty elementu. |
EquationSymbol
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | EquationSymbol | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getCode() | String | Pobiera kod odpowiadający symbolowi równania. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | EquationSymbol | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | EquationSymbol | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | EquationSymbol | Ustawia atrybuty elementu. |
FontFamily
FooterSection
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendListItem(listItem) | ListItem | Dołącza podaną wartość ListItem . |
appendListItem(text) | ListItem | Tworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu. |
appendParagraph(paragraph) | Paragraph | Dołącza podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu. |
appendTable() | Table | Tworzy i dołącza nowy element Table . |
appendTable(cells) | Table | Dodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu. |
appendTable(table) | Table | Dołącza podaną wartość Table . |
clear() | FooterSection | Usuwa zawartość elementu. |
copy() | FooterSection | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera 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() | Integer | Pobiera liczbę dzieci. |
getParagraphs() | Paragraph[] | Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getTables() | Table[] | Pobiera wszystkie zasoby Tables zawarte w sekcji. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia nowy HorizontalRule w podanym indeksie. |
insertImage(childIndex, image) | InlineImage | Tworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertListItem(childIndex, listItem) | ListItem | Wstawia podaną wartość ListItem w określonym indeksie. |
insertListItem(childIndex, text) | ListItem | Tworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podaną wartość Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertTable(childIndex) | Table | Tworzy i wstawia nowy Table w podanym indeksie. |
insertTable(childIndex, cells) | Table | Tworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie. |
insertTable(childIndex, table) | Table | Wstawia podaną wartość Table w określonym indeksie. |
removeChild(child) | FooterSection | Usuwa określony element podrzędny. |
removeFromParent() | FooterSection | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | FooterSection | Ustawia atrybuty elementu. |
setText(text) | FooterSection | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | FooterSection | Określa wyrównanie tekstu. |
Footnote
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | Footnote | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getFootnoteContents() | FootnoteSection | Pobiera zawartość elementu przypisu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
removeFromParent() | Footnote | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | Footnote | Ustawia atrybuty elementu. |
FootnoteSection
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendParagraph(paragraph) | Paragraph | Dołącza podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu. |
clear() | FootnoteSection | Usuwa zawartość elementu. |
copy() | FootnoteSection | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParagraphs() | Paragraph[] | Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podaną wartość Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
removeChild(child) | FootnoteSection | Usuwa określony element podrzędny. |
removeFromParent() | FootnoteSection | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | FootnoteSection | Ustawia atrybuty elementu. |
setText(text) | FootnoteSection | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | FootnoteSection | Określa wyrównanie tekstu. |
GlyphType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
BULLET | Enum | Domyślny punktor okrągły i wypełniony. |
HOLLOW_BULLET | Enum | Pusty punktor. |
SQUARE_BULLET | Enum | Punktor kwadratowy. |
NUMBER | Enum | Punktor liczby. |
LATIN_UPPER | Enum | Punktor w alfabecie łacińskim. |
LATIN_LOWER | Enum | Punktor w alfabecie łacińskim. |
ROMAN_UPPER | Enum | Cyfra rzymska z wielkimi literami. |
ROMAN_LOWER | Enum | Cyfra rzymska z małą kropką. |
HeaderSection
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendListItem(listItem) | ListItem | Dołącza podaną wartość ListItem . |
appendListItem(text) | ListItem | Tworzy i dołącza nowy dokument ListItem zawierający określoną zawartość tekstu. |
appendParagraph(paragraph) | Paragraph | Dołącza podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy dokument Paragraph zawierający określoną zawartość tekstu. |
appendTable() | Table | Tworzy i dołącza nowy element Table . |
appendTable(cells) | Table | Dodaje nowy element Table zawierający TableCell dla każdej określonej wartości ciągu. |
appendTable(table) | Table | Dołącza podaną wartość Table . |
clear() | HeaderSection | Usuwa zawartość elementu. |
copy() | HeaderSection | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera 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() | Integer | Pobiera liczbę dzieci. |
getParagraphs() | Paragraph[] | Pobiera wszystkie funkcje Paragraphs zawarte w sekcji (w tym ListItems ). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getTables() | Table[] | Pobiera wszystkie zasoby Tables zawarte w sekcji. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia nowy HorizontalRule w podanym indeksie. |
insertImage(childIndex, image) | InlineImage | Tworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertListItem(childIndex, listItem) | ListItem | Wstawia podaną wartość ListItem w określonym indeksie. |
insertListItem(childIndex, text) | ListItem | Tworzy i wstawia nowy element ListItem w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podaną wartość Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia nowy element Paragraph w podanym indeksie, zawierający określony indeks
zawartość tekstową. |
insertTable(childIndex) | Table | Tworzy i wstawia nowy Table w podanym indeksie. |
insertTable(childIndex, cells) | Table | Tworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie. |
insertTable(childIndex, table) | Table | Wstawia podaną wartość Table w określonym indeksie. |
removeChild(child) | HeaderSection | Usuwa określony element podrzędny. |
removeFromParent() | HeaderSection | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | HeaderSection | Ustawia atrybuty elementu. |
setText(text) | HeaderSection | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | HeaderSection | Określa wyrównanie tekstu. |
HorizontalAlignment
Właściwości
Właściwość | Typ | Opis |
---|---|---|
LEFT | Enum | Opcja wyrównania do lewej. |
CENTER | Enum | Opcja wyrównania do środka. |
RIGHT | Enum | Opcja wyrównania do prawej. |
JUSTIFY | Enum | Opcja wyrównania. |
HorizontalRule
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | HorizontalRule | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
removeFromParent() | HorizontalRule | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | HorizontalRule | Ustawia atrybuty elementu. |
InlineDrawing
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | InlineDrawing | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAltDescription() | String | Zwraca alternatywny opis rysunku. |
getAltTitle() | String | Zwraca alternatywny tytuł rysunku. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | InlineDrawing | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | InlineDrawing | Usuwa element z elementu nadrzędnego. |
setAltDescription(description) | InlineDrawing | Ustawia alternatywny opis rysunku. |
setAltTitle(title) | InlineDrawing | Ustawia alternatywny tytuł rysunku. |
setAttributes(attributes) | InlineDrawing | Ustawia atrybuty elementu. |
InlineImage
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | InlineImage | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAltDescription() | String | Zwraca alternatywny opis obrazu. |
getAltTitle() | String | Zwraca alternatywny tytuł obrazu. |
getAs(contentType) | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getBlob() | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob. |
getHeight() | Integer | Pobiera wysokość obrazu w pikselach. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
getWidth() | Integer | Pobiera szerokość obrazu w pikselach. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | InlineImage | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | InlineImage | Usuwa element z elementu nadrzędnego. |
setAltDescription(description) | InlineImage | Ustawia alternatywny opis obrazu. |
setAltTitle(title) | InlineImage | Ustawia alternatywny tytuł obrazu. |
setAttributes(attributes) | InlineImage | Ustawia atrybuty elementu. |
setHeight(height) | InlineImage | Ustawia wysokość obrazu w pikselach. |
setLinkUrl(url) | InlineImage | Ustawia adres URL linku. |
setWidth(width) | InlineImage | Ustawia szerokość obrazu w pikselach. |
ListItem
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addPositionedImage(image) | PositionedImage | Tworzy i wstawia nowy obiekt PositionedImage z określonego obiektu blob obrazu. |
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendInlineImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendInlineImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dołącza podaną wartość PageBreak . |
appendText(text) | Text | Tworzy i dodaje nowy element Text z podaną zawartością. |
appendText(text) | Text | Dołącza podany element Text . |
clear() | ListItem | Usuwa zawartość elementu. |
copy() | ListItem | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAlignment() | HorizontalAlignment | Pobiera HorizontalAlignment . |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getGlyphType() | GlyphType | Pobiera GlyphType elementu listy. |
getHeading() | ParagraphHeading | Pobiera ParagraphHeading . |
getIndentEnd() | Number | Pobiera wcięcie końcowe (w punktach). |
getIndentFirstLine() | Number | Pobiera w punktach pierwsze wcięcie pierwszego wiersza. |
getIndentStart() | Number | Pobiera wcięcie początkowe. |
getLineSpacing() | Number | Pobiera odstępy między wierszami w punktach. |
getLinkUrl() | String | Pobiera adres URL linku. |
getListId() | String | Pobiera identyfikator listy. |
getNestingLevel() | Integer | Pobiera poziom zagnieżdżenia elementu listy. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPositionedImage(id) | PositionedImage | Pobiera wartość PositionedImage na podstawie identyfikatora obrazu. |
getPositionedImages() | PositionedImage[] | Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getSpacingAfter() | Number | Pobiera odstępy po elemencie w punktach. |
getSpacingBefore() | Number | Pobiera odstępy przed elementem (w punktach). |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia HorizontalRule w podanym indeksie. |
insertInlineImage(childIndex, image) | InlineImage | Tworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertInlineImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertPageBreak(childIndex) | PageBreak | Tworzy i wstawia nowy PageBreak w podanym indeksie. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Wstawia podaną wartość PageBreak w określonym indeksie. |
insertText(childIndex, text) | Text | Tworzy i wstawia nowy element tekstowy w określonym indeksie. |
insertText(childIndex, text) | Text | Wstawia dany element Text w określonym indeksie z określonym tekstem
treści. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
isLeftToRight() | Boolean | Pobiera ustawienie od lewej do prawej. |
merge() | ListItem | Scala element z poprzednim elementem potomnym tego samego typu. |
removeChild(child) | ListItem | Usuwa określony element podrzędny. |
removeFromParent() | ListItem | Usuwa element z elementu nadrzędnego. |
removePositionedImage(id) | Boolean | Usuwa wartość PositionedImage według identyfikatora obrazu. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAlignment(alignment) | ListItem | Ustawia HorizontalAlignment . |
setAttributes(attributes) | ListItem | Ustawia atrybuty elementu. |
setGlyphType(glyphType) | ListItem | Ustawia GlyphType elementu listy. |
setHeading(heading) | ListItem | Ustawia ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Ustawia wcięcie końcowe w punktach. |
setIndentFirstLine(indentFirstLine) | ListItem | Ustawia wcięcie pierwszego wiersza (w punktach). |
setIndentStart(indentStart) | ListItem | Ustawia wcięcie początkowe w punktach. |
setLeftToRight(leftToRight) | ListItem | Określa ustawienie tekstu od lewej do prawej. |
setLineSpacing(multiplier) | ListItem | Ustawia odstępy między wierszami jako liczbę określającą ich liczbę. |
setLinkUrl(url) | ListItem | Ustawia adres URL linku. |
setListId(listItem) | ListItem | Ustawia identyfikator listy. |
setNestingLevel(nestingLevel) | ListItem | Określa poziom zagnieżdżenia elementu listy. |
setSpacingAfter(spacingAfter) | ListItem | Ustawia odstępy po elemencie w punktach. |
setSpacingBefore(spacingBefore) | ListItem | Ustawia odstępy przed elementem w punktach. |
setText(text) | void | Ustawia zawartość elementu listy jako tekst. |
setTextAlignment(textAlignment) | ListItem | Określa wyrównanie tekstu. |
NamedRange
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getId() | String | Pobiera identyfikator tego zasobu (NamedRange ). |
getName() | String | Pobiera nazwę tego elementu (NamedRange ). |
getRange() | Range | Pobiera zakres elementów powiązanych z tym obiektem typu NamedRange . |
remove() | void | Usuwa element NamedRange z karty. |
PageBreak
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | PageBreak | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
removeFromParent() | PageBreak | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | PageBreak | Ustawia atrybuty elementu. |
Paragraph
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addPositionedImage(image) | PositionedImage | Tworzy i wstawia nowy obiekt PositionedImage z określonego obiektu blob obrazu. |
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendInlineImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendInlineImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendPageBreak() | PageBreak | Tworzy i dołącza nowy element PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Dołącza podaną wartość PageBreak . |
appendText(text) | Text | Tworzy i dodaje nowy element Text z podaną zawartością. |
appendText(text) | Text | Dołącza podany element Text . |
clear() | Paragraph | Usuwa zawartość elementu. |
copy() | Paragraph | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAlignment() | HorizontalAlignment | Pobiera HorizontalAlignment . |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getHeading() | ParagraphHeading | Pobiera ParagraphHeading . |
getIndentEnd() | Number | Pobiera wcięcie końcowe (w punktach). |
getIndentFirstLine() | Number | Pobiera w punktach pierwsze wcięcie pierwszego wiersza. |
getIndentStart() | Number | Pobiera wcięcie początkowe. |
getLineSpacing() | Number | Pobiera odstępy między wierszami w punktach. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPositionedImage(id) | PositionedImage | Pobiera wartość PositionedImage na podstawie identyfikatora obrazu. |
getPositionedImages() | PositionedImage[] | Pobiera wszystkie obiekty PositionedImage zakotwiczone do akapitu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getSpacingAfter() | Number | Pobiera odstępy po elemencie w punktach. |
getSpacingBefore() | Number | Pobiera odstępy przed elementem (w punktach). |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia HorizontalRule w podanym indeksie. |
insertInlineImage(childIndex, image) | InlineImage | Tworzy i wstawia nowy obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertInlineImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertPageBreak(childIndex) | PageBreak | Tworzy i wstawia nowy PageBreak w podanym indeksie. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Wstawia podaną wartość PageBreak w określonym indeksie. |
insertText(childIndex, text) | Text | Tworzy i wstawia nowy element tekstowy w określonym indeksie. |
insertText(childIndex, text) | Text | Wstawia dany element Text w określonym indeksie z określonym tekstem
treści. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
isLeftToRight() | Boolean | Pobiera ustawienie od lewej do prawej. |
merge() | Paragraph | Scala element z poprzednim elementem potomnym tego samego typu. |
removeChild(child) | Paragraph | Usuwa określony element podrzędny. |
removeFromParent() | Paragraph | Usuwa element z elementu nadrzędnego. |
removePositionedImage(id) | Boolean | Usuwa wartość PositionedImage według identyfikatora obrazu. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAlignment(alignment) | Paragraph | Ustawia HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Ustawia atrybuty elementu. |
setHeading(heading) | Paragraph | Ustawia ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Ustawia wcięcie końcowe w punktach. |
setIndentFirstLine(indentFirstLine) | Paragraph | Ustawia wcięcie pierwszego wiersza (w punktach). |
setIndentStart(indentStart) | Paragraph | Ustawia wcięcie początkowe w punktach. |
setLeftToRight(leftToRight) | Paragraph | Określa ustawienie tekstu od lewej do prawej. |
setLineSpacing(multiplier) | Paragraph | Ustawia odstępy między wierszami jako liczbę określającą ich liczbę. |
setLinkUrl(url) | Paragraph | Ustawia adres URL linku. |
setSpacingAfter(spacingAfter) | Paragraph | Ustawia odstępy po elemencie w punktach. |
setSpacingBefore(spacingBefore) | Paragraph | Ustawia odstępy przed elementem w punktach. |
setText(text) | void | Ustawia zawartość akapitu jako tekst. |
setTextAlignment(textAlignment) | Paragraph | Określa wyrównanie tekstu. |
ParagraphHeading
Właściwości
Właściwość | Typ | Opis |
---|---|---|
NORMAL | Enum | Opcja nagłówka zwykłego tekstu. |
HEADING1 | Enum | Opcja najwyższego nagłówka. |
HEADING2 | Enum | Opcja drugiego nagłówka. |
HEADING3 | Enum | Opcja trzeciego nagłówka |
HEADING4 | Enum | Czwarta opcja nagłówka. |
HEADING5 | Enum | Piąta opcja nagłówka. |
HEADING6 | Enum | Opcja najniższego nagłówka. |
TITLE | Enum | Opcja nagłówka tytułu. |
SUBTITLE | Enum | Opcja nagłówka podtytułu. |
Person
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | Person | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getEmail() | String | Zwraca adres e-mail osoby. |
getName() | String | Zwraca wyświetlaną nazwę osoby, jeśli została ustawiona. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | Person | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | Person | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | Person | Ustawia atrybuty elementu. |
Position
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getElement() | Element | Pobiera element zawierający Position . |
getOffset() | Integer | Pobiera względną lokalizację tego elementu (Position ) w elemencie, który go zawiera. |
getSurroundingText() | Text | Tworzy 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() | Integer | Pobiera przesunięcie wartości Position w elemencie Text zwróconym przez funkcję getSurroundingText() . |
insertBookmark() | Bookmark | Tworzy i wstawia nowy element Bookmark w tym miejscu: Position . |
insertInlineImage(image) | InlineImage | Tworzy i wstawia nowy element InlineImage w: Position na podstawie określonego obrazu
blob. |
insertText(text) | Text | Wstawia określony tekst w tym miejscu: Position . |
PositionedImage
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getAs(contentType) | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob przekonwertowany na określony typ treści. |
getBlob() | Blob | Zwraca dane wewnątrz tego obiektu jako obiekt blob. |
getHeight() | Integer | Pobiera wysokość obrazu w pikselach. |
getId() | String | Pobiera identyfikator obrazu. |
getLayout() | PositionedLayout | Pobiera wartość wyliczeniową, która reprezentuje układ obrazu. |
getLeftOffset() | Number | Pobiera przesunięcie obrazu (w punktach) od lewej krawędzi akapitu. |
getParagraph() | Paragraph | Pobiera Paragraph , do którego jest zakotwiczony obraz. |
getTopOffset() | Number | Pobiera przesunięcie obrazu (w punktach) od góry akapitu. |
getWidth() | Integer | Pobiera szerokość obrazu w pikselach. |
setHeight(height) | PositionedImage | Ustawia wysokość obrazu w pikselach. |
setLayout(layout) | PositionedImage | Określa definicję układu zdjęcia. |
setLeftOffset(offset) | PositionedImage | Określa przesunięcie obrazu (w punktach) od lewej krawędzi akapitu. |
setTopOffset(offset) | PositionedImage | Określa przesunięcie obrazu (w punktach) od góry akapitu. |
setWidth(width) | PositionedImage | Ustawia szerokość obrazu w pikselach. |
PositionedLayout
Właściwości
Właściwość | Typ | Opis |
---|---|---|
ABOVE_TEXT | Enum | Obraz jest umieszczony nad tekstem. |
BREAK_BOTH | Enum | Obraz dzieli tekst z lewej i prawej strony. |
BREAK_LEFT | Enum | Obraz dzieli tekst po lewej stronie. |
BREAK_RIGHT | Enum | Obraz dzieli tekst po prawej stronie. |
WRAP_TEXT | Enum | Obraz jest zawijany przez tekst. |
Range
Metody
Metoda | Zwracany typ | Kró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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
addElement(element) | RangeBuilder | Dodaje cały element Element do elementu RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Dodaje częściowy element Text do tego elementu (RangeBuilder ). |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Dodaje do tego elementu RangeBuilder 2 całe elementy i wszystkie elementy między nimi. |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Dodaje do pola RangeBuilder 2 częściowe elementy Text i wszystkie elementy między nimi. |
addRange(range) | RangeBuilder | Dodaje zawartość innego elementu Range do tego elementu (RangeBuilder ). |
build() | Range | Tworzy 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
Metoda | Zwracany typ | Krótki opis |
---|---|---|
getElement() | Element | Pobiera Element odpowiadającą RangeElement . |
getEndOffsetInclusive() | Integer | Pobiera pozycję końca częściowego zakresu w elemencie zakresu. |
getStartOffset() | Integer | Pobiera pozycję początku częściowego zakresu w elemencie zakresu. |
isPartial() | Boolean | Określa, czy ten element zakresu obejmuje cały element, czy jego część znaków elementu. |
RichLink
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | RichLink | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getMimeType() | String | Zwraca typ MIME
link, który jest dostępny, gdy element jest linkiem do pliku na Dysku oraz null
w przeciwnym razie. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getTitle() | String | Zwraca wyświetlany tytuł linku. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
getUrl() | String | Zwraca adres URL zasobu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | RichLink | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | RichLink | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | RichLink | Ustawia atrybuty elementu. |
Tab
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
asDocumentTab() | DocumentTab | Pobiera zawartość karty jako DocumentTab . |
getChildTabs() | Tab[] | Pobiera karty podrzędne zagnieżdżone w tej karcie. |
getId() | String | Pobiera identyfikator karty. |
getIndex() | Integer | Pobiera indeks karty w elemencie nadrzędnym oparty na 0. |
getTitle() | String | Pobiera tytuł karty. |
getType() | TabType | Pobiera typ karty. |
TabType
Właściwości
Właściwość | Typ | Opis |
---|---|---|
DOCUMENT_TAB | Enum | Typ odpowiadający wartości DocumentTab . |
Table
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendTableRow() | TableRow | Tworzy i dołącza nowy element TableRow . |
appendTableRow(tableRow) | TableRow | Dołącza podaną wartość TableRow . |
clear() | Table | Usuwa zawartość elementu. |
copy() | Table | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getBorderColor() | String | Pobiera kolor obramowania. |
getBorderWidth() | Number | Pobiera szerokość obramowania w punktach. |
getCell(rowIndex, cellIndex) | TableCell | Pobiera pole TableCell z określonego wiersza i indeksów komórek. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getColumnWidth(columnIndex) | Number | Pobiera szerokość określonej kolumny tabeli (w punktach). |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getNumRows() | Integer | Pobiera liczbę TableRows . |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getRow(rowIndex) | TableRow | Pobiera TableRow o określonym indeksie wiersza. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertTableRow(childIndex) | TableRow | Tworzy i wstawia nowy TableRow w podanym indeksie. |
insertTableRow(childIndex, tableRow) | TableRow | Wstawia podaną wartość TableRow w określonym indeksie. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
removeChild(child) | Table | Usuwa określony element podrzędny. |
removeFromParent() | Table | Usuwa element z elementu nadrzędnego. |
removeRow(rowIndex) | TableRow | Usuwa wartość TableRow w określonym indeksie wiersza. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | Table | Ustawia atrybuty elementu. |
setBorderColor(color) | Table | Ustawia kolor obramowania. |
setBorderWidth(width) | Table | Określa szerokość obramowania w punktach. |
setColumnWidth(columnIndex, width) | Table | Ustawia szerokość określonej kolumny (w punktach). |
setLinkUrl(url) | Table | Ustawia adres URL linku. |
setTextAlignment(textAlignment) | Table | Określa wyrównanie tekstu. |
TableCell
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendHorizontalRule() | HorizontalRule | Tworzy i dołącza nowy element HorizontalRule . |
appendImage(image) | InlineImage | Tworzy i dołącza nowy obiekt InlineImage z określonego obiektu blob obrazu. |
appendImage(image) | InlineImage | Dołącza podaną wartość InlineImage . |
appendListItem(listItem) | ListItem | Dołącza podaną wartość ListItem . |
appendListItem(text) | ListItem | Tworzy i dołącza nowy element ListItem . |
appendParagraph(paragraph) | Paragraph | Dołącza podaną wartość Paragraph . |
appendParagraph(text) | Paragraph | Tworzy i dołącza nowy element Paragraph . |
appendTable() | Table | Tworzy i dołącza nowy element Table . |
appendTable(cells) | Table | Dodaje nowy element Table zawierający określone komórki. |
appendTable(table) | Table | Dołącza podaną wartość Table . |
clear() | TableCell | Usuwa zawartość elementu. |
copy() | TableCell | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getBackgroundColor() | String | Pobiera kolor tła. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getColSpan() | Integer | Pobiera rozpiętość kolumny będącą liczbą kolumn komórek tabeli, które obejmuje ta komórka. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getPaddingBottom() | Number | Pobiera dopełnienie u dołu w punktach. |
getPaddingLeft() | Number | Pobiera dopełnienie z lewej strony w punktach. |
getPaddingRight() | Number | Pobiera odpowiednie dopełnienie w punktach. |
getPaddingTop() | Number | Pobiera górne dopełnienie (w punktach). |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getParentRow() | TableRow | Pobiera obiekt TableRow zawierający bieżącą wartość TableCell . |
getParentTable() | Table | Pobiera obiekt Table zawierający bieżącą wartość TableCell . |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getRowSpan() | Integer | Pobiera rozpiętość wierszy będącą liczbą wierszy komórek tabeli, które obejmuje ta komórka. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
getVerticalAlignment() | VerticalAlignment | Pobiera VerticalAlignment . |
getWidth() | Number | Pobiera szerokość kolumny zawierającej komórkę (w punktach). |
insertHorizontalRule(childIndex) | HorizontalRule | Tworzy i wstawia nowy HorizontalRule w podanym indeksie. |
insertImage(childIndex, image) | InlineImage | Tworzy i wstawia obiekt InlineImage z określonego obiektu blob w określonym miejscu
indeksu. |
insertImage(childIndex, image) | InlineImage | Wstawia podaną wartość InlineImage w określonym indeksie. |
insertListItem(childIndex, listItem) | ListItem | Wstawia podaną wartość ListItem w określonym indeksie. |
insertListItem(childIndex, text) | ListItem | Tworzy i wstawia nowy ListItem w podanym indeksie. |
insertParagraph(childIndex, paragraph) | Paragraph | Wstawia podaną wartość Paragraph w określonym indeksie. |
insertParagraph(childIndex, text) | Paragraph | Tworzy i wstawia nowy Paragraph w podanym indeksie. |
insertTable(childIndex) | Table | Tworzy i wstawia nowy Table w podanym indeksie. |
insertTable(childIndex, cells) | Table | Tworzy i wstawia nowy obiekt Table zawierający określone komórki w określonym indeksie. |
insertTable(childIndex, table) | Table | Wstawia podaną wartość Table w określonym indeksie. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | TableCell | Scala element z poprzednim elementem potomnym tego samego typu. |
removeChild(child) | TableCell | Usuwa określony element podrzędny. |
removeFromParent() | TableCell | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | TableCell | Ustawia atrybuty elementu. |
setBackgroundColor(color) | TableCell | Ustawia kolor tła. |
setLinkUrl(url) | TableCell | Ustawia adres URL linku. |
setPaddingBottom(paddingBottom) | TableCell | Ustawia dopełnienie u dołu w punktach. |
setPaddingLeft(paddingLeft) | TableCell | Ustawia dopełnienie z lewej strony w punktach. |
setPaddingRight(paddingRight) | TableCell | Ustawia odpowiednie dopełnienie w punktach. |
setPaddingTop(paddingTop) | TableCell | Ustawia dopełnienie u góry w punktach. |
setText(text) | TableCell | Ustawia zawartość jako zwykły tekst. |
setTextAlignment(textAlignment) | TableCell | Określa wyrównanie tekstu. |
setVerticalAlignment(alignment) | TableCell | Określa wyrównanie w pionie. |
setWidth(width) | TableCell | Określa szerokość kolumny zawierającej bieżącą komórkę (w punktach). |
TableOfContents
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
clear() | TableOfContents | Usuwa zawartość elementu. |
copy() | TableOfContents | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getLinkUrl() | String | Pobiera adres URL linku. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
removeFromParent() | TableOfContents | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | TableOfContents | Ustawia atrybuty elementu. |
setLinkUrl(url) | TableOfContents | Ustawia adres URL linku. |
setTextAlignment(textAlignment) | TableOfContents | Określa wyrównanie tekstu. |
TableRow
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendTableCell() | TableCell | Tworzy i dołącza nowy element TableCell . |
appendTableCell(textContents) | TableCell | Dołącza podany element TableCell zawierający określony tekst. |
appendTableCell(tableCell) | TableCell | Dołącza podaną wartość TableCell . |
clear() | TableRow | Usuwa zawartość elementu. |
copy() | TableRow | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findElement(elementType) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu podrzędnego określonego typu. |
findElement(elementType, from) | RangeElement | Przeszukuje zawartość elementu pod kątem elementu potomnego określonego typu, zaczynając od
określono RangeElement . |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getCell(cellIndex) | TableCell | Pobiera TableCell z podanego indeksu komórek. |
getChild(childIndex) | Element | Pobiera element podrzędny z określonego indeksu podrzędnego. |
getChildIndex(child) | Integer | Pobiera indeks podrzędny dla określonego elementu podrzędnego. |
getLinkUrl() | String | Pobiera adres URL linku. |
getMinimumHeight() | Number | Pobiera minimalną wysokość w punktach. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getNumCells() | Integer | Pobiera liczbę komórek w wierszu. |
getNumChildren() | Integer | Pobiera liczbę dzieci. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getParentTable() | Table | Pobiera pole Table zawierające bieżący wiersz. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertTableCell(childIndex) | TableCell | Tworzy i wstawia nowy TableCell w podanym indeksie. |
insertTableCell(childIndex, textContents) | TableCell | Wstawia podany element TableCell w określonym indeksie, zawierający podany tekst. |
insertTableCell(childIndex, tableCell) | TableCell | Wstawia podaną wartość TableCell w określonym indeksie. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | TableRow | Scala element z poprzednim elementem potomnym tego samego typu. |
removeCell(cellIndex) | TableCell | Usuwa wartość TableCell w podanym indeksie komórek. |
removeChild(child) | TableRow | Usuwa określony element podrzędny. |
removeFromParent() | TableRow | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(attributes) | TableRow | Ustawia atrybuty elementu. |
setLinkUrl(url) | TableRow | Ustawia adres URL linku. |
setMinimumHeight(minHeight) | TableRow | Określa minimalną wysokość w punktach. |
setTextAlignment(textAlignment) | TableRow | Określa wyrównanie tekstu. |
Text
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
appendText(text) | Text | Dodaje określony tekst na końcu tego obszaru tekstowego. |
copy() | Text | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
deleteText(startOffset, endOffsetInclusive) | Text | Usuwa zakres tekstu. |
editAsText() | Text | Pobiera wersję Text bieżącego elementu do edycji. |
findText(searchPattern) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu przy użyciu wyrażeń regularnych. |
findText(searchPattern, from) | RangeElement | Przeszukuje zawartość elementu pod kątem określonego wzorca tekstu, zaczynając od podanego wyniku wyszukiwania. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getAttributes(offset) | Object | Pobiera atrybuty z określonym przesunięciem znaków. |
getBackgroundColor() | String | Pobiera ustawienie koloru tła. |
getBackgroundColor(offset) | String | Pobiera kolor tła z określonym przesunięciem znaku. |
getFontFamily() | String | Pobiera ustawienie rodziny czcionek. |
getFontFamily(offset) | String | Pobiera rodzinę czcionek z określonym przesunięciem znaków. |
getFontSize() | Number | Pobiera ustawienie rozmiaru czcionki. |
getFontSize(offset) | Number | Pobiera rozmiar czcionki z określonym przesunięciem znaku. |
getForegroundColor() | String | Pobiera ustawienie koloru pierwszego planu. |
getForegroundColor(offset) | String | Pobiera kolor pierwszego planu z określonym przesunięciem znaku. |
getLinkUrl() | String | Pobiera adres URL linku. |
getLinkUrl(offset) | String | Pobiera adres URL linku z określonym przesunięciem znaków. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getText() | String | Pobiera zawartość elementu jako ciąg tekstowy. |
getTextAlignment() | TextAlignment | Pobiera wyrównanie tekstu. |
getTextAlignment(offset) | TextAlignment | Pobiera wyrównanie tekstu dla pojedynczego znaku. |
getTextAttributeIndices() | Integer[] | Pobiera zestaw indeksów tekstowych, które odpowiadają początkowi odrębnego formatowania tekstu biegi. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
insertText(offset, text) | Text | Wstawia określony tekst z podanym przesunięciem znaków. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
isBold() | Boolean | Pobiera ustawienie pogrubienia. |
isBold(offset) | Boolean | Pobiera ustawienie pogrubienia z określonym przesunięciem znaków. |
isItalic() | Boolean | Pobiera ustawienie kursywy. |
isItalic(offset) | Boolean | Pobiera ustawienie kursywy z określonym przesunięciem znaku. |
isStrikethrough() | Boolean | Pobiera ustawienie przekreślenia. |
isStrikethrough(offset) | Boolean | Pobiera ustawienie przekreślenia z określonym przesunięciem znaków. |
isUnderline() | Boolean | Pobiera ustawienie podkreślenia. |
isUnderline(offset) | Boolean | Pobiera ustawienie podkreślenia z określonym przesunięciem znaków. |
merge() | Text | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | Text | Usuwa element z elementu nadrzędnego. |
replaceText(searchPattern, replacement) | Element | Zastępuje wszystkie wystąpienia danego wzorca tekstowego danym ciągiem zastępczym, stosując zwykłe wyrażeń. |
setAttributes(startOffset, endOffsetInclusive, attributes) | Text | Stosuje określone atrybuty do podanego zakresu znaków. |
setAttributes(attributes) | Text | Ustawia atrybuty elementu. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | Ustawia kolor tła określonego zakresu znaków. |
setBackgroundColor(color) | Text | Ustawia kolor tła. |
setBold(bold) | Text | Określa ustawienie pogrubienia. |
setBold(startOffset, endOffsetInclusive, bold) | Text | Określa ustawienie pogrubienia w określonym zakresie znaków. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | Ustawia rodzinę czcionek dla określonego zakresu znaków. |
setFontFamily(fontFamilyName) | Text | Ustawia rodzinę czcionek. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | Ustawia rozmiar czcionki w określonym zakresie znaków. |
setFontSize(size) | Text | Ustawia rozmiar czcionki. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | Ustawia kolor pierwszego planu dla określonego zakresu znaków. |
setForegroundColor(color) | Text | Ustawia kolor pierwszego planu. |
setItalic(italic) | Text | Określa ustawienie kursywy. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | Określa ustawienie kursywy w określonym zakresie znaków. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | Ustawia adres URL linku dla określonego zakresu znaków. |
setLinkUrl(url) | Text | Ustawia adres URL linku. |
setStrikethrough(strikethrough) | Text | Określa ustawienie przekreślenia. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | Określa ustawienie przekreślenia w wybranym zakresie znaków. |
setText(text) | Text | Określa zawartość tekstu. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | Określa wyrównanie tekstu w danym zakresie znaków. |
setTextAlignment(textAlignment) | Text | Określa wyrównanie tekstu. |
setUnderline(underline) | Text | Określa ustawienie podkreślenia. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | Określa ustawienie podkreślenia w określonym zakresie znaków. |
TextAlignment
Właściwości
Właściwość | Typ | Opis |
---|---|---|
NORMAL | Enum | Normalne wyrównanie tekstu. |
SUPERSCRIPT | Enum | Wyrównanie tekstu w indeksie górnym. |
SUBSCRIPT | Enum | Wyrównanie tekstu w indeksie dolnym. |
UnsupportedElement
Metody
Metoda | Zwracany typ | Krótki opis |
---|---|---|
copy() | UnsupportedElement | Zwraca odłączoną, głęboką kopię bieżącego elementu. |
getAttributes() | Object | Pobiera atrybuty elementu. |
getNextSibling() | Element | Pobiera kolejny element równorzędny elementu. |
getParent() | ContainerElement | Pobiera element nadrzędny elementu. |
getPreviousSibling() | Element | Pobiera poprzedni element równorzędny elementu. |
getType() | ElementType | Pobiera wartość ElementType elementu. |
isAtDocumentEnd() | Boolean | Określa, czy element jest na końcu Document . |
merge() | UnsupportedElement | Scala element z poprzednim elementem potomnym tego samego typu. |
removeFromParent() | UnsupportedElement | Usuwa element z elementu nadrzędnego. |
setAttributes(attributes) | UnsupportedElement | Ustawia atrybuty elementu. |
VerticalAlignment
Właściwości
Właściwość | Typ | Opis |
---|---|---|
BOTTOM | Enum | Opcja wyrównania do dołu. |
CENTER | Enum | Opcja wyrównania do środka. |
TOP | Enum | Opcja wyrównania do góry. |