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
Nome | Breve descrição |
---|---|
Attribute | Uma enumeração dos atributos do elemento. |
Body | Um elemento que representa um corpo de documento. |
Bookmark | Um objeto que representa um favorito. |
ContainerElement | Um elemento genérico que pode conter outros elementos. |
Date | Um elemento que representa uma data formatada |
Document | É um documento que contém rich text e elementos como tabelas e listas. |
DocumentApp | O serviço Documento cria e abre Documents que podem ser editados. |
Element | Um elemento genérico. |
ElementType | Uma enumeração de todos os tipos de elemento. |
Equation | Um elemento que representa uma expressão matemática. |
EquationFunction | Um elemento que representa uma função em um Equation matemático. |
EquationFunctionArgumentSeparator | Um elemento que representa um separador de função em um Equation matemático. |
EquationSymbol | Um elemento que representa um símbolo em uma Equation matemática. |
| Uma enumeração das fontes compatíveis. |
FooterSection | Um elemento que representa uma seção de rodapé. |
Footnote | Um elemento que representa uma nota de rodapé. |
FootnoteSection | Um elemento que representa uma seção de nota de rodapé. |
GlyphType | Uma enumeração dos tipos de glifos compatíveis. |
HeaderSection | Um elemento que representa uma seção de cabeçalho. |
HorizontalAlignment | Uma enumeração dos tipos de alinhamento horizontal compatíveis. |
HorizontalRule | Um elemento que representa uma regra horizontal. |
InlineDrawing | Um elemento que representa um desenho incorporado. |
InlineImage | Um elemento que representa uma imagem incorporada. |
ListItem | Um elemento que representa um item da lista. |
NamedRange | Um Range que tem um nome e um ID para permitir a recuperação posterior. |
PageBreak | Um elemento que representa uma quebra de página. |
Paragraph | Um elemento que representa um parágrafo. |
ParagraphHeading | Uma enumeração dos cabeçalhos de parágrafo padrão. |
Person | Elemento que representa um link para uma pessoa. |
Position | Uma referência a um local no documento, em relação a um elemento específico. |
PositionedImage | A imagem de posição fixa foi fixada em um Paragraph . |
PositionedLayout | Uma enumeração que especifica como definir um PositionedImage em relação ao texto
ao redor. |
Range | Um intervalo de elementos em um documento. |
RangeBuilder | Um builder usado para construir objetos Range a partir de elementos do documento. |
RangeElement | Um wrapper em torno de uma Element com um possível deslocamento de início e fim. |
RichLink | Um elemento que representa um link para um recurso do Google, como um arquivo do Drive ou um vídeo do YouTube. |
Table | Um elemento que representa uma tabela. |
TableCell | Um elemento que representa uma célula da tabela. |
TableOfContents | Um elemento que contém um sumário. |
TableRow | Um elemento que representa uma linha da tabela. |
Text | Um elemento que representa uma região de rich text. |
TextAlignment | Uma enumeração do tipo de alinhamento de texto. |
UnsupportedElement | Um elemento que representa uma região desconhecida ou que não pode ser afetado por um script, como um número de página. |
VerticalAlignment | Uma enumeração dos tipos de alinhamento vertical compatíveis. |
Attribute
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
BACKGROUND_COLOR | Enum | A cor do plano de fundo de um elemento (parágrafo, tabela etc.) ou documento. |
BOLD | Enum | É a configuração de espessura da fonte para rich text. |
BORDER_COLOR | Enum | A cor da borda para elementos da tabela. |
BORDER_WIDTH | Enum | A largura da borda em pontos para elementos de tabela. |
CODE | Enum | O conteúdo do código para elementos de equação. |
FONT_FAMILY | Enum | A configuração de família de fontes para rich text. |
FONT_SIZE | Enum | É a configuração de tamanho da fonte em pontos para rich text. |
FOREGROUND_COLOR | Enum | É a configuração de cor de primeiro plano para rich text. |
HEADING | Enum | O tipo de cabeçalho, para elementos de parágrafo (por exemplo, DocumentApp.ParagraphHeading.HEADING1 ). |
HEIGHT | Enum | Configuração de altura para elementos de imagem. |
HORIZONTAL_ALIGNMENT | Enum | O alinhamento horizontal, para elementos de parágrafo (por exemplo, DocumentApp.HorizontalAlignment.CENTER ). |
INDENT_END | Enum | Configuração de recuo final em pontos para elementos de parágrafo. |
INDENT_FIRST_LINE | Enum | A configuração de recuo da primeira linha em pontos, para elementos de parágrafo. |
INDENT_START | Enum | Configuração de recuo inicial em pontos para elementos de parágrafo. |
ITALIC | Enum | É a configuração de estilo da fonte para rich text. |
GLYPH_TYPE | Enum | O tipo de glifo, para elementos de item da lista. |
LEFT_TO_RIGHT | Enum | É a configuração de direção do texto para rich text. |
LINE_SPACING | Enum | Configuração do espaçamento entre linhas como um multiplicador para elementos de parágrafo. |
LINK_URL | Enum | O URL do link para rich text. |
LIST_ID | Enum | ID da lista abrangente, para os elementos do item da lista. |
MARGIN_BOTTOM | Enum | A configuração de margem inferior em pontos para elementos de parágrafo. |
MARGIN_LEFT | Enum | Configuração da margem esquerda em pontos para elementos de parágrafo. |
MARGIN_RIGHT | Enum | A configuração de margem direita em pontos para elementos de parágrafo. |
MARGIN_TOP | Enum | Configuração da margem superior em pontos para elementos de parágrafo. |
NESTING_LEVEL | Enum | O nível de aninhamento de itens para elementos da lista. |
MINIMUM_HEIGHT | Enum | Configuração de altura mínima em pontos para elementos de linha da tabela. |
PADDING_BOTTOM | Enum | Configuração de padding inferior em pontos para elementos de célula da tabela. |
PADDING_LEFT | Enum | A configuração de padding à esquerda em pontos, para elementos de célula da tabela. |
PADDING_RIGHT | Enum | Configuração de preenchimento correto em pontos para elementos de célula da tabela. |
PADDING_TOP | Enum | Configuração de padding superior em pontos para elementos de célula da tabela. |
PAGE_HEIGHT | Enum | A configuração de altura da página em pontos, para documentos. |
PAGE_WIDTH | Enum | A configuração de largura da página em pontos para documentos. |
SPACING_AFTER | Enum | A configuração de espaçamento abaixo em pontos para elementos de parágrafo. |
SPACING_BEFORE | Enum | Configuração de espaçamento superior em pontos para elementos de parágrafo. |
STRIKETHROUGH | Enum | É a configuração de tachado para rich text. |
UNDERLINE | Enum | É a configuração de sublinhado para texto em rich text. |
VERTICAL_ALIGNMENT | Enum | Configuração de alinhamento vertical para elementos da célula da tabela. |
WIDTH | Enum | A configuração de largura para elementos de imagem e célula da tabela. |
Body
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendListItem(listItem) | ListItem | Anexa o ListItem especificado. |
appendListItem(text) | ListItem | Cria e anexa um novo ListItem com o conteúdo de texto especificado. |
appendPageBreak() | PageBreak | Cria e anexa um novo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Anexa o PageBreak especificado. |
appendParagraph(paragraph) | Paragraph | Anexa o Paragraph especificado. |
appendParagraph(text) | Paragraph | Cria e anexa um novo Paragraph com o conteúdo de texto especificado. |
appendTable() | Table | Cria e anexa um novo Table . |
appendTable(cells) | Table | Anexa um novo Table contendo um TableCell para cada valor de string especificado. |
appendTable(table) | Table | Anexa o Table especificado. |
clear() | Body | Limpa o conteúdo do elemento. |
copy() | Body | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getHeadingAttributes(paragraphHeading) | Object | Recupera 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() | Number | Recupera a margem de baixo, em pontos. |
getMarginLeft() | Number | Recupera a margem esquerda em pontos. |
getMarginRight() | Number | Recupera a margem direita. |
getMarginTop() | Number | Recupera a margem superior. |
getNumChildren() | Integer | Recupera o número de filhos. |
getPageHeight() | Number | Recupera a altura da página em pontos. |
getPageWidth() | Number | Recupera a largura da página em pontos. |
getParagraphs() | Paragraph[] | Recupera todos os Paragraphs contidos na seção (incluindo ListItems ). |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getTables() | Table[] | Recupera todos os Tables contidos na seção. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um novo HorizontalRule no índice especificado. |
insertImage(childIndex, image) | InlineImage | Cria e insere uma InlineImage do blob de imagem especificado no índice especificado. |
insertImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Insere o ListItem especificado no índice especificado. |
insertListItem(childIndex, text) | ListItem | Cria e insere um novo ListItem no índice especificado, com o conteúdo de texto
especificado. |
insertPageBreak(childIndex) | PageBreak | Cria e insere um novo PageBreak no índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insere o PageBreak especificado no índice especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Insere o Paragraph especificado no índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Cria e insere um novo Paragraph no índice especificado, com o conteúdo de texto
especificado. |
insertTable(childIndex) | Table | Cria e insere um novo Table no índice especificado. |
insertTable(childIndex, cells) | Table | Cria e insere um novo Table contendo as células especificadas no índice especificado. |
insertTable(childIndex, table) | Table | Insere o Table especificado no índice especificado. |
removeChild(child) | Body | Remove o elemento filho especificado. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | Body | Define os atributos do elemento. |
setHeadingAttributes(paragraphHeading, attributes) | Body | Define os atributos para o ParagraphHeading fornecido. |
setMarginBottom(marginBottom) | Body | Define a margem inferior em pontos. |
setMarginLeft(marginLeft) | Body | Define a margem esquerda em pontos. |
setMarginRight(marginRight) | Body | Define a margem direita em pontos. |
setMarginTop(marginTop) | Body | Define a margem superior. |
setPageHeight(pageHeight) | Body | Define a altura da página em pontos. |
setPageWidth(pageWidth) | Body | Define a largura da página em pontos. |
setText(text) | Body | Define o conteúdo como texto simples. |
setTextAlignment(textAlignment) | Body | Define o alinhamento do texto. |
Bookmark
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getId() | String | Recebe o ID de Bookmark . |
getPosition() | Position | Acessa o Position do Bookmark no Document . |
remove() | void | Exclui o Bookmark . |
ContainerElement
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asBody() | Body | Retorna o elemento atual como uma Body . |
asEquation() | Equation | Retorna o elemento atual como uma Equation . |
asFooterSection() | FooterSection | Retorna o elemento atual como uma FooterSection . |
asFootnoteSection() | FootnoteSection | Retorna o elemento atual como uma FootnoteSection . |
asHeaderSection() | HeaderSection | Retorna o elemento atual como uma HeaderSection . |
asListItem() | ListItem | Retorna o elemento atual como uma ListItem . |
asParagraph() | Paragraph | Retorna o elemento atual como uma Paragraph . |
asTable() | Table | Retorna o elemento atual como uma Table . |
asTableCell() | TableCell | Retorna o elemento atual como uma TableCell . |
asTableOfContents() | TableOfContents | Retorna o elemento atual como uma TableOfContents . |
asTableRow() | TableRow | Retorna o elemento atual como uma TableRow . |
clear() | ContainerElement | Limpa o conteúdo do elemento. |
copy() | ContainerElement | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | ContainerElement | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | ContainerElement | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | ContainerElement | Define os atributos do elemento. |
setLinkUrl(url) | ContainerElement | Define o URL do link. |
setTextAlignment(textAlignment) | ContainerElement | Define o alinhamento do texto. |
Date
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | Date | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getDisplayText() | String | Retorna o valor de exibição renderizado no documento. |
getLocale() | String | Retorna a localidade da data usada para o valor de exibição. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getTimestamp() | Date | Retorna o carimbo de data/hora associado à data. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | Date | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | Date | Remove o elemento do pai. |
setAttributes(attributes) | Date | Define os atributos do elemento. |
Document
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addBookmark(position) | Bookmark | Adiciona uma Bookmark no Position especificado. |
addEditor(emailAddress) | Document | Adiciona o usuário especificado à lista de editores do Document . |
addEditor(user) | Document | Adiciona o usuário especificado à lista de editores do Document . |
addEditors(emailAddresses) | Document | Adiciona a matriz de usuários especificada à lista de editores do Document . |
addFooter() | FooterSection | Adiciona uma seção de rodapé a um documento, se não houver nenhuma. |
addHeader() | HeaderSection | Adiciona uma seção de cabeçalho do documento, se não existir nenhuma. |
addNamedRange(name, range) | NamedRange | Adiciona um NamedRange , que é um Range com um nome e um ID a serem usados para
recuperação posterior. |
addViewer(emailAddress) | Document | Adiciona o usuário especificado à lista de visualizadores para o Document . |
addViewer(user) | Document | Adiciona o usuário especificado à lista de visualizadores para o Document . |
addViewers(emailAddresses) | Document | Adiciona a matriz de usuários especificada à lista de visualizadores para o Document . |
getAs(contentType) | Blob | Recupera o conteúdo do Document atual como um blob do tipo especificado. |
getBlob() | Blob | Recupera o conteúdo do Document atual como um blob. |
getBody() | Body | Recupera o Body do documento ativo. |
getBookmark(id) | Bookmark | Recebe o Bookmark com o ID fornecido. |
getBookmarks() | Bookmark[] | Recebe todos os objetos Bookmark no documento. |
getCursor() | Position | Acessa o cursor do usuário no documento ativo. |
getEditors() | User[] | Recebe a lista de editores para esse Document . |
getFooter() | FooterSection | Recupera a seção de rodapé do documento, se houver. |
getFootnotes() | Footnote[] | Recupera todos os elementos Footnote no corpo do documento. |
getHeader() | HeaderSection | Recupera a seção do cabeçalho do documento, se houver. |
getId() | String | Recupera o identificador exclusivo do documento. |
getLanguage() | String | Recebe o código de idioma do documento. |
getName() | String | Recupera o título do documento. |
getNamedRangeById(id) | NamedRange | Recebe 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() | Range | Recebe a seleção do usuário no documento ativo. |
getSupportedLanguageCodes() | String[] | Recebe todos os códigos de idioma compatíveis com arquivos do Documentos Google. |
getUrl() | String | Recupera o URL para acessar o documento atual. |
getViewers() | User[] | Recebe a lista de leitores e comentaristas desta Document . |
newPosition(element, offset) | Position | Cria um novo Position , que é uma referência a um local no documento, em relação a
um elemento específico. |
newRange() | RangeBuilder | Cria um builder usado para construir objetos Range a partir de elementos do documento. |
removeEditor(emailAddress) | Document | Remove o usuário em questão da lista de editores do Document . |
removeEditor(user) | Document | Remove o usuário em questão da lista de editores do Document . |
removeViewer(emailAddress) | Document | Remove o usuário da lista de leitores e comentaristas da Document . |
removeViewer(user) | Document | Remove o usuário da lista de leitores e comentaristas da Document . |
saveAndClose() | void | Salva o Document atual. |
setCursor(position) | Document | Define o cursor do usuário no documento ativo, considerando um Position . |
setLanguage(languageCode) | Document | Define o código de idioma do documento. |
setName(name) | Document | Define o título do documento. |
setSelection(range) | Document | Define a seleção do usuário no documento ativo, considerando um Range . |
DocumentApp
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
Attribute | Attribute | A enumeração Attribute . |
ElementType | ElementType | A enumeração ElementType . |
FontFamily |
| A enumeração . |
GlyphType | GlyphType | A enumeração GlyphType . |
HorizontalAlignment | HorizontalAlignment | A enumeração HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | A enumeração ParagraphHeading . |
PositionedLayout | PositionedLayout | A enumeração PositionedLayout . |
TextAlignment | TextAlignment | A enumeração TextAlignment . |
VerticalAlignment | VerticalAlignment | A enumeração VerticalAlignment . |
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
create(name) | Document | Cria e retorna um novo documento. |
getActiveDocument() | Document | Retorna o documento ao qual o script é vinculado ao contêiner. |
getUi() | Ui | Retorna uma instância do ambiente de interface do usuário do documento que permite que o script adicione recursos como menus, caixas de diálogo e barras laterais. |
openById(id) | Document | Retorna o documento com o ID especificado. |
openByUrl(url) | Document | Abre e retorna o documento com o URL especificado. |
Element
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
asBody() | Body | Retorna o elemento atual como uma Body . |
asDate() | Date | Retorna o elemento atual como uma Date . |
asEquation() | Equation | Retorna o elemento atual como uma Equation . |
asEquationFunction() | EquationFunction | Retorna o elemento atual como uma EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Retorna o elemento atual como uma EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Retorna o elemento atual como uma EquationSymbol . |
asFooterSection() | FooterSection | Retorna o elemento atual como uma FooterSection . |
asFootnote() | Footnote | Retorna o elemento atual como uma Footnote . |
asFootnoteSection() | FootnoteSection | Retorna o elemento atual como uma FootnoteSection . |
asHeaderSection() | HeaderSection | Retorna o elemento atual como uma HeaderSection . |
asHorizontalRule() | HorizontalRule | Retorna o elemento atual como uma HorizontalRule . |
asInlineDrawing() | InlineDrawing | Retorna o elemento atual como uma InlineDrawing . |
asInlineImage() | InlineImage | Retorna o elemento atual como uma InlineImage . |
asListItem() | ListItem | Retorna o elemento atual como uma ListItem . |
asPageBreak() | PageBreak | Retorna o elemento atual como uma PageBreak . |
asParagraph() | Paragraph | Retorna o elemento atual como uma Paragraph . |
asPerson() | Person | Retorna o elemento atual como uma Person . |
asRichLink() | RichLink | Retorna o elemento atual como uma RichLink , por exemplo, um link para um arquivo do Planilhas Google. |
asTable() | Table | Retorna o elemento atual como uma Table . |
asTableCell() | TableCell | Retorna o elemento atual como uma TableCell . |
asTableOfContents() | TableOfContents | Retorna o elemento atual como uma TableOfContents . |
asTableRow() | TableRow | Retorna o elemento atual como uma TableRow . |
asText() | Text | Retorna o elemento atual como uma Text . |
copy() | Element | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | Element | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | Element | Remove o elemento do pai. |
setAttributes(attributes) | Element | Define os atributos do elemento. |
ElementType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
BODY_SECTION | Enum | Tipo correspondente ao elemento Body . |
COMMENT_SECTION | Enum | Tipo correspondente ao elemento . |
DATE | Enum | O tipo correspondente ao elemento
Date . |
DOCUMENT | Enum | O tipo que corresponde à raiz do documento. |
EQUATION | Enum | Tipo correspondente ao elemento Equation . |
EQUATION_FUNCTION | Enum | Tipo correspondente ao elemento EquationFunction . |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | O tipo correspondente ao elemento
EquationFunctionArgumentSeparator . |
EQUATION_SYMBOL | Enum | Tipo correspondente ao elemento EquationSymbol . |
RICH_LINK | Enum | Tipo correspondente ao elemento RichLink . |
FOOTER_SECTION | Enum | Tipo correspondente ao elemento FooterSection . |
FOOTNOTE | Enum | Tipo correspondente ao elemento Footnote . |
FOOTNOTE_SECTION | Enum | Tipo correspondente ao elemento FootnoteSection . |
HEADER_SECTION | Enum | Tipo correspondente ao elemento HeaderSection . |
HORIZONTAL_RULE | Enum | Tipo correspondente ao elemento HorizontalRule . |
INLINE_DRAWING | Enum | Tipo correspondente ao elemento InlineDrawing . |
INLINE_IMAGE | Enum | Tipo correspondente ao elemento InlineImage . |
LIST_ITEM | Enum | Tipo correspondente ao elemento ListItem . |
PAGE_BREAK | Enum | Tipo correspondente ao elemento PageBreak . |
PARAGRAPH | Enum | Tipo correspondente ao elemento Paragraph . |
PERSON | Enum | Tipo correspondente ao elemento Person . |
TABLE | Enum | Tipo correspondente ao elemento Table . |
TABLE_CELL | Enum | Tipo correspondente ao elemento TableCell . |
TABLE_OF_CONTENTS | Enum | Tipo correspondente ao elemento TableOfContents . |
TABLE_ROW | Enum | Tipo correspondente ao elemento TableRow . |
TEXT | Enum | O tipo correspondente ao elemento
Text . |
UNSUPPORTED | Enum | O tipo correspondente a UnsupportedElement . |
Equation
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
clear() | Equation | Limpa o conteúdo do elemento. |
copy() | Equation | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | Equation | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | Equation | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | Equation | Define os atributos do elemento. |
setLinkUrl(url) | Equation | Define o URL do link. |
setTextAlignment(textAlignment) | Equation | Define o alinhamento do texto. |
EquationFunction
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
clear() | EquationFunction | Limpa o conteúdo do elemento. |
copy() | EquationFunction | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getCode() | String | Recupera o código correspondente à função de equação. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | EquationFunction | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | EquationFunction | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | EquationFunction | Define os atributos do elemento. |
setLinkUrl(url) | EquationFunction | Define o URL do link. |
setTextAlignment(textAlignment) | EquationFunction | Define o alinhamento do texto. |
EquationFunctionArgumentSeparator
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | EquationFunctionArgumentSeparator | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | EquationFunctionArgumentSeparator | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | EquationFunctionArgumentSeparator | Remove o elemento do pai. |
setAttributes(attributes) | EquationFunctionArgumentSeparator | Define os atributos do elemento. |
EquationSymbol
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | EquationSymbol | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getCode() | String | Recupera o código correspondente ao símbolo de equação. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | EquationSymbol | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | EquationSymbol | Remove o elemento do pai. |
setAttributes(attributes) | EquationSymbol | Define os atributos do elemento. |
FontFamily
FooterSection
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendListItem(listItem) | ListItem | Anexa o ListItem especificado. |
appendListItem(text) | ListItem | Cria e anexa um novo ListItem com o conteúdo de texto especificado. |
appendParagraph(paragraph) | Paragraph | Anexa o Paragraph especificado. |
appendParagraph(text) | Paragraph | Cria e anexa um novo Paragraph com o conteúdo de texto especificado. |
appendTable() | Table | Cria e anexa um novo Table . |
appendTable(cells) | Table | Anexa um novo Table contendo um TableCell para cada valor de string especificado. |
appendTable(table) | Table | Anexa o Table especificado. |
clear() | FooterSection | Limpa o conteúdo do elemento. |
copy() | FooterSection | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera 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() | Integer | Recupera o número de filhos. |
getParagraphs() | Paragraph[] | Recupera todos os Paragraphs contidos na seção (incluindo ListItems ). |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getTables() | Table[] | Recupera todos os Tables contidos na seção. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um novo HorizontalRule no índice especificado. |
insertImage(childIndex, image) | InlineImage | Cria e insere uma InlineImage do blob de imagem especificado no índice especificado. |
insertImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Insere o ListItem especificado no índice especificado. |
insertListItem(childIndex, text) | ListItem | Cria e insere um novo ListItem no índice especificado, com o conteúdo de texto
especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Insere o Paragraph especificado no índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Cria e insere um novo Paragraph no índice especificado, com o conteúdo de texto
especificado. |
insertTable(childIndex) | Table | Cria e insere um novo Table no índice especificado. |
insertTable(childIndex, cells) | Table | Cria e insere um novo Table contendo as células especificadas no índice especificado. |
insertTable(childIndex, table) | Table | Insere o Table especificado no índice especificado. |
removeChild(child) | FooterSection | Remove o elemento filho especificado. |
removeFromParent() | FooterSection | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | FooterSection | Define os atributos do elemento. |
setText(text) | FooterSection | Define o conteúdo como texto simples. |
setTextAlignment(textAlignment) | FooterSection | Define o alinhamento do texto. |
Footnote
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | Footnote | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getFootnoteContents() | FootnoteSection | Recupera o conteúdo do elemento de nota de rodapé. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
removeFromParent() | Footnote | Remove o elemento do pai. |
setAttributes(attributes) | Footnote | Define os atributos do elemento. |
FootnoteSection
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendParagraph(paragraph) | Paragraph | Anexa o Paragraph especificado. |
appendParagraph(text) | Paragraph | Cria e anexa um novo Paragraph com o conteúdo de texto especificado. |
clear() | FootnoteSection | Limpa o conteúdo do elemento. |
copy() | FootnoteSection | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParagraphs() | Paragraph[] | Recupera todos os Paragraphs contidos na seção (incluindo ListItems ). |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertParagraph(childIndex, paragraph) | Paragraph | Insere o Paragraph especificado no índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Cria e insere um novo Paragraph no índice especificado, com o conteúdo de texto
especificado. |
removeChild(child) | FootnoteSection | Remove o elemento filho especificado. |
removeFromParent() | FootnoteSection | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | FootnoteSection | Define os atributos do elemento. |
setText(text) | FootnoteSection | Define o conteúdo como texto simples. |
setTextAlignment(textAlignment) | FootnoteSection | Define o alinhamento do texto. |
GlyphType
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
BULLET | Enum | Marcador padrão, circular e preenchido. |
HOLLOW_BULLET | Enum | Um marcador vazio. |
SQUARE_BULLET | Enum | Um marcador quadrado. |
NUMBER | Enum | Um marcador com base no número. |
LATIN_UPPER | Enum | Marcador latino maiúsculo. |
LATIN_LOWER | Enum | Marcador latino maiúsculo. |
ROMAN_UPPER | Enum | Um numeral romano, um marcador com letras maiúsculas. |
ROMAN_LOWER | Enum | Um algarismo romano, marcador em letra minúscula. |
HeaderSection
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendListItem(listItem) | ListItem | Anexa o ListItem especificado. |
appendListItem(text) | ListItem | Cria e anexa um novo ListItem com o conteúdo de texto especificado. |
appendParagraph(paragraph) | Paragraph | Anexa o Paragraph especificado. |
appendParagraph(text) | Paragraph | Cria e anexa um novo Paragraph com o conteúdo de texto especificado. |
appendTable() | Table | Cria e anexa um novo Table . |
appendTable(cells) | Table | Anexa um novo Table contendo um TableCell para cada valor de string especificado. |
appendTable(table) | Table | Anexa o Table especificado. |
clear() | HeaderSection | Limpa o conteúdo do elemento. |
copy() | HeaderSection | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera 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() | Integer | Recupera o número de filhos. |
getParagraphs() | Paragraph[] | Recupera todos os Paragraphs contidos na seção (incluindo ListItems ). |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getTables() | Table[] | Recupera todos os Tables contidos na seção. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um novo HorizontalRule no índice especificado. |
insertImage(childIndex, image) | InlineImage | Cria e insere uma InlineImage do blob de imagem especificado no índice especificado. |
insertImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Insere o ListItem especificado no índice especificado. |
insertListItem(childIndex, text) | ListItem | Cria e insere um novo ListItem no índice especificado, com o conteúdo de texto
especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Insere o Paragraph especificado no índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Cria e insere um novo Paragraph no índice especificado, com o conteúdo de texto
especificado. |
insertTable(childIndex) | Table | Cria e insere um novo Table no índice especificado. |
insertTable(childIndex, cells) | Table | Cria e insere um novo Table contendo as células especificadas no índice especificado. |
insertTable(childIndex, table) | Table | Insere o Table especificado no índice especificado. |
removeChild(child) | HeaderSection | Remove o elemento filho especificado. |
removeFromParent() | HeaderSection | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | HeaderSection | Define os atributos do elemento. |
setText(text) | HeaderSection | Define o conteúdo como texto simples. |
setTextAlignment(textAlignment) | HeaderSection | Define o alinhamento do texto. |
HorizontalAlignment
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
LEFT | Enum | A opção de alinhamento à esquerda. |
CENTER | Enum | A opção de alinhamento centralizado. |
RIGHT | Enum | A opção de alinhamento à direita. |
JUSTIFY | Enum | A opção justify-alignment |
HorizontalRule
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | HorizontalRule | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
removeFromParent() | HorizontalRule | Remove o elemento do pai. |
setAttributes(attributes) | HorizontalRule | Define os atributos do elemento. |
InlineDrawing
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | InlineDrawing | Retorna uma cópia detalhada e removida do elemento atual. |
getAltDescription() | String | Retorna a descrição alternativa do desenho. |
getAltTitle() | String | Retorna o título alternativo do desenho. |
getAttributes() | Object | Recupera os atributos do elemento. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | InlineDrawing | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | InlineDrawing | Remove o elemento do pai. |
setAltDescription(description) | InlineDrawing | Define a descrição alternativa do desenho. |
setAltTitle(title) | InlineDrawing | Define o título alternativo do desenho. |
setAttributes(attributes) | InlineDrawing | Define os atributos do elemento. |
InlineImage
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | InlineImage | Retorna uma cópia detalhada e removida do elemento atual. |
getAltDescription() | String | Retorna a descrição alternativa da imagem. |
getAltTitle() | String | Retorna o título alternativo da imagem. |
getAs(contentType) | Blob | Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getAttributes() | Object | Recupera os atributos do elemento. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getHeight() | Integer | Recupera a altura da imagem em pixels. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
getWidth() | Integer | Recupera a largura da imagem em pixels. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | InlineImage | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | InlineImage | Remove o elemento do pai. |
setAltDescription(description) | InlineImage | Define a descrição alternativa da imagem. |
setAltTitle(title) | InlineImage | Define o título alternativo da imagem. |
setAttributes(attributes) | InlineImage | Define os atributos do elemento. |
setHeight(height) | InlineImage | Define a altura da imagem em pixels. |
setLinkUrl(url) | InlineImage | Define o URL do link. |
setWidth(width) | InlineImage | Define a largura da imagem em pixels. |
ListItem
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addPositionedImage(image) | PositionedImage | Cria e insere um novo PositionedImage a partir do blob de imagem especificado. |
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendInlineImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendInlineImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendPageBreak() | PageBreak | Cria e anexa um novo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Anexa o PageBreak especificado. |
appendText(text) | Text | Cria e anexa um novo elemento Text com o conteúdo especificado. |
appendText(text) | Text | Anexa o elemento Text fornecido. |
clear() | ListItem | Limpa o conteúdo do elemento. |
copy() | ListItem | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAlignment() | HorizontalAlignment | Recupera o HorizontalAlignment . |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getGlyphType() | GlyphType | Recupera o GlyphType do item da lista. |
getHeading() | ParagraphHeading | Recupera o ParagraphHeading . |
getIndentEnd() | Number | Recupera o recuo final em pontos. |
getIndentFirstLine() | Number | Recupera o recuo da primeira linha, em pontos. |
getIndentStart() | Number | Recupera o recuo inicial. |
getLineSpacing() | Number | Recupera o espaçamento entre linhas em pontos. |
getLinkUrl() | String | Recupera o URL do link. |
getListId() | String | Recupera o ID da lista. |
getNestingLevel() | Integer | Recupera o nível de aninhamento do item da lista. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPositionedImage(id) | PositionedImage | Recebe um PositionedImage pelo ID da imagem. |
getPositionedImages() | PositionedImage[] | Faz com que todos os objetos PositionedImage sejam ancorados ao parágrafo. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getSpacingAfter() | Number | Recupera o espaçamento após o elemento em pontos. |
getSpacingBefore() | Number | Recupera o espaçamento antes do elemento em pontos. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um HorizontalRule no índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Cria e insere uma nova InlineImage do blob de imagem especificado no índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertPageBreak(childIndex) | PageBreak | Cria e insere um novo PageBreak no índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insere o PageBreak especificado no índice especificado. |
insertText(childIndex, text) | Text | Cria e insere um novo elemento de texto no índice especificado. |
insertText(childIndex, text) | Text | Insere o elemento Text no índice especificado, com o conteúdo de texto
especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
isLeftToRight() | Boolean | Recupera a configuração da esquerda para a direita. |
merge() | ListItem | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeChild(child) | ListItem | Remove o elemento filho especificado. |
removeFromParent() | ListItem | Remove o elemento do pai. |
removePositionedImage(id) | Boolean | Remove um PositionedImage pelo ID da imagem. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAlignment(alignment) | ListItem | Define o HorizontalAlignment . |
setAttributes(attributes) | ListItem | Define os atributos do elemento. |
setGlyphType(glyphType) | ListItem | Define o GlyphType do item da lista. |
setHeading(heading) | ListItem | Define o ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Define o recuo final em pontos. |
setIndentFirstLine(indentFirstLine) | ListItem | Define o recuo da primeira linha, em pontos. |
setIndentStart(indentStart) | ListItem | Define o recuo inicial em pontos. |
setLeftToRight(leftToRight) | ListItem | Define a configuração da esquerda para a direita. |
setLineSpacing(multiplier) | ListItem | Define o espaçamento entre as linhas, como uma quantidade que indica o número de linhas a serem usadas para espaçamento. |
setLinkUrl(url) | ListItem | Define o URL do link. |
setListId(listItem) | ListItem | Define o ID da lista. |
setNestingLevel(nestingLevel) | ListItem | Define o nível de aninhamento do item da lista. |
setSpacingAfter(spacingAfter) | ListItem | Define o espaçamento após os elementos em pontos. |
setSpacingBefore(spacingBefore) | ListItem | Define o espaçamento antes do elemento em pontos. |
setText(text) | void | Define o conteúdo do item da lista como texto. |
setTextAlignment(textAlignment) | ListItem | Define o alinhamento do texto. |
NamedRange
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getId() | String | Recebe o ID desse NamedRange . |
getName() | String | Recebe o nome deste NamedRange . |
getRange() | Range | Recebe o intervalo de elementos associados a essa NamedRange . |
remove() | void | Remove este NamedRange do documento. |
PageBreak
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | PageBreak | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
removeFromParent() | PageBreak | Remove o elemento do pai. |
setAttributes(attributes) | PageBreak | Define os atributos do elemento. |
Paragraph
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
addPositionedImage(image) | PositionedImage | Cria e insere um novo PositionedImage a partir do blob de imagem especificado. |
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendInlineImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendInlineImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendPageBreak() | PageBreak | Cria e anexa um novo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Anexa o PageBreak especificado. |
appendText(text) | Text | Cria e anexa um novo elemento Text com o conteúdo especificado. |
appendText(text) | Text | Anexa o elemento Text fornecido. |
clear() | Paragraph | Limpa o conteúdo do elemento. |
copy() | Paragraph | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAlignment() | HorizontalAlignment | Recupera o HorizontalAlignment . |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getHeading() | ParagraphHeading | Recupera o ParagraphHeading . |
getIndentEnd() | Number | Recupera o recuo final em pontos. |
getIndentFirstLine() | Number | Recupera o recuo da primeira linha, em pontos. |
getIndentStart() | Number | Recupera o recuo inicial. |
getLineSpacing() | Number | Recupera o espaçamento entre linhas em pontos. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPositionedImage(id) | PositionedImage | Recebe um PositionedImage pelo ID da imagem. |
getPositionedImages() | PositionedImage[] | Faz com que todos os objetos PositionedImage sejam ancorados ao parágrafo. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getSpacingAfter() | Number | Recupera o espaçamento após o elemento em pontos. |
getSpacingBefore() | Number | Recupera o espaçamento antes do elemento em pontos. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um HorizontalRule no índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Cria e insere uma nova InlineImage do blob de imagem especificado no índice especificado. |
insertInlineImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertPageBreak(childIndex) | PageBreak | Cria e insere um novo PageBreak no índice especificado. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Insere o PageBreak especificado no índice especificado. |
insertText(childIndex, text) | Text | Cria e insere um novo elemento de texto no índice especificado. |
insertText(childIndex, text) | Text | Insere o elemento Text no índice especificado, com o conteúdo de texto
especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
isLeftToRight() | Boolean | Recupera a configuração da esquerda para a direita. |
merge() | Paragraph | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeChild(child) | Paragraph | Remove o elemento filho especificado. |
removeFromParent() | Paragraph | Remove o elemento do pai. |
removePositionedImage(id) | Boolean | Remove um PositionedImage pelo ID da imagem. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAlignment(alignment) | Paragraph | Define o HorizontalAlignment . |
setAttributes(attributes) | Paragraph | Define os atributos do elemento. |
setHeading(heading) | Paragraph | Define o ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | Define o recuo final em pontos. |
setIndentFirstLine(indentFirstLine) | Paragraph | Define o recuo da primeira linha, em pontos. |
setIndentStart(indentStart) | Paragraph | Define o recuo inicial em pontos. |
setLeftToRight(leftToRight) | Paragraph | Define a configuração da esquerda para a direita. |
setLineSpacing(multiplier) | Paragraph | Define o espaçamento entre as linhas, como uma quantidade que indica o número de linhas a serem usadas para espaçamento. |
setLinkUrl(url) | Paragraph | Define o URL do link. |
setSpacingAfter(spacingAfter) | Paragraph | Define o espaçamento após os elementos em pontos. |
setSpacingBefore(spacingBefore) | Paragraph | Define o espaçamento antes do elemento em pontos. |
setText(text) | void | Define o conteúdo do parágrafo como texto. |
setTextAlignment(textAlignment) | Paragraph | Define o alinhamento do texto. |
ParagraphHeading
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
NORMAL | Enum | A opção de título para o texto normal. |
HEADING1 | Enum | A opção de cabeçalho mais alta. |
HEADING2 | Enum | A segunda opção de título. |
HEADING3 | Enum | A terceira opção de título |
HEADING4 | Enum | A quarta opção de título. |
HEADING5 | Enum | A quinta opção de título. |
HEADING6 | Enum | A opção de cabeçalho mais baixa. |
TITLE | Enum | A opção de título do título. |
SUBTITLE | Enum | A opção de título da legenda. |
Person
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | Person | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getEmail() | String | Retorna o endereço de e-mail da pessoa. |
getName() | String | Retorna o nome de exibição da pessoa, se definido. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | Person | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | Person | Remove o elemento do pai. |
setAttributes(attributes) | Person | Define os atributos do elemento. |
Position
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getElement() | Element | Recebe o elemento que contém esse Position . |
getOffset() | Integer | Acessa o local relativo do Position no elemento que o contém. |
getSurroundingText() | Text | Cria um elemento Text artificial que representa o texto e a formatação da
Paragraph ou ListItem que contém a Position , seja diretamente ou por uma cadeia de elementos filhos. |
getSurroundingTextOffset() | Integer | Acessa o deslocamento desse Position no elemento Text retornado por getSurroundingText() . |
insertBookmark() | Bookmark | Cria e insere um novo Bookmark nesta Position . |
insertInlineImage(image) | InlineImage | Cria e insere um novo InlineImage nessa Position do blob de imagem
especificado. |
insertText(text) | Text | Insere o texto especificado neste Position . |
PositionedImage
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getAs(contentType) | Blob | Retorna os dados dentro desse objeto como um blob convertido para o tipo de conteúdo especificado. |
getBlob() | Blob | Retorne os dados dentro desse objeto como um blob. |
getHeight() | Integer | Recupera a altura da imagem em pixels. |
getId() | String | Recebe o ID da imagem. |
getLayout() | PositionedLayout | Recebe um valor de enumeração que representa como a imagem é exibida. |
getLeftOffset() | Number | Recebe o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo. |
getParagraph() | Paragraph | Recebe o Paragraph em que a imagem está ancorada. |
getTopOffset() | Number | Recebe o deslocamento da imagem, em pontos, desde o topo do parágrafo. |
getWidth() | Integer | Recupera a largura da imagem em pixels. |
setHeight(height) | PositionedImage | Define a altura da imagem em pixels. |
setLayout(layout) | PositionedImage | Define a definição de como a imagem é apresentada. |
setLeftOffset(offset) | PositionedImage | Define o deslocamento da imagem, em pontos, a partir da esquerda do parágrafo. |
setTopOffset(offset) | PositionedImage | Define o deslocamento da imagem, em pontos, a partir da parte superior do parágrafo. |
setWidth(width) | PositionedImage | Define a largura da imagem em pixels. |
PositionedLayout
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
ABOVE_TEXT | Enum | A imagem está posicionada acima do texto. |
BREAK_BOTH | Enum | A imagem quebra o texto à esquerda e à direita. |
BREAK_LEFT | Enum | A imagem quebra o texto à esquerda. |
BREAK_RIGHT | Enum | A imagem quebra o texto à direita. |
WRAP_TEXT | Enum | A imagem é encapsulada por texto. |
Range
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
getRangeElements() | RangeElement[] | Recebe todos os elementos nessa 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étodo | Tipo de retorno | Breve descrição |
---|---|---|
addElement(element) | RangeBuilder | Adiciona uma Element inteira ao RangeBuilder . |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | Adiciona um elemento Text parcial a este RangeBuilder . |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | Adiciona dois elementos inteiros e todos os elementos entre eles a essa RangeBuilder . |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | Adiciona dois elementos Text parciais, e todos os elementos entre eles, ao RangeBuilder . |
addRange(range) | RangeBuilder | Adiciona o conteúdo de outro Range ao RangeBuilder . |
build() | Range | Cria um Range com as configurações aplicadas ao builder. |
getRangeElements() | RangeElement[] | Recebe todos os elementos nessa 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étodo | Tipo de retorno | Breve descrição |
---|---|---|
getElement() | Element | Recebe o Element correspondente a esse RangeElement . |
getEndOffsetInclusive() | Integer | Recebe a posição do fim de um intervalo parcial dentro do elemento de intervalo. |
getStartOffset() | Integer | Recebe a posição do início de um intervalo parcial dentro do elemento de intervalo. |
isPartial() | Boolean | Determina se esse elemento de intervalo abrange todo o elemento ou uma seleção parcial dos caracteres do elemento. |
RichLink
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | RichLink | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getMimeType() | String | Retorna o tipo MIME do
link, disponível quando o item é um link para um arquivo do Drive e null ,
caso contrário. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getTitle() | String | Retorna o título exibido do link. |
getType() | ElementType | Recupera a ElementType do elemento. |
getUrl() | String | Retorna o URL do recurso. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | RichLink | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | RichLink | Remove o elemento do pai. |
setAttributes(attributes) | RichLink | Define os atributos do elemento. |
Table
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendTableRow() | TableRow | Cria e anexa um novo TableRow . |
appendTableRow(tableRow) | TableRow | Anexa o TableRow especificado. |
clear() | Table | Limpa o conteúdo do elemento. |
copy() | Table | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getBorderColor() | String | Recupera a cor da borda. |
getBorderWidth() | Number | Recupera a largura da borda em pontos. |
getCell(rowIndex, cellIndex) | TableCell | Recupera o TableCell nos índices de célula e linha especificados. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getColumnWidth(columnIndex) | Number | Recupera a largura da coluna da tabela especificada em pontos. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getNumRows() | Integer | Recupera o número de TableRows . |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getRow(rowIndex) | TableRow | Recupera o TableRow no índice de linhas especificado. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertTableRow(childIndex) | TableRow | Cria e insere um novo TableRow no índice especificado. |
insertTableRow(childIndex, tableRow) | TableRow | Insere o TableRow especificado no índice especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
removeChild(child) | Table | Remove o elemento filho especificado. |
removeFromParent() | Table | Remove o elemento do pai. |
removeRow(rowIndex) | TableRow | Remove a TableRow no índice de linhas especificado. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | Table | Define os atributos do elemento. |
setBorderColor(color) | Table | Define a cor da borda. |
setBorderWidth(width) | Table | Define a largura da borda em pontos. |
setColumnWidth(columnIndex, width) | Table | Define a largura da coluna especificada em pontos. |
setLinkUrl(url) | Table | Define o URL do link. |
setTextAlignment(textAlignment) | Table | Define o alinhamento do texto. |
TableCell
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendHorizontalRule() | HorizontalRule | Cria e anexa um novo HorizontalRule . |
appendImage(image) | InlineImage | Cria e anexa um novo InlineImage do blob de imagem especificado. |
appendImage(image) | InlineImage | Anexa o InlineImage especificado. |
appendListItem(listItem) | ListItem | Anexa o ListItem especificado. |
appendListItem(text) | ListItem | Cria e anexa um novo ListItem . |
appendParagraph(paragraph) | Paragraph | Anexa o Paragraph especificado. |
appendParagraph(text) | Paragraph | Cria e anexa um novo Paragraph . |
appendTable() | Table | Cria e anexa um novo Table . |
appendTable(cells) | Table | Anexa um novo Table contendo as células especificadas. |
appendTable(table) | Table | Anexa o Table especificado. |
clear() | TableCell | Limpa o conteúdo do elemento. |
copy() | TableCell | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getBackgroundColor() | String | Recupera a cor do plano de fundo. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getColSpan() | Integer | Recupera o período da coluna, que é o número de colunas das células da tabela que essa célula abrange. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getPaddingBottom() | Number | Recupera o padding de baixo, em pontos. |
getPaddingLeft() | Number | Recupera o padding esquerdo, em pontos. |
getPaddingRight() | Number | Recupera o padding certo, em pontos. |
getPaddingTop() | Number | Recupera o padding superior em pontos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getParentRow() | TableRow | Recupera o TableRow que contém o TableCell atual. |
getParentTable() | Table | Recupera o Table que contém o TableCell atual. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getRowSpan() | Integer | Recupera o período da linha, que é o número de linhas de células da tabela que essa célula abrange. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
getVerticalAlignment() | VerticalAlignment | Recupera o VerticalAlignment . |
getWidth() | Number | Recupera a largura da coluna com a célula em pontos. |
insertHorizontalRule(childIndex) | HorizontalRule | Cria e insere um novo HorizontalRule no índice especificado. |
insertImage(childIndex, image) | InlineImage | Cria e insere uma InlineImage do blob de imagem especificado no índice especificado. |
insertImage(childIndex, image) | InlineImage | Insere o InlineImage especificado no índice especificado. |
insertListItem(childIndex, listItem) | ListItem | Insere o ListItem especificado no índice especificado. |
insertListItem(childIndex, text) | ListItem | Cria e insere um novo ListItem no índice especificado. |
insertParagraph(childIndex, paragraph) | Paragraph | Insere o Paragraph especificado no índice especificado. |
insertParagraph(childIndex, text) | Paragraph | Cria e insere um novo Paragraph no índice especificado. |
insertTable(childIndex) | Table | Cria e insere um novo Table no índice especificado. |
insertTable(childIndex, cells) | Table | Cria e insere um novo Table contendo as células especificadas no índice especificado. |
insertTable(childIndex, table) | Table | Insere o Table especificado no índice especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | TableCell | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeChild(child) | TableCell | Remove o elemento filho especificado. |
removeFromParent() | TableCell | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | TableCell | Define os atributos do elemento. |
setBackgroundColor(color) | TableCell | Define a cor do plano de fundo. |
setLinkUrl(url) | TableCell | Define o URL do link. |
setPaddingBottom(paddingBottom) | TableCell | Define o padding inferior, em pontos. |
setPaddingLeft(paddingLeft) | TableCell | Define o padding esquerdo, em pontos. |
setPaddingRight(paddingTop) | TableCell | Define o padding certo, em pontos. |
setPaddingTop(paddingTop) | TableCell | Define o padding superior em pontos. |
setText(text) | TableCell | Define o conteúdo como texto simples. |
setTextAlignment(textAlignment) | TableCell | Define o alinhamento do texto. |
setVerticalAlignment(alignment) | TableCell | Define o alinhamento vertical. |
setWidth(width) | TableCell | Define a largura da coluna que contém a célula atual em pontos. |
TableOfContents
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
clear() | TableOfContents | Limpa o conteúdo do elemento. |
copy() | TableOfContents | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getLinkUrl() | String | Recupera o URL do link. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
removeFromParent() | TableOfContents | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | TableOfContents | Define os atributos do elemento. |
setLinkUrl(url) | TableOfContents | Define o URL do link. |
setTextAlignment(textAlignment) | TableOfContents | Define o alinhamento do texto. |
TableRow
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendTableCell() | TableCell | Cria e anexa um novo TableCell . |
appendTableCell(textContents) | TableCell | Anexa o TableCell especificado que contém o texto especificado. |
appendTableCell(tableCell) | TableCell | Anexa o TableCell especificado. |
clear() | TableRow | Limpa o conteúdo do elemento. |
copy() | TableRow | Retorna uma cópia detalhada e removida do elemento atual. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findElement(elementType) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado. |
findElement(elementType, from) | RangeElement | Pesquisa o conteúdo do elemento em busca de um descendente do tipo especificado, começando pelo
RangeElement especificado. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getCell(cellIndex) | TableCell | Recupera o TableCell no índice de célula especificado. |
getChild(childIndex) | Element | Recupera o elemento filho no índice filho especificado. |
getChildIndex(child) | Integer | Recupera o índice filho do elemento filho especificado. |
getLinkUrl() | String | Recupera o URL do link. |
getMinimumHeight() | Number | Recupera a altura mínima em pontos. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getNumCells() | Integer | Recupera o número de células na linha. |
getNumChildren() | Integer | Recupera o número de filhos. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getParentTable() | Table | Recupera o Table que contém a linha atual. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertTableCell(childIndex) | TableCell | Cria e insere um novo TableCell no índice especificado. |
insertTableCell(childIndex, textContents) | TableCell | Insere o TableCell especificado no índice especificado, contendo o texto fornecido. |
insertTableCell(childIndex, tableCell) | TableCell | Insere o TableCell especificado no índice especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | TableRow | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeCell(cellIndex) | TableCell | Remove a TableCell no índice de células especificado. |
removeChild(child) | TableRow | Remove o elemento filho especificado. |
removeFromParent() | TableRow | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui todas as ocorrências de um determinado padrão de texto por uma determinada string de substituição, usando expressões regulares. |
setAttributes(attributes) | TableRow | Define os atributos do elemento. |
setLinkUrl(url) | TableRow | Define o URL do link. |
setMinimumHeight(minHeight) | TableRow | Define a altura mínima, em pontos. |
setTextAlignment(textAlignment) | TableRow | Define o alinhamento do texto. |
Text
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
appendText(text) | Text | Adiciona o texto especificado ao final desta região de texto. |
copy() | Text | Retorna uma cópia detalhada e removida do elemento atual. |
deleteText(startOffset, endOffsetInclusive) | Text | Exclui um intervalo de texto. |
editAsText() | Text | Recebe uma versão Text do elemento atual para edição. |
findText(searchPattern) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado usando expressões regulares. |
findText(searchPattern, from) | RangeElement | Pesquisa o conteúdo do elemento para o padrão de texto especificado, começando por um determinado resultado da pesquisa. |
getAttributes() | Object | Recupera os atributos do elemento. |
getAttributes(offset) | Object | Recupera os atributos no deslocamento de caracteres especificado. |
getBackgroundColor() | String | Recupera a configuração de cor de fundo. |
getBackgroundColor(offset) | String | Recupera a cor do plano de fundo no deslocamento de caracteres especificado. |
getFontFamily() | String | Recupera a configuração da família de fontes. |
getFontFamily(offset) | String | Recupera a família de fontes no deslocamento de caracteres especificado. |
getFontSize() | Number | Recupera a configuração do tamanho da fonte. |
getFontSize(offset) | Number | Recupera o tamanho da fonte no deslocamento de caracteres especificado. |
getForegroundColor() | String | Recupera a configuração de cor de primeiro plano. |
getForegroundColor(offset) | String | Recupera a cor do primeiro plano no deslocamento de caracteres especificado. |
getLinkUrl() | String | Recupera o URL do link. |
getLinkUrl(offset) | String | Recupera o URL do link no deslocamento de caracteres especificado. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getText() | String | Recupera o conteúdo do elemento como uma string de texto. |
getTextAlignment() | TextAlignment | Acessa o alinhamento do texto. |
getTextAlignment(offset) | TextAlignment | Recebe o alinhamento do texto de um único caractere. |
getTextAttributeIndices() | Integer[] | Recupera o conjunto de índices de texto que correspondem ao início das execuções de formatação de texto diferentes. |
getType() | ElementType | Recupera a ElementType do elemento. |
insertText(offset, text) | Text | Insere o texto especificado no deslocamento de caracteres especificado. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
isBold() | Boolean | Recupera a configuração em negrito. |
isBold(offset) | Boolean | Recupera a configuração de negrito no deslocamento de caracteres especificado. |
isItalic() | Boolean | Recupera a configuração em itálico. |
isItalic(offset) | Boolean | Recupera a configuração de itálico no deslocamento de caracteres especificado. |
isStrikethrough() | Boolean | Recupera a configuração de tachado. |
isStrikethrough(offset) | Boolean | Recupera a configuração de tachado no deslocamento de caracteres especificado. |
isUnderline() | Boolean | Recupera a configuração de sublinhado. |
isUnderline(offset) | Boolean | Recupera a configuração de sublinhado no deslocamento de caracteres especificado. |
merge() | Text | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | Text | Remove o elemento do pai. |
replaceText(searchPattern, replacement) | Element | Substitui 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) | Text | Aplica os atributos especificados ao intervalo de caracteres especificado. |
setAttributes(attributes) | Text | Define os atributos do elemento. |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | Define a cor do plano de fundo do intervalo de caracteres especificado. |
setBackgroundColor(color) | Text | Define a cor do plano de fundo. |
setBold(bold) | Text | Define a configuração de negrito. |
setBold(startOffset, endOffsetInclusive, bold) | Text | Define a configuração de negrito para o intervalo de caracteres especificado. |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | Define a família de fontes para o intervalo de caracteres especificado. |
setFontFamily(fontFamilyName) | Text | Define a família de fontes. |
setFontSize(startOffset, endOffsetInclusive, size) | Text | Define o tamanho da fonte para o intervalo de caracteres especificado. |
setFontSize(size) | Text | Define o tamanho da fonte. |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | Define a cor do primeiro plano do intervalo de caracteres especificado. |
setForegroundColor(color) | Text | Define a cor do primeiro plano. |
setItalic(italic) | Text | Define a configuração de itálico. |
setItalic(startOffset, endOffsetInclusive, italic) | Text | Define a configuração de itálico do intervalo de caracteres especificado. |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | Define o URL do link para o intervalo de caracteres especificado. |
setLinkUrl(url) | Text | Define o URL do link. |
setStrikethrough(strikethrough) | Text | Define a configuração de tachado. |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | Define a configuração de tachado para o intervalo de caracteres especificado. |
setText(text) | Text | Define o conteúdo de texto. |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | Define o alinhamento do texto para um determinado intervalo de caracteres. |
setTextAlignment(textAlignment) | Text | Define o alinhamento do texto. |
setUnderline(underline) | Text | Define a configuração de sublinhado. |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | Define a configuração de sublinhado para o intervalo de caracteres especificado. |
TextAlignment
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
NORMAL | Enum | O alinhamento normal do texto. |
SUPERSCRIPT | Enum | O alinhamento do texto sobrescrito. |
SUBSCRIPT | Enum | O alinhamento do texto do subscrito. |
UnsupportedElement
Métodos
Método | Tipo de retorno | Breve descrição |
---|---|---|
copy() | UnsupportedElement | Retorna uma cópia detalhada e removida do elemento atual. |
getAttributes() | Object | Recupera os atributos do elemento. |
getNextSibling() | Element | Recupera o próximo elemento irmão do elemento. |
getParent() | ContainerElement | Recupera o elemento pai do elemento. |
getPreviousSibling() | Element | Recupera o elemento irmão anterior do elemento. |
getType() | ElementType | Recupera a ElementType do elemento. |
isAtDocumentEnd() | Boolean | Determina se o elemento está no final do Document . |
merge() | UnsupportedElement | Mescla o elemento com o irmão anterior do mesmo tipo. |
removeFromParent() | UnsupportedElement | Remove o elemento do pai. |
setAttributes(attributes) | UnsupportedElement | Define os atributos do elemento. |
VerticalAlignment
Propriedades
Propriedade | Tipo | Descrição |
---|---|---|
BOTTOM | Enum | A opção de alinhamento inferior. |
CENTER | Enum | A opção de alinhamento centralizado. |
TOP | Enum | A opção de alinhamento na parte superior. |