Document Service

Document

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

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

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

Classes

NomeBreve descrição
AttributeUma enumeração dos atributos do elemento.
BodyO conteúdo de uma guia em um documento do Google Docs.
BookmarkUm objeto que representa um marcador.
ContainerElementUm elemento genérico que pode conter outros elementos.
DateUm elemento que representa uma data formatada
DocumentUm documento que contém um ou mais objetos Tab, cada um com texto formatado e elementos como tabelas e listas.
DocumentAppO serviço de documentos cria e abre Documents que podem ser editados.
DocumentTabUma guia de documento que contém texto formatado e elementos como tabelas e listas.
ElementUm elemento genérico.
ElementTypeUma enumeração de todos os tipos de elementos.
EquationUm elemento que representa uma expressão matemática.
EquationFunctionUm elemento que representa uma função em um Equation matemático.
EquationFunctionArgumentSeparatorUm elemento que representa um separador de função em uma Equation matemática.
EquationSymbolUm elemento que representa um símbolo em uma Equation matemática.
FontFamilyUma enumeração das fontes compatíveis.
FooterSectionUm elemento que representa uma seção de rodapé.
FootnoteUm elemento que representa uma nota de rodapé.
FootnoteSectionUm elemento que representa uma seção de nota de rodapé.
GlyphTypeUma enumeração dos tipos de glifos compatíveis.
HeaderSectionUm elemento 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.
InlineDrawingUm elemento que representa um desenho incorporado.
InlineImageUm elemento que representa uma imagem incorporada.
ListItemUm elemento que representa um item de lista.
NamedRangeUm Range com 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.
PersonUm elemento que representa um link para uma pessoa.
PositionUma referência a um local na guia do documento, em relação a um elemento específico.
PositionedImageImagem de posição fixa ancorada em um Paragraph.
PositionedLayoutUma enumeração que especifica como dispor um PositionedImage em relação ao texto ao redor.
RangeUm intervalo de elementos em um documento.
RangeBuilderUm builder usado para criar objetos Range de elementos de documento.
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.
TabUma guia em um documento do Google Docs.
TabTypeUma enumeração de todos os tipos de guias.
TableUm elemento que representa uma tabela.
TableCellUm elemento que representa uma célula de tabela.
TableOfContentsUm elemento que contém um sumário.
TableRowUm elemento que representa uma linha da tabela.
TextUm elemento que representa uma região de rich text.
TextAlignmentUma enumeração do tipo de alinhamentos de texto.
UnsupportedElementUm elemento que representa uma região desconhecida ou que não pode ser afetada 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_COLOREnumA cor de fundo de um elemento (parágrafo, tabela etc.) ou documento.
BOLDEnumA configuração de peso da fonte para rich text.
BORDER_COLOREnumA cor da borda para elementos de tabela.
BORDER_WIDTHEnumA largura da borda em pontos para elementos de tabela.
CODEEnumO conteúdo do código para elementos de equação.
FONT_FAMILYEnumA configuração da família de fontes para texto formatado.
FONT_SIZEEnumA configuração do tamanho da fonte em pontos para texto formatado.
FOREGROUND_COLOREnumA configuração de cor de primeiro plano para rich text.
HEADINGEnumO tipo de cabeçalho 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_ENDEnumA configuração de recuo 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_STARTEnumA configuração de recuo inicial em pontos para elementos de parágrafo.
ITALICEnumA configuração de estilo da fonte para rich text.
GLYPH_TYPEEnumO tipo de glifo para elementos de item de lista.
LEFT_TO_RIGHTEnumA configuração de direção do texto para rich text.
LINE_SPACINGEnumA configuração de espaçamento entre linhas como um multiplicador para elementos de parágrafo.
LINK_URLEnumO URL do link para texto formatado.
LIST_IDEnumO ID da lista abrangente para elementos de itens da lista.
MARGIN_BOTTOMEnumA configuração da margem inferior em pontos para elementos de parágrafo.
MARGIN_LEFTEnumA configuração da margem esquerda em pontos para elementos de parágrafo.
MARGIN_RIGHTEnumA configuração da margem direita em pontos para elementos de parágrafo.
MARGIN_TOPEnumA configuração da margem superior em pontos para elementos de parágrafo.
NESTING_LEVELEnumO nível de aninhamento do item para elementos de item da lista.
MINIMUM_HEIGHTEnumA configuração de altura mínima em pontos para elementos de linha da tabela.
PADDING_BOTTOMEnumA configuração de padding da parte de baixo em pontos para elementos de célula da tabela.
PADDING_LEFTEnumA configuração de padding à esquerda em pontos para elementos de célula da tabela.
PADDING_RIGHTEnumA configuração de padding à direita em pontos para elementos de célula da tabela.
PADDING_TOPEnumA configuração de padding superior em pontos para elementos de 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_AFTEREnumA configuração de espaçamento inferior em pontos para elementos de parágrafo.
SPACING_BEFOREEnumA configuração de espaçamento superior em pontos para elementos de parágrafo.
STRIKETHROUGHEnumA configuração de tachado para rich text.
UNDERLINEEnumA configuração de sublinhado para rich text.
VERTICAL_ALIGNMENTEnumA configuração de alinhamento vertical para elementos de célula da tabela.
WIDTHEnumA configuração de largura para elementos de célula de tabela e imagem.

