Document Service

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.
Document

Esse serviço permite que os scripts criem, acessem e modifiquem arquivos do Documentos Google.

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

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

Classes

NomeBreve descrição
AttributeUma enumeração dos atributos do elemento.
BodyUm elemento que representa um corpo de documento.
BookmarkUm objeto que representa um favorito.
ContainerElementUm elemento genérico que pode conter outros elementos.
DateUm elemento que representa uma data formatada
DocumentUm documento que contém elementos rich text e elementos como tabelas e listas.
DocumentAppO serviço Document cria e abre Documents que pode ser editado.
ElementUm elemento genérico.
ElementTypeUma enumeração de todos os tipos de elementos.
EquationElemento que representa uma expressão matemática.
EquationFunctionElemento que representa uma função em um Equation matemático.
EquationFunctionArgumentSeparatorElemento que representa um separador de função em um Equation matemático.
EquationSymbolElemento que representa um símbolo em um Equation matemático.
FontFamilyUma enumeração das fontes compatíveis.
FooterSectionElemento que representa uma seção de rodapé.
FootnoteElemento que representa uma nota de rodapé.
FootnoteSectionElemento que representa uma seção de nota de rodapé.
GlyphTypeUma enumeração dos tipos de glifos compatíveis.
HeaderSectionElemento que representa uma seção de cabeçalho.
HorizontalAlignmentUma enumeração dos tipos de alinhamento horizontal compatíveis.
HorizontalRuleUm elemento que representa uma regra horizontal.
InlineDrawingElemento que representa um desenho incorporado.
InlineImageElemento que representa uma imagem incorporada.
ListItemElemento que representa um item da lista.
NamedRangeUma Range que tem um nome e um ID para permitir a recuperação posterior.
PageBreakUm elemento que representa uma quebra de página.
ParagraphUm elemento que representa um parágrafo.
ParagraphHeadingUma enumeração dos cabeçalhos de parágrafo padrão.
PersonElemento que representa um link para uma pessoa.
PositionUma referência a um local no documento em relação a um elemento específico.
PositionedImageCorreção da imagem de posição fixada em um Paragraph.
PositionedLayoutUma enumeração que especifica como estabelecer uma PositionedImage em relação ao texto ao redor.
RangeUm intervalo de elementos em um documento.
RangeBuilderUm builder usado para construir objetos Range com elementos de documentos.
RangeElementUm wrapper em torno de um Element com um possível deslocamento de início e fim.
RichLinkUm elemento que representa um link para um recurso do Google, como um arquivo do Drive ou um vídeo do YouTube.
TableUm elemento que representa uma tabela.
TableCellUm elemento que representa uma célula da tabela.
TableOfContentsUm elemento que contém um sumário.
TableRowElemento que representa uma linha da tabela.
TextElemento que representa uma região de rich text.
TextAlignmentUma enumeração do tipo de alinhamento de texto
UnsupportedElementUm elemento que representa uma região desconhecida ou que não pode ser afetado por um script, como um número de página.
VerticalAlignmentUma enumeração dos tipos de alinhamento vertical compatíveis

Attribute

Propriedades