Body

Métodos

MétodoTipo de retornoBreve descrição
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendImage(image)InlineImageCria e anexa um novo InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAcrescenta o InlineImage especificado.
appendListItem(listItem)ListItemAcrescenta o ListItem especificado.
appendListItem(text)ListItemCria e anexa um novo ListItem que contém o conteúdo de texto especificado.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAcrescenta o PageBreak especificado.
appendParagraph(paragraph)ParagraphAcrescenta o Paragraph especificado.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph que contém o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table que contém um TableCell para cada valor de string especificado.
appendTable(table)TableAcrescenta o Table especificado.
clear()BodyLimpa o conteúdo do elemento.
copy()BodyRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getHeadingAttributes(paragraphHeading)ObjectRecupera o conjunto de atributos do ParagraphHeading fornecido.
getImages()InlineImage[]|nullRecupera todos os InlineImages contidos na seção.
getListItems()ListItem[]|nullRecupera todos os ListItems contidos na seção.
getMarginBottom()Number|nullRecupera a margem inferior, em pontos.
getMarginLeft()Number|nullRecupera a margem esquerda, em pontos.
getMarginRight()Number|nullRecupera a margem direita.
getMarginTop()Number|nullRecupera a margem superior.
getNumChildren()IntegerRecupera o número de filhos.
getPageHeight()Number|nullRecupera a altura da página, em pontos.
getPageWidth()Number|nullRecupera a largura da página em pontos.
getParagraphs()Paragraph[]|nullRecupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getTables()Table[]|nullRecupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice indicado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice indicado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, contendo 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 indicado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice indicado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, contendo 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 contendo as células especificadas no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice indicado.
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 superior.
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 do Bookmark.
getPosition()PositionRecebe o Position do Bookmark no DocumentTab.
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 independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()ContainerElement|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()ContainerElement|nullRemove 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 independente 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()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera 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 final do Document.
merge()Date|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()Date|nullRemove o elemento do pai.
setAttributes(attributes)DateDefine os atributos do elemento.

Document

Métodos

MétodoTipo de retornoBreve descrição
addBookmark(position)BookmarkAdiciona um Bookmark no Position especificado à primeira guia ou, para scripts vinculados a um documento, à guia ativa.
addEditor(emailAddress)DocumentAdiciona o usuário especificado à lista de editores do Document.
addEditor(user)DocumentAdiciona o usuário especificado à lista de editores do Document.
addEditors(emailAddresses)DocumentAdiciona a matriz de usuários à lista de editores do Document.
addFooter()FooterSectionAdiciona uma seção de rodapé, se não houver nenhuma, à primeira guia ou, para scripts vinculados a um documento, à guia ativa.
addHeader()HeaderSectionAdiciona uma seção de cabeçalho, se não houver nenhuma, à primeira guia ou, para scripts vinculados a um documento, à guia ativa.
addNamedRange(name, range)NamedRangeAdiciona um NamedRange, que é um Range com um nome e um ID para uso em recuperação posterior, na primeira guia ou, para scripts vinculados a um documento, na guia ativa.
addViewer(emailAddress)DocumentAdiciona o usuário especificado à lista de leitores do Document.
addViewer(user)DocumentAdiciona o usuário especificado à lista de leitores do Document.
addViewers(emailAddresses)DocumentAdiciona a matriz de usuários à lista de leitores do Document.
getActiveTab()TabRecebe o Tab ativo do usuário no documento.
getAs(contentType)BlobRecupera o conteúdo Document atual como um blob do tipo especificado.
getBlob()BlobRecupera o conteúdo Document atual como um blob.
getBody()BodyRecupera o Body da primeira guia ou, para scripts vinculados a um documento, o DocumentBodySection da guia ativa.
getBookmark(id)Bookmark|nullRecebe o Bookmark com o ID especificado na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
getBookmarks()Bookmark[]Recebe todos os objetos Bookmark na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
getCursor()Position|nullRecebe o cursor do usuário na guia ativa.
getEditors()User[]Recebe a lista de editores para este Document.
getFooter()FooterSection|nullRecupera a seção de rodapé da primeira guia ou, para scripts vinculados a um documento, a seção de rodapé da guia ativa.
getFootnotes()Footnote[]|nullRecupera todos os elementos Footnote no corpo da primeira guia ou, para scripts vinculados a um documento, o corpo da guia ativa.
getHeader()HeaderSection|nullRecupera a seção de cabeçalho da primeira guia ou, para scripts vinculados a um documento, a seção de cabeçalho da guia ativa.
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)NamedRange|nullRecebe o NamedRange com o ID especificado na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
getNamedRanges()NamedRange[]Recebe todos os objetos NamedRange na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
getNamedRanges(name)NamedRange[]Recebe todos os objetos NamedRange com o nome especificado na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
getSelection()Range|nullRecebe a seleção do usuário na guia ativa.
getSupportedLanguageCodes()String[]Recebe todos os códigos de idioma compatíveis com arquivos do Google Docs.
getTab(tabId)TabRecebe o Tab com o ID especificado.
getTabs()Tab[]Recebe todos os Tabs não aninhados que fazem parte do documento.
getUrl()StringRecupera o URL para acessar o documento atual.
getViewers()User[]Recebe a lista de leitores e comentaristas deste Document.
newPosition(element, offset)PositionCria um novo Position, que é uma referência a um local na guia, em relação a um elemento específico na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
newRange()RangeBuilderCria um builder usado para construir objetos Range de elementos de guia na primeira guia ou, para scripts vinculados a um documento, a guia ativa.
removeEditor(emailAddress)DocumentRemove o usuário especificado da lista de editores do Document.
removeEditor(user)DocumentRemove o usuário especificado da lista de editores do Document.
removeViewer(emailAddress)DocumentRemove o usuário especificado da lista de espectadores e comentaristas do Document.
removeViewer(user)DocumentRemove o usuário especificado da lista de espectadores e comentaristas do Document.
saveAndClose()voidSalva o Document atual.
setActiveTab(tabId)voidDefine o Tab selecionado pelo usuário no documento atual como a guia com o ID especificado.
setCursor(position)DocumentDefine o cursor do usuário, 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 na guia ativa, considerando 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 ao qual o script está vinculado ao contêiner.
getUi()UiRetorna uma instância do ambiente da interface do usuário do documento que permite ao script adicionar 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.

DocumentTab

Métodos

MétodoTipo de retornoBreve descrição
addBookmark(position)BookmarkAdiciona um Bookmark no Position especificado.
addFooter()FooterSectionAdiciona uma seção de rodapé da guia, se não houver nenhuma.
addHeader()HeaderSectionAdiciona uma seção de cabeçalho de guia, se não houver nenhuma.
addNamedRange(name, range)NamedRangeAdiciona um NamedRange, que é um Range com um nome e um ID para uso em recuperação posterior.
getBody()BodyRecupera o Body da guia.
getBookmark(id)Bookmark|nullRecebe a Bookmark com o ID especificado.
getBookmarks()Bookmark[]Recebe todos os objetos Bookmark na guia.
getFooter()FooterSection|nullRecupera a seção de rodapé da guia, se houver.
getFootnotes()Footnote[]|nullRecupera todos os elementos Footnote no corpo da guia.
getHeader()HeaderSection|nullRecupera a seção de cabeçalho da guia, se houver.
getNamedRangeById(id)NamedRange|nullRecebe a NamedRange com o ID especificado.
getNamedRanges()NamedRange[]Recebe todos os objetos NamedRange na guia.
getNamedRanges(name)NamedRange[]Recebe todos os objetos NamedRange na guia com o nome especificado.
newPosition(element, offset)PositionCria um novo Position, que é uma referência a um local na guia, em relação a um elemento específico.
newRange()RangeBuilderCria um builder usado para construir objetos Range com base em elementos de guia.

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 das 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 independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()Element|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()Element|nullRemove o elemento do pai.
setAttributes(attributes)ElementDefine os atributos do elemento.

ElementType

Propriedades