PropriedadeTipoDescrição
BACKGROUND_COLOREnumÉ a cor do plano de fundo de um elemento (parágrafo, tabela etc.) ou documento.
BOLDEnumA configuração de espessura da fonte para rich text.
BORDER_COLOREnumA cor da borda, para elementos da tabela.
BORDER_WIDTHEnumÉ a largura da borda em pontos para elementos da tabela.
CODEEnumO conteúdo do código, para elementos de equação.
FONT_FAMILYEnumÉ a configuração de família de fontes para rich text.
FONT_SIZEEnumÉ a configuração de tamanho da fonte em pontos para rich text.
FOREGROUND_COLOREnumConfiguração de cor em primeiro plano para rich text.
HEADINGEnumO tipo de título, para elementos de parágrafo (por exemplo, DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumA configuração de altura, para elementos de imagem.
HORIZONTAL_ALIGNMENTEnumO alinhamento horizontal, para elementos de parágrafo (por exemplo, DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumConfiguração de recuo do final em pontos para elementos de parágrafo.
INDENT_FIRST_LINEEnumA configuração de recuo da primeira linha em pontos para elementos de parágrafo.
INDENT_STARTEnumConfiguração de início do recuo em pontos para elementos de parágrafo.
ITALICEnumÉ a configuração de estilo de fonte para rich text.
GLYPH_TYPEEnumO tipo de glifo para elementos da lista de itens.
LEFT_TO_RIGHTEnumÉ a configuração de direção do texto para rich text.
LINE_SPACINGEnumConfiguração de espaçamento entre linhas como um multiplicador para elementos de parágrafo.
LINK_URLEnumÉ o URL do link para rich text.
LIST_IDEnumO ID da lista abrangente, para elementos do item da lista.
MARGIN_BOTTOMEnumA configuração de margem inferior em pontos para elementos de parágrafo.
MARGIN_LEFTEnumConfiguração da margem esquerda em pontos para elementos de parágrafo.
MARGIN_RIGHTEnumA configuração de margem direita em pontos para elementos de parágrafo.
MARGIN_TOPEnumA configuração de margem de cima em pontos para elementos de parágrafo.
NESTING_LEVELEnumNível de aninhamento do item para elementos da lista.
MINIMUM_HEIGHTEnumA configuração de altura mínima em pontos para elementos de linha da tabela.
PADDING_BOTTOMEnumConfiguração de padding inferior em pontos para elementos da célula da tabela.
PADDING_LEFTEnumConfiguração de padding à esquerda em pontos para elementos da célula da tabela.
PADDING_RIGHTEnumConfiguração de padding certa em pontos para elementos da célula da tabela.
PADDING_TOPEnumA configuração de padding superior em pontos para elementos da célula da tabela.
PAGE_HEIGHTEnumA configuração de altura da página em pontos para documentos.
PAGE_WIDTHEnumA configuração de largura da página em pontos para documentos.
SPACING_AFTEREnumConfiguração de espaçamento inferior em pontos para elementos de parágrafo.
SPACING_BEFOREEnumÉ a configuração de espaçamento superior em pontos para elementos de parágrafo.
STRIKETHROUGHEnumConfiguração de tachado para rich text.
UNDERLINEEnumConfiguração de sublinhado para rich text.
VERTICAL_ALIGNMENTEnumConfiguração de alinhamento vertical para elementos das células da tabela.
WIDTHEnumA configuração de largura para elementos da imagem da célula da tabela e da imagem.

Body

Métodos

MétodoTipo de retornoBreve descrição
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendImage(image)InlineImageCria e anexa uma nova InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAnexa a InlineImage fornecida.
appendListItem(listItem)ListItemAnexa a ListItem fornecida.
appendListItem(text)ListItemCria e anexa uma nova ListItem contendo o conteúdo de texto especificado.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAnexa a PageBreak fornecida.
appendParagraph(paragraph)ParagraphAnexa a Paragraph fornecida.
appendParagraph(text)ParagraphCria e anexa uma nova Paragraph contendo o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table contendo um TableCell para cada valor de string especificado.
appendTable(table)TableAnexa a Table fornecida.
clear()BodyLimpa o conteúdo do elemento.
copy()BodyRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getHeadingAttributes(paragraphHeading)ObjectRecupera o conjunto de atributos para o ParagraphHeading fornecido.
getImages()InlineImage[]Recupera todos os InlineImages contidos na seção.
getListItems()ListItem[]Recupera todos os ListItems contidos na seção.
getMarginBottom()NumberRecupera a margem de baixo, em pontos.
getMarginLeft()NumberRecupera a margem esquerda em pontos.
getMarginRight()NumberRecupera a margem direita.
getMarginTop()NumberRecupera a margem de cima.
getNumChildren()IntegerRecupera o número de filhos.
getPageHeight()NumberRecupera a altura da página em pontos.
getPageWidth()NumberRecupera a largura da página em pontos.
getParagraphs()Paragraph[]Recupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElementRecupera o elemento pai do elemento.
getTables()Table[]Recupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um novo HorizontalRule no índice especificado.
insertImage(childIndex, image)InlineImageCria e insere um InlineImage a partir do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice especificado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, com o conteúdo de texto especificado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice especificado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, com o conteúdo de texto especificado.
insertTable(childIndex)TableCria e insere um novo Table no índice especificado.
insertTable(childIndex, cells)TableCria e insere um novo Table com as células especificadas, no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice especificado.
removeChild(child)BodyRemove o elemento filho especificado.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)BodyDefine os atributos do elemento.
setHeadingAttributes(paragraphHeading, attributes)BodyDefine os atributos para o ParagraphHeading fornecido.
setMarginBottom(marginBottom)BodyDefine a margem inferior em pontos.
setMarginLeft(marginLeft)BodyDefine a margem esquerda em pontos.
setMarginRight(marginRight)BodyDefine a margem direita em pontos.
setMarginTop(marginTop)BodyDefine a margem de cima.
setPageHeight(pageHeight)BodyDefine a altura da página em pontos.
setPageWidth(pageWidth)BodyDefine a largura da página em pontos.
setText(text)BodyDefine o conteúdo como texto simples.
setTextAlignment(textAlignment)BodyDefine o alinhamento do texto.

Bookmark

Métodos

MétodoTipo de retornoBreve descrição
getId()StringRecebe o ID da Bookmark.
getPosition()PositionRecebe o Position do Bookmark no Document.
remove()voidExclui o Bookmark.

ContainerElement

Métodos

MétodoTipo de retornoBreve descrição
asBody()BodyRetorna o elemento atual como um Body.
asEquation()EquationRetorna o elemento atual como um Equation.
asFooterSection()FooterSectionRetorna o elemento atual como um FooterSection.
asFootnoteSection()FootnoteSectionRetorna o elemento atual como um FootnoteSection.
asHeaderSection()HeaderSectionRetorna o elemento atual como um HeaderSection.
asListItem()ListItemRetorna o elemento atual como um ListItem.
asParagraph()ParagraphRetorna o elemento atual como um Paragraph.
asTable()TableRetorna o elemento atual como um Table.
asTableCell()TableCellRetorna o elemento atual como um TableCell.
asTableOfContents()TableOfContentsRetorna o elemento atual como um TableOfContents.
asTableRow()TableRowRetorna o elemento atual como um TableRow.
clear()ContainerElementLimpa o conteúdo do elemento.
copy()ContainerElementRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()ContainerElementMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()ContainerElementRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)ContainerElementDefine os atributos do elemento.
setLinkUrl(url)ContainerElementDefine o URL do link.
setTextAlignment(textAlignment)ContainerElementDefine o alinhamento do texto.

Date

Métodos

MétodoTipo de retornoBreve descrição
copy()DateRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getDisplayText()StringRetorna o valor de exibição renderizado no documento.
getLocale()StringRetorna a localidade da data usada para o valor de exibição.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getTimestamp()DateRetorna o carimbo de data/hora associado à data.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()DateMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()DateRemove o elemento do pai.
setAttributes(attributes)DateDefine os atributos do elemento.

Document

Métodos

MétodoTipo de retornoBreve descrição
addBookmark(position)BookmarkAdiciona uma Bookmark na Position especificada.
addEditor(emailAddress)DocumentAdiciona o usuário especificado à lista de editores de Document.
addEditor(user)DocumentAdiciona o usuário especificado à lista de editores de Document.
addEditors(emailAddresses)DocumentAdiciona a matriz especificada de usuários à lista de editores de Document.
addFooter()FooterSectionAdiciona uma seção de rodapé a um documento, se não houver nenhuma.
addHeader()HeaderSectionAdiciona uma seção de cabeçalho do documento, se não houver nenhuma.
addNamedRange(name, range)NamedRangeAdiciona uma nova NamedRange, que é uma Range que tem um nome e um ID para permitir a recuperação posterior.
addViewer(emailAddress)DocumentAdiciona o usuário especificado à lista de visualizadores do Document.
addViewer(user)DocumentAdiciona o usuário especificado à lista de visualizadores do Document.
addViewers(emailAddresses)DocumentAdiciona a matriz de usuários especificada à lista de visualizadores de Document.
getAs(contentType)BlobRecupera o conteúdo atual da Document como um blob do tipo especificado.
getBlob()BlobRecupera o conteúdo atual da Document como um blob.
getBody()BodyRecupera o Body do documento ativo.
getBookmark(id)BookmarkRecebe o Bookmark com o ID fornecido.
getBookmarks()Bookmark[]Recebe todos os objetos Bookmark no documento.
getCursor()PositionRecebe o cursor do usuário no documento ativo.
getEditors()User[]Recebe a lista de editores desse Document.
getFooter()FooterSectionRecupera a seção de rodapé do documento, se houver.
getFootnotes()Footnote[]Recupera todos os elementos Footnote no corpo do documento.
getHeader()HeaderSectionRecupera a seção de cabeçalho do documento, se houver.
getId()StringRecupera o identificador exclusivo do documento.
getLanguage()StringRecebe o código de idioma do documento.
getName()StringRecupera o título do documento.
getNamedRangeById(id)NamedRangeRecebe o NamedRange com o ID fornecido.
getNamedRanges()NamedRange[]Recebe todos os objetos NamedRange no documento.
getNamedRanges(name)NamedRange[]Recebe todos os objetos NamedRange no documento com o nome fornecido.
getSelection()RangeRecebe a seleção do usuário no documento ativo.
getSupportedLanguageCodes()String[]Recebe todos os códigos de idioma compatíveis com os arquivos do Documentos Google.
getUrl()StringRecupera o URL para acessar o documento atual.
getViewers()User[]Recebe a lista de espectadores e comentaristas deste Document.
newPosition(element, offset)PositionCria um novo Position, que é uma referência a um local no documento, em relação a um elemento específico.
newRange()RangeBuilderCria um builder usado para construir objetos Range usando elementos do documento.
removeEditor(emailAddress)DocumentRemove o usuário especificado da lista de editores para o Document.
removeEditor(user)DocumentRemove o usuário especificado da lista de editores para o Document.
removeViewer(emailAddress)DocumentRemove o usuário em questão da lista de leitores e comentaristas do Document.
removeViewer(user)DocumentRemove o usuário em questão da lista de leitores e comentaristas do Document.
saveAndClose()voidSalva o Document atual.
setCursor(position)DocumentDefine o cursor do usuário no documento ativo, considerando um Position.
setLanguage(languageCode)DocumentDefine o código de idioma do documento.
setName(name)DocumentDefine o título do documento.
setSelection(range)DocumentDefine a seleção do usuário no documento ativo, com base em um Range.