PropriedadeTipoDescrição
BODY_SECTIONEnumO tipo correspondente ao elemento Body.
COMMENT_SECTIONEnumO tipo correspondente ao elemento CommentSection.
DATEEnumO tipo correspondente ao elemento Date.
EQUATIONEnumO tipo correspondente ao elemento Equation.
EQUATION_FUNCTIONEnumO tipo correspondente ao elemento EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumO tipo correspondente ao elemento EquationFunctionArgumentSeparator.
EQUATION_SYMBOLEnumO tipo correspondente ao elemento EquationSymbol.
RICH_LINKEnumO tipo correspondente ao elemento RichLink.
FOOTER_SECTIONEnumO tipo correspondente ao elemento FooterSection.
FOOTNOTEEnumO tipo correspondente ao elemento Footnote.
FOOTNOTE_SECTIONEnumO tipo correspondente ao elemento FootnoteSection.
HEADER_SECTIONEnumO tipo correspondente ao elemento HeaderSection.
HORIZONTAL_RULEEnumO tipo correspondente ao elemento HorizontalRule.
INLINE_DRAWINGEnumO tipo correspondente ao elemento InlineDrawing.
INLINE_IMAGEEnumO tipo correspondente ao elemento InlineImage.
LIST_ITEMEnumO tipo correspondente ao elemento ListItem.
PAGE_BREAKEnumO tipo correspondente ao elemento PageBreak.
PARAGRAPHEnumO tipo correspondente ao elemento Paragraph.
PERSONEnumO tipo correspondente ao elemento Person.
TABLEEnumO tipo correspondente ao elemento Table.
TABLE_CELLEnumO tipo correspondente ao elemento TableCell.
TABLE_OF_CONTENTSEnumO tipo correspondente ao elemento TableOfContents.
TABLE_ROWEnumO tipo correspondente ao elemento TableRow.
TEXTEnumO tipo 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 independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()Equation|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()Equation|nullRemove 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 independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getCode()StringRecupera o código correspondente à função de equação.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()EquationFunction|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationFunction|nullRemove 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 independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()EquationFunctionArgumentSeparator|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationFunctionArgumentSeparator|nullRemove 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 independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getCode()StringRecupera o código correspondente ao símbolo da equação.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()EquationSymbol|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()EquationSymbol|nullRemove 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 um novo InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAcrescenta o InlineImage especificado.
appendListItem(listItem)ListItemAcrescenta o ListItem especificado.
appendListItem(text)ListItemCria e anexa um novo ListItem que contém o conteúdo de texto especificado.
appendParagraph(paragraph)ParagraphAcrescenta o Paragraph especificado.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph que contém o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table que contém um TableCell para cada valor de string especificado.
appendTable(table)TableAcrescenta o Table especificado.
clear()FooterSectionLimpa o conteúdo do elemento.
copy()FooterSectionRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getImages()InlineImage[]|nullRecupera todos os InlineImages contidos na seção.
getListItems()ListItem[]|nullRecupera todos os ListItems contidos na seção.
getNumChildren()IntegerRecupera o número de filhos.
getParagraphs()Paragraph[]|nullRecupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getTables()Table[]|nullRecupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice indicado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice indicado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, contendo o conteúdo de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice indicado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, contendo 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 contendo as células especificadas no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice indicado.
removeChild(child)FooterSectionRemove o elemento filho especificado.
removeFromParent()FooterSection|nullRemove 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 independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getFootnoteContents()FootnoteSection|nullRecupera o conteúdo do elemento de nota de rodapé.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
removeFromParent()Footnote|nullRemove o elemento do pai.
setAttributes(attributes)FootnoteDefine os atributos do elemento.

FootnoteSection

Métodos

MétodoTipo de retornoBreve descrição
appendParagraph(paragraph)ParagraphAcrescenta o Paragraph especificado.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph que contém o conteúdo de texto especificado.
clear()FootnoteSectionLimpa o conteúdo do elemento.
copy()FootnoteSectionRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParagraphs()Paragraph[]|nullRecupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice indicado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, contendo o conteúdo de texto especificado.
removeChild(child)FootnoteSectionRemove o elemento filho especificado.
removeFromParent()FootnoteSection|nullRemove 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
BULLETEnumO marcador padrão, circular e preenchido.
HOLLOW_BULLETEnumUm marcador vazado.
SQUARE_BULLETEnumUm marcador quadrado.
NUMBEREnumUm marcador baseado em números.
LATIN_UPPEREnumUm marcador latino em maiúsculas.
LATIN_LOWEREnumUm marcador latino em minúsculas.
ROMAN_UPPEREnumUm número romano, marcador em maiúsculas.
ROMAN_LOWEREnumUm número 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 um novo InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAcrescenta o InlineImage especificado.
appendListItem(listItem)ListItemAcrescenta o ListItem especificado.
appendListItem(text)ListItemCria e anexa um novo ListItem que contém o conteúdo de texto especificado.
appendParagraph(paragraph)ParagraphAcrescenta o Paragraph especificado.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph que contém o conteúdo de texto especificado.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAnexa um novo Table que contém um TableCell para cada valor de string especificado.
appendTable(table)TableAcrescenta o Table especificado.
clear()HeaderSectionLimpa o conteúdo do elemento.
copy()HeaderSectionRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getImages()InlineImage[]|nullRecupera todos os InlineImages contidos na seção.
getListItems()ListItem[]|nullRecupera todos os ListItems contidos na seção.
getNumChildren()IntegerRecupera o número de filhos.
getParagraphs()Paragraph[]|nullRecupera todos os Paragraphs contidos na seção (incluindo ListItems).
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getTables()Table[]|nullRecupera todos os Tables contidos na seção.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice indicado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice indicado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado, contendo o conteúdo de texto especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice indicado.
insertParagraph(childIndex, text)ParagraphCria e insere um novo Paragraph no índice especificado, contendo 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 contendo as células especificadas no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice indicado.
removeChild(child)HeaderSectionRemove o elemento filho especificado.
removeFromParent()HeaderSection|nullRemove 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 de alinhamento justificado.