DocumentApp

Propriedades

PropriedadeTipoDescrição
AttributeAttributeA enumeração Attribute.
ElementTypeElementTypeA enumeração ElementType.
FontFamilyFontFamilyA enumeração FontFamily.
GlyphTypeGlyphTypeA enumeração GlyphType.
HorizontalAlignmentHorizontalAlignmentA enumeração HorizontalAlignment.
ParagraphHeadingParagraphHeadingA enumeração ParagraphHeading.
PositionedLayoutPositionedLayoutA enumeração PositionedLayout.
TextAlignmentTextAlignmentA enumeração TextAlignment.
VerticalAlignmentVerticalAlignmentA enumeração VerticalAlignment.

Métodos

MétodoTipo de retornoBreve descrição
create(name)DocumentCria e retorna um novo documento.
getActiveDocument()DocumentRetorna o documento em que o script é vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente da interface do usuário do documento que permite que o script adicione recursos, como menus, caixas de diálogo e barras laterais.
openById(id)DocumentRetorna o documento com o ID especificado.
openByUrl(url)DocumentAbre e retorna o documento com o URL especificado.

Element

Métodos

MétodoTipo de retornoBreve descrição
asBody()BodyRetorna o elemento atual como um Body.
asDate()DateRetorna o elemento atual como um Date.
asEquation()EquationRetorna o elemento atual como um Equation.
asEquationFunction()EquationFunctionRetorna o elemento atual como um EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorRetorna o elemento atual como um EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolRetorna o elemento atual como um EquationSymbol.
asFooterSection()FooterSectionRetorna o elemento atual como um FooterSection.
asFootnote()FootnoteRetorna o elemento atual como um Footnote.
asFootnoteSection()FootnoteSectionRetorna o elemento atual como um FootnoteSection.
asHeaderSection()HeaderSectionRetorna o elemento atual como um HeaderSection.
asHorizontalRule()HorizontalRuleRetorna o elemento atual como um HorizontalRule.
asInlineDrawing()InlineDrawingRetorna o elemento atual como um InlineDrawing.
asInlineImage()InlineImageRetorna o elemento atual como um InlineImage.
asListItem()ListItemRetorna o elemento atual como um ListItem.
asPageBreak()PageBreakRetorna o elemento atual como um PageBreak.
asParagraph()ParagraphRetorna o elemento atual como um Paragraph.
asPerson()PersonRetorna o elemento atual como um Person.
asRichLink()RichLinkRetorna o elemento atual como um RichLink, por exemplo, um link para um arquivo do Planilhas Google.
asTable()TableRetorna o elemento atual como um Table.
asTableCell()TableCellRetorna o elemento atual como um TableCell.
asTableOfContents()TableOfContentsRetorna o elemento atual como um TableOfContents.
asTableRow()TableRowRetorna o elemento atual como um TableRow.
asText()TextRetorna o elemento atual como um Text.
copy()ElementRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()ElementMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()ElementRemove o elemento do pai.
setAttributes(attributes)ElementDefine os atributos do elemento.

ElementType

Propriedades

PropriedadeTipoDescrição
BODY_SECTIONEnumTipo correspondente ao elemento Body.
COMMENT_SECTIONEnumTipo correspondente ao elemento CommentSection.
DATEEnumTipo correspondente ao elemento Date.
DOCUMENTEnumO tipo que corresponde à raiz do documento.
EQUATIONEnumTipo correspondente ao elemento Equation.
EQUATION_FUNCTIONEnumTipo correspondente ao elemento EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumTipo correspondente ao elemento EquationFunctionArgumentSeparator.
EQUATION_SYMBOLEnumTipo correspondente ao elemento EquationSymbol.
RICH_LINKEnumTipo correspondente ao elemento RichLink.
FOOTER_SECTIONEnumTipo correspondente ao elemento FooterSection.
FOOTNOTEEnumTipo correspondente ao elemento Footnote.
FOOTNOTE_SECTIONEnumTipo correspondente ao elemento FootnoteSection.
HEADER_SECTIONEnumTipo correspondente ao elemento HeaderSection.
HORIZONTAL_RULEEnumTipo correspondente ao elemento HorizontalRule.
INLINE_DRAWINGEnumTipo correspondente ao elemento InlineDrawing.
INLINE_IMAGEEnumTipo correspondente ao elemento InlineImage.
LIST_ITEMEnumTipo correspondente ao elemento ListItem.
PAGE_BREAKEnumTipo correspondente ao elemento PageBreak.
PARAGRAPHEnumTipo correspondente ao elemento Paragraph.
PERSONEnumTipo correspondente ao elemento Person.
TABLEEnumTipo correspondente ao elemento Table.
TABLE_CELLEnumTipo correspondente ao elemento TableCell.
TABLE_OF_CONTENTSEnumTipo correspondente ao elemento TableOfContents.
TABLE_ROWEnumTipo correspondente ao elemento TableRow.
TEXTEnumTipo correspondente ao elemento Text.
UNSUPPORTEDEnumO tipo correspondente a UnsupportedElement.

Equation

Métodos

MétodoTipo de retornoBreve descrição
clear()EquationLimpa o conteúdo do elemento.
copy()EquationRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()EquationMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)EquationDefine os atributos do elemento.
setLinkUrl(url)EquationDefine o URL do link.
setTextAlignment(textAlignment)EquationDefine o alinhamento do texto.