HorizontalRule

Métodos

MétodoTipo de retornoBreve descrição
copy()HorizontalRuleRetorna uma cópia detalhada e independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
removeFromParent()HorizontalRule|nullRemove 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 independente do elemento atual.
getAltDescription()String|nullRetorna a descrição alternativa do desenho.
getAltTitle()String|nullRetorna o título alternativo do desenho.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()InlineDrawing|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()InlineDrawing|nullRemove 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 independente do elemento atual.
getAltDescription()String|nullRetorna a descrição alternativa da imagem.
getAltTitle()String|nullRetorna 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()BlobRetorna os dados dentro desse objeto como um blob.
getHeight()IntegerRecupera a altura da imagem em pixels.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera 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 final do Document.
merge()InlineImage|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()InlineImage|nullRemove 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 do blob de imagem especificado.
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendInlineImage(image)InlineImageCria e anexa um novo InlineImage do blob de imagem especificado.
appendInlineImage(image)InlineImageAcrescenta o InlineImage especificado.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAcrescenta o PageBreak especificado.
appendText(text)TextCria e anexa um novo elemento Text com o conteúdo especificado.
appendText(text)TextAcrescenta o elemento Text especificado.
clear()ListItemLimpa o conteúdo do elemento.
copy()ListItemRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAlignment()HorizontalAlignment|nullRecupera o HorizontalAlignment.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getGlyphType()GlyphType|nullRecupera o GlyphType do item da lista.
getHeading()ParagraphHeading|nullRecupera o ParagraphHeading.
getIndentEnd()Number|nullRecupera o recuo final, em pontos.
getIndentFirstLine()Number|nullRecupera o recuo da primeira linha, em pontos.
getIndentStart()Number|nullRecupera o recuo inicial.
getLineSpacing()Number|nullRecupera o espaçamento entre linhas, em pontos.
getLinkUrl()String|nullRecupera o URL do link.
getListId()String|nullRecupera o ID da lista.
getNestingLevel()IntegerRecupera o nível de aninhamento do item da lista.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPositionedImage(id)PositionedImageRecebe um PositionedImage pelo ID da imagem.
getPositionedImages()PositionedImage[]Recebe todos os objetos PositionedImage ancorados no parágrafo.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getSpacingAfter()Number|nullRecupera o espaçamento após o elemento, em pontos.
getSpacingBefore()Number|nullRecupera o espaçamento antes do elemento, em pontos.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 do blob de imagem especificado no índice especificado.
insertInlineImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice indicado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice indicado.
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 final do Document.
isLeftToRight()Boolean|nullRecupera a configuração da esquerda para a direita.
merge()ListItem|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)ListItemRemove o elemento filho especificado.
removeFromParent()ListItem|nullRemove 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 do item da lista.
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 inicial, em pontos.
setLeftToRight(leftToRight)ListItemDefine a configuração da esquerda para a direita.
setLineSpacing(multiplier)ListItemDefine o espaçamento entre linhas como uma quantidade que indica o número de linhas a serem usadas para 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 o elemento, em pontos.
setSpacingBefore(spacingBefore)ListItemDefine o espaçamento antes do elemento, 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 desta NamedRange.
getName()StringRecebe o nome deste NamedRange.
getRange()RangeRecebe o intervalo de elementos associados a este NamedRange.
remove()voidRemove este NamedRange da guia.

PageBreak

Métodos