EquationFunction

Métodos

MétodoTipo de retornoBreve descrição
clear()EquationFunctionLimpa o conteúdo do elemento.
copy()EquationFunctionRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getCode()StringRecupera o código correspondente à função de equação.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()EquationFunctionMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationFunctionRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)EquationFunctionDefine os atributos do elemento.
setLinkUrl(url)EquationFunctionDefine o URL do link.
setTextAlignment(textAlignment)EquationFunctionDefine o alinhamento do texto.

EquationFunctionArgumentSeparator

Métodos

MétodoTipo de retornoBreve descrição
copy()EquationFunctionArgumentSeparatorRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()EquationFunctionArgumentSeparatorMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationFunctionArgumentSeparatorRemove o elemento do pai.
setAttributes(attributes)EquationFunctionArgumentSeparatorDefine os atributos do elemento.

EquationSymbol

Métodos

MétodoTipo de retornoBreve descrição
copy()EquationSymbolRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getCode()StringRecupera o código correspondente ao símbolo de equação.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()EquationSymbolMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationSymbolRemove o elemento do pai.
setAttributes(attributes)EquationSymbolDefine os atributos do elemento.

FontFamily

FooterSection

Métodos

MétodoTipo de retornoBreve descrição
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendImage(image)InlineImageCria e anexa uma nova InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAnexa a InlineImage fornecida.
appendListItem(listItem)ListItemAnexa a ListItem fornecida.
appendListItem(text)ListItemCria e anexa uma nova ListItem contendo o conteúdo de texto especificado.
appendParagraph(paragraph)ParagraphAnexa a Paragraph fornecida.
appendParagraph(text)ParagraphCria e anexa uma nova Paragraph contendo o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table contendo um TableCell para cada valor de string especificado.
appendTable(table)TableAnexa a Table fornecida.
clear()FooterSectionLimpa o conteúdo do elemento.
copy()FooterSectionRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getImages()InlineImage[]Recupera todos os InlineImages contidos na seção.
getListItems()ListItem[]Recupera todos os ListItems contidos na seção.
getNumChildren()IntegerRecupera o número de filhos.
getParagraphs()Paragraph[]Recupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElementRecupera o elemento pai do elemento.
getTables()Table[]Recupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um novo HorizontalRule no índice especificado.
insertImage(childIndex, image)InlineImageCria e insere um InlineImage a partir do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice especificado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, com o conteúdo de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice especificado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, com o conteúdo de texto especificado.
insertTable(childIndex)TableCria e insere um novo Table no índice especificado.
insertTable(childIndex, cells)TableCria e insere um novo Table com as células especificadas, no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice especificado.
removeChild(child)FooterSectionRemove o elemento filho especificado.
removeFromParent()FooterSectionRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)FooterSectionDefine os atributos do elemento.
setText(text)FooterSectionDefine o conteúdo como texto simples.
setTextAlignment(textAlignment)FooterSectionDefine o alinhamento do texto.

Footnote

Métodos

MétodoTipo de retornoBreve descrição
copy()FootnoteRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getFootnoteContents()FootnoteSectionRecupera o conteúdo do elemento da nota de rodapé.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
removeFromParent()FootnoteRemove o elemento do pai.
setAttributes(attributes)FootnoteDefine os atributos do elemento.

FootnoteSection

Métodos

MétodoTipo de retornoBreve descrição
appendParagraph(paragraph)ParagraphAnexa a Paragraph fornecida.
appendParagraph(text)ParagraphCria e anexa uma nova Paragraph contendo o conteúdo de texto especificado.
clear()FootnoteSectionLimpa o conteúdo do elemento.
copy()FootnoteSectionRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParagraphs()Paragraph[]Recupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice especificado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, com o conteúdo de texto especificado.
removeChild(child)FootnoteSectionRemove o elemento filho especificado.
removeFromParent()FootnoteSectionRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)FootnoteSectionDefine os atributos do elemento.
setText(text)FootnoteSectionDefine o conteúdo como texto simples.
setTextAlignment(textAlignment)FootnoteSectionDefine o alinhamento do texto.

GlyphType

Propriedades

PropriedadeTipoDescrição
BULLETEnumMarcador padrão, circular e preenchido.
HOLLOW_BULLETEnumUm marcador oco.
SQUARE_BULLETEnumUm marcador quadrado.
NUMBEREnumMarcador com base em número.
LATIN_UPPEREnumMarcador latino maiúsculo.
LATIN_LOWEREnumMarcador latino latino.
ROMAN_UPPEREnumUm numeral romano, um marcador maiúsculo.
ROMAN_LOWEREnumUm numeral romano, um marcador minúsculo.

HeaderSection

Métodos

MétodoTipo de retornoBreve descrição
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendImage(image)InlineImageCria e anexa uma nova InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAnexa a InlineImage fornecida.
appendListItem(listItem)ListItemAnexa a ListItem fornecida.
appendListItem(text)ListItemCria e anexa uma nova ListItem contendo o conteúdo de texto especificado.
appendParagraph(paragraph)ParagraphAnexa a Paragraph fornecida.
appendParagraph(text)ParagraphCria e anexa uma nova Paragraph contendo o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table contendo um TableCell para cada valor de string especificado.
appendTable(table)TableAnexa a Table fornecida.
clear()HeaderSectionLimpa o conteúdo do elemento.
copy()HeaderSectionRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getImages()InlineImage[]Recupera todos os InlineImages contidos na seção.
getListItems()ListItem[]Recupera todos os ListItems contidos na seção.
getNumChildren()IntegerRecupera o número de filhos.
getParagraphs()Paragraph[]Recupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElementRecupera o elemento pai do elemento.
getTables()Table[]Recupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um novo HorizontalRule no índice especificado.
insertImage(childIndex, image)InlineImageCria e insere um InlineImage a partir do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice especificado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, com o conteúdo de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice especificado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, com o conteúdo de texto especificado.
insertTable(childIndex)TableCria e insere um novo Table no índice especificado.
insertTable(childIndex, cells)TableCria e insere um novo Table com as células especificadas, no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice especificado.
removeChild(child)HeaderSectionRemove o elemento filho especificado.
removeFromParent()HeaderSectionRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)HeaderSectionDefine os atributos do elemento.
setText(text)HeaderSectionDefine o conteúdo como texto simples.
setTextAlignment(textAlignment)HeaderSectionDefine o alinhamento do texto.

HorizontalAlignment

Propriedades

PropriedadeTipoDescrição
LEFTEnumA opção de alinhamento à esquerda.
CENTEREnumA opção de alinhamento central.
RIGHTEnumA opção de alinhamento à direita.
JUSTIFYEnumA opção justify-alignment.

HorizontalRule

Métodos

MétodoTipo de retornoBreve descrição
copy()HorizontalRuleRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
removeFromParent()HorizontalRuleRemove o elemento do pai.
setAttributes(attributes)HorizontalRuleDefine os atributos do elemento.

InlineDrawing

Métodos

MétodoTipo de retornoBreve descrição
copy()InlineDrawingRetorna uma cópia detalhada e removida do elemento atual.
getAltDescription()StringRetorna a descrição alternativa do desenho.
getAltTitle()StringRetorna o título alternativo do desenho.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()InlineDrawingMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()InlineDrawingRemove o elemento do pai.
setAltDescription(description)InlineDrawingDefine a descrição alternativa do desenho.
setAltTitle(title)InlineDrawingDefine o título alternativo do desenho.
setAttributes(attributes)InlineDrawingDefine os atributos do elemento.

InlineImage

Métodos

MétodoTipo de retornoBreve descrição
copy()InlineImageRetorna uma cópia detalhada e removida do elemento atual.
getAltDescription()StringRetorna a descrição alternativa da imagem.
getAltTitle()StringRetorna o título alternativo da imagem.
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getAttributes()ObjectRecupera os atributos do elemento.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getHeight()IntegerRecupera a altura da imagem em pixels.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
getWidth()IntegerRecupera a largura da imagem em pixels.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()InlineImageMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()InlineImageRemove o elemento do pai.
setAltDescription(description)InlineImageDefine a descrição alternativa da imagem.
setAltTitle(title)InlineImageDefine o título alternativo da imagem.
setAttributes(attributes)InlineImageDefine os atributos do elemento.
setHeight(height)InlineImageDefine a altura da imagem em pixels.
setLinkUrl(url)InlineImageDefine o URL do link.
setWidth(width)InlineImageDefine a largura da imagem em pixels.

ListItem

Métodos

MétodoTipo de retornoBreve descrição
addPositionedImage(image)PositionedImageCria e insere um novo PositionedImage com base no blob de imagem especificado.
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendInlineImage(image)InlineImageCria e anexa uma nova InlineImage do blob de imagem especificado.
appendInlineImage(image)InlineImageAnexa a InlineImage fornecida.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAnexa a PageBreak fornecida.
appendText(text)TextCria e anexa um novo elemento Text com o conteúdo especificado.
appendText(text)TextAnexa o elemento Text especificado.
clear()ListItemLimpa o conteúdo do elemento.
copy()ListItemRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAlignment()HorizontalAlignmentRecupera o HorizontalAlignment.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getGlyphType()GlyphTypeRecupera o GlyphType do item da lista.
getHeading()ParagraphHeadingRecupera o ParagraphHeading.
getIndentEnd()NumberRecupera o recuo final, em pontos.
getIndentFirstLine()NumberRecupera o primeiro recuo da linha em pontos.
getIndentStart()NumberRecupera o recuo inicial.
getLineSpacing()NumberRecupera o espaçamento entre linhas em pontos.
getLinkUrl()StringRecupera o URL do link.
getListId()StringRecupera o ID da lista.
getNestingLevel()IntegerRecupera o nível de aninhamento do item da lista.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPositionedImage(id)PositionedImageRecebe um PositionedImage pelo ID da imagem.
getPositionedImages()PositionedImage[]Faz todos os objetos PositionedImage ancorados no parágrafo.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getSpacingAfter()NumberRecupera o espaçamento após os elementos, em pontos.
getSpacingBefore()NumberRecupera o espaçamento antes dos elementos, em pontos.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um HorizontalRule no índice especificado.
insertInlineImage(childIndex, image)InlineImageCria e insere um novo InlineImage com base no blob de imagem especificado no índice especificado.
insertInlineImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice especificado.
insertText(childIndex, text)TextCria e insere um novo elemento de texto no índice especificado.
insertText(childIndex, text)Textinsere o elemento Text especificado no índice especificado com o conteúdo de texto especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
isLeftToRight()BooleanRecupera a configuração da esquerda para a direita.
merge()ListItemMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)ListItemRemove o elemento filho especificado.
removeFromParent()ListItemRemove o elemento do pai.
removePositionedImage(id)BooleanRemove um PositionedImage pelo ID da imagem.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAlignment(alignment)ListItemDefine o HorizontalAlignment.
setAttributes(attributes)ListItemDefine os atributos do elemento.
setGlyphType(glyphType)ListItemDefine o GlyphType da lista de itens.
setHeading(heading)ListItemDefine o ParagraphHeading.
setIndentEnd(indentEnd)ListItemDefine o recuo final em pontos.
setIndentFirstLine(indentFirstLine)ListItemDefine o recuo da primeira linha em pontos.
setIndentStart(indentStart)ListItemDefine o recuo do início em pontos.
setLeftToRight(leftToRight)ListItemDefine a configuração da esquerda para a direita.
setLineSpacing(multiplier)ListItemDefine o espaçamento entre as linhas, como uma quantidade que indica o número de linhas a serem usadas no espaçamento.
setLinkUrl(url)ListItemDefine o URL do link.
setListId(listItem)ListItemDefine o ID da lista.
setNestingLevel(nestingLevel)ListItemDefine o nível de aninhamento do item da lista.
setSpacingAfter(spacingAfter)ListItemDefine o espaçamento após os elementos em pontos.
setSpacingBefore(spacingBefore)ListItemDefine o espaçamento antes dos elementos em pontos.
setText(text)voidDefine o conteúdo do item da lista como texto.
setTextAlignment(textAlignment)ListItemDefine o alinhamento do texto.

NamedRange

Métodos

MétodoTipo de retornoBreve descrição
getId()StringRecebe o ID deste NamedRange.
getName()StringRecebe o nome desse NamedRange.
getRange()RangeRecebe o intervalo dos elementos associados a essa NamedRange.
remove()voidRemove esse NamedRange do documento.

PageBreak

Métodos

MétodoTipo de retornoBreve descrição
copy()PageBreakRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
removeFromParent()PageBreakRemove o elemento do pai.
setAttributes(attributes)PageBreakDefine os atributos do elemento.

Paragraph

Métodos