MétodoTipo de retornoBreve descrição
copy()PageBreakRetorna uma cópia detalhada e independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
removeFromParent()PageBreak|nullRemove 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 do blob de imagem especificado.
appendHorizontalRule()HorizontalRuleCria e anexa um novo HorizontalRule.
appendInlineImage(image)InlineImageCria e anexa um novo InlineImage do blob de imagem especificado.
appendInlineImage(image)InlineImageAcrescenta o InlineImage especificado.
appendPageBreak()PageBreakCria e anexa um novo PageBreak.
appendPageBreak(pageBreak)PageBreakAcrescenta o PageBreak especificado.
appendText(text)TextCria e anexa um novo elemento Text com o conteúdo especificado.
appendText(text)TextAcrescenta o elemento Text especificado.
clear()ParagraphLimpa o conteúdo do elemento.
copy()ParagraphRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAlignment()HorizontalAlignment|nullRecupera o HorizontalAlignment.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getHeading()ParagraphHeading|nullRecupera o ParagraphHeading.
getIndentEnd()Number|nullRecupera o recuo final, em pontos.
getIndentFirstLine()Number|nullRecupera o recuo da primeira linha, em pontos.
getIndentStart()Number|nullRecupera o recuo inicial.
getLineSpacing()Number|nullRecupera o espaçamento entre linhas, em pontos.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPositionedImage(id)PositionedImageRecebe um PositionedImage pelo ID da imagem.
getPositionedImages()PositionedImage[]Recebe todos os objetos PositionedImage ancorados no parágrafo.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getSpacingAfter()Number|nullRecupera o espaçamento após o elemento, em pontos.
getSpacingBefore()Number|nullRecupera o espaçamento antes do elemento, em pontos.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 do blob de imagem especificado no índice especificado.
insertInlineImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice indicado.
insertPageBreak(childIndex)PageBreakCria e insere um novo PageBreak no índice especificado.
insertPageBreak(childIndex, pageBreak)PageBreakInsere o PageBreak especificado no índice indicado.
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 final do Document.
isLeftToRight()Boolean|nullRecupera a configuração da esquerda para a direita.
merge()Paragraph|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)ParagraphRemove o elemento filho especificado.
removeFromParent()Paragraph|nullRemove 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 inicial, em pontos.
setLeftToRight(leftToRight)ParagraphDefine a configuração da esquerda para a direita.
setLineSpacing(multiplier)ParagraphDefine o espaçamento entre linhas como uma quantidade que indica o número de linhas a serem usadas para espaçamento.
setLinkUrl(url)ParagraphDefine o URL do link.
setSpacingAfter(spacingAfter)ParagraphDefine o espaçamento após o elemento, em pontos.
setSpacingBefore(spacingBefore)ParagraphDefine o espaçamento antes do elemento, 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 cabeçalho para texto normal.
HEADING1EnumA opção de cabeçalho mais alta.
HEADING2EnumA segunda opção de título.
HEADING3EnumA terceira opção de título
HEADING4EnumA quarta opção de cabeçalho.
HEADING5EnumA quinta opção de cabeçalho.
HEADING6EnumA opção de cabeçalho mais baixa.
TITLEEnumA opção de cabeçalho do título.
SUBTITLEEnumA opção de cabeçalho de subtítulo.

Person

Métodos

MétodoTipo de retornoBreve descrição
copy()PersonRetorna uma cópia detalhada e independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getEmail()StringRetorna o endereço de e-mail da pessoa.
getName()String|nullRetorna o nome de exibição da pessoa, se ele tiver sido definido.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()Person|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()Person|nullRemove 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 este Position.
getOffset()IntegerRecebe a localização relativa deste Position no elemento que o contém.
getSurroundingText()TextCria um elemento Text artificial que representa o texto e a formatação do Paragraph ou ListItem que contém o Position, diretamente ou por uma cadeia de elementos filhos.
getSurroundingTextOffset()IntegerRecebe o deslocamento deste Position no elemento Text retornado por getSurroundingText().
insertBookmark()BookmarkCria e insere um novo Bookmark neste Position.
insertInlineImage(image)InlineImage|nullCria e insere um novo InlineImage neste Position do blob de imagem especificado.
insertText(text)Text|nullInsere 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()BlobRetorna 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 é organizada.
getLeftOffset()NumberRecebe o deslocamento da imagem, em pontos, da esquerda do parágrafo.
getParagraph()ParagraphRecebe o Paragraph a que a imagem está ancorada.
getTopOffset()NumberRecebe o deslocamento da imagem, em pontos, da parte de cima do parágrafo.
getWidth()IntegerRecupera a largura da imagem, em pixels.
setHeight(height)PositionedImageDefine a altura da imagem em pixels.
setLayout(layout)PositionedImageDefine como a imagem é organizada.
setLeftOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, à esquerda do parágrafo.
setTopOffset(offset)PositionedImageDefine o deslocamento da imagem, em pontos, da parte superior do parágrafo.
setWidth(width)PositionedImageDefine a largura da imagem, em pixels.

PositionedLayout

Propriedades

PropriedadeTipoDescrição
ABOVE_TEXTEnumA imagem fica 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 é envolvida por texto.

Range

Métodos

MétodoTipo de retornoBreve descrição
getRangeElements()RangeElement[]Recebe todos os elementos neste Range, incluindo 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 este 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 neste Range, incluindo 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 este RangeElement.
getEndOffsetInclusive()IntegerRecebe a posição do fim de um intervalo parcial dentro do 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 cobre o elemento inteiro ou uma seleção parcial dos caracteres do elemento.

Métodos

MétodoTipo de retornoBreve descrição
copy()RichLinkRetorna uma cópia detalhada e independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getMimeType()String|nullRetorna o tipo MIME do link, que está disponível quando o item é um link para um arquivo do Drive e null caso contrário.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera 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 final do Document.
merge()RichLink|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()RichLink|nullRemove o elemento do pai.
setAttributes(attributes)RichLinkDefine os atributos do elemento.

Tab

Métodos

MétodoTipo de retornoBreve descrição
asDocumentTab()DocumentTabRecupera o conteúdo da guia como um DocumentTab.
getChildTabs()Tab[]Recupera as guias filhas aninhadas nesta guia.
getId()StringRecupera o ID da guia.
getIndex()IntegerRecupera o índice baseado em zero da guia no elemento pai.
getTitle()StringRecupera o título da guia.
getType()TabTypeRecupera o tipo de guia.