MétodoTipo de retornoBreve descrição
addPositionedImage(image)PositionedImageCria e insere um novo PositionedImage com base no blob de imagem especificado.
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendInlineImage(image)InlineImageCria e anexa uma nova InlineImage do blob de imagem especificado.
appendInlineImage(image)InlineImageAnexa a InlineImage fornecida.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAnexa a PageBreak fornecida.
appendText(text)TextCria e anexa um novo elemento Text com o conteúdo especificado.
appendText(text)TextAnexa o elemento Text especificado.
clear()ParagraphLimpa o conteúdo do elemento.
copy()ParagraphRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAlignment()HorizontalAlignmentRecupera o HorizontalAlignment.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getHeading()ParagraphHeadingRecupera o ParagraphHeading.
getIndentEnd()NumberRecupera o recuo final, em pontos.
getIndentFirstLine()NumberRecupera o primeiro recuo da linha em pontos.
getIndentStart()NumberRecupera o recuo inicial.
getLineSpacing()NumberRecupera o espaçamento entre linhas em pontos.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPositionedImage(id)PositionedImageRecebe um PositionedImage pelo ID da imagem.
getPositionedImages()PositionedImage[]Faz todos os objetos PositionedImage ancorados no parágrafo.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getSpacingAfter()NumberRecupera o espaçamento após os elementos, em pontos.
getSpacingBefore()NumberRecupera o espaçamento antes dos elementos, em pontos.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um HorizontalRule no índice especificado.
insertInlineImage(childIndex, image)InlineImageCria e insere um novo InlineImage com base no blob de imagem especificado no índice especificado.
insertInlineImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice especificado.
insertText(childIndex, text)TextCria e insere um novo elemento de texto no índice especificado.
insertText(childIndex, text)Textinsere o elemento Text especificado no índice especificado com o conteúdo de texto especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
isLeftToRight()BooleanRecupera a configuração da esquerda para a direita.
merge()ParagraphMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)ParagraphRemove o elemento filho especificado.
removeFromParent()ParagraphRemove o elemento do pai.
removePositionedImage(id)BooleanRemove um PositionedImage pelo ID da imagem.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAlignment(alignment)ParagraphDefine o HorizontalAlignment.
setAttributes(attributes)ParagraphDefine os atributos do elemento.
setHeading(heading)ParagraphDefine o ParagraphHeading.
setIndentEnd(indentEnd)ParagraphDefine o recuo final em pontos.
setIndentFirstLine(indentFirstLine)ParagraphDefine o recuo da primeira linha em pontos.
setIndentStart(indentStart)ParagraphDefine o recuo do início em pontos.
setLeftToRight(leftToRight)ParagraphDefine a configuração da esquerda para a direita.
setLineSpacing(multiplier)ParagraphDefine o espaçamento entre as linhas, como uma quantidade que indica o número de linhas a serem usadas no espaçamento.
setLinkUrl(url)ParagraphDefine o URL do link.
setSpacingAfter(spacingAfter)ParagraphDefine o espaçamento após os elementos em pontos.
setSpacingBefore(spacingBefore)ParagraphDefine o espaçamento antes dos elementos em pontos.
setText(text)voidDefine o conteúdo do parágrafo como texto.
setTextAlignment(textAlignment)ParagraphDefine o alinhamento do texto.

ParagraphHeading

Propriedades

PropriedadeTipoDescrição
NORMALEnumA opção de título para texto normal.
HEADING1EnumA opção de título mais alto.
HEADING2EnumA segunda opção de título.
HEADING3EnumA terceira opção de título
HEADING4EnumQuarta opção de título.
HEADING5EnumOpção de quinto título.
HEADING6EnumA opção de cabeçalho mais baixa.
TITLEEnumOpção de título do título.
SUBTITLEEnumOpção de título da legenda.

Person

Métodos

MétodoTipo de retornoBreve descrição
copy()PersonRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getEmail()StringRetorna o endereço de e-mail da pessoa.
getName()StringRetorna o nome de exibição da pessoa, se definido.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()PersonMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()PersonRemove o elemento do pai.
setAttributes(attributes)PersonDefine os atributos do elemento.

Position

Métodos

MétodoTipo de retornoBreve descrição
getElement()ElementRecebe o elemento que contém esse Position.
getOffset()IntegerRecebe o local relativo deste Position no elemento que o contém.
getSurroundingText()TextCrie um elemento Text artificial que represente o texto e a formatação da Paragraph ou do ListItem que contém o Position, seja diretamente ou por uma cadeia de elementos filhos.
getSurroundingTextOffset()IntegerRecebe o deslocamento desse Position no elemento Text retornado por getSurroundingText().
insertBookmark()BookmarkCria e insere um novo Bookmark neste Position.
insertInlineImage(image)InlineImageCria e insere um novo InlineImage neste Position usando o blob de imagem especificado.
insertText(text)TextInsere o texto especificado neste Position.

PositionedImage

Métodos

MétodoTipo de retornoBreve descrição
getAs(contentType)BlobRetorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado.
getBlob()BlobRetorne os dados dentro desse objeto como um blob.
getHeight()IntegerRecupera a altura da imagem em pixels.
getId()StringRecebe o ID da imagem.
getLayout()PositionedLayoutRecebe um valor de enumeração que representa como a imagem é exibida.
getLeftOffset()NumberRecebe o deslocamento da imagem, em pontos, do parágrafo à esquerda.
getParagraph()ParagraphRecebe o Paragraph em que a imagem está fixada.
getTopOffset()NumberRecebe o deslocamento da imagem, em pontos, da parte superior do parágrafo.
getWidth()IntegerRecupera a largura da imagem em pixels.
setHeight(height)PositionedImageDefine a altura da imagem em pixels.
setLayout(layout)PositionedImageDefine a definição de como a imagem é exibida.
setLeftOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, do parágrafo à esquerda.
setTopOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, na parte superior do parágrafo.
setWidth(width)PositionedImageDefine a largura da imagem em pixels.

PositionedLayout

Propriedades

PropriedadeTipoDescrição
ABOVE_TEXTEnumA imagem está posicionada acima do texto.
BREAK_BOTHEnumA imagem quebra o texto à esquerda e à direita.
BREAK_LEFTEnumA imagem quebra o texto à esquerda.
BREAK_RIGHTEnumA imagem quebra o texto à direita.
WRAP_TEXTEnumA imagem é quebrada por texto.

Range

Métodos

MétodoTipo de retornoBreve descrição
getRangeElements()RangeElement[]Recebe todos os elementos nesse Range, incluindo os elementos Text parciais (por exemplo, no caso de uma seleção que inclui apenas parte de um elemento Text).

RangeBuilder

Métodos

MétodoTipo de retornoBreve descrição
addElement(element)RangeBuilderAdiciona um Element inteiro a esse RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAdiciona um elemento Text parcial a este RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAdiciona dois elementos inteiros e todos os elementos entre eles a este RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAdiciona dois elementos Text parciais e todos os elementos entre eles ao RangeBuilder.
addRange(range)RangeBuilderAdiciona o conteúdo de outro Range a este RangeBuilder.
build()RangeCria um Range com base nas configurações aplicadas ao builder.
getRangeElements()RangeElement[]Recebe todos os elementos nesse Range, incluindo os elementos Text parciais (por exemplo, no caso de uma seleção que inclui apenas parte de um elemento Text).