TabType

Propriedades

PropriedadeTipoDescrição
DOCUMENT_TABEnumO tipo correspondente a DocumentTab.

Table

Métodos

MétodoTipo de retornoBreve descrição
appendTableRow()TableRowCria e anexa um novo TableRow.
appendTableRow(tableRow)TableRowAcrescenta o TableRow especificado.
clear()TableLimpa o conteúdo do elemento.
copy()TableRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getBorderColor()String|nullRecupera a cor da borda.
getBorderWidth()Number|nullRecupera a largura da borda, em pontos.
getCell(rowIndex, cellIndex)TableCell|nullRecupera o TableCell nos índices de linha e célula especificados.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getColumnWidth(columnIndex)Number|nullRecupera a largura da coluna de tabela especificada, em pontos.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getNumRows()IntegerRecupera o número de TableRows.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getRow(rowIndex)TableRow|nullRecupera o TableRow no índice de linha especificado.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 indicado.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
removeChild(child)TableRemove o elemento filho especificado.
removeFromParent()Table|nullRemove o elemento do pai.
removeRow(rowIndex)TableRowRemove o TableRow no índice de linha 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 um novo InlineImage do blob de imagem especificado.
appendImage(image)InlineImageAcrescenta o InlineImage especificado.
appendListItem(listItem)ListItemAcrescenta o ListItem especificado.
appendListItem(text)ListItemCria e anexa um novo ListItem.
appendParagraph(paragraph)ParagraphAcrescenta o Paragraph especificado.
appendParagraph(text)ParagraphCria e anexa um novo Paragraph.
appendTable()TableCria e anexa um novo Table.
appendTable(cells)TableAdiciona um novo Table que contém as células especificadas.
appendTable(table)TableAcrescenta o Table especificado.
clear()TableCellLimpa o conteúdo do elemento.
copy()TableCellRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getBackgroundColor()String|nullRecupera a cor de plano de fundo.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getColSpan()IntegerRecupera o intervalo de colunas, que é o número de colunas de células da tabela que esta célula abrange.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getPaddingBottom()Number|nullRecupera o padding da parte de baixo, em pontos.
getPaddingLeft()Number|nullRecupera o padding esquerdo, em pontos.
getPaddingRight()Number|nullRecupera o padding direito, em pontos.
getPaddingTop()Number|nullRecupera o padding da parte de cima, em pontos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getParentRow()TableRow|nullRecupera o TableRow que contém o TableCell atual.
getParentTable()Table|nullRecupera o Table que contém o TableCell atual.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getRowSpan()IntegerRecupera o intervalo de linhas, que é o número de linhas de células da tabela que esta célula abrange.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
getVerticalAlignment()VerticalAlignment|nullRecupera o VerticalAlignment.
getWidth()Number|nullRecupera 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 do blob de imagem especificado no índice especificado.
insertImage(childIndex, image)InlineImageInsere o InlineImage especificado no índice indicado.
insertListItem(childIndex, listItem)ListItemInsere o ListItem especificado no índice indicado.
insertListItem(childIndex, text)ListItemCria e insere um novo ListItem no índice especificado.
insertParagraph(childIndex, paragraph)ParagraphInsere o Paragraph especificado no índice indicado.
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 contendo as células especificadas no índice especificado.
insertTable(childIndex, table)TableInsere o Table especificado no índice indicado.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()TableCell|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeChild(child)TableCellRemove o elemento filho especificado.
removeFromParent()TableCell|nullRemove 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 da parte de baixo, em pontos.
setPaddingLeft(paddingLeft)TableCellDefine o padding esquerdo, em pontos.
setPaddingRight(paddingRight)TableCellDefine o padding direito, 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, em pontos, da coluna que contém a célula atual.

TableOfContents

Métodos

MétodoTipo de retornoBreve descrição
clear()TableOfContentsLimpa o conteúdo do elemento.
copy()TableOfContentsRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()String|nullRecupera o URL do link.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getNumChildren()IntegerRecupera o número de filhos.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
removeFromParent()TableOfContents|nullRemove 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 o TableCell fornecido que contém o texto especificado.
appendTableCell(tableCell)TableCellAcrescenta o TableCell especificado.
clear()TableRowLimpa o conteúdo do elemento.
copy()TableRowRetorna uma cópia detalhada e independente do elemento atual.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findElement(elementType)RangeElement|nullPesquisa o conteúdo do elemento em busca de um descendente do tipo especificado.
findElement(elementType, from)RangeElement|nullPesquisa o conteúdo do elemento para encontrar um descendente do tipo especificado, começando pelo RangeElement especificado.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getCell(cellIndex)TableCell|nullRecupera o TableCell no índice de célula especificado.
getChild(childIndex)ElementRecupera o elemento filho no índice especificado.
getChildIndex(child)IntegerRecupera o índice filho do elemento filho especificado.
getLinkUrl()String|nullRecupera o URL do link.
getMinimumHeight()Number|nullRecupera a altura mínima, em pontos.
getNextSibling()Element|nullRecupera 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()ContainerElement|nullRecupera o elemento pai do elemento.
getParentTable()Table|nullRecupera o Table que contém a linha atual.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe 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 indicado, contendo o texto fornecido.
insertTableCell(childIndex, tableCell)TableCellInsere o TableCell especificado no índice indicado.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()TableRow|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeCell(cellIndex)TableCellRemove o TableCell no índice de célula especificado.
removeChild(child)TableRowRemove o elemento filho especificado.
removeFromParent()TableRow|nullRemove 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 independente do elemento atual.
deleteText(startOffset, endOffsetInclusive)TextExclui um intervalo de texto.
editAsText()TextRecebe uma versão Text do elemento atual para edição.
findText(searchPattern)RangeElement|nullPesquisa o conteúdo do elemento para encontrar o padrão de texto especificado usando expressões regulares.
findText(searchPattern, from)RangeElement|nullPesquisa o conteúdo do elemento em busca do padrão de texto especificado, começando por um determinado resultado da pesquisa.
getAttributes()ObjectRecupera os atributos do elemento.
getAttributes(offset)ObjectRecupera os atributos no deslocamento de caractere especificado.
getBackgroundColor()String|nullRecupera a configuração de cor de plano de fundo.
getBackgroundColor(offset)String|nullRecupera a cor de plano de fundo no deslocamento de caractere especificado.
getFontFamily()String|nullRecupera a configuração da família de fontes.
getFontFamily(offset)String|nullRecupera a família de fontes no deslocamento de caractere especificado.
getFontSize()Number|nullRecupera a configuração de tamanho da fonte.
getFontSize(offset)Number|nullRecupera o tamanho da fonte no deslocamento de caractere especificado.
getForegroundColor()String|nullRecupera a configuração de cor de primeiro plano.
getForegroundColor(offset)String|nullRecupera a cor de primeiro plano no deslocamento de caractere especificado.
getLinkUrl()String|nullRecupera o URL do link.
getLinkUrl(offset)String|nullRecupera o URL do link no deslocamento de caractere especificado.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getText()StringRecupera o conteúdo do elemento como uma string de texto.
getTextAlignment()TextAlignment|nullRecebe o alinhamento do texto.
getTextAlignment(offset)TextAlignment|nullRecebe o alinhamento de 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 distintas.
getType()ElementTypeRecupera o ElementType do elemento.
insertText(offset, text)TextInsere o texto especificado no deslocamento de caractere indicado.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
isBold()Boolean|nullRecupera a configuração de negrito.
isBold(offset)Boolean|nullRecupera a configuração de negrito no deslocamento de caractere especificado.
isItalic()Boolean|nullRecupera a configuração de itálico.
isItalic(offset)Boolean|nullRecupera a configuração de itálico no deslocamento de caractere especificado.
isStrikethrough()Boolean|nullRecupera a configuração de tachado.
isStrikethrough(offset)Boolean|nullRecupera a configuração de tachado no deslocamento de caractere especificado.
isUnderline()Boolean|nullRecupera a configuração de sublinhado.
isUnderline(offset)Boolean|nullRecupera a configuração de sublinhado no deslocamento de caractere especificado.
merge()Text|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()Text|nullRemove 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 determinado.
setAttributes(attributes)TextDefine os atributos do elemento.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextDefine a cor de fundo para o 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 para o 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 de primeiro plano para o intervalo de caracteres especificado.
setForegroundColor(color)TextDefine a cor de 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 do 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 para o intervalo de caracteres especificado.

TextAlignment

Propriedades

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

UnsupportedElement

Métodos

MétodoTipo de retornoBreve descrição
copy()UnsupportedElementRetorna uma cópia detalhada e independente do elemento atual.
getAttributes()ObjectRecupera os atributos do elemento.
getNextSibling()Element|nullRecupera o próximo elemento irmão do elemento.
getParent()ContainerElement|nullRecupera o elemento pai do elemento.
getPreviousSibling()Element|nullRecupera o elemento irmão anterior do elemento.
getType()ElementTypeRecupera o ElementType do elemento.
isAtDocumentEnd()BooleanDetermina se o elemento está no final do Document.
merge()UnsupportedElement|nullMescla o elemento com o irmão anterior do mesmo tipo.
removeFromParent()UnsupportedElement|nullRemove o elemento do pai.
setAttributes(attributes)UnsupportedElementDefine os atributos do elemento.

VerticalAlignment

Propriedades

PropriedadeTipoDescrição
BOTTOMEnumA opção de alinhamento na parte de baixo.
CENTEREnumA opção de alinhamento central.
TOPEnumA opção de alinhamento na parte de cima.