RangeElement

Métodos

MétodoTipo de retornoBreve descrição
getElement()ElementRecebe o Element que corresponde a esse RangeElement.
getEndOffsetInclusive()IntegerRecebe a posição do fim de um intervalo parcial no elemento de intervalo.
getStartOffset()IntegerRecebe a posição do início de um intervalo parcial no elemento de intervalo.
isPartial()BooleanDetermina se esse elemento de intervalo abrange todo o elemento ou uma seleção parcial dos caracteres do elemento.

Métodos

MétodoTipo de retornoBreve descrição
copy()RichLinkRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getMimeType()StringRetorna o tipo MIME do link, disponível quando o item é um link para um arquivo do Drive e null, caso contrário.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getTitle()StringRetorna o título exibido do link.
getType()ElementTypeRecupera o ElementType do elemento.
getUrl()StringRetorna o URL do recurso.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()RichLinkMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()RichLinkRemove o elemento do pai.
setAttributes(attributes)RichLinkDefine os atributos do elemento.

Table

Métodos

MétodoTipo de retornoBreve descrição
appendTableRow()TableRowCria e anexa um novo TableRow.
appendTableRow(tableRow)TableRowAnexa a TableRow fornecida.
clear()TableLimpa o conteúdo do elemento.
copy()TableRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getBorderColor()StringRecupera a cor da borda.
getBorderWidth()NumberRecupera a largura da borda em pontos.
getCell(rowIndex, cellIndex)TableCellRecupera o TableCell nos índices de linhas e células especificados.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getColumnWidth(columnIndex)NumberRecupera a largura da coluna da tabela especificada em pontos.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getNumRows()IntegerRecupera o número de TableRows.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getRow(rowIndex)TableRowRecupera o TableRow no índice de linha especificado.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertTableRow(childIndex)TableRowCria e insere um novo TableRow no índice especificado.
insertTableRow(childIndex, tableRow)TableRowInsere o TableRow especificado no índice especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
removeChild(child)TableRemove o elemento filho especificado.
removeFromParent()TableRemove o elemento do pai.
removeRow(rowIndex)TableRowRemove o TableRow no índice de linhas especificado.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)TableDefine os atributos do elemento.
setBorderColor(color)TableDefine a cor da borda.
setBorderWidth(width)TableDefine a largura da borda em pontos.
setColumnWidth(columnIndex, width)TableDefine a largura da coluna especificada em pontos.
setLinkUrl(url)TableDefine o URL do link.
setTextAlignment(textAlignment)TableDefine o alinhamento do texto.

TableCell

Métodos

MétodoTipo de retornoBreve descrição
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendImage(image)InlineImageCria e anexa uma nova InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAnexa a InlineImage fornecida.
appendListItem(listItem)ListItemAnexa a ListItem fornecida.
appendListItem(text)ListItemCria e anexa um novo ListItem.
appendParagraph(paragraph)ParagraphAnexa a Paragraph fornecida.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table contendo as células especificadas.
appendTable(table)TableAnexa a Table fornecida.
clear()TableCellLimpa o conteúdo do elemento.
copy()TableCellRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getBackgroundColor()StringRecupera a cor do plano de fundo.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getColSpan()IntegerRecupera o período da coluna, que é o número de colunas das células da tabela que essa célula abrange.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getPaddingBottom()NumberRecupera o padding da parte inferior, em pontos.
getPaddingLeft()NumberRecupera o padding esquerdo, em pontos.
getPaddingRight()NumberRecupera o padding certo, em pontos.
getPaddingTop()NumberRecupera o padding superior, em pontos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getParentRow()TableRowRecupera a TableRow contendo o TableCell atual.
getParentTable()TableRecupera a Table contendo o TableCell atual.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getRowSpan()IntegerRecupera o período da linha, que é o número de linhas de células da tabela que essa célula abrange.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
getVerticalAlignment()VerticalAlignmentRecupera o VerticalAlignment.
getWidth()NumberRecupera a largura da coluna que contém a célula em pontos.
insertHorizontalRule(childIndex)HorizontalRuleCria e insere um novo HorizontalRule no índice especificado.
insertImage(childIndex, image)InlineImageCria e insere um InlineImage a partir do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice especificado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice especificado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice especificado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado.
insertTable(childIndex)TableCria e insere um novo Table no índice especificado.
insertTable(childIndex, cells)TableCria e insere um novo Table com as células especificadas, no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()TableCellMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)TableCellRemove o elemento filho especificado.
removeFromParent()TableCellRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)TableCellDefine os atributos do elemento.
setBackgroundColor(color)TableCellDefine a cor do plano de fundo.
setLinkUrl(url)TableCellDefine o URL do link.
setPaddingBottom(paddingBottom)TableCellDefine o padding inferior, em pontos.
setPaddingLeft(paddingLeft)TableCellDefine o padding esquerdo, em pontos.
setPaddingRight(paddingTop)TableCellDefine o padding certo, em pontos.
setPaddingTop(paddingTop)TableCellDefine o padding superior, em pontos.
setText(text)TableCellDefine o conteúdo como texto simples.
setTextAlignment(textAlignment)TableCellDefine o alinhamento do texto.
setVerticalAlignment(alignment)TableCellDefine o alinhamento vertical.
setWidth(width)TableCellDefine a largura da coluna que contém a célula atual em pontos.

TableOfContents

Métodos

MétodoTipo de retornoBreve descrição
clear()TableOfContentsLimpa o conteúdo do elemento.
copy()TableOfContentsRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()StringRecupera o URL do link.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
removeFromParent()TableOfContentsRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)TableOfContentsDefine os atributos do elemento.
setLinkUrl(url)TableOfContentsDefine o URL do link.
setTextAlignment(textAlignment)TableOfContentsDefine o alinhamento do texto.

TableRow

Métodos

MétodoTipo de retornoBreve descrição
appendTableCell()TableCellCria e anexa um novo TableCell.
appendTableCell(textContents)TableCellAnexa a classe TableCell especificada com o texto especificado.
appendTableCell(tableCell)TableCellAnexa a TableCell fornecida.
clear()TableRowLimpa o conteúdo do elemento.
copy()TableRowRetorna uma cópia detalhada e removida do elemento atual.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findElement(elementType)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado.
findElement(elementType, from)RangeElementPesquisa o conteúdo do elemento para um descendente do tipo especificado, começando pela RangeElement especificada.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getCell(cellIndex)TableCellRecupera a TableCell no índice de célula especificado.
getChild(childIndex)ElementRecupera o elemento filho no índice filho especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()StringRecupera o URL do link.
getMinimumHeight()NumberRecupera a altura mínima em pontos.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getNumCells()IntegerRecupera o número de células na linha.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElementRecupera o elemento pai do elemento.
getParentTable()TableRecupera a Table que contém a linha atual.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertTableCell(childIndex)TableCellCria e insere um novo TableCell no índice especificado.
insertTableCell(childIndex, textContents)TableCellInsere o TableCell especificado no índice especificado, contendo o texto especificado.
insertTableCell(childIndex, tableCell)TableCellInsere o TableCell especificado no índice especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()TableRowMescla o elemento com o irmão anterior do mesmo tipo.
removeCell(cellIndex)TableCellRemove o TableCell no índice de células especificado.
removeChild(child)TableRowRemove o elemento filho especificado.
removeFromParent()TableRowRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(attributes)TableRowDefine os atributos do elemento.
setLinkUrl(url)TableRowDefine o URL do link.
setMinimumHeight(minHeight)TableRowDefine a altura mínima, em pontos.
setTextAlignment(textAlignment)TableRowDefine o alinhamento do texto.

Text

Métodos

MétodoTipo de retornoBreve descrição
appendText(text)TextAdiciona o texto especificado ao final desta região de texto.
copy()TextRetorna uma cópia detalhada e removida do elemento atual.
deleteText(startOffset, endOffsetInclusive)TextExclui um intervalo de texto.
editAsText()TextRecebe uma versão de Text do elemento atual para edição.
findText(searchPattern)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElementPesquisa o conteúdo do elemento para o padrão de texto especificado, começando com um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getAttributes(offset)ObjectRecupera os atributos no deslocamento de caracteres especificado.
getBackgroundColor()StringRecupera a configuração de cor de fundo.
getBackgroundColor(offset)StringRecupera a cor do plano de fundo no deslocamento de caracteres especificado.
getFontFamily()StringRecupera a configuração da família de fontes.
getFontFamily(offset)StringRecupera a família de fontes no deslocamento de caracteres especificado.
getFontSize()NumberRecupera a configuração do tamanho da fonte.
getFontSize(offset)NumberRecupera o tamanho da fonte no deslocamento de caracteres especificado.
getForegroundColor()StringRecupera a configuração de cor em primeiro plano.
getForegroundColor(offset)StringRecupera a cor do primeiro plano no deslocamento de caracteres especificado.
getLinkUrl()StringRecupera o URL do link.
getLinkUrl(offset)StringRecupera o URL do link no deslocamento de caracteres especificado.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignmentRecebe o alinhamento do texto.
getTextAlignment(offset)TextAlignmentRecebe o alinhamento do texto para um único caractere.
getTextAttributeIndices()Integer[]Recupera o conjunto de índices de texto que correspondem ao início de execuções de formatação de texto diferentes.
getType()ElementTypeRecupera o ElementType do elemento.
insertText(offset, text)TextInsere o texto especificado no deslocamento de caracteres especificado.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
isBold()BooleanRecupera a configuração em negrito.
isBold(offset)BooleanRecupera a configuração em negrito no deslocamento de caracteres especificado.
isItalic()BooleanRecupera a configuração de itálico.
isItalic(offset)BooleanRecupera a configuração de itálico no deslocamento de caracteres especificado.
isStrikethrough()BooleanRecupera a configuração tachada.
isStrikethrough(offset)BooleanRecupera a configuração tachada no deslocamento de caracteres especificado.
isUnderline()BooleanRecupera a configuração de sublinhado.
isUnderline(offset)BooleanRecupera a configuração de sublinhado no deslocamento de caracteres especificado.
merge()TextMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()TextRemove o elemento do pai.
replaceText(searchPattern, replacement)ElementSubstitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição usando expressões regulares.
setAttributes(startOffset, endOffsetInclusive, attributes)TextAplica os atributos especificados ao intervalo de caracteres especificado.
setAttributes(attributes)TextDefine os atributos do elemento.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextDefine a cor do plano de fundo do intervalo de caracteres especificado.
setBackgroundColor(color)TextDefine a cor do plano de fundo.
setBold(bold)TextDefine a configuração de negrito.
setBold(startOffset, endOffsetInclusive, bold)TextDefine a configuração de negrito para o intervalo de caracteres especificado.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextDefine a família de fontes do intervalo de caracteres especificado.
setFontFamily(fontFamilyName)TextDefine a família de fontes.
setFontSize(startOffset, endOffsetInclusive, size)TextDefine o tamanho da fonte para o intervalo de caracteres especificado.
setFontSize(size)TextDefine o tamanho da fonte.
setForegroundColor(startOffset, endOffsetInclusive, color)TextDefine a cor do primeiro plano para o intervalo de caracteres especificado.
setForegroundColor(color)TextDefine a cor do primeiro plano.
setItalic(italic)TextDefine a configuração de itálico.
setItalic(startOffset, endOffsetInclusive, italic)TextDefine a configuração de itálico para o intervalo de caracteres especificado.
setLinkUrl(startOffset, endOffsetInclusive, url)TextDefine o URL do link para o intervalo de caracteres especificado.
setLinkUrl(url)TextDefine o URL do link.
setStrikethrough(strikethrough)TextDefine a configuração de tachado.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextDefine a configuração de tachado para o intervalo de caracteres especificado.
setText(text)TextDefine o conteúdo de texto.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextDefine o alinhamento do texto para um determinado intervalo de caracteres.
setTextAlignment(textAlignment)TextDefine o alinhamento do texto.
setUnderline(underline)TextDefine a configuração de sublinhado.
setUnderline(startOffset, endOffsetInclusive, underline)TextDefine a configuração de sublinhado do intervalo de caracteres especificado.

TextAlignment

Propriedades

PropriedadeTipoDescrição
NORMALEnumO alinhamento normal do texto.
SUPERSCRIPTEnumO alinhamento do texto sobrescrito.
SUBSCRIPTEnumO alinhamento do texto do subscrito.

UnsupportedElement

Métodos

MétodoTipo de retornoBreve descrição
copy()UnsupportedElementRetorna uma cópia detalhada e removida do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()ElementRecupera o próximo elemento irmão do elemento.
getParent()ContainerElementRecupera o elemento pai do elemento.
getPreviousSibling()ElementRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no fim do Document.
merge()UnsupportedElementMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()UnsupportedElementRemove o elemento do pai.
setAttributes(attributes)UnsupportedElementDefine os atributos do elemento.

VerticalAlignment

Propriedades

PropriedadeTipoDescrição
BOTTOMEnumA opção de alinhamento inferior.
CENTEREnumA opção de alinhamento central.
TOPEnumA opção de alinhamento superior.